blob: a48313a6fa7e4be8810b2c293ff9724361b8575b [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 {
1257 status_t status = dumpsys.startDumpThread(Dumpsys::TYPE_DUMP, service, args);
1258 if (status == OK) {
1259 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1260 std::chrono::duration<double> elapsed_seconds;
1261 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH &&
1262 service == String16("meminfo")) {
1263 // Use a longer timeout for meminfo, since 30s is not always enough.
1264 status = dumpsys.writeDump(STDOUT_FILENO, service, 60s,
1265 /* as_proto = */ false, elapsed_seconds,
1266 bytes_written);
1267 } else {
1268 status = dumpsys.writeDump(STDOUT_FILENO, service, service_timeout,
1269 /* as_proto = */ false, elapsed_seconds,
1270 bytes_written);
1271 }
1272 dumpsys.writeDumpFooter(STDOUT_FILENO, service, elapsed_seconds);
1273 bool dump_complete = (status == OK);
1274 dumpsys.stopDumpThread(dump_complete);
Gavin Corkeryfac7e2b2021-07-08 22:39:02 +01001275 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001276 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001277
1278 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1279 std::chrono::steady_clock::now() - start);
1280 if (elapsed_duration > timeout) {
1281 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1282 elapsed_duration.count());
1283 break;
1284 }
1285 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001286 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001287}
1288
Vishnu Nair64afc022018-02-01 15:29:34 -08001289static void RunDumpsysText(const std::string& title, int priority,
1290 std::chrono::milliseconds timeout,
1291 std::chrono::milliseconds service_timeout) {
1292 DurationReporter duration_reporter(title);
1293 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1294 fsync(STDOUT_FILENO);
1295 RunDumpsysTextByPriority(title, priority, timeout, service_timeout);
1296}
1297
1298/* Dump all services registered with Normal or Default priority. */
Nandana Dutt5c390032019-03-12 10:52:56 +00001299static Dumpstate::RunStatus RunDumpsysTextNormalPriority(const std::string& title,
1300 std::chrono::milliseconds timeout,
1301 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001302 DurationReporter duration_reporter(title);
1303 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1304 fsync(STDOUT_FILENO);
1305 RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_NORMAL, timeout,
1306 service_timeout);
Nandana Dutt5c390032019-03-12 10:52:56 +00001307
1308 RETURN_IF_USER_DENIED_CONSENT();
1309
1310 return RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_DEFAULT, timeout,
1311 service_timeout);
Vishnu Nair64afc022018-02-01 15:29:34 -08001312}
1313
Nandana Dutt5c390032019-03-12 10:52:56 +00001314static Dumpstate::RunStatus RunDumpsysProto(const std::string& title, int priority,
1315 std::chrono::milliseconds timeout,
1316 std::chrono::milliseconds service_timeout) {
Vishnu Naire97d6122018-01-18 13:58:56 -08001317 sp<android::IServiceManager> sm = defaultServiceManager();
1318 Dumpsys dumpsys(sm.get());
1319 Vector<String16> args;
1320 Dumpsys::setServiceArgs(args, /* asProto = */ true, priority);
1321 DurationReporter duration_reporter(title);
1322
1323 auto start = std::chrono::steady_clock::now();
1324 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ true);
1325 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001326 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001327 std::string path(kProtoPath);
1328 path.append(String8(service).c_str());
1329 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL) {
1330 path.append("_CRITICAL");
1331 } else if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH) {
1332 path.append("_HIGH");
1333 }
1334 path.append(kProtoExt);
Steven Morelandcbd69fc2021-07-20 20:45:43 +00001335 status_t status = dumpsys.startDumpThread(Dumpsys::TYPE_DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001336 if (status == OK) {
1337 status = ds.AddZipEntryFromFd(path, dumpsys.getDumpFd(), service_timeout);
1338 bool dumpTerminated = (status == OK);
1339 dumpsys.stopDumpThread(dumpTerminated);
1340 }
1341 ZipWriter::FileEntry file_entry;
1342 ds.zip_writer_->GetLastEntry(&file_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -08001343
1344 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1345 std::chrono::steady_clock::now() - start);
1346 if (elapsed_duration > timeout) {
1347 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1348 elapsed_duration.count());
1349 break;
1350 }
1351 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001352 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001353}
1354
Nandana Dutta7db6342018-11-21 14:53:34 +00001355// Runs dumpsys on services that must dump first and will take less than 100ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001356static Dumpstate::RunStatus RunDumpsysCritical() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001357 RunDumpsysText("DUMPSYS CRITICAL", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1358 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Nandana Dutt5c390032019-03-12 10:52:56 +00001359
1360 RETURN_IF_USER_DENIED_CONSENT();
1361
1362 return RunDumpsysProto("DUMPSYS CRITICAL PROTO", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1363 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Vishnu Nair780b1282017-10-10 13:57:24 -07001364}
1365
1366// Runs dumpsys on services that must dump first but can take up to 250ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001367static Dumpstate::RunStatus RunDumpsysHigh() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001368 // TODO meminfo takes ~10s, connectivity takes ~5sec to dump. They are both
1369 // high priority. Reduce timeout once they are able to dump in a shorter time or
1370 // moved to a parallel task.
1371 RunDumpsysText("DUMPSYS HIGH", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1372 /* timeout= */ 90s, /* service_timeout= */ 30s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001373
1374 RETURN_IF_USER_DENIED_CONSENT();
1375
1376 return RunDumpsysProto("DUMPSYS HIGH PROTO", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1377 /* timeout= */ 5s, /* service_timeout= */ 1s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001378}
1379
1380// Runs dumpsys on services that must dump but can take up to 10s to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001381static Dumpstate::RunStatus RunDumpsysNormal() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001382 RunDumpsysTextNormalPriority("DUMPSYS", /* timeout= */ 90s, /* service_timeout= */ 10s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001383
1384 RETURN_IF_USER_DENIED_CONSENT();
1385
1386 return RunDumpsysProto("DUMPSYS PROTO", IServiceManager::DUMP_FLAG_PRIORITY_NORMAL,
1387 /* timeout= */ 90s, /* service_timeout= */ 10s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001388}
1389
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001390/*
1391 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1392 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1393 * if it's not running in the parallel task.
1394 */
1395static void DumpHals(int out_fd = STDOUT_FILENO) {
Yifan Hong30528a22020-08-07 18:24:06 -07001396 RunCommand("HARDWARE HALS", {"lshal", "--all", "--types=all"},
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001397 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build(),
1398 false, out_fd);
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001399
Steven Moreland44cd9482018-01-04 16:24:13 -08001400 using android::hidl::manager::V1_0::IServiceManager;
1401 using android::hardware::defaultServiceManager;
1402
1403 sp<IServiceManager> sm = defaultServiceManager();
1404 if (sm == nullptr) {
1405 MYLOGE("Could not retrieve hwservicemanager to dump hals.\n");
1406 return;
1407 }
1408
1409 auto ret = sm->list([&](const auto& interfaces) {
1410 for (const std::string& interface : interfaces) {
1411 std::string cleanName = interface;
1412 std::replace_if(cleanName.begin(),
1413 cleanName.end(),
1414 [](char c) {
1415 return !isalnum(c) &&
1416 std::string("@-_:.").find(c) == std::string::npos;
1417 }, '_');
Nandana Dutt979388e2018-11-30 16:48:55 +00001418 const std::string path = ds.bugreport_internal_dir_ + "/lshal_debug_" + cleanName;
Steven Moreland44cd9482018-01-04 16:24:13 -08001419
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001420 bool empty = false;
Steven Moreland44cd9482018-01-04 16:24:13 -08001421 {
1422 auto fd = android::base::unique_fd(
1423 TEMP_FAILURE_RETRY(open(path.c_str(),
1424 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1425 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1426 if (fd < 0) {
1427 MYLOGE("Could not open %s to dump additional hal information.\n", path.c_str());
1428 continue;
1429 }
1430 RunCommandToFd(fd,
1431 "",
Steven Morelandc81cd3c2018-01-18 14:36:26 -08001432 {"lshal", "debug", "-E", interface},
Steven Moreland44cd9482018-01-04 16:24:13 -08001433 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
1434
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001435 empty = 0 == lseek(fd, 0, SEEK_END);
Steven Moreland44cd9482018-01-04 16:24:13 -08001436 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001437 if (!empty) {
1438 ds.EnqueueAddZipEntryAndCleanupIfNeeded("lshal-debug/" + cleanName + ".txt",
1439 path);
1440 } else {
1441 unlink(path.c_str());
1442 }
Steven Moreland44cd9482018-01-04 16:24:13 -08001443 }
1444 });
1445
1446 if (!ret.isOk()) {
1447 MYLOGE("Could not list hals from hwservicemanager.\n");
1448 }
1449}
1450
Devin Moore8df81bb2022-06-08 22:47:02 +00001451// Dump all of the files that make up the vendor interface.
1452// See the files listed in dumpFileList() for the latest list of files.
1453static void DumpVintf() {
Devin Moore16271d92022-09-22 18:28:48 +00001454
1455 const std::string sku = android::base::GetProperty("ro.boot.product.hardware.sku", "");
1456 const auto vintfFiles = android::vintf::details::dumpFileList(sku);
Devin Moore8df81bb2022-06-08 22:47:02 +00001457 for (const auto vintfFile : vintfFiles) {
1458 struct stat st;
1459 if (stat(vintfFile.c_str(), &st) == 0) {
1460 if (S_ISDIR(st.st_mode)) {
1461 ds.AddDir(vintfFile, true /* recursive */);
1462 } else {
1463 ds.EnqueueAddZipEntryAndCleanupIfNeeded(ZIP_ROOT_DIR + vintfFile,
1464 vintfFile);
1465 }
1466 }
1467 }
1468}
1469
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001470static void DumpExternalFragmentationInfo() {
1471 struct stat st;
1472 if (stat("/proc/buddyinfo", &st) != 0) {
1473 MYLOGE("Unable to dump external fragmentation info\n");
1474 return;
1475 }
1476
1477 printf("------ EXTERNAL FRAGMENTATION INFO ------\n");
1478 std::ifstream ifs("/proc/buddyinfo");
1479 auto unusable_index_regex = std::regex{"Node\\s+([0-9]+),\\s+zone\\s+(\\S+)\\s+(.*)"};
1480 for (std::string line; std::getline(ifs, line);) {
1481 std::smatch match_results;
1482 if (std::regex_match(line, match_results, unusable_index_regex)) {
1483 std::stringstream free_pages(std::string{match_results[3]});
1484 std::vector<int> free_pages_per_order(std::istream_iterator<int>{free_pages},
1485 std::istream_iterator<int>());
1486
1487 int total_free_pages = 0;
1488 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1489 total_free_pages += (free_pages_per_order[i] * std::pow(2, i));
1490 }
1491
1492 printf("Node %s, zone %8s", match_results[1].str().c_str(),
1493 match_results[2].str().c_str());
1494
1495 int usable_free_pages = total_free_pages;
1496 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1497 auto unusable_index = (total_free_pages - usable_free_pages) /
1498 static_cast<double>(total_free_pages);
1499 printf(" %5.3f", unusable_index);
1500 usable_free_pages -= (free_pages_per_order[i] * std::pow(2, i));
1501 }
1502
1503 printf("\n");
1504 }
1505 }
1506 printf("\n");
1507}
1508
mhasankd451a472020-05-26 18:02:39 -07001509static void DumpstateLimitedOnly() {
1510 // Trimmed-down version of dumpstate to only include a whitelisted
1511 // set of logs (system log, event log, and system server / system app
1512 // crashes, and networking logs). See b/136273873 and b/138459828
1513 // for context.
1514 DurationReporter duration_reporter("DUMPSTATE");
1515 unsigned long timeout_ms;
1516 // calculate timeout
1517 timeout_ms = logcat_timeout({"main", "system", "crash"});
1518 RunCommand("SYSTEM LOG",
1519 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1520 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1521 timeout_ms = logcat_timeout({"events"});
1522 RunCommand(
1523 "EVENT LOG",
1524 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1525 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1526
1527 printf("========================================================\n");
1528 printf("== Networking Service\n");
1529 printf("========================================================\n");
1530
1531 RunDumpsys("DUMPSYS NETWORK_SERVICE_LIMITED", {"wifi", "-a"},
1532 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hugo Benichiaa162682020-10-30 23:28:56 +09001533 RunDumpsys("DUMPSYS CONNECTIVITY REQUESTS", {"connectivity", "requests"},
1534 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
mhasankd451a472020-05-26 18:02:39 -07001535
1536 printf("========================================================\n");
1537 printf("== Dropbox crashes\n");
1538 printf("========================================================\n");
1539
1540 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1541 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1542
1543 printf("========================================================\n");
1544 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1545 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1546 printf("========================================================\n");
1547 printf("== dumpstate: done (id %d)\n", ds.id_);
1548 printf("========================================================\n");
1549}
1550
Rhed Jaoe017f982020-07-21 17:58:41 +08001551/*
1552 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1553 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1554 * if it's not running in the parallel task.
1555 */
1556static void DumpCheckins(int out_fd = STDOUT_FILENO) {
1557 dprintf(out_fd, "========================================================\n");
1558 dprintf(out_fd, "== Checkins\n");
1559 dprintf(out_fd, "========================================================\n");
1560
1561 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"}, out_fd);
Rhed Jaoe017f982020-07-21 17:58:41 +08001562 RunDumpsys("CHECKIN NETSTATS", {"netstats", "--checkin"}, out_fd);
1563 RunDumpsys("CHECKIN PROCSTATS", {"procstats", "-c"}, out_fd);
1564 RunDumpsys("CHECKIN USAGESTATS", {"usagestats", "-c"}, out_fd);
1565 RunDumpsys("CHECKIN PACKAGE", {"package", "--checkin"}, out_fd);
1566}
1567
1568/*
1569 * Runs dumpsys on activity service to dump all application activities, services
1570 * and providers in the device.
1571 *
1572 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1573 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1574 * if it's not running in the parallel task.
1575 */
1576static void DumpAppInfos(int out_fd = STDOUT_FILENO) {
1577 dprintf(out_fd, "========================================================\n");
1578 dprintf(out_fd, "== Running Application Activities\n");
1579 dprintf(out_fd, "========================================================\n");
1580
1581 // The following dumpsys internally collects output from running apps, so it can take a long
1582 // time. So let's extend the timeout.
1583
1584 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
1585
1586 RunDumpsys("APP ACTIVITIES", {"activity", "-v", "all"}, DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1587
1588 dprintf(out_fd, "========================================================\n");
1589 dprintf(out_fd, "== Running Application Services (platform)\n");
1590 dprintf(out_fd, "========================================================\n");
1591
1592 RunDumpsys("APP SERVICES PLATFORM", {"activity", "service", "all-platform-non-critical"},
1593 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1594
1595 dprintf(out_fd, "========================================================\n");
1596 dprintf(out_fd, "== Running Application Services (non-platform)\n");
1597 dprintf(out_fd, "========================================================\n");
1598
1599 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1600 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1601
1602 dprintf(out_fd, "========================================================\n");
1603 dprintf(out_fd, "== Running Application Providers (platform)\n");
1604 dprintf(out_fd, "========================================================\n");
1605
1606 RunDumpsys("APP PROVIDERS PLATFORM", {"activity", "provider", "all-platform"},
Rhed Jaob049f182021-01-11 21:08:43 +08001607 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
Rhed Jaoe017f982020-07-21 17:58:41 +08001608
1609 dprintf(out_fd, "========================================================\n");
1610 dprintf(out_fd, "== Running Application Providers (non-platform)\n");
1611 dprintf(out_fd, "========================================================\n");
1612
1613 RunDumpsys("APP PROVIDERS NON-PLATFORM", {"activity", "provider", "all-non-platform"},
1614 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1615}
1616
Nandana Dutt5c390032019-03-12 10:52:56 +00001617// Dumps various things. Returns early with status USER_CONSENT_DENIED if user denies consent
1618// via the consent they are shown. Ignores other errors that occur while running various
1619// commands. The consent checking is currently done around long running tasks, which happen to
1620// be distributed fairly evenly throughout the function.
Kean Mariotti306633e2022-09-05 16:30:47 +00001621Dumpstate::RunStatus Dumpstate::dumpstate() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001622 DurationReporter duration_reporter("DUMPSTATE");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001623
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001624 // Enqueue slow functions into the thread pool, if the parallel run is enabled.
Aaron Huang24d215d2022-04-27 18:51:16 +08001625 std::future<std::string> dump_hals, dump_incident_report, dump_board, dump_checkins,
Kean Mariotti306633e2022-09-05 16:30:47 +00001626 dump_netstats_report, post_process_ui_traces;
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001627 if (ds.dump_pool_) {
1628 // Pool was shutdown in DumpstateDefaultAfterCritical method in order to
Kean Mariotti306633e2022-09-05 16:30:47 +00001629 // drop root user. Restarts it.
1630 ds.dump_pool_->start(/* thread_counts = */3);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001631
Chris Morinbc223142022-02-04 14:17:11 -08001632 dump_hals = ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
1633 dump_incident_report = ds.dump_pool_->enqueueTask(
1634 DUMP_INCIDENT_REPORT_TASK, &DumpIncidentReport);
Aaron Huang24d215d2022-04-27 18:51:16 +08001635 dump_netstats_report = ds.dump_pool_->enqueueTask(
1636 DUMP_NETSTATS_PROTO_TASK, &DumpNetstatsProto);
Chris Morinbc223142022-02-04 14:17:11 -08001637 dump_board = ds.dump_pool_->enqueueTaskWithFd(
1638 DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
1639 dump_checkins = ds.dump_pool_->enqueueTaskWithFd(DUMP_CHECKINS_TASK, &DumpCheckins, _1);
Kean Mariotti306633e2022-09-05 16:30:47 +00001640 post_process_ui_traces = ds.dump_pool_->enqueueTask(
1641 POST_PROCESS_UI_TRACES_TASK, &Dumpstate::MaybePostProcessUiTraces, &ds);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001642 }
1643
Nandana Dutt5c390032019-03-12 10:52:56 +00001644 // Dump various things. Note that anything that takes "long" (i.e. several seconds) should
1645 // check intermittently (if it's intrerruptable like a foreach on pids) and/or should be wrapped
1646 // in a consent check (via RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK).
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -07001647 dump_dev_files("TRUSTY VERSION", "/sys/bus/platform/drivers/trusty", "trusty_version");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001648 RunCommand("UPTIME", {"uptime"});
Wei Wang509bb5d2017-06-09 14:42:12 -07001649 DumpBlockStatFiles();
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001650 DumpFile("MEMORY INFO", "/proc/meminfo");
1651 RunCommand("CPU INFO", {"top", "-b", "-n", "1", "-H", "-s", "6", "-o",
Felipe Leme30dbfa12016-09-02 12:43:26 -07001652 "pid,tid,user,pr,ni,%cpu,s,virt,res,pcy,cmd,name"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001653
Kevin Jeon947922b2022-09-21 00:29:18 +00001654 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "BUGREPORT_PROCDUMP", {"bugreport_procdump"},
1655 CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001656
Sunny Goyal35949782019-11-19 15:54:36 -08001657 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpVisibleWindowViews);
1658
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001659 DumpFile("VIRTUAL MEMORY STATS", "/proc/vmstat");
1660 DumpFile("VMALLOC INFO", "/proc/vmallocinfo");
1661 DumpFile("SLAB INFO", "/proc/slabinfo");
1662 DumpFile("ZONEINFO", "/proc/zoneinfo");
1663 DumpFile("PAGETYPEINFO", "/proc/pagetypeinfo");
1664 DumpFile("BUDDYINFO", "/proc/buddyinfo");
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001665 DumpExternalFragmentationInfo();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001666
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001667 DumpFile("KERNEL CPUFREQ", "/sys/devices/system/cpu/cpu0/cpufreq/stats/time_in_state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001668
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001669 RunCommand("PROCESSES AND THREADS",
Yohei Yukawa591a72d2017-10-05 21:36:35 -07001670 {"ps", "-A", "-T", "-Z", "-O", "pri,nice,rtprio,sched,pcy,time"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001671
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001672 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001673 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_hals));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001674 } else {
1675 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_HALS_TASK, DumpHals);
1676 }
Steven Moreland81b429e2017-01-31 19:50:46 -08001677
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001678 RunCommand("PRINTENV", {"printenv"});
Elliott Hughes21b7c8d2016-10-28 08:53:02 -07001679 RunCommand("NETSTAT", {"netstat", "-nW"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001680 struct stat s;
1681 if (stat("/proc/modules", &s) != 0) {
1682 MYLOGD("Skipping 'lsmod' because /proc/modules does not exist\n");
1683 } else {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001684 RunCommand("LSMOD", {"lsmod"});
Woody Linc198f252021-05-04 16:37:11 +08001685 RunCommand("MODULES INFO",
1686 {"sh", "-c", "cat /proc/modules | cut -d' ' -f1 | "
1687 " while read MOD ; do echo modinfo:$MOD ; modinfo $MOD ; "
1688 "done"}, CommandOptions::AS_ROOT);
Felipe Lemee4eca582016-06-10 17:48:08 -07001689 }
Michal Karpinski4db754f2015-12-11 18:04:32 +00001690
Tom Cherryb87dbfa2020-07-28 11:28:53 -07001691 if (android::base::GetBoolProperty("ro.logd.kernel", false)) {
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001692 DoKernelLogcat();
1693 } else {
1694 do_dmesg();
1695 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001696
Devin Moore8df81bb2022-06-08 22:47:02 +00001697 DumpVintf();
1698
Felipe Lemef0292972016-11-22 13:57:05 -08001699 RunCommand("LIST OF OPEN FILES", {"lsof"}, CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001700
Jeff Brown1dc94e32014-09-11 14:15:27 -07001701 for_each_tid(show_wchan, "BLOCKED PROCESS WAIT-CHANNELS");
Mark Salyzyna297c322016-02-05 15:33:17 -08001702 for_each_pid(show_showtime, "PROCESS TIMES (pid cmd user system iowait+percentage)");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001703
Jack Yu5a6b2e22020-08-14 18:13:35 +08001704 /* Dump Nfc NCI logs */
1705 ds.AddDir("/data/misc/nfc/logs", true);
Ajay Panickerd886ec42016-09-14 12:26:46 -07001706
Paul Chang0d2aad72020-02-13 20:04:03 +08001707 if (ds.options_->do_screenshot && !ds.do_early_screenshot_) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001708 MYLOGI("taking late screenshot\n");
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001709 ds.TakeScreenshot();
Jeff Sharkey5a930032013-03-19 15:05:19 -07001710 }
1711
Felipe Lemee184f662016-10-27 10:04:47 -07001712 AddAnrTraceFiles();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001713
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001714 MaybeAddSystemTraceToZip();
1715
Narayan Kamath8f788292017-05-25 13:20:39 +01001716 // NOTE: tombstones are always added as separate entries in the zip archive
1717 // and are not interspersed with the main report.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001718 const bool tombstones_dumped = AddDumps(ds.tombstone_data_.begin(), ds.tombstone_data_.end(),
Narayan Kamathbd863722017-06-01 18:50:12 +01001719 "TOMBSTONE", true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001720 if (!tombstones_dumped) {
1721 printf("*** NO TOMBSTONES to dump in %s\n\n", TOMBSTONE_DIR.c_str());
Christopher Ferris7dc7f322014-07-22 16:08:19 -07001722 }
1723
Jayachandran Ca94c7172017-06-10 15:08:12 -07001724 DumpPacketStats();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001725
Lorenzo Colitti807f2dd2022-05-27 12:48:37 +09001726 RunDumpsys("EBPF MAP STATS", {"connectivity", "trafficcontroller"});
Chenbo Feng276a3b62018-08-07 11:44:49 -07001727
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001728 DoKmsg();
Mark Salyzyn2262c162014-12-16 09:09:26 -08001729
Woody Lin20767a92022-11-29 15:50:24 +08001730 DumpShutdownCheckpoints();
1731
Jayachandran Ca94c7172017-06-10 15:08:12 -07001732 DumpIpAddrAndRules();
Sreeram Ramachandran2b3bba32014-07-08 15:40:55 -07001733
1734 dump_route_tables();
1735
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001736 RunCommand("ARP CACHE", {"ip", "-4", "neigh", "show"});
1737 RunCommand("IPv6 ND CACHE", {"ip", "-6", "neigh", "show"});
1738 RunCommand("MULTICAST ADDRESSES", {"ip", "maddr"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001739
Nandana Dutt5c390032019-03-12 10:52:56 +00001740 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysHigh);
Lorenzo Colitti6afc38c2015-09-09 22:59:25 +09001741
Chiachang Wang668ede42021-05-17 17:14:20 +08001742 // The dump mechanism in connectivity is refactored due to modularization work. Connectivity can
1743 // only register with a default priority(NORMAL priority). Dumpstate has to call connectivity
1744 // dump with priority parameters to dump high priority information.
1745 RunDumpsys("SERVICE HIGH connectivity", {"connectivity", "--dump-priority", "HIGH"},
1746 CommandOptions::WithTimeout(10).Build());
1747
Elliott Hughes23ccc622017-02-28 10:14:22 -08001748 RunCommand("SYSTEM PROPERTIES", {"getprop"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001749
Jin Qianf334d662017-10-10 14:41:37 -07001750 RunCommand("STORAGED IO INFO", {"storaged", "-u", "-p"});
ynwangf649a6e2016-07-17 21:56:00 -07001751
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001752 RunCommand("FILESYSTEMS & FREE SPACE", {"df"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001753
Colin Crossf45fa6b2012-03-26 12:38:26 -07001754 /* Binder state is expensive to look at as it uses a lot of memory. */
Hridya Valsaraju920ba712020-02-09 16:27:01 -08001755 std::string binder_logs_dir = access("/dev/binderfs/binder_logs", R_OK) ?
1756 "/sys/kernel/debug/binder" : "/dev/binderfs/binder_logs";
1757
1758 DumpFile("BINDER FAILED TRANSACTION LOG", binder_logs_dir + "/failed_transaction_log");
1759 DumpFile("BINDER TRANSACTION LOG", binder_logs_dir + "/transaction_log");
1760 DumpFile("BINDER TRANSACTIONS", binder_logs_dir + "/transactions");
1761 DumpFile("BINDER STATS", binder_logs_dir + "/stats");
1762 DumpFile("BINDER STATE", binder_logs_dir + "/state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001763
Yifan Hongd90cc652020-02-08 16:52:02 -08001764 ds.AddDir(SNAPSHOTCTL_LOG_DIR, false);
1765
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001766 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001767 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_board));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001768 } else {
1769 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
1770 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001771
Steven Moreland7440ddb2016-12-15 16:13:39 -08001772 /* Migrate the ril_dumpstate to a device specific dumpstate? */
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001773 int rilDumpstateTimeout = android::base::GetIntProperty("ril.dumpstate.timeout", 0);
1774 if (rilDumpstateTimeout > 0) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001775 // su does not exist on user builds, so try running without it.
1776 // This way any implementations of vril-dump that do not require
1777 // root can run on user builds.
1778 CommandOptions::CommandOptionsBuilder options =
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001779 CommandOptions::WithTimeout(rilDumpstateTimeout);
Felipe Lemef0292972016-11-22 13:57:05 -08001780 if (!PropertiesHelper::IsUserBuild()) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001781 options.AsRoot();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001782 }
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001783 RunCommand("DUMP VENDOR RIL LOGS", {"vril-dump"}, options.Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -07001784 }
1785
Felipe Lemed8b94e52016-12-08 10:21:44 -08001786 printf("========================================================\n");
1787 printf("== Android Framework Services\n");
1788 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001789
Nandana Dutt5c390032019-03-12 10:52:56 +00001790 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysNormal);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001791
Jack He91ff2fe2021-02-18 18:23:43 -08001792 /* Dump Bluetooth HCI logs after getting bluetooth_manager dumpsys */
1793 ds.AddDir("/data/misc/bluetooth/logs", true);
1794
Rhed Jaoe017f982020-07-21 17:58:41 +08001795 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001796 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_checkins));
Rhed Jaoe017f982020-07-21 17:58:41 +08001797 } else {
1798 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_CHECKINS_TASK, DumpCheckins);
1799 }
Dianne Hackborn02bea972013-06-26 18:59:09 -07001800
Rhed Jaoc5f7ec32020-12-22 22:11:08 +08001801 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpAppInfos);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001802
Adrian Roos8b397ab2017-04-04 16:35:44 -07001803 printf("========================================================\n");
1804 printf("== Dropbox crashes\n");
1805 printf("========================================================\n");
1806
1807 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1808 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1809
Felipe Lemed8b94e52016-12-08 10:21:44 -08001810 printf("========================================================\n");
1811 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1812 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1813 printf("========================================================\n");
1814 printf("== dumpstate: done (id %d)\n", ds.id_);
1815 printf("========================================================\n");
Bookatz38472142018-09-28 10:20:24 -07001816
1817 printf("========================================================\n");
1818 printf("== Obtaining statsd metadata\n");
1819 printf("========================================================\n");
1820 // This differs from the usual dumpsys stats, which is the stats report data.
1821 RunDumpsys("STATSDSTATS", {"stats", "--metadata"});
Mike Ma5c267872019-08-21 11:31:34 -07001822
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +09001823 // Add linker configuration directory
1824 ds.AddDir(LINKERCONFIG_DIR, true);
1825
Li Li830179f2022-01-04 12:53:29 -08001826 /* Dump frozen cgroupfs */
1827 dump_frozen_cgroupfs();
Li Li2eedd412021-06-30 15:11:53 -07001828
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001829 if (ds.dump_pool_) {
Aaron Huang24d215d2022-04-27 18:51:16 +08001830 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_netstats_report));
1831 } else {
1832 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_NETSTATS_PROTO_TASK,
1833 DumpNetstatsProto);
1834 }
1835
1836 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001837 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_incident_report));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001838 } else {
1839 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_INCIDENT_REPORT_TASK,
1840 DumpIncidentReport);
1841 }
Mike Ma5c267872019-08-21 11:31:34 -07001842
Kean Mariotti306633e2022-09-05 16:30:47 +00001843 if (ds.dump_pool_) {
1844 WaitForTask(std::move(post_process_ui_traces));
1845 } else {
1846 RUN_SLOW_FUNCTION_AND_LOG(POST_PROCESS_UI_TRACES_TASK, MaybePostProcessUiTraces);
1847 }
1848
1849 MaybeAddUiTracesToZip();
1850
Nandana Dutt5c390032019-03-12 10:52:56 +00001851 return Dumpstate::RunStatus::OK;
Colin Crossf45fa6b2012-03-26 12:38:26 -07001852}
1853
Nandana Dutt5c390032019-03-12 10:52:56 +00001854/*
1855 * Dumps state for the default case; drops root after it's no longer necessary.
1856 *
1857 * Returns RunStatus::OK if everything went fine.
1858 * Returns RunStatus::ERROR if there was an error.
1859 * Returns RunStatus::USER_DENIED_CONSENT if user explicitly denied consent to sharing the bugreport
1860 * with the caller.
1861 */
Jichao Lie89d9c12019-11-21 19:02:51 -08001862Dumpstate::RunStatus Dumpstate::DumpstateDefaultAfterCritical() {
Nandana Duttdb379fa2019-10-09 16:54:41 +01001863 // Capture first logcat early on; useful to take a snapshot before dumpstate logs take over the
1864 // buffer.
1865 DoLogcat();
1866 // Capture timestamp after first logcat to use in next logcat
1867 time_t logcat_ts = time(nullptr);
1868
Nandana Dutt4be45d12018-09-26 15:04:23 +01001869 /* collect stack traces from Dalvik and native processes (needs root) */
Chris Morinbc223142022-02-04 14:17:11 -08001870 std::future<std::string> dump_traces;
Rhed Jao5377d792020-07-16 17:37:39 +08001871 if (dump_pool_) {
1872 RETURN_IF_USER_DENIED_CONSENT();
1873 // One thread is enough since we only need to enqueue DumpTraces here.
1874 dump_pool_->start(/* thread_counts = */1);
1875
1876 // DumpTraces takes long time, post it to the another thread in the
1877 // pool, if pool is available
Chris Morinbc223142022-02-04 14:17:11 -08001878 dump_traces = dump_pool_->enqueueTask(
1879 DUMP_TRACES_TASK, &Dumpstate::DumpTraces, &ds, &dump_traces_path);
Rhed Jao5377d792020-07-16 17:37:39 +08001880 } else {
1881 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_TRACES_TASK, ds.DumpTraces,
1882 &dump_traces_path);
1883 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001884
1885 /* Run some operations that require root. */
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001886 if (!PropertiesHelper::IsDryRun()) {
Chris Morinc2cba7a2022-02-01 17:06:50 -08001887 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX);
1888 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX);
Woody Lin20767a92022-11-29 15:50:24 +08001889 ds.shutdown_checkpoints_ = GetDumpFds(
1890 SHUTDOWN_CHECKPOINTS_DIR, SHUTDOWN_CHECKPOINTS_FILE_PREFIX);
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001891 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001892
1893 ds.AddDir(RECOVERY_DIR, true);
1894 ds.AddDir(RECOVERY_DATA_DIR, true);
1895 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
Kelvin Zhang6eaa0f92022-09-12 09:29:19 -07001896 ds.AddDir(UPDATE_ENGINE_PREF_DIR, true);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001897 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1898 if (!PropertiesHelper::IsUserBuild()) {
1899 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1900 ds.AddDir(PROFILE_DATA_DIR_REF, true);
Calin Juravlef84d3692020-04-28 15:31:12 -07001901 ds.AddZipEntry(ZIP_ROOT_DIR + PACKAGE_DEX_USE_LIST, PACKAGE_DEX_USE_LIST);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001902 }
Jerry Changa1df8a92020-01-02 16:03:39 +08001903 ds.AddDir(PREREBOOT_DATA_DIR, false);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001904 add_mountinfo();
1905 DumpIpTablesAsRoot();
David Andersond9ba4752018-12-11 18:26:59 -08001906 DumpDynamicPartitionInfo();
Yifan Hong3945e1b2019-10-29 12:59:23 -07001907 ds.AddDir(OTA_METADATA_DIR, true);
Jeff Sharkey9df29d52023-02-06 14:26:30 -07001908 if (!PropertiesHelper::IsUserBuild()) {
1909 // Include dropbox entry files inside ZIP, but exclude
1910 // noisy WTF and StrictMode entries
1911 dump_files("", DROPBOX_DIR, skip_wtf_strictmode, _add_file_from_fd);
1912 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001913
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001914 // Capture any IPSec policies in play. No keys are exposed here.
Nandana Dutt4be45d12018-09-26 15:04:23 +01001915 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1916
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001917 // Dump IPsec stats. No keys are exposed here.
1918 DumpFile("XFRM STATS", XFRM_STAT_PROC_FILE);
1919
Nandana Dutt4be45d12018-09-26 15:04:23 +01001920 // Run ss as root so we can see socket marks.
1921 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
1922
1923 // Run iotop as root to show top 100 IO threads
1924 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
1925
Erick Reyese68df822019-02-11 14:46:36 -08001926 // Gather shared memory buffer info if the product implements it
Hridya Valsaraju1da80c52021-01-09 22:10:11 -08001927 RunCommand("Dmabuf dump", {"dmabuf_dump"});
1928 RunCommand("Dmabuf per-buffer/per-exporter/per-device stats", {"dmabuf_dump", "-b"});
Erick Reyese68df822019-02-11 14:46:36 -08001929
Minchan Kim22c6a1e2019-09-30 15:58:10 -07001930 DumpFile("PSI cpu", "/proc/pressure/cpu");
1931 DumpFile("PSI memory", "/proc/pressure/memory");
1932 DumpFile("PSI io", "/proc/pressure/io");
1933
Mårten Kongstad60195a72022-09-20 14:14:20 +02001934 RunCommand("SDK EXTENSIONS", {SDK_EXT_INFO, "--dump"},
1935 CommandOptions::WithTimeout(10).Always().DropRoot().Build());
1936
Rhed Jao5377d792020-07-16 17:37:39 +08001937 if (dump_pool_) {
1938 RETURN_IF_USER_DENIED_CONSENT();
Chris Morinbc223142022-02-04 14:17:11 -08001939 WaitForTask(std::move(dump_traces));
Rhed Jao5377d792020-07-16 17:37:39 +08001940
Chris Morinbc223142022-02-04 14:17:11 -08001941 // Current running thread in the pool is the root user also. Delete
1942 // the pool and make a new one later to ensure none of threads in the pool are root.
1943 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao5377d792020-07-16 17:37:39 +08001944 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001945 if (!DropRootUser()) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001946 return Dumpstate::RunStatus::ERROR;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001947 }
1948
Nandana Dutt5c390032019-03-12 10:52:56 +00001949 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttdb379fa2019-10-09 16:54:41 +01001950 Dumpstate::RunStatus status = dumpstate();
1951 // Capture logcat since the last time we did it.
1952 DoSystemLogcat(logcat_ts);
1953 return status;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001954}
1955
Rhed Jaob5685b32020-08-14 17:19:17 +08001956// Common states for telephony and wifi which are needed to be collected before
1957// dumpstate drop the root user.
1958static void DumpstateRadioAsRoot() {
1959 DumpIpTablesAsRoot();
1960 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1961}
1962
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001963// This method collects common dumpsys for telephony and wifi. Typically, wifi
1964// reports are fine to include all information, but telephony reports on user
1965// builds need to strip some content (see DumpstateTelephonyOnly).
1966static void DumpstateRadioCommon(bool include_sensitive_info = true) {
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001967 // We need to be picky about some stuff for telephony reports on user builds.
1968 if (!include_sensitive_info) {
1969 // Only dump the radio log buffer (other buffers and dumps contain too much unrelated info).
1970 DoRadioLogcat();
1971 } else {
Rhed Jaob5685b32020-08-14 17:19:17 +08001972 // DumpHals takes long time, post it to the another thread in the pool,
1973 // if pool is available.
Chris Morinbc223142022-02-04 14:17:11 -08001974 std::future<std::string> dump_hals;
Rhed Jaob5685b32020-08-14 17:19:17 +08001975 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001976 dump_hals = ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
Rhed Jaob5685b32020-08-14 17:19:17 +08001977 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001978 // Contains various system properties and process startup info.
1979 do_dmesg();
1980 // Logs other than the radio buffer may contain package/component names and potential PII.
1981 DoLogcat();
1982 // Too broad for connectivity problems.
1983 DoKmsg();
Rhed Jaob5685b32020-08-14 17:19:17 +08001984 // DumpHals contains unrelated hardware info (camera, NFC, biometrics, ...).
1985 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001986 WaitForTask(std::move(dump_hals));
Rhed Jaob5685b32020-08-14 17:19:17 +08001987 } else {
1988 RUN_SLOW_FUNCTION_AND_LOG(DUMP_HALS_TASK, DumpHals);
1989 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001990 }
1991
Jayachandran Ca94c7172017-06-10 15:08:12 -07001992 DumpPacketStats();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001993 DumpIpAddrAndRules();
1994 dump_route_tables();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001995 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
1996 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08001997}
1998
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001999// We use "telephony" here for legacy reasons, though this now really means "connectivity" (cellular
2000// + wifi + networking). This method collects dumpsys for connectivity debugging only. General rules
2001// for what can be included on user builds: all reported information MUST directly relate to
2002// connectivity debugging or customer support and MUST NOT contain unrelated personally identifiable
2003// information. This information MUST NOT identify user-installed packages (UIDs are OK, package
2004// names are not), and MUST NOT contain logs of user application traffic.
2005// TODO(b/148168577) rename this and other related fields/methods to "connectivity" instead.
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08002006static void DumpstateTelephonyOnly(const std::string& calling_package) {
mukesh agrawal253dad42018-01-23 21:59:59 -08002007 DurationReporter duration_reporter("DUMPSTATE");
Jichao Lie89d9c12019-11-21 19:02:51 -08002008
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002009 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08002010
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002011 const bool include_sensitive_info = !PropertiesHelper::IsUserBuild();
Jayachandran Ca94c7172017-06-10 15:08:12 -07002012
Rhed Jaob5685b32020-08-14 17:19:17 +08002013 DumpstateRadioAsRoot();
2014 if (!DropRootUser()) {
2015 return;
2016 }
2017
2018 // Starts thread pool after the root user is dropped, and two additional threads
2019 // are created for DumpHals in the DumpstateRadioCommon and DumpstateBoard.
Chris Morinbc223142022-02-04 14:17:11 -08002020 std::future<std::string> dump_board;
Rhed Jaob5685b32020-08-14 17:19:17 +08002021 if (ds.dump_pool_) {
2022 ds.dump_pool_->start(/*thread_counts =*/2);
2023
2024 // DumpstateBoard takes long time, post it to the another thread in the pool,
2025 // if pool is available.
Chris Morinbc223142022-02-04 14:17:11 -08002026 dump_board = ds.dump_pool_->enqueueTaskWithFd(
2027 DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
Rhed Jaob5685b32020-08-14 17:19:17 +08002028 }
2029
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002030 DumpstateRadioCommon(include_sensitive_info);
2031
2032 if (include_sensitive_info) {
2033 // Contains too much unrelated PII, and given the unstructured nature of sysprops, we can't
2034 // really cherrypick all of the connectivity-related ones. Apps generally have no business
2035 // reading these anyway, and there should be APIs to supply the info in a more app-friendly
2036 // way.
2037 RunCommand("SYSTEM PROPERTIES", {"getprop"});
2038 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002039
2040 printf("========================================================\n");
2041 printf("== Android Framework Services\n");
2042 printf("========================================================\n");
2043
Vishnu Nair652cc802017-11-30 15:18:30 -08002044 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
2045 SEC_TO_MSEC(10));
Hunter Knepshield31cbae12021-05-11 16:23:24 -07002046 RunDumpsys("DUMPSYS", {"vcn_management"}, CommandOptions::WithTimeout(90).Build(),
2047 SEC_TO_MSEC(10));
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08002048 if (include_sensitive_info) {
2049 // Carrier apps' services will be dumped below in dumpsys activity service all-non-platform.
2050 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
2051 SEC_TO_MSEC(10));
2052 } else {
2053 // If the caller is a carrier app and has a carrier service, dump it here since we aren't
2054 // running dumpsys activity service all-non-platform below. Due to the increased output, we
2055 // give a higher timeout as well.
2056 RunDumpsys("DUMPSYS", {"carrier_config", "--requesting-package", calling_package},
2057 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(30));
2058 }
2059 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002060 RunDumpsys("DUMPSYS", {"netpolicy"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
2061 RunDumpsys("DUMPSYS", {"network_management"}, CommandOptions::WithTimeout(90).Build(),
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07002062 SEC_TO_MSEC(10));
Hunter Knepshield0fe51b12020-03-05 16:58:20 -08002063 RunDumpsys("DUMPSYS", {"telephony.registry"}, CommandOptions::WithTimeout(90).Build(),
2064 SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002065 if (include_sensitive_info) {
2066 // Contains raw IP addresses, omit from reports on user builds.
2067 RunDumpsys("DUMPSYS", {"netd"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
2068 // Contains raw destination IP/MAC addresses, omit from reports on user builds.
2069 RunDumpsys("DUMPSYS", {"connmetrics"}, CommandOptions::WithTimeout(90).Build(),
2070 SEC_TO_MSEC(10));
2071 // Contains package/component names, omit from reports on user builds.
2072 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
2073 SEC_TO_MSEC(10));
2074 // Contains package names, but should be relatively simple to remove them (also contains
2075 // UIDs already), omit from reports on user builds.
2076 RunDumpsys("BATTERYSTATS", {"deviceidle"}, CommandOptions::WithTimeout(90).Build(),
2077 SEC_TO_MSEC(10));
2078 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002079
2080 printf("========================================================\n");
2081 printf("== Running Application Services\n");
2082 printf("========================================================\n");
2083
2084 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
2085
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002086 if (include_sensitive_info) {
2087 printf("========================================================\n");
2088 printf("== Running Application Services (non-platform)\n");
2089 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002090
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002091 // Contains package/component names and potential PII, omit from reports on user builds.
2092 // To get dumps of the active CarrierService(s) on user builds, we supply an argument to the
2093 // carrier_config dumpsys instead.
2094 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
2095 DUMPSYS_COMPONENTS_OPTIONS);
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002096
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002097 printf("========================================================\n");
2098 printf("== Checkins\n");
2099 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002100
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002101 // Contains package/component names, omit from reports on user builds.
2102 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
2103 }
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002104
2105 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07002106 printf("== dumpstate: done (id %d)\n", ds.id_);
2107 printf("========================================================\n");
Rhed Jaob5685b32020-08-14 17:19:17 +08002108
2109 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08002110 WaitForTask(std::move(dump_board));
Rhed Jaob5685b32020-08-14 17:19:17 +08002111 } else {
2112 RUN_SLOW_FUNCTION_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
2113 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002114}
2115
mukesh agrawal253dad42018-01-23 21:59:59 -08002116// This method collects dumpsys for wifi debugging only
2117static void DumpstateWifiOnly() {
2118 DurationReporter duration_reporter("DUMPSTATE");
2119
Rhed Jaob5685b32020-08-14 17:19:17 +08002120 DumpstateRadioAsRoot();
2121 if (!DropRootUser()) {
2122 return;
2123 }
2124
2125 // Starts thread pool after the root user is dropped. Only one additional
2126 // thread is needed for DumpHals in the DumpstateRadioCommon.
2127 if (ds.dump_pool_) {
2128 ds.dump_pool_->start(/*thread_counts =*/1);
2129 }
2130
mukesh agrawal253dad42018-01-23 21:59:59 -08002131 DumpstateRadioCommon();
2132
2133 printf("========================================================\n");
2134 printf("== Android Framework Services\n");
2135 printf("========================================================\n");
2136
2137 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
2138 SEC_TO_MSEC(10));
2139 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
2140 SEC_TO_MSEC(10));
2141
2142 printf("========================================================\n");
2143 printf("== dumpstate: done (id %d)\n", ds.id_);
2144 printf("========================================================\n");
2145}
2146
Nandana Duttcf419a72019-03-14 10:40:17 +00002147Dumpstate::RunStatus Dumpstate::DumpTraces(const char** path) {
Gavin Corkery789d7a52021-02-24 23:52:35 +00002148 const std::string temp_file_pattern = ds.bugreport_internal_dir_ + "/dumptrace_XXXXXX";
Nandana Duttfaafd522019-03-11 09:23:09 +00002149 const size_t buf_size = temp_file_pattern.length() + 1;
2150 std::unique_ptr<char[]> file_name_buf(new char[buf_size]);
2151 memcpy(file_name_buf.get(), temp_file_pattern.c_str(), buf_size);
2152
2153 // Create a new, empty file to receive all trace dumps.
2154 //
2155 // TODO: This can be simplified once we remove support for the old style
2156 // dumps. We can have a file descriptor passed in to dump_traces instead
2157 // of creating a file, closing it and then reopening it again.
2158 android::base::unique_fd fd(mkostemp(file_name_buf.get(), O_APPEND | O_CLOEXEC));
2159 if (fd < 0) {
2160 MYLOGE("mkostemp on pattern %s: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002161 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002162 }
2163
2164 // Nobody should have access to this temporary file except dumpstate, but we
2165 // temporarily grant 'read' to 'others' here because this file is created
2166 // when tombstoned is still running as root, but dumped after dropping. This
2167 // can go away once support for old style dumping has.
2168 const int chmod_ret = fchmod(fd, 0666);
2169 if (chmod_ret < 0) {
2170 MYLOGE("fchmod on %s failed: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002171 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002172 }
2173
2174 std::unique_ptr<DIR, decltype(&closedir)> proc(opendir("/proc"), closedir);
2175 if (proc.get() == nullptr) {
2176 MYLOGE("opendir /proc failed: %s\n", strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002177 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002178 }
2179
2180 // Number of times process dumping has timed out. If we encounter too many
2181 // failures, we'll give up.
2182 int timeout_failures = 0;
2183 bool dalvik_found = false;
2184
Jayant Chowdharya0a8eb22022-05-20 03:30:09 +00002185 const std::set<int> hal_pids = get_interesting_pids();
Nandana Duttfaafd522019-03-11 09:23:09 +00002186
2187 struct dirent* d;
2188 while ((d = readdir(proc.get()))) {
Nandana Duttcf419a72019-03-14 10:40:17 +00002189 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttfaafd522019-03-11 09:23:09 +00002190 int pid = atoi(d->d_name);
2191 if (pid <= 0) {
2192 continue;
2193 }
2194
2195 const std::string link_name = android::base::StringPrintf("/proc/%d/exe", pid);
2196 std::string exe;
2197 if (!android::base::Readlink(link_name, &exe)) {
2198 continue;
2199 }
2200
2201 bool is_java_process;
2202 if (exe == "/system/bin/app_process32" || exe == "/system/bin/app_process64") {
2203 // Don't bother dumping backtraces for the zygote.
2204 if (IsZygote(pid)) {
2205 continue;
2206 }
2207
2208 dalvik_found = true;
2209 is_java_process = true;
2210 } else if (should_dump_native_traces(exe.c_str()) || hal_pids.find(pid) != hal_pids.end()) {
2211 is_java_process = false;
2212 } else {
2213 // Probably a native process we don't care about, continue.
2214 continue;
2215 }
2216
2217 // If 3 backtrace dumps fail in a row, consider debuggerd dead.
2218 if (timeout_failures == 3) {
2219 dprintf(fd, "ERROR: Too many stack dump failures, exiting.\n");
2220 break;
2221 }
2222
2223 const uint64_t start = Nanotime();
2224 const int ret = dump_backtrace_to_file_timeout(
2225 pid, is_java_process ? kDebuggerdJavaBacktrace : kDebuggerdNativeBacktrace,
2226 is_java_process ? 5 : 20, fd);
2227
2228 if (ret == -1) {
2229 // For consistency, the header and footer to this message match those
2230 // dumped by debuggerd in the success case.
2231 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
2232 dprintf(fd, "Dump failed, likely due to a timeout.\n");
2233 dprintf(fd, "---- end %d ----", pid);
2234 timeout_failures++;
2235 continue;
2236 }
2237
2238 // We've successfully dumped stack traces, reset the failure count
2239 // and write a summary of the elapsed time to the file and continue with the
2240 // next process.
2241 timeout_failures = 0;
2242
2243 dprintf(fd, "[dump %s stack %d: %.3fs elapsed]\n", is_java_process ? "dalvik" : "native",
2244 pid, (float)(Nanotime() - start) / NANOS_PER_SEC);
2245 }
2246
2247 if (!dalvik_found) {
2248 MYLOGE("Warning: no Dalvik processes found to dump stacks\n");
2249 }
2250
Nandana Duttcf419a72019-03-14 10:40:17 +00002251 *path = file_name_buf.release();
2252 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002253}
2254
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002255static dumpstate_hal_hidl::DumpstateMode GetDumpstateHalModeHidl(
2256 const Dumpstate::BugreportMode bugreport_mode) {
2257 switch (bugreport_mode) {
2258 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2259 return dumpstate_hal_hidl::DumpstateMode::FULL;
2260 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2261 return dumpstate_hal_hidl::DumpstateMode::INTERACTIVE;
2262 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2263 return dumpstate_hal_hidl::DumpstateMode::REMOTE;
2264 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2265 return dumpstate_hal_hidl::DumpstateMode::WEAR;
2266 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2267 return dumpstate_hal_hidl::DumpstateMode::CONNECTIVITY;
2268 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2269 return dumpstate_hal_hidl::DumpstateMode::WIFI;
2270 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2271 return dumpstate_hal_hidl::DumpstateMode::DEFAULT;
2272 }
2273 return dumpstate_hal_hidl::DumpstateMode::DEFAULT;
2274}
2275
2276static dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode GetDumpstateHalModeAidl(
2277 const Dumpstate::BugreportMode bugreport_mode) {
2278 switch (bugreport_mode) {
2279 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2280 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::FULL;
2281 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2282 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::INTERACTIVE;
2283 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2284 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::REMOTE;
2285 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2286 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::WEAR;
2287 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2288 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::CONNECTIVITY;
2289 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2290 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::WIFI;
2291 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2292 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::DEFAULT;
2293 }
2294 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::DEFAULT;
2295}
2296
2297static void DoDumpstateBoardHidl(
2298 const sp<dumpstate_hal_hidl_1_0::IDumpstateDevice> dumpstate_hal_1_0,
2299 const std::vector<::ndk::ScopedFileDescriptor>& dumpstate_fds,
2300 const Dumpstate::BugreportMode bugreport_mode,
2301 const size_t timeout_sec) {
2302
2303 using ScopedNativeHandle =
2304 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
2305 ScopedNativeHandle handle(native_handle_create(static_cast<int>(dumpstate_fds.size()), 0),
2306 [](native_handle_t* handle) {
2307 // we don't close file handle's here
2308 // via native_handle_close(handle)
2309 // instead we let dumpstate_fds close the file handles when
2310 // dumpstate_fds gets destroyed
2311 native_handle_delete(handle);
2312 });
2313 if (handle == nullptr) {
2314 MYLOGE("Could not create native_handle for dumpstate HAL\n");
2315 return;
2316 }
2317
2318 for (size_t i = 0; i < dumpstate_fds.size(); i++) {
2319 handle.get()->data[i] = dumpstate_fds[i].get();
2320 }
2321
2322 // Prefer version 1.1 if available. New devices launching with R are no longer allowed to
2323 // implement just 1.0.
2324 const char* descriptor_to_kill;
2325 using DumpstateBoardTask = std::packaged_task<bool()>;
2326 DumpstateBoardTask dumpstate_board_task;
2327 sp<dumpstate_hal_hidl::IDumpstateDevice> dumpstate_hal(
2328 dumpstate_hal_hidl::IDumpstateDevice::castFrom(dumpstate_hal_1_0));
2329 if (dumpstate_hal != nullptr) {
2330 MYLOGI("Using IDumpstateDevice v1.1 HIDL HAL");
2331
2332 dumpstate_hal_hidl::DumpstateMode dumpstate_hal_mode =
2333 GetDumpstateHalModeHidl(bugreport_mode);
2334
2335 descriptor_to_kill = dumpstate_hal_hidl::IDumpstateDevice::descriptor;
2336 dumpstate_board_task =
2337 DumpstateBoardTask([timeout_sec, dumpstate_hal_mode, dumpstate_hal, &handle]() -> bool {
2338 ::android::hardware::Return<dumpstate_hal_hidl::DumpstateStatus> status =
2339 dumpstate_hal->dumpstateBoard_1_1(handle.get(), dumpstate_hal_mode,
2340 SEC_TO_MSEC(timeout_sec));
2341 if (!status.isOk()) {
2342 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2343 return false;
2344 } else if (status != dumpstate_hal_hidl::DumpstateStatus::OK) {
2345 MYLOGE("dumpstateBoard failed with DumpstateStatus::%s\n",
2346 dumpstate_hal_hidl::toString(status).c_str());
2347 return false;
2348 }
2349 return true;
2350 });
2351 } else {
2352 MYLOGI("Using IDumpstateDevice v1.0 HIDL HAL");
2353
2354 descriptor_to_kill = dumpstate_hal_hidl_1_0::IDumpstateDevice::descriptor;
2355 dumpstate_board_task = DumpstateBoardTask([dumpstate_hal_1_0, &handle]() -> bool {
2356 ::android::hardware::Return<void> status =
2357 dumpstate_hal_1_0->dumpstateBoard(handle.get());
2358 if (!status.isOk()) {
2359 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2360 return false;
2361 }
2362 return true;
2363 });
2364 }
2365 auto result = dumpstate_board_task.get_future();
2366 std::thread(std::move(dumpstate_board_task)).detach();
2367
2368 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2369 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate HAL\n", timeout_sec);
2370 if (!android::base::SetProperty(
2371 "ctl.interface_restart",
2372 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
2373 MYLOGE("Couldn't restart dumpstate HAL\n");
2374 }
2375 }
2376 // Wait some time for init to kill dumpstate vendor HAL
2377 constexpr size_t killing_timeout_sec = 10;
2378 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2379 MYLOGE(
2380 "killing dumpstateBoard timed out after %zus, continue and "
2381 "there might be racing in content\n",
2382 killing_timeout_sec);
2383 }
2384}
2385
2386static void DoDumpstateBoardAidl(
2387 const std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> dumpstate_hal,
2388 const std::vector<::ndk::ScopedFileDescriptor>& dumpstate_fds,
2389 const Dumpstate::BugreportMode bugreport_mode, const size_t timeout_sec) {
2390 MYLOGI("Using IDumpstateDevice AIDL HAL");
2391
2392 const char* descriptor_to_kill;
2393 using DumpstateBoardTask = std::packaged_task<bool()>;
2394 DumpstateBoardTask dumpstate_board_task;
2395 dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode dumpstate_hal_mode =
2396 GetDumpstateHalModeAidl(bugreport_mode);
2397
2398 descriptor_to_kill = dumpstate_hal_aidl::IDumpstateDevice::descriptor;
2399 dumpstate_board_task = DumpstateBoardTask([dumpstate_hal, &dumpstate_fds, dumpstate_hal_mode,
2400 timeout_sec]() -> bool {
2401 auto status = dumpstate_hal->dumpstateBoard(dumpstate_fds, dumpstate_hal_mode, timeout_sec);
2402
2403 if (!status.isOk()) {
2404 MYLOGE("dumpstateBoard failed: %s\n", status.getDescription().c_str());
2405 return false;
2406 }
2407 return true;
2408 });
2409 auto result = dumpstate_board_task.get_future();
2410 std::thread(std::move(dumpstate_board_task)).detach();
2411
2412 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2413 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate HAL\n", timeout_sec);
2414 if (!android::base::SetProperty(
2415 "ctl.interface_restart",
2416 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
2417 MYLOGE("Couldn't restart dumpstate HAL\n");
2418 }
2419 }
2420 // Wait some time for init to kill dumpstate vendor HAL
2421 constexpr size_t killing_timeout_sec = 10;
2422 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2423 MYLOGE(
2424 "killing dumpstateBoard timed out after %zus, continue and "
2425 "there might be racing in content\n",
2426 killing_timeout_sec);
2427 }
2428}
2429
2430static std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> GetDumpstateBoardAidlService() {
2431 const std::string aidl_instance_name =
2432 std::string(dumpstate_hal_aidl::IDumpstateDevice::descriptor) + "/default";
2433
2434 if (!AServiceManager_isDeclared(aidl_instance_name.c_str())) {
2435 return nullptr;
2436 }
2437
2438 ndk::SpAIBinder dumpstateBinder(AServiceManager_waitForService(aidl_instance_name.c_str()));
2439
2440 return dumpstate_hal_aidl::IDumpstateDevice::fromBinder(dumpstateBinder);
2441}
2442
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002443void Dumpstate::DumpstateBoard(int out_fd) {
2444 dprintf(out_fd, "========================================================\n");
2445 dprintf(out_fd, "== Board\n");
2446 dprintf(out_fd, "========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08002447
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002448 /*
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002449 * mount debugfs for non-user builds with ro.product.debugfs_restrictions.enabled
Hridya Valsaraju51101602021-04-02 14:32:46 -07002450 * set to true and unmount it after invoking dumpstateBoard_* methods.
2451 * This is to enable debug builds to not have debugfs mounted during runtime.
2452 * It will also ensure that debugfs is only accessed by the dumpstate HAL.
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002453 */
Hridya Valsaraju51101602021-04-02 14:32:46 -07002454 auto mount_debugfs =
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002455 android::base::GetBoolProperty("ro.product.debugfs_restrictions.enabled", false);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002456 if (mount_debugfs) {
2457 RunCommand("mount debugfs", {"mount", "-t", "debugfs", "debugfs", "/sys/kernel/debug"},
2458 AS_ROOT_20);
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002459 RunCommand("chmod debugfs", {"chmod", "0755", "/sys/kernel/debug"}, AS_ROOT_20);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002460 }
2461
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002462 std::vector<std::string> paths;
2463 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07002464 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002465 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
2466 kDumpstateBoardFiles[i].c_str()));
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002467 remover.emplace_back(android::base::make_scope_guard(
2468 std::bind([](std::string path) { android::os::UnlinkAndLogOnError(path); }, paths[i])));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002469 }
Jie Song9fbfad02017-06-20 16:29:42 -07002470
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002471 // get dumpstate HAL AIDL implementation
2472 std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> dumpstate_hal_handle_aidl(
2473 GetDumpstateBoardAidlService());
2474 if (dumpstate_hal_handle_aidl == nullptr) {
2475 MYLOGI("No IDumpstateDevice AIDL implementation\n");
2476 }
2477
2478 // get dumpstate HAL HIDL implementation, only if AIDL HAL implementation not found
2479 sp<dumpstate_hal_hidl_1_0::IDumpstateDevice> dumpstate_hal_handle_hidl_1_0 = nullptr;
2480 if (dumpstate_hal_handle_aidl == nullptr) {
2481 dumpstate_hal_handle_hidl_1_0 = dumpstate_hal_hidl_1_0::IDumpstateDevice::getService();
2482 if (dumpstate_hal_handle_hidl_1_0 == nullptr) {
2483 MYLOGI("No IDumpstateDevice HIDL implementation\n");
2484 }
2485 }
2486
2487 // if neither HIDL nor AIDL implementation found, then return
2488 if (dumpstate_hal_handle_hidl_1_0 == nullptr && dumpstate_hal_handle_aidl == nullptr) {
2489 MYLOGE("Could not find IDumpstateDevice implementation\n");
Wei Wang587eac92018-04-05 12:17:20 -07002490 return;
2491 }
2492
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002493 // this is used to hold the file descriptors and when this variable goes out of scope
2494 // the file descriptors are closed
2495 std::vector<::ndk::ScopedFileDescriptor> dumpstate_fds;
Wei Wang587eac92018-04-05 12:17:20 -07002496
Nandana Dutt5c390032019-03-12 10:52:56 +00002497 // TODO(128270426): Check for consent in between?
Wei Wang587eac92018-04-05 12:17:20 -07002498 for (size_t i = 0; i < paths.size(); i++) {
2499 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
2500
2501 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
2502 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
2503 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
2504 if (fd < 0) {
2505 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
2506 return;
2507 }
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002508
2509 dumpstate_fds.emplace_back(fd.release());
2510 // we call fd.release() here to make sure "fd" does not get closed
2511 // after "fd" goes out of scope after this block.
2512 // "fd" will be closed when "dumpstate_fds" goes out of scope
2513 // i.e. when we exit this function
Wei Wang587eac92018-04-05 12:17:20 -07002514 }
2515
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002516 // Given that bugreport is required to diagnose failures, it's better to set an arbitrary amount
2517 // of timeout for IDumpstateDevice than to block the rest of bugreport. In the timeout case, we
2518 // will kill the HAL and grab whatever it dumped in time.
Michael Eastwood8523ea02022-03-10 16:33:08 -08002519 constexpr size_t timeout_sec = 45;
Wei Wang587eac92018-04-05 12:17:20 -07002520
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002521 if (dumpstate_hal_handle_aidl != nullptr) {
2522 DoDumpstateBoardAidl(dumpstate_hal_handle_aidl, dumpstate_fds, options_->bugreport_mode,
2523 timeout_sec);
2524 } else if (dumpstate_hal_handle_hidl_1_0 != nullptr) {
2525 // run HIDL HAL only if AIDL HAL not found
2526 DoDumpstateBoardHidl(dumpstate_hal_handle_hidl_1_0, dumpstate_fds, options_->bugreport_mode,
2527 timeout_sec);
Wei Wang587eac92018-04-05 12:17:20 -07002528 }
2529
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002530 if (mount_debugfs) {
Hridya Valsaraju51101602021-04-02 14:32:46 -07002531 auto keep_debugfs_mounted =
2532 android::base::GetProperty("persist.dbg.keep_debugfs_mounted", "");
2533 if (keep_debugfs_mounted.empty())
2534 RunCommand("unmount debugfs", {"umount", "/sys/kernel/debug"}, AS_ROOT_20);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002535 }
2536
Wei Wang587eac92018-04-05 12:17:20 -07002537 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
2538 for (size_t i = 0; i < paths.size(); i++) {
2539 struct stat s;
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002540 if (fstat(dumpstate_fds[i].get(), &s) == -1) {
2541 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(), strerror(errno));
Wei Wang587eac92018-04-05 12:17:20 -07002542 file_sizes[i] = -1;
2543 continue;
2544 }
2545 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002546 }
2547
2548 for (size_t i = 0; i < paths.size(); i++) {
2549 if (file_sizes[i] == -1) {
2550 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002551 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002552 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07002553 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002554 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002555 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002556 remover[i].Disable();
2557 EnqueueAddZipEntryAndCleanupIfNeeded(kDumpstateBoardFiles[i], paths[i]);
2558 dprintf(out_fd, "*** See %s entry ***\n", kDumpstateBoardFiles[i].c_str());
Jie Song9fbfad02017-06-20 16:29:42 -07002559 }
Felipe Leme6f674ae2016-11-18 17:10:33 -08002560}
2561
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002562static void ShowUsage() {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002563 fprintf(stderr,
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002564 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-o directory] [-p] "
2565 "[-s] [-S] [-q] [-P] [-R] [-L] [-V version]\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002566 " -h: display this help message\n"
2567 " -b: play sound file instead of vibrate, at beginning of job\n"
2568 " -e: play sound file instead of vibrate, at end of job\n"
mhasank2d75c442020-06-11 15:05:25 -07002569 " -o: write to custom directory (only in limited mode)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01002570 " -p: capture screenshot to filename.png\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002571 " -s: write zipped file to control socket (for init)\n"
2572 " -S: write file location to control socket (for init)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002573 " -q: disable vibrate\n"
Abhijeet Kaure370d682019-10-01 16:49:30 +01002574 " -P: send broadcast when started and do progress updates\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002575 " -R: take bugreport in remote mode (shouldn't be used with -P)\n"
Nandana Dutt235864b2019-01-22 12:10:16 +00002576 " -w: start binder service and make it wait for a call to startBugreport\n"
mhasankd451a472020-05-26 18:02:39 -07002577 " -L: output limited information that is safe for submission in feedback reports\n"
Felipe Lemed071c682016-10-20 16:48:00 -07002578 " -v: prints the dumpstate header and exit\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002579}
2580
Wei Liuf87959e2016-08-26 14:51:42 -07002581static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07002582 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07002583}
2584
Felipe Leme1d486fe2016-10-14 18:06:47 -07002585bool Dumpstate::FinishZipFile() {
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002586 // Runs all enqueued adding zip entry and cleanup tasks before finishing the zip file.
2587 if (zip_entry_tasks_) {
2588 zip_entry_tasks_->run(/* do_cancel = */false);
2589 }
2590
Felipe Leme9a523ae2016-10-20 15:10:33 -07002591 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07002592 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07002593 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002594 // Final timestamp
2595 char date[80];
2596 time_t the_real_now_please_stand_up = time(nullptr);
2597 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002598 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07002599 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002600
Felipe Leme9a523ae2016-10-20 15:10:33 -07002601 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002602 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08002603 return false;
2604 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07002605 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002606 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08002607 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08002608 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08002609
Felipe Leme0f3fb202016-06-10 17:10:53 -07002610 // Add log file (which contains stderr output) to zip...
2611 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07002612 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07002613 MYLOGE("Failed to add dumpstate log to .zip file\n");
2614 return false;
2615 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002616 // TODO: Should truncate the existing file.
2617 // ... and re-open it for further logging.
Nandana Dutta344cb62019-02-22 15:12:35 +00002618 if (!redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()))) {
2619 return false;
2620 }
Felipe Leme0f3fb202016-06-10 17:10:53 -07002621 fprintf(stderr, "\n");
2622
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002623 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07002624 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002625 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002626 return false;
2627 }
2628
Felipe Leme1d486fe2016-10-14 18:06:47 -07002629 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
2630 ds.zip_file.reset(nullptr);
2631
Felipe Lemee9d2c542016-11-15 11:48:26 -08002632 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002633 android::os::UnlinkAndLogOnError(tmp_path_);
Felipe Lemec4eee562016-04-21 15:42:55 -07002634
Felipe Leme1e9edc62015-12-21 16:02:13 -08002635 return true;
2636}
Felipe Leme6e01fa62015-11-11 19:35:14 -08002637
Nikhil Kumar28ce35e2023-01-10 14:32:44 +00002638static void SendBroadcast(const std::string& action,
2639 const std::vector<std::string>& args,
2640 int32_t user_id) {
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002641 // clang-format off
Nikhil Kumar28ce35e2023-01-10 14:32:44 +00002642 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user",
2643 std::to_string(user_id), "--receiver-foreground",
2644 "--receiver-include-background", "-a", action};
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002645 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08002646
2647 am.insert(am.end(), args.begin(), args.end());
2648
Felipe Leme8d2410e2017-02-08 09:46:08 -08002649 RunCommand("", am,
2650 CommandOptions::WithTimeout(20)
2651 .Log("Sending broadcast: '%s'\n")
2652 .Always()
2653 .DropRoot()
2654 .RedirectStderr()
2655 .Build());
2656}
2657
Felipe Leme35b8cf12017-02-10 15:47:29 -08002658static void Vibrate(int duration_ms) {
2659 // clang-format off
Lais Andrade51156962021-02-22 19:21:35 +00002660 std::vector<std::string> args = {"cmd", "vibrator_manager", "synced", "-f", "-d", "dumpstate",
2661 "oneshot", std::to_string(duration_ms)};
2662 RunCommand("", args,
Felipe Leme35b8cf12017-02-10 15:47:29 -08002663 CommandOptions::WithTimeout(10)
2664 .Log("Vibrate: '%s'\n")
2665 .Always()
2666 .Build());
2667 // clang-format on
2668}
2669
Nandana Dutt979388e2018-11-30 16:48:55 +00002670static void MaybeResolveSymlink(std::string* path) {
2671 std::string resolved_path;
2672 if (android::base::Readlink(*path, &resolved_path)) {
2673 *path = resolved_path;
2674 }
2675}
2676
Nandana Dutt4be45d12018-09-26 15:04:23 +01002677/*
2678 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002679 * and adds the version file. Return false if zip_file could not be open to write.
Nandana Dutt4be45d12018-09-26 15:04:23 +01002680 */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002681static bool PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002682 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
2683
Nandana Dutt4be45d12018-09-26 15:04:23 +01002684 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
2685 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002686 ds.base_name_ = StringPrintf("bugreport-%s-%s", device_name.c_str(), build_id.c_str());
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002687 char date[80];
2688 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
2689 ds.name_ = date;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002690
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002691 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002692 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002693 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002694 ds.base_name_ += "-wifi";
2695 }
2696
Paul Chang0d2aad72020-02-13 20:04:03 +08002697 if (ds.options_->do_screenshot) {
Nandana Dutt9d17b942020-03-26 10:02:59 +00002698 ds.screenshot_path_ = ds.GetPath(ds.CalledByApi() ? "-png.tmp" : ".png");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002699 }
2700 ds.tmp_path_ = ds.GetPath(".tmp");
2701 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
2702
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002703 std::string destination = ds.CalledByApi()
Nandana Dutt54dbd672019-01-11 12:58:05 +00002704 ? StringPrintf("[fd:%d]", ds.options_->bugreport_fd.get())
Nandana Dutt9a76d202019-01-21 15:56:48 +00002705 : ds.bugreport_internal_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01002706 MYLOGD(
Nandana Dutt235c6672019-11-14 15:22:32 +00002707 "Bugreport dir: [%s] "
2708 "Base name: [%s] "
2709 "Suffix: [%s] "
2710 "Log path: [%s] "
2711 "Temporary path: [%s] "
2712 "Screenshot path: [%s]\n",
Nandana Dutt9a76d202019-01-21 15:56:48 +00002713 destination.c_str(), ds.base_name_.c_str(), ds.name_.c_str(), ds.log_path_.c_str(),
2714 ds.tmp_path_.c_str(), ds.screenshot_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002715
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002716 ds.path_ = ds.GetPath(ds.CalledByApi() ? "-zip.tmp" : ".zip");
2717 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
2718 create_parent_dirs(ds.path_.c_str());
2719 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
2720 if (ds.zip_file == nullptr) {
2721 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
2722 return false;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002723 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002724 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
2725 ds.AddTextZipEntry("version.txt", ds.version_);
2726 return true;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002727}
2728
2729/*
Abhijeet Kaure370d682019-10-01 16:49:30 +01002730 * Finalizes writing to the file by zipping the tmp file to the final location,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002731 * printing zipped file status, etc.
2732 */
2733static void FinalizeFile() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002734 bool do_text_file = !ds.FinishZipFile();
2735 if (do_text_file) {
2736 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002737 }
mhasank2d75c442020-06-11 15:05:25 -07002738
2739 std::string final_path = ds.path_;
2740 if (ds.options_->OutputToCustomFile()) {
mhasank3a4cfb42020-06-15 18:06:43 -07002741 final_path = ds.GetPath(ds.options_->out_dir, ".zip");
mhasank2d75c442020-06-11 15:05:25 -07002742 android::os::CopyFileToFile(ds.path_, final_path);
2743 }
2744
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002745 if (ds.options_->stream_to_socket) {
2746 android::os::CopyFileToFd(ds.path_, ds.control_socket_fd_);
2747 } else if (ds.options_->progress_updates_to_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002748 if (do_text_file) {
2749 dprintf(ds.control_socket_fd_,
2750 "FAIL:could not create zip file, check %s "
2751 "for more details\n",
2752 ds.log_path_.c_str());
2753 } else {
mhasank2d75c442020-06-11 15:05:25 -07002754 dprintf(ds.control_socket_fd_, "OK:%s\n", final_path.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002755 }
2756 }
2757}
2758
Nandana Dutt4be45d12018-09-26 15:04:23 +01002759
Nandana Dutt58d72e22018-11-16 10:30:48 +00002760static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2761 switch (mode) {
2762 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2763 return "BUGREPORT_FULL";
2764 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2765 return "BUGREPORT_INTERACTIVE";
2766 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2767 return "BUGREPORT_REMOTE";
2768 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2769 return "BUGREPORT_WEAR";
2770 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2771 return "BUGREPORT_TELEPHONY";
2772 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2773 return "BUGREPORT_WIFI";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002774 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2775 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002776 }
2777}
2778
Steven Leeb573eb82022-11-29 22:31:35 +08002779static bool IsConsentlessBugreportAllowed(const Dumpstate::DumpOptions& options) {
2780 // only BUGREPORT_TELEPHONY does not allow using consentless bugreport
2781 return !options.telephony_only;
2782}
2783
Paul Changf59c2b72020-03-10 02:08:55 +08002784static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options,
2785 bool is_screenshot_requested) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002786 // Modify com.android.shell.BugreportProgressService#isDefaultScreenshotRequired as well for
2787 // default system screenshots.
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002788 options->bugreport_mode = mode;
2789 options->bugreport_mode_string = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002790 switch (mode) {
2791 case Dumpstate::BugreportMode::BUGREPORT_FULL:
Paul Changf59c2b72020-03-10 02:08:55 +08002792 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002793 break;
2794 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002795 // Currently, the dumpstate binder is only used by Shell to update progress.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002796 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002797 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002798 break;
2799 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002800 options->do_vibrate = false;
2801 options->is_remote_mode = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002802 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002803 break;
2804 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002805 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002806 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002807 break;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002808 // TODO(b/148168577) rename TELEPHONY everywhere to CONNECTIVITY.
Nandana Dutt58d72e22018-11-16 10:30:48 +00002809 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002810 options->telephony_only = true;
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002811 options->do_progress_updates = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002812 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002813 break;
2814 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002815 options->wifi_only = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002816 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002817 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002818 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2819 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002820 }
2821}
2822
Nandana Dutt58d72e22018-11-16 10:30:48 +00002823static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
Nandana Dutt235c6672019-11-14 15:22:32 +00002824 MYLOGI(
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002825 "do_vibrate: %d stream_to_socket: %d progress_updates_to_socket: %d do_screenshot: %d "
Rhed Jao25f50e02020-08-20 00:10:32 +08002826 "is_remote_mode: %d show_header_only: %d telephony_only: %d "
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002827 "wifi_only: %d do_progress_updates: %d fd: %d bugreport_mode: %s "
mhasankd451a472020-05-26 18:02:39 -07002828 "limited_only: %d args: %s\n",
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002829 options.do_vibrate, options.stream_to_socket, options.progress_updates_to_socket,
Paul Chang0d2aad72020-02-13 20:04:03 +08002830 options.do_screenshot, options.is_remote_mode, options.show_header_only,
Rhed Jao25f50e02020-08-20 00:10:32 +08002831 options.telephony_only, options.wifi_only,
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002832 options.do_progress_updates, options.bugreport_fd.get(),
2833 options.bugreport_mode_string.c_str(),
2834 options.limited_only, options.args.c_str());
Nandana Dutt58d72e22018-11-16 10:30:48 +00002835}
2836
Nandana Dutt54dbd672019-01-11 12:58:05 +00002837void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode,
Kean Mariotti306633e2022-09-05 16:30:47 +00002838 int bugreport_flags,
Nandana Dutt54dbd672019-01-11 12:58:05 +00002839 const android::base::unique_fd& bugreport_fd_in,
Paul Changf59c2b72020-03-10 02:08:55 +08002840 const android::base::unique_fd& screenshot_fd_in,
2841 bool is_screenshot_requested) {
Kean Mariotti306633e2022-09-05 16:30:47 +00002842 this->use_predumped_ui_data = bugreport_flags & BugreportFlag::BUGREPORT_USE_PREDUMPED_UI_DATA;
Gavin Corkerya44686c2022-11-23 18:16:51 +00002843 this->is_consent_deferred = bugreport_flags & BugreportFlag::BUGREPORT_FLAG_DEFER_CONSENT;
Nandana Dutt54dbd672019-01-11 12:58:05 +00002844 // Duplicate the fds because the passed in fds don't outlive the binder transaction.
Todd Frederick621533f2022-03-26 02:54:17 +00002845 bugreport_fd.reset(fcntl(bugreport_fd_in.get(), F_DUPFD_CLOEXEC, 0));
2846 screenshot_fd.reset(fcntl(screenshot_fd_in.get(), F_DUPFD_CLOEXEC, 0));
Nandana Dutt58d72e22018-11-16 10:30:48 +00002847
Paul Changf59c2b72020-03-10 02:08:55 +08002848 SetOptionsFromMode(bugreport_mode, this, is_screenshot_requested);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002849}
2850
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002851Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
2852 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002853 int c;
mhasankd451a472020-05-26 18:02:39 -07002854 while ((c = getopt(argc, argv, "dho:svqzpLPBRSV:w")) != -1) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002855 switch (c) {
2856 // clang-format off
mhasank3a4cfb42020-06-15 18:06:43 -07002857 case 'o': out_dir = optarg; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002858 case 's': stream_to_socket = true; break;
2859 case 'S': progress_updates_to_socket = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002860 case 'v': show_header_only = true; break;
2861 case 'q': do_vibrate = false; break;
Paul Chang0d2aad72020-02-13 20:04:03 +08002862 case 'p': do_screenshot = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002863 case 'P': do_progress_updates = true; break;
2864 case 'R': is_remote_mode = true; break;
mhasankd451a472020-05-26 18:02:39 -07002865 case 'L': limited_only = true; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002866 case 'V':
2867 case 'd':
2868 case 'z':
2869 // compatibility no-op
2870 break;
Nandana Dutt235864b2019-01-22 12:10:16 +00002871 case 'w':
2872 // This was already processed
2873 break;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002874 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002875 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002876 break;
2877 default:
2878 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002879 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002880 break;
2881 // clang-format on
2882 }
2883 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08002884
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002885 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002886 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002887 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002888 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002889 }
2890 }
2891
2892 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
2893 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002894
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002895 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002896}
2897
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002898bool Dumpstate::DumpOptions::ValidateOptions() const {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002899 if (bugreport_fd.get() != -1 && stream_to_socket) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002900 return false;
2901 }
2902
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002903 if ((progress_updates_to_socket || do_progress_updates) && stream_to_socket) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002904 return false;
2905 }
2906
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002907 if (is_remote_mode && (do_progress_updates || stream_to_socket)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002908 return false;
2909 }
2910 return true;
2911}
2912
Nandana Dutt197661d2018-11-16 16:40:21 +00002913void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
2914 options_ = std::move(options);
2915}
2916
Abhijeet Kaura407fb82020-03-27 12:51:12 +00002917void Dumpstate::Initialize() {
2918 /* gets the sequential id */
2919 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
2920 id_ = ++last_id;
2921 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
2922}
2923
Nandana Duttd2f5f082019-01-18 17:13:52 +00002924Dumpstate::RunStatus Dumpstate::Run(int32_t calling_uid, const std::string& calling_package) {
2925 Dumpstate::RunStatus status = RunInternal(calling_uid, calling_package);
Gavin Corkerya44686c2022-11-23 18:16:51 +00002926 HandleRunStatus(status);
2927 return status;
2928}
2929
2930Dumpstate::RunStatus Dumpstate::Retrieve(int32_t calling_uid, const std::string& calling_package) {
2931 Dumpstate::RunStatus status = RetrieveInternal(calling_uid, calling_package);
2932 HandleRunStatus(status);
2933 return status;
2934}
2935
2936Dumpstate::RunStatus Dumpstate::RetrieveInternal(int32_t calling_uid,
2937 const std::string& calling_package) {
2938 consent_callback_ = new ConsentCallback();
2939 const String16 incidentcompanion("incidentcompanion");
2940 sp<android::IBinder> ics(
2941 defaultServiceManager()->checkService(incidentcompanion));
2942 android::String16 package(calling_package.c_str());
2943 if (ics != nullptr) {
2944 MYLOGD("Checking user consent via incidentcompanion service\n");
2945 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
2946 calling_uid, package, String16(), String16(),
2947 0x1 /* FLAG_CONFIRMATION_DIALOG */, consent_callback_.get());
2948 } else {
2949 MYLOGD(
2950 "Unable to check user consent; incidentcompanion service unavailable\n");
2951 return RunStatus::USER_CONSENT_TIMED_OUT;
2952 }
2953 UserConsentResult consent_result = consent_callback_->getResult();
2954 int timeout_ms = 30 * 1000;
2955 while (consent_result == UserConsentResult::UNAVAILABLE &&
2956 consent_callback_->getElapsedTimeMs() < timeout_ms) {
2957 sleep(1);
2958 consent_result = consent_callback_->getResult();
2959 }
2960 if (consent_result == UserConsentResult::DENIED) {
2961 return RunStatus::USER_CONSENT_DENIED;
2962 }
2963 if (consent_result == UserConsentResult::UNAVAILABLE) {
2964 MYLOGD("Canceling user consent request via incidentcompanion service\n");
2965 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
2966 consent_callback_.get());
2967 return RunStatus::USER_CONSENT_TIMED_OUT;
2968 }
2969
2970 bool copy_succeeded =
2971 android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
2972 if (copy_succeeded) {
2973 android::os::UnlinkAndLogOnError(path_);
2974 }
2975 return copy_succeeded ? Dumpstate::RunStatus::OK
2976 : Dumpstate::RunStatus::ERROR;
2977}
2978
2979void Dumpstate::HandleRunStatus(Dumpstate::RunStatus status) {
2980 if (listener_ != nullptr) {
Nandana Duttbabf6c72019-01-15 14:11:12 +00002981 switch (status) {
2982 case Dumpstate::RunStatus::OK:
Gavin Corkerya44686c2022-11-23 18:16:51 +00002983 listener_->onFinished(path_.c_str());
Nandana Duttbabf6c72019-01-15 14:11:12 +00002984 break;
2985 case Dumpstate::RunStatus::HELP:
2986 break;
2987 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002988 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_INVALID_INPUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002989 break;
2990 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002991 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_RUNTIME_ERROR);
2992 break;
2993 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2994 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_DENIED_CONSENT);
2995 break;
2996 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
2997 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_CONSENT_TIMED_OUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002998 break;
2999 }
3000 }
Nandana Duttbabf6c72019-01-15 14:11:12 +00003001}
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003002void Dumpstate::Cancel() {
3003 CleanupTmpFiles();
3004 android::os::UnlinkAndLogOnError(log_path_);
3005 for (int i = 0; i < NUM_OF_DUMPS; i++) {
3006 android::os::UnlinkAndLogOnError(ds.bugreport_internal_dir_ + "/" +
3007 kDumpstateBoardFiles[i]);
3008 }
3009 tombstone_data_.clear();
3010 anr_data_.clear();
Woody Lin20767a92022-11-29 15:50:24 +08003011 shutdown_checkpoints_.clear();
Rhed Jao0daac912020-08-21 14:48:20 +08003012
3013 // Instead of shutdown the pool, we delete temporary files directly since
3014 // shutdown blocking the call.
3015 if (dump_pool_) {
3016 dump_pool_->deleteTempFiles();
3017 }
3018 if (zip_entry_tasks_) {
3019 zip_entry_tasks_->run(/*do_cancel =*/ true);
3020 }
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003021}
3022
Kean Mariotti306633e2022-09-05 16:30:47 +00003023void Dumpstate::PreDumpUiData() {
3024 MaybeSnapshotUiTraces();
3025}
3026
Nandana Dutt979388e2018-11-30 16:48:55 +00003027/*
3028 * Dumps relevant information to a bugreport based on the given options.
3029 *
3030 * The bugreport can be dumped to a file or streamed to a socket.
3031 *
3032 * How dumping to file works:
3033 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
3034 * stderr is redirected a log file.
3035 *
3036 * The temporary bugreport is then populated via printfs, dumping contents of files and
3037 * output of commands to stdout.
3038 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003039 * A bunch of other files and dumps are added to the zip archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00003040 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003041 * The temporary bugreport file and the log file also get added to the archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00003042 *
mhasank2d75c442020-06-11 15:05:25 -07003043 * Bugreports are first generated in a local directory and later copied to the caller's fd
3044 * or directory if supplied.
Nandana Dutt979388e2018-11-30 16:48:55 +00003045 */
Nandana Duttd2f5f082019-01-18 17:13:52 +00003046Dumpstate::RunStatus Dumpstate::RunInternal(int32_t calling_uid,
3047 const std::string& calling_package) {
Rhed Jao5377d792020-07-16 17:37:39 +08003048 DurationReporter duration_reporter("RUN INTERNAL", /* logcat_only = */true);
Nandana Dutt979388e2018-11-30 16:48:55 +00003049 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00003050 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00003051 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003052 return RunStatus::INVALID_INPUT;
3053 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003054 /* set as high priority, and protect from OOM killer */
3055 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07003056
Felipe Lemed071c682016-10-20 16:48:00 -07003057 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07003058 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07003059 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07003060 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07003061 } else {
3062 /* fallback to kernels <= 2.6.35 */
3063 oom_adj = fopen("/proc/self/oom_adj", "we");
3064 if (oom_adj) {
3065 fputs("-17", oom_adj);
3066 fclose(oom_adj);
3067 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003068 }
3069
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003070 if (version_ == VERSION_DEFAULT) {
3071 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00003072 }
3073
Chris Morin5a50d482022-02-01 17:41:18 -08003074 if (version_ != VERSION_CURRENT) {
3075 MYLOGE("invalid version requested ('%s'); supported values are: ('%s', '%s')\n",
3076 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003077 return RunStatus::INVALID_INPUT;
Felipe Lemed071c682016-10-20 16:48:00 -07003078 }
3079
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003080 if (options_->show_header_only) {
3081 PrintHeader();
3082 return RunStatus::OK;
Felipe Lemed071c682016-10-20 16:48:00 -07003083 }
3084
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003085 MYLOGD("dumpstate calling_uid = %d ; calling package = %s \n",
3086 calling_uid, calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003087
Felipe Leme7447d7c2016-11-03 18:12:22 -07003088 // TODO: temporarily set progress until it's part of the Dumpstate constructor
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003089 std::string stats_path =
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003090 android::base::StringPrintf("%s/dumpstate-stats.txt", bugreport_internal_dir_.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003091 progress_.reset(new Progress(stats_path));
Felipe Leme7447d7c2016-11-03 18:12:22 -07003092
Sahana Raof35ed432019-07-12 10:47:52 +01003093 if (acquire_wake_lock(PARTIAL_WAKE_LOCK, WAKE_LOCK_NAME) < 0) {
3094 MYLOGE("Failed to acquire wake lock: %s\n", strerror(errno));
3095 } else {
3096 // Wake lock will be released automatically on process death
3097 MYLOGD("Wake lock acquired.\n");
3098 }
3099
Felipe Leme6ae5c4f2017-01-10 14:13:22 -08003100 register_sig_handler();
Felipe Lemed071c682016-10-20 16:48:00 -07003101
Felipe Lemef0292972016-11-22 13:57:05 -08003102 if (PropertiesHelper::IsDryRun()) {
Felipe Lemed071c682016-10-20 16:48:00 -07003103 MYLOGI("Running on dry-run mode (to disable it, call 'setprop dumpstate.dry_run false')\n");
3104 }
3105
Nandana Dutt235c6672019-11-14 15:22:32 +00003106 MYLOGI("dumpstate info: id=%d, args='%s', bugreport_mode= %s bugreport format version: %s\n",
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00003107 id_, options_->args.c_str(), options_->bugreport_mode_string.c_str(), version_.c_str());
Felipe Leme809d74e2016-02-02 12:57:00 -08003108
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003109 do_early_screenshot_ = options_->do_progress_updates;
Felipe Lemee338bf62015-12-07 14:03:50 -08003110
Christopher Ferrised9354f2014-10-01 17:35:01 -07003111 // If we are going to use a socket, do it as early as possible
3112 // to avoid timeouts from bugreport.
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003113 if (options_->stream_to_socket || options_->progress_updates_to_socket) {
Felipe Leme2628e9e2016-04-12 16:36:51 -07003114 MYLOGD("Opening control socket\n");
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003115 control_socket_fd_ = open_socket_fn_("dumpstate");
Nandana Dutta344cb62019-02-22 15:12:35 +00003116 if (control_socket_fd_ == -1) {
3117 return ERROR;
3118 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003119 if (options_->progress_updates_to_socket) {
3120 options_->do_progress_updates = 1;
3121 }
Felipe Leme2628e9e2016-04-12 16:36:51 -07003122 }
3123
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003124 if (!PrepareToWriteToFile()) {
3125 return ERROR;
3126 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08003127
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003128 // Interactive, wear & telephony modes are default to true.
3129 // and may enable from cli option or when using control socket
3130 if (options_->do_progress_updates) {
3131 // clang-format off
3132 std::vector<std::string> am_args = {
3133 "--receiver-permission", "android.permission.DUMP",
3134 };
3135 // clang-format on
3136 // Send STARTED broadcast for apps that listen to bugreport generation events
Nikhil Kumar28ce35e2023-01-10 14:32:44 +00003137 SendBroadcast("com.android.internal.intent.action.BUGREPORT_STARTED",
3138 am_args, multiuser_get_user_id(calling_uid));
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003139 if (options_->progress_updates_to_socket) {
3140 dprintf(control_socket_fd_, "BEGIN:%s\n", path_.c_str());
Felipe Leme71bbfc52015-11-23 14:14:51 -08003141 }
3142 }
3143
Nick Kralevichf3599b32016-01-25 15:05:16 -08003144 /* read /proc/cmdline before dropping root */
3145 FILE *cmdline = fopen("/proc/cmdline", "re");
3146 if (cmdline) {
3147 fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
3148 fclose(cmdline);
3149 }
3150
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003151 if (options_->do_vibrate) {
Felipe Leme35b8cf12017-02-10 15:47:29 -08003152 Vibrate(150);
John Michelau1f794c42012-09-17 11:20:19 -05003153 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003154
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003155 if (zip_file != nullptr) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003156 if (chown(path_.c_str(), AID_SHELL, AID_SHELL)) {
3157 MYLOGE("Unable to change ownership of zip file %s: %s\n", path_.c_str(),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003158 strerror(errno));
Felipe Leme1e9edc62015-12-21 16:02:13 -08003159 }
3160 }
3161
Nandana Dutt3f8c7172018-09-25 12:01:54 +01003162 int dup_stdout_fd;
3163 int dup_stderr_fd;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003164 // Redirect stderr to log_path_ for debugging.
3165 TEMP_FAILURE_RETRY(dup_stderr_fd = dup(fileno(stderr)));
3166 if (!redirect_to_file(stderr, const_cast<char*>(log_path_.c_str()))) {
3167 return ERROR;
3168 }
3169 if (chown(log_path_.c_str(), AID_SHELL, AID_SHELL)) {
3170 MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n", log_path_.c_str(),
3171 strerror(errno));
3172 }
Nandana Dutt979388e2018-11-30 16:48:55 +00003173
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003174 // Redirect stdout to tmp_path_. This is the main bugreport entry and will be
3175 // moved into zip file later, if zipping.
3176 TEMP_FAILURE_RETRY(dup_stdout_fd = dup(fileno(stdout)));
3177 // TODO: why not write to a file instead of stdout to overcome this problem?
3178 /* TODO: rather than generating a text file now and zipping it later,
3179 it would be more efficient to redirect stdout to the zip entry
3180 directly, but the libziparchive doesn't support that option yet. */
3181 if (!redirect_to_file(stdout, const_cast<char*>(tmp_path_.c_str()))) {
3182 return ERROR;
3183 }
3184 if (chown(tmp_path_.c_str(), AID_SHELL, AID_SHELL)) {
3185 MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
3186 tmp_path_.c_str(), strerror(errno));
Colin Crossf45fa6b2012-03-26 12:38:26 -07003187 }
Felipe Lemed8b94e52016-12-08 10:21:44 -08003188
3189 // Don't buffer stdout
3190 setvbuf(stdout, nullptr, _IONBF, 0);
3191
Rhed Jao5377d792020-07-16 17:37:39 +08003192 // Enable the parallel run if the client requests to output to a file.
3193 EnableParallelRunIfNeeded();
3194 // Using scope guard to make sure the dump pool can be shut down correctly.
3195 auto scope_guard_to_shutdown_pool = android::base::make_scope_guard([=]() {
3196 ShutdownDumpPool();
3197 });
3198
Felipe Leme608385d2016-02-01 10:35:38 -08003199 // NOTE: there should be no stdout output until now, otherwise it would break the header.
3200 // In particular, DurationReport objects should be created passing 'title, NULL', so their
Felipe Lemecbce55d2016-02-08 09:53:18 -08003201 // duration is logged into MYLOG instead.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003202 PrintHeader();
Colin Crossf45fa6b2012-03-26 12:38:26 -07003203
Gavin Corkery6968f552020-11-22 18:09:05 +00003204 bool is_dumpstate_restricted = options_->telephony_only
3205 || options_->wifi_only
3206 || options_->limited_only;
3207 if (!is_dumpstate_restricted) {
Paul Chang0d2aad72020-02-13 20:04:03 +08003208 // Invoke critical dumpsys first to preserve system state, before doing anything else.
Jichao Lie89d9c12019-11-21 19:02:51 -08003209 RunDumpsysCritical();
Gavin Corkery6968f552020-11-22 18:09:05 +00003210 }
3211 MaybeTakeEarlyScreenshot();
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003212
3213 if (!is_dumpstate_restricted) {
3214 // Snapshot the system trace now (if running) to avoid that dumpstate's
3215 // own activity pushes out interesting data from the trace ring buffer.
3216 // The trace file is added to the zip by MaybeAddSystemTraceToZip().
3217 MaybeSnapshotSystemTrace();
Yohei Yukawa95305b32021-03-09 07:54:27 -08003218
Kean Mariotti306633e2022-09-05 16:30:47 +00003219 // Snapshot the UI traces now (if running).
3220 // The trace files will be added to bugreport later.
3221 MaybeSnapshotUiTraces();
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003222 }
Gavin Corkery6968f552020-11-22 18:09:05 +00003223 onUiIntensiveBugreportDumpsFinished(calling_uid);
3224 MaybeCheckUserConsent(calling_uid, calling_package);
3225 if (options_->telephony_only) {
3226 DumpstateTelephonyOnly(calling_package);
3227 } else if (options_->wifi_only) {
3228 DumpstateWifiOnly();
3229 } else if (options_->limited_only) {
3230 DumpstateLimitedOnly();
3231 } else {
Nandana Dutt4be45d12018-09-26 15:04:23 +01003232 // Dump state for the default case. This also drops root.
Jichao Lie89d9c12019-11-21 19:02:51 -08003233 RunStatus s = DumpstateDefaultAfterCritical();
Nandana Dutt5c390032019-03-12 10:52:56 +00003234 if (s != RunStatus::OK) {
Nandana Duttaac6f582019-07-26 14:32:47 +01003235 if (s == RunStatus::USER_CONSENT_DENIED) {
Nandana Dutt5c390032019-03-12 10:52:56 +00003236 HandleUserConsentDenied();
3237 }
3238 return s;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08003239 }
Zhengyin Qian068ecc72016-08-10 16:48:14 -07003240 }
Felipe Leme71a74ac2016-03-17 15:43:25 -07003241
Felipe Leme55b42a62015-11-10 17:39:08 -08003242 /* close output if needed */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003243 TEMP_FAILURE_RETRY(dup2(dup_stdout_fd, fileno(stdout)));
Colin Crossf45fa6b2012-03-26 12:38:26 -07003244
Abhijeet Kaure370d682019-10-01 16:49:30 +01003245 // Zip the (now complete) .tmp file within the internal directory.
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003246 ATRACE_BEGIN("FinalizeFile");
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003247 FinalizeFile();
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003248 ATRACE_END();
Colin Crossf45fa6b2012-03-26 12:38:26 -07003249
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003250 // Share the final file with the caller if the user has consented or Shell is the caller.
Nandana Duttd2f5f082019-01-18 17:13:52 +00003251 Dumpstate::RunStatus status = Dumpstate::RunStatus::OK;
Gavin Corkerya44686c2022-11-23 18:16:51 +00003252 if (CalledByApi() && !options_->is_consent_deferred) {
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003253 status = CopyBugreportIfUserConsented(calling_uid);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003254 if (status != Dumpstate::RunStatus::OK &&
3255 status != Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
3256 // Do an early return if there were errors. We make an exception for consent
3257 // timing out because it's possible the user got distracted. In this case the
3258 // bugreport is not shared but made available for manual retrieval.
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003259 MYLOGI("User denied consent. Returning\n");
Nandana Duttd2f5f082019-01-18 17:13:52 +00003260 return status;
3261 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003262 if (status == Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
3263 MYLOGI(
3264 "Did not receive user consent yet."
3265 " Will not copy the bugreport artifacts to caller.\n");
Abhijeet Kaur57627412019-04-17 16:00:09 +01003266 const String16 incidentcompanion("incidentcompanion");
3267 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
3268 if (ics != nullptr) {
3269 MYLOGD("Canceling user consent request via incidentcompanion service\n");
3270 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
3271 consent_callback_.get());
3272 } else {
3273 MYLOGD("Unable to cancel user consent; incidentcompanion service unavailable\n");
3274 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003275 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003276 }
3277
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08003278 /* vibrate a few but shortly times to let user know it's finished */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003279 if (options_->do_vibrate) {
Takuya Ogawa47f644e2017-12-20 18:09:09 +09003280 for (int i = 0; i < 3; i++) {
3281 Vibrate(75);
3282 usleep((75 + 50) * 1000);
3283 }
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08003284 }
3285
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003286 MYLOGD("Final progress: %d/%d (estimated %d)\n", progress_->Get(), progress_->GetMax(),
3287 progress_->GetInitialMax());
3288 progress_->Save();
3289 MYLOGI("done (id %d)\n", id_);
Colin Crossf45fa6b2012-03-26 12:38:26 -07003290
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003291 TEMP_FAILURE_RETRY(dup2(dup_stderr_fd, fileno(stderr)));
Felipe Leme107a05f2016-03-08 15:11:15 -08003292
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003293 if (control_socket_fd_ != -1) {
Felipe Lemee844a9d2016-09-21 15:01:39 -07003294 MYLOGD("Closing control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003295 close(control_socket_fd_);
Felipe Leme2628e9e2016-04-12 16:36:51 -07003296 }
3297
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003298 tombstone_data_.clear();
3299 anr_data_.clear();
Woody Lin20767a92022-11-29 15:50:24 +08003300 shutdown_checkpoints_.clear();
Narayan Kamath6b9516c2017-10-27 11:15:51 +01003301
Nandana Duttd2f5f082019-01-18 17:13:52 +00003302 return (consent_callback_ != nullptr &&
3303 consent_callback_->getResult() == UserConsentResult::UNAVAILABLE)
3304 ? USER_CONSENT_TIMED_OUT
3305 : RunStatus::OK;
3306}
3307
Paul Chang0d2aad72020-02-13 20:04:03 +08003308void Dumpstate::MaybeTakeEarlyScreenshot() {
3309 if (!options_->do_screenshot || !do_early_screenshot_) {
3310 return;
3311 }
3312
3313 TakeScreenshot();
3314}
3315
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003316void Dumpstate::MaybeSnapshotSystemTrace() {
3317 // If a background system trace is happening and is marked as "suitable for
3318 // bugreport" (i.e. bugreport_score > 0 in the trace config), this command
3319 // will stop it and serialize into SYSTEM_TRACE_SNAPSHOT. In the (likely)
3320 // case that no trace is ongoing, this command is a no-op.
3321 // Note: this should not be enqueued as we need to freeze the trace before
3322 // dumpstate starts. Otherwise the trace ring buffers will contain mostly
3323 // the dumpstate's own activity which is irrelevant.
3324 int res = RunCommand(
3325 "SERIALIZE PERFETTO TRACE",
3326 {"perfetto", "--save-for-bugreport"},
3327 CommandOptions::WithTimeout(10)
3328 .DropRoot()
3329 .CloseAllFileDescriptorsOnExec()
3330 .Build());
3331 has_system_trace_ = res == 0;
3332 // MaybeAddSystemTraceToZip() will take care of copying the trace in the zip
3333 // file in the later stages.
3334}
3335
Kean Mariotti306633e2022-09-05 16:30:47 +00003336void Dumpstate::MaybeSnapshotUiTraces() {
3337 if (PropertiesHelper::IsUserBuild() || options_->use_predumped_ui_data) {
3338 return;
3339 }
3340
Hongwei Wang39229132023-01-24 15:09:59 -08003341 // Include the proto logging from WMShell.
3342 RunCommand(
3343 // Empty name because it's not intended to be classified as a bugreport section.
3344 // Actual logging files can be found as "/data/misc/wmtrace/shell_log.winscope"
3345 // in the bugreport.
3346 "", {"dumpsys", "activity", "service", "SystemUIService",
3347 "WMShell", "protolog", "save-for-bugreport"},
3348 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3349
Yohei Yukawa02b1d2c2021-03-16 09:20:30 -07003350 // Currently WindowManagerService and InputMethodManagerSerivice support WinScope protocol.
Kean Mariotti306633e2022-09-05 16:30:47 +00003351 for (const auto& service : {"input_method", "window"}) {
Yohei Yukawa02b1d2c2021-03-16 09:20:30 -07003352 RunCommand(
3353 // Empty name because it's not intended to be classified as a bugreport section.
3354 // Actual tracing files can be found in "/data/misc/wmtrace/" in the bugreport.
3355 "", {"cmd", service, "tracing", "save-for-bugreport"},
3356 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3357 }
Kean Mariotti306633e2022-09-05 16:30:47 +00003358
3359 static const auto SURFACEFLINGER_COMMAND_SAVE_ALL_TRACES = std::vector<std::string> {
3360 "service", "call", "SurfaceFlinger", "1042"
3361 };
3362 // Empty name because it's not intended to be classified as a bugreport section.
3363 // Actual tracing files can be found in "/data/misc/wmtrace/" in the bugreport.
3364 RunCommand(
3365 "", SURFACEFLINGER_COMMAND_SAVE_ALL_TRACES,
3366 CommandOptions::WithTimeout(10).Always().AsRoot().RedirectStderr().Build());
3367}
3368
3369void Dumpstate::MaybePostProcessUiTraces() {
3370 if (PropertiesHelper::IsUserBuild()) {
3371 return;
3372 }
3373
3374 RunCommand(
3375 // Empty name because it's not intended to be classified as a bugreport section.
3376 // Actual tracing files can be found in "/data/misc/wmtrace/" in the bugreport.
3377 "", {
3378 "/system/xbin/su", "system",
3379 "/system/bin/layertracegenerator",
3380 "/data/misc/wmtrace/transactions_trace.winscope",
3381 "/data/misc/wmtrace/layers_trace_from_transactions.winscope"
3382 },
3383 CommandOptions::WithTimeout(120).Always().RedirectStderr().Build());
3384}
3385
3386void Dumpstate::MaybeAddUiTracesToZip() {
3387 if (PropertiesHelper::IsUserBuild()) {
3388 return;
3389 }
3390
3391 ds.AddDir(WMTRACE_DATA_DIR, false);
Yohei Yukawa95305b32021-03-09 07:54:27 -08003392}
3393
Paul Changeb4b4642020-05-28 22:05:47 +08003394void Dumpstate::onUiIntensiveBugreportDumpsFinished(int32_t calling_uid) {
Nikhil Kumar28ce35e2023-01-10 14:32:44 +00003395 if (multiuser_get_app_id(calling_uid) == AID_SHELL || !CalledByApi()) {
Paul Changc490e662020-04-11 18:14:09 +08003396 return;
3397 }
3398 if (listener_ != nullptr) {
3399 // Let listener know ui intensive bugreport dumps are finished, then it can do event
3400 // handling if required.
Paul Changeb4b4642020-05-28 22:05:47 +08003401 listener_->onUiIntensiveBugreportDumpsFinished();
Paul Changc490e662020-04-11 18:14:09 +08003402 }
3403}
3404
Jichao Lie89d9c12019-11-21 19:02:51 -08003405void Dumpstate::MaybeCheckUserConsent(int32_t calling_uid, const std::string& calling_package) {
Gavin Corkerya44686c2022-11-23 18:16:51 +00003406 if (multiuser_get_app_id(calling_uid) == AID_SHELL ||
3407 !CalledByApi() || options_->is_consent_deferred) {
3408 // No need to get consent for shell triggered dumpstates, or not
3409 // through bugreporting API (i.e. no fd to copy back), or when consent
3410 // is deferred.
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003411 return;
3412 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003413 consent_callback_ = new ConsentCallback();
3414 const String16 incidentcompanion("incidentcompanion");
3415 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
Jichao Lie89d9c12019-11-21 19:02:51 -08003416 android::String16 package(calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003417 if (ics != nullptr) {
3418 MYLOGD("Checking user consent via incidentcompanion service\n");
Steven Leeb573eb82022-11-29 22:31:35 +08003419 int flags = 0x1; // IncidentManager.FLAG_CONFIRMATION_DIALOG
3420 if (IsConsentlessBugreportAllowed(*options_)) {
3421 flags |= 0x2; // IncidentManager.FLAG_ALLOW_CONSENTLESS_BUGREPORT
3422 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003423 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
Steven Leeb573eb82022-11-29 22:31:35 +08003424 calling_uid, package, String16(), String16(), flags, consent_callback_.get());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003425 } else {
3426 MYLOGD("Unable to check user consent; incidentcompanion service unavailable\n");
3427 }
3428}
3429
Nandana Dutt5c390032019-03-12 10:52:56 +00003430bool Dumpstate::IsUserConsentDenied() const {
3431 return ds.consent_callback_ != nullptr &&
3432 ds.consent_callback_->getResult() == UserConsentResult::DENIED;
3433}
3434
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01003435bool Dumpstate::CalledByApi() const {
3436 return ds.options_->bugreport_fd.get() != -1 ? true : false;
3437}
3438
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003439void Dumpstate::CleanupTmpFiles() {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003440 android::os::UnlinkAndLogOnError(tmp_path_);
3441 android::os::UnlinkAndLogOnError(screenshot_path_);
3442 android::os::UnlinkAndLogOnError(path_);
Gavin Corkery789d7a52021-02-24 23:52:35 +00003443 if (dump_traces_path != nullptr) {
3444 android::os::UnlinkAndLogOnError(dump_traces_path);
3445 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003446}
3447
Rhed Jao5377d792020-07-16 17:37:39 +08003448void Dumpstate::EnableParallelRunIfNeeded() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003449 if (!PropertiesHelper::IsParallelRun()) {
Rhed Jao5377d792020-07-16 17:37:39 +08003450 return;
3451 }
3452 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003453 zip_entry_tasks_ = std::make_unique<TaskQueue>();
Rhed Jao5377d792020-07-16 17:37:39 +08003454}
3455
3456void Dumpstate::ShutdownDumpPool() {
3457 if (dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08003458 dump_pool_.reset();
Rhed Jao5377d792020-07-16 17:37:39 +08003459 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003460 if (zip_entry_tasks_) {
3461 zip_entry_tasks_->run(/* do_cancel = */true);
3462 zip_entry_tasks_ = nullptr;
3463 }
3464}
3465
3466void Dumpstate::EnqueueAddZipEntryAndCleanupIfNeeded(const std::string& entry_name,
3467 const std::string& entry_path) {
3468 auto func_add_zip_entry_and_cleanup = [=](bool task_cancelled) {
3469 if (!task_cancelled) {
3470 AddZipEntry(entry_name, entry_path);
3471 }
3472 android::os::UnlinkAndLogOnError(entry_path);
3473 };
3474 if (zip_entry_tasks_) {
3475 // Enqueues AddZipEntryAndCleanup function if the parallel run is enabled.
3476 zip_entry_tasks_->add(func_add_zip_entry_and_cleanup, _1);
3477 } else {
3478 // Invokes AddZipEntryAndCleanup immediately
3479 std::invoke(func_add_zip_entry_and_cleanup, /* task_cancelled = */false);
3480 }
Rhed Jao5377d792020-07-16 17:37:39 +08003481}
3482
Nandana Duttd2f5f082019-01-18 17:13:52 +00003483Dumpstate::RunStatus Dumpstate::HandleUserConsentDenied() {
3484 MYLOGD("User denied consent; deleting files and returning\n");
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003485 CleanupTmpFiles();
Nandana Duttd2f5f082019-01-18 17:13:52 +00003486 return USER_CONSENT_DENIED;
3487}
3488
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003489Dumpstate::RunStatus Dumpstate::CopyBugreportIfUserConsented(int32_t calling_uid) {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003490 // If the caller has asked to copy the bugreport over to their directory, we need explicit
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003491 // user consent (unless the caller is Shell).
3492 UserConsentResult consent_result;
Nikhil Kumar28ce35e2023-01-10 14:32:44 +00003493 if (multiuser_get_app_id(calling_uid) == AID_SHELL) {
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003494 consent_result = UserConsentResult::APPROVED;
3495 } else {
3496 consent_result = consent_callback_->getResult();
3497 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003498 if (consent_result == UserConsentResult::UNAVAILABLE) {
3499 // User has not responded yet.
3500 uint64_t elapsed_ms = consent_callback_->getElapsedTimeMs();
Hunter Knepshield70610fa2020-01-03 15:27:33 -08003501 // Telephony is a fast report type, particularly on user builds where information may be
3502 // more aggressively limited. To give the user time to read the consent dialog, increase the
3503 // timeout.
3504 uint64_t timeout_ms = options_->telephony_only ? TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS
3505 : USER_CONSENT_TIMEOUT_MS;
3506 if (elapsed_ms < timeout_ms) {
3507 uint delay_seconds = (timeout_ms - elapsed_ms) / 1000;
Nandana Duttd2f5f082019-01-18 17:13:52 +00003508 MYLOGD("Did not receive user consent yet; going to wait for %d seconds", delay_seconds);
3509 sleep(delay_seconds);
3510 }
3511 consent_result = consent_callback_->getResult();
3512 }
3513 if (consent_result == UserConsentResult::DENIED) {
3514 // User has explicitly denied sharing with the app. To be safe delete the
3515 // internal bugreport & tmp files.
3516 return HandleUserConsentDenied();
3517 }
3518 if (consent_result == UserConsentResult::APPROVED) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00003519 bool copy_succeeded = android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
3520 if (copy_succeeded) {
3521 android::os::UnlinkAndLogOnError(path_);
Abhijeet Kaur9ce94672020-04-01 17:22:36 +01003522 if (options_->do_screenshot &&
3523 options_->screenshot_fd.get() != -1 &&
3524 !options_->is_screenshot_copied) {
3525 copy_succeeded = android::os::CopyFileToFd(screenshot_path_,
3526 options_->screenshot_fd.get());
3527 options_->is_screenshot_copied = copy_succeeded;
3528 if (copy_succeeded) {
3529 android::os::UnlinkAndLogOnError(screenshot_path_);
3530 }
3531 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003532 }
3533 return copy_succeeded ? Dumpstate::RunStatus::OK : Dumpstate::RunStatus::ERROR;
3534 } else if (consent_result == UserConsentResult::UNAVAILABLE) {
3535 // consent_result is still UNAVAILABLE. The user has likely not responded yet.
3536 // Since we do not have user consent to share the bugreport it does not get
3537 // copied over to the calling app but remains in the internal directory from
3538 // where the user can manually pull it.
Paul Changce644212021-05-11 16:06:45 +08003539 std::string final_path = GetPath(".zip");
3540 bool copy_succeeded = android::os::CopyFileToFile(path_, final_path);
3541 if (copy_succeeded) {
3542 android::os::UnlinkAndLogOnError(path_);
3543 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003544 return Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT;
3545 }
3546 // Unknown result; must be a programming error.
3547 MYLOGE("Unknown user consent result:%d\n", consent_result);
3548 return Dumpstate::RunStatus::ERROR;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003549}
3550
Nandana Duttf02564e2019-02-15 15:24:24 +00003551Dumpstate::RunStatus Dumpstate::ParseCommandlineAndRun(int argc, char* argv[]) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003552 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
3553 Dumpstate::RunStatus status = options->Initialize(argc, argv);
3554 if (status == Dumpstate::RunStatus::OK) {
Nandana Duttf02564e2019-02-15 15:24:24 +00003555 SetOptions(std::move(options));
Nandana Duttd2f5f082019-01-18 17:13:52 +00003556 // When directly running dumpstate binary, the output is not expected to be written
3557 // to any external file descriptor.
Nandana Duttf02564e2019-02-15 15:24:24 +00003558 assert(options_->bugreport_fd.get() == -1);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003559
3560 // calling_uid and calling_package are for user consent to share the bugreport with
Abhijeet Kaura407fb82020-03-27 12:51:12 +00003561 // an app; they are irrelevant here because bugreport is triggered via command line.
3562 // Update Last ID before calling Run().
3563 Initialize();
Nandana Duttf02564e2019-02-15 15:24:24 +00003564 status = Run(-1 /* calling_uid */, "" /* calling_package */);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003565 }
Nandana Duttf02564e2019-02-15 15:24:24 +00003566 return status;
3567}
3568
3569/* Main entry point for dumpstate binary. */
3570int run_main(int argc, char* argv[]) {
3571 Dumpstate::RunStatus status = ds.ParseCommandlineAndRun(argc, argv);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003572
3573 switch (status) {
3574 case Dumpstate::RunStatus::OK:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003575 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003576 case Dumpstate::RunStatus::HELP:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003577 ShowUsage();
3578 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003579 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003580 fprintf(stderr, "Invalid combination of args\n");
3581 ShowUsage();
3582 exit(1);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003583 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00003584 FALLTHROUGH_INTENDED;
3585 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
3586 FALLTHROUGH_INTENDED;
3587 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003588 exit(2);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003589 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003590}
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003591
3592// TODO(111441001): Default DumpOptions to sensible values.
3593Dumpstate::Dumpstate(const std::string& version)
3594 : pid_(getpid()),
3595 options_(new Dumpstate::DumpOptions()),
Nandana Dutt402a8392019-06-14 14:25:13 +01003596 last_reported_percent_progress_(0),
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003597 version_(version),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003598 now_(time(nullptr)),
3599 open_socket_fn_(open_socket) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003600}
3601
3602Dumpstate& Dumpstate::GetInstance() {
3603 static Dumpstate singleton_(android::base::GetProperty("dumpstate.version", VERSION_CURRENT));
3604 return singleton_;
3605}
3606
Rhed Jao5377d792020-07-16 17:37:39 +08003607DurationReporter::DurationReporter(const std::string& title, bool logcat_only, bool verbose,
3608 int duration_fd) : title_(title), logcat_only_(logcat_only), verbose_(verbose),
3609 duration_fd_(duration_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003610 if (!title_.empty()) {
3611 started_ = Nanotime();
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003612 if (title_.find("SHOW MAP") == std::string::npos) {
3613 ATRACE_ASYNC_BEGIN(title_.c_str(), 0);
3614 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003615 }
3616}
3617
3618DurationReporter::~DurationReporter() {
3619 if (!title_.empty()) {
3620 float elapsed = (float)(Nanotime() - started_) / NANOS_PER_SEC;
chenqiwuaf8b2d92019-12-12 18:53:51 +08003621 if (elapsed >= .5f || verbose_) {
3622 MYLOGD("Duration of '%s': %.2fs\n", title_.c_str(), elapsed);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003623 }
chenqiwuaf8b2d92019-12-12 18:53:51 +08003624 if (!logcat_only_) {
3625 // Use "Yoda grammar" to make it easier to grep|sort sections.
Rhed Jao5377d792020-07-16 17:37:39 +08003626 dprintf(duration_fd_, "------ %.3fs was the duration of '%s' ------\n",
3627 elapsed, title_.c_str());
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003628 }
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003629 if (title_.find("SHOW MAP") == std::string::npos) {
3630 ATRACE_ASYNC_END(title_.c_str(), 0);
3631 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003632 }
3633}
3634
3635const int32_t Progress::kDefaultMax = 5000;
3636
3637Progress::Progress(const std::string& path) : Progress(Progress::kDefaultMax, 1.1, path) {
3638}
3639
3640Progress::Progress(int32_t initial_max, int32_t progress, float growth_factor)
3641 : Progress(initial_max, growth_factor, "") {
3642 progress_ = progress;
3643}
3644
3645Progress::Progress(int32_t initial_max, float growth_factor, const std::string& path)
3646 : initial_max_(initial_max),
3647 progress_(0),
3648 max_(initial_max),
3649 growth_factor_(growth_factor),
3650 n_runs_(0),
3651 average_max_(0),
3652 path_(path) {
3653 if (!path_.empty()) {
3654 Load();
3655 }
3656}
3657
3658void Progress::Load() {
3659 MYLOGD("Loading stats from %s\n", path_.c_str());
3660 std::string content;
3661 if (!android::base::ReadFileToString(path_, &content)) {
3662 MYLOGI("Could not read stats from %s; using max of %d\n", path_.c_str(), max_);
3663 return;
3664 }
3665 if (content.empty()) {
3666 MYLOGE("No stats (empty file) on %s; using max of %d\n", path_.c_str(), max_);
3667 return;
3668 }
3669 std::vector<std::string> lines = android::base::Split(content, "\n");
3670
3671 if (lines.size() < 1) {
3672 MYLOGE("Invalid stats on file %s: not enough lines (%d). Using max of %d\n", path_.c_str(),
3673 (int)lines.size(), max_);
3674 return;
3675 }
3676 char* ptr;
3677 n_runs_ = strtol(lines[0].c_str(), &ptr, 10);
3678 average_max_ = strtol(ptr, nullptr, 10);
3679 if (n_runs_ <= 0 || average_max_ <= 0 || n_runs_ > STATS_MAX_N_RUNS ||
3680 average_max_ > STATS_MAX_AVERAGE) {
3681 MYLOGE("Invalid stats line on file %s: %s\n", path_.c_str(), lines[0].c_str());
3682 initial_max_ = Progress::kDefaultMax;
3683 } else {
3684 initial_max_ = average_max_;
3685 }
3686 max_ = initial_max_;
3687
3688 MYLOGI("Average max progress: %d in %d runs; estimated max: %d\n", average_max_, n_runs_, max_);
3689}
3690
3691void Progress::Save() {
3692 int32_t total = n_runs_ * average_max_ + progress_;
3693 int32_t runs = n_runs_ + 1;
3694 int32_t average = floor(((float)total) / runs);
3695 MYLOGI("Saving stats (total=%d, runs=%d, average=%d) on %s\n", total, runs, average,
3696 path_.c_str());
3697 if (path_.empty()) {
3698 return;
3699 }
3700
3701 std::string content = android::base::StringPrintf("%d %d\n", runs, average);
3702 if (!android::base::WriteStringToFile(content, path_)) {
3703 MYLOGE("Could not save stats on %s\n", path_.c_str());
3704 }
3705}
3706
3707int32_t Progress::Get() const {
3708 return progress_;
3709}
3710
3711bool Progress::Inc(int32_t delta_sec) {
3712 bool changed = false;
3713 if (delta_sec >= 0) {
3714 progress_ += delta_sec;
3715 if (progress_ > max_) {
3716 int32_t old_max = max_;
3717 max_ = floor((float)progress_ * growth_factor_);
3718 MYLOGD("Adjusting max progress from %d to %d\n", old_max, max_);
3719 changed = true;
3720 }
3721 }
3722 return changed;
3723}
3724
3725int32_t Progress::GetMax() const {
3726 return max_;
3727}
3728
3729int32_t Progress::GetInitialMax() const {
3730 return initial_max_;
3731}
3732
3733void Progress::Dump(int fd, const std::string& prefix) const {
3734 const char* pr = prefix.c_str();
3735 dprintf(fd, "%sprogress: %d\n", pr, progress_);
3736 dprintf(fd, "%smax: %d\n", pr, max_);
3737 dprintf(fd, "%sinitial_max: %d\n", pr, initial_max_);
3738 dprintf(fd, "%sgrowth_factor: %0.2f\n", pr, growth_factor_);
3739 dprintf(fd, "%spath: %s\n", pr, path_.c_str());
3740 dprintf(fd, "%sn_runs: %d\n", pr, n_runs_);
3741 dprintf(fd, "%saverage_max: %d\n", pr, average_max_);
3742}
3743
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003744std::string Dumpstate::GetPath(const std::string& suffix) const {
3745 return GetPath(bugreport_internal_dir_, suffix);
3746}
3747
3748std::string Dumpstate::GetPath(const std::string& directory, const std::string& suffix) const {
3749 return android::base::StringPrintf("%s/%s-%s%s", directory.c_str(), base_name_.c_str(),
3750 name_.c_str(), suffix.c_str());
3751}
3752
3753void Dumpstate::SetProgress(std::unique_ptr<Progress> progress) {
3754 progress_ = std::move(progress);
3755}
3756
3757void for_each_userid(void (*func)(int), const char *header) {
3758 std::string title = header == nullptr ? "for_each_userid" : android::base::StringPrintf(
3759 "for_each_userid(%s)", header);
3760 DurationReporter duration_reporter(title);
3761 if (PropertiesHelper::IsDryRun()) return;
3762
3763 DIR *d;
3764 struct dirent *de;
3765
3766 if (header) printf("\n------ %s ------\n", header);
3767 func(0);
3768
3769 if (!(d = opendir("/data/system/users"))) {
3770 printf("Failed to open /data/system/users (%s)\n", strerror(errno));
3771 return;
3772 }
3773
3774 while ((de = readdir(d))) {
3775 int userid;
3776 if (de->d_type != DT_DIR || !(userid = atoi(de->d_name))) {
3777 continue;
3778 }
3779 func(userid);
3780 }
3781
3782 closedir(d);
3783}
3784
3785static void __for_each_pid(void (*helper)(int, const char *, void *), const char *header, void *arg) {
3786 DIR *d;
3787 struct dirent *de;
3788
3789 if (!(d = opendir("/proc"))) {
3790 printf("Failed to open /proc (%s)\n", strerror(errno));
3791 return;
3792 }
3793
3794 if (header) printf("\n------ %s ------\n", header);
3795 while ((de = readdir(d))) {
3796 if (ds.IsUserConsentDenied()) {
3797 MYLOGE(
3798 "Returning early because user denied consent to share bugreport with calling app.");
3799 closedir(d);
3800 return;
3801 }
3802 int pid;
3803 int fd;
3804 char cmdpath[255];
3805 char cmdline[255];
3806
3807 if (!(pid = atoi(de->d_name))) {
3808 continue;
3809 }
3810
3811 memset(cmdline, 0, sizeof(cmdline));
3812
3813 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/cmdline", pid);
3814 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3815 TEMP_FAILURE_RETRY(read(fd, cmdline, sizeof(cmdline) - 2));
3816 close(fd);
3817 if (cmdline[0]) {
3818 helper(pid, cmdline, arg);
3819 continue;
3820 }
3821 }
3822
3823 // if no cmdline, a kernel thread has comm
3824 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/comm", pid);
3825 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3826 TEMP_FAILURE_RETRY(read(fd, cmdline + 1, sizeof(cmdline) - 4));
3827 close(fd);
3828 if (cmdline[1]) {
3829 cmdline[0] = '[';
3830 size_t len = strcspn(cmdline, "\f\b\r\n");
3831 cmdline[len] = ']';
3832 cmdline[len+1] = '\0';
3833 }
3834 }
3835 if (!cmdline[0]) {
3836 strcpy(cmdline, "N/A");
3837 }
3838 helper(pid, cmdline, arg);
3839 }
3840
3841 closedir(d);
3842}
3843
3844static void for_each_pid_helper(int pid, const char *cmdline, void *arg) {
3845 for_each_pid_func *func = (for_each_pid_func*) arg;
3846 func(pid, cmdline);
3847}
3848
3849void for_each_pid(for_each_pid_func func, const char *header) {
3850 std::string title = header == nullptr ? "for_each_pid"
3851 : android::base::StringPrintf("for_each_pid(%s)", header);
3852 DurationReporter duration_reporter(title);
3853 if (PropertiesHelper::IsDryRun()) return;
3854
3855 __for_each_pid(for_each_pid_helper, header, (void *) func);
3856}
3857
3858static void for_each_tid_helper(int pid, const char *cmdline, void *arg) {
3859 DIR *d;
3860 struct dirent *de;
3861 char taskpath[255];
3862 for_each_tid_func *func = (for_each_tid_func *) arg;
3863
3864 snprintf(taskpath, sizeof(taskpath), "/proc/%d/task", pid);
3865
3866 if (!(d = opendir(taskpath))) {
3867 printf("Failed to open %s (%s)\n", taskpath, strerror(errno));
3868 return;
3869 }
3870
3871 func(pid, pid, cmdline);
3872
3873 while ((de = readdir(d))) {
3874 if (ds.IsUserConsentDenied()) {
3875 MYLOGE(
3876 "Returning early because user denied consent to share bugreport with calling app.");
3877 closedir(d);
3878 return;
3879 }
3880 int tid;
3881 int fd;
3882 char commpath[255];
3883 char comm[255];
3884
3885 if (!(tid = atoi(de->d_name))) {
3886 continue;
3887 }
3888
3889 if (tid == pid)
3890 continue;
3891
3892 snprintf(commpath, sizeof(commpath), "/proc/%d/comm", tid);
3893 memset(comm, 0, sizeof(comm));
3894 if ((fd = TEMP_FAILURE_RETRY(open(commpath, O_RDONLY | O_CLOEXEC))) < 0) {
3895 strcpy(comm, "N/A");
3896 } else {
3897 char *c;
3898 TEMP_FAILURE_RETRY(read(fd, comm, sizeof(comm) - 2));
3899 close(fd);
3900
3901 c = strrchr(comm, '\n');
3902 if (c) {
3903 *c = '\0';
3904 }
3905 }
3906 func(pid, tid, comm);
3907 }
3908
3909 closedir(d);
3910}
3911
3912void for_each_tid(for_each_tid_func func, const char *header) {
3913 std::string title = header == nullptr ? "for_each_tid"
3914 : android::base::StringPrintf("for_each_tid(%s)", header);
3915 DurationReporter duration_reporter(title);
3916
3917 if (PropertiesHelper::IsDryRun()) return;
3918
3919 __for_each_pid(for_each_tid_helper, header, (void *) func);
3920}
3921
3922void show_wchan(int pid, int tid, const char *name) {
3923 if (PropertiesHelper::IsDryRun()) return;
3924
3925 char path[255];
3926 char buffer[255];
3927 int fd, ret, save_errno;
3928 char name_buffer[255];
3929
3930 memset(buffer, 0, sizeof(buffer));
3931
3932 snprintf(path, sizeof(path), "/proc/%d/wchan", tid);
3933 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3934 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3935 return;
3936 }
3937
3938 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3939 save_errno = errno;
3940 close(fd);
3941
3942 if (ret < 0) {
3943 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3944 return;
3945 }
3946
3947 snprintf(name_buffer, sizeof(name_buffer), "%*s%s",
3948 pid == tid ? 0 : 3, "", name);
3949
3950 printf("%-7d %-32s %s\n", tid, name_buffer, buffer);
3951
3952 return;
3953}
3954
3955// print time in centiseconds
3956static void snprcent(char *buffer, size_t len, size_t spc,
3957 unsigned long long time) {
3958 static long hz; // cache discovered hz
3959
3960 if (hz <= 0) {
3961 hz = sysconf(_SC_CLK_TCK);
3962 if (hz <= 0) {
3963 hz = 1000;
3964 }
3965 }
3966
3967 // convert to centiseconds
3968 time = (time * 100 + (hz / 2)) / hz;
3969
3970 char str[16];
3971
3972 snprintf(str, sizeof(str), " %llu.%02u",
3973 time / 100, (unsigned)(time % 100));
3974 size_t offset = strlen(buffer);
3975 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3976 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3977}
3978
3979// print permille as a percent
3980static void snprdec(char *buffer, size_t len, size_t spc, unsigned permille) {
3981 char str[16];
3982
3983 snprintf(str, sizeof(str), " %u.%u%%", permille / 10, permille % 10);
3984 size_t offset = strlen(buffer);
3985 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3986 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3987}
3988
3989void show_showtime(int pid, const char *name) {
3990 if (PropertiesHelper::IsDryRun()) return;
3991
3992 char path[255];
3993 char buffer[1023];
3994 int fd, ret, save_errno;
3995
3996 memset(buffer, 0, sizeof(buffer));
3997
3998 snprintf(path, sizeof(path), "/proc/%d/stat", pid);
3999 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
4000 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
4001 return;
4002 }
4003
4004 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
4005 save_errno = errno;
4006 close(fd);
4007
4008 if (ret < 0) {
4009 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
4010 return;
4011 }
4012
4013 // field 14 is utime
4014 // field 15 is stime
4015 // field 42 is iotime
4016 unsigned long long utime = 0, stime = 0, iotime = 0;
4017 if (sscanf(buffer,
4018 "%*u %*s %*s %*d %*d %*d %*d %*d %*d %*d %*d "
4019 "%*d %*d %llu %llu %*d %*d %*d %*d %*d %*d "
4020 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %*d "
4021 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %llu ",
4022 &utime, &stime, &iotime) != 3) {
4023 return;
4024 }
4025
4026 unsigned long long total = utime + stime;
4027 if (!total) {
4028 return;
4029 }
4030
4031 unsigned permille = (iotime * 1000 + (total / 2)) / total;
4032 if (permille > 1000) {
4033 permille = 1000;
4034 }
4035
4036 // try to beautify and stabilize columns at <80 characters
4037 snprintf(buffer, sizeof(buffer), "%-6d%s", pid, name);
4038 if ((name[0] != '[') || utime) {
4039 snprcent(buffer, sizeof(buffer), 57, utime);
4040 }
4041 snprcent(buffer, sizeof(buffer), 65, stime);
4042 if ((name[0] != '[') || iotime) {
4043 snprcent(buffer, sizeof(buffer), 73, iotime);
4044 }
4045 if (iotime) {
4046 snprdec(buffer, sizeof(buffer), 79, permille);
4047 }
4048 puts(buffer); // adds a trailing newline
4049
4050 return;
4051}
4052
4053void do_dmesg() {
4054 const char *title = "KERNEL LOG (dmesg)";
4055 DurationReporter duration_reporter(title);
4056 printf("------ %s ------\n", title);
4057
4058 if (PropertiesHelper::IsDryRun()) return;
4059
4060 /* Get size of kernel buffer */
4061 int size = klogctl(KLOG_SIZE_BUFFER, nullptr, 0);
4062 if (size <= 0) {
4063 printf("Unexpected klogctl return value: %d\n\n", size);
4064 return;
4065 }
4066 char *buf = (char *) malloc(size + 1);
4067 if (buf == nullptr) {
4068 printf("memory allocation failed\n\n");
4069 return;
4070 }
4071 int retval = klogctl(KLOG_READ_ALL, buf, size);
4072 if (retval < 0) {
4073 printf("klogctl failure\n\n");
4074 free(buf);
4075 return;
4076 }
4077 buf[retval] = '\0';
4078 printf("%s\n\n", buf);
4079 free(buf);
4080 return;
4081}
4082
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004083int Dumpstate::DumpFile(const std::string& title, const std::string& path) {
4084 DurationReporter duration_reporter(title);
4085
4086 int status = DumpFileToFd(STDOUT_FILENO, title, path);
4087
4088 UpdateProgress(WEIGHT_FILE);
4089
4090 return status;
4091}
4092
4093int read_file_as_long(const char *path, long int *output) {
4094 int fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC));
4095 if (fd < 0) {
4096 int err = errno;
4097 MYLOGE("Error opening file descriptor for %s: %s\n", path, strerror(err));
4098 return -1;
4099 }
4100 char buffer[50];
4101 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
4102 if (bytes_read == -1) {
4103 MYLOGE("Error reading file %s: %s\n", path, strerror(errno));
4104 return -2;
4105 }
4106 if (bytes_read == 0) {
4107 MYLOGE("File %s is empty\n", path);
4108 return -3;
4109 }
4110 *output = atoi(buffer);
4111 return 0;
4112}
4113
4114/* calls skip to gate calling dump_from_fd recursively
4115 * in the specified directory. dump_from_fd defaults to
4116 * dump_file_from_fd above when set to NULL. skip defaults
4117 * to false when set to NULL. dump_from_fd will always be
4118 * called with title NULL.
4119 */
4120int dump_files(const std::string& title, const char* dir, bool (*skip)(const char* path),
4121 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
4122 DurationReporter duration_reporter(title);
4123 DIR *dirp;
4124 struct dirent *d;
4125 char *newpath = nullptr;
4126 const char *slash = "/";
4127 int retval = 0;
4128
4129 if (!title.empty()) {
4130 printf("------ %s (%s) ------\n", title.c_str(), dir);
4131 }
4132 if (PropertiesHelper::IsDryRun()) return 0;
4133
4134 if (dir[strlen(dir) - 1] == '/') {
4135 ++slash;
4136 }
4137 dirp = opendir(dir);
4138 if (dirp == nullptr) {
4139 retval = -errno;
4140 MYLOGE("%s: %s\n", dir, strerror(errno));
4141 return retval;
4142 }
4143
4144 if (!dump_from_fd) {
4145 dump_from_fd = dump_file_from_fd;
4146 }
4147 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
4148 if ((d->d_name[0] == '.')
4149 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
4150 || (d->d_name[1] == '\0'))) {
4151 continue;
4152 }
4153 asprintf(&newpath, "%s%s%s%s", dir, slash, d->d_name,
4154 (d->d_type == DT_DIR) ? "/" : "");
4155 if (!newpath) {
4156 retval = -errno;
4157 continue;
4158 }
4159 if (skip && (*skip)(newpath)) {
4160 continue;
4161 }
4162 if (d->d_type == DT_DIR) {
4163 int ret = dump_files("", newpath, skip, dump_from_fd);
4164 if (ret < 0) {
4165 retval = ret;
4166 }
4167 continue;
4168 }
4169 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(newpath, O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
4170 if (fd.get() < 0) {
4171 retval = -1;
4172 printf("*** %s: %s\n", newpath, strerror(errno));
4173 continue;
4174 }
4175 (*dump_from_fd)(nullptr, newpath, fd.get());
4176 }
4177 closedir(dirp);
4178 if (!title.empty()) {
4179 printf("\n");
4180 }
4181 return retval;
4182}
4183
4184/* fd must have been opened with the flag O_NONBLOCK. With this flag set,
4185 * it's possible to avoid issues where opening the file itself can get
4186 * stuck.
4187 */
4188int dump_file_from_fd(const char *title, const char *path, int fd) {
4189 if (PropertiesHelper::IsDryRun()) return 0;
4190
4191 int flags = fcntl(fd, F_GETFL);
4192 if (flags == -1) {
4193 printf("*** %s: failed to get flags on fd %d: %s\n", path, fd, strerror(errno));
4194 return -1;
4195 } else if (!(flags & O_NONBLOCK)) {
4196 printf("*** %s: fd must have O_NONBLOCK set.\n", path);
4197 return -1;
4198 }
4199 return DumpFileFromFdToFd(title, path, fd, STDOUT_FILENO, PropertiesHelper::IsDryRun());
4200}
4201
4202int Dumpstate::RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08004203 const CommandOptions& options, bool verbose_duration, int out_fd) {
4204 DurationReporter duration_reporter(title, false /* logcat_only */,
4205 verbose_duration, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004206
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08004207 int status = RunCommandToFd(out_fd, title, full_command, options);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004208
4209 /* TODO: for now we're simplifying the progress calculation by using the
4210 * timeout as the weight. It's a good approximation for most cases, except when calling dumpsys,
4211 * where its weight should be much higher proportionally to its timeout.
4212 * Ideally, it should use a options.EstimatedDuration() instead...*/
4213 UpdateProgress(options.Timeout());
4214
4215 return status;
4216}
4217
4218void Dumpstate::RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsys_args,
Rhed Jaoe017f982020-07-21 17:58:41 +08004219 const CommandOptions& options, long dumpsysTimeoutMs, int out_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004220 long timeout_ms = dumpsysTimeoutMs > 0 ? dumpsysTimeoutMs : options.TimeoutInMs();
4221 std::vector<std::string> dumpsys = {"/system/bin/dumpsys", "-T", std::to_string(timeout_ms)};
4222 dumpsys.insert(dumpsys.end(), dumpsys_args.begin(), dumpsys_args.end());
Rhed Jaoe017f982020-07-21 17:58:41 +08004223 RunCommand(title, dumpsys, options, false, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004224}
4225
Dieter Hsu105ad0c2020-09-29 15:23:33 +08004226static int open_socket(const char* service) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004227 int s = android_get_control_socket(service);
4228 if (s < 0) {
4229 MYLOGE("android_get_control_socket(%s): %s\n", service, strerror(errno));
4230 return -1;
4231 }
4232 fcntl(s, F_SETFD, FD_CLOEXEC);
4233
4234 // Set backlog to 0 to make sure that queue size will be minimum.
4235 // In Linux, because the minimum queue will be 1, connect() will be blocked
4236 // if the other clients already called connect() and the connection request was not accepted.
4237 if (listen(s, 0) < 0) {
4238 MYLOGE("listen(control socket): %s\n", strerror(errno));
4239 return -1;
4240 }
4241
4242 struct sockaddr addr;
4243 socklen_t alen = sizeof(addr);
Abhijeet Kaur2113cae2019-09-13 09:24:15 +01004244 int fd = accept4(s, &addr, &alen, SOCK_CLOEXEC);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004245
4246 // Close socket just after accept(), to make sure that connect() by client will get error
4247 // when the socket is used by the other services.
4248 // There is still a race condition possibility between accept and close, but there is no way
4249 // to close-on-accept atomically.
4250 // See detail; b/123306389#comment25
4251 close(s);
4252
4253 if (fd < 0) {
4254 MYLOGE("accept(control socket): %s\n", strerror(errno));
4255 return -1;
4256 }
4257
4258 return fd;
4259}
4260
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004261// TODO: should call is_valid_output_file and/or be merged into it.
4262void create_parent_dirs(const char *path) {
4263 char *chp = const_cast<char *> (path);
4264
4265 /* skip initial slash */
4266 if (chp[0] == '/')
4267 chp++;
4268
4269 /* create leading directories, if necessary */
4270 struct stat dir_stat;
4271 while (chp && chp[0]) {
4272 chp = strchr(chp, '/');
4273 if (chp) {
4274 *chp = 0;
4275 if (stat(path, &dir_stat) == -1 || !S_ISDIR(dir_stat.st_mode)) {
4276 MYLOGI("Creating directory %s\n", path);
4277 if (mkdir(path, 0770)) { /* drwxrwx--- */
4278 MYLOGE("Unable to create directory %s: %s\n", path, strerror(errno));
4279 } else if (chown(path, AID_SHELL, AID_SHELL)) {
4280 MYLOGE("Unable to change ownership of dir %s: %s\n", path, strerror(errno));
4281 }
4282 }
4283 *chp++ = '/';
4284 }
4285 }
4286}
4287
4288bool _redirect_to_file(FILE* redirect, char* path, int truncate_flag) {
4289 create_parent_dirs(path);
4290
4291 int fd = TEMP_FAILURE_RETRY(open(path,
4292 O_WRONLY | O_CREAT | truncate_flag | O_CLOEXEC | O_NOFOLLOW,
4293 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH));
4294 if (fd < 0) {
4295 MYLOGE("%s: %s\n", path, strerror(errno));
4296 return false;
4297 }
4298
4299 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
4300 close(fd);
4301 return true;
4302}
4303
4304bool redirect_to_file(FILE* redirect, char* path) {
4305 return _redirect_to_file(redirect, path, O_TRUNC);
4306}
4307
4308bool redirect_to_existing_file(FILE* redirect, char* path) {
4309 return _redirect_to_file(redirect, path, O_APPEND);
4310}
4311
4312void dump_route_tables() {
4313 DurationReporter duration_reporter("DUMP ROUTE TABLES");
4314 if (PropertiesHelper::IsDryRun()) return;
4315 const char* const RT_TABLES_PATH = "/data/misc/net/rt_tables";
4316 ds.DumpFile("RT_TABLES", RT_TABLES_PATH);
4317 FILE* fp = fopen(RT_TABLES_PATH, "re");
4318 if (!fp) {
4319 printf("*** %s: %s\n", RT_TABLES_PATH, strerror(errno));
4320 return;
4321 }
4322 char table[16];
4323 // Each line has an integer (the table number), a space, and a string (the table name). We only
4324 // need the table number. It's a 32-bit unsigned number, so max 10 chars. Skip the table name.
4325 // Add a fixed max limit so this doesn't go awry.
4326 for (int i = 0; i < 64 && fscanf(fp, " %10s %*s", table) == 1; ++i) {
4327 RunCommand("ROUTE TABLE IPv4", {"ip", "-4", "route", "show", "table", table});
4328 RunCommand("ROUTE TABLE IPv6", {"ip", "-6", "route", "show", "table", table});
4329 }
4330 fclose(fp);
4331}
4332
Li Li830179f2022-01-04 12:53:29 -08004333void dump_frozen_cgroupfs(const char *dir, int level,
4334 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
4335 DIR *dirp;
4336 struct dirent *d;
4337 char *newpath = nullptr;
4338
4339 dirp = opendir(dir);
4340 if (dirp == nullptr) {
4341 MYLOGE("%s: %s\n", dir, strerror(errno));
4342 return;
4343 }
4344
4345 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
4346 if ((d->d_name[0] == '.')
4347 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
4348 || (d->d_name[1] == '\0'))) {
4349 continue;
4350 }
4351 if (d->d_type == DT_DIR) {
4352 asprintf(&newpath, "%s/%s/", dir, d->d_name);
4353 if (!newpath) {
4354 continue;
4355 }
4356 if (level == 0 && !strncmp(d->d_name, "uid_", 4)) {
4357 dump_frozen_cgroupfs(newpath, 1, dump_from_fd);
4358 } else if (level == 1 && !strncmp(d->d_name, "pid_", 4)) {
4359 char *freezer = nullptr;
4360 asprintf(&freezer, "%s/%s", newpath, "cgroup.freeze");
4361 if (freezer) {
4362 FILE* fp = fopen(freezer, "r");
4363 if (fp != NULL) {
4364 int frozen;
4365 fscanf(fp, "%d", &frozen);
4366 if (frozen > 0) {
4367 dump_files("", newpath, skip_none, dump_from_fd);
4368 }
4369 fclose(fp);
4370 }
4371 free(freezer);
4372 }
4373 }
4374 }
4375 }
4376 closedir(dirp);
4377}
4378
4379void dump_frozen_cgroupfs() {
Li Li830179f2022-01-04 12:53:29 -08004380 MYLOGD("Adding frozen processes from %s\n", CGROUPFS_DIR);
4381 DurationReporter duration_reporter("FROZEN CGROUPFS");
4382 if (PropertiesHelper::IsDryRun()) return;
4383 dump_frozen_cgroupfs(CGROUPFS_DIR, 0, _add_file_from_fd);
4384}
4385
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004386void Dumpstate::UpdateProgress(int32_t delta_sec) {
4387 if (progress_ == nullptr) {
4388 MYLOGE("UpdateProgress: progress_ not set\n");
4389 return;
4390 }
Rhed Jaobf63d8a2020-07-21 15:42:55 +08004391 // This function updates progress related members of the dumpstate and reports
4392 // progress percentage to the bugreport client. Since it could be called by
4393 // different dump tasks at the same time if the parallel run is enabled, a
4394 // mutex lock is necessary here to synchronize the call.
4395 std::lock_guard<std::recursive_mutex> lock(mutex_);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004396
4397 // Always update progess so stats can be tuned...
Nandana Dutt402a8392019-06-14 14:25:13 +01004398 progress_->Inc(delta_sec);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004399
4400 // ...but only notifiy listeners when necessary.
4401 if (!options_->do_progress_updates) return;
4402
4403 int progress = progress_->Get();
4404 int max = progress_->GetMax();
Nandana Dutt402a8392019-06-14 14:25:13 +01004405 int percent = 100 * progress / max;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004406
Nandana Dutt402a8392019-06-14 14:25:13 +01004407 if (last_reported_percent_progress_ > 0 && percent <= last_reported_percent_progress_) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004408 return;
4409 }
Nandana Dutt402a8392019-06-14 14:25:13 +01004410 last_reported_percent_progress_ = percent;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004411
4412 if (control_socket_fd_ >= 0) {
4413 dprintf(control_socket_fd_, "PROGRESS:%d/%d\n", progress, max);
4414 fsync(control_socket_fd_);
4415 }
4416
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004417 if (listener_ != nullptr) {
Nandana Dutt235c6672019-11-14 15:22:32 +00004418 if (percent % 10 == 0) {
4419 // We don't want to spam logcat, so only log multiples of 10.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004420 MYLOGD("Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004421 } else {
4422 // stderr is ignored on normal invocations, but useful when calling
4423 // /system/bin/dumpstate directly for debuggging.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004424 fprintf(stderr, "Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004425 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004426
4427 listener_->onProgress(percent);
4428 }
4429}
4430
4431void Dumpstate::TakeScreenshot(const std::string& path) {
4432 const std::string& real_path = path.empty() ? screenshot_path_ : path;
4433 int status =
4434 RunCommand("", {"/system/bin/screencap", "-p", real_path},
4435 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
4436 if (status == 0) {
4437 MYLOGD("Screenshot saved on %s\n", real_path.c_str());
4438 } else {
4439 MYLOGE("Failed to take screenshot on %s\n", real_path.c_str());
4440 }
Paul Chang0d2aad72020-02-13 20:04:03 +08004441 if (listener_ != nullptr) {
4442 // Show a visual indication to indicate screenshot is taken via
4443 // IDumpstateListener.onScreenshotTaken()
4444 listener_->onScreenshotTaken(status == 0);
4445 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004446}
4447
4448bool is_dir(const char* pathname) {
4449 struct stat info;
4450 if (stat(pathname, &info) == -1) {
4451 return false;
4452 }
4453 return S_ISDIR(info.st_mode);
4454}
4455
4456time_t get_mtime(int fd, time_t default_mtime) {
4457 struct stat info;
4458 if (fstat(fd, &info) == -1) {
4459 return default_mtime;
4460 }
4461 return info.st_mtime;
4462}