blob: 1403b77652b14e0fffd0de98f9bac46090510aa8 [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"));
Devin Moore09fde8d2023-03-21 16:28:22 +0000819 printf("Bootconfig: ");
820 DumpFileToFd(STDOUT_FILENO, "", "/proc/bootconfig");
Felipe Leme7709f8a2017-12-05 09:30:09 -0800821 printf("Uptime: ");
822 RunCommandToFd(STDOUT_FILENO, "", {"uptime", "-p"},
823 CommandOptions::WithTimeout(1).Always().Build());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800824 printf("Bugreport format version: %s\n", version_.c_str());
Rhed Jao5377d792020-07-16 17:37:39 +0800825 printf("Dumpstate info: id=%d pid=%d dry_run=%d parallel_run=%d args=%s bugreport_mode=%s\n",
826 id_, pid_, PropertiesHelper::IsDryRun(), PropertiesHelper::IsParallelRun(),
Kedar Chitnis9fd8c052021-11-16 09:09:22 +0000827 options_->args.c_str(), options_->bugreport_mode_string.c_str());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800828 printf("\n");
Felipe Leme78f2c862015-12-21 09:55:22 -0800829}
830
Felipe Leme24b66ee2016-06-16 10:55:26 -0700831// List of file extensions that can cause a zip file attachment to be rejected by some email
832// service providers.
833static const std::set<std::string> PROBLEMATIC_FILE_EXTENSIONS = {
834 ".ade", ".adp", ".bat", ".chm", ".cmd", ".com", ".cpl", ".exe", ".hta", ".ins", ".isp",
835 ".jar", ".jse", ".lib", ".lnk", ".mde", ".msc", ".msp", ".mst", ".pif", ".scr", ".sct",
836 ".shb", ".sys", ".vb", ".vbe", ".vbs", ".vxd", ".wsc", ".wsf", ".wsh"
837};
838
Vishnu Naire97d6122018-01-18 13:58:56 -0800839status_t Dumpstate::AddZipEntryFromFd(const std::string& entry_name, int fd,
840 std::chrono::milliseconds timeout = 0ms) {
Felipe Leme24b66ee2016-06-16 10:55:26 -0700841 std::string valid_name = entry_name;
842
843 // Rename extension if necessary.
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -0700844 size_t idx = entry_name.rfind('.');
Felipe Leme24b66ee2016-06-16 10:55:26 -0700845 if (idx != std::string::npos) {
846 std::string extension = entry_name.substr(idx);
847 std::transform(extension.begin(), extension.end(), extension.begin(), ::tolower);
848 if (PROBLEMATIC_FILE_EXTENSIONS.count(extension) != 0) {
849 valid_name = entry_name + ".renamed";
850 MYLOGI("Renaming entry %s to %s\n", entry_name.c_str(), valid_name.c_str());
851 }
852 }
853
Felipe Leme6fe9db62016-02-12 09:04:16 -0800854 // Logging statement below is useful to time how long each entry takes, but it's too verbose.
855 // MYLOGD("Adding zip entry %s\n", entry_name.c_str());
Kevin Jeon9bbe0ac2022-05-05 22:05:43 +0000856 size_t flags = ZipWriter::kCompress | ZipWriter::kDefaultCompression;
857 int32_t err = zip_writer_->StartEntryWithTime(valid_name.c_str(), flags,
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700858 get_mtime(fd, ds.now_));
Felipe Leme1d486fe2016-10-14 18:06:47 -0700859 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700860 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", valid_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700861 ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800862 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800863 }
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000864 bool finished_entry = false;
865 auto finish_entry = [this, &finished_entry] {
866 if (!finished_entry) {
867 // This should only be called when we're going to return an earlier error,
868 // which would've been logged. This may imply the file is already corrupt
869 // and any further logging from FinishEntry is more likely to mislead than
870 // not.
871 this->zip_writer_->FinishEntry();
872 }
873 };
874 auto scope_guard = android::base::make_scope_guard(finish_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -0800875 auto start = std::chrono::steady_clock::now();
876 auto end = start + timeout;
877 struct pollfd pfd = {fd, POLLIN};
Felipe Lemee82a27d2016-01-05 13:35:44 -0800878
Felipe Leme770410d2016-01-26 17:07:14 -0800879 std::vector<uint8_t> buffer(65536);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800880 while (1) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800881 if (timeout.count() > 0) {
882 // lambda to recalculate the timeout.
883 auto time_left_ms = [end]() {
884 auto now = std::chrono::steady_clock::now();
885 auto diff = std::chrono::duration_cast<std::chrono::milliseconds>(end - now);
886 return std::max(diff.count(), 0LL);
887 };
888
889 int rc = TEMP_FAILURE_RETRY(poll(&pfd, 1, time_left_ms()));
890 if (rc < 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000891 MYLOGE("Error in poll while adding from fd to zip entry %s:%s\n",
892 entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800893 return -errno;
894 } else if (rc == 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000895 MYLOGE("Timed out adding from fd to zip entry %s:%s Timeout:%lldms\n",
Vishnu Naire97d6122018-01-18 13:58:56 -0800896 entry_name.c_str(), strerror(errno), timeout.count());
897 return TIMED_OUT;
898 }
899 }
900
Zach Riggle22200402016-08-18 01:01:24 -0400901 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800902 if (bytes_read == 0) {
903 break;
904 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800905 MYLOGE("read(%s): %s\n", entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800906 return -errno;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800907 }
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700908 err = zip_writer_->WriteBytes(buffer.data(), bytes_read);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800909 if (err) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700910 MYLOGE("zip_writer_->WriteBytes(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800911 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800912 }
913 }
914
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700915 err = zip_writer_->FinishEntry();
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000916 finished_entry = true;
Felipe Leme1d486fe2016-10-14 18:06:47 -0700917 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700918 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800919 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800920 }
921
Vishnu Naire97d6122018-01-18 13:58:56 -0800922 return OK;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800923}
924
Felipe Leme1d486fe2016-10-14 18:06:47 -0700925bool Dumpstate::AddZipEntry(const std::string& entry_name, const std::string& entry_path) {
926 android::base::unique_fd fd(
927 TEMP_FAILURE_RETRY(open(entry_path.c_str(), O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
Andreas Gampeaff68432016-07-18 18:01:27 -0700928 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800929 MYLOGE("open(%s): %s\n", entry_path.c_str(), strerror(errno));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800930 return false;
931 }
932
Vishnu Naire97d6122018-01-18 13:58:56 -0800933 return (AddZipEntryFromFd(entry_name, fd.get()) == OK);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800934}
935
936/* adds a file to the existing zipped bugreport */
Felipe Leme4c2d6632016-09-28 14:32:00 -0700937static int _add_file_from_fd(const char* title __attribute__((unused)), const char* path, int fd) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800938 return (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + path, fd) == OK) ? 0 : 1;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800939}
940
Felipe Leme1d486fe2016-10-14 18:06:47 -0700941void Dumpstate::AddDir(const std::string& dir, bool recursive) {
Felipe Leme678727a2016-09-21 17:22:11 -0700942 MYLOGD("Adding dir %s (recursive: %d)\n", dir.c_str(), recursive);
Felipe Leme46b85da2016-11-21 17:40:45 -0800943 DurationReporter duration_reporter(dir, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700944 dump_files("", dir.c_str(), recursive ? skip_none : is_dir, _add_file_from_fd);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800945}
946
Felipe Leme1d486fe2016-10-14 18:06:47 -0700947bool Dumpstate::AddTextZipEntry(const std::string& entry_name, const std::string& content) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800948 MYLOGD("Adding zip text entry %s\n", entry_name.c_str());
Kevin Jeon9bbe0ac2022-05-05 22:05:43 +0000949 size_t flags = ZipWriter::kCompress | ZipWriter::kDefaultCompression;
950 int32_t err = zip_writer_->StartEntryWithTime(entry_name.c_str(), flags, ds.now_);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700951 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700952 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700953 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800954 return false;
955 }
956
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700957 err = zip_writer_->WriteBytes(content.c_str(), content.length());
Felipe Leme1d486fe2016-10-14 18:06:47 -0700958 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700959 MYLOGE("zip_writer_->WriteBytes(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700960 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800961 return false;
962 }
963
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700964 err = zip_writer_->FinishEntry();
Felipe Leme1d486fe2016-10-14 18:06:47 -0700965 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700966 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800967 return false;
968 }
969
970 return true;
971}
972
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800973static void DoKmsg() {
974 struct stat st;
975 if (!stat(PSTORE_LAST_KMSG, &st)) {
976 /* Also TODO: Make console-ramoops CAP_SYSLOG protected. */
977 DumpFile("LAST KMSG", PSTORE_LAST_KMSG);
978 } else if (!stat(ALT_PSTORE_LAST_KMSG, &st)) {
979 DumpFile("LAST KMSG", ALT_PSTORE_LAST_KMSG);
980 } else {
981 /* TODO: Make last_kmsg CAP_SYSLOG protected. b/5555691 */
982 DumpFile("LAST KMSG", "/proc/last_kmsg");
983 }
984}
985
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800986static void DoKernelLogcat() {
Yao Chenbe3bbc12018-01-17 16:31:10 -0800987 unsigned long timeout_ms = logcat_timeout({"kernel"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800988 RunCommand(
989 "KERNEL LOG",
990 {"logcat", "-b", "kernel", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
991 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
992}
993
Nandana Duttdb379fa2019-10-09 16:54:41 +0100994static void DoSystemLogcat(time_t since) {
995 char since_str[80];
996 strftime(since_str, sizeof(since_str), "%Y-%m-%d %H:%M:%S.000", localtime(&since));
997
998 unsigned long timeout_ms = logcat_timeout({"main", "system", "crash"});
999 RunCommand("SYSTEM LOG",
1000 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v", "-T",
1001 since_str},
1002 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1003}
1004
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001005static void DoRadioLogcat() {
1006 unsigned long timeout_ms = logcat_timeout({"radio"});
1007 RunCommand(
1008 "RADIO LOG",
1009 {"logcat", "-b", "radio", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1010 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
1011}
1012
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001013static void DoLogcat() {
Vishnu Nair6921f802017-11-22 09:17:23 -08001014 unsigned long timeout_ms;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001015 // DumpFile("EVENT LOG TAGS", "/etc/event-log-tags");
1016 // calculate timeout
Yao Chenbe3bbc12018-01-17 16:31:10 -08001017 timeout_ms = logcat_timeout({"main", "system", "crash"});
Tony Makae737652017-03-30 17:47:09 +01001018 RunCommand("SYSTEM LOG",
Vishnu Nair6921f802017-11-22 09:17:23 -08001019 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1020 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -08001021 timeout_ms = logcat_timeout({"events"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001022 RunCommand(
1023 "EVENT LOG",
1024 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001025 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Yao Chenbe3bbc12018-01-17 16:31:10 -08001026 timeout_ms = logcat_timeout({"stats"});
1027 RunCommand(
1028 "STATS LOG",
1029 {"logcat", "-b", "stats", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001030 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001031 DoRadioLogcat();
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001032
1033 RunCommand("LOG STATISTICS", {"logcat", "-b", "all", "-S"});
1034
1035 /* kernels must set CONFIG_PSTORE_PMSG, slice up pstore with device tree */
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001036 RunCommand("LAST LOGCAT", {"logcat", "-L", "-b", "all", "-v", "threadtime", "-v", "printable",
1037 "-v", "uid", "-d", "*:v"});
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001038}
1039
Mike Ma5c267872019-08-21 11:31:34 -07001040static void DumpIncidentReport() {
Mike Ma5c267872019-08-21 11:31:34 -07001041 const std::string path = ds.bugreport_internal_dir_ + "/tmp_incident_report";
1042 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1043 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1044 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1045 if (fd < 0) {
1046 MYLOGE("Could not open %s to dump incident report.\n", path.c_str());
1047 return;
1048 }
Kevin Jeon774abde2022-09-28 18:20:43 +00001049 RunCommandToFd(fd, "", {"incident", "-u"}, CommandOptions::WithTimeout(20).Build());
Mike Ma5c267872019-08-21 11:31:34 -07001050 bool empty = 0 == lseek(fd, 0, SEEK_END);
1051 if (!empty) {
1052 // Use a different name from "incident.proto"
1053 // /proto/incident.proto is reserved for incident service dump
1054 // i.e. metadata for debugging.
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001055 ds.EnqueueAddZipEntryAndCleanupIfNeeded(kProtoPath + "incident_report" + kProtoExt,
1056 path);
1057 } else {
1058 unlink(path.c_str());
Mike Ma5c267872019-08-21 11:31:34 -07001059 }
Mike Ma5c267872019-08-21 11:31:34 -07001060}
1061
Aaron Huang24d215d2022-04-27 18:51:16 +08001062static void DumpNetstatsProto() {
1063 const std::string path = ds.bugreport_internal_dir_ + "/tmp_netstats_proto";
1064 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1065 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1066 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1067 if (fd < 0) {
1068 MYLOGE("Could not open %s to dump netstats proto.\n", path.c_str());
1069 return;
1070 }
1071 RunCommandToFd(fd, "", {"dumpsys", "netstats", "--proto"},
Kevin Jeon2fb3dd62022-09-28 18:48:55 +00001072 CommandOptions::WithTimeout(5).Build());
Aaron Huang24d215d2022-04-27 18:51:16 +08001073 bool empty = 0 == lseek(fd, 0, SEEK_END);
1074 if (!empty) {
1075 ds.EnqueueAddZipEntryAndCleanupIfNeeded(kProtoPath + "netstats" + kProtoExt,
1076 path);
1077 } else {
1078 unlink(path.c_str());
1079 }
1080}
1081
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001082static void MaybeAddSystemTraceToZip() {
1083 // This function copies into the .zip the system trace that was snapshotted
1084 // by the early call to MaybeSnapshotSystemTrace(), if any background
1085 // tracing was happening.
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001086 if (!ds.has_system_trace_) {
1087 // No background trace was happening at the time dumpstate was invoked.
1088 return;
1089 }
1090 ds.AddZipEntry(
1091 ZIP_ROOT_DIR + SYSTEM_TRACE_SNAPSHOT,
1092 SYSTEM_TRACE_SNAPSHOT);
1093 android::os::UnlinkAndLogOnError(SYSTEM_TRACE_SNAPSHOT);
1094}
1095
Sunny Goyal35949782019-11-19 15:54:36 -08001096static void DumpVisibleWindowViews() {
Sunny Goyal35949782019-11-19 15:54:36 -08001097 DurationReporter duration_reporter("VISIBLE WINDOW VIEWS");
1098 const std::string path = ds.bugreport_internal_dir_ + "/tmp_visible_window_views";
1099 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1100 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1101 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1102 if (fd < 0) {
1103 MYLOGE("Could not open %s to dump visible views.\n", path.c_str());
1104 return;
1105 }
1106 RunCommandToFd(fd, "", {"cmd", "window", "dump-visible-window-views"},
Kevin Jeon774abde2022-09-28 18:20:43 +00001107 CommandOptions::WithTimeout(10).Build());
Sunny Goyal35949782019-11-19 15:54:36 -08001108 bool empty = 0 == lseek(fd, 0, SEEK_END);
1109 if (!empty) {
1110 ds.AddZipEntry("visible_windows.zip", path);
1111 } else {
1112 MYLOGW("Failed to dump visible windows\n");
1113 }
1114 unlink(path.c_str());
1115}
1116
Jayachandran Ca94c7172017-06-10 15:08:12 -07001117static void DumpIpTablesAsRoot() {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001118 RunCommand("IPTABLES", {"iptables", "-L", "-nvx"});
1119 RunCommand("IP6TABLES", {"ip6tables", "-L", "-nvx"});
Erik Kline32af8c22016-09-28 17:26:26 +09001120 RunCommand("IPTABLES NAT", {"iptables", "-t", "nat", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001121 /* no ip6 nat */
Erik Kline32af8c22016-09-28 17:26:26 +09001122 RunCommand("IPTABLES MANGLE", {"iptables", "-t", "mangle", "-L", "-nvx"});
1123 RunCommand("IP6TABLES MANGLE", {"ip6tables", "-t", "mangle", "-L", "-nvx"});
1124 RunCommand("IPTABLES RAW", {"iptables", "-t", "raw", "-L", "-nvx"});
1125 RunCommand("IP6TABLES RAW", {"ip6tables", "-t", "raw", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001126}
1127
Woody Lin20767a92022-11-29 15:50:24 +08001128static void DumpShutdownCheckpoints() {
1129 const bool shutdown_checkpoints_dumped = AddDumps(
1130 ds.shutdown_checkpoints_.begin(), ds.shutdown_checkpoints_.end(),
1131 "SHUTDOWN CHECKPOINTS", false /* add_to_zip */);
1132 if (!shutdown_checkpoints_dumped) {
1133 printf("*** NO SHUTDOWN CHECKPOINTS to dump in %s\n\n",
1134 SHUTDOWN_CHECKPOINTS_DIR.c_str());
1135 }
1136}
1137
David Andersond9ba4752018-12-11 18:26:59 -08001138static void DumpDynamicPartitionInfo() {
1139 if (!::android::base::GetBoolProperty("ro.boot.dynamic_partitions", false)) {
1140 return;
1141 }
1142
1143 RunCommand("LPDUMP", {"lpdump", "--all"});
David Anderson6650ade2019-10-02 15:18:59 -07001144 RunCommand("DEVICE-MAPPER", {"gsid", "dump-device-mapper"});
David Andersond9ba4752018-12-11 18:26:59 -08001145}
1146
Chris Morin5a50d482022-02-01 17:41:18 -08001147static void AddAnrTraceDir(const std::string& anr_traces_dir) {
Narayan Kamath8f788292017-05-25 13:20:39 +01001148 MYLOGD("AddAnrTraceDir(): dump_traces_file=%s, anr_traces_dir=%s\n", dump_traces_path,
1149 anr_traces_dir.c_str());
1150
1151 // If we're here, dump_traces_path will always be a temporary file
1152 // (created with mkostemp or similar) that contains dumps taken earlier
1153 // on in the process.
1154 if (dump_traces_path != nullptr) {
Chris Morin5a50d482022-02-01 17:41:18 -08001155 MYLOGD("Dumping current ANR traces (%s) to the main bugreport entry\n",
1156 dump_traces_path);
1157 ds.DumpFile("VM TRACES JUST NOW", dump_traces_path);
Narayan Kamath8f788292017-05-25 13:20:39 +01001158
1159 const int ret = unlink(dump_traces_path);
1160 if (ret == -1) {
1161 MYLOGW("Error unlinking temporary trace path %s: %s\n", dump_traces_path,
1162 strerror(errno));
Felipe Lemee184f662016-10-27 10:04:47 -07001163 }
1164 }
1165
Narayan Kamathbd863722017-06-01 18:50:12 +01001166 // Add a specific message for the first ANR Dump.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001167 if (ds.anr_data_.size() > 0) {
Chris Morin5a50d482022-02-01 17:41:18 -08001168 // The "last" ANR will always be present in the body of the main entry.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001169 AddDumps(ds.anr_data_.begin(), ds.anr_data_.begin() + 1,
Chris Morin5a50d482022-02-01 17:41:18 -08001170 "VM TRACES AT LAST ANR", false /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001171
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001172 // Historical ANRs are always included as separate entries in the bugreport zip file.
Chris Morin5a50d482022-02-01 17:41:18 -08001173 AddDumps(ds.anr_data_.begin(), ds.anr_data_.end(),
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001174 "HISTORICAL ANR", true /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001175 } else {
Narayan Kamath8f788292017-05-25 13:20:39 +01001176 printf("*** NO ANRs to dump in %s\n\n", ANR_DIR.c_str());
1177 }
1178}
1179
1180static void AddAnrTraceFiles() {
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001181 std::string anr_traces_dir = "/data/anr";
Narayan Kamath8f788292017-05-25 13:20:39 +01001182
Chris Morin5a50d482022-02-01 17:41:18 -08001183 AddAnrTraceDir(anr_traces_dir);
Narayan Kamath8f788292017-05-25 13:20:39 +01001184
Makoto Onuki83ec63f2019-01-31 17:08:59 -08001185 RunCommand("ANR FILES", {"ls", "-lt", ANR_DIR});
1186
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001187 // Slow traces for slow operations.
Felipe Lemee184f662016-10-27 10:04:47 -07001188 struct stat st;
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001189 int i = 0;
1190 while (true) {
1191 const std::string slow_trace_path =
1192 anr_traces_dir + android::base::StringPrintf("slow%02d.txt", i);
1193 if (stat(slow_trace_path.c_str(), &st)) {
1194 // No traces file at this index, done with the files.
1195 break;
Felipe Lemee184f662016-10-27 10:04:47 -07001196 }
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001197 ds.DumpFile("VM TRACES WHEN SLOW", slow_trace_path.c_str());
1198 i++;
Felipe Lemee184f662016-10-27 10:04:47 -07001199 }
1200}
1201
Wei Wang509bb5d2017-06-09 14:42:12 -07001202static void DumpBlockStatFiles() {
1203 DurationReporter duration_reporter("DUMP BLOCK STAT");
Wei Wang509bb5d2017-06-09 14:42:12 -07001204
Wei Wang1dc1ef52017-06-12 11:28:37 -07001205 std::unique_ptr<DIR, std::function<int(DIR*)>> dirptr(opendir(BLK_DEV_SYS_DIR), closedir);
1206
1207 if (dirptr == nullptr) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001208 MYLOGE("Failed to open %s: %s\n", BLK_DEV_SYS_DIR, strerror(errno));
1209 return;
1210 }
1211
1212 printf("------ DUMP BLOCK STAT ------\n\n");
Wei Wang1dc1ef52017-06-12 11:28:37 -07001213 while (struct dirent *d = readdir(dirptr.get())) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001214 if ((d->d_name[0] == '.')
1215 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
1216 || (d->d_name[1] == '\0'))) {
1217 continue;
1218 }
1219 const std::string new_path =
1220 android::base::StringPrintf("%s/%s", BLK_DEV_SYS_DIR, d->d_name);
1221 printf("------ BLOCK STAT (%s) ------\n", new_path.c_str());
1222 dump_files("", new_path.c_str(), skip_not_stat, dump_stat_from_fd);
1223 printf("\n");
1224 }
Wei Wang1dc1ef52017-06-12 11:28:37 -07001225 return;
Wei Wang509bb5d2017-06-09 14:42:12 -07001226}
Jayachandran Ca94c7172017-06-10 15:08:12 -07001227
1228static void DumpPacketStats() {
1229 DumpFile("NETWORK DEV INFO", "/proc/net/dev");
Jayachandran Ca94c7172017-06-10 15:08:12 -07001230}
1231
1232static void DumpIpAddrAndRules() {
1233 /* The following have a tendency to get wedged when wifi drivers/fw goes belly-up. */
1234 RunCommand("NETWORK INTERFACES", {"ip", "link"});
1235 RunCommand("IPv4 ADDRESSES", {"ip", "-4", "addr", "show"});
1236 RunCommand("IPv6 ADDRESSES", {"ip", "-6", "addr", "show"});
1237 RunCommand("IP RULES", {"ip", "rule", "show"});
1238 RunCommand("IP RULES v6", {"ip", "-6", "rule", "show"});
1239}
1240
Nandana Dutt5c390032019-03-12 10:52:56 +00001241static Dumpstate::RunStatus RunDumpsysTextByPriority(const std::string& title, int priority,
1242 std::chrono::milliseconds timeout,
1243 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001244 auto start = std::chrono::steady_clock::now();
Vishnu Naire97d6122018-01-18 13:58:56 -08001245 sp<android::IServiceManager> sm = defaultServiceManager();
1246 Dumpsys dumpsys(sm.get());
Vishnu Naire97d6122018-01-18 13:58:56 -08001247 Vector<String16> args;
1248 Dumpsys::setServiceArgs(args, /* asProto = */ false, priority);
Vishnu Naire97d6122018-01-18 13:58:56 -08001249 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ false);
1250 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001251 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001252 std::string path(title);
1253 path.append(" - ").append(String8(service).c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -08001254 size_t bytes_written = 0;
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001255 if (PropertiesHelper::IsDryRun()) {
1256 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1257 dumpsys.writeDumpFooter(STDOUT_FILENO, service, std::chrono::milliseconds(1));
1258 } else {
Devin Mooref492c1a2023-03-15 19:19:03 +00001259 status_t status = dumpsys.startDumpThread(Dumpsys::TYPE_DUMP | Dumpsys::TYPE_PID |
1260 Dumpsys::TYPE_CLIENTS | Dumpsys::TYPE_THREAD,
Devin Mooreae68df22023-02-24 20:59:51 +00001261 service, args);
1262 if (status == OK) {
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001263 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1264 std::chrono::duration<double> elapsed_seconds;
1265 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH &&
1266 service == String16("meminfo")) {
1267 // Use a longer timeout for meminfo, since 30s is not always enough.
1268 status = dumpsys.writeDump(STDOUT_FILENO, service, 60s,
1269 /* as_proto = */ false, elapsed_seconds,
1270 bytes_written);
1271 } else {
1272 status = dumpsys.writeDump(STDOUT_FILENO, service, service_timeout,
1273 /* as_proto = */ false, elapsed_seconds,
1274 bytes_written);
1275 }
1276 dumpsys.writeDumpFooter(STDOUT_FILENO, service, elapsed_seconds);
1277 bool dump_complete = (status == OK);
1278 dumpsys.stopDumpThread(dump_complete);
Devin Moorecdfa4602023-03-16 20:49:39 +00001279 } else {
1280 MYLOGE("Failed to start dump thread for service: %s, status: %d",
1281 String8(service).c_str(), status);
Gavin Corkeryfac7e2b2021-07-08 22:39:02 +01001282 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001283 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001284
1285 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1286 std::chrono::steady_clock::now() - start);
1287 if (elapsed_duration > timeout) {
1288 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1289 elapsed_duration.count());
1290 break;
1291 }
1292 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001293 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001294}
1295
Vishnu Nair64afc022018-02-01 15:29:34 -08001296static void RunDumpsysText(const std::string& title, int priority,
1297 std::chrono::milliseconds timeout,
1298 std::chrono::milliseconds service_timeout) {
1299 DurationReporter duration_reporter(title);
1300 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1301 fsync(STDOUT_FILENO);
1302 RunDumpsysTextByPriority(title, priority, timeout, service_timeout);
1303}
1304
1305/* Dump all services registered with Normal or Default priority. */
Nandana Dutt5c390032019-03-12 10:52:56 +00001306static Dumpstate::RunStatus RunDumpsysTextNormalPriority(const std::string& title,
1307 std::chrono::milliseconds timeout,
1308 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001309 DurationReporter duration_reporter(title);
1310 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1311 fsync(STDOUT_FILENO);
1312 RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_NORMAL, timeout,
1313 service_timeout);
Nandana Dutt5c390032019-03-12 10:52:56 +00001314
1315 RETURN_IF_USER_DENIED_CONSENT();
1316
1317 return RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_DEFAULT, timeout,
1318 service_timeout);
Vishnu Nair64afc022018-02-01 15:29:34 -08001319}
1320
Nandana Dutt5c390032019-03-12 10:52:56 +00001321static Dumpstate::RunStatus RunDumpsysProto(const std::string& title, int priority,
1322 std::chrono::milliseconds timeout,
1323 std::chrono::milliseconds service_timeout) {
Vishnu Naire97d6122018-01-18 13:58:56 -08001324 sp<android::IServiceManager> sm = defaultServiceManager();
1325 Dumpsys dumpsys(sm.get());
1326 Vector<String16> args;
1327 Dumpsys::setServiceArgs(args, /* asProto = */ true, priority);
1328 DurationReporter duration_reporter(title);
1329
1330 auto start = std::chrono::steady_clock::now();
1331 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ true);
1332 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001333 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001334 std::string path(kProtoPath);
1335 path.append(String8(service).c_str());
1336 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL) {
1337 path.append("_CRITICAL");
1338 } else if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH) {
1339 path.append("_HIGH");
1340 }
1341 path.append(kProtoExt);
Steven Morelandcbd69fc2021-07-20 20:45:43 +00001342 status_t status = dumpsys.startDumpThread(Dumpsys::TYPE_DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001343 if (status == OK) {
1344 status = ds.AddZipEntryFromFd(path, dumpsys.getDumpFd(), service_timeout);
1345 bool dumpTerminated = (status == OK);
1346 dumpsys.stopDumpThread(dumpTerminated);
1347 }
1348 ZipWriter::FileEntry file_entry;
1349 ds.zip_writer_->GetLastEntry(&file_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -08001350
1351 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1352 std::chrono::steady_clock::now() - start);
1353 if (elapsed_duration > timeout) {
1354 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1355 elapsed_duration.count());
1356 break;
1357 }
1358 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001359 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001360}
1361
Nandana Dutta7db6342018-11-21 14:53:34 +00001362// Runs dumpsys on services that must dump first and will take less than 100ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001363static Dumpstate::RunStatus RunDumpsysCritical() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001364 RunDumpsysText("DUMPSYS CRITICAL", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1365 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Nandana Dutt5c390032019-03-12 10:52:56 +00001366
1367 RETURN_IF_USER_DENIED_CONSENT();
1368
1369 return RunDumpsysProto("DUMPSYS CRITICAL PROTO", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1370 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Vishnu Nair780b1282017-10-10 13:57:24 -07001371}
1372
1373// Runs dumpsys on services that must dump first but can take up to 250ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001374static Dumpstate::RunStatus RunDumpsysHigh() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001375 // TODO meminfo takes ~10s, connectivity takes ~5sec to dump. They are both
1376 // high priority. Reduce timeout once they are able to dump in a shorter time or
1377 // moved to a parallel task.
1378 RunDumpsysText("DUMPSYS HIGH", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1379 /* timeout= */ 90s, /* service_timeout= */ 30s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001380
1381 RETURN_IF_USER_DENIED_CONSENT();
1382
1383 return RunDumpsysProto("DUMPSYS HIGH PROTO", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1384 /* timeout= */ 5s, /* service_timeout= */ 1s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001385}
1386
1387// Runs dumpsys on services that must dump but can take up to 10s to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001388static Dumpstate::RunStatus RunDumpsysNormal() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001389 RunDumpsysTextNormalPriority("DUMPSYS", /* timeout= */ 90s, /* service_timeout= */ 10s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001390
1391 RETURN_IF_USER_DENIED_CONSENT();
1392
1393 return RunDumpsysProto("DUMPSYS PROTO", IServiceManager::DUMP_FLAG_PRIORITY_NORMAL,
1394 /* timeout= */ 90s, /* service_timeout= */ 10s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001395}
1396
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001397/*
1398 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1399 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1400 * if it's not running in the parallel task.
1401 */
1402static void DumpHals(int out_fd = STDOUT_FILENO) {
Yifan Hong30528a22020-08-07 18:24:06 -07001403 RunCommand("HARDWARE HALS", {"lshal", "--all", "--types=all"},
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001404 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build(),
1405 false, out_fd);
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001406
Steven Moreland44cd9482018-01-04 16:24:13 -08001407 using android::hidl::manager::V1_0::IServiceManager;
1408 using android::hardware::defaultServiceManager;
1409
1410 sp<IServiceManager> sm = defaultServiceManager();
1411 if (sm == nullptr) {
1412 MYLOGE("Could not retrieve hwservicemanager to dump hals.\n");
1413 return;
1414 }
1415
1416 auto ret = sm->list([&](const auto& interfaces) {
1417 for (const std::string& interface : interfaces) {
1418 std::string cleanName = interface;
1419 std::replace_if(cleanName.begin(),
1420 cleanName.end(),
1421 [](char c) {
1422 return !isalnum(c) &&
1423 std::string("@-_:.").find(c) == std::string::npos;
1424 }, '_');
Nandana Dutt979388e2018-11-30 16:48:55 +00001425 const std::string path = ds.bugreport_internal_dir_ + "/lshal_debug_" + cleanName;
Steven Moreland44cd9482018-01-04 16:24:13 -08001426
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001427 bool empty = false;
Steven Moreland44cd9482018-01-04 16:24:13 -08001428 {
1429 auto fd = android::base::unique_fd(
1430 TEMP_FAILURE_RETRY(open(path.c_str(),
1431 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1432 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1433 if (fd < 0) {
1434 MYLOGE("Could not open %s to dump additional hal information.\n", path.c_str());
1435 continue;
1436 }
1437 RunCommandToFd(fd,
1438 "",
Steven Morelandc81cd3c2018-01-18 14:36:26 -08001439 {"lshal", "debug", "-E", interface},
Steven Moreland44cd9482018-01-04 16:24:13 -08001440 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
1441
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001442 empty = 0 == lseek(fd, 0, SEEK_END);
Steven Moreland44cd9482018-01-04 16:24:13 -08001443 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001444 if (!empty) {
1445 ds.EnqueueAddZipEntryAndCleanupIfNeeded("lshal-debug/" + cleanName + ".txt",
1446 path);
1447 } else {
1448 unlink(path.c_str());
1449 }
Steven Moreland44cd9482018-01-04 16:24:13 -08001450 }
1451 });
1452
1453 if (!ret.isOk()) {
1454 MYLOGE("Could not list hals from hwservicemanager.\n");
1455 }
1456}
1457
Devin Moore8df81bb2022-06-08 22:47:02 +00001458// Dump all of the files that make up the vendor interface.
1459// See the files listed in dumpFileList() for the latest list of files.
1460static void DumpVintf() {
Devin Moore16271d92022-09-22 18:28:48 +00001461
1462 const std::string sku = android::base::GetProperty("ro.boot.product.hardware.sku", "");
1463 const auto vintfFiles = android::vintf::details::dumpFileList(sku);
Devin Moore8df81bb2022-06-08 22:47:02 +00001464 for (const auto vintfFile : vintfFiles) {
1465 struct stat st;
1466 if (stat(vintfFile.c_str(), &st) == 0) {
1467 if (S_ISDIR(st.st_mode)) {
1468 ds.AddDir(vintfFile, true /* recursive */);
1469 } else {
1470 ds.EnqueueAddZipEntryAndCleanupIfNeeded(ZIP_ROOT_DIR + vintfFile,
1471 vintfFile);
1472 }
1473 }
1474 }
1475}
1476
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001477static void DumpExternalFragmentationInfo() {
1478 struct stat st;
1479 if (stat("/proc/buddyinfo", &st) != 0) {
1480 MYLOGE("Unable to dump external fragmentation info\n");
1481 return;
1482 }
1483
1484 printf("------ EXTERNAL FRAGMENTATION INFO ------\n");
1485 std::ifstream ifs("/proc/buddyinfo");
1486 auto unusable_index_regex = std::regex{"Node\\s+([0-9]+),\\s+zone\\s+(\\S+)\\s+(.*)"};
1487 for (std::string line; std::getline(ifs, line);) {
1488 std::smatch match_results;
1489 if (std::regex_match(line, match_results, unusable_index_regex)) {
1490 std::stringstream free_pages(std::string{match_results[3]});
1491 std::vector<int> free_pages_per_order(std::istream_iterator<int>{free_pages},
1492 std::istream_iterator<int>());
1493
1494 int total_free_pages = 0;
1495 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1496 total_free_pages += (free_pages_per_order[i] * std::pow(2, i));
1497 }
1498
1499 printf("Node %s, zone %8s", match_results[1].str().c_str(),
1500 match_results[2].str().c_str());
1501
1502 int usable_free_pages = total_free_pages;
1503 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1504 auto unusable_index = (total_free_pages - usable_free_pages) /
1505 static_cast<double>(total_free_pages);
1506 printf(" %5.3f", unusable_index);
1507 usable_free_pages -= (free_pages_per_order[i] * std::pow(2, i));
1508 }
1509
1510 printf("\n");
1511 }
1512 }
1513 printf("\n");
1514}
1515
mhasankd451a472020-05-26 18:02:39 -07001516static void DumpstateLimitedOnly() {
1517 // Trimmed-down version of dumpstate to only include a whitelisted
1518 // set of logs (system log, event log, and system server / system app
1519 // crashes, and networking logs). See b/136273873 and b/138459828
1520 // for context.
1521 DurationReporter duration_reporter("DUMPSTATE");
1522 unsigned long timeout_ms;
1523 // calculate timeout
1524 timeout_ms = logcat_timeout({"main", "system", "crash"});
1525 RunCommand("SYSTEM LOG",
1526 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1527 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1528 timeout_ms = logcat_timeout({"events"});
1529 RunCommand(
1530 "EVENT LOG",
1531 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1532 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1533
1534 printf("========================================================\n");
1535 printf("== Networking Service\n");
1536 printf("========================================================\n");
1537
1538 RunDumpsys("DUMPSYS NETWORK_SERVICE_LIMITED", {"wifi", "-a"},
1539 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hugo Benichiaa162682020-10-30 23:28:56 +09001540 RunDumpsys("DUMPSYS CONNECTIVITY REQUESTS", {"connectivity", "requests"},
1541 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
mhasankd451a472020-05-26 18:02:39 -07001542
1543 printf("========================================================\n");
1544 printf("== Dropbox crashes\n");
1545 printf("========================================================\n");
1546
1547 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1548 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1549
1550 printf("========================================================\n");
1551 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1552 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1553 printf("========================================================\n");
1554 printf("== dumpstate: done (id %d)\n", ds.id_);
1555 printf("========================================================\n");
1556}
1557
Rhed Jaoe017f982020-07-21 17:58:41 +08001558/*
1559 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1560 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1561 * if it's not running in the parallel task.
1562 */
1563static void DumpCheckins(int out_fd = STDOUT_FILENO) {
1564 dprintf(out_fd, "========================================================\n");
1565 dprintf(out_fd, "== Checkins\n");
1566 dprintf(out_fd, "========================================================\n");
1567
1568 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"}, out_fd);
Rhed Jaoe017f982020-07-21 17:58:41 +08001569 RunDumpsys("CHECKIN NETSTATS", {"netstats", "--checkin"}, out_fd);
1570 RunDumpsys("CHECKIN PROCSTATS", {"procstats", "-c"}, out_fd);
1571 RunDumpsys("CHECKIN USAGESTATS", {"usagestats", "-c"}, out_fd);
1572 RunDumpsys("CHECKIN PACKAGE", {"package", "--checkin"}, out_fd);
1573}
1574
1575/*
1576 * Runs dumpsys on activity service to dump all application activities, services
1577 * and providers in the device.
1578 *
1579 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1580 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1581 * if it's not running in the parallel task.
1582 */
1583static void DumpAppInfos(int out_fd = STDOUT_FILENO) {
1584 dprintf(out_fd, "========================================================\n");
1585 dprintf(out_fd, "== Running Application Activities\n");
1586 dprintf(out_fd, "========================================================\n");
1587
1588 // The following dumpsys internally collects output from running apps, so it can take a long
1589 // time. So let's extend the timeout.
1590
1591 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
1592
1593 RunDumpsys("APP ACTIVITIES", {"activity", "-v", "all"}, DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1594
1595 dprintf(out_fd, "========================================================\n");
1596 dprintf(out_fd, "== Running Application Services (platform)\n");
1597 dprintf(out_fd, "========================================================\n");
1598
1599 RunDumpsys("APP SERVICES PLATFORM", {"activity", "service", "all-platform-non-critical"},
1600 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1601
1602 dprintf(out_fd, "========================================================\n");
1603 dprintf(out_fd, "== Running Application Services (non-platform)\n");
1604 dprintf(out_fd, "========================================================\n");
1605
1606 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1607 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1608
1609 dprintf(out_fd, "========================================================\n");
1610 dprintf(out_fd, "== Running Application Providers (platform)\n");
1611 dprintf(out_fd, "========================================================\n");
1612
1613 RunDumpsys("APP PROVIDERS PLATFORM", {"activity", "provider", "all-platform"},
Rhed Jaob049f182021-01-11 21:08:43 +08001614 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
Rhed Jaoe017f982020-07-21 17:58:41 +08001615
1616 dprintf(out_fd, "========================================================\n");
1617 dprintf(out_fd, "== Running Application Providers (non-platform)\n");
1618 dprintf(out_fd, "========================================================\n");
1619
1620 RunDumpsys("APP PROVIDERS NON-PLATFORM", {"activity", "provider", "all-non-platform"},
1621 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1622}
1623
Nandana Dutt5c390032019-03-12 10:52:56 +00001624// Dumps various things. Returns early with status USER_CONSENT_DENIED if user denies consent
1625// via the consent they are shown. Ignores other errors that occur while running various
1626// commands. The consent checking is currently done around long running tasks, which happen to
1627// be distributed fairly evenly throughout the function.
Kean Mariotti306633e2022-09-05 16:30:47 +00001628Dumpstate::RunStatus Dumpstate::dumpstate() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001629 DurationReporter duration_reporter("DUMPSTATE");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001630
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001631 // Enqueue slow functions into the thread pool, if the parallel run is enabled.
Aaron Huang24d215d2022-04-27 18:51:16 +08001632 std::future<std::string> dump_hals, dump_incident_report, dump_board, dump_checkins,
Kean Mariotti306633e2022-09-05 16:30:47 +00001633 dump_netstats_report, post_process_ui_traces;
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001634 if (ds.dump_pool_) {
1635 // Pool was shutdown in DumpstateDefaultAfterCritical method in order to
Kean Mariotti306633e2022-09-05 16:30:47 +00001636 // drop root user. Restarts it.
1637 ds.dump_pool_->start(/* thread_counts = */3);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001638
Chris Morinbc223142022-02-04 14:17:11 -08001639 dump_hals = ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
1640 dump_incident_report = ds.dump_pool_->enqueueTask(
1641 DUMP_INCIDENT_REPORT_TASK, &DumpIncidentReport);
Aaron Huang24d215d2022-04-27 18:51:16 +08001642 dump_netstats_report = ds.dump_pool_->enqueueTask(
1643 DUMP_NETSTATS_PROTO_TASK, &DumpNetstatsProto);
Chris Morinbc223142022-02-04 14:17:11 -08001644 dump_board = ds.dump_pool_->enqueueTaskWithFd(
1645 DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
1646 dump_checkins = ds.dump_pool_->enqueueTaskWithFd(DUMP_CHECKINS_TASK, &DumpCheckins, _1);
Kean Mariotti306633e2022-09-05 16:30:47 +00001647 post_process_ui_traces = ds.dump_pool_->enqueueTask(
1648 POST_PROCESS_UI_TRACES_TASK, &Dumpstate::MaybePostProcessUiTraces, &ds);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001649 }
1650
Nandana Dutt5c390032019-03-12 10:52:56 +00001651 // Dump various things. Note that anything that takes "long" (i.e. several seconds) should
1652 // check intermittently (if it's intrerruptable like a foreach on pids) and/or should be wrapped
1653 // in a consent check (via RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK).
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -07001654 dump_dev_files("TRUSTY VERSION", "/sys/bus/platform/drivers/trusty", "trusty_version");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001655 RunCommand("UPTIME", {"uptime"});
Wei Wang509bb5d2017-06-09 14:42:12 -07001656 DumpBlockStatFiles();
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001657 DumpFile("MEMORY INFO", "/proc/meminfo");
1658 RunCommand("CPU INFO", {"top", "-b", "-n", "1", "-H", "-s", "6", "-o",
Felipe Leme30dbfa12016-09-02 12:43:26 -07001659 "pid,tid,user,pr,ni,%cpu,s,virt,res,pcy,cmd,name"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001660
Kevin Jeon947922b2022-09-21 00:29:18 +00001661 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "BUGREPORT_PROCDUMP", {"bugreport_procdump"},
1662 CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001663
Sunny Goyal35949782019-11-19 15:54:36 -08001664 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpVisibleWindowViews);
1665
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001666 DumpFile("VIRTUAL MEMORY STATS", "/proc/vmstat");
1667 DumpFile("VMALLOC INFO", "/proc/vmallocinfo");
1668 DumpFile("SLAB INFO", "/proc/slabinfo");
1669 DumpFile("ZONEINFO", "/proc/zoneinfo");
1670 DumpFile("PAGETYPEINFO", "/proc/pagetypeinfo");
1671 DumpFile("BUDDYINFO", "/proc/buddyinfo");
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001672 DumpExternalFragmentationInfo();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001673
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001674 DumpFile("KERNEL CPUFREQ", "/sys/devices/system/cpu/cpu0/cpufreq/stats/time_in_state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001675
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001676 RunCommand("PROCESSES AND THREADS",
Yohei Yukawa591a72d2017-10-05 21:36:35 -07001677 {"ps", "-A", "-T", "-Z", "-O", "pri,nice,rtprio,sched,pcy,time"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001678
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001679 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001680 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_hals));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001681 } else {
1682 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_HALS_TASK, DumpHals);
1683 }
Steven Moreland81b429e2017-01-31 19:50:46 -08001684
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001685 RunCommand("PRINTENV", {"printenv"});
Elliott Hughes21b7c8d2016-10-28 08:53:02 -07001686 RunCommand("NETSTAT", {"netstat", "-nW"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001687 struct stat s;
1688 if (stat("/proc/modules", &s) != 0) {
1689 MYLOGD("Skipping 'lsmod' because /proc/modules does not exist\n");
1690 } else {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001691 RunCommand("LSMOD", {"lsmod"});
Woody Linc198f252021-05-04 16:37:11 +08001692 RunCommand("MODULES INFO",
1693 {"sh", "-c", "cat /proc/modules | cut -d' ' -f1 | "
1694 " while read MOD ; do echo modinfo:$MOD ; modinfo $MOD ; "
1695 "done"}, CommandOptions::AS_ROOT);
Felipe Lemee4eca582016-06-10 17:48:08 -07001696 }
Michal Karpinski4db754f2015-12-11 18:04:32 +00001697
Tom Cherryb87dbfa2020-07-28 11:28:53 -07001698 if (android::base::GetBoolProperty("ro.logd.kernel", false)) {
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001699 DoKernelLogcat();
1700 } else {
1701 do_dmesg();
1702 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001703
Devin Moore8df81bb2022-06-08 22:47:02 +00001704 DumpVintf();
1705
Felipe Lemef0292972016-11-22 13:57:05 -08001706 RunCommand("LIST OF OPEN FILES", {"lsof"}, CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001707
Jeff Brown1dc94e32014-09-11 14:15:27 -07001708 for_each_tid(show_wchan, "BLOCKED PROCESS WAIT-CHANNELS");
Mark Salyzyna297c322016-02-05 15:33:17 -08001709 for_each_pid(show_showtime, "PROCESS TIMES (pid cmd user system iowait+percentage)");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001710
Jack Yu5a6b2e22020-08-14 18:13:35 +08001711 /* Dump Nfc NCI logs */
1712 ds.AddDir("/data/misc/nfc/logs", true);
Ajay Panickerd886ec42016-09-14 12:26:46 -07001713
Paul Chang0d2aad72020-02-13 20:04:03 +08001714 if (ds.options_->do_screenshot && !ds.do_early_screenshot_) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001715 MYLOGI("taking late screenshot\n");
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001716 ds.TakeScreenshot();
Jeff Sharkey5a930032013-03-19 15:05:19 -07001717 }
1718
Felipe Lemee184f662016-10-27 10:04:47 -07001719 AddAnrTraceFiles();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001720
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001721 MaybeAddSystemTraceToZip();
1722
Narayan Kamath8f788292017-05-25 13:20:39 +01001723 // NOTE: tombstones are always added as separate entries in the zip archive
1724 // and are not interspersed with the main report.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001725 const bool tombstones_dumped = AddDumps(ds.tombstone_data_.begin(), ds.tombstone_data_.end(),
Narayan Kamathbd863722017-06-01 18:50:12 +01001726 "TOMBSTONE", true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001727 if (!tombstones_dumped) {
1728 printf("*** NO TOMBSTONES to dump in %s\n\n", TOMBSTONE_DIR.c_str());
Christopher Ferris7dc7f322014-07-22 16:08:19 -07001729 }
1730
Jayachandran Ca94c7172017-06-10 15:08:12 -07001731 DumpPacketStats();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001732
Lorenzo Colitti807f2dd2022-05-27 12:48:37 +09001733 RunDumpsys("EBPF MAP STATS", {"connectivity", "trafficcontroller"});
Chenbo Feng276a3b62018-08-07 11:44:49 -07001734
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001735 DoKmsg();
Mark Salyzyn2262c162014-12-16 09:09:26 -08001736
Woody Lin20767a92022-11-29 15:50:24 +08001737 DumpShutdownCheckpoints();
1738
Jayachandran Ca94c7172017-06-10 15:08:12 -07001739 DumpIpAddrAndRules();
Sreeram Ramachandran2b3bba32014-07-08 15:40:55 -07001740
1741 dump_route_tables();
1742
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001743 RunCommand("ARP CACHE", {"ip", "-4", "neigh", "show"});
1744 RunCommand("IPv6 ND CACHE", {"ip", "-6", "neigh", "show"});
1745 RunCommand("MULTICAST ADDRESSES", {"ip", "maddr"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001746
Nandana Dutt5c390032019-03-12 10:52:56 +00001747 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysHigh);
Lorenzo Colitti6afc38c2015-09-09 22:59:25 +09001748
Chiachang Wang668ede42021-05-17 17:14:20 +08001749 // The dump mechanism in connectivity is refactored due to modularization work. Connectivity can
1750 // only register with a default priority(NORMAL priority). Dumpstate has to call connectivity
1751 // dump with priority parameters to dump high priority information.
1752 RunDumpsys("SERVICE HIGH connectivity", {"connectivity", "--dump-priority", "HIGH"},
1753 CommandOptions::WithTimeout(10).Build());
1754
Elliott Hughes23ccc622017-02-28 10:14:22 -08001755 RunCommand("SYSTEM PROPERTIES", {"getprop"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001756
Jin Qianf334d662017-10-10 14:41:37 -07001757 RunCommand("STORAGED IO INFO", {"storaged", "-u", "-p"});
ynwangf649a6e2016-07-17 21:56:00 -07001758
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001759 RunCommand("FILESYSTEMS & FREE SPACE", {"df"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001760
Colin Crossf45fa6b2012-03-26 12:38:26 -07001761 /* Binder state is expensive to look at as it uses a lot of memory. */
Hridya Valsaraju920ba712020-02-09 16:27:01 -08001762 std::string binder_logs_dir = access("/dev/binderfs/binder_logs", R_OK) ?
1763 "/sys/kernel/debug/binder" : "/dev/binderfs/binder_logs";
1764
1765 DumpFile("BINDER FAILED TRANSACTION LOG", binder_logs_dir + "/failed_transaction_log");
1766 DumpFile("BINDER TRANSACTION LOG", binder_logs_dir + "/transaction_log");
1767 DumpFile("BINDER TRANSACTIONS", binder_logs_dir + "/transactions");
1768 DumpFile("BINDER STATS", binder_logs_dir + "/stats");
1769 DumpFile("BINDER STATE", binder_logs_dir + "/state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001770
Yifan Hongd90cc652020-02-08 16:52:02 -08001771 ds.AddDir(SNAPSHOTCTL_LOG_DIR, false);
1772
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001773 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001774 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_board));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001775 } else {
1776 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
1777 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001778
Steven Moreland7440ddb2016-12-15 16:13:39 -08001779 /* Migrate the ril_dumpstate to a device specific dumpstate? */
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001780 int rilDumpstateTimeout = android::base::GetIntProperty("ril.dumpstate.timeout", 0);
1781 if (rilDumpstateTimeout > 0) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001782 // su does not exist on user builds, so try running without it.
1783 // This way any implementations of vril-dump that do not require
1784 // root can run on user builds.
1785 CommandOptions::CommandOptionsBuilder options =
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001786 CommandOptions::WithTimeout(rilDumpstateTimeout);
Felipe Lemef0292972016-11-22 13:57:05 -08001787 if (!PropertiesHelper::IsUserBuild()) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001788 options.AsRoot();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001789 }
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001790 RunCommand("DUMP VENDOR RIL LOGS", {"vril-dump"}, options.Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -07001791 }
1792
Felipe Lemed8b94e52016-12-08 10:21:44 -08001793 printf("========================================================\n");
1794 printf("== Android Framework Services\n");
1795 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001796
Nandana Dutt5c390032019-03-12 10:52:56 +00001797 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysNormal);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001798
Jack He91ff2fe2021-02-18 18:23:43 -08001799 /* Dump Bluetooth HCI logs after getting bluetooth_manager dumpsys */
1800 ds.AddDir("/data/misc/bluetooth/logs", true);
1801
Rhed Jaoe017f982020-07-21 17:58:41 +08001802 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001803 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_checkins));
Rhed Jaoe017f982020-07-21 17:58:41 +08001804 } else {
1805 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_CHECKINS_TASK, DumpCheckins);
1806 }
Dianne Hackborn02bea972013-06-26 18:59:09 -07001807
Rhed Jaoc5f7ec32020-12-22 22:11:08 +08001808 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpAppInfos);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001809
Adrian Roos8b397ab2017-04-04 16:35:44 -07001810 printf("========================================================\n");
1811 printf("== Dropbox crashes\n");
1812 printf("========================================================\n");
1813
1814 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1815 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1816
Felipe Lemed8b94e52016-12-08 10:21:44 -08001817 printf("========================================================\n");
1818 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1819 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1820 printf("========================================================\n");
1821 printf("== dumpstate: done (id %d)\n", ds.id_);
1822 printf("========================================================\n");
Bookatz38472142018-09-28 10:20:24 -07001823
1824 printf("========================================================\n");
1825 printf("== Obtaining statsd metadata\n");
1826 printf("========================================================\n");
1827 // This differs from the usual dumpsys stats, which is the stats report data.
1828 RunDumpsys("STATSDSTATS", {"stats", "--metadata"});
Mike Ma5c267872019-08-21 11:31:34 -07001829
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +09001830 // Add linker configuration directory
1831 ds.AddDir(LINKERCONFIG_DIR, true);
1832
Li Li830179f2022-01-04 12:53:29 -08001833 /* Dump frozen cgroupfs */
1834 dump_frozen_cgroupfs();
Li Li2eedd412021-06-30 15:11:53 -07001835
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001836 if (ds.dump_pool_) {
Aaron Huang24d215d2022-04-27 18:51:16 +08001837 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_netstats_report));
1838 } else {
1839 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_NETSTATS_PROTO_TASK,
1840 DumpNetstatsProto);
1841 }
1842
1843 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001844 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_incident_report));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001845 } else {
1846 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_INCIDENT_REPORT_TASK,
1847 DumpIncidentReport);
1848 }
Mike Ma5c267872019-08-21 11:31:34 -07001849
Kean Mariotti306633e2022-09-05 16:30:47 +00001850 if (ds.dump_pool_) {
1851 WaitForTask(std::move(post_process_ui_traces));
1852 } else {
1853 RUN_SLOW_FUNCTION_AND_LOG(POST_PROCESS_UI_TRACES_TASK, MaybePostProcessUiTraces);
1854 }
1855
1856 MaybeAddUiTracesToZip();
1857
Nandana Dutt5c390032019-03-12 10:52:56 +00001858 return Dumpstate::RunStatus::OK;
Colin Crossf45fa6b2012-03-26 12:38:26 -07001859}
1860
Nandana Dutt5c390032019-03-12 10:52:56 +00001861/*
1862 * Dumps state for the default case; drops root after it's no longer necessary.
1863 *
1864 * Returns RunStatus::OK if everything went fine.
1865 * Returns RunStatus::ERROR if there was an error.
1866 * Returns RunStatus::USER_DENIED_CONSENT if user explicitly denied consent to sharing the bugreport
1867 * with the caller.
1868 */
Jichao Lie89d9c12019-11-21 19:02:51 -08001869Dumpstate::RunStatus Dumpstate::DumpstateDefaultAfterCritical() {
Nandana Duttdb379fa2019-10-09 16:54:41 +01001870 // Capture first logcat early on; useful to take a snapshot before dumpstate logs take over the
1871 // buffer.
1872 DoLogcat();
1873 // Capture timestamp after first logcat to use in next logcat
1874 time_t logcat_ts = time(nullptr);
1875
Nandana Dutt4be45d12018-09-26 15:04:23 +01001876 /* collect stack traces from Dalvik and native processes (needs root) */
Chris Morinbc223142022-02-04 14:17:11 -08001877 std::future<std::string> dump_traces;
Rhed Jao5377d792020-07-16 17:37:39 +08001878 if (dump_pool_) {
1879 RETURN_IF_USER_DENIED_CONSENT();
1880 // One thread is enough since we only need to enqueue DumpTraces here.
1881 dump_pool_->start(/* thread_counts = */1);
1882
1883 // DumpTraces takes long time, post it to the another thread in the
1884 // pool, if pool is available
Chris Morinbc223142022-02-04 14:17:11 -08001885 dump_traces = dump_pool_->enqueueTask(
1886 DUMP_TRACES_TASK, &Dumpstate::DumpTraces, &ds, &dump_traces_path);
Rhed Jao5377d792020-07-16 17:37:39 +08001887 } else {
1888 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_TRACES_TASK, ds.DumpTraces,
1889 &dump_traces_path);
1890 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001891
1892 /* Run some operations that require root. */
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001893 if (!PropertiesHelper::IsDryRun()) {
Chris Morinc2cba7a2022-02-01 17:06:50 -08001894 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX);
1895 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX);
Woody Lin20767a92022-11-29 15:50:24 +08001896 ds.shutdown_checkpoints_ = GetDumpFds(
1897 SHUTDOWN_CHECKPOINTS_DIR, SHUTDOWN_CHECKPOINTS_FILE_PREFIX);
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001898 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001899
1900 ds.AddDir(RECOVERY_DIR, true);
1901 ds.AddDir(RECOVERY_DATA_DIR, true);
1902 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
Kelvin Zhang6eaa0f92022-09-12 09:29:19 -07001903 ds.AddDir(UPDATE_ENGINE_PREF_DIR, true);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001904 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1905 if (!PropertiesHelper::IsUserBuild()) {
1906 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1907 ds.AddDir(PROFILE_DATA_DIR_REF, true);
Calin Juravlef84d3692020-04-28 15:31:12 -07001908 ds.AddZipEntry(ZIP_ROOT_DIR + PACKAGE_DEX_USE_LIST, PACKAGE_DEX_USE_LIST);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001909 }
Jerry Changa1df8a92020-01-02 16:03:39 +08001910 ds.AddDir(PREREBOOT_DATA_DIR, false);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001911 add_mountinfo();
Peter Collingbourne78aa2942023-02-15 14:50:31 -08001912 for (const char* path : {"/proc/cpuinfo", "/proc/meminfo"}) {
1913 ds.AddZipEntry(ZIP_ROOT_DIR + path, path);
1914 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001915 DumpIpTablesAsRoot();
David Andersond9ba4752018-12-11 18:26:59 -08001916 DumpDynamicPartitionInfo();
Yifan Hong3945e1b2019-10-29 12:59:23 -07001917 ds.AddDir(OTA_METADATA_DIR, true);
Jeff Sharkey9df29d52023-02-06 14:26:30 -07001918 if (!PropertiesHelper::IsUserBuild()) {
1919 // Include dropbox entry files inside ZIP, but exclude
1920 // noisy WTF and StrictMode entries
1921 dump_files("", DROPBOX_DIR, skip_wtf_strictmode, _add_file_from_fd);
1922 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001923
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001924 // Capture any IPSec policies in play. No keys are exposed here.
Nandana Dutt4be45d12018-09-26 15:04:23 +01001925 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1926
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001927 // Dump IPsec stats. No keys are exposed here.
1928 DumpFile("XFRM STATS", XFRM_STAT_PROC_FILE);
1929
Nandana Dutt4be45d12018-09-26 15:04:23 +01001930 // Run ss as root so we can see socket marks.
1931 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
1932
1933 // Run iotop as root to show top 100 IO threads
1934 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
1935
Erick Reyese68df822019-02-11 14:46:36 -08001936 // Gather shared memory buffer info if the product implements it
Hridya Valsaraju1da80c52021-01-09 22:10:11 -08001937 RunCommand("Dmabuf dump", {"dmabuf_dump"});
1938 RunCommand("Dmabuf per-buffer/per-exporter/per-device stats", {"dmabuf_dump", "-b"});
Erick Reyese68df822019-02-11 14:46:36 -08001939
Minchan Kim22c6a1e2019-09-30 15:58:10 -07001940 DumpFile("PSI cpu", "/proc/pressure/cpu");
1941 DumpFile("PSI memory", "/proc/pressure/memory");
1942 DumpFile("PSI io", "/proc/pressure/io");
1943
Mårten Kongstad60195a72022-09-20 14:14:20 +02001944 RunCommand("SDK EXTENSIONS", {SDK_EXT_INFO, "--dump"},
1945 CommandOptions::WithTimeout(10).Always().DropRoot().Build());
1946
Rhed Jao5377d792020-07-16 17:37:39 +08001947 if (dump_pool_) {
1948 RETURN_IF_USER_DENIED_CONSENT();
Chris Morinbc223142022-02-04 14:17:11 -08001949 WaitForTask(std::move(dump_traces));
Rhed Jao5377d792020-07-16 17:37:39 +08001950
Chris Morinbc223142022-02-04 14:17:11 -08001951 // Current running thread in the pool is the root user also. Delete
1952 // the pool and make a new one later to ensure none of threads in the pool are root.
1953 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao5377d792020-07-16 17:37:39 +08001954 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001955 if (!DropRootUser()) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001956 return Dumpstate::RunStatus::ERROR;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001957 }
1958
Nandana Dutt5c390032019-03-12 10:52:56 +00001959 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttdb379fa2019-10-09 16:54:41 +01001960 Dumpstate::RunStatus status = dumpstate();
1961 // Capture logcat since the last time we did it.
1962 DoSystemLogcat(logcat_ts);
1963 return status;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001964}
1965
Rhed Jaob5685b32020-08-14 17:19:17 +08001966// Common states for telephony and wifi which are needed to be collected before
1967// dumpstate drop the root user.
1968static void DumpstateRadioAsRoot() {
1969 DumpIpTablesAsRoot();
1970 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1971}
1972
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001973// This method collects common dumpsys for telephony and wifi. Typically, wifi
1974// reports are fine to include all information, but telephony reports on user
1975// builds need to strip some content (see DumpstateTelephonyOnly).
1976static void DumpstateRadioCommon(bool include_sensitive_info = true) {
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001977 // We need to be picky about some stuff for telephony reports on user builds.
1978 if (!include_sensitive_info) {
1979 // Only dump the radio log buffer (other buffers and dumps contain too much unrelated info).
1980 DoRadioLogcat();
1981 } else {
Rhed Jaob5685b32020-08-14 17:19:17 +08001982 // DumpHals takes long time, post it to the another thread in the pool,
1983 // if pool is available.
Chris Morinbc223142022-02-04 14:17:11 -08001984 std::future<std::string> dump_hals;
Rhed Jaob5685b32020-08-14 17:19:17 +08001985 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001986 dump_hals = ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
Rhed Jaob5685b32020-08-14 17:19:17 +08001987 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001988 // Contains various system properties and process startup info.
1989 do_dmesg();
1990 // Logs other than the radio buffer may contain package/component names and potential PII.
1991 DoLogcat();
1992 // Too broad for connectivity problems.
1993 DoKmsg();
Rhed Jaob5685b32020-08-14 17:19:17 +08001994 // DumpHals contains unrelated hardware info (camera, NFC, biometrics, ...).
1995 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001996 WaitForTask(std::move(dump_hals));
Rhed Jaob5685b32020-08-14 17:19:17 +08001997 } else {
1998 RUN_SLOW_FUNCTION_AND_LOG(DUMP_HALS_TASK, DumpHals);
1999 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002000 }
2001
Jayachandran Ca94c7172017-06-10 15:08:12 -07002002 DumpPacketStats();
Jayachandran Ca94c7172017-06-10 15:08:12 -07002003 DumpIpAddrAndRules();
2004 dump_route_tables();
Jayachandran Ca94c7172017-06-10 15:08:12 -07002005 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
2006 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08002007}
2008
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002009// We use "telephony" here for legacy reasons, though this now really means "connectivity" (cellular
2010// + wifi + networking). This method collects dumpsys for connectivity debugging only. General rules
2011// for what can be included on user builds: all reported information MUST directly relate to
2012// connectivity debugging or customer support and MUST NOT contain unrelated personally identifiable
2013// information. This information MUST NOT identify user-installed packages (UIDs are OK, package
2014// names are not), and MUST NOT contain logs of user application traffic.
2015// TODO(b/148168577) rename this and other related fields/methods to "connectivity" instead.
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08002016static void DumpstateTelephonyOnly(const std::string& calling_package) {
mukesh agrawal253dad42018-01-23 21:59:59 -08002017 DurationReporter duration_reporter("DUMPSTATE");
Jichao Lie89d9c12019-11-21 19:02:51 -08002018
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002019 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08002020
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002021 const bool include_sensitive_info = !PropertiesHelper::IsUserBuild();
Jayachandran Ca94c7172017-06-10 15:08:12 -07002022
Rhed Jaob5685b32020-08-14 17:19:17 +08002023 DumpstateRadioAsRoot();
2024 if (!DropRootUser()) {
2025 return;
2026 }
2027
2028 // Starts thread pool after the root user is dropped, and two additional threads
2029 // are created for DumpHals in the DumpstateRadioCommon and DumpstateBoard.
Chris Morinbc223142022-02-04 14:17:11 -08002030 std::future<std::string> dump_board;
Rhed Jaob5685b32020-08-14 17:19:17 +08002031 if (ds.dump_pool_) {
2032 ds.dump_pool_->start(/*thread_counts =*/2);
2033
2034 // DumpstateBoard takes long time, post it to the another thread in the pool,
2035 // if pool is available.
Chris Morinbc223142022-02-04 14:17:11 -08002036 dump_board = ds.dump_pool_->enqueueTaskWithFd(
2037 DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
Rhed Jaob5685b32020-08-14 17:19:17 +08002038 }
2039
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002040 DumpstateRadioCommon(include_sensitive_info);
2041
2042 if (include_sensitive_info) {
2043 // Contains too much unrelated PII, and given the unstructured nature of sysprops, we can't
2044 // really cherrypick all of the connectivity-related ones. Apps generally have no business
2045 // reading these anyway, and there should be APIs to supply the info in a more app-friendly
2046 // way.
2047 RunCommand("SYSTEM PROPERTIES", {"getprop"});
2048 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002049
2050 printf("========================================================\n");
2051 printf("== Android Framework Services\n");
2052 printf("========================================================\n");
2053
Vishnu Nair652cc802017-11-30 15:18:30 -08002054 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
2055 SEC_TO_MSEC(10));
Hunter Knepshield31cbae12021-05-11 16:23:24 -07002056 RunDumpsys("DUMPSYS", {"vcn_management"}, CommandOptions::WithTimeout(90).Build(),
2057 SEC_TO_MSEC(10));
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08002058 if (include_sensitive_info) {
2059 // Carrier apps' services will be dumped below in dumpsys activity service all-non-platform.
2060 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
2061 SEC_TO_MSEC(10));
2062 } else {
2063 // If the caller is a carrier app and has a carrier service, dump it here since we aren't
2064 // running dumpsys activity service all-non-platform below. Due to the increased output, we
2065 // give a higher timeout as well.
2066 RunDumpsys("DUMPSYS", {"carrier_config", "--requesting-package", calling_package},
2067 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(30));
2068 }
2069 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002070 RunDumpsys("DUMPSYS", {"netpolicy"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
2071 RunDumpsys("DUMPSYS", {"network_management"}, CommandOptions::WithTimeout(90).Build(),
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07002072 SEC_TO_MSEC(10));
Hunter Knepshield0fe51b12020-03-05 16:58:20 -08002073 RunDumpsys("DUMPSYS", {"telephony.registry"}, CommandOptions::WithTimeout(90).Build(),
2074 SEC_TO_MSEC(10));
Jack Yu773cc032023-03-16 22:43:39 -07002075 RunDumpsys("DUMPSYS", {"isub"}, CommandOptions::WithTimeout(90).Build(),
2076 SEC_TO_MSEC(10));
Grant Menke56698972023-02-24 13:11:07 -08002077 RunDumpsys("DUMPSYS", {"telecom"}, CommandOptions::WithTimeout(90).Build(),
2078 SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002079 if (include_sensitive_info) {
2080 // Contains raw IP addresses, omit from reports on user builds.
2081 RunDumpsys("DUMPSYS", {"netd"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
2082 // Contains raw destination IP/MAC addresses, omit from reports on user builds.
2083 RunDumpsys("DUMPSYS", {"connmetrics"}, CommandOptions::WithTimeout(90).Build(),
2084 SEC_TO_MSEC(10));
2085 // Contains package/component names, omit from reports on user builds.
2086 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
2087 SEC_TO_MSEC(10));
2088 // Contains package names, but should be relatively simple to remove them (also contains
2089 // UIDs already), omit from reports on user builds.
2090 RunDumpsys("BATTERYSTATS", {"deviceidle"}, CommandOptions::WithTimeout(90).Build(),
2091 SEC_TO_MSEC(10));
2092 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002093
2094 printf("========================================================\n");
2095 printf("== Running Application Services\n");
2096 printf("========================================================\n");
2097
2098 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
2099
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002100 if (include_sensitive_info) {
2101 printf("========================================================\n");
2102 printf("== Running Application Services (non-platform)\n");
2103 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002104
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002105 // Contains package/component names and potential PII, omit from reports on user builds.
2106 // To get dumps of the active CarrierService(s) on user builds, we supply an argument to the
2107 // carrier_config dumpsys instead.
2108 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
2109 DUMPSYS_COMPONENTS_OPTIONS);
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002110
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002111 printf("========================================================\n");
2112 printf("== Checkins\n");
2113 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002114
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002115 // Contains package/component names, omit from reports on user builds.
2116 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
2117 }
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002118
2119 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07002120 printf("== dumpstate: done (id %d)\n", ds.id_);
2121 printf("========================================================\n");
Rhed Jaob5685b32020-08-14 17:19:17 +08002122
2123 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08002124 WaitForTask(std::move(dump_board));
Rhed Jaob5685b32020-08-14 17:19:17 +08002125 } else {
2126 RUN_SLOW_FUNCTION_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
2127 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002128}
2129
mukesh agrawal253dad42018-01-23 21:59:59 -08002130// This method collects dumpsys for wifi debugging only
2131static void DumpstateWifiOnly() {
2132 DurationReporter duration_reporter("DUMPSTATE");
2133
Rhed Jaob5685b32020-08-14 17:19:17 +08002134 DumpstateRadioAsRoot();
2135 if (!DropRootUser()) {
2136 return;
2137 }
2138
2139 // Starts thread pool after the root user is dropped. Only one additional
2140 // thread is needed for DumpHals in the DumpstateRadioCommon.
2141 if (ds.dump_pool_) {
2142 ds.dump_pool_->start(/*thread_counts =*/1);
2143 }
2144
mukesh agrawal253dad42018-01-23 21:59:59 -08002145 DumpstateRadioCommon();
2146
2147 printf("========================================================\n");
2148 printf("== Android Framework Services\n");
2149 printf("========================================================\n");
2150
2151 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
2152 SEC_TO_MSEC(10));
2153 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
2154 SEC_TO_MSEC(10));
2155
2156 printf("========================================================\n");
2157 printf("== dumpstate: done (id %d)\n", ds.id_);
2158 printf("========================================================\n");
2159}
2160
Nandana Duttcf419a72019-03-14 10:40:17 +00002161Dumpstate::RunStatus Dumpstate::DumpTraces(const char** path) {
Gavin Corkery789d7a52021-02-24 23:52:35 +00002162 const std::string temp_file_pattern = ds.bugreport_internal_dir_ + "/dumptrace_XXXXXX";
Nandana Duttfaafd522019-03-11 09:23:09 +00002163 const size_t buf_size = temp_file_pattern.length() + 1;
2164 std::unique_ptr<char[]> file_name_buf(new char[buf_size]);
2165 memcpy(file_name_buf.get(), temp_file_pattern.c_str(), buf_size);
2166
2167 // Create a new, empty file to receive all trace dumps.
2168 //
2169 // TODO: This can be simplified once we remove support for the old style
2170 // dumps. We can have a file descriptor passed in to dump_traces instead
2171 // of creating a file, closing it and then reopening it again.
2172 android::base::unique_fd fd(mkostemp(file_name_buf.get(), O_APPEND | O_CLOEXEC));
2173 if (fd < 0) {
2174 MYLOGE("mkostemp on pattern %s: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002175 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002176 }
2177
2178 // Nobody should have access to this temporary file except dumpstate, but we
2179 // temporarily grant 'read' to 'others' here because this file is created
2180 // when tombstoned is still running as root, but dumped after dropping. This
2181 // can go away once support for old style dumping has.
2182 const int chmod_ret = fchmod(fd, 0666);
2183 if (chmod_ret < 0) {
2184 MYLOGE("fchmod on %s failed: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002185 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002186 }
2187
2188 std::unique_ptr<DIR, decltype(&closedir)> proc(opendir("/proc"), closedir);
2189 if (proc.get() == nullptr) {
2190 MYLOGE("opendir /proc failed: %s\n", strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002191 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002192 }
2193
2194 // Number of times process dumping has timed out. If we encounter too many
2195 // failures, we'll give up.
2196 int timeout_failures = 0;
2197 bool dalvik_found = false;
2198
Jayant Chowdharya0a8eb22022-05-20 03:30:09 +00002199 const std::set<int> hal_pids = get_interesting_pids();
Nandana Duttfaafd522019-03-11 09:23:09 +00002200
2201 struct dirent* d;
2202 while ((d = readdir(proc.get()))) {
Nandana Duttcf419a72019-03-14 10:40:17 +00002203 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttfaafd522019-03-11 09:23:09 +00002204 int pid = atoi(d->d_name);
2205 if (pid <= 0) {
2206 continue;
2207 }
2208
2209 const std::string link_name = android::base::StringPrintf("/proc/%d/exe", pid);
2210 std::string exe;
2211 if (!android::base::Readlink(link_name, &exe)) {
2212 continue;
2213 }
2214
2215 bool is_java_process;
2216 if (exe == "/system/bin/app_process32" || exe == "/system/bin/app_process64") {
2217 // Don't bother dumping backtraces for the zygote.
2218 if (IsZygote(pid)) {
2219 continue;
2220 }
2221
2222 dalvik_found = true;
2223 is_java_process = true;
2224 } else if (should_dump_native_traces(exe.c_str()) || hal_pids.find(pid) != hal_pids.end()) {
2225 is_java_process = false;
2226 } else {
2227 // Probably a native process we don't care about, continue.
2228 continue;
2229 }
2230
2231 // If 3 backtrace dumps fail in a row, consider debuggerd dead.
2232 if (timeout_failures == 3) {
2233 dprintf(fd, "ERROR: Too many stack dump failures, exiting.\n");
2234 break;
2235 }
2236
2237 const uint64_t start = Nanotime();
2238 const int ret = dump_backtrace_to_file_timeout(
2239 pid, is_java_process ? kDebuggerdJavaBacktrace : kDebuggerdNativeBacktrace,
2240 is_java_process ? 5 : 20, fd);
2241
2242 if (ret == -1) {
2243 // For consistency, the header and footer to this message match those
2244 // dumped by debuggerd in the success case.
2245 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
2246 dprintf(fd, "Dump failed, likely due to a timeout.\n");
2247 dprintf(fd, "---- end %d ----", pid);
2248 timeout_failures++;
2249 continue;
2250 }
2251
2252 // We've successfully dumped stack traces, reset the failure count
2253 // and write a summary of the elapsed time to the file and continue with the
2254 // next process.
2255 timeout_failures = 0;
2256
2257 dprintf(fd, "[dump %s stack %d: %.3fs elapsed]\n", is_java_process ? "dalvik" : "native",
2258 pid, (float)(Nanotime() - start) / NANOS_PER_SEC);
2259 }
2260
2261 if (!dalvik_found) {
2262 MYLOGE("Warning: no Dalvik processes found to dump stacks\n");
2263 }
2264
Nandana Duttcf419a72019-03-14 10:40:17 +00002265 *path = file_name_buf.release();
2266 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002267}
2268
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002269static dumpstate_hal_hidl::DumpstateMode GetDumpstateHalModeHidl(
2270 const Dumpstate::BugreportMode bugreport_mode) {
2271 switch (bugreport_mode) {
2272 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2273 return dumpstate_hal_hidl::DumpstateMode::FULL;
2274 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2275 return dumpstate_hal_hidl::DumpstateMode::INTERACTIVE;
2276 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2277 return dumpstate_hal_hidl::DumpstateMode::REMOTE;
2278 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2279 return dumpstate_hal_hidl::DumpstateMode::WEAR;
2280 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2281 return dumpstate_hal_hidl::DumpstateMode::CONNECTIVITY;
2282 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2283 return dumpstate_hal_hidl::DumpstateMode::WIFI;
2284 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2285 return dumpstate_hal_hidl::DumpstateMode::DEFAULT;
2286 }
2287 return dumpstate_hal_hidl::DumpstateMode::DEFAULT;
2288}
2289
2290static dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode GetDumpstateHalModeAidl(
2291 const Dumpstate::BugreportMode bugreport_mode) {
2292 switch (bugreport_mode) {
2293 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2294 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::FULL;
2295 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2296 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::INTERACTIVE;
2297 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2298 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::REMOTE;
2299 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2300 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::WEAR;
2301 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2302 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::CONNECTIVITY;
2303 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2304 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::WIFI;
2305 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2306 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::DEFAULT;
2307 }
2308 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::DEFAULT;
2309}
2310
2311static void DoDumpstateBoardHidl(
2312 const sp<dumpstate_hal_hidl_1_0::IDumpstateDevice> dumpstate_hal_1_0,
2313 const std::vector<::ndk::ScopedFileDescriptor>& dumpstate_fds,
2314 const Dumpstate::BugreportMode bugreport_mode,
2315 const size_t timeout_sec) {
2316
2317 using ScopedNativeHandle =
2318 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
2319 ScopedNativeHandle handle(native_handle_create(static_cast<int>(dumpstate_fds.size()), 0),
2320 [](native_handle_t* handle) {
2321 // we don't close file handle's here
2322 // via native_handle_close(handle)
2323 // instead we let dumpstate_fds close the file handles when
2324 // dumpstate_fds gets destroyed
2325 native_handle_delete(handle);
2326 });
2327 if (handle == nullptr) {
2328 MYLOGE("Could not create native_handle for dumpstate HAL\n");
2329 return;
2330 }
2331
2332 for (size_t i = 0; i < dumpstate_fds.size(); i++) {
2333 handle.get()->data[i] = dumpstate_fds[i].get();
2334 }
2335
2336 // Prefer version 1.1 if available. New devices launching with R are no longer allowed to
2337 // implement just 1.0.
2338 const char* descriptor_to_kill;
2339 using DumpstateBoardTask = std::packaged_task<bool()>;
2340 DumpstateBoardTask dumpstate_board_task;
2341 sp<dumpstate_hal_hidl::IDumpstateDevice> dumpstate_hal(
2342 dumpstate_hal_hidl::IDumpstateDevice::castFrom(dumpstate_hal_1_0));
2343 if (dumpstate_hal != nullptr) {
2344 MYLOGI("Using IDumpstateDevice v1.1 HIDL HAL");
2345
2346 dumpstate_hal_hidl::DumpstateMode dumpstate_hal_mode =
2347 GetDumpstateHalModeHidl(bugreport_mode);
2348
2349 descriptor_to_kill = dumpstate_hal_hidl::IDumpstateDevice::descriptor;
2350 dumpstate_board_task =
2351 DumpstateBoardTask([timeout_sec, dumpstate_hal_mode, dumpstate_hal, &handle]() -> bool {
2352 ::android::hardware::Return<dumpstate_hal_hidl::DumpstateStatus> status =
2353 dumpstate_hal->dumpstateBoard_1_1(handle.get(), dumpstate_hal_mode,
2354 SEC_TO_MSEC(timeout_sec));
2355 if (!status.isOk()) {
2356 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2357 return false;
2358 } else if (status != dumpstate_hal_hidl::DumpstateStatus::OK) {
2359 MYLOGE("dumpstateBoard failed with DumpstateStatus::%s\n",
2360 dumpstate_hal_hidl::toString(status).c_str());
2361 return false;
2362 }
2363 return true;
2364 });
2365 } else {
2366 MYLOGI("Using IDumpstateDevice v1.0 HIDL HAL");
2367
2368 descriptor_to_kill = dumpstate_hal_hidl_1_0::IDumpstateDevice::descriptor;
2369 dumpstate_board_task = DumpstateBoardTask([dumpstate_hal_1_0, &handle]() -> bool {
2370 ::android::hardware::Return<void> status =
2371 dumpstate_hal_1_0->dumpstateBoard(handle.get());
2372 if (!status.isOk()) {
2373 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2374 return false;
2375 }
2376 return true;
2377 });
2378 }
2379 auto result = dumpstate_board_task.get_future();
2380 std::thread(std::move(dumpstate_board_task)).detach();
2381
2382 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2383 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate HAL\n", timeout_sec);
2384 if (!android::base::SetProperty(
2385 "ctl.interface_restart",
2386 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
2387 MYLOGE("Couldn't restart dumpstate HAL\n");
2388 }
2389 }
2390 // Wait some time for init to kill dumpstate vendor HAL
2391 constexpr size_t killing_timeout_sec = 10;
2392 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2393 MYLOGE(
2394 "killing dumpstateBoard timed out after %zus, continue and "
2395 "there might be racing in content\n",
2396 killing_timeout_sec);
2397 }
2398}
2399
2400static void DoDumpstateBoardAidl(
2401 const std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> dumpstate_hal,
2402 const std::vector<::ndk::ScopedFileDescriptor>& dumpstate_fds,
2403 const Dumpstate::BugreportMode bugreport_mode, const size_t timeout_sec) {
2404 MYLOGI("Using IDumpstateDevice AIDL HAL");
2405
2406 const char* descriptor_to_kill;
2407 using DumpstateBoardTask = std::packaged_task<bool()>;
2408 DumpstateBoardTask dumpstate_board_task;
2409 dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode dumpstate_hal_mode =
2410 GetDumpstateHalModeAidl(bugreport_mode);
2411
2412 descriptor_to_kill = dumpstate_hal_aidl::IDumpstateDevice::descriptor;
2413 dumpstate_board_task = DumpstateBoardTask([dumpstate_hal, &dumpstate_fds, dumpstate_hal_mode,
2414 timeout_sec]() -> bool {
2415 auto status = dumpstate_hal->dumpstateBoard(dumpstate_fds, dumpstate_hal_mode, timeout_sec);
2416
2417 if (!status.isOk()) {
2418 MYLOGE("dumpstateBoard failed: %s\n", status.getDescription().c_str());
2419 return false;
2420 }
2421 return true;
2422 });
2423 auto result = dumpstate_board_task.get_future();
2424 std::thread(std::move(dumpstate_board_task)).detach();
2425
2426 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2427 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate HAL\n", timeout_sec);
2428 if (!android::base::SetProperty(
2429 "ctl.interface_restart",
2430 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
2431 MYLOGE("Couldn't restart dumpstate HAL\n");
2432 }
2433 }
2434 // Wait some time for init to kill dumpstate vendor HAL
2435 constexpr size_t killing_timeout_sec = 10;
2436 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2437 MYLOGE(
2438 "killing dumpstateBoard timed out after %zus, continue and "
2439 "there might be racing in content\n",
2440 killing_timeout_sec);
2441 }
2442}
2443
2444static std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> GetDumpstateBoardAidlService() {
2445 const std::string aidl_instance_name =
2446 std::string(dumpstate_hal_aidl::IDumpstateDevice::descriptor) + "/default";
2447
2448 if (!AServiceManager_isDeclared(aidl_instance_name.c_str())) {
2449 return nullptr;
2450 }
2451
2452 ndk::SpAIBinder dumpstateBinder(AServiceManager_waitForService(aidl_instance_name.c_str()));
2453
2454 return dumpstate_hal_aidl::IDumpstateDevice::fromBinder(dumpstateBinder);
2455}
2456
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002457void Dumpstate::DumpstateBoard(int out_fd) {
2458 dprintf(out_fd, "========================================================\n");
2459 dprintf(out_fd, "== Board\n");
2460 dprintf(out_fd, "========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08002461
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002462 /*
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002463 * mount debugfs for non-user builds with ro.product.debugfs_restrictions.enabled
Hridya Valsaraju51101602021-04-02 14:32:46 -07002464 * set to true and unmount it after invoking dumpstateBoard_* methods.
2465 * This is to enable debug builds to not have debugfs mounted during runtime.
2466 * It will also ensure that debugfs is only accessed by the dumpstate HAL.
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002467 */
Hridya Valsaraju51101602021-04-02 14:32:46 -07002468 auto mount_debugfs =
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002469 android::base::GetBoolProperty("ro.product.debugfs_restrictions.enabled", false);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002470 if (mount_debugfs) {
2471 RunCommand("mount debugfs", {"mount", "-t", "debugfs", "debugfs", "/sys/kernel/debug"},
2472 AS_ROOT_20);
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002473 RunCommand("chmod debugfs", {"chmod", "0755", "/sys/kernel/debug"}, AS_ROOT_20);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002474 }
2475
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002476 std::vector<std::string> paths;
2477 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07002478 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002479 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
2480 kDumpstateBoardFiles[i].c_str()));
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002481 remover.emplace_back(android::base::make_scope_guard(
2482 std::bind([](std::string path) { android::os::UnlinkAndLogOnError(path); }, paths[i])));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002483 }
Jie Song9fbfad02017-06-20 16:29:42 -07002484
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002485 // get dumpstate HAL AIDL implementation
2486 std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> dumpstate_hal_handle_aidl(
2487 GetDumpstateBoardAidlService());
2488 if (dumpstate_hal_handle_aidl == nullptr) {
2489 MYLOGI("No IDumpstateDevice AIDL implementation\n");
2490 }
2491
2492 // get dumpstate HAL HIDL implementation, only if AIDL HAL implementation not found
2493 sp<dumpstate_hal_hidl_1_0::IDumpstateDevice> dumpstate_hal_handle_hidl_1_0 = nullptr;
2494 if (dumpstate_hal_handle_aidl == nullptr) {
2495 dumpstate_hal_handle_hidl_1_0 = dumpstate_hal_hidl_1_0::IDumpstateDevice::getService();
2496 if (dumpstate_hal_handle_hidl_1_0 == nullptr) {
2497 MYLOGI("No IDumpstateDevice HIDL implementation\n");
2498 }
2499 }
2500
2501 // if neither HIDL nor AIDL implementation found, then return
2502 if (dumpstate_hal_handle_hidl_1_0 == nullptr && dumpstate_hal_handle_aidl == nullptr) {
2503 MYLOGE("Could not find IDumpstateDevice implementation\n");
Wei Wang587eac92018-04-05 12:17:20 -07002504 return;
2505 }
2506
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002507 // this is used to hold the file descriptors and when this variable goes out of scope
2508 // the file descriptors are closed
2509 std::vector<::ndk::ScopedFileDescriptor> dumpstate_fds;
Wei Wang587eac92018-04-05 12:17:20 -07002510
Nandana Dutt5c390032019-03-12 10:52:56 +00002511 // TODO(128270426): Check for consent in between?
Wei Wang587eac92018-04-05 12:17:20 -07002512 for (size_t i = 0; i < paths.size(); i++) {
2513 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
2514
2515 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
2516 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
2517 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
2518 if (fd < 0) {
2519 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
2520 return;
2521 }
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002522
2523 dumpstate_fds.emplace_back(fd.release());
2524 // we call fd.release() here to make sure "fd" does not get closed
2525 // after "fd" goes out of scope after this block.
2526 // "fd" will be closed when "dumpstate_fds" goes out of scope
2527 // i.e. when we exit this function
Wei Wang587eac92018-04-05 12:17:20 -07002528 }
2529
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002530 // Given that bugreport is required to diagnose failures, it's better to set an arbitrary amount
2531 // of timeout for IDumpstateDevice than to block the rest of bugreport. In the timeout case, we
2532 // will kill the HAL and grab whatever it dumped in time.
Michael Eastwood8523ea02022-03-10 16:33:08 -08002533 constexpr size_t timeout_sec = 45;
Wei Wang587eac92018-04-05 12:17:20 -07002534
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002535 if (dumpstate_hal_handle_aidl != nullptr) {
2536 DoDumpstateBoardAidl(dumpstate_hal_handle_aidl, dumpstate_fds, options_->bugreport_mode,
2537 timeout_sec);
2538 } else if (dumpstate_hal_handle_hidl_1_0 != nullptr) {
2539 // run HIDL HAL only if AIDL HAL not found
2540 DoDumpstateBoardHidl(dumpstate_hal_handle_hidl_1_0, dumpstate_fds, options_->bugreport_mode,
2541 timeout_sec);
Wei Wang587eac92018-04-05 12:17:20 -07002542 }
2543
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002544 if (mount_debugfs) {
Hridya Valsaraju51101602021-04-02 14:32:46 -07002545 auto keep_debugfs_mounted =
2546 android::base::GetProperty("persist.dbg.keep_debugfs_mounted", "");
2547 if (keep_debugfs_mounted.empty())
2548 RunCommand("unmount debugfs", {"umount", "/sys/kernel/debug"}, AS_ROOT_20);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002549 }
2550
Wei Wang587eac92018-04-05 12:17:20 -07002551 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
2552 for (size_t i = 0; i < paths.size(); i++) {
2553 struct stat s;
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002554 if (fstat(dumpstate_fds[i].get(), &s) == -1) {
2555 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(), strerror(errno));
Wei Wang587eac92018-04-05 12:17:20 -07002556 file_sizes[i] = -1;
2557 continue;
2558 }
2559 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002560 }
2561
2562 for (size_t i = 0; i < paths.size(); i++) {
2563 if (file_sizes[i] == -1) {
2564 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002565 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002566 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07002567 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002568 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002569 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002570 remover[i].Disable();
2571 EnqueueAddZipEntryAndCleanupIfNeeded(kDumpstateBoardFiles[i], paths[i]);
2572 dprintf(out_fd, "*** See %s entry ***\n", kDumpstateBoardFiles[i].c_str());
Jie Song9fbfad02017-06-20 16:29:42 -07002573 }
Felipe Leme6f674ae2016-11-18 17:10:33 -08002574}
2575
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002576static void ShowUsage() {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002577 fprintf(stderr,
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002578 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-o directory] [-p] "
2579 "[-s] [-S] [-q] [-P] [-R] [-L] [-V version]\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002580 " -h: display this help message\n"
2581 " -b: play sound file instead of vibrate, at beginning of job\n"
2582 " -e: play sound file instead of vibrate, at end of job\n"
mhasank2d75c442020-06-11 15:05:25 -07002583 " -o: write to custom directory (only in limited mode)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01002584 " -p: capture screenshot to filename.png\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002585 " -s: write zipped file to control socket (for init)\n"
2586 " -S: write file location to control socket (for init)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002587 " -q: disable vibrate\n"
Abhijeet Kaure370d682019-10-01 16:49:30 +01002588 " -P: send broadcast when started and do progress updates\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002589 " -R: take bugreport in remote mode (shouldn't be used with -P)\n"
Nandana Dutt235864b2019-01-22 12:10:16 +00002590 " -w: start binder service and make it wait for a call to startBugreport\n"
mhasankd451a472020-05-26 18:02:39 -07002591 " -L: output limited information that is safe for submission in feedback reports\n"
Felipe Lemed071c682016-10-20 16:48:00 -07002592 " -v: prints the dumpstate header and exit\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002593}
2594
Wei Liuf87959e2016-08-26 14:51:42 -07002595static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07002596 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07002597}
2598
Felipe Leme1d486fe2016-10-14 18:06:47 -07002599bool Dumpstate::FinishZipFile() {
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002600 // Runs all enqueued adding zip entry and cleanup tasks before finishing the zip file.
2601 if (zip_entry_tasks_) {
2602 zip_entry_tasks_->run(/* do_cancel = */false);
2603 }
2604
Felipe Leme9a523ae2016-10-20 15:10:33 -07002605 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07002606 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07002607 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002608 // Final timestamp
2609 char date[80];
2610 time_t the_real_now_please_stand_up = time(nullptr);
2611 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002612 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07002613 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002614
Felipe Leme9a523ae2016-10-20 15:10:33 -07002615 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002616 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08002617 return false;
2618 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07002619 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002620 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08002621 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08002622 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08002623
Felipe Leme0f3fb202016-06-10 17:10:53 -07002624 // Add log file (which contains stderr output) to zip...
2625 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07002626 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07002627 MYLOGE("Failed to add dumpstate log to .zip file\n");
2628 return false;
2629 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002630 // TODO: Should truncate the existing file.
2631 // ... and re-open it for further logging.
Nandana Dutta344cb62019-02-22 15:12:35 +00002632 if (!redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()))) {
2633 return false;
2634 }
Felipe Leme0f3fb202016-06-10 17:10:53 -07002635 fprintf(stderr, "\n");
2636
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002637 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07002638 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002639 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002640 return false;
2641 }
2642
Felipe Leme1d486fe2016-10-14 18:06:47 -07002643 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
2644 ds.zip_file.reset(nullptr);
2645
Felipe Lemee9d2c542016-11-15 11:48:26 -08002646 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002647 android::os::UnlinkAndLogOnError(tmp_path_);
Felipe Lemec4eee562016-04-21 15:42:55 -07002648
Felipe Leme1e9edc62015-12-21 16:02:13 -08002649 return true;
2650}
Felipe Leme6e01fa62015-11-11 19:35:14 -08002651
Nikhil Kumar28ce35e2023-01-10 14:32:44 +00002652static void SendBroadcast(const std::string& action,
2653 const std::vector<std::string>& args,
2654 int32_t user_id) {
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002655 // clang-format off
Nikhil Kumar28ce35e2023-01-10 14:32:44 +00002656 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user",
2657 std::to_string(user_id), "--receiver-foreground",
2658 "--receiver-include-background", "-a", action};
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002659 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08002660
2661 am.insert(am.end(), args.begin(), args.end());
2662
Felipe Leme8d2410e2017-02-08 09:46:08 -08002663 RunCommand("", am,
2664 CommandOptions::WithTimeout(20)
2665 .Log("Sending broadcast: '%s'\n")
2666 .Always()
2667 .DropRoot()
2668 .RedirectStderr()
2669 .Build());
2670}
2671
Felipe Leme35b8cf12017-02-10 15:47:29 -08002672static void Vibrate(int duration_ms) {
2673 // clang-format off
Lais Andrade51156962021-02-22 19:21:35 +00002674 std::vector<std::string> args = {"cmd", "vibrator_manager", "synced", "-f", "-d", "dumpstate",
2675 "oneshot", std::to_string(duration_ms)};
2676 RunCommand("", args,
Felipe Leme35b8cf12017-02-10 15:47:29 -08002677 CommandOptions::WithTimeout(10)
2678 .Log("Vibrate: '%s'\n")
2679 .Always()
2680 .Build());
2681 // clang-format on
2682}
2683
Nandana Dutt979388e2018-11-30 16:48:55 +00002684static void MaybeResolveSymlink(std::string* path) {
2685 std::string resolved_path;
2686 if (android::base::Readlink(*path, &resolved_path)) {
2687 *path = resolved_path;
2688 }
2689}
2690
Nandana Dutt4be45d12018-09-26 15:04:23 +01002691/*
2692 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002693 * and adds the version file. Return false if zip_file could not be open to write.
Nandana Dutt4be45d12018-09-26 15:04:23 +01002694 */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002695static bool PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002696 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
2697
Nandana Dutt4be45d12018-09-26 15:04:23 +01002698 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
2699 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002700 ds.base_name_ = StringPrintf("bugreport-%s-%s", device_name.c_str(), build_id.c_str());
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002701 char date[80];
2702 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
2703 ds.name_ = date;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002704
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002705 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002706 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002707 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002708 ds.base_name_ += "-wifi";
2709 }
2710
Paul Chang0d2aad72020-02-13 20:04:03 +08002711 if (ds.options_->do_screenshot) {
Nandana Dutt9d17b942020-03-26 10:02:59 +00002712 ds.screenshot_path_ = ds.GetPath(ds.CalledByApi() ? "-png.tmp" : ".png");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002713 }
2714 ds.tmp_path_ = ds.GetPath(".tmp");
2715 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
2716
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002717 std::string destination = ds.CalledByApi()
Nandana Dutt54dbd672019-01-11 12:58:05 +00002718 ? StringPrintf("[fd:%d]", ds.options_->bugreport_fd.get())
Nandana Dutt9a76d202019-01-21 15:56:48 +00002719 : ds.bugreport_internal_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01002720 MYLOGD(
Nandana Dutt235c6672019-11-14 15:22:32 +00002721 "Bugreport dir: [%s] "
2722 "Base name: [%s] "
2723 "Suffix: [%s] "
2724 "Log path: [%s] "
2725 "Temporary path: [%s] "
2726 "Screenshot path: [%s]\n",
Nandana Dutt9a76d202019-01-21 15:56:48 +00002727 destination.c_str(), ds.base_name_.c_str(), ds.name_.c_str(), ds.log_path_.c_str(),
2728 ds.tmp_path_.c_str(), ds.screenshot_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002729
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002730 ds.path_ = ds.GetPath(ds.CalledByApi() ? "-zip.tmp" : ".zip");
2731 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
2732 create_parent_dirs(ds.path_.c_str());
2733 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
2734 if (ds.zip_file == nullptr) {
2735 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
2736 return false;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002737 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002738 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
2739 ds.AddTextZipEntry("version.txt", ds.version_);
2740 return true;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002741}
2742
2743/*
Abhijeet Kaure370d682019-10-01 16:49:30 +01002744 * Finalizes writing to the file by zipping the tmp file to the final location,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002745 * printing zipped file status, etc.
2746 */
2747static void FinalizeFile() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002748 bool do_text_file = !ds.FinishZipFile();
2749 if (do_text_file) {
2750 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002751 }
mhasank2d75c442020-06-11 15:05:25 -07002752
2753 std::string final_path = ds.path_;
2754 if (ds.options_->OutputToCustomFile()) {
mhasank3a4cfb42020-06-15 18:06:43 -07002755 final_path = ds.GetPath(ds.options_->out_dir, ".zip");
mhasank2d75c442020-06-11 15:05:25 -07002756 android::os::CopyFileToFile(ds.path_, final_path);
2757 }
2758
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002759 if (ds.options_->stream_to_socket) {
2760 android::os::CopyFileToFd(ds.path_, ds.control_socket_fd_);
2761 } else if (ds.options_->progress_updates_to_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002762 if (do_text_file) {
2763 dprintf(ds.control_socket_fd_,
2764 "FAIL:could not create zip file, check %s "
2765 "for more details\n",
2766 ds.log_path_.c_str());
2767 } else {
mhasank2d75c442020-06-11 15:05:25 -07002768 dprintf(ds.control_socket_fd_, "OK:%s\n", final_path.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002769 }
2770 }
2771}
2772
Nandana Dutt4be45d12018-09-26 15:04:23 +01002773
Nandana Dutt58d72e22018-11-16 10:30:48 +00002774static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2775 switch (mode) {
2776 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2777 return "BUGREPORT_FULL";
2778 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2779 return "BUGREPORT_INTERACTIVE";
2780 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2781 return "BUGREPORT_REMOTE";
2782 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2783 return "BUGREPORT_WEAR";
2784 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2785 return "BUGREPORT_TELEPHONY";
2786 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2787 return "BUGREPORT_WIFI";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002788 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2789 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002790 }
2791}
2792
Steven Leeb573eb82022-11-29 22:31:35 +08002793static bool IsConsentlessBugreportAllowed(const Dumpstate::DumpOptions& options) {
2794 // only BUGREPORT_TELEPHONY does not allow using consentless bugreport
2795 return !options.telephony_only;
2796}
2797
Paul Changf59c2b72020-03-10 02:08:55 +08002798static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options,
2799 bool is_screenshot_requested) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002800 // Modify com.android.shell.BugreportProgressService#isDefaultScreenshotRequired as well for
2801 // default system screenshots.
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002802 options->bugreport_mode = mode;
2803 options->bugreport_mode_string = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002804 switch (mode) {
2805 case Dumpstate::BugreportMode::BUGREPORT_FULL:
Paul Changf59c2b72020-03-10 02:08:55 +08002806 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002807 break;
2808 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002809 // Currently, the dumpstate binder is only used by Shell to update progress.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002810 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002811 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002812 break;
2813 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002814 options->do_vibrate = false;
2815 options->is_remote_mode = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002816 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002817 break;
2818 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002819 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002820 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002821 break;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002822 // TODO(b/148168577) rename TELEPHONY everywhere to CONNECTIVITY.
Nandana Dutt58d72e22018-11-16 10:30:48 +00002823 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002824 options->telephony_only = true;
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002825 options->do_progress_updates = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002826 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002827 break;
2828 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002829 options->wifi_only = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002830 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002831 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002832 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2833 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002834 }
2835}
2836
Nandana Dutt58d72e22018-11-16 10:30:48 +00002837static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
Nandana Dutt235c6672019-11-14 15:22:32 +00002838 MYLOGI(
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002839 "do_vibrate: %d stream_to_socket: %d progress_updates_to_socket: %d do_screenshot: %d "
Rhed Jao25f50e02020-08-20 00:10:32 +08002840 "is_remote_mode: %d show_header_only: %d telephony_only: %d "
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002841 "wifi_only: %d do_progress_updates: %d fd: %d bugreport_mode: %s "
mhasankd451a472020-05-26 18:02:39 -07002842 "limited_only: %d args: %s\n",
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002843 options.do_vibrate, options.stream_to_socket, options.progress_updates_to_socket,
Paul Chang0d2aad72020-02-13 20:04:03 +08002844 options.do_screenshot, options.is_remote_mode, options.show_header_only,
Rhed Jao25f50e02020-08-20 00:10:32 +08002845 options.telephony_only, options.wifi_only,
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002846 options.do_progress_updates, options.bugreport_fd.get(),
2847 options.bugreport_mode_string.c_str(),
2848 options.limited_only, options.args.c_str());
Nandana Dutt58d72e22018-11-16 10:30:48 +00002849}
2850
Nandana Dutt54dbd672019-01-11 12:58:05 +00002851void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode,
Kean Mariotti306633e2022-09-05 16:30:47 +00002852 int bugreport_flags,
Nandana Dutt54dbd672019-01-11 12:58:05 +00002853 const android::base::unique_fd& bugreport_fd_in,
Paul Changf59c2b72020-03-10 02:08:55 +08002854 const android::base::unique_fd& screenshot_fd_in,
2855 bool is_screenshot_requested) {
Kean Mariotti306633e2022-09-05 16:30:47 +00002856 this->use_predumped_ui_data = bugreport_flags & BugreportFlag::BUGREPORT_USE_PREDUMPED_UI_DATA;
Gavin Corkerya44686c2022-11-23 18:16:51 +00002857 this->is_consent_deferred = bugreport_flags & BugreportFlag::BUGREPORT_FLAG_DEFER_CONSENT;
Nandana Dutt54dbd672019-01-11 12:58:05 +00002858 // Duplicate the fds because the passed in fds don't outlive the binder transaction.
Todd Frederick621533f2022-03-26 02:54:17 +00002859 bugreport_fd.reset(fcntl(bugreport_fd_in.get(), F_DUPFD_CLOEXEC, 0));
2860 screenshot_fd.reset(fcntl(screenshot_fd_in.get(), F_DUPFD_CLOEXEC, 0));
Nandana Dutt58d72e22018-11-16 10:30:48 +00002861
Paul Changf59c2b72020-03-10 02:08:55 +08002862 SetOptionsFromMode(bugreport_mode, this, is_screenshot_requested);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002863}
2864
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002865Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
2866 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002867 int c;
mhasankd451a472020-05-26 18:02:39 -07002868 while ((c = getopt(argc, argv, "dho:svqzpLPBRSV:w")) != -1) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002869 switch (c) {
2870 // clang-format off
mhasank3a4cfb42020-06-15 18:06:43 -07002871 case 'o': out_dir = optarg; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002872 case 's': stream_to_socket = true; break;
2873 case 'S': progress_updates_to_socket = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002874 case 'v': show_header_only = true; break;
2875 case 'q': do_vibrate = false; break;
Paul Chang0d2aad72020-02-13 20:04:03 +08002876 case 'p': do_screenshot = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002877 case 'P': do_progress_updates = true; break;
2878 case 'R': is_remote_mode = true; break;
mhasankd451a472020-05-26 18:02:39 -07002879 case 'L': limited_only = true; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002880 case 'V':
2881 case 'd':
2882 case 'z':
2883 // compatibility no-op
2884 break;
Nandana Dutt235864b2019-01-22 12:10:16 +00002885 case 'w':
2886 // This was already processed
2887 break;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002888 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002889 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002890 break;
2891 default:
2892 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002893 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002894 break;
2895 // clang-format on
2896 }
2897 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08002898
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002899 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002900 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002901 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002902 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002903 }
2904 }
2905
2906 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
2907 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002908
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002909 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002910}
2911
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002912bool Dumpstate::DumpOptions::ValidateOptions() const {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002913 if (bugreport_fd.get() != -1 && stream_to_socket) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002914 return false;
2915 }
2916
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002917 if ((progress_updates_to_socket || do_progress_updates) && stream_to_socket) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002918 return false;
2919 }
2920
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002921 if (is_remote_mode && (do_progress_updates || stream_to_socket)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002922 return false;
2923 }
2924 return true;
2925}
2926
Nandana Dutt197661d2018-11-16 16:40:21 +00002927void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
2928 options_ = std::move(options);
2929}
2930
Abhijeet Kaura407fb82020-03-27 12:51:12 +00002931void Dumpstate::Initialize() {
2932 /* gets the sequential id */
2933 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
2934 id_ = ++last_id;
2935 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
2936}
2937
Nandana Duttd2f5f082019-01-18 17:13:52 +00002938Dumpstate::RunStatus Dumpstate::Run(int32_t calling_uid, const std::string& calling_package) {
2939 Dumpstate::RunStatus status = RunInternal(calling_uid, calling_package);
Gavin Corkerya44686c2022-11-23 18:16:51 +00002940 HandleRunStatus(status);
2941 return status;
2942}
2943
2944Dumpstate::RunStatus Dumpstate::Retrieve(int32_t calling_uid, const std::string& calling_package) {
2945 Dumpstate::RunStatus status = RetrieveInternal(calling_uid, calling_package);
2946 HandleRunStatus(status);
2947 return status;
2948}
2949
2950Dumpstate::RunStatus Dumpstate::RetrieveInternal(int32_t calling_uid,
2951 const std::string& calling_package) {
2952 consent_callback_ = new ConsentCallback();
2953 const String16 incidentcompanion("incidentcompanion");
2954 sp<android::IBinder> ics(
2955 defaultServiceManager()->checkService(incidentcompanion));
2956 android::String16 package(calling_package.c_str());
2957 if (ics != nullptr) {
2958 MYLOGD("Checking user consent via incidentcompanion service\n");
2959 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
2960 calling_uid, package, String16(), String16(),
2961 0x1 /* FLAG_CONFIRMATION_DIALOG */, consent_callback_.get());
2962 } else {
2963 MYLOGD(
2964 "Unable to check user consent; incidentcompanion service unavailable\n");
2965 return RunStatus::USER_CONSENT_TIMED_OUT;
2966 }
2967 UserConsentResult consent_result = consent_callback_->getResult();
2968 int timeout_ms = 30 * 1000;
2969 while (consent_result == UserConsentResult::UNAVAILABLE &&
2970 consent_callback_->getElapsedTimeMs() < timeout_ms) {
2971 sleep(1);
2972 consent_result = consent_callback_->getResult();
2973 }
2974 if (consent_result == UserConsentResult::DENIED) {
2975 return RunStatus::USER_CONSENT_DENIED;
2976 }
2977 if (consent_result == UserConsentResult::UNAVAILABLE) {
2978 MYLOGD("Canceling user consent request via incidentcompanion service\n");
2979 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
2980 consent_callback_.get());
2981 return RunStatus::USER_CONSENT_TIMED_OUT;
2982 }
2983
2984 bool copy_succeeded =
2985 android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
2986 if (copy_succeeded) {
2987 android::os::UnlinkAndLogOnError(path_);
2988 }
2989 return copy_succeeded ? Dumpstate::RunStatus::OK
2990 : Dumpstate::RunStatus::ERROR;
2991}
2992
2993void Dumpstate::HandleRunStatus(Dumpstate::RunStatus status) {
2994 if (listener_ != nullptr) {
Nandana Duttbabf6c72019-01-15 14:11:12 +00002995 switch (status) {
2996 case Dumpstate::RunStatus::OK:
Gavin Corkerya44686c2022-11-23 18:16:51 +00002997 listener_->onFinished(path_.c_str());
Nandana Duttbabf6c72019-01-15 14:11:12 +00002998 break;
2999 case Dumpstate::RunStatus::HELP:
3000 break;
3001 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Duttd2f5f082019-01-18 17:13:52 +00003002 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_INVALID_INPUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00003003 break;
3004 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00003005 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_RUNTIME_ERROR);
3006 break;
3007 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
3008 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_DENIED_CONSENT);
3009 break;
3010 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
3011 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_CONSENT_TIMED_OUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00003012 break;
3013 }
3014 }
Nandana Duttbabf6c72019-01-15 14:11:12 +00003015}
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003016void Dumpstate::Cancel() {
3017 CleanupTmpFiles();
3018 android::os::UnlinkAndLogOnError(log_path_);
3019 for (int i = 0; i < NUM_OF_DUMPS; i++) {
3020 android::os::UnlinkAndLogOnError(ds.bugreport_internal_dir_ + "/" +
3021 kDumpstateBoardFiles[i]);
3022 }
3023 tombstone_data_.clear();
3024 anr_data_.clear();
Woody Lin20767a92022-11-29 15:50:24 +08003025 shutdown_checkpoints_.clear();
Rhed Jao0daac912020-08-21 14:48:20 +08003026
3027 // Instead of shutdown the pool, we delete temporary files directly since
3028 // shutdown blocking the call.
3029 if (dump_pool_) {
3030 dump_pool_->deleteTempFiles();
3031 }
3032 if (zip_entry_tasks_) {
3033 zip_entry_tasks_->run(/*do_cancel =*/ true);
3034 }
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003035}
3036
Kean Mariotti306633e2022-09-05 16:30:47 +00003037void Dumpstate::PreDumpUiData() {
3038 MaybeSnapshotUiTraces();
3039}
3040
Nandana Dutt979388e2018-11-30 16:48:55 +00003041/*
3042 * Dumps relevant information to a bugreport based on the given options.
3043 *
3044 * The bugreport can be dumped to a file or streamed to a socket.
3045 *
3046 * How dumping to file works:
3047 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
3048 * stderr is redirected a log file.
3049 *
3050 * The temporary bugreport is then populated via printfs, dumping contents of files and
3051 * output of commands to stdout.
3052 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003053 * A bunch of other files and dumps are added to the zip archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00003054 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003055 * The temporary bugreport file and the log file also get added to the archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00003056 *
mhasank2d75c442020-06-11 15:05:25 -07003057 * Bugreports are first generated in a local directory and later copied to the caller's fd
3058 * or directory if supplied.
Nandana Dutt979388e2018-11-30 16:48:55 +00003059 */
Nandana Duttd2f5f082019-01-18 17:13:52 +00003060Dumpstate::RunStatus Dumpstate::RunInternal(int32_t calling_uid,
3061 const std::string& calling_package) {
Rhed Jao5377d792020-07-16 17:37:39 +08003062 DurationReporter duration_reporter("RUN INTERNAL", /* logcat_only = */true);
Nandana Dutt979388e2018-11-30 16:48:55 +00003063 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00003064 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00003065 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003066 return RunStatus::INVALID_INPUT;
3067 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003068 /* set as high priority, and protect from OOM killer */
3069 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07003070
Felipe Lemed071c682016-10-20 16:48:00 -07003071 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07003072 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07003073 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07003074 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07003075 } else {
3076 /* fallback to kernels <= 2.6.35 */
3077 oom_adj = fopen("/proc/self/oom_adj", "we");
3078 if (oom_adj) {
3079 fputs("-17", oom_adj);
3080 fclose(oom_adj);
3081 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003082 }
3083
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003084 if (version_ == VERSION_DEFAULT) {
3085 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00003086 }
3087
Chris Morin5a50d482022-02-01 17:41:18 -08003088 if (version_ != VERSION_CURRENT) {
3089 MYLOGE("invalid version requested ('%s'); supported values are: ('%s', '%s')\n",
3090 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003091 return RunStatus::INVALID_INPUT;
Felipe Lemed071c682016-10-20 16:48:00 -07003092 }
3093
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003094 if (options_->show_header_only) {
3095 PrintHeader();
3096 return RunStatus::OK;
Felipe Lemed071c682016-10-20 16:48:00 -07003097 }
3098
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003099 MYLOGD("dumpstate calling_uid = %d ; calling package = %s \n",
3100 calling_uid, calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003101
Felipe Leme7447d7c2016-11-03 18:12:22 -07003102 // TODO: temporarily set progress until it's part of the Dumpstate constructor
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003103 std::string stats_path =
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003104 android::base::StringPrintf("%s/dumpstate-stats.txt", bugreport_internal_dir_.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003105 progress_.reset(new Progress(stats_path));
Felipe Leme7447d7c2016-11-03 18:12:22 -07003106
Sahana Raof35ed432019-07-12 10:47:52 +01003107 if (acquire_wake_lock(PARTIAL_WAKE_LOCK, WAKE_LOCK_NAME) < 0) {
3108 MYLOGE("Failed to acquire wake lock: %s\n", strerror(errno));
3109 } else {
3110 // Wake lock will be released automatically on process death
3111 MYLOGD("Wake lock acquired.\n");
3112 }
3113
Felipe Leme6ae5c4f2017-01-10 14:13:22 -08003114 register_sig_handler();
Felipe Lemed071c682016-10-20 16:48:00 -07003115
Felipe Lemef0292972016-11-22 13:57:05 -08003116 if (PropertiesHelper::IsDryRun()) {
Felipe Lemed071c682016-10-20 16:48:00 -07003117 MYLOGI("Running on dry-run mode (to disable it, call 'setprop dumpstate.dry_run false')\n");
3118 }
3119
Nandana Dutt235c6672019-11-14 15:22:32 +00003120 MYLOGI("dumpstate info: id=%d, args='%s', bugreport_mode= %s bugreport format version: %s\n",
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00003121 id_, options_->args.c_str(), options_->bugreport_mode_string.c_str(), version_.c_str());
Felipe Leme809d74e2016-02-02 12:57:00 -08003122
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003123 do_early_screenshot_ = options_->do_progress_updates;
Felipe Lemee338bf62015-12-07 14:03:50 -08003124
Christopher Ferrised9354f2014-10-01 17:35:01 -07003125 // If we are going to use a socket, do it as early as possible
3126 // to avoid timeouts from bugreport.
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003127 if (options_->stream_to_socket || options_->progress_updates_to_socket) {
Felipe Leme2628e9e2016-04-12 16:36:51 -07003128 MYLOGD("Opening control socket\n");
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003129 control_socket_fd_ = open_socket_fn_("dumpstate");
Nandana Dutta344cb62019-02-22 15:12:35 +00003130 if (control_socket_fd_ == -1) {
3131 return ERROR;
3132 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003133 if (options_->progress_updates_to_socket) {
3134 options_->do_progress_updates = 1;
3135 }
Felipe Leme2628e9e2016-04-12 16:36:51 -07003136 }
3137
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003138 if (!PrepareToWriteToFile()) {
3139 return ERROR;
3140 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08003141
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003142 // Interactive, wear & telephony modes are default to true.
3143 // and may enable from cli option or when using control socket
3144 if (options_->do_progress_updates) {
3145 // clang-format off
3146 std::vector<std::string> am_args = {
3147 "--receiver-permission", "android.permission.DUMP",
3148 };
3149 // clang-format on
3150 // Send STARTED broadcast for apps that listen to bugreport generation events
Nikhil Kumar28ce35e2023-01-10 14:32:44 +00003151 SendBroadcast("com.android.internal.intent.action.BUGREPORT_STARTED",
3152 am_args, multiuser_get_user_id(calling_uid));
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003153 if (options_->progress_updates_to_socket) {
3154 dprintf(control_socket_fd_, "BEGIN:%s\n", path_.c_str());
Felipe Leme71bbfc52015-11-23 14:14:51 -08003155 }
3156 }
3157
Nick Kralevichf3599b32016-01-25 15:05:16 -08003158 /* read /proc/cmdline before dropping root */
3159 FILE *cmdline = fopen("/proc/cmdline", "re");
3160 if (cmdline) {
3161 fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
3162 fclose(cmdline);
3163 }
3164
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003165 if (options_->do_vibrate) {
Felipe Leme35b8cf12017-02-10 15:47:29 -08003166 Vibrate(150);
John Michelau1f794c42012-09-17 11:20:19 -05003167 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003168
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003169 if (zip_file != nullptr) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003170 if (chown(path_.c_str(), AID_SHELL, AID_SHELL)) {
3171 MYLOGE("Unable to change ownership of zip file %s: %s\n", path_.c_str(),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003172 strerror(errno));
Felipe Leme1e9edc62015-12-21 16:02:13 -08003173 }
3174 }
3175
Nandana Dutt3f8c7172018-09-25 12:01:54 +01003176 int dup_stdout_fd;
3177 int dup_stderr_fd;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003178 // Redirect stderr to log_path_ for debugging.
3179 TEMP_FAILURE_RETRY(dup_stderr_fd = dup(fileno(stderr)));
3180 if (!redirect_to_file(stderr, const_cast<char*>(log_path_.c_str()))) {
3181 return ERROR;
3182 }
3183 if (chown(log_path_.c_str(), AID_SHELL, AID_SHELL)) {
3184 MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n", log_path_.c_str(),
3185 strerror(errno));
3186 }
Nandana Dutt979388e2018-11-30 16:48:55 +00003187
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003188 // Redirect stdout to tmp_path_. This is the main bugreport entry and will be
3189 // moved into zip file later, if zipping.
3190 TEMP_FAILURE_RETRY(dup_stdout_fd = dup(fileno(stdout)));
3191 // TODO: why not write to a file instead of stdout to overcome this problem?
3192 /* TODO: rather than generating a text file now and zipping it later,
3193 it would be more efficient to redirect stdout to the zip entry
3194 directly, but the libziparchive doesn't support that option yet. */
3195 if (!redirect_to_file(stdout, const_cast<char*>(tmp_path_.c_str()))) {
3196 return ERROR;
3197 }
3198 if (chown(tmp_path_.c_str(), AID_SHELL, AID_SHELL)) {
3199 MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
3200 tmp_path_.c_str(), strerror(errno));
Colin Crossf45fa6b2012-03-26 12:38:26 -07003201 }
Felipe Lemed8b94e52016-12-08 10:21:44 -08003202
3203 // Don't buffer stdout
3204 setvbuf(stdout, nullptr, _IONBF, 0);
3205
Rhed Jao5377d792020-07-16 17:37:39 +08003206 // Enable the parallel run if the client requests to output to a file.
3207 EnableParallelRunIfNeeded();
3208 // Using scope guard to make sure the dump pool can be shut down correctly.
3209 auto scope_guard_to_shutdown_pool = android::base::make_scope_guard([=]() {
3210 ShutdownDumpPool();
3211 });
3212
Felipe Leme608385d2016-02-01 10:35:38 -08003213 // NOTE: there should be no stdout output until now, otherwise it would break the header.
3214 // In particular, DurationReport objects should be created passing 'title, NULL', so their
Felipe Lemecbce55d2016-02-08 09:53:18 -08003215 // duration is logged into MYLOG instead.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003216 PrintHeader();
Colin Crossf45fa6b2012-03-26 12:38:26 -07003217
Gavin Corkery6968f552020-11-22 18:09:05 +00003218 bool is_dumpstate_restricted = options_->telephony_only
3219 || options_->wifi_only
3220 || options_->limited_only;
3221 if (!is_dumpstate_restricted) {
Paul Chang0d2aad72020-02-13 20:04:03 +08003222 // Invoke critical dumpsys first to preserve system state, before doing anything else.
Jichao Lie89d9c12019-11-21 19:02:51 -08003223 RunDumpsysCritical();
Gavin Corkery6968f552020-11-22 18:09:05 +00003224 }
3225 MaybeTakeEarlyScreenshot();
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003226
3227 if (!is_dumpstate_restricted) {
3228 // Snapshot the system trace now (if running) to avoid that dumpstate's
3229 // own activity pushes out interesting data from the trace ring buffer.
3230 // The trace file is added to the zip by MaybeAddSystemTraceToZip().
3231 MaybeSnapshotSystemTrace();
Yohei Yukawa95305b32021-03-09 07:54:27 -08003232
Kean Mariotti306633e2022-09-05 16:30:47 +00003233 // Snapshot the UI traces now (if running).
3234 // The trace files will be added to bugreport later.
3235 MaybeSnapshotUiTraces();
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003236 }
Gavin Corkery6968f552020-11-22 18:09:05 +00003237 onUiIntensiveBugreportDumpsFinished(calling_uid);
3238 MaybeCheckUserConsent(calling_uid, calling_package);
3239 if (options_->telephony_only) {
3240 DumpstateTelephonyOnly(calling_package);
3241 } else if (options_->wifi_only) {
3242 DumpstateWifiOnly();
3243 } else if (options_->limited_only) {
3244 DumpstateLimitedOnly();
3245 } else {
Nandana Dutt4be45d12018-09-26 15:04:23 +01003246 // Dump state for the default case. This also drops root.
Jichao Lie89d9c12019-11-21 19:02:51 -08003247 RunStatus s = DumpstateDefaultAfterCritical();
Nandana Dutt5c390032019-03-12 10:52:56 +00003248 if (s != RunStatus::OK) {
Nandana Duttaac6f582019-07-26 14:32:47 +01003249 if (s == RunStatus::USER_CONSENT_DENIED) {
Nandana Dutt5c390032019-03-12 10:52:56 +00003250 HandleUserConsentDenied();
3251 }
3252 return s;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08003253 }
Zhengyin Qian068ecc72016-08-10 16:48:14 -07003254 }
Felipe Leme71a74ac2016-03-17 15:43:25 -07003255
Felipe Leme55b42a62015-11-10 17:39:08 -08003256 /* close output if needed */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003257 TEMP_FAILURE_RETRY(dup2(dup_stdout_fd, fileno(stdout)));
Colin Crossf45fa6b2012-03-26 12:38:26 -07003258
Abhijeet Kaure370d682019-10-01 16:49:30 +01003259 // Zip the (now complete) .tmp file within the internal directory.
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003260 ATRACE_BEGIN("FinalizeFile");
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003261 FinalizeFile();
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003262 ATRACE_END();
Colin Crossf45fa6b2012-03-26 12:38:26 -07003263
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003264 // Share the final file with the caller if the user has consented or Shell is the caller.
Nandana Duttd2f5f082019-01-18 17:13:52 +00003265 Dumpstate::RunStatus status = Dumpstate::RunStatus::OK;
Gavin Corkerya44686c2022-11-23 18:16:51 +00003266 if (CalledByApi() && !options_->is_consent_deferred) {
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003267 status = CopyBugreportIfUserConsented(calling_uid);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003268 if (status != Dumpstate::RunStatus::OK &&
3269 status != Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
3270 // Do an early return if there were errors. We make an exception for consent
3271 // timing out because it's possible the user got distracted. In this case the
3272 // bugreport is not shared but made available for manual retrieval.
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003273 MYLOGI("User denied consent. Returning\n");
Nandana Duttd2f5f082019-01-18 17:13:52 +00003274 return status;
3275 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003276 if (status == Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
3277 MYLOGI(
3278 "Did not receive user consent yet."
3279 " Will not copy the bugreport artifacts to caller.\n");
Abhijeet Kaur57627412019-04-17 16:00:09 +01003280 const String16 incidentcompanion("incidentcompanion");
3281 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
3282 if (ics != nullptr) {
3283 MYLOGD("Canceling user consent request via incidentcompanion service\n");
3284 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
3285 consent_callback_.get());
3286 } else {
3287 MYLOGD("Unable to cancel user consent; incidentcompanion service unavailable\n");
3288 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003289 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003290 }
3291
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08003292 /* vibrate a few but shortly times to let user know it's finished */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003293 if (options_->do_vibrate) {
Takuya Ogawa47f644e2017-12-20 18:09:09 +09003294 for (int i = 0; i < 3; i++) {
3295 Vibrate(75);
3296 usleep((75 + 50) * 1000);
3297 }
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08003298 }
3299
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003300 MYLOGD("Final progress: %d/%d (estimated %d)\n", progress_->Get(), progress_->GetMax(),
3301 progress_->GetInitialMax());
3302 progress_->Save();
3303 MYLOGI("done (id %d)\n", id_);
Colin Crossf45fa6b2012-03-26 12:38:26 -07003304
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003305 TEMP_FAILURE_RETRY(dup2(dup_stderr_fd, fileno(stderr)));
Felipe Leme107a05f2016-03-08 15:11:15 -08003306
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003307 if (control_socket_fd_ != -1) {
Felipe Lemee844a9d2016-09-21 15:01:39 -07003308 MYLOGD("Closing control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003309 close(control_socket_fd_);
Felipe Leme2628e9e2016-04-12 16:36:51 -07003310 }
3311
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003312 tombstone_data_.clear();
3313 anr_data_.clear();
Woody Lin20767a92022-11-29 15:50:24 +08003314 shutdown_checkpoints_.clear();
Narayan Kamath6b9516c2017-10-27 11:15:51 +01003315
Nandana Duttd2f5f082019-01-18 17:13:52 +00003316 return (consent_callback_ != nullptr &&
3317 consent_callback_->getResult() == UserConsentResult::UNAVAILABLE)
3318 ? USER_CONSENT_TIMED_OUT
3319 : RunStatus::OK;
3320}
3321
Paul Chang0d2aad72020-02-13 20:04:03 +08003322void Dumpstate::MaybeTakeEarlyScreenshot() {
3323 if (!options_->do_screenshot || !do_early_screenshot_) {
3324 return;
3325 }
3326
3327 TakeScreenshot();
3328}
3329
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003330void Dumpstate::MaybeSnapshotSystemTrace() {
3331 // If a background system trace is happening and is marked as "suitable for
3332 // bugreport" (i.e. bugreport_score > 0 in the trace config), this command
3333 // will stop it and serialize into SYSTEM_TRACE_SNAPSHOT. In the (likely)
3334 // case that no trace is ongoing, this command is a no-op.
3335 // Note: this should not be enqueued as we need to freeze the trace before
3336 // dumpstate starts. Otherwise the trace ring buffers will contain mostly
3337 // the dumpstate's own activity which is irrelevant.
3338 int res = RunCommand(
3339 "SERIALIZE PERFETTO TRACE",
3340 {"perfetto", "--save-for-bugreport"},
3341 CommandOptions::WithTimeout(10)
3342 .DropRoot()
3343 .CloseAllFileDescriptorsOnExec()
3344 .Build());
3345 has_system_trace_ = res == 0;
3346 // MaybeAddSystemTraceToZip() will take care of copying the trace in the zip
3347 // file in the later stages.
3348}
3349
Kean Mariotti306633e2022-09-05 16:30:47 +00003350void Dumpstate::MaybeSnapshotUiTraces() {
3351 if (PropertiesHelper::IsUserBuild() || options_->use_predumped_ui_data) {
3352 return;
3353 }
3354
Hongwei Wang39229132023-01-24 15:09:59 -08003355 // Include the proto logging from WMShell.
3356 RunCommand(
3357 // Empty name because it's not intended to be classified as a bugreport section.
3358 // Actual logging files can be found as "/data/misc/wmtrace/shell_log.winscope"
3359 // in the bugreport.
3360 "", {"dumpsys", "activity", "service", "SystemUIService",
3361 "WMShell", "protolog", "save-for-bugreport"},
3362 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3363
Pablo Gamitod96101d2023-03-29 16:16:19 +00003364 for (const auto& service : {"input_method", "window", "window shell"}) {
Yohei Yukawa02b1d2c2021-03-16 09:20:30 -07003365 RunCommand(
3366 // Empty name because it's not intended to be classified as a bugreport section.
3367 // Actual tracing files can be found in "/data/misc/wmtrace/" in the bugreport.
3368 "", {"cmd", service, "tracing", "save-for-bugreport"},
3369 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3370 }
Kean Mariotti306633e2022-09-05 16:30:47 +00003371
3372 static const auto SURFACEFLINGER_COMMAND_SAVE_ALL_TRACES = std::vector<std::string> {
3373 "service", "call", "SurfaceFlinger", "1042"
3374 };
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 RunCommand(
3378 "", SURFACEFLINGER_COMMAND_SAVE_ALL_TRACES,
3379 CommandOptions::WithTimeout(10).Always().AsRoot().RedirectStderr().Build());
3380}
3381
3382void Dumpstate::MaybePostProcessUiTraces() {
3383 if (PropertiesHelper::IsUserBuild()) {
3384 return;
3385 }
3386
3387 RunCommand(
3388 // Empty name because it's not intended to be classified as a bugreport section.
3389 // Actual tracing files can be found in "/data/misc/wmtrace/" in the bugreport.
3390 "", {
3391 "/system/xbin/su", "system",
3392 "/system/bin/layertracegenerator",
3393 "/data/misc/wmtrace/transactions_trace.winscope",
3394 "/data/misc/wmtrace/layers_trace_from_transactions.winscope"
3395 },
3396 CommandOptions::WithTimeout(120).Always().RedirectStderr().Build());
3397}
3398
3399void Dumpstate::MaybeAddUiTracesToZip() {
3400 if (PropertiesHelper::IsUserBuild()) {
3401 return;
3402 }
3403
3404 ds.AddDir(WMTRACE_DATA_DIR, false);
Yohei Yukawa95305b32021-03-09 07:54:27 -08003405}
3406
Paul Changeb4b4642020-05-28 22:05:47 +08003407void Dumpstate::onUiIntensiveBugreportDumpsFinished(int32_t calling_uid) {
Nikhil Kumar28ce35e2023-01-10 14:32:44 +00003408 if (multiuser_get_app_id(calling_uid) == AID_SHELL || !CalledByApi()) {
Paul Changc490e662020-04-11 18:14:09 +08003409 return;
3410 }
3411 if (listener_ != nullptr) {
3412 // Let listener know ui intensive bugreport dumps are finished, then it can do event
3413 // handling if required.
Paul Changeb4b4642020-05-28 22:05:47 +08003414 listener_->onUiIntensiveBugreportDumpsFinished();
Paul Changc490e662020-04-11 18:14:09 +08003415 }
3416}
3417
Jichao Lie89d9c12019-11-21 19:02:51 -08003418void Dumpstate::MaybeCheckUserConsent(int32_t calling_uid, const std::string& calling_package) {
Gavin Corkerya44686c2022-11-23 18:16:51 +00003419 if (multiuser_get_app_id(calling_uid) == AID_SHELL ||
3420 !CalledByApi() || options_->is_consent_deferred) {
3421 // No need to get consent for shell triggered dumpstates, or not
3422 // through bugreporting API (i.e. no fd to copy back), or when consent
3423 // is deferred.
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003424 return;
3425 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003426 consent_callback_ = new ConsentCallback();
3427 const String16 incidentcompanion("incidentcompanion");
3428 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
Jichao Lie89d9c12019-11-21 19:02:51 -08003429 android::String16 package(calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003430 if (ics != nullptr) {
3431 MYLOGD("Checking user consent via incidentcompanion service\n");
Steven Leeb573eb82022-11-29 22:31:35 +08003432 int flags = 0x1; // IncidentManager.FLAG_CONFIRMATION_DIALOG
3433 if (IsConsentlessBugreportAllowed(*options_)) {
3434 flags |= 0x2; // IncidentManager.FLAG_ALLOW_CONSENTLESS_BUGREPORT
3435 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003436 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
Steven Leeb573eb82022-11-29 22:31:35 +08003437 calling_uid, package, String16(), String16(), flags, consent_callback_.get());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003438 } else {
3439 MYLOGD("Unable to check user consent; incidentcompanion service unavailable\n");
3440 }
3441}
3442
Nandana Dutt5c390032019-03-12 10:52:56 +00003443bool Dumpstate::IsUserConsentDenied() const {
3444 return ds.consent_callback_ != nullptr &&
3445 ds.consent_callback_->getResult() == UserConsentResult::DENIED;
3446}
3447
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01003448bool Dumpstate::CalledByApi() const {
3449 return ds.options_->bugreport_fd.get() != -1 ? true : false;
3450}
3451
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003452void Dumpstate::CleanupTmpFiles() {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003453 android::os::UnlinkAndLogOnError(tmp_path_);
3454 android::os::UnlinkAndLogOnError(screenshot_path_);
3455 android::os::UnlinkAndLogOnError(path_);
Gavin Corkery789d7a52021-02-24 23:52:35 +00003456 if (dump_traces_path != nullptr) {
3457 android::os::UnlinkAndLogOnError(dump_traces_path);
3458 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003459}
3460
Rhed Jao5377d792020-07-16 17:37:39 +08003461void Dumpstate::EnableParallelRunIfNeeded() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003462 if (!PropertiesHelper::IsParallelRun()) {
Rhed Jao5377d792020-07-16 17:37:39 +08003463 return;
3464 }
3465 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003466 zip_entry_tasks_ = std::make_unique<TaskQueue>();
Rhed Jao5377d792020-07-16 17:37:39 +08003467}
3468
3469void Dumpstate::ShutdownDumpPool() {
3470 if (dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08003471 dump_pool_.reset();
Rhed Jao5377d792020-07-16 17:37:39 +08003472 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003473 if (zip_entry_tasks_) {
3474 zip_entry_tasks_->run(/* do_cancel = */true);
3475 zip_entry_tasks_ = nullptr;
3476 }
3477}
3478
3479void Dumpstate::EnqueueAddZipEntryAndCleanupIfNeeded(const std::string& entry_name,
3480 const std::string& entry_path) {
3481 auto func_add_zip_entry_and_cleanup = [=](bool task_cancelled) {
3482 if (!task_cancelled) {
3483 AddZipEntry(entry_name, entry_path);
3484 }
3485 android::os::UnlinkAndLogOnError(entry_path);
3486 };
3487 if (zip_entry_tasks_) {
3488 // Enqueues AddZipEntryAndCleanup function if the parallel run is enabled.
3489 zip_entry_tasks_->add(func_add_zip_entry_and_cleanup, _1);
3490 } else {
3491 // Invokes AddZipEntryAndCleanup immediately
3492 std::invoke(func_add_zip_entry_and_cleanup, /* task_cancelled = */false);
3493 }
Rhed Jao5377d792020-07-16 17:37:39 +08003494}
3495
Nandana Duttd2f5f082019-01-18 17:13:52 +00003496Dumpstate::RunStatus Dumpstate::HandleUserConsentDenied() {
3497 MYLOGD("User denied consent; deleting files and returning\n");
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003498 CleanupTmpFiles();
Nandana Duttd2f5f082019-01-18 17:13:52 +00003499 return USER_CONSENT_DENIED;
3500}
3501
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003502Dumpstate::RunStatus Dumpstate::CopyBugreportIfUserConsented(int32_t calling_uid) {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003503 // If the caller has asked to copy the bugreport over to their directory, we need explicit
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003504 // user consent (unless the caller is Shell).
3505 UserConsentResult consent_result;
Nikhil Kumar28ce35e2023-01-10 14:32:44 +00003506 if (multiuser_get_app_id(calling_uid) == AID_SHELL) {
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003507 consent_result = UserConsentResult::APPROVED;
3508 } else {
3509 consent_result = consent_callback_->getResult();
3510 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003511 if (consent_result == UserConsentResult::UNAVAILABLE) {
3512 // User has not responded yet.
3513 uint64_t elapsed_ms = consent_callback_->getElapsedTimeMs();
Hunter Knepshield70610fa2020-01-03 15:27:33 -08003514 // Telephony is a fast report type, particularly on user builds where information may be
3515 // more aggressively limited. To give the user time to read the consent dialog, increase the
3516 // timeout.
3517 uint64_t timeout_ms = options_->telephony_only ? TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS
3518 : USER_CONSENT_TIMEOUT_MS;
3519 if (elapsed_ms < timeout_ms) {
3520 uint delay_seconds = (timeout_ms - elapsed_ms) / 1000;
Nandana Duttd2f5f082019-01-18 17:13:52 +00003521 MYLOGD("Did not receive user consent yet; going to wait for %d seconds", delay_seconds);
3522 sleep(delay_seconds);
3523 }
3524 consent_result = consent_callback_->getResult();
3525 }
3526 if (consent_result == UserConsentResult::DENIED) {
3527 // User has explicitly denied sharing with the app. To be safe delete the
3528 // internal bugreport & tmp files.
3529 return HandleUserConsentDenied();
3530 }
3531 if (consent_result == UserConsentResult::APPROVED) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00003532 bool copy_succeeded = android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
3533 if (copy_succeeded) {
3534 android::os::UnlinkAndLogOnError(path_);
Abhijeet Kaur9ce94672020-04-01 17:22:36 +01003535 if (options_->do_screenshot &&
3536 options_->screenshot_fd.get() != -1 &&
3537 !options_->is_screenshot_copied) {
3538 copy_succeeded = android::os::CopyFileToFd(screenshot_path_,
3539 options_->screenshot_fd.get());
3540 options_->is_screenshot_copied = copy_succeeded;
3541 if (copy_succeeded) {
3542 android::os::UnlinkAndLogOnError(screenshot_path_);
3543 }
3544 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003545 }
3546 return copy_succeeded ? Dumpstate::RunStatus::OK : Dumpstate::RunStatus::ERROR;
3547 } else if (consent_result == UserConsentResult::UNAVAILABLE) {
3548 // consent_result is still UNAVAILABLE. The user has likely not responded yet.
3549 // Since we do not have user consent to share the bugreport it does not get
3550 // copied over to the calling app but remains in the internal directory from
3551 // where the user can manually pull it.
Paul Changce644212021-05-11 16:06:45 +08003552 std::string final_path = GetPath(".zip");
3553 bool copy_succeeded = android::os::CopyFileToFile(path_, final_path);
3554 if (copy_succeeded) {
3555 android::os::UnlinkAndLogOnError(path_);
3556 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003557 return Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT;
3558 }
3559 // Unknown result; must be a programming error.
3560 MYLOGE("Unknown user consent result:%d\n", consent_result);
3561 return Dumpstate::RunStatus::ERROR;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003562}
3563
Nandana Duttf02564e2019-02-15 15:24:24 +00003564Dumpstate::RunStatus Dumpstate::ParseCommandlineAndRun(int argc, char* argv[]) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003565 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
3566 Dumpstate::RunStatus status = options->Initialize(argc, argv);
3567 if (status == Dumpstate::RunStatus::OK) {
Nandana Duttf02564e2019-02-15 15:24:24 +00003568 SetOptions(std::move(options));
Nandana Duttd2f5f082019-01-18 17:13:52 +00003569 // When directly running dumpstate binary, the output is not expected to be written
3570 // to any external file descriptor.
Nandana Duttf02564e2019-02-15 15:24:24 +00003571 assert(options_->bugreport_fd.get() == -1);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003572
3573 // calling_uid and calling_package are for user consent to share the bugreport with
Abhijeet Kaura407fb82020-03-27 12:51:12 +00003574 // an app; they are irrelevant here because bugreport is triggered via command line.
3575 // Update Last ID before calling Run().
3576 Initialize();
Nandana Duttf02564e2019-02-15 15:24:24 +00003577 status = Run(-1 /* calling_uid */, "" /* calling_package */);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003578 }
Nandana Duttf02564e2019-02-15 15:24:24 +00003579 return status;
3580}
3581
3582/* Main entry point for dumpstate binary. */
3583int run_main(int argc, char* argv[]) {
3584 Dumpstate::RunStatus status = ds.ParseCommandlineAndRun(argc, argv);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003585
3586 switch (status) {
3587 case Dumpstate::RunStatus::OK:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003588 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003589 case Dumpstate::RunStatus::HELP:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003590 ShowUsage();
3591 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003592 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003593 fprintf(stderr, "Invalid combination of args\n");
3594 ShowUsage();
3595 exit(1);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003596 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00003597 FALLTHROUGH_INTENDED;
3598 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
3599 FALLTHROUGH_INTENDED;
3600 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003601 exit(2);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003602 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003603}
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003604
3605// TODO(111441001): Default DumpOptions to sensible values.
3606Dumpstate::Dumpstate(const std::string& version)
3607 : pid_(getpid()),
3608 options_(new Dumpstate::DumpOptions()),
Nandana Dutt402a8392019-06-14 14:25:13 +01003609 last_reported_percent_progress_(0),
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003610 version_(version),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003611 now_(time(nullptr)),
3612 open_socket_fn_(open_socket) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003613}
3614
3615Dumpstate& Dumpstate::GetInstance() {
3616 static Dumpstate singleton_(android::base::GetProperty("dumpstate.version", VERSION_CURRENT));
3617 return singleton_;
3618}
3619
Rhed Jao5377d792020-07-16 17:37:39 +08003620DurationReporter::DurationReporter(const std::string& title, bool logcat_only, bool verbose,
3621 int duration_fd) : title_(title), logcat_only_(logcat_only), verbose_(verbose),
3622 duration_fd_(duration_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003623 if (!title_.empty()) {
3624 started_ = Nanotime();
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003625 if (title_.find("SHOW MAP") == std::string::npos) {
3626 ATRACE_ASYNC_BEGIN(title_.c_str(), 0);
3627 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003628 }
3629}
3630
3631DurationReporter::~DurationReporter() {
3632 if (!title_.empty()) {
3633 float elapsed = (float)(Nanotime() - started_) / NANOS_PER_SEC;
chenqiwuaf8b2d92019-12-12 18:53:51 +08003634 if (elapsed >= .5f || verbose_) {
3635 MYLOGD("Duration of '%s': %.2fs\n", title_.c_str(), elapsed);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003636 }
chenqiwuaf8b2d92019-12-12 18:53:51 +08003637 if (!logcat_only_) {
3638 // Use "Yoda grammar" to make it easier to grep|sort sections.
Rhed Jao5377d792020-07-16 17:37:39 +08003639 dprintf(duration_fd_, "------ %.3fs was the duration of '%s' ------\n",
3640 elapsed, title_.c_str());
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003641 }
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003642 if (title_.find("SHOW MAP") == std::string::npos) {
3643 ATRACE_ASYNC_END(title_.c_str(), 0);
3644 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003645 }
3646}
3647
3648const int32_t Progress::kDefaultMax = 5000;
3649
3650Progress::Progress(const std::string& path) : Progress(Progress::kDefaultMax, 1.1, path) {
3651}
3652
3653Progress::Progress(int32_t initial_max, int32_t progress, float growth_factor)
3654 : Progress(initial_max, growth_factor, "") {
3655 progress_ = progress;
3656}
3657
3658Progress::Progress(int32_t initial_max, float growth_factor, const std::string& path)
3659 : initial_max_(initial_max),
3660 progress_(0),
3661 max_(initial_max),
3662 growth_factor_(growth_factor),
3663 n_runs_(0),
3664 average_max_(0),
3665 path_(path) {
3666 if (!path_.empty()) {
3667 Load();
3668 }
3669}
3670
3671void Progress::Load() {
3672 MYLOGD("Loading stats from %s\n", path_.c_str());
3673 std::string content;
3674 if (!android::base::ReadFileToString(path_, &content)) {
3675 MYLOGI("Could not read stats from %s; using max of %d\n", path_.c_str(), max_);
3676 return;
3677 }
3678 if (content.empty()) {
3679 MYLOGE("No stats (empty file) on %s; using max of %d\n", path_.c_str(), max_);
3680 return;
3681 }
3682 std::vector<std::string> lines = android::base::Split(content, "\n");
3683
3684 if (lines.size() < 1) {
3685 MYLOGE("Invalid stats on file %s: not enough lines (%d). Using max of %d\n", path_.c_str(),
3686 (int)lines.size(), max_);
3687 return;
3688 }
3689 char* ptr;
3690 n_runs_ = strtol(lines[0].c_str(), &ptr, 10);
3691 average_max_ = strtol(ptr, nullptr, 10);
3692 if (n_runs_ <= 0 || average_max_ <= 0 || n_runs_ > STATS_MAX_N_RUNS ||
3693 average_max_ > STATS_MAX_AVERAGE) {
3694 MYLOGE("Invalid stats line on file %s: %s\n", path_.c_str(), lines[0].c_str());
3695 initial_max_ = Progress::kDefaultMax;
3696 } else {
3697 initial_max_ = average_max_;
3698 }
3699 max_ = initial_max_;
3700
3701 MYLOGI("Average max progress: %d in %d runs; estimated max: %d\n", average_max_, n_runs_, max_);
3702}
3703
3704void Progress::Save() {
3705 int32_t total = n_runs_ * average_max_ + progress_;
3706 int32_t runs = n_runs_ + 1;
3707 int32_t average = floor(((float)total) / runs);
3708 MYLOGI("Saving stats (total=%d, runs=%d, average=%d) on %s\n", total, runs, average,
3709 path_.c_str());
3710 if (path_.empty()) {
3711 return;
3712 }
3713
3714 std::string content = android::base::StringPrintf("%d %d\n", runs, average);
3715 if (!android::base::WriteStringToFile(content, path_)) {
3716 MYLOGE("Could not save stats on %s\n", path_.c_str());
3717 }
3718}
3719
3720int32_t Progress::Get() const {
3721 return progress_;
3722}
3723
3724bool Progress::Inc(int32_t delta_sec) {
3725 bool changed = false;
3726 if (delta_sec >= 0) {
3727 progress_ += delta_sec;
3728 if (progress_ > max_) {
3729 int32_t old_max = max_;
3730 max_ = floor((float)progress_ * growth_factor_);
3731 MYLOGD("Adjusting max progress from %d to %d\n", old_max, max_);
3732 changed = true;
3733 }
3734 }
3735 return changed;
3736}
3737
3738int32_t Progress::GetMax() const {
3739 return max_;
3740}
3741
3742int32_t Progress::GetInitialMax() const {
3743 return initial_max_;
3744}
3745
3746void Progress::Dump(int fd, const std::string& prefix) const {
3747 const char* pr = prefix.c_str();
3748 dprintf(fd, "%sprogress: %d\n", pr, progress_);
3749 dprintf(fd, "%smax: %d\n", pr, max_);
3750 dprintf(fd, "%sinitial_max: %d\n", pr, initial_max_);
3751 dprintf(fd, "%sgrowth_factor: %0.2f\n", pr, growth_factor_);
3752 dprintf(fd, "%spath: %s\n", pr, path_.c_str());
3753 dprintf(fd, "%sn_runs: %d\n", pr, n_runs_);
3754 dprintf(fd, "%saverage_max: %d\n", pr, average_max_);
3755}
3756
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003757std::string Dumpstate::GetPath(const std::string& suffix) const {
3758 return GetPath(bugreport_internal_dir_, suffix);
3759}
3760
3761std::string Dumpstate::GetPath(const std::string& directory, const std::string& suffix) const {
3762 return android::base::StringPrintf("%s/%s-%s%s", directory.c_str(), base_name_.c_str(),
3763 name_.c_str(), suffix.c_str());
3764}
3765
3766void Dumpstate::SetProgress(std::unique_ptr<Progress> progress) {
3767 progress_ = std::move(progress);
3768}
3769
3770void for_each_userid(void (*func)(int), const char *header) {
3771 std::string title = header == nullptr ? "for_each_userid" : android::base::StringPrintf(
3772 "for_each_userid(%s)", header);
3773 DurationReporter duration_reporter(title);
3774 if (PropertiesHelper::IsDryRun()) return;
3775
3776 DIR *d;
3777 struct dirent *de;
3778
3779 if (header) printf("\n------ %s ------\n", header);
3780 func(0);
3781
3782 if (!(d = opendir("/data/system/users"))) {
3783 printf("Failed to open /data/system/users (%s)\n", strerror(errno));
3784 return;
3785 }
3786
3787 while ((de = readdir(d))) {
3788 int userid;
3789 if (de->d_type != DT_DIR || !(userid = atoi(de->d_name))) {
3790 continue;
3791 }
3792 func(userid);
3793 }
3794
3795 closedir(d);
3796}
3797
3798static void __for_each_pid(void (*helper)(int, const char *, void *), const char *header, void *arg) {
3799 DIR *d;
3800 struct dirent *de;
3801
3802 if (!(d = opendir("/proc"))) {
3803 printf("Failed to open /proc (%s)\n", strerror(errno));
3804 return;
3805 }
3806
3807 if (header) printf("\n------ %s ------\n", header);
3808 while ((de = readdir(d))) {
3809 if (ds.IsUserConsentDenied()) {
3810 MYLOGE(
3811 "Returning early because user denied consent to share bugreport with calling app.");
3812 closedir(d);
3813 return;
3814 }
3815 int pid;
3816 int fd;
3817 char cmdpath[255];
3818 char cmdline[255];
3819
3820 if (!(pid = atoi(de->d_name))) {
3821 continue;
3822 }
3823
3824 memset(cmdline, 0, sizeof(cmdline));
3825
3826 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/cmdline", pid);
3827 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3828 TEMP_FAILURE_RETRY(read(fd, cmdline, sizeof(cmdline) - 2));
3829 close(fd);
3830 if (cmdline[0]) {
3831 helper(pid, cmdline, arg);
3832 continue;
3833 }
3834 }
3835
3836 // if no cmdline, a kernel thread has comm
3837 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/comm", pid);
3838 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3839 TEMP_FAILURE_RETRY(read(fd, cmdline + 1, sizeof(cmdline) - 4));
3840 close(fd);
3841 if (cmdline[1]) {
3842 cmdline[0] = '[';
3843 size_t len = strcspn(cmdline, "\f\b\r\n");
3844 cmdline[len] = ']';
3845 cmdline[len+1] = '\0';
3846 }
3847 }
3848 if (!cmdline[0]) {
3849 strcpy(cmdline, "N/A");
3850 }
3851 helper(pid, cmdline, arg);
3852 }
3853
3854 closedir(d);
3855}
3856
3857static void for_each_pid_helper(int pid, const char *cmdline, void *arg) {
3858 for_each_pid_func *func = (for_each_pid_func*) arg;
3859 func(pid, cmdline);
3860}
3861
3862void for_each_pid(for_each_pid_func func, const char *header) {
3863 std::string title = header == nullptr ? "for_each_pid"
3864 : android::base::StringPrintf("for_each_pid(%s)", header);
3865 DurationReporter duration_reporter(title);
3866 if (PropertiesHelper::IsDryRun()) return;
3867
3868 __for_each_pid(for_each_pid_helper, header, (void *) func);
3869}
3870
3871static void for_each_tid_helper(int pid, const char *cmdline, void *arg) {
3872 DIR *d;
3873 struct dirent *de;
3874 char taskpath[255];
3875 for_each_tid_func *func = (for_each_tid_func *) arg;
3876
3877 snprintf(taskpath, sizeof(taskpath), "/proc/%d/task", pid);
3878
3879 if (!(d = opendir(taskpath))) {
3880 printf("Failed to open %s (%s)\n", taskpath, strerror(errno));
3881 return;
3882 }
3883
3884 func(pid, pid, cmdline);
3885
3886 while ((de = readdir(d))) {
3887 if (ds.IsUserConsentDenied()) {
3888 MYLOGE(
3889 "Returning early because user denied consent to share bugreport with calling app.");
3890 closedir(d);
3891 return;
3892 }
3893 int tid;
3894 int fd;
3895 char commpath[255];
3896 char comm[255];
3897
3898 if (!(tid = atoi(de->d_name))) {
3899 continue;
3900 }
3901
3902 if (tid == pid)
3903 continue;
3904
3905 snprintf(commpath, sizeof(commpath), "/proc/%d/comm", tid);
3906 memset(comm, 0, sizeof(comm));
3907 if ((fd = TEMP_FAILURE_RETRY(open(commpath, O_RDONLY | O_CLOEXEC))) < 0) {
3908 strcpy(comm, "N/A");
3909 } else {
3910 char *c;
3911 TEMP_FAILURE_RETRY(read(fd, comm, sizeof(comm) - 2));
3912 close(fd);
3913
3914 c = strrchr(comm, '\n');
3915 if (c) {
3916 *c = '\0';
3917 }
3918 }
3919 func(pid, tid, comm);
3920 }
3921
3922 closedir(d);
3923}
3924
3925void for_each_tid(for_each_tid_func func, const char *header) {
3926 std::string title = header == nullptr ? "for_each_tid"
3927 : android::base::StringPrintf("for_each_tid(%s)", header);
3928 DurationReporter duration_reporter(title);
3929
3930 if (PropertiesHelper::IsDryRun()) return;
3931
3932 __for_each_pid(for_each_tid_helper, header, (void *) func);
3933}
3934
3935void show_wchan(int pid, int tid, const char *name) {
3936 if (PropertiesHelper::IsDryRun()) return;
3937
3938 char path[255];
3939 char buffer[255];
3940 int fd, ret, save_errno;
3941 char name_buffer[255];
3942
3943 memset(buffer, 0, sizeof(buffer));
3944
3945 snprintf(path, sizeof(path), "/proc/%d/wchan", tid);
3946 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3947 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3948 return;
3949 }
3950
3951 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3952 save_errno = errno;
3953 close(fd);
3954
3955 if (ret < 0) {
3956 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3957 return;
3958 }
3959
3960 snprintf(name_buffer, sizeof(name_buffer), "%*s%s",
3961 pid == tid ? 0 : 3, "", name);
3962
3963 printf("%-7d %-32s %s\n", tid, name_buffer, buffer);
3964
3965 return;
3966}
3967
3968// print time in centiseconds
3969static void snprcent(char *buffer, size_t len, size_t spc,
3970 unsigned long long time) {
3971 static long hz; // cache discovered hz
3972
3973 if (hz <= 0) {
3974 hz = sysconf(_SC_CLK_TCK);
3975 if (hz <= 0) {
3976 hz = 1000;
3977 }
3978 }
3979
3980 // convert to centiseconds
3981 time = (time * 100 + (hz / 2)) / hz;
3982
3983 char str[16];
3984
3985 snprintf(str, sizeof(str), " %llu.%02u",
3986 time / 100, (unsigned)(time % 100));
3987 size_t offset = strlen(buffer);
3988 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3989 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3990}
3991
3992// print permille as a percent
3993static void snprdec(char *buffer, size_t len, size_t spc, unsigned permille) {
3994 char str[16];
3995
3996 snprintf(str, sizeof(str), " %u.%u%%", permille / 10, permille % 10);
3997 size_t offset = strlen(buffer);
3998 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3999 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
4000}
4001
4002void show_showtime(int pid, const char *name) {
4003 if (PropertiesHelper::IsDryRun()) return;
4004
4005 char path[255];
4006 char buffer[1023];
4007 int fd, ret, save_errno;
4008
4009 memset(buffer, 0, sizeof(buffer));
4010
4011 snprintf(path, sizeof(path), "/proc/%d/stat", pid);
4012 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
4013 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
4014 return;
4015 }
4016
4017 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
4018 save_errno = errno;
4019 close(fd);
4020
4021 if (ret < 0) {
4022 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
4023 return;
4024 }
4025
4026 // field 14 is utime
4027 // field 15 is stime
4028 // field 42 is iotime
4029 unsigned long long utime = 0, stime = 0, iotime = 0;
4030 if (sscanf(buffer,
4031 "%*u %*s %*s %*d %*d %*d %*d %*d %*d %*d %*d "
4032 "%*d %*d %llu %llu %*d %*d %*d %*d %*d %*d "
4033 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %*d "
4034 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %llu ",
4035 &utime, &stime, &iotime) != 3) {
4036 return;
4037 }
4038
4039 unsigned long long total = utime + stime;
4040 if (!total) {
4041 return;
4042 }
4043
4044 unsigned permille = (iotime * 1000 + (total / 2)) / total;
4045 if (permille > 1000) {
4046 permille = 1000;
4047 }
4048
4049 // try to beautify and stabilize columns at <80 characters
4050 snprintf(buffer, sizeof(buffer), "%-6d%s", pid, name);
4051 if ((name[0] != '[') || utime) {
4052 snprcent(buffer, sizeof(buffer), 57, utime);
4053 }
4054 snprcent(buffer, sizeof(buffer), 65, stime);
4055 if ((name[0] != '[') || iotime) {
4056 snprcent(buffer, sizeof(buffer), 73, iotime);
4057 }
4058 if (iotime) {
4059 snprdec(buffer, sizeof(buffer), 79, permille);
4060 }
4061 puts(buffer); // adds a trailing newline
4062
4063 return;
4064}
4065
4066void do_dmesg() {
4067 const char *title = "KERNEL LOG (dmesg)";
4068 DurationReporter duration_reporter(title);
4069 printf("------ %s ------\n", title);
4070
4071 if (PropertiesHelper::IsDryRun()) return;
4072
4073 /* Get size of kernel buffer */
4074 int size = klogctl(KLOG_SIZE_BUFFER, nullptr, 0);
4075 if (size <= 0) {
4076 printf("Unexpected klogctl return value: %d\n\n", size);
4077 return;
4078 }
4079 char *buf = (char *) malloc(size + 1);
4080 if (buf == nullptr) {
4081 printf("memory allocation failed\n\n");
4082 return;
4083 }
4084 int retval = klogctl(KLOG_READ_ALL, buf, size);
4085 if (retval < 0) {
4086 printf("klogctl failure\n\n");
4087 free(buf);
4088 return;
4089 }
4090 buf[retval] = '\0';
4091 printf("%s\n\n", buf);
4092 free(buf);
4093 return;
4094}
4095
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004096int Dumpstate::DumpFile(const std::string& title, const std::string& path) {
4097 DurationReporter duration_reporter(title);
4098
4099 int status = DumpFileToFd(STDOUT_FILENO, title, path);
4100
4101 UpdateProgress(WEIGHT_FILE);
4102
4103 return status;
4104}
4105
4106int read_file_as_long(const char *path, long int *output) {
4107 int fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC));
4108 if (fd < 0) {
4109 int err = errno;
4110 MYLOGE("Error opening file descriptor for %s: %s\n", path, strerror(err));
4111 return -1;
4112 }
4113 char buffer[50];
4114 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
4115 if (bytes_read == -1) {
4116 MYLOGE("Error reading file %s: %s\n", path, strerror(errno));
4117 return -2;
4118 }
4119 if (bytes_read == 0) {
4120 MYLOGE("File %s is empty\n", path);
4121 return -3;
4122 }
4123 *output = atoi(buffer);
4124 return 0;
4125}
4126
4127/* calls skip to gate calling dump_from_fd recursively
4128 * in the specified directory. dump_from_fd defaults to
4129 * dump_file_from_fd above when set to NULL. skip defaults
4130 * to false when set to NULL. dump_from_fd will always be
4131 * called with title NULL.
4132 */
4133int dump_files(const std::string& title, const char* dir, bool (*skip)(const char* path),
4134 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
4135 DurationReporter duration_reporter(title);
4136 DIR *dirp;
4137 struct dirent *d;
4138 char *newpath = nullptr;
4139 const char *slash = "/";
4140 int retval = 0;
4141
4142 if (!title.empty()) {
4143 printf("------ %s (%s) ------\n", title.c_str(), dir);
4144 }
4145 if (PropertiesHelper::IsDryRun()) return 0;
4146
4147 if (dir[strlen(dir) - 1] == '/') {
4148 ++slash;
4149 }
4150 dirp = opendir(dir);
4151 if (dirp == nullptr) {
4152 retval = -errno;
4153 MYLOGE("%s: %s\n", dir, strerror(errno));
4154 return retval;
4155 }
4156
4157 if (!dump_from_fd) {
4158 dump_from_fd = dump_file_from_fd;
4159 }
4160 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
4161 if ((d->d_name[0] == '.')
4162 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
4163 || (d->d_name[1] == '\0'))) {
4164 continue;
4165 }
4166 asprintf(&newpath, "%s%s%s%s", dir, slash, d->d_name,
4167 (d->d_type == DT_DIR) ? "/" : "");
4168 if (!newpath) {
4169 retval = -errno;
4170 continue;
4171 }
4172 if (skip && (*skip)(newpath)) {
4173 continue;
4174 }
4175 if (d->d_type == DT_DIR) {
4176 int ret = dump_files("", newpath, skip, dump_from_fd);
4177 if (ret < 0) {
4178 retval = ret;
4179 }
4180 continue;
4181 }
4182 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(newpath, O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
4183 if (fd.get() < 0) {
4184 retval = -1;
4185 printf("*** %s: %s\n", newpath, strerror(errno));
4186 continue;
4187 }
4188 (*dump_from_fd)(nullptr, newpath, fd.get());
4189 }
4190 closedir(dirp);
4191 if (!title.empty()) {
4192 printf("\n");
4193 }
4194 return retval;
4195}
4196
4197/* fd must have been opened with the flag O_NONBLOCK. With this flag set,
4198 * it's possible to avoid issues where opening the file itself can get
4199 * stuck.
4200 */
4201int dump_file_from_fd(const char *title, const char *path, int fd) {
4202 if (PropertiesHelper::IsDryRun()) return 0;
4203
4204 int flags = fcntl(fd, F_GETFL);
4205 if (flags == -1) {
4206 printf("*** %s: failed to get flags on fd %d: %s\n", path, fd, strerror(errno));
4207 return -1;
4208 } else if (!(flags & O_NONBLOCK)) {
4209 printf("*** %s: fd must have O_NONBLOCK set.\n", path);
4210 return -1;
4211 }
4212 return DumpFileFromFdToFd(title, path, fd, STDOUT_FILENO, PropertiesHelper::IsDryRun());
4213}
4214
4215int Dumpstate::RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08004216 const CommandOptions& options, bool verbose_duration, int out_fd) {
4217 DurationReporter duration_reporter(title, false /* logcat_only */,
4218 verbose_duration, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004219
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08004220 int status = RunCommandToFd(out_fd, title, full_command, options);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004221
4222 /* TODO: for now we're simplifying the progress calculation by using the
4223 * timeout as the weight. It's a good approximation for most cases, except when calling dumpsys,
4224 * where its weight should be much higher proportionally to its timeout.
4225 * Ideally, it should use a options.EstimatedDuration() instead...*/
4226 UpdateProgress(options.Timeout());
4227
4228 return status;
4229}
4230
4231void Dumpstate::RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsys_args,
Rhed Jaoe017f982020-07-21 17:58:41 +08004232 const CommandOptions& options, long dumpsysTimeoutMs, int out_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004233 long timeout_ms = dumpsysTimeoutMs > 0 ? dumpsysTimeoutMs : options.TimeoutInMs();
4234 std::vector<std::string> dumpsys = {"/system/bin/dumpsys", "-T", std::to_string(timeout_ms)};
4235 dumpsys.insert(dumpsys.end(), dumpsys_args.begin(), dumpsys_args.end());
Rhed Jaoe017f982020-07-21 17:58:41 +08004236 RunCommand(title, dumpsys, options, false, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004237}
4238
Dieter Hsu105ad0c2020-09-29 15:23:33 +08004239static int open_socket(const char* service) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004240 int s = android_get_control_socket(service);
4241 if (s < 0) {
4242 MYLOGE("android_get_control_socket(%s): %s\n", service, strerror(errno));
4243 return -1;
4244 }
4245 fcntl(s, F_SETFD, FD_CLOEXEC);
4246
4247 // Set backlog to 0 to make sure that queue size will be minimum.
4248 // In Linux, because the minimum queue will be 1, connect() will be blocked
4249 // if the other clients already called connect() and the connection request was not accepted.
4250 if (listen(s, 0) < 0) {
4251 MYLOGE("listen(control socket): %s\n", strerror(errno));
4252 return -1;
4253 }
4254
4255 struct sockaddr addr;
4256 socklen_t alen = sizeof(addr);
Abhijeet Kaur2113cae2019-09-13 09:24:15 +01004257 int fd = accept4(s, &addr, &alen, SOCK_CLOEXEC);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004258
4259 // Close socket just after accept(), to make sure that connect() by client will get error
4260 // when the socket is used by the other services.
4261 // There is still a race condition possibility between accept and close, but there is no way
4262 // to close-on-accept atomically.
4263 // See detail; b/123306389#comment25
4264 close(s);
4265
4266 if (fd < 0) {
4267 MYLOGE("accept(control socket): %s\n", strerror(errno));
4268 return -1;
4269 }
4270
4271 return fd;
4272}
4273
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004274// TODO: should call is_valid_output_file and/or be merged into it.
4275void create_parent_dirs(const char *path) {
4276 char *chp = const_cast<char *> (path);
4277
4278 /* skip initial slash */
4279 if (chp[0] == '/')
4280 chp++;
4281
4282 /* create leading directories, if necessary */
4283 struct stat dir_stat;
4284 while (chp && chp[0]) {
4285 chp = strchr(chp, '/');
4286 if (chp) {
4287 *chp = 0;
4288 if (stat(path, &dir_stat) == -1 || !S_ISDIR(dir_stat.st_mode)) {
4289 MYLOGI("Creating directory %s\n", path);
4290 if (mkdir(path, 0770)) { /* drwxrwx--- */
4291 MYLOGE("Unable to create directory %s: %s\n", path, strerror(errno));
4292 } else if (chown(path, AID_SHELL, AID_SHELL)) {
4293 MYLOGE("Unable to change ownership of dir %s: %s\n", path, strerror(errno));
4294 }
4295 }
4296 *chp++ = '/';
4297 }
4298 }
4299}
4300
4301bool _redirect_to_file(FILE* redirect, char* path, int truncate_flag) {
4302 create_parent_dirs(path);
4303
4304 int fd = TEMP_FAILURE_RETRY(open(path,
4305 O_WRONLY | O_CREAT | truncate_flag | O_CLOEXEC | O_NOFOLLOW,
4306 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH));
4307 if (fd < 0) {
4308 MYLOGE("%s: %s\n", path, strerror(errno));
4309 return false;
4310 }
4311
4312 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
4313 close(fd);
4314 return true;
4315}
4316
4317bool redirect_to_file(FILE* redirect, char* path) {
4318 return _redirect_to_file(redirect, path, O_TRUNC);
4319}
4320
4321bool redirect_to_existing_file(FILE* redirect, char* path) {
4322 return _redirect_to_file(redirect, path, O_APPEND);
4323}
4324
4325void dump_route_tables() {
4326 DurationReporter duration_reporter("DUMP ROUTE TABLES");
4327 if (PropertiesHelper::IsDryRun()) return;
4328 const char* const RT_TABLES_PATH = "/data/misc/net/rt_tables";
4329 ds.DumpFile("RT_TABLES", RT_TABLES_PATH);
4330 FILE* fp = fopen(RT_TABLES_PATH, "re");
4331 if (!fp) {
4332 printf("*** %s: %s\n", RT_TABLES_PATH, strerror(errno));
4333 return;
4334 }
4335 char table[16];
4336 // Each line has an integer (the table number), a space, and a string (the table name). We only
4337 // need the table number. It's a 32-bit unsigned number, so max 10 chars. Skip the table name.
4338 // Add a fixed max limit so this doesn't go awry.
4339 for (int i = 0; i < 64 && fscanf(fp, " %10s %*s", table) == 1; ++i) {
4340 RunCommand("ROUTE TABLE IPv4", {"ip", "-4", "route", "show", "table", table});
4341 RunCommand("ROUTE TABLE IPv6", {"ip", "-6", "route", "show", "table", table});
4342 }
4343 fclose(fp);
4344}
4345
Li Li830179f2022-01-04 12:53:29 -08004346void dump_frozen_cgroupfs(const char *dir, int level,
4347 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
4348 DIR *dirp;
4349 struct dirent *d;
4350 char *newpath = nullptr;
4351
4352 dirp = opendir(dir);
4353 if (dirp == nullptr) {
4354 MYLOGE("%s: %s\n", dir, strerror(errno));
4355 return;
4356 }
4357
4358 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
4359 if ((d->d_name[0] == '.')
4360 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
4361 || (d->d_name[1] == '\0'))) {
4362 continue;
4363 }
4364 if (d->d_type == DT_DIR) {
4365 asprintf(&newpath, "%s/%s/", dir, d->d_name);
4366 if (!newpath) {
4367 continue;
4368 }
4369 if (level == 0 && !strncmp(d->d_name, "uid_", 4)) {
4370 dump_frozen_cgroupfs(newpath, 1, dump_from_fd);
4371 } else if (level == 1 && !strncmp(d->d_name, "pid_", 4)) {
4372 char *freezer = nullptr;
4373 asprintf(&freezer, "%s/%s", newpath, "cgroup.freeze");
4374 if (freezer) {
4375 FILE* fp = fopen(freezer, "r");
4376 if (fp != NULL) {
4377 int frozen;
4378 fscanf(fp, "%d", &frozen);
4379 if (frozen > 0) {
4380 dump_files("", newpath, skip_none, dump_from_fd);
4381 }
4382 fclose(fp);
4383 }
4384 free(freezer);
4385 }
4386 }
4387 }
4388 }
4389 closedir(dirp);
4390}
4391
4392void dump_frozen_cgroupfs() {
Li Li830179f2022-01-04 12:53:29 -08004393 MYLOGD("Adding frozen processes from %s\n", CGROUPFS_DIR);
4394 DurationReporter duration_reporter("FROZEN CGROUPFS");
4395 if (PropertiesHelper::IsDryRun()) return;
4396 dump_frozen_cgroupfs(CGROUPFS_DIR, 0, _add_file_from_fd);
4397}
4398
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004399void Dumpstate::UpdateProgress(int32_t delta_sec) {
4400 if (progress_ == nullptr) {
4401 MYLOGE("UpdateProgress: progress_ not set\n");
4402 return;
4403 }
Rhed Jaobf63d8a2020-07-21 15:42:55 +08004404 // This function updates progress related members of the dumpstate and reports
4405 // progress percentage to the bugreport client. Since it could be called by
4406 // different dump tasks at the same time if the parallel run is enabled, a
4407 // mutex lock is necessary here to synchronize the call.
4408 std::lock_guard<std::recursive_mutex> lock(mutex_);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004409
4410 // Always update progess so stats can be tuned...
Nandana Dutt402a8392019-06-14 14:25:13 +01004411 progress_->Inc(delta_sec);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004412
4413 // ...but only notifiy listeners when necessary.
4414 if (!options_->do_progress_updates) return;
4415
4416 int progress = progress_->Get();
4417 int max = progress_->GetMax();
Nandana Dutt402a8392019-06-14 14:25:13 +01004418 int percent = 100 * progress / max;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004419
Nandana Dutt402a8392019-06-14 14:25:13 +01004420 if (last_reported_percent_progress_ > 0 && percent <= last_reported_percent_progress_) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004421 return;
4422 }
Nandana Dutt402a8392019-06-14 14:25:13 +01004423 last_reported_percent_progress_ = percent;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004424
4425 if (control_socket_fd_ >= 0) {
4426 dprintf(control_socket_fd_, "PROGRESS:%d/%d\n", progress, max);
4427 fsync(control_socket_fd_);
4428 }
4429
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004430 if (listener_ != nullptr) {
Nandana Dutt235c6672019-11-14 15:22:32 +00004431 if (percent % 10 == 0) {
4432 // We don't want to spam logcat, so only log multiples of 10.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004433 MYLOGD("Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004434 } else {
4435 // stderr is ignored on normal invocations, but useful when calling
4436 // /system/bin/dumpstate directly for debuggging.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004437 fprintf(stderr, "Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004438 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004439
4440 listener_->onProgress(percent);
4441 }
4442}
4443
4444void Dumpstate::TakeScreenshot(const std::string& path) {
4445 const std::string& real_path = path.empty() ? screenshot_path_ : path;
4446 int status =
4447 RunCommand("", {"/system/bin/screencap", "-p", real_path},
4448 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
4449 if (status == 0) {
4450 MYLOGD("Screenshot saved on %s\n", real_path.c_str());
4451 } else {
4452 MYLOGE("Failed to take screenshot on %s\n", real_path.c_str());
4453 }
Paul Chang0d2aad72020-02-13 20:04:03 +08004454 if (listener_ != nullptr) {
4455 // Show a visual indication to indicate screenshot is taken via
4456 // IDumpstateListener.onScreenshotTaken()
4457 listener_->onScreenshotTaken(status == 0);
4458 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004459}
4460
4461bool is_dir(const char* pathname) {
4462 struct stat info;
4463 if (stat(pathname, &info) == -1) {
4464 return false;
4465 }
4466 return S_ISDIR(info.st_mode);
4467}
4468
4469time_t get_mtime(int fd, time_t default_mtime) {
4470 struct stat info;
4471 if (fstat(fd, &info) == -1) {
4472 return default_mtime;
4473 }
4474 return info.st_mtime;
4475}