blob: 6f84e7c0acf1009dfae5b340530200f2d76b1972 [file] [log] [blame]
Colin Crossf45fa6b2012-03-26 12:38:26 -07001/*
2 * Copyright (C) 2008 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
Felipe Lemef0292972016-11-22 13:57:05 -080016
Mark Salyzyn6c3d90f2016-09-27 14:55:27 -070017#define LOG_TAG "dumpstate"
Kevin Jeon2c02e8e2022-07-07 21:45:17 +000018#define ATRACE_TAG ATRACE_TAG_ALWAYS
Colin Crossf45fa6b2012-03-26 12:38:26 -070019
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -070020#include <dirent.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070021#include <errno.h>
22#include <fcntl.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010023#include <inttypes.h>
Felipe Lemead5f6c42015-11-30 14:26:46 -080024#include <libgen.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070025#include <limits.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010026#include <math.h>
27#include <poll.h>
Mark Salyzyn8f37aa52015-06-12 12:28:24 -070028#include <stdbool.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070029#include <stdio.h>
30#include <stdlib.h>
31#include <string.h>
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -070032#include <sys/mount.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080033#include <sys/poll.h>
Christopher Ferris7dc7f322014-07-22 16:08:19 -070034#include <sys/prctl.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070035#include <sys/resource.h>
36#include <sys/stat.h>
37#include <sys/time.h>
38#include <sys/wait.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010039#include <signal.h>
40#include <stdarg.h>
41#include <string.h>
42#include <sys/capability.h>
43#include <sys/inotify.h>
44#include <sys/klog.h>
45#include <time.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070046#include <unistd.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070047
48#include <chrono>
Hridya Valsarajuac582cd2019-08-05 15:39:54 -070049#include <cmath>
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +000050#include <fstream>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070051#include <functional>
52#include <future>
Narayan Kamath8f788292017-05-25 13:20:39 +010053#include <memory>
Hridya Valsarajuac582cd2019-08-05 15:39:54 -070054#include <numeric>
Narayan Kamath8f788292017-05-25 13:20:39 +010055#include <regex>
56#include <set>
57#include <string>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070058#include <utility>
Narayan Kamath8f788292017-05-25 13:20:39 +010059#include <vector>
Colin Crossf45fa6b2012-03-26 12:38:26 -070060
Kedar Chitnis9fd8c052021-11-16 09:09:22 +000061#include <aidl/android/hardware/dumpstate/IDumpstateDevice.h>
Felipe Leme96c2bbb2016-09-26 09:21:21 -070062#include <android-base/file.h>
63#include <android-base/properties.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070064#include <android-base/scopeguard.h>
Elliott Hughes9dc117c2015-12-07 14:21:50 -080065#include <android-base/stringprintf.h>
Naveen Kalla058e1e82016-10-19 21:38:44 -070066#include <android-base/strings.h>
Andreas Gampeaff68432016-07-18 18:01:27 -070067#include <android-base/unique_fd.h>
Kedar Chitnis9fd8c052021-11-16 09:09:22 +000068#include <android/binder_manager.h>
69#include <android/binder_process.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010070#include <android/content/pm/IPackageManagerNative.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080071#include <android/hardware/dumpstate/1.0/IDumpstateDevice.h>
Hunter Knepshield8540faf2020-02-04 19:47:20 -080072#include <android/hardware/dumpstate/1.1/IDumpstateDevice.h>
73#include <android/hardware/dumpstate/1.1/types.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080074#include <android/hidl/manager/1.0/IServiceManager.h>
Nandana Duttd2f5f082019-01-18 17:13:52 +000075#include <android/os/IIncidentCompanion.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010076#include <binder/IServiceManager.h>
Nikhil Kumar28ce35e2023-01-10 14:32:44 +000077#include <cutils/multiuser.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080078#include <cutils/native_handle.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070079#include <cutils/properties.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010080#include <cutils/sockets.h>
Kevin Jeon2c02e8e2022-07-07 21:45:17 +000081#include <cutils/trace.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000082#include <debuggerd/client.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080083#include <dumpsys.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000084#include <dumputils/dump_utils.h>
Sahana Raof35ed432019-07-12 10:47:52 +010085#include <hardware_legacy/power.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080086#include <hidl/ServiceManagement.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010087#include <log/log.h>
Tom Cherryf4472f32020-08-05 09:31:17 -070088#include <log/log_read.h>
Felipe Leme75876a22016-10-27 16:31:27 -070089#include <openssl/sha.h>
Mark Salyzyn6c3d90f2016-09-27 14:55:27 -070090#include <private/android_filesystem_config.h>
91#include <private/android_logger.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080092#include <serviceutils/PriorityDumper.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070093#include <utils/StrongPointer.h>
Devin Moore8df81bb2022-06-08 22:47:02 +000094#include <vintf/VintfObject.h>
Felipe Lemef0292972016-11-22 13:57:05 -080095#include "DumpstateInternal.h"
Felipe Leme75876a22016-10-27 16:31:27 -070096#include "DumpstateService.h"
Colin Crossf45fa6b2012-03-26 12:38:26 -070097#include "dumpstate.h"
Felipe Leme6e01fa62015-11-11 19:35:14 -080098
Kedar Chitnis9fd8c052021-11-16 09:09:22 +000099namespace dumpstate_hal_hidl_1_0 = android::hardware::dumpstate::V1_0;
100namespace dumpstate_hal_hidl = android::hardware::dumpstate::V1_1;
101namespace dumpstate_hal_aidl = aidl::android::hardware::dumpstate;
102
Vishnu Naire97d6122018-01-18 13:58:56 -0800103using ::std::literals::chrono_literals::operator""ms;
104using ::std::literals::chrono_literals::operator""s;
Rhed Jao5377d792020-07-16 17:37:39 +0800105using ::std::placeholders::_1;
Steven Morelandcb7ef822016-11-29 13:20:37 -0800106
Felipe Leme47e9be22016-12-21 15:37:07 -0800107// TODO: remove once moved to namespace
Vishnu Naire97d6122018-01-18 13:58:56 -0800108using android::defaultServiceManager;
109using android::Dumpsys;
110using android::INVALID_OPERATION;
111using android::IServiceManager;
112using android::OK;
113using android::sp;
114using android::status_t;
115using android::String16;
116using android::String8;
117using android::TIMED_OUT;
118using android::UNKNOWN_ERROR;
119using android::Vector;
Nandana Dutt979388e2018-11-30 16:48:55 +0000120using android::base::StringPrintf;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000121using android::os::IDumpstateListener;
Felipe Leme47e9be22016-12-21 15:37:07 -0800122using android::os::dumpstate::CommandOptions;
123using android::os::dumpstate::DumpFileToFd;
Rhed Jao5377d792020-07-16 17:37:39 +0800124using android::os::dumpstate::DumpPool;
Vishnu Naire97d6122018-01-18 13:58:56 -0800125using android::os::dumpstate::PropertiesHelper;
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800126using android::os::dumpstate::TaskQueue;
Chris Morinbc223142022-02-04 14:17:11 -0800127using android::os::dumpstate::WaitForTask;
Felipe Leme47e9be22016-12-21 15:37:07 -0800128
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100129// Keep in sync with
130// frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
131static const int TRACE_DUMP_TIMEOUT_MS = 10000; // 10 seconds
132
133/* Most simple commands have 10 as timeout, so 5 is a good estimate */
134static const int32_t WEIGHT_FILE = 5;
135
136// TODO: temporary variables and functions used during C++ refactoring
137static Dumpstate& ds = Dumpstate::GetInstance();
138static int RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Nandana Dutt8d945c02019-08-14 13:30:07 +0100139 const CommandOptions& options = CommandOptions::DEFAULT,
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800140 bool verbose_duration = false, int out_fd = STDOUT_FILENO) {
141 return ds.RunCommand(title, full_command, options, verbose_duration, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100142}
143
144// Reasonable value for max stats.
145static const int STATS_MAX_N_RUNS = 1000;
146static const long STATS_MAX_AVERAGE = 100000;
147
148CommandOptions Dumpstate::DEFAULT_DUMPSYS = CommandOptions::WithTimeout(30).Build();
149
Nandana Duttd2f5f082019-01-18 17:13:52 +0000150typedef Dumpstate::ConsentCallback::ConsentResult UserConsentResult;
151
Colin Crossf45fa6b2012-03-26 12:38:26 -0700152/* read before root is shed */
153static char cmdline_buf[16384] = "(unknown)";
Yi Kong19d5c002018-07-20 13:39:55 -0700154static const char *dump_traces_path = nullptr;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000155static const uint64_t USER_CONSENT_TIMEOUT_MS = 30 * 1000;
Hunter Knepshield70610fa2020-01-03 15:27:33 -0800156// Because telephony reports are significantly faster to collect (< 10 seconds vs. > 2 minutes),
157// it's often the case that they time out far too quickly for consent with such a hefty dialog for
158// the user to read. For telephony reports only, we increase the default timeout to 2 minutes to
159// roughly match full reports' durations.
160static const uint64_t TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS = 2 * 60 * 1000;
Colin Crossf45fa6b2012-03-26 12:38:26 -0700161
Felipe Leme1d486fe2016-10-14 18:06:47 -0700162// TODO: variables and functions below should be part of dumpstate object
163
Felipe Leme635ca312016-01-05 14:23:02 -0800164static std::set<std::string> mount_points;
165void add_mountinfo();
Felipe Leme78f2c862015-12-21 09:55:22 -0800166
Todd Poynor2a83daa2013-11-22 15:44:22 -0800167#define PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops"
Mark Salyzyn7d0a7622016-06-24 14:06:15 -0700168#define ALT_PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops-0"
Wei Wang509bb5d2017-06-09 14:42:12 -0700169#define BLK_DEV_SYS_DIR "/sys/block"
Todd Poynor2a83daa2013-11-22 15:44:22 -0800170
Felipe Lemee82a27d2016-01-05 13:35:44 -0800171#define RECOVERY_DIR "/cache/recovery"
Mark Salyzynd6ab0112016-03-25 12:56:39 -0700172#define RECOVERY_DATA_DIR "/data/misc/recovery"
Tianjie Xu75d53362018-04-11 16:42:28 -0700173#define UPDATE_ENGINE_LOG_DIR "/data/misc/update_engine_log"
Kelvin Zhang6eaa0f92022-09-12 09:29:19 -0700174#define UPDATE_ENGINE_PREF_DIR "/data/misc/update_engine/prefs"
Mark Salyzyn4d42dea2016-04-01 10:03:14 -0700175#define LOGPERSIST_DATA_DIR "/data/misc/logd"
Jerry Changa1df8a92020-01-02 16:03:39 +0800176#define PREREBOOT_DATA_DIR "/data/misc/prereboot"
David Brazdild2991962016-06-03 14:40:44 +0100177#define PROFILE_DATA_DIR_CUR "/data/misc/profiles/cur"
178#define PROFILE_DATA_DIR_REF "/data/misc/profiles/ref"
Benedict Wong8f9d8a42019-01-03 16:19:38 -0800179#define XFRM_STAT_PROC_FILE "/proc/net/xfrm_stat"
Erik Kline08165202016-05-30 11:55:44 +0900180#define WLUTIL "/vendor/xbin/wlutil"
Vishnu Nair36b4cdb2017-11-17 10:27:05 -0800181#define WMTRACE_DATA_DIR "/data/misc/wmtrace"
Yifan Hong3945e1b2019-10-29 12:59:23 -0700182#define OTA_METADATA_DIR "/metadata/ota"
Yifan Hong0efa7972020-02-03 16:45:02 -0800183#define SNAPSHOTCTL_LOG_DIR "/data/misc/snapshotctl_log"
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +0900184#define LINKERCONFIG_DIR "/linkerconfig"
Calin Juravlef84d3692020-04-28 15:31:12 -0700185#define PACKAGE_DEX_USE_LIST "/data/system/package-dex-usage.list"
Primiano Tuccifaaaafb2021-01-14 12:26:29 +0000186#define SYSTEM_TRACE_SNAPSHOT "/data/misc/perfetto-traces/bugreport/systrace.pftrace"
Li Li2eedd412021-06-30 15:11:53 -0700187#define CGROUPFS_DIR "/sys/fs/cgroup"
Mårten Kongstad60195a72022-09-20 14:14:20 +0200188#define SDK_EXT_INFO "/apex/com.android.sdkext/bin/derive_sdk"
Jeff Sharkey9df29d52023-02-06 14:26:30 -0700189#define DROPBOX_DIR "/data/system/dropbox"
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700190
Narayan Kamath8f788292017-05-25 13:20:39 +0100191// TODO(narayan): Since this information has to be kept in sync
192// with tombstoned, we should just put it in a common header.
193//
194// File: system/core/debuggerd/tombstoned/tombstoned.cpp
Narayan Kamathbd863722017-06-01 18:50:12 +0100195static const std::string TOMBSTONE_DIR = "/data/tombstones/";
196static const std::string TOMBSTONE_FILE_PREFIX = "tombstone_";
197static const std::string ANR_DIR = "/data/anr/";
198static const std::string ANR_FILE_PREFIX = "anr_";
Woody Lin20767a92022-11-29 15:50:24 +0800199static const std::string SHUTDOWN_CHECKPOINTS_DIR = "/data/system/shutdown-checkpoints/";
200static const std::string SHUTDOWN_CHECKPOINTS_FILE_PREFIX = "checkpoints-";
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700201
Felipe Lemee844a9d2016-09-21 15:01:39 -0700202// TODO: temporary variables and functions used during C++ refactoring
Nandana Dutt979388e2018-11-30 16:48:55 +0000203
Nandana Dutt5c390032019-03-12 10:52:56 +0000204#define RETURN_IF_USER_DENIED_CONSENT() \
205 if (ds.IsUserConsentDenied()) { \
206 MYLOGE("Returning early as user denied consent to share bugreport with calling app."); \
207 return Dumpstate::RunStatus::USER_CONSENT_DENIED; \
208 }
209
210// Runs func_ptr, but checks user consent before and after running it. Returns USER_CONSENT_DENIED
211// if consent is found to be denied.
212#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(func_ptr, ...) \
213 RETURN_IF_USER_DENIED_CONSENT(); \
214 func_ptr(__VA_ARGS__); \
215 RETURN_IF_USER_DENIED_CONSENT();
216
Rhed Jao5377d792020-07-16 17:37:39 +0800217// Runs func_ptr, and logs a duration report after it's finished.
218#define RUN_SLOW_FUNCTION_AND_LOG(log_title, func_ptr, ...) \
219 { \
220 DurationReporter duration_reporter_in_macro(log_title); \
221 func_ptr(__VA_ARGS__); \
222 }
223
224// Similar with RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK, an additional duration report
225// is output after a slow function is finished.
226#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(log_title, func_ptr, ...) \
227 RETURN_IF_USER_DENIED_CONSENT(); \
228 RUN_SLOW_FUNCTION_AND_LOG(log_title, func_ptr, __VA_ARGS__); \
229 RETURN_IF_USER_DENIED_CONSENT();
230
Chris Morinbc223142022-02-04 14:17:11 -0800231#define WAIT_TASK_WITH_CONSENT_CHECK(future) \
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800232 RETURN_IF_USER_DENIED_CONSENT(); \
Chris Morinbc223142022-02-04 14:17:11 -0800233 WaitForTask(future); \
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800234 RETURN_IF_USER_DENIED_CONSENT();
235
Sahana Raof35ed432019-07-12 10:47:52 +0100236static const char* WAKE_LOCK_NAME = "dumpstate_wakelock";
237
Rhed Jao5377d792020-07-16 17:37:39 +0800238// Names of parallel tasks, they are used for the DumpPool to identify the dump
239// task and the log title of the duration report.
240static const std::string DUMP_TRACES_TASK = "DUMP TRACES";
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800241static const std::string DUMP_INCIDENT_REPORT_TASK = "INCIDENT REPORT";
Aaron Huang24d215d2022-04-27 18:51:16 +0800242static const std::string DUMP_NETSTATS_PROTO_TASK = "DUMP NETSTATS PROTO";
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800243static const std::string DUMP_HALS_TASK = "DUMP HALS";
244static const std::string DUMP_BOARD_TASK = "dumpstate_board()";
Rhed Jaoe017f982020-07-21 17:58:41 +0800245static const std::string DUMP_CHECKINS_TASK = "DUMP CHECKINS";
Kean Mariotti306633e2022-09-05 16:30:47 +0000246static const std::string POST_PROCESS_UI_TRACES_TASK = "POST-PROCESS UI TRACES";
Rhed Jao5377d792020-07-16 17:37:39 +0800247
Nandana Dutt979388e2018-11-30 16:48:55 +0000248namespace android {
249namespace os {
250namespace {
251
252static int Open(std::string path, int flags, mode_t mode = 0) {
253 int fd = TEMP_FAILURE_RETRY(open(path.c_str(), flags, mode));
254 if (fd == -1) {
255 MYLOGE("open(%s, %s)\n", path.c_str(), strerror(errno));
256 }
257 return fd;
258}
259
mhasank2d75c442020-06-11 15:05:25 -0700260static int OpenForWrite(std::string path) {
261 return Open(path, O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
262 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH);
263}
Nandana Dutt979388e2018-11-30 16:48:55 +0000264
265static int OpenForRead(std::string path) {
266 return Open(path, O_RDONLY | O_CLOEXEC | O_NOFOLLOW);
267}
268
269bool CopyFile(int in_fd, int out_fd) {
270 char buf[4096];
271 ssize_t byte_count;
272 while ((byte_count = TEMP_FAILURE_RETRY(read(in_fd, buf, sizeof(buf)))) > 0) {
273 if (!android::base::WriteFully(out_fd, buf, byte_count)) {
274 return false;
275 }
276 }
277 return (byte_count != -1);
278}
279
280static bool CopyFileToFd(const std::string& input_file, int out_fd) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000281 MYLOGD("Going to copy file (%s) to %d\n", input_file.c_str(), out_fd);
Nandana Dutt979388e2018-11-30 16:48:55 +0000282
283 // Obtain a handle to the source file.
284 android::base::unique_fd in_fd(OpenForRead(input_file));
285 if (out_fd != -1 && in_fd.get() != -1) {
286 if (CopyFile(in_fd.get(), out_fd)) {
287 return true;
288 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000289 MYLOGE("Failed to copy file: %s\n", strerror(errno));
Nandana Dutt979388e2018-11-30 16:48:55 +0000290 }
291 return false;
292}
293
Nandana Duttd2f5f082019-01-18 17:13:52 +0000294static bool UnlinkAndLogOnError(const std::string& file) {
Nandana Dutt8ae16e62020-03-27 10:20:22 +0000295 if (file.empty()) {
296 return false;
297 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000298 if (unlink(file.c_str())) {
299 MYLOGE("Failed to unlink file (%s): %s\n", file.c_str(), strerror(errno));
Nandana Duttd2f5f082019-01-18 17:13:52 +0000300 return false;
301 }
302 return true;
303}
Nandana Dutt979388e2018-11-30 16:48:55 +0000304
Nikita Ioffea325a572019-05-16 19:49:47 +0100305int64_t GetModuleMetadataVersion() {
306 auto binder = defaultServiceManager()->getService(android::String16("package_native"));
307 if (binder == nullptr) {
308 MYLOGE("Failed to retrieve package_native service");
309 return 0L;
310 }
311 auto package_service = android::interface_cast<content::pm::IPackageManagerNative>(binder);
312 std::string package_name;
313 auto status = package_service->getModuleMetadataPackageName(&package_name);
314 if (!status.isOk()) {
315 MYLOGE("Failed to retrieve module metadata package name: %s", status.toString8().c_str());
316 return 0L;
317 }
Nandana Duttdb379fa2019-10-09 16:54:41 +0100318 MYLOGD("Module metadata package name: %s\n", package_name.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100319 int64_t version_code;
320 status = package_service->getVersionCodeForPackage(android::String16(package_name.c_str()),
321 &version_code);
322 if (!status.isOk()) {
323 MYLOGE("Failed to retrieve module metadata version: %s", status.toString8().c_str());
324 return 0L;
325 }
326 return version_code;
327}
328
mhasank2d75c442020-06-11 15:05:25 -0700329static bool PathExists(const std::string& path) {
330 struct stat sb;
331 return stat(path.c_str(), &sb) == 0;
332}
333
334static bool CopyFileToFile(const std::string& input_file, const std::string& output_file) {
335 if (input_file == output_file) {
336 MYLOGD("Skipping copying bugreport file since the destination is the same (%s)\n",
337 output_file.c_str());
338 return false;
339 }
340 else if (PathExists(output_file)) {
341 MYLOGD("Cannot overwrite an existing file (%s)\n", output_file.c_str());
342 return false;
343 }
344
345 MYLOGD("Going to copy bugreport file (%s) to %s\n", input_file.c_str(), output_file.c_str());
346 android::base::unique_fd out_fd(OpenForWrite(output_file));
347 return CopyFileToFd(input_file, out_fd.get());
348}
349
Nandana Dutt979388e2018-11-30 16:48:55 +0000350} // namespace
351} // namespace os
352} // namespace android
353
Felipe Leme678727a2016-09-21 17:22:11 -0700354static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
Felipe Lemebda15a02016-11-16 17:48:25 -0800355 const CommandOptions& options = Dumpstate::DEFAULT_DUMPSYS,
Rhed Jaoe017f982020-07-21 17:58:41 +0800356 long dumpsysTimeoutMs = 0, int out_fd = STDOUT_FILENO) {
357 return ds.RunDumpsys(title, dumpsysArgs, options, dumpsysTimeoutMs, out_fd);
358}
359static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
360 int out_fd) {
361 return ds.RunDumpsys(title, dumpsysArgs, Dumpstate::DEFAULT_DUMPSYS, 0, out_fd);
Felipe Leme678727a2016-09-21 17:22:11 -0700362}
363static int DumpFile(const std::string& title, const std::string& path) {
364 return ds.DumpFile(title, path);
365}
Felipe Lemee82a27d2016-01-05 13:35:44 -0800366
Felipe Lemee844a9d2016-09-21 15:01:39 -0700367// Relative directory (inside the zip) for all files copied as-is into the bugreport.
368static const std::string ZIP_ROOT_DIR = "FS";
369
Vishnu Naire97d6122018-01-18 13:58:56 -0800370static const std::string kProtoPath = "proto/";
371static const std::string kProtoExt = ".proto";
Jie Song9fbfad02017-06-20 16:29:42 -0700372static const std::string kDumpstateBoardFiles[] = {
373 "dumpstate_board.txt",
Felipe Leme95d6ca52017-08-01 16:35:56 -0700374 "dumpstate_board.bin"
Jie Song9fbfad02017-06-20 16:29:42 -0700375};
376static const int NUM_OF_DUMPS = arraysize(kDumpstateBoardFiles);
377
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700378static constexpr char PROPERTY_LAST_ID[] = "dumpstate.last_id";
Felipe Lemed071c682016-10-20 16:48:00 -0700379static constexpr char PROPERTY_VERSION[] = "dumpstate.version";
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700380
Felipe Lemef0292972016-11-22 13:57:05 -0800381static const CommandOptions AS_ROOT_20 = CommandOptions::WithTimeout(20).AsRoot().Build();
382
Narayan Kamath8f788292017-05-25 13:20:39 +0100383/*
Narayan Kamathbd863722017-06-01 18:50:12 +0100384 * Returns a vector of dump fds under |dir_path| with a given |file_prefix|.
Rhed Jao01dc0c62020-06-03 17:13:30 +0800385 * The returned vector is sorted by the mtimes of the dumps with descending
Chris Morinc2cba7a2022-02-01 17:06:50 -0800386 * order.
Narayan Kamath8f788292017-05-25 13:20:39 +0100387 */
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700388static std::vector<DumpData> GetDumpFds(const std::string& dir_path,
Chris Morinc2cba7a2022-02-01 17:06:50 -0800389 const std::string& file_prefix) {
Narayan Kamathbd863722017-06-01 18:50:12 +0100390 std::unique_ptr<DIR, decltype(&closedir)> dump_dir(opendir(dir_path.c_str()), closedir);
Narayan Kamath8f788292017-05-25 13:20:39 +0100391
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700392 if (dump_dir == nullptr) {
393 MYLOGW("Unable to open directory %s: %s\n", dir_path.c_str(), strerror(errno));
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700394 return std::vector<DumpData>();
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700395 }
396
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700397 std::vector<DumpData> dump_data;
Narayan Kamathbd863722017-06-01 18:50:12 +0100398 struct dirent* entry = nullptr;
399 while ((entry = readdir(dump_dir.get()))) {
400 if (entry->d_type != DT_REG) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100401 continue;
402 }
403
Narayan Kamathbd863722017-06-01 18:50:12 +0100404 const std::string base_name(entry->d_name);
405 if (base_name.find(file_prefix) != 0) {
406 continue;
407 }
408
409 const std::string abs_path = dir_path + base_name;
410 android::base::unique_fd fd(
411 TEMP_FAILURE_RETRY(open(abs_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW | O_NONBLOCK)));
412 if (fd == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700413 MYLOGW("Unable to open dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamathbd863722017-06-01 18:50:12 +0100414 break;
415 }
416
417 struct stat st = {};
418 if (fstat(fd, &st) == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700419 MYLOGW("Unable to stat dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamath8f788292017-05-25 13:20:39 +0100420 continue;
421 }
422
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700423 dump_data.emplace_back(DumpData{abs_path, std::move(fd), st.st_mtime});
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700424 }
Rhed Jao01dc0c62020-06-03 17:13:30 +0800425 if (!dump_data.empty()) {
426 std::sort(dump_data.begin(), dump_data.end(),
427 [](const auto& a, const auto& b) { return a.mtime > b.mtime; });
428 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100429
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700430 return dump_data;
Narayan Kamath8f788292017-05-25 13:20:39 +0100431}
432
Narayan Kamathbd863722017-06-01 18:50:12 +0100433static bool AddDumps(const std::vector<DumpData>::const_iterator start,
434 const std::vector<DumpData>::const_iterator end,
435 const char* type_name, const bool add_to_zip) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100436 bool dumped = false;
Narayan Kamathbd863722017-06-01 18:50:12 +0100437 for (auto it = start; it != end; ++it) {
438 const std::string& name = it->name;
439 const int fd = it->fd;
Narayan Kamath8f788292017-05-25 13:20:39 +0100440 dumped = true;
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100441
442 // Seek to the beginning of the file before dumping any data. A given
443 // DumpData entry might be dumped multiple times in the report.
444 //
445 // For example, the most recent ANR entry is dumped to the body of the
446 // main entry and it also shows up as a separate entry in the bugreport
447 // ZIP file.
448 if (lseek(fd, 0, SEEK_SET) != static_cast<off_t>(0)) {
449 MYLOGE("Unable to add %s to zip file, lseek failed: %s\n", name.c_str(),
450 strerror(errno));
451 }
452
Chris Morinc2cba7a2022-02-01 17:06:50 -0800453 if (add_to_zip) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800454 if (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + name, fd, /* timeout = */ 0ms) != OK) {
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100455 MYLOGE("Unable to add %s to zip file, addZipEntryFromFd failed\n", name.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100456 }
457 } else {
458 dump_file_from_fd(type_name, name.c_str(), fd);
459 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100460 }
461
462 return dumped;
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700463}
464
Felipe Leme635ca312016-01-05 14:23:02 -0800465// for_each_pid() callback to get mount info about a process.
Felipe Leme4c2d6632016-09-28 14:32:00 -0700466void do_mountinfo(int pid, const char* name __attribute__((unused))) {
Felipe Leme635ca312016-01-05 14:23:02 -0800467 char path[PATH_MAX];
468
469 // Gets the the content of the /proc/PID/ns/mnt link, so only unique mount points
470 // are added.
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700471 snprintf(path, sizeof(path), "/proc/%d/ns/mnt", pid);
Felipe Leme635ca312016-01-05 14:23:02 -0800472 char linkname[PATH_MAX];
473 ssize_t r = readlink(path, linkname, PATH_MAX);
474 if (r == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800475 MYLOGE("Unable to read link for %s: %s\n", path, strerror(errno));
Felipe Leme635ca312016-01-05 14:23:02 -0800476 return;
477 }
478 linkname[r] = '\0';
479
480 if (mount_points.find(linkname) == mount_points.end()) {
481 // First time this mount point was found: add it
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700482 snprintf(path, sizeof(path), "/proc/%d/mountinfo", pid);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700483 if (ds.AddZipEntry(ZIP_ROOT_DIR + path, path)) {
Felipe Leme635ca312016-01-05 14:23:02 -0800484 mount_points.insert(linkname);
485 } else {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800486 MYLOGE("Unable to add mountinfo %s to zip file\n", path);
Felipe Leme635ca312016-01-05 14:23:02 -0800487 }
488 }
489}
490
491void add_mountinfo() {
Felipe Leme678727a2016-09-21 17:22:11 -0700492 std::string title = "MOUNT INFO";
Felipe Leme635ca312016-01-05 14:23:02 -0800493 mount_points.clear();
Felipe Leme46b85da2016-11-21 17:40:45 -0800494 DurationReporter duration_reporter(title, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700495 for_each_pid(do_mountinfo, nullptr);
496 MYLOGD("%s: %d entries added to zip file\n", title.c_str(), (int)mount_points.size());
Felipe Leme635ca312016-01-05 14:23:02 -0800497}
498
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700499static void dump_dev_files(const char *title, const char *driverpath, const char *filename)
500{
501 DIR *d;
502 struct dirent *de;
503 char path[PATH_MAX];
504
505 d = opendir(driverpath);
Yi Kong19d5c002018-07-20 13:39:55 -0700506 if (d == nullptr) {
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700507 return;
508 }
509
510 while ((de = readdir(d))) {
511 if (de->d_type != DT_LNK) {
512 continue;
513 }
514 snprintf(path, sizeof(path), "%s/%s/%s", driverpath, de->d_name, filename);
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700515 DumpFile(title, path);
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700516 }
517
518 closedir(d);
519}
520
Mark Salyzyn326842f2015-04-30 09:49:41 -0700521static bool skip_not_stat(const char *path) {
522 static const char stat[] = "/stat";
523 size_t len = strlen(path);
524 if (path[len - 1] == '/') { /* Directory? */
525 return false;
526 }
527 return strcmp(path + len - sizeof(stat) + 1, stat); /* .../stat? */
528}
529
Jeff Sharkey9df29d52023-02-06 14:26:30 -0700530static bool skip_wtf_strictmode(const char *path) {
531 if (strstr(path, "_wtf")) {
532 return true;
533 } else if (strstr(path, "_strictmode")) {
534 return true;
535 }
536 return false;
537}
538
Felipe Leme4c2d6632016-09-28 14:32:00 -0700539static bool skip_none(const char* path __attribute__((unused))) {
Felipe Lemee82a27d2016-01-05 13:35:44 -0800540 return false;
541}
542
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700543unsigned long worst_write_perf = 20000; /* in KB/s */
Mark Salyzyn326842f2015-04-30 09:49:41 -0700544
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800545//
546// stat offsets
547// Name units description
548// ---- ----- -----------
549// read I/Os requests number of read I/Os processed
550#define __STAT_READ_IOS 0
551// read merges requests number of read I/Os merged with in-queue I/O
552#define __STAT_READ_MERGES 1
553// read sectors sectors number of sectors read
554#define __STAT_READ_SECTORS 2
555// read ticks milliseconds total wait time for read requests
556#define __STAT_READ_TICKS 3
557// write I/Os requests number of write I/Os processed
558#define __STAT_WRITE_IOS 4
559// write merges requests number of write I/Os merged with in-queue I/O
560#define __STAT_WRITE_MERGES 5
561// write sectors sectors number of sectors written
562#define __STAT_WRITE_SECTORS 6
563// write ticks milliseconds total wait time for write requests
564#define __STAT_WRITE_TICKS 7
565// in_flight requests number of I/Os currently in flight
566#define __STAT_IN_FLIGHT 8
567// io_ticks milliseconds total time this block device has been active
568#define __STAT_IO_TICKS 9
569// time_in_queue milliseconds total wait time for all requests
570#define __STAT_IN_QUEUE 10
571#define __STAT_NUMBER_FIELD 11
572//
573// read I/Os, write I/Os
574// =====================
575//
576// These values increment when an I/O request completes.
577//
578// read merges, write merges
579// =========================
580//
581// These values increment when an I/O request is merged with an
582// already-queued I/O request.
583//
584// read sectors, write sectors
585// ===========================
586//
587// These values count the number of sectors read from or written to this
588// block device. The "sectors" in question are the standard UNIX 512-byte
589// sectors, not any device- or filesystem-specific block size. The
590// counters are incremented when the I/O completes.
591#define SECTOR_SIZE 512
592//
593// read ticks, write ticks
594// =======================
595//
596// These values count the number of milliseconds that I/O requests have
597// waited on this block device. If there are multiple I/O requests waiting,
598// these values will increase at a rate greater than 1000/second; for
599// example, if 60 read requests wait for an average of 30 ms, the read_ticks
600// field will increase by 60*30 = 1800.
601//
602// in_flight
603// =========
604//
605// This value counts the number of I/O requests that have been issued to
606// the device driver but have not yet completed. It does not include I/O
607// requests that are in the queue but not yet issued to the device driver.
608//
609// io_ticks
610// ========
611//
612// This value counts the number of milliseconds during which the device has
613// had I/O requests queued.
614//
615// time_in_queue
616// =============
617//
618// This value counts the number of milliseconds that I/O requests have waited
619// on this block device. If there are multiple I/O requests waiting, this
620// value will increase as the product of the number of milliseconds times the
621// number of requests waiting (see "read ticks" above for an example).
622#define S_TO_MS 1000
623//
624
Mark Salyzyn326842f2015-04-30 09:49:41 -0700625static int dump_stat_from_fd(const char *title __unused, const char *path, int fd) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800626 unsigned long long fields[__STAT_NUMBER_FIELD];
Mark Salyzyn326842f2015-04-30 09:49:41 -0700627 bool z;
Yi Kong19d5c002018-07-20 13:39:55 -0700628 char *cp, *buffer = nullptr;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700629 size_t i = 0;
Josh Gao7c4258c2018-06-25 13:40:08 -0700630 FILE *fp = fdopen(dup(fd), "rb");
Mark Salyzyn326842f2015-04-30 09:49:41 -0700631 getline(&buffer, &i, fp);
632 fclose(fp);
633 if (!buffer) {
634 return -errno;
635 }
636 i = strlen(buffer);
637 while ((i > 0) && (buffer[i - 1] == '\n')) {
638 buffer[--i] = '\0';
639 }
640 if (!*buffer) {
641 free(buffer);
642 return 0;
643 }
644 z = true;
645 for (cp = buffer, i = 0; i < (sizeof(fields) / sizeof(fields[0])); ++i) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800646 fields[i] = strtoull(cp, &cp, 10);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700647 if (fields[i] != 0) {
648 z = false;
649 }
650 }
651 if (z) { /* never accessed */
652 free(buffer);
653 return 0;
654 }
655
Wei Wang509bb5d2017-06-09 14:42:12 -0700656 if (!strncmp(path, BLK_DEV_SYS_DIR, sizeof(BLK_DEV_SYS_DIR) - 1)) {
657 path += sizeof(BLK_DEV_SYS_DIR) - 1;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700658 }
Wei Wang1dc1ef52017-06-12 11:28:37 -0700659
660 printf("%-30s:%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s\n%-30s:\t%s\n", "Block-Dev",
661 "R-IOs", "R-merg", "R-sect", "R-wait", "W-IOs", "W-merg", "W-sect",
662 "W-wait", "in-fli", "activ", "T-wait", path, buffer);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700663 free(buffer);
664
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800665 if (fields[__STAT_IO_TICKS]) {
666 unsigned long read_perf = 0;
667 unsigned long read_ios = 0;
668 if (fields[__STAT_READ_TICKS]) {
669 unsigned long long divisor = fields[__STAT_READ_TICKS]
670 * fields[__STAT_IO_TICKS];
671 read_perf = ((unsigned long long)SECTOR_SIZE
672 * fields[__STAT_READ_SECTORS]
673 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
674 / divisor;
675 read_ios = ((unsigned long long)S_TO_MS * fields[__STAT_READ_IOS]
676 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
677 / divisor;
678 }
679
680 unsigned long write_perf = 0;
681 unsigned long write_ios = 0;
682 if (fields[__STAT_WRITE_TICKS]) {
683 unsigned long long divisor = fields[__STAT_WRITE_TICKS]
684 * fields[__STAT_IO_TICKS];
685 write_perf = ((unsigned long long)SECTOR_SIZE
686 * fields[__STAT_WRITE_SECTORS]
687 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
688 / divisor;
689 write_ios = ((unsigned long long)S_TO_MS * fields[__STAT_WRITE_IOS]
690 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
691 / divisor;
692 }
693
694 unsigned queue = (fields[__STAT_IN_QUEUE]
695 + (fields[__STAT_IO_TICKS] >> 1))
696 / fields[__STAT_IO_TICKS];
697
698 if (!write_perf && !write_ios) {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700699 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 -0800700 } else {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700701 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 -0800702 read_ios, write_perf, write_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800703 }
704
705 /* bugreport timeout factor adjustment */
706 if ((write_perf > 1) && (write_perf < worst_write_perf)) {
707 worst_write_perf = write_perf;
708 }
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700709 }
Mark Salyzyn326842f2015-04-30 09:49:41 -0700710 return 0;
711}
712
Yao Chenbe3bbc12018-01-17 16:31:10 -0800713static const long MINIMUM_LOGCAT_TIMEOUT_MS = 50000;
714
Tom Cherryf4472f32020-08-05 09:31:17 -0700715// Returns the actual readable size of the given buffer or -1 on error.
716static long logcat_buffer_readable_size(const std::string& buffer) {
717 std::unique_ptr<logger_list, decltype(&android_logger_list_free)> logger_list{
718 android_logger_list_alloc(0, 0, 0), &android_logger_list_free};
719 auto logger = android_logger_open(logger_list.get(), android_name_to_log_id(buffer.c_str()));
720
721 return android_logger_get_log_readable_size(logger);
722}
723
724// Returns timeout in ms to read a list of buffers.
Yao Chenbe3bbc12018-01-17 16:31:10 -0800725static unsigned long logcat_timeout(const std::vector<std::string>& buffers) {
726 unsigned long timeout_ms = 0;
727 for (const auto& buffer : buffers) {
Tom Cherryf4472f32020-08-05 09:31:17 -0700728 long readable_size = logcat_buffer_readable_size(buffer);
729 if (readable_size > 0) {
730 // Engineering margin is ten-fold our guess.
731 timeout_ms += 10 * (readable_size + worst_write_perf) / worst_write_perf;
732 }
Yao Chenbe3bbc12018-01-17 16:31:10 -0800733 }
734 return timeout_ms > MINIMUM_LOGCAT_TIMEOUT_MS ? timeout_ms : MINIMUM_LOGCAT_TIMEOUT_MS;
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700735}
736
Dieter Hsu105ad0c2020-09-29 15:23:33 +0800737// Opens a socket and returns its file descriptor.
738static int open_socket(const char* service);
739
Nandana Duttd2f5f082019-01-18 17:13:52 +0000740Dumpstate::ConsentCallback::ConsentCallback() : result_(UNAVAILABLE), start_time_(Nanotime()) {
741}
742
743android::binder::Status Dumpstate::ConsentCallback::onReportApproved() {
744 std::lock_guard<std::mutex> lock(lock_);
745 result_ = APPROVED;
746 MYLOGD("User approved consent to share bugreport\n");
Paul Chang0d2aad72020-02-13 20:04:03 +0800747
748 // Maybe copy screenshot so calling app can display the screenshot to the user as soon as
749 // consent is granted.
750 if (ds.options_->is_screenshot_copied) {
751 return android::binder::Status::ok();
752 }
753
754 if (!ds.options_->do_screenshot || ds.options_->screenshot_fd.get() == -1 ||
755 !ds.do_early_screenshot_) {
756 return android::binder::Status::ok();
757 }
758
759 bool copy_succeeded = android::os::CopyFileToFd(ds.screenshot_path_,
760 ds.options_->screenshot_fd.get());
761 ds.options_->is_screenshot_copied = copy_succeeded;
762 if (copy_succeeded) {
763 android::os::UnlinkAndLogOnError(ds.screenshot_path_);
764 }
Nandana Duttd2f5f082019-01-18 17:13:52 +0000765 return android::binder::Status::ok();
766}
767
768android::binder::Status Dumpstate::ConsentCallback::onReportDenied() {
769 std::lock_guard<std::mutex> lock(lock_);
770 result_ = DENIED;
771 MYLOGW("User denied consent to share bugreport\n");
772 return android::binder::Status::ok();
773}
774
775UserConsentResult Dumpstate::ConsentCallback::getResult() {
776 std::lock_guard<std::mutex> lock(lock_);
777 return result_;
778}
779
780uint64_t Dumpstate::ConsentCallback::getElapsedTimeMs() const {
Hunter Knepshieldf0a39052020-01-03 14:53:04 -0800781 return (Nanotime() - start_time_) / NANOS_PER_MILLI;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000782}
783
Felipe Leme2b9b06c2016-10-14 09:13:06 -0700784void Dumpstate::PrintHeader() const {
Mårten Kongstad60195a72022-09-20 14:14:20 +0200785 std::string build, fingerprint, radio, bootloader, network, sdkversion;
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700786 char date[80];
Colin Crossf45fa6b2012-03-26 12:38:26 -0700787
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700788 build = android::base::GetProperty("ro.build.display.id", "(unknown)");
789 fingerprint = android::base::GetProperty("ro.build.fingerprint", "(unknown)");
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700790 radio = android::base::GetProperty("gsm.version.baseband", "(unknown)");
791 bootloader = android::base::GetProperty("ro.bootloader", "(unknown)");
792 network = android::base::GetProperty("gsm.operator.alpha", "(unknown)");
Mårten Kongstad60195a72022-09-20 14:14:20 +0200793 sdkversion = android::base::GetProperty("ro.build.version.sdk", "(unknown)");
Felipe Lemebbaf3c12016-10-11 14:32:25 -0700794 strftime(date, sizeof(date), "%Y-%m-%d %H:%M:%S", localtime(&now_));
Colin Crossf45fa6b2012-03-26 12:38:26 -0700795
Felipe Lemed8b94e52016-12-08 10:21:44 -0800796 printf("========================================================\n");
797 printf("== dumpstate: %s\n", date);
798 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -0700799
Felipe Lemed8b94e52016-12-08 10:21:44 -0800800 printf("\n");
801 printf("Build: %s\n", build.c_str());
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700802 // NOTE: fingerprint entry format is important for other tools.
Felipe Lemed8b94e52016-12-08 10:21:44 -0800803 printf("Build fingerprint: '%s'\n", fingerprint.c_str());
804 printf("Bootloader: %s\n", bootloader.c_str());
805 printf("Radio: %s\n", radio.c_str());
806 printf("Network: %s\n", network.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100807 int64_t module_metadata_version = android::os::GetModuleMetadataVersion();
808 if (module_metadata_version != 0) {
809 printf("Module Metadata version: %" PRId64 "\n", module_metadata_version);
810 }
Mårten Kongstad60195a72022-09-20 14:14:20 +0200811 printf("Android SDK version: %s\n", sdkversion.c_str());
812 printf("SDK extensions: ");
813 RunCommandToFd(STDOUT_FILENO, "", {SDK_EXT_INFO, "--header"},
814 CommandOptions::WithTimeout(1).Always().DropRoot().Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -0700815
Felipe Lemed8b94e52016-12-08 10:21:44 -0800816 printf("Kernel: ");
Felipe Lemef0292972016-11-22 13:57:05 -0800817 DumpFileToFd(STDOUT_FILENO, "", "/proc/version");
Felipe Lemed8b94e52016-12-08 10:21:44 -0800818 printf("Command line: %s\n", strtok(cmdline_buf, "\n"));
Felipe Leme7709f8a2017-12-05 09:30:09 -0800819 printf("Uptime: ");
820 RunCommandToFd(STDOUT_FILENO, "", {"uptime", "-p"},
821 CommandOptions::WithTimeout(1).Always().Build());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800822 printf("Bugreport format version: %s\n", version_.c_str());
Rhed Jao5377d792020-07-16 17:37:39 +0800823 printf("Dumpstate info: id=%d pid=%d dry_run=%d parallel_run=%d args=%s bugreport_mode=%s\n",
824 id_, pid_, PropertiesHelper::IsDryRun(), PropertiesHelper::IsParallelRun(),
Kedar Chitnis9fd8c052021-11-16 09:09:22 +0000825 options_->args.c_str(), options_->bugreport_mode_string.c_str());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800826 printf("\n");
Felipe Leme78f2c862015-12-21 09:55:22 -0800827}
828
Felipe Leme24b66ee2016-06-16 10:55:26 -0700829// List of file extensions that can cause a zip file attachment to be rejected by some email
830// service providers.
831static const std::set<std::string> PROBLEMATIC_FILE_EXTENSIONS = {
832 ".ade", ".adp", ".bat", ".chm", ".cmd", ".com", ".cpl", ".exe", ".hta", ".ins", ".isp",
833 ".jar", ".jse", ".lib", ".lnk", ".mde", ".msc", ".msp", ".mst", ".pif", ".scr", ".sct",
834 ".shb", ".sys", ".vb", ".vbe", ".vbs", ".vxd", ".wsc", ".wsf", ".wsh"
835};
836
Vishnu Naire97d6122018-01-18 13:58:56 -0800837status_t Dumpstate::AddZipEntryFromFd(const std::string& entry_name, int fd,
838 std::chrono::milliseconds timeout = 0ms) {
Felipe Leme24b66ee2016-06-16 10:55:26 -0700839 std::string valid_name = entry_name;
840
841 // Rename extension if necessary.
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -0700842 size_t idx = entry_name.rfind('.');
Felipe Leme24b66ee2016-06-16 10:55:26 -0700843 if (idx != std::string::npos) {
844 std::string extension = entry_name.substr(idx);
845 std::transform(extension.begin(), extension.end(), extension.begin(), ::tolower);
846 if (PROBLEMATIC_FILE_EXTENSIONS.count(extension) != 0) {
847 valid_name = entry_name + ".renamed";
848 MYLOGI("Renaming entry %s to %s\n", entry_name.c_str(), valid_name.c_str());
849 }
850 }
851
Felipe Leme6fe9db62016-02-12 09:04:16 -0800852 // Logging statement below is useful to time how long each entry takes, but it's too verbose.
853 // MYLOGD("Adding zip entry %s\n", entry_name.c_str());
Kevin Jeon9bbe0ac2022-05-05 22:05:43 +0000854 size_t flags = ZipWriter::kCompress | ZipWriter::kDefaultCompression;
855 int32_t err = zip_writer_->StartEntryWithTime(valid_name.c_str(), flags,
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700856 get_mtime(fd, ds.now_));
Felipe Leme1d486fe2016-10-14 18:06:47 -0700857 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700858 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", valid_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700859 ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800860 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800861 }
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000862 bool finished_entry = false;
863 auto finish_entry = [this, &finished_entry] {
864 if (!finished_entry) {
865 // This should only be called when we're going to return an earlier error,
866 // which would've been logged. This may imply the file is already corrupt
867 // and any further logging from FinishEntry is more likely to mislead than
868 // not.
869 this->zip_writer_->FinishEntry();
870 }
871 };
872 auto scope_guard = android::base::make_scope_guard(finish_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -0800873 auto start = std::chrono::steady_clock::now();
874 auto end = start + timeout;
875 struct pollfd pfd = {fd, POLLIN};
Felipe Lemee82a27d2016-01-05 13:35:44 -0800876
Felipe Leme770410d2016-01-26 17:07:14 -0800877 std::vector<uint8_t> buffer(65536);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800878 while (1) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800879 if (timeout.count() > 0) {
880 // lambda to recalculate the timeout.
881 auto time_left_ms = [end]() {
882 auto now = std::chrono::steady_clock::now();
883 auto diff = std::chrono::duration_cast<std::chrono::milliseconds>(end - now);
884 return std::max(diff.count(), 0LL);
885 };
886
887 int rc = TEMP_FAILURE_RETRY(poll(&pfd, 1, time_left_ms()));
888 if (rc < 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000889 MYLOGE("Error in poll while adding from fd to zip entry %s:%s\n",
890 entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800891 return -errno;
892 } else if (rc == 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000893 MYLOGE("Timed out adding from fd to zip entry %s:%s Timeout:%lldms\n",
Vishnu Naire97d6122018-01-18 13:58:56 -0800894 entry_name.c_str(), strerror(errno), timeout.count());
895 return TIMED_OUT;
896 }
897 }
898
Zach Riggle22200402016-08-18 01:01:24 -0400899 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800900 if (bytes_read == 0) {
901 break;
902 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800903 MYLOGE("read(%s): %s\n", entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800904 return -errno;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800905 }
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700906 err = zip_writer_->WriteBytes(buffer.data(), bytes_read);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800907 if (err) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700908 MYLOGE("zip_writer_->WriteBytes(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800909 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800910 }
911 }
912
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700913 err = zip_writer_->FinishEntry();
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000914 finished_entry = true;
Felipe Leme1d486fe2016-10-14 18:06:47 -0700915 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700916 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800917 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800918 }
919
Vishnu Naire97d6122018-01-18 13:58:56 -0800920 return OK;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800921}
922
Felipe Leme1d486fe2016-10-14 18:06:47 -0700923bool Dumpstate::AddZipEntry(const std::string& entry_name, const std::string& entry_path) {
924 android::base::unique_fd fd(
925 TEMP_FAILURE_RETRY(open(entry_path.c_str(), O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
Andreas Gampeaff68432016-07-18 18:01:27 -0700926 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800927 MYLOGE("open(%s): %s\n", entry_path.c_str(), strerror(errno));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800928 return false;
929 }
930
Vishnu Naire97d6122018-01-18 13:58:56 -0800931 return (AddZipEntryFromFd(entry_name, fd.get()) == OK);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800932}
933
934/* adds a file to the existing zipped bugreport */
Felipe Leme4c2d6632016-09-28 14:32:00 -0700935static int _add_file_from_fd(const char* title __attribute__((unused)), const char* path, int fd) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800936 return (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + path, fd) == OK) ? 0 : 1;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800937}
938
Felipe Leme1d486fe2016-10-14 18:06:47 -0700939void Dumpstate::AddDir(const std::string& dir, bool recursive) {
Felipe Leme678727a2016-09-21 17:22:11 -0700940 MYLOGD("Adding dir %s (recursive: %d)\n", dir.c_str(), recursive);
Felipe Leme46b85da2016-11-21 17:40:45 -0800941 DurationReporter duration_reporter(dir, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700942 dump_files("", dir.c_str(), recursive ? skip_none : is_dir, _add_file_from_fd);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800943}
944
Felipe Leme1d486fe2016-10-14 18:06:47 -0700945bool Dumpstate::AddTextZipEntry(const std::string& entry_name, const std::string& content) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800946 MYLOGD("Adding zip text entry %s\n", entry_name.c_str());
Kevin Jeon9bbe0ac2022-05-05 22:05:43 +0000947 size_t flags = ZipWriter::kCompress | ZipWriter::kDefaultCompression;
948 int32_t err = zip_writer_->StartEntryWithTime(entry_name.c_str(), flags, ds.now_);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700949 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700950 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700951 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800952 return false;
953 }
954
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700955 err = zip_writer_->WriteBytes(content.c_str(), content.length());
Felipe Leme1d486fe2016-10-14 18:06:47 -0700956 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700957 MYLOGE("zip_writer_->WriteBytes(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700958 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800959 return false;
960 }
961
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700962 err = zip_writer_->FinishEntry();
Felipe Leme1d486fe2016-10-14 18:06:47 -0700963 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700964 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800965 return false;
966 }
967
968 return true;
969}
970
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800971static void DoKmsg() {
972 struct stat st;
973 if (!stat(PSTORE_LAST_KMSG, &st)) {
974 /* Also TODO: Make console-ramoops CAP_SYSLOG protected. */
975 DumpFile("LAST KMSG", PSTORE_LAST_KMSG);
976 } else if (!stat(ALT_PSTORE_LAST_KMSG, &st)) {
977 DumpFile("LAST KMSG", ALT_PSTORE_LAST_KMSG);
978 } else {
979 /* TODO: Make last_kmsg CAP_SYSLOG protected. b/5555691 */
980 DumpFile("LAST KMSG", "/proc/last_kmsg");
981 }
982}
983
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800984static void DoKernelLogcat() {
Yao Chenbe3bbc12018-01-17 16:31:10 -0800985 unsigned long timeout_ms = logcat_timeout({"kernel"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800986 RunCommand(
987 "KERNEL LOG",
988 {"logcat", "-b", "kernel", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
989 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
990}
991
Nandana Duttdb379fa2019-10-09 16:54:41 +0100992static void DoSystemLogcat(time_t since) {
993 char since_str[80];
994 strftime(since_str, sizeof(since_str), "%Y-%m-%d %H:%M:%S.000", localtime(&since));
995
996 unsigned long timeout_ms = logcat_timeout({"main", "system", "crash"});
997 RunCommand("SYSTEM LOG",
998 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v", "-T",
999 since_str},
1000 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1001}
1002
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001003static void DoRadioLogcat() {
1004 unsigned long timeout_ms = logcat_timeout({"radio"});
1005 RunCommand(
1006 "RADIO LOG",
1007 {"logcat", "-b", "radio", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1008 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
1009}
1010
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001011static void DoLogcat() {
Vishnu Nair6921f802017-11-22 09:17:23 -08001012 unsigned long timeout_ms;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001013 // DumpFile("EVENT LOG TAGS", "/etc/event-log-tags");
1014 // calculate timeout
Yao Chenbe3bbc12018-01-17 16:31:10 -08001015 timeout_ms = logcat_timeout({"main", "system", "crash"});
Tony Makae737652017-03-30 17:47:09 +01001016 RunCommand("SYSTEM LOG",
Vishnu Nair6921f802017-11-22 09:17:23 -08001017 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1018 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -08001019 timeout_ms = logcat_timeout({"events"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001020 RunCommand(
1021 "EVENT LOG",
1022 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001023 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Yao Chenbe3bbc12018-01-17 16:31:10 -08001024 timeout_ms = logcat_timeout({"stats"});
1025 RunCommand(
1026 "STATS LOG",
1027 {"logcat", "-b", "stats", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001028 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001029 DoRadioLogcat();
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001030
1031 RunCommand("LOG STATISTICS", {"logcat", "-b", "all", "-S"});
1032
1033 /* kernels must set CONFIG_PSTORE_PMSG, slice up pstore with device tree */
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001034 RunCommand("LAST LOGCAT", {"logcat", "-L", "-b", "all", "-v", "threadtime", "-v", "printable",
1035 "-v", "uid", "-d", "*:v"});
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001036}
1037
Mike Ma5c267872019-08-21 11:31:34 -07001038static void DumpIncidentReport() {
Mike Ma5c267872019-08-21 11:31:34 -07001039 const std::string path = ds.bugreport_internal_dir_ + "/tmp_incident_report";
1040 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1041 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1042 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1043 if (fd < 0) {
1044 MYLOGE("Could not open %s to dump incident report.\n", path.c_str());
1045 return;
1046 }
Kevin Jeon774abde2022-09-28 18:20:43 +00001047 RunCommandToFd(fd, "", {"incident", "-u"}, CommandOptions::WithTimeout(20).Build());
Mike Ma5c267872019-08-21 11:31:34 -07001048 bool empty = 0 == lseek(fd, 0, SEEK_END);
1049 if (!empty) {
1050 // Use a different name from "incident.proto"
1051 // /proto/incident.proto is reserved for incident service dump
1052 // i.e. metadata for debugging.
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001053 ds.EnqueueAddZipEntryAndCleanupIfNeeded(kProtoPath + "incident_report" + kProtoExt,
1054 path);
1055 } else {
1056 unlink(path.c_str());
Mike Ma5c267872019-08-21 11:31:34 -07001057 }
Mike Ma5c267872019-08-21 11:31:34 -07001058}
1059
Aaron Huang24d215d2022-04-27 18:51:16 +08001060static void DumpNetstatsProto() {
1061 const std::string path = ds.bugreport_internal_dir_ + "/tmp_netstats_proto";
1062 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1063 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1064 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1065 if (fd < 0) {
1066 MYLOGE("Could not open %s to dump netstats proto.\n", path.c_str());
1067 return;
1068 }
1069 RunCommandToFd(fd, "", {"dumpsys", "netstats", "--proto"},
Kevin Jeon2fb3dd62022-09-28 18:48:55 +00001070 CommandOptions::WithTimeout(5).Build());
Aaron Huang24d215d2022-04-27 18:51:16 +08001071 bool empty = 0 == lseek(fd, 0, SEEK_END);
1072 if (!empty) {
1073 ds.EnqueueAddZipEntryAndCleanupIfNeeded(kProtoPath + "netstats" + kProtoExt,
1074 path);
1075 } else {
1076 unlink(path.c_str());
1077 }
1078}
1079
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001080static void MaybeAddSystemTraceToZip() {
1081 // This function copies into the .zip the system trace that was snapshotted
1082 // by the early call to MaybeSnapshotSystemTrace(), if any background
1083 // tracing was happening.
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001084 if (!ds.has_system_trace_) {
1085 // No background trace was happening at the time dumpstate was invoked.
1086 return;
1087 }
1088 ds.AddZipEntry(
1089 ZIP_ROOT_DIR + SYSTEM_TRACE_SNAPSHOT,
1090 SYSTEM_TRACE_SNAPSHOT);
1091 android::os::UnlinkAndLogOnError(SYSTEM_TRACE_SNAPSHOT);
1092}
1093
Sunny Goyal35949782019-11-19 15:54:36 -08001094static void DumpVisibleWindowViews() {
Sunny Goyal35949782019-11-19 15:54:36 -08001095 DurationReporter duration_reporter("VISIBLE WINDOW VIEWS");
1096 const std::string path = ds.bugreport_internal_dir_ + "/tmp_visible_window_views";
1097 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1098 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1099 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1100 if (fd < 0) {
1101 MYLOGE("Could not open %s to dump visible views.\n", path.c_str());
1102 return;
1103 }
1104 RunCommandToFd(fd, "", {"cmd", "window", "dump-visible-window-views"},
Kevin Jeon774abde2022-09-28 18:20:43 +00001105 CommandOptions::WithTimeout(10).Build());
Sunny Goyal35949782019-11-19 15:54:36 -08001106 bool empty = 0 == lseek(fd, 0, SEEK_END);
1107 if (!empty) {
1108 ds.AddZipEntry("visible_windows.zip", path);
1109 } else {
1110 MYLOGW("Failed to dump visible windows\n");
1111 }
1112 unlink(path.c_str());
1113}
1114
Jayachandran Ca94c7172017-06-10 15:08:12 -07001115static void DumpIpTablesAsRoot() {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001116 RunCommand("IPTABLES", {"iptables", "-L", "-nvx"});
1117 RunCommand("IP6TABLES", {"ip6tables", "-L", "-nvx"});
Erik Kline32af8c22016-09-28 17:26:26 +09001118 RunCommand("IPTABLES NAT", {"iptables", "-t", "nat", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001119 /* no ip6 nat */
Erik Kline32af8c22016-09-28 17:26:26 +09001120 RunCommand("IPTABLES MANGLE", {"iptables", "-t", "mangle", "-L", "-nvx"});
1121 RunCommand("IP6TABLES MANGLE", {"ip6tables", "-t", "mangle", "-L", "-nvx"});
1122 RunCommand("IPTABLES RAW", {"iptables", "-t", "raw", "-L", "-nvx"});
1123 RunCommand("IP6TABLES RAW", {"ip6tables", "-t", "raw", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001124}
1125
Woody Lin20767a92022-11-29 15:50:24 +08001126static void DumpShutdownCheckpoints() {
1127 const bool shutdown_checkpoints_dumped = AddDumps(
1128 ds.shutdown_checkpoints_.begin(), ds.shutdown_checkpoints_.end(),
1129 "SHUTDOWN CHECKPOINTS", false /* add_to_zip */);
1130 if (!shutdown_checkpoints_dumped) {
1131 printf("*** NO SHUTDOWN CHECKPOINTS to dump in %s\n\n",
1132 SHUTDOWN_CHECKPOINTS_DIR.c_str());
1133 }
1134}
1135
David Andersond9ba4752018-12-11 18:26:59 -08001136static void DumpDynamicPartitionInfo() {
1137 if (!::android::base::GetBoolProperty("ro.boot.dynamic_partitions", false)) {
1138 return;
1139 }
1140
1141 RunCommand("LPDUMP", {"lpdump", "--all"});
David Anderson6650ade2019-10-02 15:18:59 -07001142 RunCommand("DEVICE-MAPPER", {"gsid", "dump-device-mapper"});
David Andersond9ba4752018-12-11 18:26:59 -08001143}
1144
Chris Morin5a50d482022-02-01 17:41:18 -08001145static void AddAnrTraceDir(const std::string& anr_traces_dir) {
Narayan Kamath8f788292017-05-25 13:20:39 +01001146 MYLOGD("AddAnrTraceDir(): dump_traces_file=%s, anr_traces_dir=%s\n", dump_traces_path,
1147 anr_traces_dir.c_str());
1148
1149 // If we're here, dump_traces_path will always be a temporary file
1150 // (created with mkostemp or similar) that contains dumps taken earlier
1151 // on in the process.
1152 if (dump_traces_path != nullptr) {
Chris Morin5a50d482022-02-01 17:41:18 -08001153 MYLOGD("Dumping current ANR traces (%s) to the main bugreport entry\n",
1154 dump_traces_path);
1155 ds.DumpFile("VM TRACES JUST NOW", dump_traces_path);
Narayan Kamath8f788292017-05-25 13:20:39 +01001156
1157 const int ret = unlink(dump_traces_path);
1158 if (ret == -1) {
1159 MYLOGW("Error unlinking temporary trace path %s: %s\n", dump_traces_path,
1160 strerror(errno));
Felipe Lemee184f662016-10-27 10:04:47 -07001161 }
1162 }
1163
Narayan Kamathbd863722017-06-01 18:50:12 +01001164 // Add a specific message for the first ANR Dump.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001165 if (ds.anr_data_.size() > 0) {
Chris Morin5a50d482022-02-01 17:41:18 -08001166 // The "last" ANR will always be present in the body of the main entry.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001167 AddDumps(ds.anr_data_.begin(), ds.anr_data_.begin() + 1,
Chris Morin5a50d482022-02-01 17:41:18 -08001168 "VM TRACES AT LAST ANR", false /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001169
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001170 // Historical ANRs are always included as separate entries in the bugreport zip file.
Chris Morin5a50d482022-02-01 17:41:18 -08001171 AddDumps(ds.anr_data_.begin(), ds.anr_data_.end(),
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001172 "HISTORICAL ANR", true /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001173 } else {
Narayan Kamath8f788292017-05-25 13:20:39 +01001174 printf("*** NO ANRs to dump in %s\n\n", ANR_DIR.c_str());
1175 }
1176}
1177
1178static void AddAnrTraceFiles() {
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001179 std::string anr_traces_dir = "/data/anr";
Narayan Kamath8f788292017-05-25 13:20:39 +01001180
Chris Morin5a50d482022-02-01 17:41:18 -08001181 AddAnrTraceDir(anr_traces_dir);
Narayan Kamath8f788292017-05-25 13:20:39 +01001182
Makoto Onuki83ec63f2019-01-31 17:08:59 -08001183 RunCommand("ANR FILES", {"ls", "-lt", ANR_DIR});
1184
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001185 // Slow traces for slow operations.
Felipe Lemee184f662016-10-27 10:04:47 -07001186 struct stat st;
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001187 int i = 0;
1188 while (true) {
1189 const std::string slow_trace_path =
1190 anr_traces_dir + android::base::StringPrintf("slow%02d.txt", i);
1191 if (stat(slow_trace_path.c_str(), &st)) {
1192 // No traces file at this index, done with the files.
1193 break;
Felipe Lemee184f662016-10-27 10:04:47 -07001194 }
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001195 ds.DumpFile("VM TRACES WHEN SLOW", slow_trace_path.c_str());
1196 i++;
Felipe Lemee184f662016-10-27 10:04:47 -07001197 }
1198}
1199
Wei Wang509bb5d2017-06-09 14:42:12 -07001200static void DumpBlockStatFiles() {
1201 DurationReporter duration_reporter("DUMP BLOCK STAT");
Wei Wang509bb5d2017-06-09 14:42:12 -07001202
Wei Wang1dc1ef52017-06-12 11:28:37 -07001203 std::unique_ptr<DIR, std::function<int(DIR*)>> dirptr(opendir(BLK_DEV_SYS_DIR), closedir);
1204
1205 if (dirptr == nullptr) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001206 MYLOGE("Failed to open %s: %s\n", BLK_DEV_SYS_DIR, strerror(errno));
1207 return;
1208 }
1209
1210 printf("------ DUMP BLOCK STAT ------\n\n");
Wei Wang1dc1ef52017-06-12 11:28:37 -07001211 while (struct dirent *d = readdir(dirptr.get())) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001212 if ((d->d_name[0] == '.')
1213 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
1214 || (d->d_name[1] == '\0'))) {
1215 continue;
1216 }
1217 const std::string new_path =
1218 android::base::StringPrintf("%s/%s", BLK_DEV_SYS_DIR, d->d_name);
1219 printf("------ BLOCK STAT (%s) ------\n", new_path.c_str());
1220 dump_files("", new_path.c_str(), skip_not_stat, dump_stat_from_fd);
1221 printf("\n");
1222 }
Wei Wang1dc1ef52017-06-12 11:28:37 -07001223 return;
Wei Wang509bb5d2017-06-09 14:42:12 -07001224}
Jayachandran Ca94c7172017-06-10 15:08:12 -07001225
1226static void DumpPacketStats() {
1227 DumpFile("NETWORK DEV INFO", "/proc/net/dev");
Jayachandran Ca94c7172017-06-10 15:08:12 -07001228}
1229
1230static void DumpIpAddrAndRules() {
1231 /* The following have a tendency to get wedged when wifi drivers/fw goes belly-up. */
1232 RunCommand("NETWORK INTERFACES", {"ip", "link"});
1233 RunCommand("IPv4 ADDRESSES", {"ip", "-4", "addr", "show"});
1234 RunCommand("IPv6 ADDRESSES", {"ip", "-6", "addr", "show"});
1235 RunCommand("IP RULES", {"ip", "rule", "show"});
1236 RunCommand("IP RULES v6", {"ip", "-6", "rule", "show"});
1237}
1238
Nandana Dutt5c390032019-03-12 10:52:56 +00001239static Dumpstate::RunStatus RunDumpsysTextByPriority(const std::string& title, int priority,
1240 std::chrono::milliseconds timeout,
1241 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001242 auto start = std::chrono::steady_clock::now();
Vishnu Naire97d6122018-01-18 13:58:56 -08001243 sp<android::IServiceManager> sm = defaultServiceManager();
1244 Dumpsys dumpsys(sm.get());
Vishnu Naire97d6122018-01-18 13:58:56 -08001245 Vector<String16> args;
1246 Dumpsys::setServiceArgs(args, /* asProto = */ false, priority);
Vishnu Naire97d6122018-01-18 13:58:56 -08001247 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ false);
1248 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001249 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001250 std::string path(title);
1251 path.append(" - ").append(String8(service).c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -08001252 size_t bytes_written = 0;
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001253 if (PropertiesHelper::IsDryRun()) {
1254 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1255 dumpsys.writeDumpFooter(STDOUT_FILENO, service, std::chrono::milliseconds(1));
1256 } else {
Devin Mooreae68df22023-02-24 20:59:51 +00001257 status_t status = dumpsys.startDumpThread(Dumpsys::TYPE_DUMP | Dumpsys::TYPE_PID,
1258 service, args);
1259 if (status == OK) {
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001260 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1261 std::chrono::duration<double> elapsed_seconds;
1262 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH &&
1263 service == String16("meminfo")) {
1264 // Use a longer timeout for meminfo, since 30s is not always enough.
1265 status = dumpsys.writeDump(STDOUT_FILENO, service, 60s,
1266 /* as_proto = */ false, elapsed_seconds,
1267 bytes_written);
1268 } else {
1269 status = dumpsys.writeDump(STDOUT_FILENO, service, service_timeout,
1270 /* as_proto = */ false, elapsed_seconds,
1271 bytes_written);
1272 }
1273 dumpsys.writeDumpFooter(STDOUT_FILENO, service, elapsed_seconds);
1274 bool dump_complete = (status == OK);
1275 dumpsys.stopDumpThread(dump_complete);
Gavin Corkeryfac7e2b2021-07-08 22:39:02 +01001276 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001277 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001278
1279 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1280 std::chrono::steady_clock::now() - start);
1281 if (elapsed_duration > timeout) {
1282 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1283 elapsed_duration.count());
1284 break;
1285 }
1286 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001287 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001288}
1289
Vishnu Nair64afc022018-02-01 15:29:34 -08001290static void RunDumpsysText(const std::string& title, int priority,
1291 std::chrono::milliseconds timeout,
1292 std::chrono::milliseconds service_timeout) {
1293 DurationReporter duration_reporter(title);
1294 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1295 fsync(STDOUT_FILENO);
1296 RunDumpsysTextByPriority(title, priority, timeout, service_timeout);
1297}
1298
1299/* Dump all services registered with Normal or Default priority. */
Nandana Dutt5c390032019-03-12 10:52:56 +00001300static Dumpstate::RunStatus RunDumpsysTextNormalPriority(const std::string& title,
1301 std::chrono::milliseconds timeout,
1302 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001303 DurationReporter duration_reporter(title);
1304 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1305 fsync(STDOUT_FILENO);
1306 RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_NORMAL, timeout,
1307 service_timeout);
Nandana Dutt5c390032019-03-12 10:52:56 +00001308
1309 RETURN_IF_USER_DENIED_CONSENT();
1310
1311 return RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_DEFAULT, timeout,
1312 service_timeout);
Vishnu Nair64afc022018-02-01 15:29:34 -08001313}
1314
Nandana Dutt5c390032019-03-12 10:52:56 +00001315static Dumpstate::RunStatus RunDumpsysProto(const std::string& title, int priority,
1316 std::chrono::milliseconds timeout,
1317 std::chrono::milliseconds service_timeout) {
Vishnu Naire97d6122018-01-18 13:58:56 -08001318 sp<android::IServiceManager> sm = defaultServiceManager();
1319 Dumpsys dumpsys(sm.get());
1320 Vector<String16> args;
1321 Dumpsys::setServiceArgs(args, /* asProto = */ true, priority);
1322 DurationReporter duration_reporter(title);
1323
1324 auto start = std::chrono::steady_clock::now();
1325 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ true);
1326 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001327 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001328 std::string path(kProtoPath);
1329 path.append(String8(service).c_str());
1330 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL) {
1331 path.append("_CRITICAL");
1332 } else if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH) {
1333 path.append("_HIGH");
1334 }
1335 path.append(kProtoExt);
Steven Morelandcbd69fc2021-07-20 20:45:43 +00001336 status_t status = dumpsys.startDumpThread(Dumpsys::TYPE_DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001337 if (status == OK) {
1338 status = ds.AddZipEntryFromFd(path, dumpsys.getDumpFd(), service_timeout);
1339 bool dumpTerminated = (status == OK);
1340 dumpsys.stopDumpThread(dumpTerminated);
1341 }
1342 ZipWriter::FileEntry file_entry;
1343 ds.zip_writer_->GetLastEntry(&file_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -08001344
1345 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1346 std::chrono::steady_clock::now() - start);
1347 if (elapsed_duration > timeout) {
1348 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1349 elapsed_duration.count());
1350 break;
1351 }
1352 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001353 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001354}
1355
Nandana Dutta7db6342018-11-21 14:53:34 +00001356// Runs dumpsys on services that must dump first and will take less than 100ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001357static Dumpstate::RunStatus RunDumpsysCritical() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001358 RunDumpsysText("DUMPSYS CRITICAL", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1359 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Nandana Dutt5c390032019-03-12 10:52:56 +00001360
1361 RETURN_IF_USER_DENIED_CONSENT();
1362
1363 return RunDumpsysProto("DUMPSYS CRITICAL PROTO", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1364 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Vishnu Nair780b1282017-10-10 13:57:24 -07001365}
1366
1367// Runs dumpsys on services that must dump first but can take up to 250ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001368static Dumpstate::RunStatus RunDumpsysHigh() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001369 // TODO meminfo takes ~10s, connectivity takes ~5sec to dump. They are both
1370 // high priority. Reduce timeout once they are able to dump in a shorter time or
1371 // moved to a parallel task.
1372 RunDumpsysText("DUMPSYS HIGH", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1373 /* timeout= */ 90s, /* service_timeout= */ 30s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001374
1375 RETURN_IF_USER_DENIED_CONSENT();
1376
1377 return RunDumpsysProto("DUMPSYS HIGH PROTO", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1378 /* timeout= */ 5s, /* service_timeout= */ 1s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001379}
1380
1381// Runs dumpsys on services that must dump but can take up to 10s to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001382static Dumpstate::RunStatus RunDumpsysNormal() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001383 RunDumpsysTextNormalPriority("DUMPSYS", /* timeout= */ 90s, /* service_timeout= */ 10s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001384
1385 RETURN_IF_USER_DENIED_CONSENT();
1386
1387 return RunDumpsysProto("DUMPSYS PROTO", IServiceManager::DUMP_FLAG_PRIORITY_NORMAL,
1388 /* timeout= */ 90s, /* service_timeout= */ 10s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001389}
1390
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001391/*
1392 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1393 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1394 * if it's not running in the parallel task.
1395 */
1396static void DumpHals(int out_fd = STDOUT_FILENO) {
Yifan Hong30528a22020-08-07 18:24:06 -07001397 RunCommand("HARDWARE HALS", {"lshal", "--all", "--types=all"},
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001398 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build(),
1399 false, out_fd);
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001400
Steven Moreland44cd9482018-01-04 16:24:13 -08001401 using android::hidl::manager::V1_0::IServiceManager;
1402 using android::hardware::defaultServiceManager;
1403
1404 sp<IServiceManager> sm = defaultServiceManager();
1405 if (sm == nullptr) {
1406 MYLOGE("Could not retrieve hwservicemanager to dump hals.\n");
1407 return;
1408 }
1409
1410 auto ret = sm->list([&](const auto& interfaces) {
1411 for (const std::string& interface : interfaces) {
1412 std::string cleanName = interface;
1413 std::replace_if(cleanName.begin(),
1414 cleanName.end(),
1415 [](char c) {
1416 return !isalnum(c) &&
1417 std::string("@-_:.").find(c) == std::string::npos;
1418 }, '_');
Nandana Dutt979388e2018-11-30 16:48:55 +00001419 const std::string path = ds.bugreport_internal_dir_ + "/lshal_debug_" + cleanName;
Steven Moreland44cd9482018-01-04 16:24:13 -08001420
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001421 bool empty = false;
Steven Moreland44cd9482018-01-04 16:24:13 -08001422 {
1423 auto fd = android::base::unique_fd(
1424 TEMP_FAILURE_RETRY(open(path.c_str(),
1425 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1426 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1427 if (fd < 0) {
1428 MYLOGE("Could not open %s to dump additional hal information.\n", path.c_str());
1429 continue;
1430 }
1431 RunCommandToFd(fd,
1432 "",
Steven Morelandc81cd3c2018-01-18 14:36:26 -08001433 {"lshal", "debug", "-E", interface},
Steven Moreland44cd9482018-01-04 16:24:13 -08001434 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
1435
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001436 empty = 0 == lseek(fd, 0, SEEK_END);
Steven Moreland44cd9482018-01-04 16:24:13 -08001437 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001438 if (!empty) {
1439 ds.EnqueueAddZipEntryAndCleanupIfNeeded("lshal-debug/" + cleanName + ".txt",
1440 path);
1441 } else {
1442 unlink(path.c_str());
1443 }
Steven Moreland44cd9482018-01-04 16:24:13 -08001444 }
1445 });
1446
1447 if (!ret.isOk()) {
1448 MYLOGE("Could not list hals from hwservicemanager.\n");
1449 }
1450}
1451
Devin Moore8df81bb2022-06-08 22:47:02 +00001452// Dump all of the files that make up the vendor interface.
1453// See the files listed in dumpFileList() for the latest list of files.
1454static void DumpVintf() {
Devin Moore16271d92022-09-22 18:28:48 +00001455
1456 const std::string sku = android::base::GetProperty("ro.boot.product.hardware.sku", "");
1457 const auto vintfFiles = android::vintf::details::dumpFileList(sku);
Devin Moore8df81bb2022-06-08 22:47:02 +00001458 for (const auto vintfFile : vintfFiles) {
1459 struct stat st;
1460 if (stat(vintfFile.c_str(), &st) == 0) {
1461 if (S_ISDIR(st.st_mode)) {
1462 ds.AddDir(vintfFile, true /* recursive */);
1463 } else {
1464 ds.EnqueueAddZipEntryAndCleanupIfNeeded(ZIP_ROOT_DIR + vintfFile,
1465 vintfFile);
1466 }
1467 }
1468 }
1469}
1470
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001471static void DumpExternalFragmentationInfo() {
1472 struct stat st;
1473 if (stat("/proc/buddyinfo", &st) != 0) {
1474 MYLOGE("Unable to dump external fragmentation info\n");
1475 return;
1476 }
1477
1478 printf("------ EXTERNAL FRAGMENTATION INFO ------\n");
1479 std::ifstream ifs("/proc/buddyinfo");
1480 auto unusable_index_regex = std::regex{"Node\\s+([0-9]+),\\s+zone\\s+(\\S+)\\s+(.*)"};
1481 for (std::string line; std::getline(ifs, line);) {
1482 std::smatch match_results;
1483 if (std::regex_match(line, match_results, unusable_index_regex)) {
1484 std::stringstream free_pages(std::string{match_results[3]});
1485 std::vector<int> free_pages_per_order(std::istream_iterator<int>{free_pages},
1486 std::istream_iterator<int>());
1487
1488 int total_free_pages = 0;
1489 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1490 total_free_pages += (free_pages_per_order[i] * std::pow(2, i));
1491 }
1492
1493 printf("Node %s, zone %8s", match_results[1].str().c_str(),
1494 match_results[2].str().c_str());
1495
1496 int usable_free_pages = total_free_pages;
1497 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1498 auto unusable_index = (total_free_pages - usable_free_pages) /
1499 static_cast<double>(total_free_pages);
1500 printf(" %5.3f", unusable_index);
1501 usable_free_pages -= (free_pages_per_order[i] * std::pow(2, i));
1502 }
1503
1504 printf("\n");
1505 }
1506 }
1507 printf("\n");
1508}
1509
mhasankd451a472020-05-26 18:02:39 -07001510static void DumpstateLimitedOnly() {
1511 // Trimmed-down version of dumpstate to only include a whitelisted
1512 // set of logs (system log, event log, and system server / system app
1513 // crashes, and networking logs). See b/136273873 and b/138459828
1514 // for context.
1515 DurationReporter duration_reporter("DUMPSTATE");
1516 unsigned long timeout_ms;
1517 // calculate timeout
1518 timeout_ms = logcat_timeout({"main", "system", "crash"});
1519 RunCommand("SYSTEM LOG",
1520 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1521 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1522 timeout_ms = logcat_timeout({"events"});
1523 RunCommand(
1524 "EVENT LOG",
1525 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1526 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1527
1528 printf("========================================================\n");
1529 printf("== Networking Service\n");
1530 printf("========================================================\n");
1531
1532 RunDumpsys("DUMPSYS NETWORK_SERVICE_LIMITED", {"wifi", "-a"},
1533 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hugo Benichiaa162682020-10-30 23:28:56 +09001534 RunDumpsys("DUMPSYS CONNECTIVITY REQUESTS", {"connectivity", "requests"},
1535 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
mhasankd451a472020-05-26 18:02:39 -07001536
1537 printf("========================================================\n");
1538 printf("== Dropbox crashes\n");
1539 printf("========================================================\n");
1540
1541 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1542 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1543
1544 printf("========================================================\n");
1545 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1546 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1547 printf("========================================================\n");
1548 printf("== dumpstate: done (id %d)\n", ds.id_);
1549 printf("========================================================\n");
1550}
1551
Rhed Jaoe017f982020-07-21 17:58:41 +08001552/*
1553 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1554 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1555 * if it's not running in the parallel task.
1556 */
1557static void DumpCheckins(int out_fd = STDOUT_FILENO) {
1558 dprintf(out_fd, "========================================================\n");
1559 dprintf(out_fd, "== Checkins\n");
1560 dprintf(out_fd, "========================================================\n");
1561
1562 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"}, out_fd);
Rhed Jaoe017f982020-07-21 17:58:41 +08001563 RunDumpsys("CHECKIN NETSTATS", {"netstats", "--checkin"}, out_fd);
1564 RunDumpsys("CHECKIN PROCSTATS", {"procstats", "-c"}, out_fd);
1565 RunDumpsys("CHECKIN USAGESTATS", {"usagestats", "-c"}, out_fd);
1566 RunDumpsys("CHECKIN PACKAGE", {"package", "--checkin"}, out_fd);
1567}
1568
1569/*
1570 * Runs dumpsys on activity service to dump all application activities, services
1571 * and providers in the device.
1572 *
1573 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1574 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1575 * if it's not running in the parallel task.
1576 */
1577static void DumpAppInfos(int out_fd = STDOUT_FILENO) {
1578 dprintf(out_fd, "========================================================\n");
1579 dprintf(out_fd, "== Running Application Activities\n");
1580 dprintf(out_fd, "========================================================\n");
1581
1582 // The following dumpsys internally collects output from running apps, so it can take a long
1583 // time. So let's extend the timeout.
1584
1585 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
1586
1587 RunDumpsys("APP ACTIVITIES", {"activity", "-v", "all"}, DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1588
1589 dprintf(out_fd, "========================================================\n");
1590 dprintf(out_fd, "== Running Application Services (platform)\n");
1591 dprintf(out_fd, "========================================================\n");
1592
1593 RunDumpsys("APP SERVICES PLATFORM", {"activity", "service", "all-platform-non-critical"},
1594 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1595
1596 dprintf(out_fd, "========================================================\n");
1597 dprintf(out_fd, "== Running Application Services (non-platform)\n");
1598 dprintf(out_fd, "========================================================\n");
1599
1600 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1601 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1602
1603 dprintf(out_fd, "========================================================\n");
1604 dprintf(out_fd, "== Running Application Providers (platform)\n");
1605 dprintf(out_fd, "========================================================\n");
1606
1607 RunDumpsys("APP PROVIDERS PLATFORM", {"activity", "provider", "all-platform"},
Rhed Jaob049f182021-01-11 21:08:43 +08001608 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
Rhed Jaoe017f982020-07-21 17:58:41 +08001609
1610 dprintf(out_fd, "========================================================\n");
1611 dprintf(out_fd, "== Running Application Providers (non-platform)\n");
1612 dprintf(out_fd, "========================================================\n");
1613
1614 RunDumpsys("APP PROVIDERS NON-PLATFORM", {"activity", "provider", "all-non-platform"},
1615 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1616}
1617
Nandana Dutt5c390032019-03-12 10:52:56 +00001618// Dumps various things. Returns early with status USER_CONSENT_DENIED if user denies consent
1619// via the consent they are shown. Ignores other errors that occur while running various
1620// commands. The consent checking is currently done around long running tasks, which happen to
1621// be distributed fairly evenly throughout the function.
Kean Mariotti306633e2022-09-05 16:30:47 +00001622Dumpstate::RunStatus Dumpstate::dumpstate() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001623 DurationReporter duration_reporter("DUMPSTATE");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001624
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001625 // Enqueue slow functions into the thread pool, if the parallel run is enabled.
Aaron Huang24d215d2022-04-27 18:51:16 +08001626 std::future<std::string> dump_hals, dump_incident_report, dump_board, dump_checkins,
Kean Mariotti306633e2022-09-05 16:30:47 +00001627 dump_netstats_report, post_process_ui_traces;
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001628 if (ds.dump_pool_) {
1629 // Pool was shutdown in DumpstateDefaultAfterCritical method in order to
Kean Mariotti306633e2022-09-05 16:30:47 +00001630 // drop root user. Restarts it.
1631 ds.dump_pool_->start(/* thread_counts = */3);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001632
Chris Morinbc223142022-02-04 14:17:11 -08001633 dump_hals = ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
1634 dump_incident_report = ds.dump_pool_->enqueueTask(
1635 DUMP_INCIDENT_REPORT_TASK, &DumpIncidentReport);
Aaron Huang24d215d2022-04-27 18:51:16 +08001636 dump_netstats_report = ds.dump_pool_->enqueueTask(
1637 DUMP_NETSTATS_PROTO_TASK, &DumpNetstatsProto);
Chris Morinbc223142022-02-04 14:17:11 -08001638 dump_board = ds.dump_pool_->enqueueTaskWithFd(
1639 DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
1640 dump_checkins = ds.dump_pool_->enqueueTaskWithFd(DUMP_CHECKINS_TASK, &DumpCheckins, _1);
Kean Mariotti306633e2022-09-05 16:30:47 +00001641 post_process_ui_traces = ds.dump_pool_->enqueueTask(
1642 POST_PROCESS_UI_TRACES_TASK, &Dumpstate::MaybePostProcessUiTraces, &ds);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001643 }
1644
Nandana Dutt5c390032019-03-12 10:52:56 +00001645 // Dump various things. Note that anything that takes "long" (i.e. several seconds) should
1646 // check intermittently (if it's intrerruptable like a foreach on pids) and/or should be wrapped
1647 // in a consent check (via RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK).
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -07001648 dump_dev_files("TRUSTY VERSION", "/sys/bus/platform/drivers/trusty", "trusty_version");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001649 RunCommand("UPTIME", {"uptime"});
Wei Wang509bb5d2017-06-09 14:42:12 -07001650 DumpBlockStatFiles();
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001651 DumpFile("MEMORY INFO", "/proc/meminfo");
1652 RunCommand("CPU INFO", {"top", "-b", "-n", "1", "-H", "-s", "6", "-o",
Felipe Leme30dbfa12016-09-02 12:43:26 -07001653 "pid,tid,user,pr,ni,%cpu,s,virt,res,pcy,cmd,name"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001654
Kevin Jeon947922b2022-09-21 00:29:18 +00001655 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "BUGREPORT_PROCDUMP", {"bugreport_procdump"},
1656 CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001657
Sunny Goyal35949782019-11-19 15:54:36 -08001658 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpVisibleWindowViews);
1659
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001660 DumpFile("VIRTUAL MEMORY STATS", "/proc/vmstat");
1661 DumpFile("VMALLOC INFO", "/proc/vmallocinfo");
1662 DumpFile("SLAB INFO", "/proc/slabinfo");
1663 DumpFile("ZONEINFO", "/proc/zoneinfo");
1664 DumpFile("PAGETYPEINFO", "/proc/pagetypeinfo");
1665 DumpFile("BUDDYINFO", "/proc/buddyinfo");
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001666 DumpExternalFragmentationInfo();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001667
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001668 DumpFile("KERNEL CPUFREQ", "/sys/devices/system/cpu/cpu0/cpufreq/stats/time_in_state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001669
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001670 RunCommand("PROCESSES AND THREADS",
Yohei Yukawa591a72d2017-10-05 21:36:35 -07001671 {"ps", "-A", "-T", "-Z", "-O", "pri,nice,rtprio,sched,pcy,time"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001672
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001673 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001674 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_hals));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001675 } else {
1676 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_HALS_TASK, DumpHals);
1677 }
Steven Moreland81b429e2017-01-31 19:50:46 -08001678
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001679 RunCommand("PRINTENV", {"printenv"});
Elliott Hughes21b7c8d2016-10-28 08:53:02 -07001680 RunCommand("NETSTAT", {"netstat", "-nW"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001681 struct stat s;
1682 if (stat("/proc/modules", &s) != 0) {
1683 MYLOGD("Skipping 'lsmod' because /proc/modules does not exist\n");
1684 } else {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001685 RunCommand("LSMOD", {"lsmod"});
Woody Linc198f252021-05-04 16:37:11 +08001686 RunCommand("MODULES INFO",
1687 {"sh", "-c", "cat /proc/modules | cut -d' ' -f1 | "
1688 " while read MOD ; do echo modinfo:$MOD ; modinfo $MOD ; "
1689 "done"}, CommandOptions::AS_ROOT);
Felipe Lemee4eca582016-06-10 17:48:08 -07001690 }
Michal Karpinski4db754f2015-12-11 18:04:32 +00001691
Tom Cherryb87dbfa2020-07-28 11:28:53 -07001692 if (android::base::GetBoolProperty("ro.logd.kernel", false)) {
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001693 DoKernelLogcat();
1694 } else {
1695 do_dmesg();
1696 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001697
Devin Moore8df81bb2022-06-08 22:47:02 +00001698 DumpVintf();
1699
Felipe Lemef0292972016-11-22 13:57:05 -08001700 RunCommand("LIST OF OPEN FILES", {"lsof"}, CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001701
Jeff Brown1dc94e32014-09-11 14:15:27 -07001702 for_each_tid(show_wchan, "BLOCKED PROCESS WAIT-CHANNELS");
Mark Salyzyna297c322016-02-05 15:33:17 -08001703 for_each_pid(show_showtime, "PROCESS TIMES (pid cmd user system iowait+percentage)");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001704
Jack Yu5a6b2e22020-08-14 18:13:35 +08001705 /* Dump Nfc NCI logs */
1706 ds.AddDir("/data/misc/nfc/logs", true);
Ajay Panickerd886ec42016-09-14 12:26:46 -07001707
Paul Chang0d2aad72020-02-13 20:04:03 +08001708 if (ds.options_->do_screenshot && !ds.do_early_screenshot_) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001709 MYLOGI("taking late screenshot\n");
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001710 ds.TakeScreenshot();
Jeff Sharkey5a930032013-03-19 15:05:19 -07001711 }
1712
Felipe Lemee184f662016-10-27 10:04:47 -07001713 AddAnrTraceFiles();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001714
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001715 MaybeAddSystemTraceToZip();
1716
Narayan Kamath8f788292017-05-25 13:20:39 +01001717 // NOTE: tombstones are always added as separate entries in the zip archive
1718 // and are not interspersed with the main report.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001719 const bool tombstones_dumped = AddDumps(ds.tombstone_data_.begin(), ds.tombstone_data_.end(),
Narayan Kamathbd863722017-06-01 18:50:12 +01001720 "TOMBSTONE", true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001721 if (!tombstones_dumped) {
1722 printf("*** NO TOMBSTONES to dump in %s\n\n", TOMBSTONE_DIR.c_str());
Christopher Ferris7dc7f322014-07-22 16:08:19 -07001723 }
1724
Jayachandran Ca94c7172017-06-10 15:08:12 -07001725 DumpPacketStats();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001726
Lorenzo Colitti807f2dd2022-05-27 12:48:37 +09001727 RunDumpsys("EBPF MAP STATS", {"connectivity", "trafficcontroller"});
Chenbo Feng276a3b62018-08-07 11:44:49 -07001728
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001729 DoKmsg();
Mark Salyzyn2262c162014-12-16 09:09:26 -08001730
Woody Lin20767a92022-11-29 15:50:24 +08001731 DumpShutdownCheckpoints();
1732
Jayachandran Ca94c7172017-06-10 15:08:12 -07001733 DumpIpAddrAndRules();
Sreeram Ramachandran2b3bba32014-07-08 15:40:55 -07001734
1735 dump_route_tables();
1736
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001737 RunCommand("ARP CACHE", {"ip", "-4", "neigh", "show"});
1738 RunCommand("IPv6 ND CACHE", {"ip", "-6", "neigh", "show"});
1739 RunCommand("MULTICAST ADDRESSES", {"ip", "maddr"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001740
Nandana Dutt5c390032019-03-12 10:52:56 +00001741 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysHigh);
Lorenzo Colitti6afc38c2015-09-09 22:59:25 +09001742
Chiachang Wang668ede42021-05-17 17:14:20 +08001743 // The dump mechanism in connectivity is refactored due to modularization work. Connectivity can
1744 // only register with a default priority(NORMAL priority). Dumpstate has to call connectivity
1745 // dump with priority parameters to dump high priority information.
1746 RunDumpsys("SERVICE HIGH connectivity", {"connectivity", "--dump-priority", "HIGH"},
1747 CommandOptions::WithTimeout(10).Build());
1748
Elliott Hughes23ccc622017-02-28 10:14:22 -08001749 RunCommand("SYSTEM PROPERTIES", {"getprop"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001750
Jin Qianf334d662017-10-10 14:41:37 -07001751 RunCommand("STORAGED IO INFO", {"storaged", "-u", "-p"});
ynwangf649a6e2016-07-17 21:56:00 -07001752
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001753 RunCommand("FILESYSTEMS & FREE SPACE", {"df"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001754
Colin Crossf45fa6b2012-03-26 12:38:26 -07001755 /* Binder state is expensive to look at as it uses a lot of memory. */
Hridya Valsaraju920ba712020-02-09 16:27:01 -08001756 std::string binder_logs_dir = access("/dev/binderfs/binder_logs", R_OK) ?
1757 "/sys/kernel/debug/binder" : "/dev/binderfs/binder_logs";
1758
1759 DumpFile("BINDER FAILED TRANSACTION LOG", binder_logs_dir + "/failed_transaction_log");
1760 DumpFile("BINDER TRANSACTION LOG", binder_logs_dir + "/transaction_log");
1761 DumpFile("BINDER TRANSACTIONS", binder_logs_dir + "/transactions");
1762 DumpFile("BINDER STATS", binder_logs_dir + "/stats");
1763 DumpFile("BINDER STATE", binder_logs_dir + "/state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001764
Yifan Hongd90cc652020-02-08 16:52:02 -08001765 ds.AddDir(SNAPSHOTCTL_LOG_DIR, false);
1766
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001767 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001768 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_board));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001769 } else {
1770 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
1771 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001772
Steven Moreland7440ddb2016-12-15 16:13:39 -08001773 /* Migrate the ril_dumpstate to a device specific dumpstate? */
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001774 int rilDumpstateTimeout = android::base::GetIntProperty("ril.dumpstate.timeout", 0);
1775 if (rilDumpstateTimeout > 0) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001776 // su does not exist on user builds, so try running without it.
1777 // This way any implementations of vril-dump that do not require
1778 // root can run on user builds.
1779 CommandOptions::CommandOptionsBuilder options =
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001780 CommandOptions::WithTimeout(rilDumpstateTimeout);
Felipe Lemef0292972016-11-22 13:57:05 -08001781 if (!PropertiesHelper::IsUserBuild()) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001782 options.AsRoot();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001783 }
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001784 RunCommand("DUMP VENDOR RIL LOGS", {"vril-dump"}, options.Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -07001785 }
1786
Felipe Lemed8b94e52016-12-08 10:21:44 -08001787 printf("========================================================\n");
1788 printf("== Android Framework Services\n");
1789 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001790
Nandana Dutt5c390032019-03-12 10:52:56 +00001791 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysNormal);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001792
Jack He91ff2fe2021-02-18 18:23:43 -08001793 /* Dump Bluetooth HCI logs after getting bluetooth_manager dumpsys */
1794 ds.AddDir("/data/misc/bluetooth/logs", true);
1795
Rhed Jaoe017f982020-07-21 17:58:41 +08001796 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001797 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_checkins));
Rhed Jaoe017f982020-07-21 17:58:41 +08001798 } else {
1799 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_CHECKINS_TASK, DumpCheckins);
1800 }
Dianne Hackborn02bea972013-06-26 18:59:09 -07001801
Rhed Jaoc5f7ec32020-12-22 22:11:08 +08001802 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpAppInfos);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001803
Adrian Roos8b397ab2017-04-04 16:35:44 -07001804 printf("========================================================\n");
1805 printf("== Dropbox crashes\n");
1806 printf("========================================================\n");
1807
1808 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1809 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1810
Felipe Lemed8b94e52016-12-08 10:21:44 -08001811 printf("========================================================\n");
1812 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1813 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1814 printf("========================================================\n");
1815 printf("== dumpstate: done (id %d)\n", ds.id_);
1816 printf("========================================================\n");
Bookatz38472142018-09-28 10:20:24 -07001817
1818 printf("========================================================\n");
1819 printf("== Obtaining statsd metadata\n");
1820 printf("========================================================\n");
1821 // This differs from the usual dumpsys stats, which is the stats report data.
1822 RunDumpsys("STATSDSTATS", {"stats", "--metadata"});
Mike Ma5c267872019-08-21 11:31:34 -07001823
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +09001824 // Add linker configuration directory
1825 ds.AddDir(LINKERCONFIG_DIR, true);
1826
Li Li830179f2022-01-04 12:53:29 -08001827 /* Dump frozen cgroupfs */
1828 dump_frozen_cgroupfs();
Li Li2eedd412021-06-30 15:11:53 -07001829
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001830 if (ds.dump_pool_) {
Aaron Huang24d215d2022-04-27 18:51:16 +08001831 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_netstats_report));
1832 } else {
1833 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_NETSTATS_PROTO_TASK,
1834 DumpNetstatsProto);
1835 }
1836
1837 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001838 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_incident_report));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001839 } else {
1840 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_INCIDENT_REPORT_TASK,
1841 DumpIncidentReport);
1842 }
Mike Ma5c267872019-08-21 11:31:34 -07001843
Kean Mariotti306633e2022-09-05 16:30:47 +00001844 if (ds.dump_pool_) {
1845 WaitForTask(std::move(post_process_ui_traces));
1846 } else {
1847 RUN_SLOW_FUNCTION_AND_LOG(POST_PROCESS_UI_TRACES_TASK, MaybePostProcessUiTraces);
1848 }
1849
1850 MaybeAddUiTracesToZip();
1851
Nandana Dutt5c390032019-03-12 10:52:56 +00001852 return Dumpstate::RunStatus::OK;
Colin Crossf45fa6b2012-03-26 12:38:26 -07001853}
1854
Nandana Dutt5c390032019-03-12 10:52:56 +00001855/*
1856 * Dumps state for the default case; drops root after it's no longer necessary.
1857 *
1858 * Returns RunStatus::OK if everything went fine.
1859 * Returns RunStatus::ERROR if there was an error.
1860 * Returns RunStatus::USER_DENIED_CONSENT if user explicitly denied consent to sharing the bugreport
1861 * with the caller.
1862 */
Jichao Lie89d9c12019-11-21 19:02:51 -08001863Dumpstate::RunStatus Dumpstate::DumpstateDefaultAfterCritical() {
Nandana Duttdb379fa2019-10-09 16:54:41 +01001864 // Capture first logcat early on; useful to take a snapshot before dumpstate logs take over the
1865 // buffer.
1866 DoLogcat();
1867 // Capture timestamp after first logcat to use in next logcat
1868 time_t logcat_ts = time(nullptr);
1869
Nandana Dutt4be45d12018-09-26 15:04:23 +01001870 /* collect stack traces from Dalvik and native processes (needs root) */
Chris Morinbc223142022-02-04 14:17:11 -08001871 std::future<std::string> dump_traces;
Rhed Jao5377d792020-07-16 17:37:39 +08001872 if (dump_pool_) {
1873 RETURN_IF_USER_DENIED_CONSENT();
1874 // One thread is enough since we only need to enqueue DumpTraces here.
1875 dump_pool_->start(/* thread_counts = */1);
1876
1877 // DumpTraces takes long time, post it to the another thread in the
1878 // pool, if pool is available
Chris Morinbc223142022-02-04 14:17:11 -08001879 dump_traces = dump_pool_->enqueueTask(
1880 DUMP_TRACES_TASK, &Dumpstate::DumpTraces, &ds, &dump_traces_path);
Rhed Jao5377d792020-07-16 17:37:39 +08001881 } else {
1882 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_TRACES_TASK, ds.DumpTraces,
1883 &dump_traces_path);
1884 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001885
1886 /* Run some operations that require root. */
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001887 if (!PropertiesHelper::IsDryRun()) {
Chris Morinc2cba7a2022-02-01 17:06:50 -08001888 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX);
1889 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX);
Woody Lin20767a92022-11-29 15:50:24 +08001890 ds.shutdown_checkpoints_ = GetDumpFds(
1891 SHUTDOWN_CHECKPOINTS_DIR, SHUTDOWN_CHECKPOINTS_FILE_PREFIX);
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001892 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001893
1894 ds.AddDir(RECOVERY_DIR, true);
1895 ds.AddDir(RECOVERY_DATA_DIR, true);
1896 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
Kelvin Zhang6eaa0f92022-09-12 09:29:19 -07001897 ds.AddDir(UPDATE_ENGINE_PREF_DIR, true);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001898 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1899 if (!PropertiesHelper::IsUserBuild()) {
1900 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1901 ds.AddDir(PROFILE_DATA_DIR_REF, true);
Calin Juravlef84d3692020-04-28 15:31:12 -07001902 ds.AddZipEntry(ZIP_ROOT_DIR + PACKAGE_DEX_USE_LIST, PACKAGE_DEX_USE_LIST);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001903 }
Jerry Changa1df8a92020-01-02 16:03:39 +08001904 ds.AddDir(PREREBOOT_DATA_DIR, false);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001905 add_mountinfo();
Peter Collingbourne78aa2942023-02-15 14:50:31 -08001906 for (const char* path : {"/proc/cpuinfo", "/proc/meminfo"}) {
1907 ds.AddZipEntry(ZIP_ROOT_DIR + path, path);
1908 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001909 DumpIpTablesAsRoot();
David Andersond9ba4752018-12-11 18:26:59 -08001910 DumpDynamicPartitionInfo();
Yifan Hong3945e1b2019-10-29 12:59:23 -07001911 ds.AddDir(OTA_METADATA_DIR, true);
Jeff Sharkey9df29d52023-02-06 14:26:30 -07001912 if (!PropertiesHelper::IsUserBuild()) {
1913 // Include dropbox entry files inside ZIP, but exclude
1914 // noisy WTF and StrictMode entries
1915 dump_files("", DROPBOX_DIR, skip_wtf_strictmode, _add_file_from_fd);
1916 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001917
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001918 // Capture any IPSec policies in play. No keys are exposed here.
Nandana Dutt4be45d12018-09-26 15:04:23 +01001919 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1920
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001921 // Dump IPsec stats. No keys are exposed here.
1922 DumpFile("XFRM STATS", XFRM_STAT_PROC_FILE);
1923
Nandana Dutt4be45d12018-09-26 15:04:23 +01001924 // Run ss as root so we can see socket marks.
1925 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
1926
1927 // Run iotop as root to show top 100 IO threads
1928 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
1929
Erick Reyese68df822019-02-11 14:46:36 -08001930 // Gather shared memory buffer info if the product implements it
Hridya Valsaraju1da80c52021-01-09 22:10:11 -08001931 RunCommand("Dmabuf dump", {"dmabuf_dump"});
1932 RunCommand("Dmabuf per-buffer/per-exporter/per-device stats", {"dmabuf_dump", "-b"});
Erick Reyese68df822019-02-11 14:46:36 -08001933
Minchan Kim22c6a1e2019-09-30 15:58:10 -07001934 DumpFile("PSI cpu", "/proc/pressure/cpu");
1935 DumpFile("PSI memory", "/proc/pressure/memory");
1936 DumpFile("PSI io", "/proc/pressure/io");
1937
Mårten Kongstad60195a72022-09-20 14:14:20 +02001938 RunCommand("SDK EXTENSIONS", {SDK_EXT_INFO, "--dump"},
1939 CommandOptions::WithTimeout(10).Always().DropRoot().Build());
1940
Rhed Jao5377d792020-07-16 17:37:39 +08001941 if (dump_pool_) {
1942 RETURN_IF_USER_DENIED_CONSENT();
Chris Morinbc223142022-02-04 14:17:11 -08001943 WaitForTask(std::move(dump_traces));
Rhed Jao5377d792020-07-16 17:37:39 +08001944
Chris Morinbc223142022-02-04 14:17:11 -08001945 // Current running thread in the pool is the root user also. Delete
1946 // the pool and make a new one later to ensure none of threads in the pool are root.
1947 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao5377d792020-07-16 17:37:39 +08001948 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001949 if (!DropRootUser()) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001950 return Dumpstate::RunStatus::ERROR;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001951 }
1952
Nandana Dutt5c390032019-03-12 10:52:56 +00001953 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttdb379fa2019-10-09 16:54:41 +01001954 Dumpstate::RunStatus status = dumpstate();
1955 // Capture logcat since the last time we did it.
1956 DoSystemLogcat(logcat_ts);
1957 return status;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001958}
1959
Rhed Jaob5685b32020-08-14 17:19:17 +08001960// Common states for telephony and wifi which are needed to be collected before
1961// dumpstate drop the root user.
1962static void DumpstateRadioAsRoot() {
1963 DumpIpTablesAsRoot();
1964 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1965}
1966
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001967// This method collects common dumpsys for telephony and wifi. Typically, wifi
1968// reports are fine to include all information, but telephony reports on user
1969// builds need to strip some content (see DumpstateTelephonyOnly).
1970static void DumpstateRadioCommon(bool include_sensitive_info = true) {
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001971 // We need to be picky about some stuff for telephony reports on user builds.
1972 if (!include_sensitive_info) {
1973 // Only dump the radio log buffer (other buffers and dumps contain too much unrelated info).
1974 DoRadioLogcat();
1975 } else {
Rhed Jaob5685b32020-08-14 17:19:17 +08001976 // DumpHals takes long time, post it to the another thread in the pool,
1977 // if pool is available.
Chris Morinbc223142022-02-04 14:17:11 -08001978 std::future<std::string> dump_hals;
Rhed Jaob5685b32020-08-14 17:19:17 +08001979 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001980 dump_hals = ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
Rhed Jaob5685b32020-08-14 17:19:17 +08001981 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001982 // Contains various system properties and process startup info.
1983 do_dmesg();
1984 // Logs other than the radio buffer may contain package/component names and potential PII.
1985 DoLogcat();
1986 // Too broad for connectivity problems.
1987 DoKmsg();
Rhed Jaob5685b32020-08-14 17:19:17 +08001988 // DumpHals contains unrelated hardware info (camera, NFC, biometrics, ...).
1989 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001990 WaitForTask(std::move(dump_hals));
Rhed Jaob5685b32020-08-14 17:19:17 +08001991 } else {
1992 RUN_SLOW_FUNCTION_AND_LOG(DUMP_HALS_TASK, DumpHals);
1993 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001994 }
1995
Jayachandran Ca94c7172017-06-10 15:08:12 -07001996 DumpPacketStats();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001997 DumpIpAddrAndRules();
1998 dump_route_tables();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001999 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
2000 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08002001}
2002
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002003// We use "telephony" here for legacy reasons, though this now really means "connectivity" (cellular
2004// + wifi + networking). This method collects dumpsys for connectivity debugging only. General rules
2005// for what can be included on user builds: all reported information MUST directly relate to
2006// connectivity debugging or customer support and MUST NOT contain unrelated personally identifiable
2007// information. This information MUST NOT identify user-installed packages (UIDs are OK, package
2008// names are not), and MUST NOT contain logs of user application traffic.
2009// TODO(b/148168577) rename this and other related fields/methods to "connectivity" instead.
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08002010static void DumpstateTelephonyOnly(const std::string& calling_package) {
mukesh agrawal253dad42018-01-23 21:59:59 -08002011 DurationReporter duration_reporter("DUMPSTATE");
Jichao Lie89d9c12019-11-21 19:02:51 -08002012
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002013 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08002014
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002015 const bool include_sensitive_info = !PropertiesHelper::IsUserBuild();
Jayachandran Ca94c7172017-06-10 15:08:12 -07002016
Rhed Jaob5685b32020-08-14 17:19:17 +08002017 DumpstateRadioAsRoot();
2018 if (!DropRootUser()) {
2019 return;
2020 }
2021
2022 // Starts thread pool after the root user is dropped, and two additional threads
2023 // are created for DumpHals in the DumpstateRadioCommon and DumpstateBoard.
Chris Morinbc223142022-02-04 14:17:11 -08002024 std::future<std::string> dump_board;
Rhed Jaob5685b32020-08-14 17:19:17 +08002025 if (ds.dump_pool_) {
2026 ds.dump_pool_->start(/*thread_counts =*/2);
2027
2028 // DumpstateBoard takes long time, post it to the another thread in the pool,
2029 // if pool is available.
Chris Morinbc223142022-02-04 14:17:11 -08002030 dump_board = ds.dump_pool_->enqueueTaskWithFd(
2031 DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
Rhed Jaob5685b32020-08-14 17:19:17 +08002032 }
2033
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002034 DumpstateRadioCommon(include_sensitive_info);
2035
2036 if (include_sensitive_info) {
2037 // Contains too much unrelated PII, and given the unstructured nature of sysprops, we can't
2038 // really cherrypick all of the connectivity-related ones. Apps generally have no business
2039 // reading these anyway, and there should be APIs to supply the info in a more app-friendly
2040 // way.
2041 RunCommand("SYSTEM PROPERTIES", {"getprop"});
2042 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002043
2044 printf("========================================================\n");
2045 printf("== Android Framework Services\n");
2046 printf("========================================================\n");
2047
Vishnu Nair652cc802017-11-30 15:18:30 -08002048 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
2049 SEC_TO_MSEC(10));
Hunter Knepshield31cbae12021-05-11 16:23:24 -07002050 RunDumpsys("DUMPSYS", {"vcn_management"}, CommandOptions::WithTimeout(90).Build(),
2051 SEC_TO_MSEC(10));
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08002052 if (include_sensitive_info) {
2053 // Carrier apps' services will be dumped below in dumpsys activity service all-non-platform.
2054 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
2055 SEC_TO_MSEC(10));
2056 } else {
2057 // If the caller is a carrier app and has a carrier service, dump it here since we aren't
2058 // running dumpsys activity service all-non-platform below. Due to the increased output, we
2059 // give a higher timeout as well.
2060 RunDumpsys("DUMPSYS", {"carrier_config", "--requesting-package", calling_package},
2061 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(30));
2062 }
2063 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002064 RunDumpsys("DUMPSYS", {"netpolicy"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
2065 RunDumpsys("DUMPSYS", {"network_management"}, CommandOptions::WithTimeout(90).Build(),
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07002066 SEC_TO_MSEC(10));
Hunter Knepshield0fe51b12020-03-05 16:58:20 -08002067 RunDumpsys("DUMPSYS", {"telephony.registry"}, CommandOptions::WithTimeout(90).Build(),
2068 SEC_TO_MSEC(10));
Grant Menke56698972023-02-24 13:11:07 -08002069 RunDumpsys("DUMPSYS", {"telecom"}, CommandOptions::WithTimeout(90).Build(),
2070 SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002071 if (include_sensitive_info) {
2072 // Contains raw IP addresses, omit from reports on user builds.
2073 RunDumpsys("DUMPSYS", {"netd"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
2074 // Contains raw destination IP/MAC addresses, omit from reports on user builds.
2075 RunDumpsys("DUMPSYS", {"connmetrics"}, CommandOptions::WithTimeout(90).Build(),
2076 SEC_TO_MSEC(10));
2077 // Contains package/component names, omit from reports on user builds.
2078 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
2079 SEC_TO_MSEC(10));
2080 // Contains package names, but should be relatively simple to remove them (also contains
2081 // UIDs already), omit from reports on user builds.
2082 RunDumpsys("BATTERYSTATS", {"deviceidle"}, CommandOptions::WithTimeout(90).Build(),
2083 SEC_TO_MSEC(10));
2084 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002085
2086 printf("========================================================\n");
2087 printf("== Running Application Services\n");
2088 printf("========================================================\n");
2089
2090 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
2091
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002092 if (include_sensitive_info) {
2093 printf("========================================================\n");
2094 printf("== Running Application Services (non-platform)\n");
2095 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002096
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002097 // Contains package/component names and potential PII, omit from reports on user builds.
2098 // To get dumps of the active CarrierService(s) on user builds, we supply an argument to the
2099 // carrier_config dumpsys instead.
2100 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
2101 DUMPSYS_COMPONENTS_OPTIONS);
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002102
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002103 printf("========================================================\n");
2104 printf("== Checkins\n");
2105 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002106
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002107 // Contains package/component names, omit from reports on user builds.
2108 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
2109 }
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002110
2111 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07002112 printf("== dumpstate: done (id %d)\n", ds.id_);
2113 printf("========================================================\n");
Rhed Jaob5685b32020-08-14 17:19:17 +08002114
2115 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08002116 WaitForTask(std::move(dump_board));
Rhed Jaob5685b32020-08-14 17:19:17 +08002117 } else {
2118 RUN_SLOW_FUNCTION_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
2119 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002120}
2121
mukesh agrawal253dad42018-01-23 21:59:59 -08002122// This method collects dumpsys for wifi debugging only
2123static void DumpstateWifiOnly() {
2124 DurationReporter duration_reporter("DUMPSTATE");
2125
Rhed Jaob5685b32020-08-14 17:19:17 +08002126 DumpstateRadioAsRoot();
2127 if (!DropRootUser()) {
2128 return;
2129 }
2130
2131 // Starts thread pool after the root user is dropped. Only one additional
2132 // thread is needed for DumpHals in the DumpstateRadioCommon.
2133 if (ds.dump_pool_) {
2134 ds.dump_pool_->start(/*thread_counts =*/1);
2135 }
2136
mukesh agrawal253dad42018-01-23 21:59:59 -08002137 DumpstateRadioCommon();
2138
2139 printf("========================================================\n");
2140 printf("== Android Framework Services\n");
2141 printf("========================================================\n");
2142
2143 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
2144 SEC_TO_MSEC(10));
2145 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
2146 SEC_TO_MSEC(10));
2147
2148 printf("========================================================\n");
2149 printf("== dumpstate: done (id %d)\n", ds.id_);
2150 printf("========================================================\n");
2151}
2152
Nandana Duttcf419a72019-03-14 10:40:17 +00002153Dumpstate::RunStatus Dumpstate::DumpTraces(const char** path) {
Gavin Corkery789d7a52021-02-24 23:52:35 +00002154 const std::string temp_file_pattern = ds.bugreport_internal_dir_ + "/dumptrace_XXXXXX";
Nandana Duttfaafd522019-03-11 09:23:09 +00002155 const size_t buf_size = temp_file_pattern.length() + 1;
2156 std::unique_ptr<char[]> file_name_buf(new char[buf_size]);
2157 memcpy(file_name_buf.get(), temp_file_pattern.c_str(), buf_size);
2158
2159 // Create a new, empty file to receive all trace dumps.
2160 //
2161 // TODO: This can be simplified once we remove support for the old style
2162 // dumps. We can have a file descriptor passed in to dump_traces instead
2163 // of creating a file, closing it and then reopening it again.
2164 android::base::unique_fd fd(mkostemp(file_name_buf.get(), O_APPEND | O_CLOEXEC));
2165 if (fd < 0) {
2166 MYLOGE("mkostemp on pattern %s: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002167 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002168 }
2169
2170 // Nobody should have access to this temporary file except dumpstate, but we
2171 // temporarily grant 'read' to 'others' here because this file is created
2172 // when tombstoned is still running as root, but dumped after dropping. This
2173 // can go away once support for old style dumping has.
2174 const int chmod_ret = fchmod(fd, 0666);
2175 if (chmod_ret < 0) {
2176 MYLOGE("fchmod on %s failed: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002177 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002178 }
2179
2180 std::unique_ptr<DIR, decltype(&closedir)> proc(opendir("/proc"), closedir);
2181 if (proc.get() == nullptr) {
2182 MYLOGE("opendir /proc failed: %s\n", strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002183 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002184 }
2185
2186 // Number of times process dumping has timed out. If we encounter too many
2187 // failures, we'll give up.
2188 int timeout_failures = 0;
2189 bool dalvik_found = false;
2190
Jayant Chowdharya0a8eb22022-05-20 03:30:09 +00002191 const std::set<int> hal_pids = get_interesting_pids();
Nandana Duttfaafd522019-03-11 09:23:09 +00002192
2193 struct dirent* d;
2194 while ((d = readdir(proc.get()))) {
Nandana Duttcf419a72019-03-14 10:40:17 +00002195 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttfaafd522019-03-11 09:23:09 +00002196 int pid = atoi(d->d_name);
2197 if (pid <= 0) {
2198 continue;
2199 }
2200
2201 const std::string link_name = android::base::StringPrintf("/proc/%d/exe", pid);
2202 std::string exe;
2203 if (!android::base::Readlink(link_name, &exe)) {
2204 continue;
2205 }
2206
2207 bool is_java_process;
2208 if (exe == "/system/bin/app_process32" || exe == "/system/bin/app_process64") {
2209 // Don't bother dumping backtraces for the zygote.
2210 if (IsZygote(pid)) {
2211 continue;
2212 }
2213
2214 dalvik_found = true;
2215 is_java_process = true;
2216 } else if (should_dump_native_traces(exe.c_str()) || hal_pids.find(pid) != hal_pids.end()) {
2217 is_java_process = false;
2218 } else {
2219 // Probably a native process we don't care about, continue.
2220 continue;
2221 }
2222
2223 // If 3 backtrace dumps fail in a row, consider debuggerd dead.
2224 if (timeout_failures == 3) {
2225 dprintf(fd, "ERROR: Too many stack dump failures, exiting.\n");
2226 break;
2227 }
2228
2229 const uint64_t start = Nanotime();
2230 const int ret = dump_backtrace_to_file_timeout(
2231 pid, is_java_process ? kDebuggerdJavaBacktrace : kDebuggerdNativeBacktrace,
2232 is_java_process ? 5 : 20, fd);
2233
2234 if (ret == -1) {
2235 // For consistency, the header and footer to this message match those
2236 // dumped by debuggerd in the success case.
2237 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
2238 dprintf(fd, "Dump failed, likely due to a timeout.\n");
2239 dprintf(fd, "---- end %d ----", pid);
2240 timeout_failures++;
2241 continue;
2242 }
2243
2244 // We've successfully dumped stack traces, reset the failure count
2245 // and write a summary of the elapsed time to the file and continue with the
2246 // next process.
2247 timeout_failures = 0;
2248
2249 dprintf(fd, "[dump %s stack %d: %.3fs elapsed]\n", is_java_process ? "dalvik" : "native",
2250 pid, (float)(Nanotime() - start) / NANOS_PER_SEC);
2251 }
2252
2253 if (!dalvik_found) {
2254 MYLOGE("Warning: no Dalvik processes found to dump stacks\n");
2255 }
2256
Nandana Duttcf419a72019-03-14 10:40:17 +00002257 *path = file_name_buf.release();
2258 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002259}
2260
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002261static dumpstate_hal_hidl::DumpstateMode GetDumpstateHalModeHidl(
2262 const Dumpstate::BugreportMode bugreport_mode) {
2263 switch (bugreport_mode) {
2264 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2265 return dumpstate_hal_hidl::DumpstateMode::FULL;
2266 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2267 return dumpstate_hal_hidl::DumpstateMode::INTERACTIVE;
2268 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2269 return dumpstate_hal_hidl::DumpstateMode::REMOTE;
2270 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2271 return dumpstate_hal_hidl::DumpstateMode::WEAR;
2272 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2273 return dumpstate_hal_hidl::DumpstateMode::CONNECTIVITY;
2274 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2275 return dumpstate_hal_hidl::DumpstateMode::WIFI;
2276 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2277 return dumpstate_hal_hidl::DumpstateMode::DEFAULT;
2278 }
2279 return dumpstate_hal_hidl::DumpstateMode::DEFAULT;
2280}
2281
2282static dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode GetDumpstateHalModeAidl(
2283 const Dumpstate::BugreportMode bugreport_mode) {
2284 switch (bugreport_mode) {
2285 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2286 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::FULL;
2287 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2288 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::INTERACTIVE;
2289 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2290 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::REMOTE;
2291 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2292 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::WEAR;
2293 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2294 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::CONNECTIVITY;
2295 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2296 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::WIFI;
2297 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2298 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::DEFAULT;
2299 }
2300 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::DEFAULT;
2301}
2302
2303static void DoDumpstateBoardHidl(
2304 const sp<dumpstate_hal_hidl_1_0::IDumpstateDevice> dumpstate_hal_1_0,
2305 const std::vector<::ndk::ScopedFileDescriptor>& dumpstate_fds,
2306 const Dumpstate::BugreportMode bugreport_mode,
2307 const size_t timeout_sec) {
2308
2309 using ScopedNativeHandle =
2310 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
2311 ScopedNativeHandle handle(native_handle_create(static_cast<int>(dumpstate_fds.size()), 0),
2312 [](native_handle_t* handle) {
2313 // we don't close file handle's here
2314 // via native_handle_close(handle)
2315 // instead we let dumpstate_fds close the file handles when
2316 // dumpstate_fds gets destroyed
2317 native_handle_delete(handle);
2318 });
2319 if (handle == nullptr) {
2320 MYLOGE("Could not create native_handle for dumpstate HAL\n");
2321 return;
2322 }
2323
2324 for (size_t i = 0; i < dumpstate_fds.size(); i++) {
2325 handle.get()->data[i] = dumpstate_fds[i].get();
2326 }
2327
2328 // Prefer version 1.1 if available. New devices launching with R are no longer allowed to
2329 // implement just 1.0.
2330 const char* descriptor_to_kill;
2331 using DumpstateBoardTask = std::packaged_task<bool()>;
2332 DumpstateBoardTask dumpstate_board_task;
2333 sp<dumpstate_hal_hidl::IDumpstateDevice> dumpstate_hal(
2334 dumpstate_hal_hidl::IDumpstateDevice::castFrom(dumpstate_hal_1_0));
2335 if (dumpstate_hal != nullptr) {
2336 MYLOGI("Using IDumpstateDevice v1.1 HIDL HAL");
2337
2338 dumpstate_hal_hidl::DumpstateMode dumpstate_hal_mode =
2339 GetDumpstateHalModeHidl(bugreport_mode);
2340
2341 descriptor_to_kill = dumpstate_hal_hidl::IDumpstateDevice::descriptor;
2342 dumpstate_board_task =
2343 DumpstateBoardTask([timeout_sec, dumpstate_hal_mode, dumpstate_hal, &handle]() -> bool {
2344 ::android::hardware::Return<dumpstate_hal_hidl::DumpstateStatus> status =
2345 dumpstate_hal->dumpstateBoard_1_1(handle.get(), dumpstate_hal_mode,
2346 SEC_TO_MSEC(timeout_sec));
2347 if (!status.isOk()) {
2348 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2349 return false;
2350 } else if (status != dumpstate_hal_hidl::DumpstateStatus::OK) {
2351 MYLOGE("dumpstateBoard failed with DumpstateStatus::%s\n",
2352 dumpstate_hal_hidl::toString(status).c_str());
2353 return false;
2354 }
2355 return true;
2356 });
2357 } else {
2358 MYLOGI("Using IDumpstateDevice v1.0 HIDL HAL");
2359
2360 descriptor_to_kill = dumpstate_hal_hidl_1_0::IDumpstateDevice::descriptor;
2361 dumpstate_board_task = DumpstateBoardTask([dumpstate_hal_1_0, &handle]() -> bool {
2362 ::android::hardware::Return<void> status =
2363 dumpstate_hal_1_0->dumpstateBoard(handle.get());
2364 if (!status.isOk()) {
2365 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2366 return false;
2367 }
2368 return true;
2369 });
2370 }
2371 auto result = dumpstate_board_task.get_future();
2372 std::thread(std::move(dumpstate_board_task)).detach();
2373
2374 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2375 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate HAL\n", timeout_sec);
2376 if (!android::base::SetProperty(
2377 "ctl.interface_restart",
2378 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
2379 MYLOGE("Couldn't restart dumpstate HAL\n");
2380 }
2381 }
2382 // Wait some time for init to kill dumpstate vendor HAL
2383 constexpr size_t killing_timeout_sec = 10;
2384 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2385 MYLOGE(
2386 "killing dumpstateBoard timed out after %zus, continue and "
2387 "there might be racing in content\n",
2388 killing_timeout_sec);
2389 }
2390}
2391
2392static void DoDumpstateBoardAidl(
2393 const std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> dumpstate_hal,
2394 const std::vector<::ndk::ScopedFileDescriptor>& dumpstate_fds,
2395 const Dumpstate::BugreportMode bugreport_mode, const size_t timeout_sec) {
2396 MYLOGI("Using IDumpstateDevice AIDL HAL");
2397
2398 const char* descriptor_to_kill;
2399 using DumpstateBoardTask = std::packaged_task<bool()>;
2400 DumpstateBoardTask dumpstate_board_task;
2401 dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode dumpstate_hal_mode =
2402 GetDumpstateHalModeAidl(bugreport_mode);
2403
2404 descriptor_to_kill = dumpstate_hal_aidl::IDumpstateDevice::descriptor;
2405 dumpstate_board_task = DumpstateBoardTask([dumpstate_hal, &dumpstate_fds, dumpstate_hal_mode,
2406 timeout_sec]() -> bool {
2407 auto status = dumpstate_hal->dumpstateBoard(dumpstate_fds, dumpstate_hal_mode, timeout_sec);
2408
2409 if (!status.isOk()) {
2410 MYLOGE("dumpstateBoard failed: %s\n", status.getDescription().c_str());
2411 return false;
2412 }
2413 return true;
2414 });
2415 auto result = dumpstate_board_task.get_future();
2416 std::thread(std::move(dumpstate_board_task)).detach();
2417
2418 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2419 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate HAL\n", timeout_sec);
2420 if (!android::base::SetProperty(
2421 "ctl.interface_restart",
2422 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
2423 MYLOGE("Couldn't restart dumpstate HAL\n");
2424 }
2425 }
2426 // Wait some time for init to kill dumpstate vendor HAL
2427 constexpr size_t killing_timeout_sec = 10;
2428 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2429 MYLOGE(
2430 "killing dumpstateBoard timed out after %zus, continue and "
2431 "there might be racing in content\n",
2432 killing_timeout_sec);
2433 }
2434}
2435
2436static std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> GetDumpstateBoardAidlService() {
2437 const std::string aidl_instance_name =
2438 std::string(dumpstate_hal_aidl::IDumpstateDevice::descriptor) + "/default";
2439
2440 if (!AServiceManager_isDeclared(aidl_instance_name.c_str())) {
2441 return nullptr;
2442 }
2443
2444 ndk::SpAIBinder dumpstateBinder(AServiceManager_waitForService(aidl_instance_name.c_str()));
2445
2446 return dumpstate_hal_aidl::IDumpstateDevice::fromBinder(dumpstateBinder);
2447}
2448
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002449void Dumpstate::DumpstateBoard(int out_fd) {
2450 dprintf(out_fd, "========================================================\n");
2451 dprintf(out_fd, "== Board\n");
2452 dprintf(out_fd, "========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08002453
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002454 /*
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002455 * mount debugfs for non-user builds with ro.product.debugfs_restrictions.enabled
Hridya Valsaraju51101602021-04-02 14:32:46 -07002456 * set to true and unmount it after invoking dumpstateBoard_* methods.
2457 * This is to enable debug builds to not have debugfs mounted during runtime.
2458 * It will also ensure that debugfs is only accessed by the dumpstate HAL.
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002459 */
Hridya Valsaraju51101602021-04-02 14:32:46 -07002460 auto mount_debugfs =
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002461 android::base::GetBoolProperty("ro.product.debugfs_restrictions.enabled", false);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002462 if (mount_debugfs) {
2463 RunCommand("mount debugfs", {"mount", "-t", "debugfs", "debugfs", "/sys/kernel/debug"},
2464 AS_ROOT_20);
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002465 RunCommand("chmod debugfs", {"chmod", "0755", "/sys/kernel/debug"}, AS_ROOT_20);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002466 }
2467
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002468 std::vector<std::string> paths;
2469 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07002470 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002471 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
2472 kDumpstateBoardFiles[i].c_str()));
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002473 remover.emplace_back(android::base::make_scope_guard(
2474 std::bind([](std::string path) { android::os::UnlinkAndLogOnError(path); }, paths[i])));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002475 }
Jie Song9fbfad02017-06-20 16:29:42 -07002476
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002477 // get dumpstate HAL AIDL implementation
2478 std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> dumpstate_hal_handle_aidl(
2479 GetDumpstateBoardAidlService());
2480 if (dumpstate_hal_handle_aidl == nullptr) {
2481 MYLOGI("No IDumpstateDevice AIDL implementation\n");
2482 }
2483
2484 // get dumpstate HAL HIDL implementation, only if AIDL HAL implementation not found
2485 sp<dumpstate_hal_hidl_1_0::IDumpstateDevice> dumpstate_hal_handle_hidl_1_0 = nullptr;
2486 if (dumpstate_hal_handle_aidl == nullptr) {
2487 dumpstate_hal_handle_hidl_1_0 = dumpstate_hal_hidl_1_0::IDumpstateDevice::getService();
2488 if (dumpstate_hal_handle_hidl_1_0 == nullptr) {
2489 MYLOGI("No IDumpstateDevice HIDL implementation\n");
2490 }
2491 }
2492
2493 // if neither HIDL nor AIDL implementation found, then return
2494 if (dumpstate_hal_handle_hidl_1_0 == nullptr && dumpstate_hal_handle_aidl == nullptr) {
2495 MYLOGE("Could not find IDumpstateDevice implementation\n");
Wei Wang587eac92018-04-05 12:17:20 -07002496 return;
2497 }
2498
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002499 // this is used to hold the file descriptors and when this variable goes out of scope
2500 // the file descriptors are closed
2501 std::vector<::ndk::ScopedFileDescriptor> dumpstate_fds;
Wei Wang587eac92018-04-05 12:17:20 -07002502
Nandana Dutt5c390032019-03-12 10:52:56 +00002503 // TODO(128270426): Check for consent in between?
Wei Wang587eac92018-04-05 12:17:20 -07002504 for (size_t i = 0; i < paths.size(); i++) {
2505 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
2506
2507 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
2508 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
2509 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
2510 if (fd < 0) {
2511 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
2512 return;
2513 }
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002514
2515 dumpstate_fds.emplace_back(fd.release());
2516 // we call fd.release() here to make sure "fd" does not get closed
2517 // after "fd" goes out of scope after this block.
2518 // "fd" will be closed when "dumpstate_fds" goes out of scope
2519 // i.e. when we exit this function
Wei Wang587eac92018-04-05 12:17:20 -07002520 }
2521
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002522 // Given that bugreport is required to diagnose failures, it's better to set an arbitrary amount
2523 // of timeout for IDumpstateDevice than to block the rest of bugreport. In the timeout case, we
2524 // will kill the HAL and grab whatever it dumped in time.
Michael Eastwood8523ea02022-03-10 16:33:08 -08002525 constexpr size_t timeout_sec = 45;
Wei Wang587eac92018-04-05 12:17:20 -07002526
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002527 if (dumpstate_hal_handle_aidl != nullptr) {
2528 DoDumpstateBoardAidl(dumpstate_hal_handle_aidl, dumpstate_fds, options_->bugreport_mode,
2529 timeout_sec);
2530 } else if (dumpstate_hal_handle_hidl_1_0 != nullptr) {
2531 // run HIDL HAL only if AIDL HAL not found
2532 DoDumpstateBoardHidl(dumpstate_hal_handle_hidl_1_0, dumpstate_fds, options_->bugreport_mode,
2533 timeout_sec);
Wei Wang587eac92018-04-05 12:17:20 -07002534 }
2535
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002536 if (mount_debugfs) {
Hridya Valsaraju51101602021-04-02 14:32:46 -07002537 auto keep_debugfs_mounted =
2538 android::base::GetProperty("persist.dbg.keep_debugfs_mounted", "");
2539 if (keep_debugfs_mounted.empty())
2540 RunCommand("unmount debugfs", {"umount", "/sys/kernel/debug"}, AS_ROOT_20);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002541 }
2542
Wei Wang587eac92018-04-05 12:17:20 -07002543 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
2544 for (size_t i = 0; i < paths.size(); i++) {
2545 struct stat s;
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002546 if (fstat(dumpstate_fds[i].get(), &s) == -1) {
2547 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(), strerror(errno));
Wei Wang587eac92018-04-05 12:17:20 -07002548 file_sizes[i] = -1;
2549 continue;
2550 }
2551 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002552 }
2553
2554 for (size_t i = 0; i < paths.size(); i++) {
2555 if (file_sizes[i] == -1) {
2556 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002557 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002558 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07002559 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002560 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002561 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002562 remover[i].Disable();
2563 EnqueueAddZipEntryAndCleanupIfNeeded(kDumpstateBoardFiles[i], paths[i]);
2564 dprintf(out_fd, "*** See %s entry ***\n", kDumpstateBoardFiles[i].c_str());
Jie Song9fbfad02017-06-20 16:29:42 -07002565 }
Felipe Leme6f674ae2016-11-18 17:10:33 -08002566}
2567
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002568static void ShowUsage() {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002569 fprintf(stderr,
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002570 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-o directory] [-p] "
2571 "[-s] [-S] [-q] [-P] [-R] [-L] [-V version]\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002572 " -h: display this help message\n"
2573 " -b: play sound file instead of vibrate, at beginning of job\n"
2574 " -e: play sound file instead of vibrate, at end of job\n"
mhasank2d75c442020-06-11 15:05:25 -07002575 " -o: write to custom directory (only in limited mode)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01002576 " -p: capture screenshot to filename.png\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002577 " -s: write zipped file to control socket (for init)\n"
2578 " -S: write file location to control socket (for init)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002579 " -q: disable vibrate\n"
Abhijeet Kaure370d682019-10-01 16:49:30 +01002580 " -P: send broadcast when started and do progress updates\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002581 " -R: take bugreport in remote mode (shouldn't be used with -P)\n"
Nandana Dutt235864b2019-01-22 12:10:16 +00002582 " -w: start binder service and make it wait for a call to startBugreport\n"
mhasankd451a472020-05-26 18:02:39 -07002583 " -L: output limited information that is safe for submission in feedback reports\n"
Felipe Lemed071c682016-10-20 16:48:00 -07002584 " -v: prints the dumpstate header and exit\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002585}
2586
Wei Liuf87959e2016-08-26 14:51:42 -07002587static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07002588 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07002589}
2590
Felipe Leme1d486fe2016-10-14 18:06:47 -07002591bool Dumpstate::FinishZipFile() {
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002592 // Runs all enqueued adding zip entry and cleanup tasks before finishing the zip file.
2593 if (zip_entry_tasks_) {
2594 zip_entry_tasks_->run(/* do_cancel = */false);
2595 }
2596
Felipe Leme9a523ae2016-10-20 15:10:33 -07002597 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07002598 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07002599 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002600 // Final timestamp
2601 char date[80];
2602 time_t the_real_now_please_stand_up = time(nullptr);
2603 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002604 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07002605 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002606
Felipe Leme9a523ae2016-10-20 15:10:33 -07002607 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002608 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08002609 return false;
2610 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07002611 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002612 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08002613 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08002614 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08002615
Felipe Leme0f3fb202016-06-10 17:10:53 -07002616 // Add log file (which contains stderr output) to zip...
2617 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07002618 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07002619 MYLOGE("Failed to add dumpstate log to .zip file\n");
2620 return false;
2621 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002622 // TODO: Should truncate the existing file.
2623 // ... and re-open it for further logging.
Nandana Dutta344cb62019-02-22 15:12:35 +00002624 if (!redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()))) {
2625 return false;
2626 }
Felipe Leme0f3fb202016-06-10 17:10:53 -07002627 fprintf(stderr, "\n");
2628
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002629 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07002630 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002631 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002632 return false;
2633 }
2634
Felipe Leme1d486fe2016-10-14 18:06:47 -07002635 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
2636 ds.zip_file.reset(nullptr);
2637
Felipe Lemee9d2c542016-11-15 11:48:26 -08002638 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002639 android::os::UnlinkAndLogOnError(tmp_path_);
Felipe Lemec4eee562016-04-21 15:42:55 -07002640
Felipe Leme1e9edc62015-12-21 16:02:13 -08002641 return true;
2642}
Felipe Leme6e01fa62015-11-11 19:35:14 -08002643
Nikhil Kumar28ce35e2023-01-10 14:32:44 +00002644static void SendBroadcast(const std::string& action,
2645 const std::vector<std::string>& args,
2646 int32_t user_id) {
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002647 // clang-format off
Nikhil Kumar28ce35e2023-01-10 14:32:44 +00002648 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user",
2649 std::to_string(user_id), "--receiver-foreground",
2650 "--receiver-include-background", "-a", action};
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002651 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08002652
2653 am.insert(am.end(), args.begin(), args.end());
2654
Felipe Leme8d2410e2017-02-08 09:46:08 -08002655 RunCommand("", am,
2656 CommandOptions::WithTimeout(20)
2657 .Log("Sending broadcast: '%s'\n")
2658 .Always()
2659 .DropRoot()
2660 .RedirectStderr()
2661 .Build());
2662}
2663
Felipe Leme35b8cf12017-02-10 15:47:29 -08002664static void Vibrate(int duration_ms) {
2665 // clang-format off
Lais Andrade51156962021-02-22 19:21:35 +00002666 std::vector<std::string> args = {"cmd", "vibrator_manager", "synced", "-f", "-d", "dumpstate",
2667 "oneshot", std::to_string(duration_ms)};
2668 RunCommand("", args,
Felipe Leme35b8cf12017-02-10 15:47:29 -08002669 CommandOptions::WithTimeout(10)
2670 .Log("Vibrate: '%s'\n")
2671 .Always()
2672 .Build());
2673 // clang-format on
2674}
2675
Nandana Dutt979388e2018-11-30 16:48:55 +00002676static void MaybeResolveSymlink(std::string* path) {
2677 std::string resolved_path;
2678 if (android::base::Readlink(*path, &resolved_path)) {
2679 *path = resolved_path;
2680 }
2681}
2682
Nandana Dutt4be45d12018-09-26 15:04:23 +01002683/*
2684 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002685 * and adds the version file. Return false if zip_file could not be open to write.
Nandana Dutt4be45d12018-09-26 15:04:23 +01002686 */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002687static bool PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002688 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
2689
Nandana Dutt4be45d12018-09-26 15:04:23 +01002690 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
2691 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002692 ds.base_name_ = StringPrintf("bugreport-%s-%s", device_name.c_str(), build_id.c_str());
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002693 char date[80];
2694 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
2695 ds.name_ = date;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002696
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002697 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002698 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002699 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002700 ds.base_name_ += "-wifi";
2701 }
2702
Paul Chang0d2aad72020-02-13 20:04:03 +08002703 if (ds.options_->do_screenshot) {
Nandana Dutt9d17b942020-03-26 10:02:59 +00002704 ds.screenshot_path_ = ds.GetPath(ds.CalledByApi() ? "-png.tmp" : ".png");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002705 }
2706 ds.tmp_path_ = ds.GetPath(".tmp");
2707 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
2708
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002709 std::string destination = ds.CalledByApi()
Nandana Dutt54dbd672019-01-11 12:58:05 +00002710 ? StringPrintf("[fd:%d]", ds.options_->bugreport_fd.get())
Nandana Dutt9a76d202019-01-21 15:56:48 +00002711 : ds.bugreport_internal_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01002712 MYLOGD(
Nandana Dutt235c6672019-11-14 15:22:32 +00002713 "Bugreport dir: [%s] "
2714 "Base name: [%s] "
2715 "Suffix: [%s] "
2716 "Log path: [%s] "
2717 "Temporary path: [%s] "
2718 "Screenshot path: [%s]\n",
Nandana Dutt9a76d202019-01-21 15:56:48 +00002719 destination.c_str(), ds.base_name_.c_str(), ds.name_.c_str(), ds.log_path_.c_str(),
2720 ds.tmp_path_.c_str(), ds.screenshot_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002721
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002722 ds.path_ = ds.GetPath(ds.CalledByApi() ? "-zip.tmp" : ".zip");
2723 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
2724 create_parent_dirs(ds.path_.c_str());
2725 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
2726 if (ds.zip_file == nullptr) {
2727 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
2728 return false;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002729 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002730 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
2731 ds.AddTextZipEntry("version.txt", ds.version_);
2732 return true;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002733}
2734
2735/*
Abhijeet Kaure370d682019-10-01 16:49:30 +01002736 * Finalizes writing to the file by zipping the tmp file to the final location,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002737 * printing zipped file status, etc.
2738 */
2739static void FinalizeFile() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002740 bool do_text_file = !ds.FinishZipFile();
2741 if (do_text_file) {
2742 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002743 }
mhasank2d75c442020-06-11 15:05:25 -07002744
2745 std::string final_path = ds.path_;
2746 if (ds.options_->OutputToCustomFile()) {
mhasank3a4cfb42020-06-15 18:06:43 -07002747 final_path = ds.GetPath(ds.options_->out_dir, ".zip");
mhasank2d75c442020-06-11 15:05:25 -07002748 android::os::CopyFileToFile(ds.path_, final_path);
2749 }
2750
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002751 if (ds.options_->stream_to_socket) {
2752 android::os::CopyFileToFd(ds.path_, ds.control_socket_fd_);
2753 } else if (ds.options_->progress_updates_to_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002754 if (do_text_file) {
2755 dprintf(ds.control_socket_fd_,
2756 "FAIL:could not create zip file, check %s "
2757 "for more details\n",
2758 ds.log_path_.c_str());
2759 } else {
mhasank2d75c442020-06-11 15:05:25 -07002760 dprintf(ds.control_socket_fd_, "OK:%s\n", final_path.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002761 }
2762 }
2763}
2764
Nandana Dutt4be45d12018-09-26 15:04:23 +01002765
Nandana Dutt58d72e22018-11-16 10:30:48 +00002766static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2767 switch (mode) {
2768 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2769 return "BUGREPORT_FULL";
2770 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2771 return "BUGREPORT_INTERACTIVE";
2772 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2773 return "BUGREPORT_REMOTE";
2774 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2775 return "BUGREPORT_WEAR";
2776 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2777 return "BUGREPORT_TELEPHONY";
2778 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2779 return "BUGREPORT_WIFI";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002780 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2781 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002782 }
2783}
2784
Steven Leeb573eb82022-11-29 22:31:35 +08002785static bool IsConsentlessBugreportAllowed(const Dumpstate::DumpOptions& options) {
2786 // only BUGREPORT_TELEPHONY does not allow using consentless bugreport
2787 return !options.telephony_only;
2788}
2789
Paul Changf59c2b72020-03-10 02:08:55 +08002790static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options,
2791 bool is_screenshot_requested) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002792 // Modify com.android.shell.BugreportProgressService#isDefaultScreenshotRequired as well for
2793 // default system screenshots.
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002794 options->bugreport_mode = mode;
2795 options->bugreport_mode_string = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002796 switch (mode) {
2797 case Dumpstate::BugreportMode::BUGREPORT_FULL:
Paul Changf59c2b72020-03-10 02:08:55 +08002798 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002799 break;
2800 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002801 // Currently, the dumpstate binder is only used by Shell to update progress.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002802 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002803 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002804 break;
2805 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002806 options->do_vibrate = false;
2807 options->is_remote_mode = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002808 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002809 break;
2810 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002811 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002812 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002813 break;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002814 // TODO(b/148168577) rename TELEPHONY everywhere to CONNECTIVITY.
Nandana Dutt58d72e22018-11-16 10:30:48 +00002815 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002816 options->telephony_only = true;
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002817 options->do_progress_updates = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002818 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002819 break;
2820 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002821 options->wifi_only = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002822 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002823 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002824 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2825 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002826 }
2827}
2828
Nandana Dutt58d72e22018-11-16 10:30:48 +00002829static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
Nandana Dutt235c6672019-11-14 15:22:32 +00002830 MYLOGI(
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002831 "do_vibrate: %d stream_to_socket: %d progress_updates_to_socket: %d do_screenshot: %d "
Rhed Jao25f50e02020-08-20 00:10:32 +08002832 "is_remote_mode: %d show_header_only: %d telephony_only: %d "
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002833 "wifi_only: %d do_progress_updates: %d fd: %d bugreport_mode: %s "
mhasankd451a472020-05-26 18:02:39 -07002834 "limited_only: %d args: %s\n",
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002835 options.do_vibrate, options.stream_to_socket, options.progress_updates_to_socket,
Paul Chang0d2aad72020-02-13 20:04:03 +08002836 options.do_screenshot, options.is_remote_mode, options.show_header_only,
Rhed Jao25f50e02020-08-20 00:10:32 +08002837 options.telephony_only, options.wifi_only,
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002838 options.do_progress_updates, options.bugreport_fd.get(),
2839 options.bugreport_mode_string.c_str(),
2840 options.limited_only, options.args.c_str());
Nandana Dutt58d72e22018-11-16 10:30:48 +00002841}
2842
Nandana Dutt54dbd672019-01-11 12:58:05 +00002843void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode,
Kean Mariotti306633e2022-09-05 16:30:47 +00002844 int bugreport_flags,
Nandana Dutt54dbd672019-01-11 12:58:05 +00002845 const android::base::unique_fd& bugreport_fd_in,
Paul Changf59c2b72020-03-10 02:08:55 +08002846 const android::base::unique_fd& screenshot_fd_in,
2847 bool is_screenshot_requested) {
Kean Mariotti306633e2022-09-05 16:30:47 +00002848 this->use_predumped_ui_data = bugreport_flags & BugreportFlag::BUGREPORT_USE_PREDUMPED_UI_DATA;
Gavin Corkerya44686c2022-11-23 18:16:51 +00002849 this->is_consent_deferred = bugreport_flags & BugreportFlag::BUGREPORT_FLAG_DEFER_CONSENT;
Nandana Dutt54dbd672019-01-11 12:58:05 +00002850 // Duplicate the fds because the passed in fds don't outlive the binder transaction.
Todd Frederick621533f2022-03-26 02:54:17 +00002851 bugreport_fd.reset(fcntl(bugreport_fd_in.get(), F_DUPFD_CLOEXEC, 0));
2852 screenshot_fd.reset(fcntl(screenshot_fd_in.get(), F_DUPFD_CLOEXEC, 0));
Nandana Dutt58d72e22018-11-16 10:30:48 +00002853
Paul Changf59c2b72020-03-10 02:08:55 +08002854 SetOptionsFromMode(bugreport_mode, this, is_screenshot_requested);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002855}
2856
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002857Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
2858 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002859 int c;
mhasankd451a472020-05-26 18:02:39 -07002860 while ((c = getopt(argc, argv, "dho:svqzpLPBRSV:w")) != -1) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002861 switch (c) {
2862 // clang-format off
mhasank3a4cfb42020-06-15 18:06:43 -07002863 case 'o': out_dir = optarg; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002864 case 's': stream_to_socket = true; break;
2865 case 'S': progress_updates_to_socket = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002866 case 'v': show_header_only = true; break;
2867 case 'q': do_vibrate = false; break;
Paul Chang0d2aad72020-02-13 20:04:03 +08002868 case 'p': do_screenshot = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002869 case 'P': do_progress_updates = true; break;
2870 case 'R': is_remote_mode = true; break;
mhasankd451a472020-05-26 18:02:39 -07002871 case 'L': limited_only = true; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002872 case 'V':
2873 case 'd':
2874 case 'z':
2875 // compatibility no-op
2876 break;
Nandana Dutt235864b2019-01-22 12:10:16 +00002877 case 'w':
2878 // This was already processed
2879 break;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002880 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002881 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002882 break;
2883 default:
2884 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002885 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002886 break;
2887 // clang-format on
2888 }
2889 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08002890
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002891 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002892 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002893 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002894 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002895 }
2896 }
2897
2898 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
2899 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002900
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002901 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002902}
2903
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002904bool Dumpstate::DumpOptions::ValidateOptions() const {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002905 if (bugreport_fd.get() != -1 && stream_to_socket) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002906 return false;
2907 }
2908
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002909 if ((progress_updates_to_socket || do_progress_updates) && stream_to_socket) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002910 return false;
2911 }
2912
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002913 if (is_remote_mode && (do_progress_updates || stream_to_socket)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002914 return false;
2915 }
2916 return true;
2917}
2918
Nandana Dutt197661d2018-11-16 16:40:21 +00002919void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
2920 options_ = std::move(options);
2921}
2922
Abhijeet Kaura407fb82020-03-27 12:51:12 +00002923void Dumpstate::Initialize() {
2924 /* gets the sequential id */
2925 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
2926 id_ = ++last_id;
2927 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
2928}
2929
Nandana Duttd2f5f082019-01-18 17:13:52 +00002930Dumpstate::RunStatus Dumpstate::Run(int32_t calling_uid, const std::string& calling_package) {
2931 Dumpstate::RunStatus status = RunInternal(calling_uid, calling_package);
Gavin Corkerya44686c2022-11-23 18:16:51 +00002932 HandleRunStatus(status);
2933 return status;
2934}
2935
2936Dumpstate::RunStatus Dumpstate::Retrieve(int32_t calling_uid, const std::string& calling_package) {
2937 Dumpstate::RunStatus status = RetrieveInternal(calling_uid, calling_package);
2938 HandleRunStatus(status);
2939 return status;
2940}
2941
2942Dumpstate::RunStatus Dumpstate::RetrieveInternal(int32_t calling_uid,
2943 const std::string& calling_package) {
2944 consent_callback_ = new ConsentCallback();
2945 const String16 incidentcompanion("incidentcompanion");
2946 sp<android::IBinder> ics(
2947 defaultServiceManager()->checkService(incidentcompanion));
2948 android::String16 package(calling_package.c_str());
2949 if (ics != nullptr) {
2950 MYLOGD("Checking user consent via incidentcompanion service\n");
2951 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
2952 calling_uid, package, String16(), String16(),
2953 0x1 /* FLAG_CONFIRMATION_DIALOG */, consent_callback_.get());
2954 } else {
2955 MYLOGD(
2956 "Unable to check user consent; incidentcompanion service unavailable\n");
2957 return RunStatus::USER_CONSENT_TIMED_OUT;
2958 }
2959 UserConsentResult consent_result = consent_callback_->getResult();
2960 int timeout_ms = 30 * 1000;
2961 while (consent_result == UserConsentResult::UNAVAILABLE &&
2962 consent_callback_->getElapsedTimeMs() < timeout_ms) {
2963 sleep(1);
2964 consent_result = consent_callback_->getResult();
2965 }
2966 if (consent_result == UserConsentResult::DENIED) {
2967 return RunStatus::USER_CONSENT_DENIED;
2968 }
2969 if (consent_result == UserConsentResult::UNAVAILABLE) {
2970 MYLOGD("Canceling user consent request via incidentcompanion service\n");
2971 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
2972 consent_callback_.get());
2973 return RunStatus::USER_CONSENT_TIMED_OUT;
2974 }
2975
2976 bool copy_succeeded =
2977 android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
2978 if (copy_succeeded) {
2979 android::os::UnlinkAndLogOnError(path_);
2980 }
2981 return copy_succeeded ? Dumpstate::RunStatus::OK
2982 : Dumpstate::RunStatus::ERROR;
2983}
2984
2985void Dumpstate::HandleRunStatus(Dumpstate::RunStatus status) {
2986 if (listener_ != nullptr) {
Nandana Duttbabf6c72019-01-15 14:11:12 +00002987 switch (status) {
2988 case Dumpstate::RunStatus::OK:
Gavin Corkerya44686c2022-11-23 18:16:51 +00002989 listener_->onFinished(path_.c_str());
Nandana Duttbabf6c72019-01-15 14:11:12 +00002990 break;
2991 case Dumpstate::RunStatus::HELP:
2992 break;
2993 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002994 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_INVALID_INPUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002995 break;
2996 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002997 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_RUNTIME_ERROR);
2998 break;
2999 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
3000 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_DENIED_CONSENT);
3001 break;
3002 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
3003 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_CONSENT_TIMED_OUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00003004 break;
3005 }
3006 }
Nandana Duttbabf6c72019-01-15 14:11:12 +00003007}
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003008void Dumpstate::Cancel() {
3009 CleanupTmpFiles();
3010 android::os::UnlinkAndLogOnError(log_path_);
3011 for (int i = 0; i < NUM_OF_DUMPS; i++) {
3012 android::os::UnlinkAndLogOnError(ds.bugreport_internal_dir_ + "/" +
3013 kDumpstateBoardFiles[i]);
3014 }
3015 tombstone_data_.clear();
3016 anr_data_.clear();
Woody Lin20767a92022-11-29 15:50:24 +08003017 shutdown_checkpoints_.clear();
Rhed Jao0daac912020-08-21 14:48:20 +08003018
3019 // Instead of shutdown the pool, we delete temporary files directly since
3020 // shutdown blocking the call.
3021 if (dump_pool_) {
3022 dump_pool_->deleteTempFiles();
3023 }
3024 if (zip_entry_tasks_) {
3025 zip_entry_tasks_->run(/*do_cancel =*/ true);
3026 }
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003027}
3028
Kean Mariotti306633e2022-09-05 16:30:47 +00003029void Dumpstate::PreDumpUiData() {
3030 MaybeSnapshotUiTraces();
3031}
3032
Nandana Dutt979388e2018-11-30 16:48:55 +00003033/*
3034 * Dumps relevant information to a bugreport based on the given options.
3035 *
3036 * The bugreport can be dumped to a file or streamed to a socket.
3037 *
3038 * How dumping to file works:
3039 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
3040 * stderr is redirected a log file.
3041 *
3042 * The temporary bugreport is then populated via printfs, dumping contents of files and
3043 * output of commands to stdout.
3044 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003045 * A bunch of other files and dumps are added to the zip archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00003046 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003047 * The temporary bugreport file and the log file also get added to the archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00003048 *
mhasank2d75c442020-06-11 15:05:25 -07003049 * Bugreports are first generated in a local directory and later copied to the caller's fd
3050 * or directory if supplied.
Nandana Dutt979388e2018-11-30 16:48:55 +00003051 */
Nandana Duttd2f5f082019-01-18 17:13:52 +00003052Dumpstate::RunStatus Dumpstate::RunInternal(int32_t calling_uid,
3053 const std::string& calling_package) {
Rhed Jao5377d792020-07-16 17:37:39 +08003054 DurationReporter duration_reporter("RUN INTERNAL", /* logcat_only = */true);
Nandana Dutt979388e2018-11-30 16:48:55 +00003055 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00003056 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00003057 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003058 return RunStatus::INVALID_INPUT;
3059 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003060 /* set as high priority, and protect from OOM killer */
3061 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07003062
Felipe Lemed071c682016-10-20 16:48:00 -07003063 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07003064 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07003065 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07003066 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07003067 } else {
3068 /* fallback to kernels <= 2.6.35 */
3069 oom_adj = fopen("/proc/self/oom_adj", "we");
3070 if (oom_adj) {
3071 fputs("-17", oom_adj);
3072 fclose(oom_adj);
3073 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003074 }
3075
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003076 if (version_ == VERSION_DEFAULT) {
3077 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00003078 }
3079
Chris Morin5a50d482022-02-01 17:41:18 -08003080 if (version_ != VERSION_CURRENT) {
3081 MYLOGE("invalid version requested ('%s'); supported values are: ('%s', '%s')\n",
3082 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003083 return RunStatus::INVALID_INPUT;
Felipe Lemed071c682016-10-20 16:48:00 -07003084 }
3085
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003086 if (options_->show_header_only) {
3087 PrintHeader();
3088 return RunStatus::OK;
Felipe Lemed071c682016-10-20 16:48:00 -07003089 }
3090
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003091 MYLOGD("dumpstate calling_uid = %d ; calling package = %s \n",
3092 calling_uid, calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003093
Felipe Leme7447d7c2016-11-03 18:12:22 -07003094 // TODO: temporarily set progress until it's part of the Dumpstate constructor
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003095 std::string stats_path =
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003096 android::base::StringPrintf("%s/dumpstate-stats.txt", bugreport_internal_dir_.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003097 progress_.reset(new Progress(stats_path));
Felipe Leme7447d7c2016-11-03 18:12:22 -07003098
Sahana Raof35ed432019-07-12 10:47:52 +01003099 if (acquire_wake_lock(PARTIAL_WAKE_LOCK, WAKE_LOCK_NAME) < 0) {
3100 MYLOGE("Failed to acquire wake lock: %s\n", strerror(errno));
3101 } else {
3102 // Wake lock will be released automatically on process death
3103 MYLOGD("Wake lock acquired.\n");
3104 }
3105
Felipe Leme6ae5c4f2017-01-10 14:13:22 -08003106 register_sig_handler();
Felipe Lemed071c682016-10-20 16:48:00 -07003107
Felipe Lemef0292972016-11-22 13:57:05 -08003108 if (PropertiesHelper::IsDryRun()) {
Felipe Lemed071c682016-10-20 16:48:00 -07003109 MYLOGI("Running on dry-run mode (to disable it, call 'setprop dumpstate.dry_run false')\n");
3110 }
3111
Nandana Dutt235c6672019-11-14 15:22:32 +00003112 MYLOGI("dumpstate info: id=%d, args='%s', bugreport_mode= %s bugreport format version: %s\n",
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00003113 id_, options_->args.c_str(), options_->bugreport_mode_string.c_str(), version_.c_str());
Felipe Leme809d74e2016-02-02 12:57:00 -08003114
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003115 do_early_screenshot_ = options_->do_progress_updates;
Felipe Lemee338bf62015-12-07 14:03:50 -08003116
Christopher Ferrised9354f2014-10-01 17:35:01 -07003117 // If we are going to use a socket, do it as early as possible
3118 // to avoid timeouts from bugreport.
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003119 if (options_->stream_to_socket || options_->progress_updates_to_socket) {
Felipe Leme2628e9e2016-04-12 16:36:51 -07003120 MYLOGD("Opening control socket\n");
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003121 control_socket_fd_ = open_socket_fn_("dumpstate");
Nandana Dutta344cb62019-02-22 15:12:35 +00003122 if (control_socket_fd_ == -1) {
3123 return ERROR;
3124 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003125 if (options_->progress_updates_to_socket) {
3126 options_->do_progress_updates = 1;
3127 }
Felipe Leme2628e9e2016-04-12 16:36:51 -07003128 }
3129
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003130 if (!PrepareToWriteToFile()) {
3131 return ERROR;
3132 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08003133
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003134 // Interactive, wear & telephony modes are default to true.
3135 // and may enable from cli option or when using control socket
3136 if (options_->do_progress_updates) {
3137 // clang-format off
3138 std::vector<std::string> am_args = {
3139 "--receiver-permission", "android.permission.DUMP",
3140 };
3141 // clang-format on
3142 // Send STARTED broadcast for apps that listen to bugreport generation events
Nikhil Kumar28ce35e2023-01-10 14:32:44 +00003143 SendBroadcast("com.android.internal.intent.action.BUGREPORT_STARTED",
3144 am_args, multiuser_get_user_id(calling_uid));
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003145 if (options_->progress_updates_to_socket) {
3146 dprintf(control_socket_fd_, "BEGIN:%s\n", path_.c_str());
Felipe Leme71bbfc52015-11-23 14:14:51 -08003147 }
3148 }
3149
Nick Kralevichf3599b32016-01-25 15:05:16 -08003150 /* read /proc/cmdline before dropping root */
3151 FILE *cmdline = fopen("/proc/cmdline", "re");
3152 if (cmdline) {
3153 fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
3154 fclose(cmdline);
3155 }
3156
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003157 if (options_->do_vibrate) {
Felipe Leme35b8cf12017-02-10 15:47:29 -08003158 Vibrate(150);
John Michelau1f794c42012-09-17 11:20:19 -05003159 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003160
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003161 if (zip_file != nullptr) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003162 if (chown(path_.c_str(), AID_SHELL, AID_SHELL)) {
3163 MYLOGE("Unable to change ownership of zip file %s: %s\n", path_.c_str(),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003164 strerror(errno));
Felipe Leme1e9edc62015-12-21 16:02:13 -08003165 }
3166 }
3167
Nandana Dutt3f8c7172018-09-25 12:01:54 +01003168 int dup_stdout_fd;
3169 int dup_stderr_fd;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003170 // Redirect stderr to log_path_ for debugging.
3171 TEMP_FAILURE_RETRY(dup_stderr_fd = dup(fileno(stderr)));
3172 if (!redirect_to_file(stderr, const_cast<char*>(log_path_.c_str()))) {
3173 return ERROR;
3174 }
3175 if (chown(log_path_.c_str(), AID_SHELL, AID_SHELL)) {
3176 MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n", log_path_.c_str(),
3177 strerror(errno));
3178 }
Nandana Dutt979388e2018-11-30 16:48:55 +00003179
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003180 // Redirect stdout to tmp_path_. This is the main bugreport entry and will be
3181 // moved into zip file later, if zipping.
3182 TEMP_FAILURE_RETRY(dup_stdout_fd = dup(fileno(stdout)));
3183 // TODO: why not write to a file instead of stdout to overcome this problem?
3184 /* TODO: rather than generating a text file now and zipping it later,
3185 it would be more efficient to redirect stdout to the zip entry
3186 directly, but the libziparchive doesn't support that option yet. */
3187 if (!redirect_to_file(stdout, const_cast<char*>(tmp_path_.c_str()))) {
3188 return ERROR;
3189 }
3190 if (chown(tmp_path_.c_str(), AID_SHELL, AID_SHELL)) {
3191 MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
3192 tmp_path_.c_str(), strerror(errno));
Colin Crossf45fa6b2012-03-26 12:38:26 -07003193 }
Felipe Lemed8b94e52016-12-08 10:21:44 -08003194
3195 // Don't buffer stdout
3196 setvbuf(stdout, nullptr, _IONBF, 0);
3197
Rhed Jao5377d792020-07-16 17:37:39 +08003198 // Enable the parallel run if the client requests to output to a file.
3199 EnableParallelRunIfNeeded();
3200 // Using scope guard to make sure the dump pool can be shut down correctly.
3201 auto scope_guard_to_shutdown_pool = android::base::make_scope_guard([=]() {
3202 ShutdownDumpPool();
3203 });
3204
Felipe Leme608385d2016-02-01 10:35:38 -08003205 // NOTE: there should be no stdout output until now, otherwise it would break the header.
3206 // In particular, DurationReport objects should be created passing 'title, NULL', so their
Felipe Lemecbce55d2016-02-08 09:53:18 -08003207 // duration is logged into MYLOG instead.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003208 PrintHeader();
Colin Crossf45fa6b2012-03-26 12:38:26 -07003209
Gavin Corkery6968f552020-11-22 18:09:05 +00003210 bool is_dumpstate_restricted = options_->telephony_only
3211 || options_->wifi_only
3212 || options_->limited_only;
3213 if (!is_dumpstate_restricted) {
Paul Chang0d2aad72020-02-13 20:04:03 +08003214 // Invoke critical dumpsys first to preserve system state, before doing anything else.
Jichao Lie89d9c12019-11-21 19:02:51 -08003215 RunDumpsysCritical();
Gavin Corkery6968f552020-11-22 18:09:05 +00003216 }
3217 MaybeTakeEarlyScreenshot();
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003218
3219 if (!is_dumpstate_restricted) {
3220 // Snapshot the system trace now (if running) to avoid that dumpstate's
3221 // own activity pushes out interesting data from the trace ring buffer.
3222 // The trace file is added to the zip by MaybeAddSystemTraceToZip().
3223 MaybeSnapshotSystemTrace();
Yohei Yukawa95305b32021-03-09 07:54:27 -08003224
Kean Mariotti306633e2022-09-05 16:30:47 +00003225 // Snapshot the UI traces now (if running).
3226 // The trace files will be added to bugreport later.
3227 MaybeSnapshotUiTraces();
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003228 }
Gavin Corkery6968f552020-11-22 18:09:05 +00003229 onUiIntensiveBugreportDumpsFinished(calling_uid);
3230 MaybeCheckUserConsent(calling_uid, calling_package);
3231 if (options_->telephony_only) {
3232 DumpstateTelephonyOnly(calling_package);
3233 } else if (options_->wifi_only) {
3234 DumpstateWifiOnly();
3235 } else if (options_->limited_only) {
3236 DumpstateLimitedOnly();
3237 } else {
Nandana Dutt4be45d12018-09-26 15:04:23 +01003238 // Dump state for the default case. This also drops root.
Jichao Lie89d9c12019-11-21 19:02:51 -08003239 RunStatus s = DumpstateDefaultAfterCritical();
Nandana Dutt5c390032019-03-12 10:52:56 +00003240 if (s != RunStatus::OK) {
Nandana Duttaac6f582019-07-26 14:32:47 +01003241 if (s == RunStatus::USER_CONSENT_DENIED) {
Nandana Dutt5c390032019-03-12 10:52:56 +00003242 HandleUserConsentDenied();
3243 }
3244 return s;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08003245 }
Zhengyin Qian068ecc72016-08-10 16:48:14 -07003246 }
Felipe Leme71a74ac2016-03-17 15:43:25 -07003247
Felipe Leme55b42a62015-11-10 17:39:08 -08003248 /* close output if needed */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003249 TEMP_FAILURE_RETRY(dup2(dup_stdout_fd, fileno(stdout)));
Colin Crossf45fa6b2012-03-26 12:38:26 -07003250
Abhijeet Kaure370d682019-10-01 16:49:30 +01003251 // Zip the (now complete) .tmp file within the internal directory.
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003252 ATRACE_BEGIN("FinalizeFile");
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003253 FinalizeFile();
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003254 ATRACE_END();
Colin Crossf45fa6b2012-03-26 12:38:26 -07003255
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003256 // Share the final file with the caller if the user has consented or Shell is the caller.
Nandana Duttd2f5f082019-01-18 17:13:52 +00003257 Dumpstate::RunStatus status = Dumpstate::RunStatus::OK;
Gavin Corkerya44686c2022-11-23 18:16:51 +00003258 if (CalledByApi() && !options_->is_consent_deferred) {
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003259 status = CopyBugreportIfUserConsented(calling_uid);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003260 if (status != Dumpstate::RunStatus::OK &&
3261 status != Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
3262 // Do an early return if there were errors. We make an exception for consent
3263 // timing out because it's possible the user got distracted. In this case the
3264 // bugreport is not shared but made available for manual retrieval.
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003265 MYLOGI("User denied consent. Returning\n");
Nandana Duttd2f5f082019-01-18 17:13:52 +00003266 return status;
3267 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003268 if (status == Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
3269 MYLOGI(
3270 "Did not receive user consent yet."
3271 " Will not copy the bugreport artifacts to caller.\n");
Abhijeet Kaur57627412019-04-17 16:00:09 +01003272 const String16 incidentcompanion("incidentcompanion");
3273 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
3274 if (ics != nullptr) {
3275 MYLOGD("Canceling user consent request via incidentcompanion service\n");
3276 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
3277 consent_callback_.get());
3278 } else {
3279 MYLOGD("Unable to cancel user consent; incidentcompanion service unavailable\n");
3280 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003281 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003282 }
3283
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08003284 /* vibrate a few but shortly times to let user know it's finished */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003285 if (options_->do_vibrate) {
Takuya Ogawa47f644e2017-12-20 18:09:09 +09003286 for (int i = 0; i < 3; i++) {
3287 Vibrate(75);
3288 usleep((75 + 50) * 1000);
3289 }
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08003290 }
3291
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003292 MYLOGD("Final progress: %d/%d (estimated %d)\n", progress_->Get(), progress_->GetMax(),
3293 progress_->GetInitialMax());
3294 progress_->Save();
3295 MYLOGI("done (id %d)\n", id_);
Colin Crossf45fa6b2012-03-26 12:38:26 -07003296
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003297 TEMP_FAILURE_RETRY(dup2(dup_stderr_fd, fileno(stderr)));
Felipe Leme107a05f2016-03-08 15:11:15 -08003298
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003299 if (control_socket_fd_ != -1) {
Felipe Lemee844a9d2016-09-21 15:01:39 -07003300 MYLOGD("Closing control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003301 close(control_socket_fd_);
Felipe Leme2628e9e2016-04-12 16:36:51 -07003302 }
3303
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003304 tombstone_data_.clear();
3305 anr_data_.clear();
Woody Lin20767a92022-11-29 15:50:24 +08003306 shutdown_checkpoints_.clear();
Narayan Kamath6b9516c2017-10-27 11:15:51 +01003307
Nandana Duttd2f5f082019-01-18 17:13:52 +00003308 return (consent_callback_ != nullptr &&
3309 consent_callback_->getResult() == UserConsentResult::UNAVAILABLE)
3310 ? USER_CONSENT_TIMED_OUT
3311 : RunStatus::OK;
3312}
3313
Paul Chang0d2aad72020-02-13 20:04:03 +08003314void Dumpstate::MaybeTakeEarlyScreenshot() {
3315 if (!options_->do_screenshot || !do_early_screenshot_) {
3316 return;
3317 }
3318
3319 TakeScreenshot();
3320}
3321
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003322void Dumpstate::MaybeSnapshotSystemTrace() {
3323 // If a background system trace is happening and is marked as "suitable for
3324 // bugreport" (i.e. bugreport_score > 0 in the trace config), this command
3325 // will stop it and serialize into SYSTEM_TRACE_SNAPSHOT. In the (likely)
3326 // case that no trace is ongoing, this command is a no-op.
3327 // Note: this should not be enqueued as we need to freeze the trace before
3328 // dumpstate starts. Otherwise the trace ring buffers will contain mostly
3329 // the dumpstate's own activity which is irrelevant.
3330 int res = RunCommand(
3331 "SERIALIZE PERFETTO TRACE",
3332 {"perfetto", "--save-for-bugreport"},
3333 CommandOptions::WithTimeout(10)
3334 .DropRoot()
3335 .CloseAllFileDescriptorsOnExec()
3336 .Build());
3337 has_system_trace_ = res == 0;
3338 // MaybeAddSystemTraceToZip() will take care of copying the trace in the zip
3339 // file in the later stages.
3340}
3341
Kean Mariotti306633e2022-09-05 16:30:47 +00003342void Dumpstate::MaybeSnapshotUiTraces() {
3343 if (PropertiesHelper::IsUserBuild() || options_->use_predumped_ui_data) {
3344 return;
3345 }
3346
Hongwei Wang39229132023-01-24 15:09:59 -08003347 // Include the proto logging from WMShell.
3348 RunCommand(
3349 // Empty name because it's not intended to be classified as a bugreport section.
3350 // Actual logging files can be found as "/data/misc/wmtrace/shell_log.winscope"
3351 // in the bugreport.
3352 "", {"dumpsys", "activity", "service", "SystemUIService",
3353 "WMShell", "protolog", "save-for-bugreport"},
3354 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3355
Yohei Yukawa02b1d2c2021-03-16 09:20:30 -07003356 // Currently WindowManagerService and InputMethodManagerSerivice support WinScope protocol.
Kean Mariotti306633e2022-09-05 16:30:47 +00003357 for (const auto& service : {"input_method", "window"}) {
Yohei Yukawa02b1d2c2021-03-16 09:20:30 -07003358 RunCommand(
3359 // Empty name because it's not intended to be classified as a bugreport section.
3360 // Actual tracing files can be found in "/data/misc/wmtrace/" in the bugreport.
3361 "", {"cmd", service, "tracing", "save-for-bugreport"},
3362 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3363 }
Kean Mariotti306633e2022-09-05 16:30:47 +00003364
3365 static const auto SURFACEFLINGER_COMMAND_SAVE_ALL_TRACES = std::vector<std::string> {
3366 "service", "call", "SurfaceFlinger", "1042"
3367 };
3368 // Empty name because it's not intended to be classified as a bugreport section.
3369 // Actual tracing files can be found in "/data/misc/wmtrace/" in the bugreport.
3370 RunCommand(
3371 "", SURFACEFLINGER_COMMAND_SAVE_ALL_TRACES,
3372 CommandOptions::WithTimeout(10).Always().AsRoot().RedirectStderr().Build());
3373}
3374
3375void Dumpstate::MaybePostProcessUiTraces() {
3376 if (PropertiesHelper::IsUserBuild()) {
3377 return;
3378 }
3379
3380 RunCommand(
3381 // Empty name because it's not intended to be classified as a bugreport section.
3382 // Actual tracing files can be found in "/data/misc/wmtrace/" in the bugreport.
3383 "", {
3384 "/system/xbin/su", "system",
3385 "/system/bin/layertracegenerator",
3386 "/data/misc/wmtrace/transactions_trace.winscope",
3387 "/data/misc/wmtrace/layers_trace_from_transactions.winscope"
3388 },
3389 CommandOptions::WithTimeout(120).Always().RedirectStderr().Build());
3390}
3391
3392void Dumpstate::MaybeAddUiTracesToZip() {
3393 if (PropertiesHelper::IsUserBuild()) {
3394 return;
3395 }
3396
3397 ds.AddDir(WMTRACE_DATA_DIR, false);
Yohei Yukawa95305b32021-03-09 07:54:27 -08003398}
3399
Paul Changeb4b4642020-05-28 22:05:47 +08003400void Dumpstate::onUiIntensiveBugreportDumpsFinished(int32_t calling_uid) {
Nikhil Kumar28ce35e2023-01-10 14:32:44 +00003401 if (multiuser_get_app_id(calling_uid) == AID_SHELL || !CalledByApi()) {
Paul Changc490e662020-04-11 18:14:09 +08003402 return;
3403 }
3404 if (listener_ != nullptr) {
3405 // Let listener know ui intensive bugreport dumps are finished, then it can do event
3406 // handling if required.
Paul Changeb4b4642020-05-28 22:05:47 +08003407 listener_->onUiIntensiveBugreportDumpsFinished();
Paul Changc490e662020-04-11 18:14:09 +08003408 }
3409}
3410
Jichao Lie89d9c12019-11-21 19:02:51 -08003411void Dumpstate::MaybeCheckUserConsent(int32_t calling_uid, const std::string& calling_package) {
Gavin Corkerya44686c2022-11-23 18:16:51 +00003412 if (multiuser_get_app_id(calling_uid) == AID_SHELL ||
3413 !CalledByApi() || options_->is_consent_deferred) {
3414 // No need to get consent for shell triggered dumpstates, or not
3415 // through bugreporting API (i.e. no fd to copy back), or when consent
3416 // is deferred.
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003417 return;
3418 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003419 consent_callback_ = new ConsentCallback();
3420 const String16 incidentcompanion("incidentcompanion");
3421 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
Jichao Lie89d9c12019-11-21 19:02:51 -08003422 android::String16 package(calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003423 if (ics != nullptr) {
3424 MYLOGD("Checking user consent via incidentcompanion service\n");
Steven Leeb573eb82022-11-29 22:31:35 +08003425 int flags = 0x1; // IncidentManager.FLAG_CONFIRMATION_DIALOG
3426 if (IsConsentlessBugreportAllowed(*options_)) {
3427 flags |= 0x2; // IncidentManager.FLAG_ALLOW_CONSENTLESS_BUGREPORT
3428 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003429 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
Steven Leeb573eb82022-11-29 22:31:35 +08003430 calling_uid, package, String16(), String16(), flags, consent_callback_.get());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003431 } else {
3432 MYLOGD("Unable to check user consent; incidentcompanion service unavailable\n");
3433 }
3434}
3435
Nandana Dutt5c390032019-03-12 10:52:56 +00003436bool Dumpstate::IsUserConsentDenied() const {
3437 return ds.consent_callback_ != nullptr &&
3438 ds.consent_callback_->getResult() == UserConsentResult::DENIED;
3439}
3440
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01003441bool Dumpstate::CalledByApi() const {
3442 return ds.options_->bugreport_fd.get() != -1 ? true : false;
3443}
3444
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003445void Dumpstate::CleanupTmpFiles() {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003446 android::os::UnlinkAndLogOnError(tmp_path_);
3447 android::os::UnlinkAndLogOnError(screenshot_path_);
3448 android::os::UnlinkAndLogOnError(path_);
Gavin Corkery789d7a52021-02-24 23:52:35 +00003449 if (dump_traces_path != nullptr) {
3450 android::os::UnlinkAndLogOnError(dump_traces_path);
3451 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003452}
3453
Rhed Jao5377d792020-07-16 17:37:39 +08003454void Dumpstate::EnableParallelRunIfNeeded() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003455 if (!PropertiesHelper::IsParallelRun()) {
Rhed Jao5377d792020-07-16 17:37:39 +08003456 return;
3457 }
3458 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003459 zip_entry_tasks_ = std::make_unique<TaskQueue>();
Rhed Jao5377d792020-07-16 17:37:39 +08003460}
3461
3462void Dumpstate::ShutdownDumpPool() {
3463 if (dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08003464 dump_pool_.reset();
Rhed Jao5377d792020-07-16 17:37:39 +08003465 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003466 if (zip_entry_tasks_) {
3467 zip_entry_tasks_->run(/* do_cancel = */true);
3468 zip_entry_tasks_ = nullptr;
3469 }
3470}
3471
3472void Dumpstate::EnqueueAddZipEntryAndCleanupIfNeeded(const std::string& entry_name,
3473 const std::string& entry_path) {
3474 auto func_add_zip_entry_and_cleanup = [=](bool task_cancelled) {
3475 if (!task_cancelled) {
3476 AddZipEntry(entry_name, entry_path);
3477 }
3478 android::os::UnlinkAndLogOnError(entry_path);
3479 };
3480 if (zip_entry_tasks_) {
3481 // Enqueues AddZipEntryAndCleanup function if the parallel run is enabled.
3482 zip_entry_tasks_->add(func_add_zip_entry_and_cleanup, _1);
3483 } else {
3484 // Invokes AddZipEntryAndCleanup immediately
3485 std::invoke(func_add_zip_entry_and_cleanup, /* task_cancelled = */false);
3486 }
Rhed Jao5377d792020-07-16 17:37:39 +08003487}
3488
Nandana Duttd2f5f082019-01-18 17:13:52 +00003489Dumpstate::RunStatus Dumpstate::HandleUserConsentDenied() {
3490 MYLOGD("User denied consent; deleting files and returning\n");
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003491 CleanupTmpFiles();
Nandana Duttd2f5f082019-01-18 17:13:52 +00003492 return USER_CONSENT_DENIED;
3493}
3494
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003495Dumpstate::RunStatus Dumpstate::CopyBugreportIfUserConsented(int32_t calling_uid) {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003496 // If the caller has asked to copy the bugreport over to their directory, we need explicit
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003497 // user consent (unless the caller is Shell).
3498 UserConsentResult consent_result;
Nikhil Kumar28ce35e2023-01-10 14:32:44 +00003499 if (multiuser_get_app_id(calling_uid) == AID_SHELL) {
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003500 consent_result = UserConsentResult::APPROVED;
3501 } else {
3502 consent_result = consent_callback_->getResult();
3503 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003504 if (consent_result == UserConsentResult::UNAVAILABLE) {
3505 // User has not responded yet.
3506 uint64_t elapsed_ms = consent_callback_->getElapsedTimeMs();
Hunter Knepshield70610fa2020-01-03 15:27:33 -08003507 // Telephony is a fast report type, particularly on user builds where information may be
3508 // more aggressively limited. To give the user time to read the consent dialog, increase the
3509 // timeout.
3510 uint64_t timeout_ms = options_->telephony_only ? TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS
3511 : USER_CONSENT_TIMEOUT_MS;
3512 if (elapsed_ms < timeout_ms) {
3513 uint delay_seconds = (timeout_ms - elapsed_ms) / 1000;
Nandana Duttd2f5f082019-01-18 17:13:52 +00003514 MYLOGD("Did not receive user consent yet; going to wait for %d seconds", delay_seconds);
3515 sleep(delay_seconds);
3516 }
3517 consent_result = consent_callback_->getResult();
3518 }
3519 if (consent_result == UserConsentResult::DENIED) {
3520 // User has explicitly denied sharing with the app. To be safe delete the
3521 // internal bugreport & tmp files.
3522 return HandleUserConsentDenied();
3523 }
3524 if (consent_result == UserConsentResult::APPROVED) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00003525 bool copy_succeeded = android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
3526 if (copy_succeeded) {
3527 android::os::UnlinkAndLogOnError(path_);
Abhijeet Kaur9ce94672020-04-01 17:22:36 +01003528 if (options_->do_screenshot &&
3529 options_->screenshot_fd.get() != -1 &&
3530 !options_->is_screenshot_copied) {
3531 copy_succeeded = android::os::CopyFileToFd(screenshot_path_,
3532 options_->screenshot_fd.get());
3533 options_->is_screenshot_copied = copy_succeeded;
3534 if (copy_succeeded) {
3535 android::os::UnlinkAndLogOnError(screenshot_path_);
3536 }
3537 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003538 }
3539 return copy_succeeded ? Dumpstate::RunStatus::OK : Dumpstate::RunStatus::ERROR;
3540 } else if (consent_result == UserConsentResult::UNAVAILABLE) {
3541 // consent_result is still UNAVAILABLE. The user has likely not responded yet.
3542 // Since we do not have user consent to share the bugreport it does not get
3543 // copied over to the calling app but remains in the internal directory from
3544 // where the user can manually pull it.
Paul Changce644212021-05-11 16:06:45 +08003545 std::string final_path = GetPath(".zip");
3546 bool copy_succeeded = android::os::CopyFileToFile(path_, final_path);
3547 if (copy_succeeded) {
3548 android::os::UnlinkAndLogOnError(path_);
3549 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003550 return Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT;
3551 }
3552 // Unknown result; must be a programming error.
3553 MYLOGE("Unknown user consent result:%d\n", consent_result);
3554 return Dumpstate::RunStatus::ERROR;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003555}
3556
Nandana Duttf02564e2019-02-15 15:24:24 +00003557Dumpstate::RunStatus Dumpstate::ParseCommandlineAndRun(int argc, char* argv[]) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003558 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
3559 Dumpstate::RunStatus status = options->Initialize(argc, argv);
3560 if (status == Dumpstate::RunStatus::OK) {
Nandana Duttf02564e2019-02-15 15:24:24 +00003561 SetOptions(std::move(options));
Nandana Duttd2f5f082019-01-18 17:13:52 +00003562 // When directly running dumpstate binary, the output is not expected to be written
3563 // to any external file descriptor.
Nandana Duttf02564e2019-02-15 15:24:24 +00003564 assert(options_->bugreport_fd.get() == -1);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003565
3566 // calling_uid and calling_package are for user consent to share the bugreport with
Abhijeet Kaura407fb82020-03-27 12:51:12 +00003567 // an app; they are irrelevant here because bugreport is triggered via command line.
3568 // Update Last ID before calling Run().
3569 Initialize();
Nandana Duttf02564e2019-02-15 15:24:24 +00003570 status = Run(-1 /* calling_uid */, "" /* calling_package */);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003571 }
Nandana Duttf02564e2019-02-15 15:24:24 +00003572 return status;
3573}
3574
3575/* Main entry point for dumpstate binary. */
3576int run_main(int argc, char* argv[]) {
3577 Dumpstate::RunStatus status = ds.ParseCommandlineAndRun(argc, argv);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003578
3579 switch (status) {
3580 case Dumpstate::RunStatus::OK:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003581 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003582 case Dumpstate::RunStatus::HELP:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003583 ShowUsage();
3584 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003585 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003586 fprintf(stderr, "Invalid combination of args\n");
3587 ShowUsage();
3588 exit(1);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003589 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00003590 FALLTHROUGH_INTENDED;
3591 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
3592 FALLTHROUGH_INTENDED;
3593 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003594 exit(2);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003595 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003596}
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003597
3598// TODO(111441001): Default DumpOptions to sensible values.
3599Dumpstate::Dumpstate(const std::string& version)
3600 : pid_(getpid()),
3601 options_(new Dumpstate::DumpOptions()),
Nandana Dutt402a8392019-06-14 14:25:13 +01003602 last_reported_percent_progress_(0),
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003603 version_(version),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003604 now_(time(nullptr)),
3605 open_socket_fn_(open_socket) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003606}
3607
3608Dumpstate& Dumpstate::GetInstance() {
3609 static Dumpstate singleton_(android::base::GetProperty("dumpstate.version", VERSION_CURRENT));
3610 return singleton_;
3611}
3612
Rhed Jao5377d792020-07-16 17:37:39 +08003613DurationReporter::DurationReporter(const std::string& title, bool logcat_only, bool verbose,
3614 int duration_fd) : title_(title), logcat_only_(logcat_only), verbose_(verbose),
3615 duration_fd_(duration_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003616 if (!title_.empty()) {
3617 started_ = Nanotime();
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003618 if (title_.find("SHOW MAP") == std::string::npos) {
3619 ATRACE_ASYNC_BEGIN(title_.c_str(), 0);
3620 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003621 }
3622}
3623
3624DurationReporter::~DurationReporter() {
3625 if (!title_.empty()) {
3626 float elapsed = (float)(Nanotime() - started_) / NANOS_PER_SEC;
chenqiwuaf8b2d92019-12-12 18:53:51 +08003627 if (elapsed >= .5f || verbose_) {
3628 MYLOGD("Duration of '%s': %.2fs\n", title_.c_str(), elapsed);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003629 }
chenqiwuaf8b2d92019-12-12 18:53:51 +08003630 if (!logcat_only_) {
3631 // Use "Yoda grammar" to make it easier to grep|sort sections.
Rhed Jao5377d792020-07-16 17:37:39 +08003632 dprintf(duration_fd_, "------ %.3fs was the duration of '%s' ------\n",
3633 elapsed, title_.c_str());
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003634 }
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003635 if (title_.find("SHOW MAP") == std::string::npos) {
3636 ATRACE_ASYNC_END(title_.c_str(), 0);
3637 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003638 }
3639}
3640
3641const int32_t Progress::kDefaultMax = 5000;
3642
3643Progress::Progress(const std::string& path) : Progress(Progress::kDefaultMax, 1.1, path) {
3644}
3645
3646Progress::Progress(int32_t initial_max, int32_t progress, float growth_factor)
3647 : Progress(initial_max, growth_factor, "") {
3648 progress_ = progress;
3649}
3650
3651Progress::Progress(int32_t initial_max, float growth_factor, const std::string& path)
3652 : initial_max_(initial_max),
3653 progress_(0),
3654 max_(initial_max),
3655 growth_factor_(growth_factor),
3656 n_runs_(0),
3657 average_max_(0),
3658 path_(path) {
3659 if (!path_.empty()) {
3660 Load();
3661 }
3662}
3663
3664void Progress::Load() {
3665 MYLOGD("Loading stats from %s\n", path_.c_str());
3666 std::string content;
3667 if (!android::base::ReadFileToString(path_, &content)) {
3668 MYLOGI("Could not read stats from %s; using max of %d\n", path_.c_str(), max_);
3669 return;
3670 }
3671 if (content.empty()) {
3672 MYLOGE("No stats (empty file) on %s; using max of %d\n", path_.c_str(), max_);
3673 return;
3674 }
3675 std::vector<std::string> lines = android::base::Split(content, "\n");
3676
3677 if (lines.size() < 1) {
3678 MYLOGE("Invalid stats on file %s: not enough lines (%d). Using max of %d\n", path_.c_str(),
3679 (int)lines.size(), max_);
3680 return;
3681 }
3682 char* ptr;
3683 n_runs_ = strtol(lines[0].c_str(), &ptr, 10);
3684 average_max_ = strtol(ptr, nullptr, 10);
3685 if (n_runs_ <= 0 || average_max_ <= 0 || n_runs_ > STATS_MAX_N_RUNS ||
3686 average_max_ > STATS_MAX_AVERAGE) {
3687 MYLOGE("Invalid stats line on file %s: %s\n", path_.c_str(), lines[0].c_str());
3688 initial_max_ = Progress::kDefaultMax;
3689 } else {
3690 initial_max_ = average_max_;
3691 }
3692 max_ = initial_max_;
3693
3694 MYLOGI("Average max progress: %d in %d runs; estimated max: %d\n", average_max_, n_runs_, max_);
3695}
3696
3697void Progress::Save() {
3698 int32_t total = n_runs_ * average_max_ + progress_;
3699 int32_t runs = n_runs_ + 1;
3700 int32_t average = floor(((float)total) / runs);
3701 MYLOGI("Saving stats (total=%d, runs=%d, average=%d) on %s\n", total, runs, average,
3702 path_.c_str());
3703 if (path_.empty()) {
3704 return;
3705 }
3706
3707 std::string content = android::base::StringPrintf("%d %d\n", runs, average);
3708 if (!android::base::WriteStringToFile(content, path_)) {
3709 MYLOGE("Could not save stats on %s\n", path_.c_str());
3710 }
3711}
3712
3713int32_t Progress::Get() const {
3714 return progress_;
3715}
3716
3717bool Progress::Inc(int32_t delta_sec) {
3718 bool changed = false;
3719 if (delta_sec >= 0) {
3720 progress_ += delta_sec;
3721 if (progress_ > max_) {
3722 int32_t old_max = max_;
3723 max_ = floor((float)progress_ * growth_factor_);
3724 MYLOGD("Adjusting max progress from %d to %d\n", old_max, max_);
3725 changed = true;
3726 }
3727 }
3728 return changed;
3729}
3730
3731int32_t Progress::GetMax() const {
3732 return max_;
3733}
3734
3735int32_t Progress::GetInitialMax() const {
3736 return initial_max_;
3737}
3738
3739void Progress::Dump(int fd, const std::string& prefix) const {
3740 const char* pr = prefix.c_str();
3741 dprintf(fd, "%sprogress: %d\n", pr, progress_);
3742 dprintf(fd, "%smax: %d\n", pr, max_);
3743 dprintf(fd, "%sinitial_max: %d\n", pr, initial_max_);
3744 dprintf(fd, "%sgrowth_factor: %0.2f\n", pr, growth_factor_);
3745 dprintf(fd, "%spath: %s\n", pr, path_.c_str());
3746 dprintf(fd, "%sn_runs: %d\n", pr, n_runs_);
3747 dprintf(fd, "%saverage_max: %d\n", pr, average_max_);
3748}
3749
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003750std::string Dumpstate::GetPath(const std::string& suffix) const {
3751 return GetPath(bugreport_internal_dir_, suffix);
3752}
3753
3754std::string Dumpstate::GetPath(const std::string& directory, const std::string& suffix) const {
3755 return android::base::StringPrintf("%s/%s-%s%s", directory.c_str(), base_name_.c_str(),
3756 name_.c_str(), suffix.c_str());
3757}
3758
3759void Dumpstate::SetProgress(std::unique_ptr<Progress> progress) {
3760 progress_ = std::move(progress);
3761}
3762
3763void for_each_userid(void (*func)(int), const char *header) {
3764 std::string title = header == nullptr ? "for_each_userid" : android::base::StringPrintf(
3765 "for_each_userid(%s)", header);
3766 DurationReporter duration_reporter(title);
3767 if (PropertiesHelper::IsDryRun()) return;
3768
3769 DIR *d;
3770 struct dirent *de;
3771
3772 if (header) printf("\n------ %s ------\n", header);
3773 func(0);
3774
3775 if (!(d = opendir("/data/system/users"))) {
3776 printf("Failed to open /data/system/users (%s)\n", strerror(errno));
3777 return;
3778 }
3779
3780 while ((de = readdir(d))) {
3781 int userid;
3782 if (de->d_type != DT_DIR || !(userid = atoi(de->d_name))) {
3783 continue;
3784 }
3785 func(userid);
3786 }
3787
3788 closedir(d);
3789}
3790
3791static void __for_each_pid(void (*helper)(int, const char *, void *), const char *header, void *arg) {
3792 DIR *d;
3793 struct dirent *de;
3794
3795 if (!(d = opendir("/proc"))) {
3796 printf("Failed to open /proc (%s)\n", strerror(errno));
3797 return;
3798 }
3799
3800 if (header) printf("\n------ %s ------\n", header);
3801 while ((de = readdir(d))) {
3802 if (ds.IsUserConsentDenied()) {
3803 MYLOGE(
3804 "Returning early because user denied consent to share bugreport with calling app.");
3805 closedir(d);
3806 return;
3807 }
3808 int pid;
3809 int fd;
3810 char cmdpath[255];
3811 char cmdline[255];
3812
3813 if (!(pid = atoi(de->d_name))) {
3814 continue;
3815 }
3816
3817 memset(cmdline, 0, sizeof(cmdline));
3818
3819 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/cmdline", pid);
3820 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3821 TEMP_FAILURE_RETRY(read(fd, cmdline, sizeof(cmdline) - 2));
3822 close(fd);
3823 if (cmdline[0]) {
3824 helper(pid, cmdline, arg);
3825 continue;
3826 }
3827 }
3828
3829 // if no cmdline, a kernel thread has comm
3830 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/comm", pid);
3831 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3832 TEMP_FAILURE_RETRY(read(fd, cmdline + 1, sizeof(cmdline) - 4));
3833 close(fd);
3834 if (cmdline[1]) {
3835 cmdline[0] = '[';
3836 size_t len = strcspn(cmdline, "\f\b\r\n");
3837 cmdline[len] = ']';
3838 cmdline[len+1] = '\0';
3839 }
3840 }
3841 if (!cmdline[0]) {
3842 strcpy(cmdline, "N/A");
3843 }
3844 helper(pid, cmdline, arg);
3845 }
3846
3847 closedir(d);
3848}
3849
3850static void for_each_pid_helper(int pid, const char *cmdline, void *arg) {
3851 for_each_pid_func *func = (for_each_pid_func*) arg;
3852 func(pid, cmdline);
3853}
3854
3855void for_each_pid(for_each_pid_func func, const char *header) {
3856 std::string title = header == nullptr ? "for_each_pid"
3857 : android::base::StringPrintf("for_each_pid(%s)", header);
3858 DurationReporter duration_reporter(title);
3859 if (PropertiesHelper::IsDryRun()) return;
3860
3861 __for_each_pid(for_each_pid_helper, header, (void *) func);
3862}
3863
3864static void for_each_tid_helper(int pid, const char *cmdline, void *arg) {
3865 DIR *d;
3866 struct dirent *de;
3867 char taskpath[255];
3868 for_each_tid_func *func = (for_each_tid_func *) arg;
3869
3870 snprintf(taskpath, sizeof(taskpath), "/proc/%d/task", pid);
3871
3872 if (!(d = opendir(taskpath))) {
3873 printf("Failed to open %s (%s)\n", taskpath, strerror(errno));
3874 return;
3875 }
3876
3877 func(pid, pid, cmdline);
3878
3879 while ((de = readdir(d))) {
3880 if (ds.IsUserConsentDenied()) {
3881 MYLOGE(
3882 "Returning early because user denied consent to share bugreport with calling app.");
3883 closedir(d);
3884 return;
3885 }
3886 int tid;
3887 int fd;
3888 char commpath[255];
3889 char comm[255];
3890
3891 if (!(tid = atoi(de->d_name))) {
3892 continue;
3893 }
3894
3895 if (tid == pid)
3896 continue;
3897
3898 snprintf(commpath, sizeof(commpath), "/proc/%d/comm", tid);
3899 memset(comm, 0, sizeof(comm));
3900 if ((fd = TEMP_FAILURE_RETRY(open(commpath, O_RDONLY | O_CLOEXEC))) < 0) {
3901 strcpy(comm, "N/A");
3902 } else {
3903 char *c;
3904 TEMP_FAILURE_RETRY(read(fd, comm, sizeof(comm) - 2));
3905 close(fd);
3906
3907 c = strrchr(comm, '\n');
3908 if (c) {
3909 *c = '\0';
3910 }
3911 }
3912 func(pid, tid, comm);
3913 }
3914
3915 closedir(d);
3916}
3917
3918void for_each_tid(for_each_tid_func func, const char *header) {
3919 std::string title = header == nullptr ? "for_each_tid"
3920 : android::base::StringPrintf("for_each_tid(%s)", header);
3921 DurationReporter duration_reporter(title);
3922
3923 if (PropertiesHelper::IsDryRun()) return;
3924
3925 __for_each_pid(for_each_tid_helper, header, (void *) func);
3926}
3927
3928void show_wchan(int pid, int tid, const char *name) {
3929 if (PropertiesHelper::IsDryRun()) return;
3930
3931 char path[255];
3932 char buffer[255];
3933 int fd, ret, save_errno;
3934 char name_buffer[255];
3935
3936 memset(buffer, 0, sizeof(buffer));
3937
3938 snprintf(path, sizeof(path), "/proc/%d/wchan", tid);
3939 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3940 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3941 return;
3942 }
3943
3944 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3945 save_errno = errno;
3946 close(fd);
3947
3948 if (ret < 0) {
3949 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3950 return;
3951 }
3952
3953 snprintf(name_buffer, sizeof(name_buffer), "%*s%s",
3954 pid == tid ? 0 : 3, "", name);
3955
3956 printf("%-7d %-32s %s\n", tid, name_buffer, buffer);
3957
3958 return;
3959}
3960
3961// print time in centiseconds
3962static void snprcent(char *buffer, size_t len, size_t spc,
3963 unsigned long long time) {
3964 static long hz; // cache discovered hz
3965
3966 if (hz <= 0) {
3967 hz = sysconf(_SC_CLK_TCK);
3968 if (hz <= 0) {
3969 hz = 1000;
3970 }
3971 }
3972
3973 // convert to centiseconds
3974 time = (time * 100 + (hz / 2)) / hz;
3975
3976 char str[16];
3977
3978 snprintf(str, sizeof(str), " %llu.%02u",
3979 time / 100, (unsigned)(time % 100));
3980 size_t offset = strlen(buffer);
3981 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3982 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3983}
3984
3985// print permille as a percent
3986static void snprdec(char *buffer, size_t len, size_t spc, unsigned permille) {
3987 char str[16];
3988
3989 snprintf(str, sizeof(str), " %u.%u%%", permille / 10, permille % 10);
3990 size_t offset = strlen(buffer);
3991 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3992 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3993}
3994
3995void show_showtime(int pid, const char *name) {
3996 if (PropertiesHelper::IsDryRun()) return;
3997
3998 char path[255];
3999 char buffer[1023];
4000 int fd, ret, save_errno;
4001
4002 memset(buffer, 0, sizeof(buffer));
4003
4004 snprintf(path, sizeof(path), "/proc/%d/stat", pid);
4005 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
4006 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
4007 return;
4008 }
4009
4010 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
4011 save_errno = errno;
4012 close(fd);
4013
4014 if (ret < 0) {
4015 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
4016 return;
4017 }
4018
4019 // field 14 is utime
4020 // field 15 is stime
4021 // field 42 is iotime
4022 unsigned long long utime = 0, stime = 0, iotime = 0;
4023 if (sscanf(buffer,
4024 "%*u %*s %*s %*d %*d %*d %*d %*d %*d %*d %*d "
4025 "%*d %*d %llu %llu %*d %*d %*d %*d %*d %*d "
4026 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %*d "
4027 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %llu ",
4028 &utime, &stime, &iotime) != 3) {
4029 return;
4030 }
4031
4032 unsigned long long total = utime + stime;
4033 if (!total) {
4034 return;
4035 }
4036
4037 unsigned permille = (iotime * 1000 + (total / 2)) / total;
4038 if (permille > 1000) {
4039 permille = 1000;
4040 }
4041
4042 // try to beautify and stabilize columns at <80 characters
4043 snprintf(buffer, sizeof(buffer), "%-6d%s", pid, name);
4044 if ((name[0] != '[') || utime) {
4045 snprcent(buffer, sizeof(buffer), 57, utime);
4046 }
4047 snprcent(buffer, sizeof(buffer), 65, stime);
4048 if ((name[0] != '[') || iotime) {
4049 snprcent(buffer, sizeof(buffer), 73, iotime);
4050 }
4051 if (iotime) {
4052 snprdec(buffer, sizeof(buffer), 79, permille);
4053 }
4054 puts(buffer); // adds a trailing newline
4055
4056 return;
4057}
4058
4059void do_dmesg() {
4060 const char *title = "KERNEL LOG (dmesg)";
4061 DurationReporter duration_reporter(title);
4062 printf("------ %s ------\n", title);
4063
4064 if (PropertiesHelper::IsDryRun()) return;
4065
4066 /* Get size of kernel buffer */
4067 int size = klogctl(KLOG_SIZE_BUFFER, nullptr, 0);
4068 if (size <= 0) {
4069 printf("Unexpected klogctl return value: %d\n\n", size);
4070 return;
4071 }
4072 char *buf = (char *) malloc(size + 1);
4073 if (buf == nullptr) {
4074 printf("memory allocation failed\n\n");
4075 return;
4076 }
4077 int retval = klogctl(KLOG_READ_ALL, buf, size);
4078 if (retval < 0) {
4079 printf("klogctl failure\n\n");
4080 free(buf);
4081 return;
4082 }
4083 buf[retval] = '\0';
4084 printf("%s\n\n", buf);
4085 free(buf);
4086 return;
4087}
4088
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004089int Dumpstate::DumpFile(const std::string& title, const std::string& path) {
4090 DurationReporter duration_reporter(title);
4091
4092 int status = DumpFileToFd(STDOUT_FILENO, title, path);
4093
4094 UpdateProgress(WEIGHT_FILE);
4095
4096 return status;
4097}
4098
4099int read_file_as_long(const char *path, long int *output) {
4100 int fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC));
4101 if (fd < 0) {
4102 int err = errno;
4103 MYLOGE("Error opening file descriptor for %s: %s\n", path, strerror(err));
4104 return -1;
4105 }
4106 char buffer[50];
4107 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
4108 if (bytes_read == -1) {
4109 MYLOGE("Error reading file %s: %s\n", path, strerror(errno));
4110 return -2;
4111 }
4112 if (bytes_read == 0) {
4113 MYLOGE("File %s is empty\n", path);
4114 return -3;
4115 }
4116 *output = atoi(buffer);
4117 return 0;
4118}
4119
4120/* calls skip to gate calling dump_from_fd recursively
4121 * in the specified directory. dump_from_fd defaults to
4122 * dump_file_from_fd above when set to NULL. skip defaults
4123 * to false when set to NULL. dump_from_fd will always be
4124 * called with title NULL.
4125 */
4126int dump_files(const std::string& title, const char* dir, bool (*skip)(const char* path),
4127 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
4128 DurationReporter duration_reporter(title);
4129 DIR *dirp;
4130 struct dirent *d;
4131 char *newpath = nullptr;
4132 const char *slash = "/";
4133 int retval = 0;
4134
4135 if (!title.empty()) {
4136 printf("------ %s (%s) ------\n", title.c_str(), dir);
4137 }
4138 if (PropertiesHelper::IsDryRun()) return 0;
4139
4140 if (dir[strlen(dir) - 1] == '/') {
4141 ++slash;
4142 }
4143 dirp = opendir(dir);
4144 if (dirp == nullptr) {
4145 retval = -errno;
4146 MYLOGE("%s: %s\n", dir, strerror(errno));
4147 return retval;
4148 }
4149
4150 if (!dump_from_fd) {
4151 dump_from_fd = dump_file_from_fd;
4152 }
4153 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
4154 if ((d->d_name[0] == '.')
4155 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
4156 || (d->d_name[1] == '\0'))) {
4157 continue;
4158 }
4159 asprintf(&newpath, "%s%s%s%s", dir, slash, d->d_name,
4160 (d->d_type == DT_DIR) ? "/" : "");
4161 if (!newpath) {
4162 retval = -errno;
4163 continue;
4164 }
4165 if (skip && (*skip)(newpath)) {
4166 continue;
4167 }
4168 if (d->d_type == DT_DIR) {
4169 int ret = dump_files("", newpath, skip, dump_from_fd);
4170 if (ret < 0) {
4171 retval = ret;
4172 }
4173 continue;
4174 }
4175 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(newpath, O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
4176 if (fd.get() < 0) {
4177 retval = -1;
4178 printf("*** %s: %s\n", newpath, strerror(errno));
4179 continue;
4180 }
4181 (*dump_from_fd)(nullptr, newpath, fd.get());
4182 }
4183 closedir(dirp);
4184 if (!title.empty()) {
4185 printf("\n");
4186 }
4187 return retval;
4188}
4189
4190/* fd must have been opened with the flag O_NONBLOCK. With this flag set,
4191 * it's possible to avoid issues where opening the file itself can get
4192 * stuck.
4193 */
4194int dump_file_from_fd(const char *title, const char *path, int fd) {
4195 if (PropertiesHelper::IsDryRun()) return 0;
4196
4197 int flags = fcntl(fd, F_GETFL);
4198 if (flags == -1) {
4199 printf("*** %s: failed to get flags on fd %d: %s\n", path, fd, strerror(errno));
4200 return -1;
4201 } else if (!(flags & O_NONBLOCK)) {
4202 printf("*** %s: fd must have O_NONBLOCK set.\n", path);
4203 return -1;
4204 }
4205 return DumpFileFromFdToFd(title, path, fd, STDOUT_FILENO, PropertiesHelper::IsDryRun());
4206}
4207
4208int Dumpstate::RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08004209 const CommandOptions& options, bool verbose_duration, int out_fd) {
4210 DurationReporter duration_reporter(title, false /* logcat_only */,
4211 verbose_duration, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004212
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08004213 int status = RunCommandToFd(out_fd, title, full_command, options);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004214
4215 /* TODO: for now we're simplifying the progress calculation by using the
4216 * timeout as the weight. It's a good approximation for most cases, except when calling dumpsys,
4217 * where its weight should be much higher proportionally to its timeout.
4218 * Ideally, it should use a options.EstimatedDuration() instead...*/
4219 UpdateProgress(options.Timeout());
4220
4221 return status;
4222}
4223
4224void Dumpstate::RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsys_args,
Rhed Jaoe017f982020-07-21 17:58:41 +08004225 const CommandOptions& options, long dumpsysTimeoutMs, int out_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004226 long timeout_ms = dumpsysTimeoutMs > 0 ? dumpsysTimeoutMs : options.TimeoutInMs();
4227 std::vector<std::string> dumpsys = {"/system/bin/dumpsys", "-T", std::to_string(timeout_ms)};
4228 dumpsys.insert(dumpsys.end(), dumpsys_args.begin(), dumpsys_args.end());
Rhed Jaoe017f982020-07-21 17:58:41 +08004229 RunCommand(title, dumpsys, options, false, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004230}
4231
Dieter Hsu105ad0c2020-09-29 15:23:33 +08004232static int open_socket(const char* service) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004233 int s = android_get_control_socket(service);
4234 if (s < 0) {
4235 MYLOGE("android_get_control_socket(%s): %s\n", service, strerror(errno));
4236 return -1;
4237 }
4238 fcntl(s, F_SETFD, FD_CLOEXEC);
4239
4240 // Set backlog to 0 to make sure that queue size will be minimum.
4241 // In Linux, because the minimum queue will be 1, connect() will be blocked
4242 // if the other clients already called connect() and the connection request was not accepted.
4243 if (listen(s, 0) < 0) {
4244 MYLOGE("listen(control socket): %s\n", strerror(errno));
4245 return -1;
4246 }
4247
4248 struct sockaddr addr;
4249 socklen_t alen = sizeof(addr);
Abhijeet Kaur2113cae2019-09-13 09:24:15 +01004250 int fd = accept4(s, &addr, &alen, SOCK_CLOEXEC);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004251
4252 // Close socket just after accept(), to make sure that connect() by client will get error
4253 // when the socket is used by the other services.
4254 // There is still a race condition possibility between accept and close, but there is no way
4255 // to close-on-accept atomically.
4256 // See detail; b/123306389#comment25
4257 close(s);
4258
4259 if (fd < 0) {
4260 MYLOGE("accept(control socket): %s\n", strerror(errno));
4261 return -1;
4262 }
4263
4264 return fd;
4265}
4266
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004267// TODO: should call is_valid_output_file and/or be merged into it.
4268void create_parent_dirs(const char *path) {
4269 char *chp = const_cast<char *> (path);
4270
4271 /* skip initial slash */
4272 if (chp[0] == '/')
4273 chp++;
4274
4275 /* create leading directories, if necessary */
4276 struct stat dir_stat;
4277 while (chp && chp[0]) {
4278 chp = strchr(chp, '/');
4279 if (chp) {
4280 *chp = 0;
4281 if (stat(path, &dir_stat) == -1 || !S_ISDIR(dir_stat.st_mode)) {
4282 MYLOGI("Creating directory %s\n", path);
4283 if (mkdir(path, 0770)) { /* drwxrwx--- */
4284 MYLOGE("Unable to create directory %s: %s\n", path, strerror(errno));
4285 } else if (chown(path, AID_SHELL, AID_SHELL)) {
4286 MYLOGE("Unable to change ownership of dir %s: %s\n", path, strerror(errno));
4287 }
4288 }
4289 *chp++ = '/';
4290 }
4291 }
4292}
4293
4294bool _redirect_to_file(FILE* redirect, char* path, int truncate_flag) {
4295 create_parent_dirs(path);
4296
4297 int fd = TEMP_FAILURE_RETRY(open(path,
4298 O_WRONLY | O_CREAT | truncate_flag | O_CLOEXEC | O_NOFOLLOW,
4299 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH));
4300 if (fd < 0) {
4301 MYLOGE("%s: %s\n", path, strerror(errno));
4302 return false;
4303 }
4304
4305 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
4306 close(fd);
4307 return true;
4308}
4309
4310bool redirect_to_file(FILE* redirect, char* path) {
4311 return _redirect_to_file(redirect, path, O_TRUNC);
4312}
4313
4314bool redirect_to_existing_file(FILE* redirect, char* path) {
4315 return _redirect_to_file(redirect, path, O_APPEND);
4316}
4317
4318void dump_route_tables() {
4319 DurationReporter duration_reporter("DUMP ROUTE TABLES");
4320 if (PropertiesHelper::IsDryRun()) return;
4321 const char* const RT_TABLES_PATH = "/data/misc/net/rt_tables";
4322 ds.DumpFile("RT_TABLES", RT_TABLES_PATH);
4323 FILE* fp = fopen(RT_TABLES_PATH, "re");
4324 if (!fp) {
4325 printf("*** %s: %s\n", RT_TABLES_PATH, strerror(errno));
4326 return;
4327 }
4328 char table[16];
4329 // Each line has an integer (the table number), a space, and a string (the table name). We only
4330 // need the table number. It's a 32-bit unsigned number, so max 10 chars. Skip the table name.
4331 // Add a fixed max limit so this doesn't go awry.
4332 for (int i = 0; i < 64 && fscanf(fp, " %10s %*s", table) == 1; ++i) {
4333 RunCommand("ROUTE TABLE IPv4", {"ip", "-4", "route", "show", "table", table});
4334 RunCommand("ROUTE TABLE IPv6", {"ip", "-6", "route", "show", "table", table});
4335 }
4336 fclose(fp);
4337}
4338
Li Li830179f2022-01-04 12:53:29 -08004339void dump_frozen_cgroupfs(const char *dir, int level,
4340 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
4341 DIR *dirp;
4342 struct dirent *d;
4343 char *newpath = nullptr;
4344
4345 dirp = opendir(dir);
4346 if (dirp == nullptr) {
4347 MYLOGE("%s: %s\n", dir, strerror(errno));
4348 return;
4349 }
4350
4351 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
4352 if ((d->d_name[0] == '.')
4353 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
4354 || (d->d_name[1] == '\0'))) {
4355 continue;
4356 }
4357 if (d->d_type == DT_DIR) {
4358 asprintf(&newpath, "%s/%s/", dir, d->d_name);
4359 if (!newpath) {
4360 continue;
4361 }
4362 if (level == 0 && !strncmp(d->d_name, "uid_", 4)) {
4363 dump_frozen_cgroupfs(newpath, 1, dump_from_fd);
4364 } else if (level == 1 && !strncmp(d->d_name, "pid_", 4)) {
4365 char *freezer = nullptr;
4366 asprintf(&freezer, "%s/%s", newpath, "cgroup.freeze");
4367 if (freezer) {
4368 FILE* fp = fopen(freezer, "r");
4369 if (fp != NULL) {
4370 int frozen;
4371 fscanf(fp, "%d", &frozen);
4372 if (frozen > 0) {
4373 dump_files("", newpath, skip_none, dump_from_fd);
4374 }
4375 fclose(fp);
4376 }
4377 free(freezer);
4378 }
4379 }
4380 }
4381 }
4382 closedir(dirp);
4383}
4384
4385void dump_frozen_cgroupfs() {
Li Li830179f2022-01-04 12:53:29 -08004386 MYLOGD("Adding frozen processes from %s\n", CGROUPFS_DIR);
4387 DurationReporter duration_reporter("FROZEN CGROUPFS");
4388 if (PropertiesHelper::IsDryRun()) return;
4389 dump_frozen_cgroupfs(CGROUPFS_DIR, 0, _add_file_from_fd);
4390}
4391
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004392void Dumpstate::UpdateProgress(int32_t delta_sec) {
4393 if (progress_ == nullptr) {
4394 MYLOGE("UpdateProgress: progress_ not set\n");
4395 return;
4396 }
Rhed Jaobf63d8a2020-07-21 15:42:55 +08004397 // This function updates progress related members of the dumpstate and reports
4398 // progress percentage to the bugreport client. Since it could be called by
4399 // different dump tasks at the same time if the parallel run is enabled, a
4400 // mutex lock is necessary here to synchronize the call.
4401 std::lock_guard<std::recursive_mutex> lock(mutex_);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004402
4403 // Always update progess so stats can be tuned...
Nandana Dutt402a8392019-06-14 14:25:13 +01004404 progress_->Inc(delta_sec);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004405
4406 // ...but only notifiy listeners when necessary.
4407 if (!options_->do_progress_updates) return;
4408
4409 int progress = progress_->Get();
4410 int max = progress_->GetMax();
Nandana Dutt402a8392019-06-14 14:25:13 +01004411 int percent = 100 * progress / max;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004412
Nandana Dutt402a8392019-06-14 14:25:13 +01004413 if (last_reported_percent_progress_ > 0 && percent <= last_reported_percent_progress_) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004414 return;
4415 }
Nandana Dutt402a8392019-06-14 14:25:13 +01004416 last_reported_percent_progress_ = percent;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004417
4418 if (control_socket_fd_ >= 0) {
4419 dprintf(control_socket_fd_, "PROGRESS:%d/%d\n", progress, max);
4420 fsync(control_socket_fd_);
4421 }
4422
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004423 if (listener_ != nullptr) {
Nandana Dutt235c6672019-11-14 15:22:32 +00004424 if (percent % 10 == 0) {
4425 // We don't want to spam logcat, so only log multiples of 10.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004426 MYLOGD("Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004427 } else {
4428 // stderr is ignored on normal invocations, but useful when calling
4429 // /system/bin/dumpstate directly for debuggging.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004430 fprintf(stderr, "Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004431 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004432
4433 listener_->onProgress(percent);
4434 }
4435}
4436
4437void Dumpstate::TakeScreenshot(const std::string& path) {
4438 const std::string& real_path = path.empty() ? screenshot_path_ : path;
4439 int status =
4440 RunCommand("", {"/system/bin/screencap", "-p", real_path},
4441 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
4442 if (status == 0) {
4443 MYLOGD("Screenshot saved on %s\n", real_path.c_str());
4444 } else {
4445 MYLOGE("Failed to take screenshot on %s\n", real_path.c_str());
4446 }
Paul Chang0d2aad72020-02-13 20:04:03 +08004447 if (listener_ != nullptr) {
4448 // Show a visual indication to indicate screenshot is taken via
4449 // IDumpstateListener.onScreenshotTaken()
4450 listener_->onScreenshotTaken(status == 0);
4451 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004452}
4453
4454bool is_dir(const char* pathname) {
4455 struct stat info;
4456 if (stat(pathname, &info) == -1) {
4457 return false;
4458 }
4459 return S_ISDIR(info.st_mode);
4460}
4461
4462time_t get_mtime(int fd, time_t default_mtime) {
4463 struct stat info;
4464 if (fstat(fd, &info) == -1) {
4465 return default_mtime;
4466 }
4467 return info.st_mtime;
4468}