blob: 23cdd10a254b7037bacc71b88b97c50f05179724 [file] [log] [blame]
Colin Crossf45fa6b2012-03-26 12:38:26 -07001/*
2 * Copyright (C) 2008 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
Felipe Lemef0292972016-11-22 13:57:05 -080016
Mark Salyzyn6c3d90f2016-09-27 14:55:27 -070017#define LOG_TAG "dumpstate"
Kevin Jeon2c02e8e2022-07-07 21:45:17 +000018#define ATRACE_TAG ATRACE_TAG_ALWAYS
Colin Crossf45fa6b2012-03-26 12:38:26 -070019
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -070020#include <dirent.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070021#include <errno.h>
22#include <fcntl.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010023#include <inttypes.h>
Felipe Lemead5f6c42015-11-30 14:26:46 -080024#include <libgen.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070025#include <limits.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010026#include <math.h>
27#include <poll.h>
Mark Salyzyn8f37aa52015-06-12 12:28:24 -070028#include <stdbool.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070029#include <stdio.h>
30#include <stdlib.h>
31#include <string.h>
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -070032#include <sys/mount.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080033#include <sys/poll.h>
Christopher Ferris7dc7f322014-07-22 16:08:19 -070034#include <sys/prctl.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070035#include <sys/resource.h>
36#include <sys/stat.h>
37#include <sys/time.h>
38#include <sys/wait.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010039#include <signal.h>
40#include <stdarg.h>
41#include <string.h>
42#include <sys/capability.h>
43#include <sys/inotify.h>
44#include <sys/klog.h>
45#include <time.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070046#include <unistd.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070047
48#include <chrono>
Hridya Valsarajuac582cd2019-08-05 15:39:54 -070049#include <cmath>
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +000050#include <fstream>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070051#include <functional>
52#include <future>
Narayan Kamath8f788292017-05-25 13:20:39 +010053#include <memory>
Hridya Valsarajuac582cd2019-08-05 15:39:54 -070054#include <numeric>
Narayan Kamath8f788292017-05-25 13:20:39 +010055#include <regex>
56#include <set>
57#include <string>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070058#include <utility>
Narayan Kamath8f788292017-05-25 13:20:39 +010059#include <vector>
Colin Crossf45fa6b2012-03-26 12:38:26 -070060
Kedar Chitnis9fd8c052021-11-16 09:09:22 +000061#include <aidl/android/hardware/dumpstate/IDumpstateDevice.h>
Felipe Leme96c2bbb2016-09-26 09:21:21 -070062#include <android-base/file.h>
63#include <android-base/properties.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070064#include <android-base/scopeguard.h>
Elliott Hughes9dc117c2015-12-07 14:21:50 -080065#include <android-base/stringprintf.h>
Naveen Kalla058e1e82016-10-19 21:38:44 -070066#include <android-base/strings.h>
Andreas Gampeaff68432016-07-18 18:01:27 -070067#include <android-base/unique_fd.h>
Kedar Chitnis9fd8c052021-11-16 09:09:22 +000068#include <android/binder_manager.h>
69#include <android/binder_process.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010070#include <android/content/pm/IPackageManagerNative.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080071#include <android/hardware/dumpstate/1.0/IDumpstateDevice.h>
Hunter Knepshield8540faf2020-02-04 19:47:20 -080072#include <android/hardware/dumpstate/1.1/IDumpstateDevice.h>
73#include <android/hardware/dumpstate/1.1/types.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080074#include <android/hidl/manager/1.0/IServiceManager.h>
Nandana Duttd2f5f082019-01-18 17:13:52 +000075#include <android/os/IIncidentCompanion.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010076#include <binder/IServiceManager.h>
Nikhil Kumar28ce35e2023-01-10 14:32:44 +000077#include <cutils/multiuser.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080078#include <cutils/native_handle.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070079#include <cutils/properties.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010080#include <cutils/sockets.h>
Kevin Jeon2c02e8e2022-07-07 21:45:17 +000081#include <cutils/trace.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000082#include <debuggerd/client.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080083#include <dumpsys.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000084#include <dumputils/dump_utils.h>
Sahana Raof35ed432019-07-12 10:47:52 +010085#include <hardware_legacy/power.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080086#include <hidl/ServiceManagement.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010087#include <log/log.h>
Tom Cherryf4472f32020-08-05 09:31:17 -070088#include <log/log_read.h>
Felipe Leme75876a22016-10-27 16:31:27 -070089#include <openssl/sha.h>
Mark Salyzyn6c3d90f2016-09-27 14:55:27 -070090#include <private/android_filesystem_config.h>
91#include <private/android_logger.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080092#include <serviceutils/PriorityDumper.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070093#include <utils/StrongPointer.h>
Devin Moore8df81bb2022-06-08 22:47:02 +000094#include <vintf/VintfObject.h>
Felipe Lemef0292972016-11-22 13:57:05 -080095#include "DumpstateInternal.h"
Felipe Leme75876a22016-10-27 16:31:27 -070096#include "DumpstateService.h"
Colin Crossf45fa6b2012-03-26 12:38:26 -070097#include "dumpstate.h"
Felipe Leme6e01fa62015-11-11 19:35:14 -080098
Kedar Chitnis9fd8c052021-11-16 09:09:22 +000099namespace dumpstate_hal_hidl_1_0 = android::hardware::dumpstate::V1_0;
100namespace dumpstate_hal_hidl = android::hardware::dumpstate::V1_1;
101namespace dumpstate_hal_aidl = aidl::android::hardware::dumpstate;
102
Vishnu Naire97d6122018-01-18 13:58:56 -0800103using ::std::literals::chrono_literals::operator""ms;
104using ::std::literals::chrono_literals::operator""s;
Rhed Jao5377d792020-07-16 17:37:39 +0800105using ::std::placeholders::_1;
Steven Morelandcb7ef822016-11-29 13:20:37 -0800106
Felipe Leme47e9be22016-12-21 15:37:07 -0800107// TODO: remove once moved to namespace
Vishnu Naire97d6122018-01-18 13:58:56 -0800108using android::defaultServiceManager;
109using android::Dumpsys;
110using android::INVALID_OPERATION;
111using android::IServiceManager;
112using android::OK;
113using android::sp;
114using android::status_t;
115using android::String16;
116using android::String8;
117using android::TIMED_OUT;
118using android::UNKNOWN_ERROR;
119using android::Vector;
Nandana Dutt979388e2018-11-30 16:48:55 +0000120using android::base::StringPrintf;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000121using android::os::IDumpstateListener;
Felipe Leme47e9be22016-12-21 15:37:07 -0800122using android::os::dumpstate::CommandOptions;
123using android::os::dumpstate::DumpFileToFd;
Rhed Jao5377d792020-07-16 17:37:39 +0800124using android::os::dumpstate::DumpPool;
Vishnu Naire97d6122018-01-18 13:58:56 -0800125using android::os::dumpstate::PropertiesHelper;
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800126using android::os::dumpstate::TaskQueue;
Chris Morinbc223142022-02-04 14:17:11 -0800127using android::os::dumpstate::WaitForTask;
Felipe Leme47e9be22016-12-21 15:37:07 -0800128
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100129// Keep in sync with
130// frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
131static const int TRACE_DUMP_TIMEOUT_MS = 10000; // 10 seconds
132
133/* Most simple commands have 10 as timeout, so 5 is a good estimate */
134static const int32_t WEIGHT_FILE = 5;
135
136// TODO: temporary variables and functions used during C++ refactoring
137static Dumpstate& ds = Dumpstate::GetInstance();
138static int RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Nandana Dutt8d945c02019-08-14 13:30:07 +0100139 const CommandOptions& options = CommandOptions::DEFAULT,
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800140 bool verbose_duration = false, int out_fd = STDOUT_FILENO) {
141 return ds.RunCommand(title, full_command, options, verbose_duration, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100142}
143
144// Reasonable value for max stats.
145static const int STATS_MAX_N_RUNS = 1000;
146static const long STATS_MAX_AVERAGE = 100000;
147
148CommandOptions Dumpstate::DEFAULT_DUMPSYS = CommandOptions::WithTimeout(30).Build();
149
Nandana Duttd2f5f082019-01-18 17:13:52 +0000150typedef Dumpstate::ConsentCallback::ConsentResult UserConsentResult;
151
Colin Crossf45fa6b2012-03-26 12:38:26 -0700152/* read before root is shed */
153static char cmdline_buf[16384] = "(unknown)";
Yi Kong19d5c002018-07-20 13:39:55 -0700154static const char *dump_traces_path = nullptr;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000155static const uint64_t USER_CONSENT_TIMEOUT_MS = 30 * 1000;
Hunter Knepshield70610fa2020-01-03 15:27:33 -0800156// Because telephony reports are significantly faster to collect (< 10 seconds vs. > 2 minutes),
157// it's often the case that they time out far too quickly for consent with such a hefty dialog for
158// the user to read. For telephony reports only, we increase the default timeout to 2 minutes to
159// roughly match full reports' durations.
160static const uint64_t TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS = 2 * 60 * 1000;
Colin Crossf45fa6b2012-03-26 12:38:26 -0700161
Felipe Leme1d486fe2016-10-14 18:06:47 -0700162// TODO: variables and functions below should be part of dumpstate object
163
Felipe Leme635ca312016-01-05 14:23:02 -0800164static std::set<std::string> mount_points;
165void add_mountinfo();
Felipe Leme78f2c862015-12-21 09:55:22 -0800166
Todd Poynor2a83daa2013-11-22 15:44:22 -0800167#define PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops"
Mark Salyzyn7d0a7622016-06-24 14:06:15 -0700168#define ALT_PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops-0"
Wei Wang509bb5d2017-06-09 14:42:12 -0700169#define BLK_DEV_SYS_DIR "/sys/block"
Todd Poynor2a83daa2013-11-22 15:44:22 -0800170
Felipe Lemee82a27d2016-01-05 13:35:44 -0800171#define RECOVERY_DIR "/cache/recovery"
Mark Salyzynd6ab0112016-03-25 12:56:39 -0700172#define RECOVERY_DATA_DIR "/data/misc/recovery"
Tianjie Xu75d53362018-04-11 16:42:28 -0700173#define UPDATE_ENGINE_LOG_DIR "/data/misc/update_engine_log"
Kelvin Zhang6eaa0f92022-09-12 09:29:19 -0700174#define UPDATE_ENGINE_PREF_DIR "/data/misc/update_engine/prefs"
Mark Salyzyn4d42dea2016-04-01 10:03:14 -0700175#define LOGPERSIST_DATA_DIR "/data/misc/logd"
Jerry Changa1df8a92020-01-02 16:03:39 +0800176#define PREREBOOT_DATA_DIR "/data/misc/prereboot"
David Brazdild2991962016-06-03 14:40:44 +0100177#define PROFILE_DATA_DIR_CUR "/data/misc/profiles/cur"
178#define PROFILE_DATA_DIR_REF "/data/misc/profiles/ref"
Benedict Wong8f9d8a42019-01-03 16:19:38 -0800179#define XFRM_STAT_PROC_FILE "/proc/net/xfrm_stat"
Erik Kline08165202016-05-30 11:55:44 +0900180#define WLUTIL "/vendor/xbin/wlutil"
Vishnu Nair36b4cdb2017-11-17 10:27:05 -0800181#define WMTRACE_DATA_DIR "/data/misc/wmtrace"
Yifan Hong3945e1b2019-10-29 12:59:23 -0700182#define OTA_METADATA_DIR "/metadata/ota"
Yifan Hong0efa7972020-02-03 16:45:02 -0800183#define SNAPSHOTCTL_LOG_DIR "/data/misc/snapshotctl_log"
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +0900184#define LINKERCONFIG_DIR "/linkerconfig"
Calin Juravlef84d3692020-04-28 15:31:12 -0700185#define PACKAGE_DEX_USE_LIST "/data/system/package-dex-usage.list"
Primiano Tuccifaaaafb2021-01-14 12:26:29 +0000186#define SYSTEM_TRACE_SNAPSHOT "/data/misc/perfetto-traces/bugreport/systrace.pftrace"
Li Li2eedd412021-06-30 15:11:53 -0700187#define CGROUPFS_DIR "/sys/fs/cgroup"
Mårten Kongstad60195a72022-09-20 14:14:20 +0200188#define SDK_EXT_INFO "/apex/com.android.sdkext/bin/derive_sdk"
Jeff Sharkey9df29d52023-02-06 14:26:30 -0700189#define DROPBOX_DIR "/data/system/dropbox"
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700190
Narayan Kamath8f788292017-05-25 13:20:39 +0100191// TODO(narayan): Since this information has to be kept in sync
192// with tombstoned, we should just put it in a common header.
193//
194// File: system/core/debuggerd/tombstoned/tombstoned.cpp
Narayan Kamathbd863722017-06-01 18:50:12 +0100195static const std::string TOMBSTONE_DIR = "/data/tombstones/";
196static const std::string TOMBSTONE_FILE_PREFIX = "tombstone_";
197static const std::string ANR_DIR = "/data/anr/";
198static const std::string ANR_FILE_PREFIX = "anr_";
Woody Lin20767a92022-11-29 15:50:24 +0800199static const std::string SHUTDOWN_CHECKPOINTS_DIR = "/data/system/shutdown-checkpoints/";
200static const std::string SHUTDOWN_CHECKPOINTS_FILE_PREFIX = "checkpoints-";
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700201
Felipe Lemee844a9d2016-09-21 15:01:39 -0700202// TODO: temporary variables and functions used during C++ refactoring
Nandana Dutt979388e2018-11-30 16:48:55 +0000203
Nandana Dutt5c390032019-03-12 10:52:56 +0000204#define RETURN_IF_USER_DENIED_CONSENT() \
205 if (ds.IsUserConsentDenied()) { \
206 MYLOGE("Returning early as user denied consent to share bugreport with calling app."); \
207 return Dumpstate::RunStatus::USER_CONSENT_DENIED; \
208 }
209
210// Runs func_ptr, but checks user consent before and after running it. Returns USER_CONSENT_DENIED
211// if consent is found to be denied.
212#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(func_ptr, ...) \
213 RETURN_IF_USER_DENIED_CONSENT(); \
214 func_ptr(__VA_ARGS__); \
215 RETURN_IF_USER_DENIED_CONSENT();
216
Rhed Jao5377d792020-07-16 17:37:39 +0800217// Runs func_ptr, and logs a duration report after it's finished.
218#define RUN_SLOW_FUNCTION_AND_LOG(log_title, func_ptr, ...) \
219 { \
220 DurationReporter duration_reporter_in_macro(log_title); \
221 func_ptr(__VA_ARGS__); \
222 }
223
224// Similar with RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK, an additional duration report
225// is output after a slow function is finished.
226#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(log_title, func_ptr, ...) \
227 RETURN_IF_USER_DENIED_CONSENT(); \
228 RUN_SLOW_FUNCTION_AND_LOG(log_title, func_ptr, __VA_ARGS__); \
229 RETURN_IF_USER_DENIED_CONSENT();
230
Chris Morinbc223142022-02-04 14:17:11 -0800231#define WAIT_TASK_WITH_CONSENT_CHECK(future) \
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800232 RETURN_IF_USER_DENIED_CONSENT(); \
Chris Morinbc223142022-02-04 14:17:11 -0800233 WaitForTask(future); \
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800234 RETURN_IF_USER_DENIED_CONSENT();
235
Sahana Raof35ed432019-07-12 10:47:52 +0100236static const char* WAKE_LOCK_NAME = "dumpstate_wakelock";
237
Rhed Jao5377d792020-07-16 17:37:39 +0800238// Names of parallel tasks, they are used for the DumpPool to identify the dump
239// task and the log title of the duration report.
240static const std::string DUMP_TRACES_TASK = "DUMP TRACES";
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800241static const std::string DUMP_INCIDENT_REPORT_TASK = "INCIDENT REPORT";
Aaron Huang24d215d2022-04-27 18:51:16 +0800242static const std::string DUMP_NETSTATS_PROTO_TASK = "DUMP NETSTATS PROTO";
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800243static const std::string DUMP_HALS_TASK = "DUMP HALS";
244static const std::string DUMP_BOARD_TASK = "dumpstate_board()";
Rhed Jaoe017f982020-07-21 17:58:41 +0800245static const std::string DUMP_CHECKINS_TASK = "DUMP CHECKINS";
Kean Mariotti306633e2022-09-05 16:30:47 +0000246static const std::string POST_PROCESS_UI_TRACES_TASK = "POST-PROCESS UI TRACES";
Rhed Jao5377d792020-07-16 17:37:39 +0800247
Nandana Dutt979388e2018-11-30 16:48:55 +0000248namespace android {
249namespace os {
250namespace {
251
252static int Open(std::string path, int flags, mode_t mode = 0) {
253 int fd = TEMP_FAILURE_RETRY(open(path.c_str(), flags, mode));
254 if (fd == -1) {
255 MYLOGE("open(%s, %s)\n", path.c_str(), strerror(errno));
256 }
257 return fd;
258}
259
mhasank2d75c442020-06-11 15:05:25 -0700260static int OpenForWrite(std::string path) {
261 return Open(path, O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
262 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH);
263}
Nandana Dutt979388e2018-11-30 16:48:55 +0000264
265static int OpenForRead(std::string path) {
266 return Open(path, O_RDONLY | O_CLOEXEC | O_NOFOLLOW);
267}
268
269bool CopyFile(int in_fd, int out_fd) {
270 char buf[4096];
271 ssize_t byte_count;
272 while ((byte_count = TEMP_FAILURE_RETRY(read(in_fd, buf, sizeof(buf)))) > 0) {
273 if (!android::base::WriteFully(out_fd, buf, byte_count)) {
274 return false;
275 }
276 }
277 return (byte_count != -1);
278}
279
280static bool CopyFileToFd(const std::string& input_file, int out_fd) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000281 MYLOGD("Going to copy file (%s) to %d\n", input_file.c_str(), out_fd);
Nandana Dutt979388e2018-11-30 16:48:55 +0000282
283 // Obtain a handle to the source file.
284 android::base::unique_fd in_fd(OpenForRead(input_file));
285 if (out_fd != -1 && in_fd.get() != -1) {
286 if (CopyFile(in_fd.get(), out_fd)) {
287 return true;
288 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000289 MYLOGE("Failed to copy file: %s\n", strerror(errno));
Nandana Dutt979388e2018-11-30 16:48:55 +0000290 }
291 return false;
292}
293
Nandana Duttd2f5f082019-01-18 17:13:52 +0000294static bool UnlinkAndLogOnError(const std::string& file) {
Nandana Dutt8ae16e62020-03-27 10:20:22 +0000295 if (file.empty()) {
296 return false;
297 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000298 if (unlink(file.c_str())) {
299 MYLOGE("Failed to unlink file (%s): %s\n", file.c_str(), strerror(errno));
Nandana Duttd2f5f082019-01-18 17:13:52 +0000300 return false;
301 }
302 return true;
303}
Nandana Dutt979388e2018-11-30 16:48:55 +0000304
Nikita Ioffea325a572019-05-16 19:49:47 +0100305int64_t GetModuleMetadataVersion() {
306 auto binder = defaultServiceManager()->getService(android::String16("package_native"));
307 if (binder == nullptr) {
308 MYLOGE("Failed to retrieve package_native service");
309 return 0L;
310 }
311 auto package_service = android::interface_cast<content::pm::IPackageManagerNative>(binder);
312 std::string package_name;
313 auto status = package_service->getModuleMetadataPackageName(&package_name);
314 if (!status.isOk()) {
315 MYLOGE("Failed to retrieve module metadata package name: %s", status.toString8().c_str());
316 return 0L;
317 }
Nandana Duttdb379fa2019-10-09 16:54:41 +0100318 MYLOGD("Module metadata package name: %s\n", package_name.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100319 int64_t version_code;
320 status = package_service->getVersionCodeForPackage(android::String16(package_name.c_str()),
321 &version_code);
322 if (!status.isOk()) {
323 MYLOGE("Failed to retrieve module metadata version: %s", status.toString8().c_str());
324 return 0L;
325 }
326 return version_code;
327}
328
mhasank2d75c442020-06-11 15:05:25 -0700329static bool PathExists(const std::string& path) {
330 struct stat sb;
331 return stat(path.c_str(), &sb) == 0;
332}
333
334static bool CopyFileToFile(const std::string& input_file, const std::string& output_file) {
335 if (input_file == output_file) {
336 MYLOGD("Skipping copying bugreport file since the destination is the same (%s)\n",
337 output_file.c_str());
338 return false;
339 }
340 else if (PathExists(output_file)) {
341 MYLOGD("Cannot overwrite an existing file (%s)\n", output_file.c_str());
342 return false;
343 }
344
345 MYLOGD("Going to copy bugreport file (%s) to %s\n", input_file.c_str(), output_file.c_str());
346 android::base::unique_fd out_fd(OpenForWrite(output_file));
347 return CopyFileToFd(input_file, out_fd.get());
348}
349
Nandana Dutt979388e2018-11-30 16:48:55 +0000350} // namespace
351} // namespace os
352} // namespace android
353
Felipe Leme678727a2016-09-21 17:22:11 -0700354static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
Felipe Lemebda15a02016-11-16 17:48:25 -0800355 const CommandOptions& options = Dumpstate::DEFAULT_DUMPSYS,
Rhed Jaoe017f982020-07-21 17:58:41 +0800356 long dumpsysTimeoutMs = 0, int out_fd = STDOUT_FILENO) {
357 return ds.RunDumpsys(title, dumpsysArgs, options, dumpsysTimeoutMs, out_fd);
358}
359static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
360 int out_fd) {
361 return ds.RunDumpsys(title, dumpsysArgs, Dumpstate::DEFAULT_DUMPSYS, 0, out_fd);
Felipe Leme678727a2016-09-21 17:22:11 -0700362}
363static int DumpFile(const std::string& title, const std::string& path) {
364 return ds.DumpFile(title, path);
365}
Felipe Lemee82a27d2016-01-05 13:35:44 -0800366
Felipe Lemee844a9d2016-09-21 15:01:39 -0700367// Relative directory (inside the zip) for all files copied as-is into the bugreport.
368static const std::string ZIP_ROOT_DIR = "FS";
369
Vishnu Naire97d6122018-01-18 13:58:56 -0800370static const std::string kProtoPath = "proto/";
371static const std::string kProtoExt = ".proto";
Jie Song9fbfad02017-06-20 16:29:42 -0700372static const std::string kDumpstateBoardFiles[] = {
373 "dumpstate_board.txt",
Felipe Leme95d6ca52017-08-01 16:35:56 -0700374 "dumpstate_board.bin"
Jie Song9fbfad02017-06-20 16:29:42 -0700375};
376static const int NUM_OF_DUMPS = arraysize(kDumpstateBoardFiles);
377
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700378static constexpr char PROPERTY_LAST_ID[] = "dumpstate.last_id";
Felipe Lemed071c682016-10-20 16:48:00 -0700379static constexpr char PROPERTY_VERSION[] = "dumpstate.version";
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700380
Felipe Lemef0292972016-11-22 13:57:05 -0800381static const CommandOptions AS_ROOT_20 = CommandOptions::WithTimeout(20).AsRoot().Build();
382
Narayan Kamath8f788292017-05-25 13:20:39 +0100383/*
Narayan Kamathbd863722017-06-01 18:50:12 +0100384 * Returns a vector of dump fds under |dir_path| with a given |file_prefix|.
Rhed Jao01dc0c62020-06-03 17:13:30 +0800385 * The returned vector is sorted by the mtimes of the dumps with descending
Chris Morinc2cba7a2022-02-01 17:06:50 -0800386 * order.
Narayan Kamath8f788292017-05-25 13:20:39 +0100387 */
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700388static std::vector<DumpData> GetDumpFds(const std::string& dir_path,
Chris Morinc2cba7a2022-02-01 17:06:50 -0800389 const std::string& file_prefix) {
Narayan Kamathbd863722017-06-01 18:50:12 +0100390 std::unique_ptr<DIR, decltype(&closedir)> dump_dir(opendir(dir_path.c_str()), closedir);
Narayan Kamath8f788292017-05-25 13:20:39 +0100391
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700392 if (dump_dir == nullptr) {
393 MYLOGW("Unable to open directory %s: %s\n", dir_path.c_str(), strerror(errno));
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700394 return std::vector<DumpData>();
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700395 }
396
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700397 std::vector<DumpData> dump_data;
Narayan Kamathbd863722017-06-01 18:50:12 +0100398 struct dirent* entry = nullptr;
399 while ((entry = readdir(dump_dir.get()))) {
400 if (entry->d_type != DT_REG) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100401 continue;
402 }
403
Narayan Kamathbd863722017-06-01 18:50:12 +0100404 const std::string base_name(entry->d_name);
405 if (base_name.find(file_prefix) != 0) {
406 continue;
407 }
408
409 const std::string abs_path = dir_path + base_name;
410 android::base::unique_fd fd(
411 TEMP_FAILURE_RETRY(open(abs_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW | O_NONBLOCK)));
412 if (fd == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700413 MYLOGW("Unable to open dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamathbd863722017-06-01 18:50:12 +0100414 break;
415 }
416
417 struct stat st = {};
418 if (fstat(fd, &st) == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700419 MYLOGW("Unable to stat dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamath8f788292017-05-25 13:20:39 +0100420 continue;
421 }
422
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700423 dump_data.emplace_back(DumpData{abs_path, std::move(fd), st.st_mtime});
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700424 }
Rhed Jao01dc0c62020-06-03 17:13:30 +0800425 if (!dump_data.empty()) {
426 std::sort(dump_data.begin(), dump_data.end(),
427 [](const auto& a, const auto& b) { return a.mtime > b.mtime; });
428 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100429
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700430 return dump_data;
Narayan Kamath8f788292017-05-25 13:20:39 +0100431}
432
Narayan Kamathbd863722017-06-01 18:50:12 +0100433static bool AddDumps(const std::vector<DumpData>::const_iterator start,
434 const std::vector<DumpData>::const_iterator end,
435 const char* type_name, const bool add_to_zip) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100436 bool dumped = false;
Narayan Kamathbd863722017-06-01 18:50:12 +0100437 for (auto it = start; it != end; ++it) {
438 const std::string& name = it->name;
439 const int fd = it->fd;
Narayan Kamath8f788292017-05-25 13:20:39 +0100440 dumped = true;
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100441
442 // Seek to the beginning of the file before dumping any data. A given
443 // DumpData entry might be dumped multiple times in the report.
444 //
445 // For example, the most recent ANR entry is dumped to the body of the
446 // main entry and it also shows up as a separate entry in the bugreport
447 // ZIP file.
448 if (lseek(fd, 0, SEEK_SET) != static_cast<off_t>(0)) {
449 MYLOGE("Unable to add %s to zip file, lseek failed: %s\n", name.c_str(),
450 strerror(errno));
451 }
452
Chris Morinc2cba7a2022-02-01 17:06:50 -0800453 if (add_to_zip) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800454 if (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + name, fd, /* timeout = */ 0ms) != OK) {
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100455 MYLOGE("Unable to add %s to zip file, addZipEntryFromFd failed\n", name.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100456 }
457 } else {
458 dump_file_from_fd(type_name, name.c_str(), fd);
459 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100460 }
461
462 return dumped;
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700463}
464
Felipe Leme635ca312016-01-05 14:23:02 -0800465// for_each_pid() callback to get mount info about a process.
Felipe Leme4c2d6632016-09-28 14:32:00 -0700466void do_mountinfo(int pid, const char* name __attribute__((unused))) {
Felipe Leme635ca312016-01-05 14:23:02 -0800467 char path[PATH_MAX];
468
469 // Gets the the content of the /proc/PID/ns/mnt link, so only unique mount points
470 // are added.
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700471 snprintf(path, sizeof(path), "/proc/%d/ns/mnt", pid);
Felipe Leme635ca312016-01-05 14:23:02 -0800472 char linkname[PATH_MAX];
473 ssize_t r = readlink(path, linkname, PATH_MAX);
474 if (r == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800475 MYLOGE("Unable to read link for %s: %s\n", path, strerror(errno));
Felipe Leme635ca312016-01-05 14:23:02 -0800476 return;
477 }
478 linkname[r] = '\0';
479
480 if (mount_points.find(linkname) == mount_points.end()) {
481 // First time this mount point was found: add it
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700482 snprintf(path, sizeof(path), "/proc/%d/mountinfo", pid);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700483 if (ds.AddZipEntry(ZIP_ROOT_DIR + path, path)) {
Felipe Leme635ca312016-01-05 14:23:02 -0800484 mount_points.insert(linkname);
485 } else {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800486 MYLOGE("Unable to add mountinfo %s to zip file\n", path);
Felipe Leme635ca312016-01-05 14:23:02 -0800487 }
488 }
489}
490
491void add_mountinfo() {
Felipe Leme678727a2016-09-21 17:22:11 -0700492 std::string title = "MOUNT INFO";
Felipe Leme635ca312016-01-05 14:23:02 -0800493 mount_points.clear();
Felipe Leme46b85da2016-11-21 17:40:45 -0800494 DurationReporter duration_reporter(title, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700495 for_each_pid(do_mountinfo, nullptr);
496 MYLOGD("%s: %d entries added to zip file\n", title.c_str(), (int)mount_points.size());
Felipe Leme635ca312016-01-05 14:23:02 -0800497}
498
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700499static void dump_dev_files(const char *title, const char *driverpath, const char *filename)
500{
501 DIR *d;
502 struct dirent *de;
503 char path[PATH_MAX];
504
505 d = opendir(driverpath);
Yi Kong19d5c002018-07-20 13:39:55 -0700506 if (d == nullptr) {
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700507 return;
508 }
509
510 while ((de = readdir(d))) {
511 if (de->d_type != DT_LNK) {
512 continue;
513 }
514 snprintf(path, sizeof(path), "%s/%s/%s", driverpath, de->d_name, filename);
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700515 DumpFile(title, path);
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700516 }
517
518 closedir(d);
519}
520
Mark Salyzyn326842f2015-04-30 09:49:41 -0700521static bool skip_not_stat(const char *path) {
522 static const char stat[] = "/stat";
523 size_t len = strlen(path);
524 if (path[len - 1] == '/') { /* Directory? */
525 return false;
526 }
527 return strcmp(path + len - sizeof(stat) + 1, stat); /* .../stat? */
528}
529
Jeff Sharkey9df29d52023-02-06 14:26:30 -0700530static bool skip_wtf_strictmode(const char *path) {
531 if (strstr(path, "_wtf")) {
532 return true;
533 } else if (strstr(path, "_strictmode")) {
534 return true;
535 }
536 return false;
537}
538
Felipe Leme4c2d6632016-09-28 14:32:00 -0700539static bool skip_none(const char* path __attribute__((unused))) {
Felipe Lemee82a27d2016-01-05 13:35:44 -0800540 return false;
541}
542
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700543unsigned long worst_write_perf = 20000; /* in KB/s */
Mark Salyzyn326842f2015-04-30 09:49:41 -0700544
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800545//
546// stat offsets
547// Name units description
548// ---- ----- -----------
549// read I/Os requests number of read I/Os processed
550#define __STAT_READ_IOS 0
551// read merges requests number of read I/Os merged with in-queue I/O
552#define __STAT_READ_MERGES 1
553// read sectors sectors number of sectors read
554#define __STAT_READ_SECTORS 2
555// read ticks milliseconds total wait time for read requests
556#define __STAT_READ_TICKS 3
557// write I/Os requests number of write I/Os processed
558#define __STAT_WRITE_IOS 4
559// write merges requests number of write I/Os merged with in-queue I/O
560#define __STAT_WRITE_MERGES 5
561// write sectors sectors number of sectors written
562#define __STAT_WRITE_SECTORS 6
563// write ticks milliseconds total wait time for write requests
564#define __STAT_WRITE_TICKS 7
565// in_flight requests number of I/Os currently in flight
566#define __STAT_IN_FLIGHT 8
567// io_ticks milliseconds total time this block device has been active
568#define __STAT_IO_TICKS 9
569// time_in_queue milliseconds total wait time for all requests
570#define __STAT_IN_QUEUE 10
571#define __STAT_NUMBER_FIELD 11
572//
573// read I/Os, write I/Os
574// =====================
575//
576// These values increment when an I/O request completes.
577//
578// read merges, write merges
579// =========================
580//
581// These values increment when an I/O request is merged with an
582// already-queued I/O request.
583//
584// read sectors, write sectors
585// ===========================
586//
587// These values count the number of sectors read from or written to this
588// block device. The "sectors" in question are the standard UNIX 512-byte
589// sectors, not any device- or filesystem-specific block size. The
590// counters are incremented when the I/O completes.
591#define SECTOR_SIZE 512
592//
593// read ticks, write ticks
594// =======================
595//
596// These values count the number of milliseconds that I/O requests have
597// waited on this block device. If there are multiple I/O requests waiting,
598// these values will increase at a rate greater than 1000/second; for
599// example, if 60 read requests wait for an average of 30 ms, the read_ticks
600// field will increase by 60*30 = 1800.
601//
602// in_flight
603// =========
604//
605// This value counts the number of I/O requests that have been issued to
606// the device driver but have not yet completed. It does not include I/O
607// requests that are in the queue but not yet issued to the device driver.
608//
609// io_ticks
610// ========
611//
612// This value counts the number of milliseconds during which the device has
613// had I/O requests queued.
614//
615// time_in_queue
616// =============
617//
618// This value counts the number of milliseconds that I/O requests have waited
619// on this block device. If there are multiple I/O requests waiting, this
620// value will increase as the product of the number of milliseconds times the
621// number of requests waiting (see "read ticks" above for an example).
622#define S_TO_MS 1000
623//
624
Mark Salyzyn326842f2015-04-30 09:49:41 -0700625static int dump_stat_from_fd(const char *title __unused, const char *path, int fd) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800626 unsigned long long fields[__STAT_NUMBER_FIELD];
Mark Salyzyn326842f2015-04-30 09:49:41 -0700627 bool z;
Yi Kong19d5c002018-07-20 13:39:55 -0700628 char *cp, *buffer = nullptr;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700629 size_t i = 0;
Josh Gao7c4258c2018-06-25 13:40:08 -0700630 FILE *fp = fdopen(dup(fd), "rb");
Mark Salyzyn326842f2015-04-30 09:49:41 -0700631 getline(&buffer, &i, fp);
632 fclose(fp);
633 if (!buffer) {
634 return -errno;
635 }
636 i = strlen(buffer);
637 while ((i > 0) && (buffer[i - 1] == '\n')) {
638 buffer[--i] = '\0';
639 }
640 if (!*buffer) {
641 free(buffer);
642 return 0;
643 }
644 z = true;
645 for (cp = buffer, i = 0; i < (sizeof(fields) / sizeof(fields[0])); ++i) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800646 fields[i] = strtoull(cp, &cp, 10);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700647 if (fields[i] != 0) {
648 z = false;
649 }
650 }
651 if (z) { /* never accessed */
652 free(buffer);
653 return 0;
654 }
655
Wei Wang509bb5d2017-06-09 14:42:12 -0700656 if (!strncmp(path, BLK_DEV_SYS_DIR, sizeof(BLK_DEV_SYS_DIR) - 1)) {
657 path += sizeof(BLK_DEV_SYS_DIR) - 1;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700658 }
Wei Wang1dc1ef52017-06-12 11:28:37 -0700659
660 printf("%-30s:%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s\n%-30s:\t%s\n", "Block-Dev",
661 "R-IOs", "R-merg", "R-sect", "R-wait", "W-IOs", "W-merg", "W-sect",
662 "W-wait", "in-fli", "activ", "T-wait", path, buffer);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700663 free(buffer);
664
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800665 if (fields[__STAT_IO_TICKS]) {
666 unsigned long read_perf = 0;
667 unsigned long read_ios = 0;
668 if (fields[__STAT_READ_TICKS]) {
669 unsigned long long divisor = fields[__STAT_READ_TICKS]
670 * fields[__STAT_IO_TICKS];
671 read_perf = ((unsigned long long)SECTOR_SIZE
672 * fields[__STAT_READ_SECTORS]
673 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
674 / divisor;
675 read_ios = ((unsigned long long)S_TO_MS * fields[__STAT_READ_IOS]
676 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
677 / divisor;
678 }
679
680 unsigned long write_perf = 0;
681 unsigned long write_ios = 0;
682 if (fields[__STAT_WRITE_TICKS]) {
683 unsigned long long divisor = fields[__STAT_WRITE_TICKS]
684 * fields[__STAT_IO_TICKS];
685 write_perf = ((unsigned long long)SECTOR_SIZE
686 * fields[__STAT_WRITE_SECTORS]
687 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
688 / divisor;
689 write_ios = ((unsigned long long)S_TO_MS * fields[__STAT_WRITE_IOS]
690 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
691 / divisor;
692 }
693
694 unsigned queue = (fields[__STAT_IN_QUEUE]
695 + (fields[__STAT_IO_TICKS] >> 1))
696 / fields[__STAT_IO_TICKS];
697
698 if (!write_perf && !write_ios) {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700699 printf("%-30s: perf(ios) rd: %luKB/s(%lu/s) q: %u\n", path, read_perf, read_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800700 } else {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700701 printf("%-30s: perf(ios) rd: %luKB/s(%lu/s) wr: %luKB/s(%lu/s) q: %u\n", path, read_perf,
Felipe Lemed8b94e52016-12-08 10:21:44 -0800702 read_ios, write_perf, write_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800703 }
704
705 /* bugreport timeout factor adjustment */
706 if ((write_perf > 1) && (write_perf < worst_write_perf)) {
707 worst_write_perf = write_perf;
708 }
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700709 }
Mark Salyzyn326842f2015-04-30 09:49:41 -0700710 return 0;
711}
712
Yao Chenbe3bbc12018-01-17 16:31:10 -0800713static const long MINIMUM_LOGCAT_TIMEOUT_MS = 50000;
714
Tom Cherryf4472f32020-08-05 09:31:17 -0700715// Returns the actual readable size of the given buffer or -1 on error.
716static long logcat_buffer_readable_size(const std::string& buffer) {
717 std::unique_ptr<logger_list, decltype(&android_logger_list_free)> logger_list{
718 android_logger_list_alloc(0, 0, 0), &android_logger_list_free};
719 auto logger = android_logger_open(logger_list.get(), android_name_to_log_id(buffer.c_str()));
720
721 return android_logger_get_log_readable_size(logger);
722}
723
724// Returns timeout in ms to read a list of buffers.
Yao Chenbe3bbc12018-01-17 16:31:10 -0800725static unsigned long logcat_timeout(const std::vector<std::string>& buffers) {
726 unsigned long timeout_ms = 0;
727 for (const auto& buffer : buffers) {
Tom Cherryf4472f32020-08-05 09:31:17 -0700728 long readable_size = logcat_buffer_readable_size(buffer);
729 if (readable_size > 0) {
730 // Engineering margin is ten-fold our guess.
731 timeout_ms += 10 * (readable_size + worst_write_perf) / worst_write_perf;
732 }
Yao Chenbe3bbc12018-01-17 16:31:10 -0800733 }
734 return timeout_ms > MINIMUM_LOGCAT_TIMEOUT_MS ? timeout_ms : MINIMUM_LOGCAT_TIMEOUT_MS;
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700735}
736
Dieter Hsu105ad0c2020-09-29 15:23:33 +0800737// Opens a socket and returns its file descriptor.
738static int open_socket(const char* service);
739
Nandana Duttd2f5f082019-01-18 17:13:52 +0000740Dumpstate::ConsentCallback::ConsentCallback() : result_(UNAVAILABLE), start_time_(Nanotime()) {
741}
742
743android::binder::Status Dumpstate::ConsentCallback::onReportApproved() {
744 std::lock_guard<std::mutex> lock(lock_);
745 result_ = APPROVED;
746 MYLOGD("User approved consent to share bugreport\n");
Paul Chang0d2aad72020-02-13 20:04:03 +0800747
748 // Maybe copy screenshot so calling app can display the screenshot to the user as soon as
749 // consent is granted.
750 if (ds.options_->is_screenshot_copied) {
751 return android::binder::Status::ok();
752 }
753
754 if (!ds.options_->do_screenshot || ds.options_->screenshot_fd.get() == -1 ||
755 !ds.do_early_screenshot_) {
756 return android::binder::Status::ok();
757 }
758
759 bool copy_succeeded = android::os::CopyFileToFd(ds.screenshot_path_,
760 ds.options_->screenshot_fd.get());
761 ds.options_->is_screenshot_copied = copy_succeeded;
762 if (copy_succeeded) {
763 android::os::UnlinkAndLogOnError(ds.screenshot_path_);
764 }
Nandana Duttd2f5f082019-01-18 17:13:52 +0000765 return android::binder::Status::ok();
766}
767
768android::binder::Status Dumpstate::ConsentCallback::onReportDenied() {
769 std::lock_guard<std::mutex> lock(lock_);
770 result_ = DENIED;
771 MYLOGW("User denied consent to share bugreport\n");
772 return android::binder::Status::ok();
773}
774
775UserConsentResult Dumpstate::ConsentCallback::getResult() {
776 std::lock_guard<std::mutex> lock(lock_);
777 return result_;
778}
779
780uint64_t Dumpstate::ConsentCallback::getElapsedTimeMs() const {
Hunter Knepshieldf0a39052020-01-03 14:53:04 -0800781 return (Nanotime() - start_time_) / NANOS_PER_MILLI;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000782}
783
Felipe Leme2b9b06c2016-10-14 09:13:06 -0700784void Dumpstate::PrintHeader() const {
Mårten Kongstad60195a72022-09-20 14:14:20 +0200785 std::string build, fingerprint, radio, bootloader, network, sdkversion;
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700786 char date[80];
Colin Crossf45fa6b2012-03-26 12:38:26 -0700787
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700788 build = android::base::GetProperty("ro.build.display.id", "(unknown)");
789 fingerprint = android::base::GetProperty("ro.build.fingerprint", "(unknown)");
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700790 radio = android::base::GetProperty("gsm.version.baseband", "(unknown)");
791 bootloader = android::base::GetProperty("ro.bootloader", "(unknown)");
792 network = android::base::GetProperty("gsm.operator.alpha", "(unknown)");
Mårten Kongstad60195a72022-09-20 14:14:20 +0200793 sdkversion = android::base::GetProperty("ro.build.version.sdk", "(unknown)");
Felipe Lemebbaf3c12016-10-11 14:32:25 -0700794 strftime(date, sizeof(date), "%Y-%m-%d %H:%M:%S", localtime(&now_));
Colin Crossf45fa6b2012-03-26 12:38:26 -0700795
Felipe Lemed8b94e52016-12-08 10:21:44 -0800796 printf("========================================================\n");
797 printf("== dumpstate: %s\n", date);
798 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -0700799
Felipe Lemed8b94e52016-12-08 10:21:44 -0800800 printf("\n");
801 printf("Build: %s\n", build.c_str());
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700802 // NOTE: fingerprint entry format is important for other tools.
Felipe Lemed8b94e52016-12-08 10:21:44 -0800803 printf("Build fingerprint: '%s'\n", fingerprint.c_str());
804 printf("Bootloader: %s\n", bootloader.c_str());
805 printf("Radio: %s\n", radio.c_str());
806 printf("Network: %s\n", network.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100807 int64_t module_metadata_version = android::os::GetModuleMetadataVersion();
808 if (module_metadata_version != 0) {
809 printf("Module Metadata version: %" PRId64 "\n", module_metadata_version);
810 }
Mårten Kongstad60195a72022-09-20 14:14:20 +0200811 printf("Android SDK version: %s\n", sdkversion.c_str());
812 printf("SDK extensions: ");
813 RunCommandToFd(STDOUT_FILENO, "", {SDK_EXT_INFO, "--header"},
814 CommandOptions::WithTimeout(1).Always().DropRoot().Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -0700815
Felipe Lemed8b94e52016-12-08 10:21:44 -0800816 printf("Kernel: ");
Felipe Lemef0292972016-11-22 13:57:05 -0800817 DumpFileToFd(STDOUT_FILENO, "", "/proc/version");
Felipe Lemed8b94e52016-12-08 10:21:44 -0800818 printf("Command line: %s\n", strtok(cmdline_buf, "\n"));
Felipe Leme7709f8a2017-12-05 09:30:09 -0800819 printf("Uptime: ");
820 RunCommandToFd(STDOUT_FILENO, "", {"uptime", "-p"},
821 CommandOptions::WithTimeout(1).Always().Build());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800822 printf("Bugreport format version: %s\n", version_.c_str());
Rhed Jao5377d792020-07-16 17:37:39 +0800823 printf("Dumpstate info: id=%d pid=%d dry_run=%d parallel_run=%d args=%s bugreport_mode=%s\n",
824 id_, pid_, PropertiesHelper::IsDryRun(), PropertiesHelper::IsParallelRun(),
Kedar Chitnis9fd8c052021-11-16 09:09:22 +0000825 options_->args.c_str(), options_->bugreport_mode_string.c_str());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800826 printf("\n");
Felipe Leme78f2c862015-12-21 09:55:22 -0800827}
828
Felipe Leme24b66ee2016-06-16 10:55:26 -0700829// List of file extensions that can cause a zip file attachment to be rejected by some email
830// service providers.
831static const std::set<std::string> PROBLEMATIC_FILE_EXTENSIONS = {
832 ".ade", ".adp", ".bat", ".chm", ".cmd", ".com", ".cpl", ".exe", ".hta", ".ins", ".isp",
833 ".jar", ".jse", ".lib", ".lnk", ".mde", ".msc", ".msp", ".mst", ".pif", ".scr", ".sct",
834 ".shb", ".sys", ".vb", ".vbe", ".vbs", ".vxd", ".wsc", ".wsf", ".wsh"
835};
836
Vishnu Naire97d6122018-01-18 13:58:56 -0800837status_t Dumpstate::AddZipEntryFromFd(const std::string& entry_name, int fd,
838 std::chrono::milliseconds timeout = 0ms) {
Felipe Leme24b66ee2016-06-16 10:55:26 -0700839 std::string valid_name = entry_name;
840
841 // Rename extension if necessary.
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -0700842 size_t idx = entry_name.rfind('.');
Felipe Leme24b66ee2016-06-16 10:55:26 -0700843 if (idx != std::string::npos) {
844 std::string extension = entry_name.substr(idx);
845 std::transform(extension.begin(), extension.end(), extension.begin(), ::tolower);
846 if (PROBLEMATIC_FILE_EXTENSIONS.count(extension) != 0) {
847 valid_name = entry_name + ".renamed";
848 MYLOGI("Renaming entry %s to %s\n", entry_name.c_str(), valid_name.c_str());
849 }
850 }
851
Felipe Leme6fe9db62016-02-12 09:04:16 -0800852 // Logging statement below is useful to time how long each entry takes, but it's too verbose.
853 // MYLOGD("Adding zip entry %s\n", entry_name.c_str());
Kevin Jeon9bbe0ac2022-05-05 22:05:43 +0000854 size_t flags = ZipWriter::kCompress | ZipWriter::kDefaultCompression;
855 int32_t err = zip_writer_->StartEntryWithTime(valid_name.c_str(), flags,
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700856 get_mtime(fd, ds.now_));
Felipe Leme1d486fe2016-10-14 18:06:47 -0700857 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700858 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", valid_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700859 ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800860 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800861 }
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000862 bool finished_entry = false;
863 auto finish_entry = [this, &finished_entry] {
864 if (!finished_entry) {
865 // This should only be called when we're going to return an earlier error,
866 // which would've been logged. This may imply the file is already corrupt
867 // and any further logging from FinishEntry is more likely to mislead than
868 // not.
869 this->zip_writer_->FinishEntry();
870 }
871 };
872 auto scope_guard = android::base::make_scope_guard(finish_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -0800873 auto start = std::chrono::steady_clock::now();
874 auto end = start + timeout;
875 struct pollfd pfd = {fd, POLLIN};
Felipe Lemee82a27d2016-01-05 13:35:44 -0800876
Felipe Leme770410d2016-01-26 17:07:14 -0800877 std::vector<uint8_t> buffer(65536);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800878 while (1) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800879 if (timeout.count() > 0) {
880 // lambda to recalculate the timeout.
881 auto time_left_ms = [end]() {
882 auto now = std::chrono::steady_clock::now();
883 auto diff = std::chrono::duration_cast<std::chrono::milliseconds>(end - now);
884 return std::max(diff.count(), 0LL);
885 };
886
887 int rc = TEMP_FAILURE_RETRY(poll(&pfd, 1, time_left_ms()));
888 if (rc < 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000889 MYLOGE("Error in poll while adding from fd to zip entry %s:%s\n",
890 entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800891 return -errno;
892 } else if (rc == 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000893 MYLOGE("Timed out adding from fd to zip entry %s:%s Timeout:%lldms\n",
Vishnu Naire97d6122018-01-18 13:58:56 -0800894 entry_name.c_str(), strerror(errno), timeout.count());
895 return TIMED_OUT;
896 }
897 }
898
Zach Riggle22200402016-08-18 01:01:24 -0400899 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800900 if (bytes_read == 0) {
901 break;
902 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800903 MYLOGE("read(%s): %s\n", entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800904 return -errno;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800905 }
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700906 err = zip_writer_->WriteBytes(buffer.data(), bytes_read);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800907 if (err) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700908 MYLOGE("zip_writer_->WriteBytes(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800909 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800910 }
911 }
912
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700913 err = zip_writer_->FinishEntry();
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000914 finished_entry = true;
Felipe Leme1d486fe2016-10-14 18:06:47 -0700915 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700916 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800917 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800918 }
919
Vishnu Naire97d6122018-01-18 13:58:56 -0800920 return OK;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800921}
922
Felipe Leme1d486fe2016-10-14 18:06:47 -0700923bool Dumpstate::AddZipEntry(const std::string& entry_name, const std::string& entry_path) {
924 android::base::unique_fd fd(
925 TEMP_FAILURE_RETRY(open(entry_path.c_str(), O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
Andreas Gampeaff68432016-07-18 18:01:27 -0700926 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800927 MYLOGE("open(%s): %s\n", entry_path.c_str(), strerror(errno));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800928 return false;
929 }
930
Vishnu Naire97d6122018-01-18 13:58:56 -0800931 return (AddZipEntryFromFd(entry_name, fd.get()) == OK);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800932}
933
934/* adds a file to the existing zipped bugreport */
Felipe Leme4c2d6632016-09-28 14:32:00 -0700935static int _add_file_from_fd(const char* title __attribute__((unused)), const char* path, int fd) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800936 return (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + path, fd) == OK) ? 0 : 1;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800937}
938
Felipe Leme1d486fe2016-10-14 18:06:47 -0700939void Dumpstate::AddDir(const std::string& dir, bool recursive) {
Felipe Leme678727a2016-09-21 17:22:11 -0700940 MYLOGD("Adding dir %s (recursive: %d)\n", dir.c_str(), recursive);
Felipe Leme46b85da2016-11-21 17:40:45 -0800941 DurationReporter duration_reporter(dir, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700942 dump_files("", dir.c_str(), recursive ? skip_none : is_dir, _add_file_from_fd);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800943}
944
Felipe Leme1d486fe2016-10-14 18:06:47 -0700945bool Dumpstate::AddTextZipEntry(const std::string& entry_name, const std::string& content) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800946 MYLOGD("Adding zip text entry %s\n", entry_name.c_str());
Kevin Jeon9bbe0ac2022-05-05 22:05:43 +0000947 size_t flags = ZipWriter::kCompress | ZipWriter::kDefaultCompression;
948 int32_t err = zip_writer_->StartEntryWithTime(entry_name.c_str(), flags, ds.now_);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700949 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700950 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700951 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800952 return false;
953 }
954
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700955 err = zip_writer_->WriteBytes(content.c_str(), content.length());
Felipe Leme1d486fe2016-10-14 18:06:47 -0700956 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700957 MYLOGE("zip_writer_->WriteBytes(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700958 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800959 return false;
960 }
961
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700962 err = zip_writer_->FinishEntry();
Felipe Leme1d486fe2016-10-14 18:06:47 -0700963 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700964 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800965 return false;
966 }
967
968 return true;
969}
970
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800971static void DoKmsg() {
972 struct stat st;
973 if (!stat(PSTORE_LAST_KMSG, &st)) {
974 /* Also TODO: Make console-ramoops CAP_SYSLOG protected. */
975 DumpFile("LAST KMSG", PSTORE_LAST_KMSG);
976 } else if (!stat(ALT_PSTORE_LAST_KMSG, &st)) {
977 DumpFile("LAST KMSG", ALT_PSTORE_LAST_KMSG);
978 } else {
979 /* TODO: Make last_kmsg CAP_SYSLOG protected. b/5555691 */
980 DumpFile("LAST KMSG", "/proc/last_kmsg");
981 }
982}
983
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800984static void DoKernelLogcat() {
Yao Chenbe3bbc12018-01-17 16:31:10 -0800985 unsigned long timeout_ms = logcat_timeout({"kernel"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800986 RunCommand(
987 "KERNEL LOG",
988 {"logcat", "-b", "kernel", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
989 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
990}
991
Nandana Duttdb379fa2019-10-09 16:54:41 +0100992static void DoSystemLogcat(time_t since) {
993 char since_str[80];
994 strftime(since_str, sizeof(since_str), "%Y-%m-%d %H:%M:%S.000", localtime(&since));
995
996 unsigned long timeout_ms = logcat_timeout({"main", "system", "crash"});
997 RunCommand("SYSTEM LOG",
998 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v", "-T",
999 since_str},
1000 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1001}
1002
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001003static void DoRadioLogcat() {
1004 unsigned long timeout_ms = logcat_timeout({"radio"});
1005 RunCommand(
1006 "RADIO LOG",
1007 {"logcat", "-b", "radio", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1008 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
1009}
1010
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001011static void DoLogcat() {
Vishnu Nair6921f802017-11-22 09:17:23 -08001012 unsigned long timeout_ms;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001013 // DumpFile("EVENT LOG TAGS", "/etc/event-log-tags");
1014 // calculate timeout
Yao Chenbe3bbc12018-01-17 16:31:10 -08001015 timeout_ms = logcat_timeout({"main", "system", "crash"});
Tony Makae737652017-03-30 17:47:09 +01001016 RunCommand("SYSTEM LOG",
Vishnu Nair6921f802017-11-22 09:17:23 -08001017 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1018 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -08001019 timeout_ms = logcat_timeout({"events"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001020 RunCommand(
1021 "EVENT LOG",
1022 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001023 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Yao Chenbe3bbc12018-01-17 16:31:10 -08001024 timeout_ms = logcat_timeout({"stats"});
1025 RunCommand(
1026 "STATS LOG",
1027 {"logcat", "-b", "stats", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001028 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001029 DoRadioLogcat();
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001030
1031 RunCommand("LOG STATISTICS", {"logcat", "-b", "all", "-S"});
1032
1033 /* kernels must set CONFIG_PSTORE_PMSG, slice up pstore with device tree */
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001034 RunCommand("LAST LOGCAT", {"logcat", "-L", "-b", "all", "-v", "threadtime", "-v", "printable",
1035 "-v", "uid", "-d", "*:v"});
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001036}
1037
Mike Ma5c267872019-08-21 11:31:34 -07001038static void DumpIncidentReport() {
Mike Ma5c267872019-08-21 11:31:34 -07001039 const std::string path = ds.bugreport_internal_dir_ + "/tmp_incident_report";
1040 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1041 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1042 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1043 if (fd < 0) {
1044 MYLOGE("Could not open %s to dump incident report.\n", path.c_str());
1045 return;
1046 }
Kevin Jeon774abde2022-09-28 18:20:43 +00001047 RunCommandToFd(fd, "", {"incident", "-u"}, CommandOptions::WithTimeout(20).Build());
Mike Ma5c267872019-08-21 11:31:34 -07001048 bool empty = 0 == lseek(fd, 0, SEEK_END);
1049 if (!empty) {
1050 // Use a different name from "incident.proto"
1051 // /proto/incident.proto is reserved for incident service dump
1052 // i.e. metadata for debugging.
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001053 ds.EnqueueAddZipEntryAndCleanupIfNeeded(kProtoPath + "incident_report" + kProtoExt,
1054 path);
1055 } else {
1056 unlink(path.c_str());
Mike Ma5c267872019-08-21 11:31:34 -07001057 }
Mike Ma5c267872019-08-21 11:31:34 -07001058}
1059
Aaron Huang24d215d2022-04-27 18:51:16 +08001060static void DumpNetstatsProto() {
1061 const std::string path = ds.bugreport_internal_dir_ + "/tmp_netstats_proto";
1062 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1063 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1064 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1065 if (fd < 0) {
1066 MYLOGE("Could not open %s to dump netstats proto.\n", path.c_str());
1067 return;
1068 }
1069 RunCommandToFd(fd, "", {"dumpsys", "netstats", "--proto"},
Kevin Jeon2fb3dd62022-09-28 18:48:55 +00001070 CommandOptions::WithTimeout(5).Build());
Aaron Huang24d215d2022-04-27 18:51:16 +08001071 bool empty = 0 == lseek(fd, 0, SEEK_END);
1072 if (!empty) {
1073 ds.EnqueueAddZipEntryAndCleanupIfNeeded(kProtoPath + "netstats" + kProtoExt,
1074 path);
1075 } else {
1076 unlink(path.c_str());
1077 }
1078}
1079
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001080static void MaybeAddSystemTraceToZip() {
1081 // This function copies into the .zip the system trace that was snapshotted
1082 // by the early call to MaybeSnapshotSystemTrace(), if any background
1083 // tracing was happening.
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001084 if (!ds.has_system_trace_) {
1085 // No background trace was happening at the time dumpstate was invoked.
1086 return;
1087 }
1088 ds.AddZipEntry(
1089 ZIP_ROOT_DIR + SYSTEM_TRACE_SNAPSHOT,
1090 SYSTEM_TRACE_SNAPSHOT);
1091 android::os::UnlinkAndLogOnError(SYSTEM_TRACE_SNAPSHOT);
1092}
1093
Sunny Goyal35949782019-11-19 15:54:36 -08001094static void DumpVisibleWindowViews() {
Sunny Goyal35949782019-11-19 15:54:36 -08001095 DurationReporter duration_reporter("VISIBLE WINDOW VIEWS");
1096 const std::string path = ds.bugreport_internal_dir_ + "/tmp_visible_window_views";
1097 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1098 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1099 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1100 if (fd < 0) {
1101 MYLOGE("Could not open %s to dump visible views.\n", path.c_str());
1102 return;
1103 }
1104 RunCommandToFd(fd, "", {"cmd", "window", "dump-visible-window-views"},
Kevin Jeon774abde2022-09-28 18:20:43 +00001105 CommandOptions::WithTimeout(10).Build());
Sunny Goyal35949782019-11-19 15:54:36 -08001106 bool empty = 0 == lseek(fd, 0, SEEK_END);
1107 if (!empty) {
1108 ds.AddZipEntry("visible_windows.zip", path);
1109 } else {
1110 MYLOGW("Failed to dump visible windows\n");
1111 }
1112 unlink(path.c_str());
1113}
1114
Jayachandran Ca94c7172017-06-10 15:08:12 -07001115static void DumpIpTablesAsRoot() {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001116 RunCommand("IPTABLES", {"iptables", "-L", "-nvx"});
1117 RunCommand("IP6TABLES", {"ip6tables", "-L", "-nvx"});
Erik Kline32af8c22016-09-28 17:26:26 +09001118 RunCommand("IPTABLES NAT", {"iptables", "-t", "nat", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001119 /* no ip6 nat */
Erik Kline32af8c22016-09-28 17:26:26 +09001120 RunCommand("IPTABLES MANGLE", {"iptables", "-t", "mangle", "-L", "-nvx"});
1121 RunCommand("IP6TABLES MANGLE", {"ip6tables", "-t", "mangle", "-L", "-nvx"});
1122 RunCommand("IPTABLES RAW", {"iptables", "-t", "raw", "-L", "-nvx"});
1123 RunCommand("IP6TABLES RAW", {"ip6tables", "-t", "raw", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001124}
1125
Woody Lin20767a92022-11-29 15:50:24 +08001126static void DumpShutdownCheckpoints() {
1127 const bool shutdown_checkpoints_dumped = AddDumps(
1128 ds.shutdown_checkpoints_.begin(), ds.shutdown_checkpoints_.end(),
1129 "SHUTDOWN CHECKPOINTS", false /* add_to_zip */);
1130 if (!shutdown_checkpoints_dumped) {
1131 printf("*** NO SHUTDOWN CHECKPOINTS to dump in %s\n\n",
1132 SHUTDOWN_CHECKPOINTS_DIR.c_str());
1133 }
1134}
1135
David Andersond9ba4752018-12-11 18:26:59 -08001136static void DumpDynamicPartitionInfo() {
1137 if (!::android::base::GetBoolProperty("ro.boot.dynamic_partitions", false)) {
1138 return;
1139 }
1140
1141 RunCommand("LPDUMP", {"lpdump", "--all"});
David Anderson6650ade2019-10-02 15:18:59 -07001142 RunCommand("DEVICE-MAPPER", {"gsid", "dump-device-mapper"});
David Andersond9ba4752018-12-11 18:26:59 -08001143}
1144
Chris Morin5a50d482022-02-01 17:41:18 -08001145static void AddAnrTraceDir(const std::string& anr_traces_dir) {
Narayan Kamath8f788292017-05-25 13:20:39 +01001146 MYLOGD("AddAnrTraceDir(): dump_traces_file=%s, anr_traces_dir=%s\n", dump_traces_path,
1147 anr_traces_dir.c_str());
1148
1149 // If we're here, dump_traces_path will always be a temporary file
1150 // (created with mkostemp or similar) that contains dumps taken earlier
1151 // on in the process.
1152 if (dump_traces_path != nullptr) {
Chris Morin5a50d482022-02-01 17:41:18 -08001153 MYLOGD("Dumping current ANR traces (%s) to the main bugreport entry\n",
1154 dump_traces_path);
1155 ds.DumpFile("VM TRACES JUST NOW", dump_traces_path);
Narayan Kamath8f788292017-05-25 13:20:39 +01001156
1157 const int ret = unlink(dump_traces_path);
1158 if (ret == -1) {
1159 MYLOGW("Error unlinking temporary trace path %s: %s\n", dump_traces_path,
1160 strerror(errno));
Felipe Lemee184f662016-10-27 10:04:47 -07001161 }
1162 }
1163
Narayan Kamathbd863722017-06-01 18:50:12 +01001164 // Add a specific message for the first ANR Dump.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001165 if (ds.anr_data_.size() > 0) {
Chris Morin5a50d482022-02-01 17:41:18 -08001166 // The "last" ANR will always be present in the body of the main entry.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001167 AddDumps(ds.anr_data_.begin(), ds.anr_data_.begin() + 1,
Chris Morin5a50d482022-02-01 17:41:18 -08001168 "VM TRACES AT LAST ANR", false /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001169
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001170 // Historical ANRs are always included as separate entries in the bugreport zip file.
Chris Morin5a50d482022-02-01 17:41:18 -08001171 AddDumps(ds.anr_data_.begin(), ds.anr_data_.end(),
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001172 "HISTORICAL ANR", true /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001173 } else {
Narayan Kamath8f788292017-05-25 13:20:39 +01001174 printf("*** NO ANRs to dump in %s\n\n", ANR_DIR.c_str());
1175 }
1176}
1177
1178static void AddAnrTraceFiles() {
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001179 std::string anr_traces_dir = "/data/anr";
Narayan Kamath8f788292017-05-25 13:20:39 +01001180
Chris Morin5a50d482022-02-01 17:41:18 -08001181 AddAnrTraceDir(anr_traces_dir);
Narayan Kamath8f788292017-05-25 13:20:39 +01001182
Makoto Onuki83ec63f2019-01-31 17:08:59 -08001183 RunCommand("ANR FILES", {"ls", "-lt", ANR_DIR});
1184
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001185 // Slow traces for slow operations.
Felipe Lemee184f662016-10-27 10:04:47 -07001186 struct stat st;
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001187 int i = 0;
1188 while (true) {
1189 const std::string slow_trace_path =
1190 anr_traces_dir + android::base::StringPrintf("slow%02d.txt", i);
1191 if (stat(slow_trace_path.c_str(), &st)) {
1192 // No traces file at this index, done with the files.
1193 break;
Felipe Lemee184f662016-10-27 10:04:47 -07001194 }
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001195 ds.DumpFile("VM TRACES WHEN SLOW", slow_trace_path.c_str());
1196 i++;
Felipe Lemee184f662016-10-27 10:04:47 -07001197 }
1198}
1199
Wei Wang509bb5d2017-06-09 14:42:12 -07001200static void DumpBlockStatFiles() {
1201 DurationReporter duration_reporter("DUMP BLOCK STAT");
Wei Wang509bb5d2017-06-09 14:42:12 -07001202
Wei Wang1dc1ef52017-06-12 11:28:37 -07001203 std::unique_ptr<DIR, std::function<int(DIR*)>> dirptr(opendir(BLK_DEV_SYS_DIR), closedir);
1204
1205 if (dirptr == nullptr) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001206 MYLOGE("Failed to open %s: %s\n", BLK_DEV_SYS_DIR, strerror(errno));
1207 return;
1208 }
1209
1210 printf("------ DUMP BLOCK STAT ------\n\n");
Wei Wang1dc1ef52017-06-12 11:28:37 -07001211 while (struct dirent *d = readdir(dirptr.get())) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001212 if ((d->d_name[0] == '.')
1213 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
1214 || (d->d_name[1] == '\0'))) {
1215 continue;
1216 }
1217 const std::string new_path =
1218 android::base::StringPrintf("%s/%s", BLK_DEV_SYS_DIR, d->d_name);
1219 printf("------ BLOCK STAT (%s) ------\n", new_path.c_str());
1220 dump_files("", new_path.c_str(), skip_not_stat, dump_stat_from_fd);
1221 printf("\n");
1222 }
Wei Wang1dc1ef52017-06-12 11:28:37 -07001223 return;
Wei Wang509bb5d2017-06-09 14:42:12 -07001224}
Jayachandran Ca94c7172017-06-10 15:08:12 -07001225
1226static void DumpPacketStats() {
1227 DumpFile("NETWORK DEV INFO", "/proc/net/dev");
Jayachandran Ca94c7172017-06-10 15:08:12 -07001228}
1229
1230static void DumpIpAddrAndRules() {
1231 /* The following have a tendency to get wedged when wifi drivers/fw goes belly-up. */
1232 RunCommand("NETWORK INTERFACES", {"ip", "link"});
1233 RunCommand("IPv4 ADDRESSES", {"ip", "-4", "addr", "show"});
1234 RunCommand("IPv6 ADDRESSES", {"ip", "-6", "addr", "show"});
1235 RunCommand("IP RULES", {"ip", "rule", "show"});
1236 RunCommand("IP RULES v6", {"ip", "-6", "rule", "show"});
1237}
1238
Nandana Dutt5c390032019-03-12 10:52:56 +00001239static Dumpstate::RunStatus RunDumpsysTextByPriority(const std::string& title, int priority,
1240 std::chrono::milliseconds timeout,
1241 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001242 auto start = std::chrono::steady_clock::now();
Vishnu Naire97d6122018-01-18 13:58:56 -08001243 sp<android::IServiceManager> sm = defaultServiceManager();
1244 Dumpsys dumpsys(sm.get());
Vishnu Naire97d6122018-01-18 13:58:56 -08001245 Vector<String16> args;
1246 Dumpsys::setServiceArgs(args, /* asProto = */ false, priority);
Vishnu Naire97d6122018-01-18 13:58:56 -08001247 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ false);
1248 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001249 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001250 std::string path(title);
1251 path.append(" - ").append(String8(service).c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -08001252 size_t bytes_written = 0;
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001253 if (PropertiesHelper::IsDryRun()) {
1254 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1255 dumpsys.writeDumpFooter(STDOUT_FILENO, service, std::chrono::milliseconds(1));
1256 } else {
1257 status_t status = dumpsys.startDumpThread(Dumpsys::TYPE_DUMP, service, args);
1258 if (status == OK) {
1259 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1260 std::chrono::duration<double> elapsed_seconds;
1261 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH &&
1262 service == String16("meminfo")) {
1263 // Use a longer timeout for meminfo, since 30s is not always enough.
1264 status = dumpsys.writeDump(STDOUT_FILENO, service, 60s,
1265 /* as_proto = */ false, elapsed_seconds,
1266 bytes_written);
1267 } else {
1268 status = dumpsys.writeDump(STDOUT_FILENO, service, service_timeout,
1269 /* as_proto = */ false, elapsed_seconds,
1270 bytes_written);
1271 }
1272 dumpsys.writeDumpFooter(STDOUT_FILENO, service, elapsed_seconds);
1273 bool dump_complete = (status == OK);
1274 dumpsys.stopDumpThread(dump_complete);
Gavin Corkeryfac7e2b2021-07-08 22:39:02 +01001275 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001276 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001277
1278 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1279 std::chrono::steady_clock::now() - start);
1280 if (elapsed_duration > timeout) {
1281 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1282 elapsed_duration.count());
1283 break;
1284 }
1285 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001286 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001287}
1288
Vishnu Nair64afc022018-02-01 15:29:34 -08001289static void RunDumpsysText(const std::string& title, int priority,
1290 std::chrono::milliseconds timeout,
1291 std::chrono::milliseconds service_timeout) {
1292 DurationReporter duration_reporter(title);
1293 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1294 fsync(STDOUT_FILENO);
1295 RunDumpsysTextByPriority(title, priority, timeout, service_timeout);
1296}
1297
1298/* Dump all services registered with Normal or Default priority. */
Nandana Dutt5c390032019-03-12 10:52:56 +00001299static Dumpstate::RunStatus RunDumpsysTextNormalPriority(const std::string& title,
1300 std::chrono::milliseconds timeout,
1301 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001302 DurationReporter duration_reporter(title);
1303 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1304 fsync(STDOUT_FILENO);
1305 RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_NORMAL, timeout,
1306 service_timeout);
Nandana Dutt5c390032019-03-12 10:52:56 +00001307
1308 RETURN_IF_USER_DENIED_CONSENT();
1309
1310 return RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_DEFAULT, timeout,
1311 service_timeout);
Vishnu Nair64afc022018-02-01 15:29:34 -08001312}
1313
Nandana Dutt5c390032019-03-12 10:52:56 +00001314static Dumpstate::RunStatus RunDumpsysProto(const std::string& title, int priority,
1315 std::chrono::milliseconds timeout,
1316 std::chrono::milliseconds service_timeout) {
Vishnu Naire97d6122018-01-18 13:58:56 -08001317 sp<android::IServiceManager> sm = defaultServiceManager();
1318 Dumpsys dumpsys(sm.get());
1319 Vector<String16> args;
1320 Dumpsys::setServiceArgs(args, /* asProto = */ true, priority);
1321 DurationReporter duration_reporter(title);
1322
1323 auto start = std::chrono::steady_clock::now();
1324 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ true);
1325 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001326 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001327 std::string path(kProtoPath);
1328 path.append(String8(service).c_str());
1329 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL) {
1330 path.append("_CRITICAL");
1331 } else if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH) {
1332 path.append("_HIGH");
1333 }
1334 path.append(kProtoExt);
Steven Morelandcbd69fc2021-07-20 20:45:43 +00001335 status_t status = dumpsys.startDumpThread(Dumpsys::TYPE_DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001336 if (status == OK) {
1337 status = ds.AddZipEntryFromFd(path, dumpsys.getDumpFd(), service_timeout);
1338 bool dumpTerminated = (status == OK);
1339 dumpsys.stopDumpThread(dumpTerminated);
1340 }
1341 ZipWriter::FileEntry file_entry;
1342 ds.zip_writer_->GetLastEntry(&file_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -08001343
1344 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1345 std::chrono::steady_clock::now() - start);
1346 if (elapsed_duration > timeout) {
1347 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1348 elapsed_duration.count());
1349 break;
1350 }
1351 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001352 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001353}
1354
Nandana Dutta7db6342018-11-21 14:53:34 +00001355// Runs dumpsys on services that must dump first and will take less than 100ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001356static Dumpstate::RunStatus RunDumpsysCritical() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001357 RunDumpsysText("DUMPSYS CRITICAL", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1358 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Nandana Dutt5c390032019-03-12 10:52:56 +00001359
1360 RETURN_IF_USER_DENIED_CONSENT();
1361
1362 return RunDumpsysProto("DUMPSYS CRITICAL PROTO", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1363 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Vishnu Nair780b1282017-10-10 13:57:24 -07001364}
1365
1366// Runs dumpsys on services that must dump first but can take up to 250ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001367static Dumpstate::RunStatus RunDumpsysHigh() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001368 // TODO meminfo takes ~10s, connectivity takes ~5sec to dump. They are both
1369 // high priority. Reduce timeout once they are able to dump in a shorter time or
1370 // moved to a parallel task.
1371 RunDumpsysText("DUMPSYS HIGH", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1372 /* timeout= */ 90s, /* service_timeout= */ 30s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001373
1374 RETURN_IF_USER_DENIED_CONSENT();
1375
1376 return RunDumpsysProto("DUMPSYS HIGH PROTO", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1377 /* timeout= */ 5s, /* service_timeout= */ 1s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001378}
1379
1380// Runs dumpsys on services that must dump but can take up to 10s to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001381static Dumpstate::RunStatus RunDumpsysNormal() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001382 RunDumpsysTextNormalPriority("DUMPSYS", /* timeout= */ 90s, /* service_timeout= */ 10s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001383
1384 RETURN_IF_USER_DENIED_CONSENT();
1385
1386 return RunDumpsysProto("DUMPSYS PROTO", IServiceManager::DUMP_FLAG_PRIORITY_NORMAL,
1387 /* timeout= */ 90s, /* service_timeout= */ 10s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001388}
1389
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001390/*
1391 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1392 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1393 * if it's not running in the parallel task.
1394 */
1395static void DumpHals(int out_fd = STDOUT_FILENO) {
Yifan Hong30528a22020-08-07 18:24:06 -07001396 RunCommand("HARDWARE HALS", {"lshal", "--all", "--types=all"},
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001397 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build(),
1398 false, out_fd);
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001399
Steven Moreland44cd9482018-01-04 16:24:13 -08001400 using android::hidl::manager::V1_0::IServiceManager;
1401 using android::hardware::defaultServiceManager;
1402
1403 sp<IServiceManager> sm = defaultServiceManager();
1404 if (sm == nullptr) {
1405 MYLOGE("Could not retrieve hwservicemanager to dump hals.\n");
1406 return;
1407 }
1408
1409 auto ret = sm->list([&](const auto& interfaces) {
1410 for (const std::string& interface : interfaces) {
1411 std::string cleanName = interface;
1412 std::replace_if(cleanName.begin(),
1413 cleanName.end(),
1414 [](char c) {
1415 return !isalnum(c) &&
1416 std::string("@-_:.").find(c) == std::string::npos;
1417 }, '_');
Nandana Dutt979388e2018-11-30 16:48:55 +00001418 const std::string path = ds.bugreport_internal_dir_ + "/lshal_debug_" + cleanName;
Steven Moreland44cd9482018-01-04 16:24:13 -08001419
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001420 bool empty = false;
Steven Moreland44cd9482018-01-04 16:24:13 -08001421 {
1422 auto fd = android::base::unique_fd(
1423 TEMP_FAILURE_RETRY(open(path.c_str(),
1424 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1425 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1426 if (fd < 0) {
1427 MYLOGE("Could not open %s to dump additional hal information.\n", path.c_str());
1428 continue;
1429 }
1430 RunCommandToFd(fd,
1431 "",
Steven Morelandc81cd3c2018-01-18 14:36:26 -08001432 {"lshal", "debug", "-E", interface},
Steven Moreland44cd9482018-01-04 16:24:13 -08001433 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
1434
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001435 empty = 0 == lseek(fd, 0, SEEK_END);
Steven Moreland44cd9482018-01-04 16:24:13 -08001436 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001437 if (!empty) {
1438 ds.EnqueueAddZipEntryAndCleanupIfNeeded("lshal-debug/" + cleanName + ".txt",
1439 path);
1440 } else {
1441 unlink(path.c_str());
1442 }
Steven Moreland44cd9482018-01-04 16:24:13 -08001443 }
1444 });
1445
1446 if (!ret.isOk()) {
1447 MYLOGE("Could not list hals from hwservicemanager.\n");
1448 }
1449}
1450
Devin Moore8df81bb2022-06-08 22:47:02 +00001451// Dump all of the files that make up the vendor interface.
1452// See the files listed in dumpFileList() for the latest list of files.
1453static void DumpVintf() {
Devin Moore16271d92022-09-22 18:28:48 +00001454
1455 const std::string sku = android::base::GetProperty("ro.boot.product.hardware.sku", "");
1456 const auto vintfFiles = android::vintf::details::dumpFileList(sku);
Devin Moore8df81bb2022-06-08 22:47:02 +00001457 for (const auto vintfFile : vintfFiles) {
1458 struct stat st;
1459 if (stat(vintfFile.c_str(), &st) == 0) {
1460 if (S_ISDIR(st.st_mode)) {
1461 ds.AddDir(vintfFile, true /* recursive */);
1462 } else {
1463 ds.EnqueueAddZipEntryAndCleanupIfNeeded(ZIP_ROOT_DIR + vintfFile,
1464 vintfFile);
1465 }
1466 }
1467 }
1468}
1469
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001470static void DumpExternalFragmentationInfo() {
1471 struct stat st;
1472 if (stat("/proc/buddyinfo", &st) != 0) {
1473 MYLOGE("Unable to dump external fragmentation info\n");
1474 return;
1475 }
1476
1477 printf("------ EXTERNAL FRAGMENTATION INFO ------\n");
1478 std::ifstream ifs("/proc/buddyinfo");
1479 auto unusable_index_regex = std::regex{"Node\\s+([0-9]+),\\s+zone\\s+(\\S+)\\s+(.*)"};
1480 for (std::string line; std::getline(ifs, line);) {
1481 std::smatch match_results;
1482 if (std::regex_match(line, match_results, unusable_index_regex)) {
1483 std::stringstream free_pages(std::string{match_results[3]});
1484 std::vector<int> free_pages_per_order(std::istream_iterator<int>{free_pages},
1485 std::istream_iterator<int>());
1486
1487 int total_free_pages = 0;
1488 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1489 total_free_pages += (free_pages_per_order[i] * std::pow(2, i));
1490 }
1491
1492 printf("Node %s, zone %8s", match_results[1].str().c_str(),
1493 match_results[2].str().c_str());
1494
1495 int usable_free_pages = total_free_pages;
1496 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1497 auto unusable_index = (total_free_pages - usable_free_pages) /
1498 static_cast<double>(total_free_pages);
1499 printf(" %5.3f", unusable_index);
1500 usable_free_pages -= (free_pages_per_order[i] * std::pow(2, i));
1501 }
1502
1503 printf("\n");
1504 }
1505 }
1506 printf("\n");
1507}
1508
mhasankd451a472020-05-26 18:02:39 -07001509static void DumpstateLimitedOnly() {
1510 // Trimmed-down version of dumpstate to only include a whitelisted
1511 // set of logs (system log, event log, and system server / system app
1512 // crashes, and networking logs). See b/136273873 and b/138459828
1513 // for context.
1514 DurationReporter duration_reporter("DUMPSTATE");
1515 unsigned long timeout_ms;
1516 // calculate timeout
1517 timeout_ms = logcat_timeout({"main", "system", "crash"});
1518 RunCommand("SYSTEM LOG",
1519 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1520 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1521 timeout_ms = logcat_timeout({"events"});
1522 RunCommand(
1523 "EVENT LOG",
1524 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1525 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1526
1527 printf("========================================================\n");
1528 printf("== Networking Service\n");
1529 printf("========================================================\n");
1530
1531 RunDumpsys("DUMPSYS NETWORK_SERVICE_LIMITED", {"wifi", "-a"},
1532 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hugo Benichiaa162682020-10-30 23:28:56 +09001533 RunDumpsys("DUMPSYS CONNECTIVITY REQUESTS", {"connectivity", "requests"},
1534 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
mhasankd451a472020-05-26 18:02:39 -07001535
1536 printf("========================================================\n");
1537 printf("== Dropbox crashes\n");
1538 printf("========================================================\n");
1539
1540 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1541 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1542
1543 printf("========================================================\n");
1544 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1545 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1546 printf("========================================================\n");
1547 printf("== dumpstate: done (id %d)\n", ds.id_);
1548 printf("========================================================\n");
1549}
1550
Rhed Jaoe017f982020-07-21 17:58:41 +08001551/*
1552 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1553 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1554 * if it's not running in the parallel task.
1555 */
1556static void DumpCheckins(int out_fd = STDOUT_FILENO) {
1557 dprintf(out_fd, "========================================================\n");
1558 dprintf(out_fd, "== Checkins\n");
1559 dprintf(out_fd, "========================================================\n");
1560
1561 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"}, out_fd);
Rhed Jaoe017f982020-07-21 17:58:41 +08001562 RunDumpsys("CHECKIN NETSTATS", {"netstats", "--checkin"}, out_fd);
1563 RunDumpsys("CHECKIN PROCSTATS", {"procstats", "-c"}, out_fd);
1564 RunDumpsys("CHECKIN USAGESTATS", {"usagestats", "-c"}, out_fd);
1565 RunDumpsys("CHECKIN PACKAGE", {"package", "--checkin"}, out_fd);
1566}
1567
1568/*
1569 * Runs dumpsys on activity service to dump all application activities, services
1570 * and providers in the device.
1571 *
1572 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1573 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1574 * if it's not running in the parallel task.
1575 */
1576static void DumpAppInfos(int out_fd = STDOUT_FILENO) {
1577 dprintf(out_fd, "========================================================\n");
1578 dprintf(out_fd, "== Running Application Activities\n");
1579 dprintf(out_fd, "========================================================\n");
1580
1581 // The following dumpsys internally collects output from running apps, so it can take a long
1582 // time. So let's extend the timeout.
1583
1584 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
1585
1586 RunDumpsys("APP ACTIVITIES", {"activity", "-v", "all"}, DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1587
1588 dprintf(out_fd, "========================================================\n");
1589 dprintf(out_fd, "== Running Application Services (platform)\n");
1590 dprintf(out_fd, "========================================================\n");
1591
1592 RunDumpsys("APP SERVICES PLATFORM", {"activity", "service", "all-platform-non-critical"},
1593 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1594
1595 dprintf(out_fd, "========================================================\n");
1596 dprintf(out_fd, "== Running Application Services (non-platform)\n");
1597 dprintf(out_fd, "========================================================\n");
1598
1599 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1600 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1601
1602 dprintf(out_fd, "========================================================\n");
1603 dprintf(out_fd, "== Running Application Providers (platform)\n");
1604 dprintf(out_fd, "========================================================\n");
1605
1606 RunDumpsys("APP PROVIDERS PLATFORM", {"activity", "provider", "all-platform"},
Rhed Jaob049f182021-01-11 21:08:43 +08001607 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
Rhed Jaoe017f982020-07-21 17:58:41 +08001608
1609 dprintf(out_fd, "========================================================\n");
1610 dprintf(out_fd, "== Running Application Providers (non-platform)\n");
1611 dprintf(out_fd, "========================================================\n");
1612
1613 RunDumpsys("APP PROVIDERS NON-PLATFORM", {"activity", "provider", "all-non-platform"},
1614 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1615}
1616
Nandana Dutt5c390032019-03-12 10:52:56 +00001617// Dumps various things. Returns early with status USER_CONSENT_DENIED if user denies consent
1618// via the consent they are shown. Ignores other errors that occur while running various
1619// commands. The consent checking is currently done around long running tasks, which happen to
1620// be distributed fairly evenly throughout the function.
Kean Mariotti306633e2022-09-05 16:30:47 +00001621Dumpstate::RunStatus Dumpstate::dumpstate() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001622 DurationReporter duration_reporter("DUMPSTATE");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001623
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001624 // Enqueue slow functions into the thread pool, if the parallel run is enabled.
Aaron Huang24d215d2022-04-27 18:51:16 +08001625 std::future<std::string> dump_hals, dump_incident_report, dump_board, dump_checkins,
Kean Mariotti306633e2022-09-05 16:30:47 +00001626 dump_netstats_report, post_process_ui_traces;
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001627 if (ds.dump_pool_) {
1628 // Pool was shutdown in DumpstateDefaultAfterCritical method in order to
Kean Mariotti306633e2022-09-05 16:30:47 +00001629 // drop root user. Restarts it.
1630 ds.dump_pool_->start(/* thread_counts = */3);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001631
Chris Morinbc223142022-02-04 14:17:11 -08001632 dump_hals = ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
1633 dump_incident_report = ds.dump_pool_->enqueueTask(
1634 DUMP_INCIDENT_REPORT_TASK, &DumpIncidentReport);
Aaron Huang24d215d2022-04-27 18:51:16 +08001635 dump_netstats_report = ds.dump_pool_->enqueueTask(
1636 DUMP_NETSTATS_PROTO_TASK, &DumpNetstatsProto);
Chris Morinbc223142022-02-04 14:17:11 -08001637 dump_board = ds.dump_pool_->enqueueTaskWithFd(
1638 DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
1639 dump_checkins = ds.dump_pool_->enqueueTaskWithFd(DUMP_CHECKINS_TASK, &DumpCheckins, _1);
Kean Mariotti306633e2022-09-05 16:30:47 +00001640 post_process_ui_traces = ds.dump_pool_->enqueueTask(
1641 POST_PROCESS_UI_TRACES_TASK, &Dumpstate::MaybePostProcessUiTraces, &ds);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001642 }
1643
Nandana Dutt5c390032019-03-12 10:52:56 +00001644 // Dump various things. Note that anything that takes "long" (i.e. several seconds) should
1645 // check intermittently (if it's intrerruptable like a foreach on pids) and/or should be wrapped
1646 // in a consent check (via RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK).
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -07001647 dump_dev_files("TRUSTY VERSION", "/sys/bus/platform/drivers/trusty", "trusty_version");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001648 RunCommand("UPTIME", {"uptime"});
Wei Wang509bb5d2017-06-09 14:42:12 -07001649 DumpBlockStatFiles();
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001650 DumpFile("MEMORY INFO", "/proc/meminfo");
1651 RunCommand("CPU INFO", {"top", "-b", "-n", "1", "-H", "-s", "6", "-o",
Felipe Leme30dbfa12016-09-02 12:43:26 -07001652 "pid,tid,user,pr,ni,%cpu,s,virt,res,pcy,cmd,name"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001653
Kevin Jeon947922b2022-09-21 00:29:18 +00001654 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "BUGREPORT_PROCDUMP", {"bugreport_procdump"},
1655 CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001656
Sunny Goyal35949782019-11-19 15:54:36 -08001657 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpVisibleWindowViews);
1658
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001659 DumpFile("VIRTUAL MEMORY STATS", "/proc/vmstat");
1660 DumpFile("VMALLOC INFO", "/proc/vmallocinfo");
1661 DumpFile("SLAB INFO", "/proc/slabinfo");
1662 DumpFile("ZONEINFO", "/proc/zoneinfo");
1663 DumpFile("PAGETYPEINFO", "/proc/pagetypeinfo");
1664 DumpFile("BUDDYINFO", "/proc/buddyinfo");
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001665 DumpExternalFragmentationInfo();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001666
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001667 DumpFile("KERNEL CPUFREQ", "/sys/devices/system/cpu/cpu0/cpufreq/stats/time_in_state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001668
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001669 RunCommand("PROCESSES AND THREADS",
Yohei Yukawa591a72d2017-10-05 21:36:35 -07001670 {"ps", "-A", "-T", "-Z", "-O", "pri,nice,rtprio,sched,pcy,time"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001671
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001672 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001673 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_hals));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001674 } else {
1675 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_HALS_TASK, DumpHals);
1676 }
Steven Moreland81b429e2017-01-31 19:50:46 -08001677
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001678 RunCommand("PRINTENV", {"printenv"});
Elliott Hughes21b7c8d2016-10-28 08:53:02 -07001679 RunCommand("NETSTAT", {"netstat", "-nW"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001680 struct stat s;
1681 if (stat("/proc/modules", &s) != 0) {
1682 MYLOGD("Skipping 'lsmod' because /proc/modules does not exist\n");
1683 } else {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001684 RunCommand("LSMOD", {"lsmod"});
Woody Linc198f252021-05-04 16:37:11 +08001685 RunCommand("MODULES INFO",
1686 {"sh", "-c", "cat /proc/modules | cut -d' ' -f1 | "
1687 " while read MOD ; do echo modinfo:$MOD ; modinfo $MOD ; "
1688 "done"}, CommandOptions::AS_ROOT);
Felipe Lemee4eca582016-06-10 17:48:08 -07001689 }
Michal Karpinski4db754f2015-12-11 18:04:32 +00001690
Tom Cherryb87dbfa2020-07-28 11:28:53 -07001691 if (android::base::GetBoolProperty("ro.logd.kernel", false)) {
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001692 DoKernelLogcat();
1693 } else {
1694 do_dmesg();
1695 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001696
Devin Moore8df81bb2022-06-08 22:47:02 +00001697 DumpVintf();
1698
Felipe Lemef0292972016-11-22 13:57:05 -08001699 RunCommand("LIST OF OPEN FILES", {"lsof"}, CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001700
Jeff Brown1dc94e32014-09-11 14:15:27 -07001701 for_each_tid(show_wchan, "BLOCKED PROCESS WAIT-CHANNELS");
Mark Salyzyna297c322016-02-05 15:33:17 -08001702 for_each_pid(show_showtime, "PROCESS TIMES (pid cmd user system iowait+percentage)");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001703
Jack Yu5a6b2e22020-08-14 18:13:35 +08001704 /* Dump Nfc NCI logs */
1705 ds.AddDir("/data/misc/nfc/logs", true);
Ajay Panickerd886ec42016-09-14 12:26:46 -07001706
Paul Chang0d2aad72020-02-13 20:04:03 +08001707 if (ds.options_->do_screenshot && !ds.do_early_screenshot_) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001708 MYLOGI("taking late screenshot\n");
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001709 ds.TakeScreenshot();
Jeff Sharkey5a930032013-03-19 15:05:19 -07001710 }
1711
Felipe Lemee184f662016-10-27 10:04:47 -07001712 AddAnrTraceFiles();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001713
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001714 MaybeAddSystemTraceToZip();
1715
Narayan Kamath8f788292017-05-25 13:20:39 +01001716 // NOTE: tombstones are always added as separate entries in the zip archive
1717 // and are not interspersed with the main report.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001718 const bool tombstones_dumped = AddDumps(ds.tombstone_data_.begin(), ds.tombstone_data_.end(),
Narayan Kamathbd863722017-06-01 18:50:12 +01001719 "TOMBSTONE", true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001720 if (!tombstones_dumped) {
1721 printf("*** NO TOMBSTONES to dump in %s\n\n", TOMBSTONE_DIR.c_str());
Christopher Ferris7dc7f322014-07-22 16:08:19 -07001722 }
1723
Jayachandran Ca94c7172017-06-10 15:08:12 -07001724 DumpPacketStats();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001725
Lorenzo Colitti807f2dd2022-05-27 12:48:37 +09001726 RunDumpsys("EBPF MAP STATS", {"connectivity", "trafficcontroller"});
Chenbo Feng276a3b62018-08-07 11:44:49 -07001727
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001728 DoKmsg();
Mark Salyzyn2262c162014-12-16 09:09:26 -08001729
Woody Lin20767a92022-11-29 15:50:24 +08001730 DumpShutdownCheckpoints();
1731
Jayachandran Ca94c7172017-06-10 15:08:12 -07001732 DumpIpAddrAndRules();
Sreeram Ramachandran2b3bba32014-07-08 15:40:55 -07001733
1734 dump_route_tables();
1735
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001736 RunCommand("ARP CACHE", {"ip", "-4", "neigh", "show"});
1737 RunCommand("IPv6 ND CACHE", {"ip", "-6", "neigh", "show"});
1738 RunCommand("MULTICAST ADDRESSES", {"ip", "maddr"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001739
Nandana Dutt5c390032019-03-12 10:52:56 +00001740 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysHigh);
Lorenzo Colitti6afc38c2015-09-09 22:59:25 +09001741
Chiachang Wang668ede42021-05-17 17:14:20 +08001742 // The dump mechanism in connectivity is refactored due to modularization work. Connectivity can
1743 // only register with a default priority(NORMAL priority). Dumpstate has to call connectivity
1744 // dump with priority parameters to dump high priority information.
1745 RunDumpsys("SERVICE HIGH connectivity", {"connectivity", "--dump-priority", "HIGH"},
1746 CommandOptions::WithTimeout(10).Build());
1747
Elliott Hughes23ccc622017-02-28 10:14:22 -08001748 RunCommand("SYSTEM PROPERTIES", {"getprop"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001749
Jin Qianf334d662017-10-10 14:41:37 -07001750 RunCommand("STORAGED IO INFO", {"storaged", "-u", "-p"});
ynwangf649a6e2016-07-17 21:56:00 -07001751
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001752 RunCommand("FILESYSTEMS & FREE SPACE", {"df"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001753
Colin Crossf45fa6b2012-03-26 12:38:26 -07001754 /* Binder state is expensive to look at as it uses a lot of memory. */
Hridya Valsaraju920ba712020-02-09 16:27:01 -08001755 std::string binder_logs_dir = access("/dev/binderfs/binder_logs", R_OK) ?
1756 "/sys/kernel/debug/binder" : "/dev/binderfs/binder_logs";
1757
1758 DumpFile("BINDER FAILED TRANSACTION LOG", binder_logs_dir + "/failed_transaction_log");
1759 DumpFile("BINDER TRANSACTION LOG", binder_logs_dir + "/transaction_log");
1760 DumpFile("BINDER TRANSACTIONS", binder_logs_dir + "/transactions");
1761 DumpFile("BINDER STATS", binder_logs_dir + "/stats");
1762 DumpFile("BINDER STATE", binder_logs_dir + "/state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001763
Yifan Hongd90cc652020-02-08 16:52:02 -08001764 ds.AddDir(SNAPSHOTCTL_LOG_DIR, false);
1765
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001766 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001767 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_board));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001768 } else {
1769 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
1770 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001771
Steven Moreland7440ddb2016-12-15 16:13:39 -08001772 /* Migrate the ril_dumpstate to a device specific dumpstate? */
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001773 int rilDumpstateTimeout = android::base::GetIntProperty("ril.dumpstate.timeout", 0);
1774 if (rilDumpstateTimeout > 0) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001775 // su does not exist on user builds, so try running without it.
1776 // This way any implementations of vril-dump that do not require
1777 // root can run on user builds.
1778 CommandOptions::CommandOptionsBuilder options =
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001779 CommandOptions::WithTimeout(rilDumpstateTimeout);
Felipe Lemef0292972016-11-22 13:57:05 -08001780 if (!PropertiesHelper::IsUserBuild()) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001781 options.AsRoot();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001782 }
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001783 RunCommand("DUMP VENDOR RIL LOGS", {"vril-dump"}, options.Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -07001784 }
1785
Felipe Lemed8b94e52016-12-08 10:21:44 -08001786 printf("========================================================\n");
1787 printf("== Android Framework Services\n");
1788 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001789
Nandana Dutt5c390032019-03-12 10:52:56 +00001790 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysNormal);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001791
Jack He91ff2fe2021-02-18 18:23:43 -08001792 /* Dump Bluetooth HCI logs after getting bluetooth_manager dumpsys */
1793 ds.AddDir("/data/misc/bluetooth/logs", true);
1794
Rhed Jaoe017f982020-07-21 17:58:41 +08001795 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001796 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_checkins));
Rhed Jaoe017f982020-07-21 17:58:41 +08001797 } else {
1798 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_CHECKINS_TASK, DumpCheckins);
1799 }
Dianne Hackborn02bea972013-06-26 18:59:09 -07001800
Rhed Jaoc5f7ec32020-12-22 22:11:08 +08001801 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpAppInfos);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001802
Adrian Roos8b397ab2017-04-04 16:35:44 -07001803 printf("========================================================\n");
1804 printf("== Dropbox crashes\n");
1805 printf("========================================================\n");
1806
1807 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1808 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1809
Felipe Lemed8b94e52016-12-08 10:21:44 -08001810 printf("========================================================\n");
1811 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1812 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1813 printf("========================================================\n");
1814 printf("== dumpstate: done (id %d)\n", ds.id_);
1815 printf("========================================================\n");
Bookatz38472142018-09-28 10:20:24 -07001816
1817 printf("========================================================\n");
1818 printf("== Obtaining statsd metadata\n");
1819 printf("========================================================\n");
1820 // This differs from the usual dumpsys stats, which is the stats report data.
1821 RunDumpsys("STATSDSTATS", {"stats", "--metadata"});
Mike Ma5c267872019-08-21 11:31:34 -07001822
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +09001823 // Add linker configuration directory
1824 ds.AddDir(LINKERCONFIG_DIR, true);
1825
Li Li830179f2022-01-04 12:53:29 -08001826 /* Dump frozen cgroupfs */
1827 dump_frozen_cgroupfs();
Li Li2eedd412021-06-30 15:11:53 -07001828
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001829 if (ds.dump_pool_) {
Aaron Huang24d215d2022-04-27 18:51:16 +08001830 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_netstats_report));
1831 } else {
1832 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_NETSTATS_PROTO_TASK,
1833 DumpNetstatsProto);
1834 }
1835
1836 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001837 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_incident_report));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001838 } else {
1839 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_INCIDENT_REPORT_TASK,
1840 DumpIncidentReport);
1841 }
Mike Ma5c267872019-08-21 11:31:34 -07001842
Kean Mariotti306633e2022-09-05 16:30:47 +00001843 if (ds.dump_pool_) {
1844 WaitForTask(std::move(post_process_ui_traces));
1845 } else {
1846 RUN_SLOW_FUNCTION_AND_LOG(POST_PROCESS_UI_TRACES_TASK, MaybePostProcessUiTraces);
1847 }
1848
1849 MaybeAddUiTracesToZip();
1850
Nandana Dutt5c390032019-03-12 10:52:56 +00001851 return Dumpstate::RunStatus::OK;
Colin Crossf45fa6b2012-03-26 12:38:26 -07001852}
1853
Nandana Dutt5c390032019-03-12 10:52:56 +00001854/*
1855 * Dumps state for the default case; drops root after it's no longer necessary.
1856 *
1857 * Returns RunStatus::OK if everything went fine.
1858 * Returns RunStatus::ERROR if there was an error.
1859 * Returns RunStatus::USER_DENIED_CONSENT if user explicitly denied consent to sharing the bugreport
1860 * with the caller.
1861 */
Jichao Lie89d9c12019-11-21 19:02:51 -08001862Dumpstate::RunStatus Dumpstate::DumpstateDefaultAfterCritical() {
Nandana Duttdb379fa2019-10-09 16:54:41 +01001863 // Capture first logcat early on; useful to take a snapshot before dumpstate logs take over the
1864 // buffer.
1865 DoLogcat();
1866 // Capture timestamp after first logcat to use in next logcat
1867 time_t logcat_ts = time(nullptr);
1868
Nandana Dutt4be45d12018-09-26 15:04:23 +01001869 /* collect stack traces from Dalvik and native processes (needs root) */
Chris Morinbc223142022-02-04 14:17:11 -08001870 std::future<std::string> dump_traces;
Rhed Jao5377d792020-07-16 17:37:39 +08001871 if (dump_pool_) {
1872 RETURN_IF_USER_DENIED_CONSENT();
1873 // One thread is enough since we only need to enqueue DumpTraces here.
1874 dump_pool_->start(/* thread_counts = */1);
1875
1876 // DumpTraces takes long time, post it to the another thread in the
1877 // pool, if pool is available
Chris Morinbc223142022-02-04 14:17:11 -08001878 dump_traces = dump_pool_->enqueueTask(
1879 DUMP_TRACES_TASK, &Dumpstate::DumpTraces, &ds, &dump_traces_path);
Rhed Jao5377d792020-07-16 17:37:39 +08001880 } else {
1881 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_TRACES_TASK, ds.DumpTraces,
1882 &dump_traces_path);
1883 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001884
1885 /* Run some operations that require root. */
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001886 if (!PropertiesHelper::IsDryRun()) {
Chris Morinc2cba7a2022-02-01 17:06:50 -08001887 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX);
1888 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX);
Woody Lin20767a92022-11-29 15:50:24 +08001889 ds.shutdown_checkpoints_ = GetDumpFds(
1890 SHUTDOWN_CHECKPOINTS_DIR, SHUTDOWN_CHECKPOINTS_FILE_PREFIX);
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001891 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001892
1893 ds.AddDir(RECOVERY_DIR, true);
1894 ds.AddDir(RECOVERY_DATA_DIR, true);
1895 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
Kelvin Zhang6eaa0f92022-09-12 09:29:19 -07001896 ds.AddDir(UPDATE_ENGINE_PREF_DIR, true);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001897 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1898 if (!PropertiesHelper::IsUserBuild()) {
1899 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1900 ds.AddDir(PROFILE_DATA_DIR_REF, true);
Calin Juravlef84d3692020-04-28 15:31:12 -07001901 ds.AddZipEntry(ZIP_ROOT_DIR + PACKAGE_DEX_USE_LIST, PACKAGE_DEX_USE_LIST);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001902 }
Jerry Changa1df8a92020-01-02 16:03:39 +08001903 ds.AddDir(PREREBOOT_DATA_DIR, false);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001904 add_mountinfo();
1905 DumpIpTablesAsRoot();
David Andersond9ba4752018-12-11 18:26:59 -08001906 DumpDynamicPartitionInfo();
Yifan Hong3945e1b2019-10-29 12:59:23 -07001907 ds.AddDir(OTA_METADATA_DIR, true);
Jeff Sharkey9df29d52023-02-06 14:26:30 -07001908 if (!PropertiesHelper::IsUserBuild()) {
1909 // Include dropbox entry files inside ZIP, but exclude
1910 // noisy WTF and StrictMode entries
1911 dump_files("", DROPBOX_DIR, skip_wtf_strictmode, _add_file_from_fd);
1912 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001913
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001914 // Capture any IPSec policies in play. No keys are exposed here.
Nandana Dutt4be45d12018-09-26 15:04:23 +01001915 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1916
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001917 // Dump IPsec stats. No keys are exposed here.
1918 DumpFile("XFRM STATS", XFRM_STAT_PROC_FILE);
1919
Nandana Dutt4be45d12018-09-26 15:04:23 +01001920 // Run ss as root so we can see socket marks.
1921 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
1922
1923 // Run iotop as root to show top 100 IO threads
1924 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
1925
Erick Reyese68df822019-02-11 14:46:36 -08001926 // Gather shared memory buffer info if the product implements it
Hridya Valsaraju1da80c52021-01-09 22:10:11 -08001927 RunCommand("Dmabuf dump", {"dmabuf_dump"});
1928 RunCommand("Dmabuf per-buffer/per-exporter/per-device stats", {"dmabuf_dump", "-b"});
Erick Reyese68df822019-02-11 14:46:36 -08001929
Minchan Kim22c6a1e2019-09-30 15:58:10 -07001930 DumpFile("PSI cpu", "/proc/pressure/cpu");
1931 DumpFile("PSI memory", "/proc/pressure/memory");
1932 DumpFile("PSI io", "/proc/pressure/io");
1933
Mårten Kongstad60195a72022-09-20 14:14:20 +02001934 RunCommand("SDK EXTENSIONS", {SDK_EXT_INFO, "--dump"},
1935 CommandOptions::WithTimeout(10).Always().DropRoot().Build());
1936
Rhed Jao5377d792020-07-16 17:37:39 +08001937 if (dump_pool_) {
1938 RETURN_IF_USER_DENIED_CONSENT();
Chris Morinbc223142022-02-04 14:17:11 -08001939 WaitForTask(std::move(dump_traces));
Rhed Jao5377d792020-07-16 17:37:39 +08001940
Chris Morinbc223142022-02-04 14:17:11 -08001941 // Current running thread in the pool is the root user also. Delete
1942 // the pool and make a new one later to ensure none of threads in the pool are root.
1943 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao5377d792020-07-16 17:37:39 +08001944 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001945 if (!DropRootUser()) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001946 return Dumpstate::RunStatus::ERROR;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001947 }
1948
Nandana Dutt5c390032019-03-12 10:52:56 +00001949 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttdb379fa2019-10-09 16:54:41 +01001950 Dumpstate::RunStatus status = dumpstate();
1951 // Capture logcat since the last time we did it.
1952 DoSystemLogcat(logcat_ts);
1953 return status;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001954}
1955
Rhed Jaob5685b32020-08-14 17:19:17 +08001956// Common states for telephony and wifi which are needed to be collected before
1957// dumpstate drop the root user.
1958static void DumpstateRadioAsRoot() {
1959 DumpIpTablesAsRoot();
1960 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1961}
1962
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001963// This method collects common dumpsys for telephony and wifi. Typically, wifi
1964// reports are fine to include all information, but telephony reports on user
1965// builds need to strip some content (see DumpstateTelephonyOnly).
1966static void DumpstateRadioCommon(bool include_sensitive_info = true) {
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001967 // We need to be picky about some stuff for telephony reports on user builds.
1968 if (!include_sensitive_info) {
1969 // Only dump the radio log buffer (other buffers and dumps contain too much unrelated info).
1970 DoRadioLogcat();
1971 } else {
Rhed Jaob5685b32020-08-14 17:19:17 +08001972 // DumpHals takes long time, post it to the another thread in the pool,
1973 // if pool is available.
Chris Morinbc223142022-02-04 14:17:11 -08001974 std::future<std::string> dump_hals;
Rhed Jaob5685b32020-08-14 17:19:17 +08001975 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001976 dump_hals = ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
Rhed Jaob5685b32020-08-14 17:19:17 +08001977 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001978 // Contains various system properties and process startup info.
1979 do_dmesg();
1980 // Logs other than the radio buffer may contain package/component names and potential PII.
1981 DoLogcat();
1982 // Too broad for connectivity problems.
1983 DoKmsg();
Rhed Jaob5685b32020-08-14 17:19:17 +08001984 // DumpHals contains unrelated hardware info (camera, NFC, biometrics, ...).
1985 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001986 WaitForTask(std::move(dump_hals));
Rhed Jaob5685b32020-08-14 17:19:17 +08001987 } else {
1988 RUN_SLOW_FUNCTION_AND_LOG(DUMP_HALS_TASK, DumpHals);
1989 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001990 }
1991
Jayachandran Ca94c7172017-06-10 15:08:12 -07001992 DumpPacketStats();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001993 DumpIpAddrAndRules();
1994 dump_route_tables();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001995 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
1996 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08001997}
1998
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001999// We use "telephony" here for legacy reasons, though this now really means "connectivity" (cellular
2000// + wifi + networking). This method collects dumpsys for connectivity debugging only. General rules
2001// for what can be included on user builds: all reported information MUST directly relate to
2002// connectivity debugging or customer support and MUST NOT contain unrelated personally identifiable
2003// information. This information MUST NOT identify user-installed packages (UIDs are OK, package
2004// names are not), and MUST NOT contain logs of user application traffic.
2005// TODO(b/148168577) rename this and other related fields/methods to "connectivity" instead.
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08002006static void DumpstateTelephonyOnly(const std::string& calling_package) {
mukesh agrawal253dad42018-01-23 21:59:59 -08002007 DurationReporter duration_reporter("DUMPSTATE");
Jichao Lie89d9c12019-11-21 19:02:51 -08002008
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002009 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08002010
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002011 const bool include_sensitive_info = !PropertiesHelper::IsUserBuild();
Jayachandran Ca94c7172017-06-10 15:08:12 -07002012
Rhed Jaob5685b32020-08-14 17:19:17 +08002013 DumpstateRadioAsRoot();
2014 if (!DropRootUser()) {
2015 return;
2016 }
2017
2018 // Starts thread pool after the root user is dropped, and two additional threads
2019 // are created for DumpHals in the DumpstateRadioCommon and DumpstateBoard.
Chris Morinbc223142022-02-04 14:17:11 -08002020 std::future<std::string> dump_board;
Rhed Jaob5685b32020-08-14 17:19:17 +08002021 if (ds.dump_pool_) {
2022 ds.dump_pool_->start(/*thread_counts =*/2);
2023
2024 // DumpstateBoard takes long time, post it to the another thread in the pool,
2025 // if pool is available.
Chris Morinbc223142022-02-04 14:17:11 -08002026 dump_board = ds.dump_pool_->enqueueTaskWithFd(
2027 DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
Rhed Jaob5685b32020-08-14 17:19:17 +08002028 }
2029
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002030 DumpstateRadioCommon(include_sensitive_info);
2031
2032 if (include_sensitive_info) {
2033 // Contains too much unrelated PII, and given the unstructured nature of sysprops, we can't
2034 // really cherrypick all of the connectivity-related ones. Apps generally have no business
2035 // reading these anyway, and there should be APIs to supply the info in a more app-friendly
2036 // way.
2037 RunCommand("SYSTEM PROPERTIES", {"getprop"});
2038 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002039
2040 printf("========================================================\n");
2041 printf("== Android Framework Services\n");
2042 printf("========================================================\n");
2043
Vishnu Nair652cc802017-11-30 15:18:30 -08002044 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
2045 SEC_TO_MSEC(10));
Hunter Knepshield31cbae12021-05-11 16:23:24 -07002046 RunDumpsys("DUMPSYS", {"vcn_management"}, CommandOptions::WithTimeout(90).Build(),
2047 SEC_TO_MSEC(10));
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08002048 if (include_sensitive_info) {
2049 // Carrier apps' services will be dumped below in dumpsys activity service all-non-platform.
2050 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
2051 SEC_TO_MSEC(10));
2052 } else {
2053 // If the caller is a carrier app and has a carrier service, dump it here since we aren't
2054 // running dumpsys activity service all-non-platform below. Due to the increased output, we
2055 // give a higher timeout as well.
2056 RunDumpsys("DUMPSYS", {"carrier_config", "--requesting-package", calling_package},
2057 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(30));
2058 }
2059 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002060 RunDumpsys("DUMPSYS", {"netpolicy"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
2061 RunDumpsys("DUMPSYS", {"network_management"}, CommandOptions::WithTimeout(90).Build(),
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07002062 SEC_TO_MSEC(10));
Hunter Knepshield0fe51b12020-03-05 16:58:20 -08002063 RunDumpsys("DUMPSYS", {"telephony.registry"}, CommandOptions::WithTimeout(90).Build(),
2064 SEC_TO_MSEC(10));
Grant Menke56698972023-02-24 13:11:07 -08002065 RunDumpsys("DUMPSYS", {"telecom"}, CommandOptions::WithTimeout(90).Build(),
2066 SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002067 if (include_sensitive_info) {
2068 // Contains raw IP addresses, omit from reports on user builds.
2069 RunDumpsys("DUMPSYS", {"netd"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
2070 // Contains raw destination IP/MAC addresses, omit from reports on user builds.
2071 RunDumpsys("DUMPSYS", {"connmetrics"}, CommandOptions::WithTimeout(90).Build(),
2072 SEC_TO_MSEC(10));
2073 // Contains package/component names, omit from reports on user builds.
2074 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
2075 SEC_TO_MSEC(10));
2076 // Contains package names, but should be relatively simple to remove them (also contains
2077 // UIDs already), omit from reports on user builds.
2078 RunDumpsys("BATTERYSTATS", {"deviceidle"}, CommandOptions::WithTimeout(90).Build(),
2079 SEC_TO_MSEC(10));
2080 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002081
2082 printf("========================================================\n");
2083 printf("== Running Application Services\n");
2084 printf("========================================================\n");
2085
2086 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
2087
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002088 if (include_sensitive_info) {
2089 printf("========================================================\n");
2090 printf("== Running Application Services (non-platform)\n");
2091 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002092
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002093 // Contains package/component names and potential PII, omit from reports on user builds.
2094 // To get dumps of the active CarrierService(s) on user builds, we supply an argument to the
2095 // carrier_config dumpsys instead.
2096 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
2097 DUMPSYS_COMPONENTS_OPTIONS);
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002098
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002099 printf("========================================================\n");
2100 printf("== Checkins\n");
2101 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002102
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002103 // Contains package/component names, omit from reports on user builds.
2104 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
2105 }
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002106
2107 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07002108 printf("== dumpstate: done (id %d)\n", ds.id_);
2109 printf("========================================================\n");
Rhed Jaob5685b32020-08-14 17:19:17 +08002110
2111 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08002112 WaitForTask(std::move(dump_board));
Rhed Jaob5685b32020-08-14 17:19:17 +08002113 } else {
2114 RUN_SLOW_FUNCTION_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
2115 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002116}
2117
mukesh agrawal253dad42018-01-23 21:59:59 -08002118// This method collects dumpsys for wifi debugging only
2119static void DumpstateWifiOnly() {
2120 DurationReporter duration_reporter("DUMPSTATE");
2121
Rhed Jaob5685b32020-08-14 17:19:17 +08002122 DumpstateRadioAsRoot();
2123 if (!DropRootUser()) {
2124 return;
2125 }
2126
2127 // Starts thread pool after the root user is dropped. Only one additional
2128 // thread is needed for DumpHals in the DumpstateRadioCommon.
2129 if (ds.dump_pool_) {
2130 ds.dump_pool_->start(/*thread_counts =*/1);
2131 }
2132
mukesh agrawal253dad42018-01-23 21:59:59 -08002133 DumpstateRadioCommon();
2134
2135 printf("========================================================\n");
2136 printf("== Android Framework Services\n");
2137 printf("========================================================\n");
2138
2139 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
2140 SEC_TO_MSEC(10));
2141 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
2142 SEC_TO_MSEC(10));
2143
2144 printf("========================================================\n");
2145 printf("== dumpstate: done (id %d)\n", ds.id_);
2146 printf("========================================================\n");
2147}
2148
Nandana Duttcf419a72019-03-14 10:40:17 +00002149Dumpstate::RunStatus Dumpstate::DumpTraces(const char** path) {
Gavin Corkery789d7a52021-02-24 23:52:35 +00002150 const std::string temp_file_pattern = ds.bugreport_internal_dir_ + "/dumptrace_XXXXXX";
Nandana Duttfaafd522019-03-11 09:23:09 +00002151 const size_t buf_size = temp_file_pattern.length() + 1;
2152 std::unique_ptr<char[]> file_name_buf(new char[buf_size]);
2153 memcpy(file_name_buf.get(), temp_file_pattern.c_str(), buf_size);
2154
2155 // Create a new, empty file to receive all trace dumps.
2156 //
2157 // TODO: This can be simplified once we remove support for the old style
2158 // dumps. We can have a file descriptor passed in to dump_traces instead
2159 // of creating a file, closing it and then reopening it again.
2160 android::base::unique_fd fd(mkostemp(file_name_buf.get(), O_APPEND | O_CLOEXEC));
2161 if (fd < 0) {
2162 MYLOGE("mkostemp on pattern %s: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002163 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002164 }
2165
2166 // Nobody should have access to this temporary file except dumpstate, but we
2167 // temporarily grant 'read' to 'others' here because this file is created
2168 // when tombstoned is still running as root, but dumped after dropping. This
2169 // can go away once support for old style dumping has.
2170 const int chmod_ret = fchmod(fd, 0666);
2171 if (chmod_ret < 0) {
2172 MYLOGE("fchmod on %s failed: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002173 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002174 }
2175
2176 std::unique_ptr<DIR, decltype(&closedir)> proc(opendir("/proc"), closedir);
2177 if (proc.get() == nullptr) {
2178 MYLOGE("opendir /proc failed: %s\n", strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002179 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002180 }
2181
2182 // Number of times process dumping has timed out. If we encounter too many
2183 // failures, we'll give up.
2184 int timeout_failures = 0;
2185 bool dalvik_found = false;
2186
Jayant Chowdharya0a8eb22022-05-20 03:30:09 +00002187 const std::set<int> hal_pids = get_interesting_pids();
Nandana Duttfaafd522019-03-11 09:23:09 +00002188
2189 struct dirent* d;
2190 while ((d = readdir(proc.get()))) {
Nandana Duttcf419a72019-03-14 10:40:17 +00002191 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttfaafd522019-03-11 09:23:09 +00002192 int pid = atoi(d->d_name);
2193 if (pid <= 0) {
2194 continue;
2195 }
2196
2197 const std::string link_name = android::base::StringPrintf("/proc/%d/exe", pid);
2198 std::string exe;
2199 if (!android::base::Readlink(link_name, &exe)) {
2200 continue;
2201 }
2202
2203 bool is_java_process;
2204 if (exe == "/system/bin/app_process32" || exe == "/system/bin/app_process64") {
2205 // Don't bother dumping backtraces for the zygote.
2206 if (IsZygote(pid)) {
2207 continue;
2208 }
2209
2210 dalvik_found = true;
2211 is_java_process = true;
2212 } else if (should_dump_native_traces(exe.c_str()) || hal_pids.find(pid) != hal_pids.end()) {
2213 is_java_process = false;
2214 } else {
2215 // Probably a native process we don't care about, continue.
2216 continue;
2217 }
2218
2219 // If 3 backtrace dumps fail in a row, consider debuggerd dead.
2220 if (timeout_failures == 3) {
2221 dprintf(fd, "ERROR: Too many stack dump failures, exiting.\n");
2222 break;
2223 }
2224
2225 const uint64_t start = Nanotime();
2226 const int ret = dump_backtrace_to_file_timeout(
2227 pid, is_java_process ? kDebuggerdJavaBacktrace : kDebuggerdNativeBacktrace,
2228 is_java_process ? 5 : 20, fd);
2229
2230 if (ret == -1) {
2231 // For consistency, the header and footer to this message match those
2232 // dumped by debuggerd in the success case.
2233 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
2234 dprintf(fd, "Dump failed, likely due to a timeout.\n");
2235 dprintf(fd, "---- end %d ----", pid);
2236 timeout_failures++;
2237 continue;
2238 }
2239
2240 // We've successfully dumped stack traces, reset the failure count
2241 // and write a summary of the elapsed time to the file and continue with the
2242 // next process.
2243 timeout_failures = 0;
2244
2245 dprintf(fd, "[dump %s stack %d: %.3fs elapsed]\n", is_java_process ? "dalvik" : "native",
2246 pid, (float)(Nanotime() - start) / NANOS_PER_SEC);
2247 }
2248
2249 if (!dalvik_found) {
2250 MYLOGE("Warning: no Dalvik processes found to dump stacks\n");
2251 }
2252
Nandana Duttcf419a72019-03-14 10:40:17 +00002253 *path = file_name_buf.release();
2254 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002255}
2256
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002257static dumpstate_hal_hidl::DumpstateMode GetDumpstateHalModeHidl(
2258 const Dumpstate::BugreportMode bugreport_mode) {
2259 switch (bugreport_mode) {
2260 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2261 return dumpstate_hal_hidl::DumpstateMode::FULL;
2262 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2263 return dumpstate_hal_hidl::DumpstateMode::INTERACTIVE;
2264 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2265 return dumpstate_hal_hidl::DumpstateMode::REMOTE;
2266 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2267 return dumpstate_hal_hidl::DumpstateMode::WEAR;
2268 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2269 return dumpstate_hal_hidl::DumpstateMode::CONNECTIVITY;
2270 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2271 return dumpstate_hal_hidl::DumpstateMode::WIFI;
2272 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2273 return dumpstate_hal_hidl::DumpstateMode::DEFAULT;
2274 }
2275 return dumpstate_hal_hidl::DumpstateMode::DEFAULT;
2276}
2277
2278static dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode GetDumpstateHalModeAidl(
2279 const Dumpstate::BugreportMode bugreport_mode) {
2280 switch (bugreport_mode) {
2281 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2282 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::FULL;
2283 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2284 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::INTERACTIVE;
2285 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2286 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::REMOTE;
2287 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2288 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::WEAR;
2289 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2290 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::CONNECTIVITY;
2291 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2292 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::WIFI;
2293 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2294 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::DEFAULT;
2295 }
2296 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::DEFAULT;
2297}
2298
2299static void DoDumpstateBoardHidl(
2300 const sp<dumpstate_hal_hidl_1_0::IDumpstateDevice> dumpstate_hal_1_0,
2301 const std::vector<::ndk::ScopedFileDescriptor>& dumpstate_fds,
2302 const Dumpstate::BugreportMode bugreport_mode,
2303 const size_t timeout_sec) {
2304
2305 using ScopedNativeHandle =
2306 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
2307 ScopedNativeHandle handle(native_handle_create(static_cast<int>(dumpstate_fds.size()), 0),
2308 [](native_handle_t* handle) {
2309 // we don't close file handle's here
2310 // via native_handle_close(handle)
2311 // instead we let dumpstate_fds close the file handles when
2312 // dumpstate_fds gets destroyed
2313 native_handle_delete(handle);
2314 });
2315 if (handle == nullptr) {
2316 MYLOGE("Could not create native_handle for dumpstate HAL\n");
2317 return;
2318 }
2319
2320 for (size_t i = 0; i < dumpstate_fds.size(); i++) {
2321 handle.get()->data[i] = dumpstate_fds[i].get();
2322 }
2323
2324 // Prefer version 1.1 if available. New devices launching with R are no longer allowed to
2325 // implement just 1.0.
2326 const char* descriptor_to_kill;
2327 using DumpstateBoardTask = std::packaged_task<bool()>;
2328 DumpstateBoardTask dumpstate_board_task;
2329 sp<dumpstate_hal_hidl::IDumpstateDevice> dumpstate_hal(
2330 dumpstate_hal_hidl::IDumpstateDevice::castFrom(dumpstate_hal_1_0));
2331 if (dumpstate_hal != nullptr) {
2332 MYLOGI("Using IDumpstateDevice v1.1 HIDL HAL");
2333
2334 dumpstate_hal_hidl::DumpstateMode dumpstate_hal_mode =
2335 GetDumpstateHalModeHidl(bugreport_mode);
2336
2337 descriptor_to_kill = dumpstate_hal_hidl::IDumpstateDevice::descriptor;
2338 dumpstate_board_task =
2339 DumpstateBoardTask([timeout_sec, dumpstate_hal_mode, dumpstate_hal, &handle]() -> bool {
2340 ::android::hardware::Return<dumpstate_hal_hidl::DumpstateStatus> status =
2341 dumpstate_hal->dumpstateBoard_1_1(handle.get(), dumpstate_hal_mode,
2342 SEC_TO_MSEC(timeout_sec));
2343 if (!status.isOk()) {
2344 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2345 return false;
2346 } else if (status != dumpstate_hal_hidl::DumpstateStatus::OK) {
2347 MYLOGE("dumpstateBoard failed with DumpstateStatus::%s\n",
2348 dumpstate_hal_hidl::toString(status).c_str());
2349 return false;
2350 }
2351 return true;
2352 });
2353 } else {
2354 MYLOGI("Using IDumpstateDevice v1.0 HIDL HAL");
2355
2356 descriptor_to_kill = dumpstate_hal_hidl_1_0::IDumpstateDevice::descriptor;
2357 dumpstate_board_task = DumpstateBoardTask([dumpstate_hal_1_0, &handle]() -> bool {
2358 ::android::hardware::Return<void> status =
2359 dumpstate_hal_1_0->dumpstateBoard(handle.get());
2360 if (!status.isOk()) {
2361 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2362 return false;
2363 }
2364 return true;
2365 });
2366 }
2367 auto result = dumpstate_board_task.get_future();
2368 std::thread(std::move(dumpstate_board_task)).detach();
2369
2370 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2371 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate HAL\n", timeout_sec);
2372 if (!android::base::SetProperty(
2373 "ctl.interface_restart",
2374 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
2375 MYLOGE("Couldn't restart dumpstate HAL\n");
2376 }
2377 }
2378 // Wait some time for init to kill dumpstate vendor HAL
2379 constexpr size_t killing_timeout_sec = 10;
2380 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2381 MYLOGE(
2382 "killing dumpstateBoard timed out after %zus, continue and "
2383 "there might be racing in content\n",
2384 killing_timeout_sec);
2385 }
2386}
2387
2388static void DoDumpstateBoardAidl(
2389 const std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> dumpstate_hal,
2390 const std::vector<::ndk::ScopedFileDescriptor>& dumpstate_fds,
2391 const Dumpstate::BugreportMode bugreport_mode, const size_t timeout_sec) {
2392 MYLOGI("Using IDumpstateDevice AIDL HAL");
2393
2394 const char* descriptor_to_kill;
2395 using DumpstateBoardTask = std::packaged_task<bool()>;
2396 DumpstateBoardTask dumpstate_board_task;
2397 dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode dumpstate_hal_mode =
2398 GetDumpstateHalModeAidl(bugreport_mode);
2399
2400 descriptor_to_kill = dumpstate_hal_aidl::IDumpstateDevice::descriptor;
2401 dumpstate_board_task = DumpstateBoardTask([dumpstate_hal, &dumpstate_fds, dumpstate_hal_mode,
2402 timeout_sec]() -> bool {
2403 auto status = dumpstate_hal->dumpstateBoard(dumpstate_fds, dumpstate_hal_mode, timeout_sec);
2404
2405 if (!status.isOk()) {
2406 MYLOGE("dumpstateBoard failed: %s\n", status.getDescription().c_str());
2407 return false;
2408 }
2409 return true;
2410 });
2411 auto result = dumpstate_board_task.get_future();
2412 std::thread(std::move(dumpstate_board_task)).detach();
2413
2414 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2415 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate HAL\n", timeout_sec);
2416 if (!android::base::SetProperty(
2417 "ctl.interface_restart",
2418 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
2419 MYLOGE("Couldn't restart dumpstate HAL\n");
2420 }
2421 }
2422 // Wait some time for init to kill dumpstate vendor HAL
2423 constexpr size_t killing_timeout_sec = 10;
2424 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2425 MYLOGE(
2426 "killing dumpstateBoard timed out after %zus, continue and "
2427 "there might be racing in content\n",
2428 killing_timeout_sec);
2429 }
2430}
2431
2432static std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> GetDumpstateBoardAidlService() {
2433 const std::string aidl_instance_name =
2434 std::string(dumpstate_hal_aidl::IDumpstateDevice::descriptor) + "/default";
2435
2436 if (!AServiceManager_isDeclared(aidl_instance_name.c_str())) {
2437 return nullptr;
2438 }
2439
2440 ndk::SpAIBinder dumpstateBinder(AServiceManager_waitForService(aidl_instance_name.c_str()));
2441
2442 return dumpstate_hal_aidl::IDumpstateDevice::fromBinder(dumpstateBinder);
2443}
2444
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002445void Dumpstate::DumpstateBoard(int out_fd) {
2446 dprintf(out_fd, "========================================================\n");
2447 dprintf(out_fd, "== Board\n");
2448 dprintf(out_fd, "========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08002449
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002450 /*
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002451 * mount debugfs for non-user builds with ro.product.debugfs_restrictions.enabled
Hridya Valsaraju51101602021-04-02 14:32:46 -07002452 * set to true and unmount it after invoking dumpstateBoard_* methods.
2453 * This is to enable debug builds to not have debugfs mounted during runtime.
2454 * It will also ensure that debugfs is only accessed by the dumpstate HAL.
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002455 */
Hridya Valsaraju51101602021-04-02 14:32:46 -07002456 auto mount_debugfs =
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002457 android::base::GetBoolProperty("ro.product.debugfs_restrictions.enabled", false);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002458 if (mount_debugfs) {
2459 RunCommand("mount debugfs", {"mount", "-t", "debugfs", "debugfs", "/sys/kernel/debug"},
2460 AS_ROOT_20);
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002461 RunCommand("chmod debugfs", {"chmod", "0755", "/sys/kernel/debug"}, AS_ROOT_20);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002462 }
2463
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002464 std::vector<std::string> paths;
2465 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07002466 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002467 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
2468 kDumpstateBoardFiles[i].c_str()));
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002469 remover.emplace_back(android::base::make_scope_guard(
2470 std::bind([](std::string path) { android::os::UnlinkAndLogOnError(path); }, paths[i])));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002471 }
Jie Song9fbfad02017-06-20 16:29:42 -07002472
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002473 // get dumpstate HAL AIDL implementation
2474 std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> dumpstate_hal_handle_aidl(
2475 GetDumpstateBoardAidlService());
2476 if (dumpstate_hal_handle_aidl == nullptr) {
2477 MYLOGI("No IDumpstateDevice AIDL implementation\n");
2478 }
2479
2480 // get dumpstate HAL HIDL implementation, only if AIDL HAL implementation not found
2481 sp<dumpstate_hal_hidl_1_0::IDumpstateDevice> dumpstate_hal_handle_hidl_1_0 = nullptr;
2482 if (dumpstate_hal_handle_aidl == nullptr) {
2483 dumpstate_hal_handle_hidl_1_0 = dumpstate_hal_hidl_1_0::IDumpstateDevice::getService();
2484 if (dumpstate_hal_handle_hidl_1_0 == nullptr) {
2485 MYLOGI("No IDumpstateDevice HIDL implementation\n");
2486 }
2487 }
2488
2489 // if neither HIDL nor AIDL implementation found, then return
2490 if (dumpstate_hal_handle_hidl_1_0 == nullptr && dumpstate_hal_handle_aidl == nullptr) {
2491 MYLOGE("Could not find IDumpstateDevice implementation\n");
Wei Wang587eac92018-04-05 12:17:20 -07002492 return;
2493 }
2494
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002495 // this is used to hold the file descriptors and when this variable goes out of scope
2496 // the file descriptors are closed
2497 std::vector<::ndk::ScopedFileDescriptor> dumpstate_fds;
Wei Wang587eac92018-04-05 12:17:20 -07002498
Nandana Dutt5c390032019-03-12 10:52:56 +00002499 // TODO(128270426): Check for consent in between?
Wei Wang587eac92018-04-05 12:17:20 -07002500 for (size_t i = 0; i < paths.size(); i++) {
2501 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
2502
2503 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
2504 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
2505 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
2506 if (fd < 0) {
2507 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
2508 return;
2509 }
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002510
2511 dumpstate_fds.emplace_back(fd.release());
2512 // we call fd.release() here to make sure "fd" does not get closed
2513 // after "fd" goes out of scope after this block.
2514 // "fd" will be closed when "dumpstate_fds" goes out of scope
2515 // i.e. when we exit this function
Wei Wang587eac92018-04-05 12:17:20 -07002516 }
2517
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002518 // Given that bugreport is required to diagnose failures, it's better to set an arbitrary amount
2519 // of timeout for IDumpstateDevice than to block the rest of bugreport. In the timeout case, we
2520 // will kill the HAL and grab whatever it dumped in time.
Michael Eastwood8523ea02022-03-10 16:33:08 -08002521 constexpr size_t timeout_sec = 45;
Wei Wang587eac92018-04-05 12:17:20 -07002522
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002523 if (dumpstate_hal_handle_aidl != nullptr) {
2524 DoDumpstateBoardAidl(dumpstate_hal_handle_aidl, dumpstate_fds, options_->bugreport_mode,
2525 timeout_sec);
2526 } else if (dumpstate_hal_handle_hidl_1_0 != nullptr) {
2527 // run HIDL HAL only if AIDL HAL not found
2528 DoDumpstateBoardHidl(dumpstate_hal_handle_hidl_1_0, dumpstate_fds, options_->bugreport_mode,
2529 timeout_sec);
Wei Wang587eac92018-04-05 12:17:20 -07002530 }
2531
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002532 if (mount_debugfs) {
Hridya Valsaraju51101602021-04-02 14:32:46 -07002533 auto keep_debugfs_mounted =
2534 android::base::GetProperty("persist.dbg.keep_debugfs_mounted", "");
2535 if (keep_debugfs_mounted.empty())
2536 RunCommand("unmount debugfs", {"umount", "/sys/kernel/debug"}, AS_ROOT_20);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002537 }
2538
Wei Wang587eac92018-04-05 12:17:20 -07002539 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
2540 for (size_t i = 0; i < paths.size(); i++) {
2541 struct stat s;
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002542 if (fstat(dumpstate_fds[i].get(), &s) == -1) {
2543 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(), strerror(errno));
Wei Wang587eac92018-04-05 12:17:20 -07002544 file_sizes[i] = -1;
2545 continue;
2546 }
2547 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002548 }
2549
2550 for (size_t i = 0; i < paths.size(); i++) {
2551 if (file_sizes[i] == -1) {
2552 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002553 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002554 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07002555 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002556 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002557 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002558 remover[i].Disable();
2559 EnqueueAddZipEntryAndCleanupIfNeeded(kDumpstateBoardFiles[i], paths[i]);
2560 dprintf(out_fd, "*** See %s entry ***\n", kDumpstateBoardFiles[i].c_str());
Jie Song9fbfad02017-06-20 16:29:42 -07002561 }
Felipe Leme6f674ae2016-11-18 17:10:33 -08002562}
2563
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002564static void ShowUsage() {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002565 fprintf(stderr,
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002566 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-o directory] [-p] "
2567 "[-s] [-S] [-q] [-P] [-R] [-L] [-V version]\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002568 " -h: display this help message\n"
2569 " -b: play sound file instead of vibrate, at beginning of job\n"
2570 " -e: play sound file instead of vibrate, at end of job\n"
mhasank2d75c442020-06-11 15:05:25 -07002571 " -o: write to custom directory (only in limited mode)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01002572 " -p: capture screenshot to filename.png\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002573 " -s: write zipped file to control socket (for init)\n"
2574 " -S: write file location to control socket (for init)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002575 " -q: disable vibrate\n"
Abhijeet Kaure370d682019-10-01 16:49:30 +01002576 " -P: send broadcast when started and do progress updates\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002577 " -R: take bugreport in remote mode (shouldn't be used with -P)\n"
Nandana Dutt235864b2019-01-22 12:10:16 +00002578 " -w: start binder service and make it wait for a call to startBugreport\n"
mhasankd451a472020-05-26 18:02:39 -07002579 " -L: output limited information that is safe for submission in feedback reports\n"
Felipe Lemed071c682016-10-20 16:48:00 -07002580 " -v: prints the dumpstate header and exit\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002581}
2582
Wei Liuf87959e2016-08-26 14:51:42 -07002583static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07002584 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07002585}
2586
Felipe Leme1d486fe2016-10-14 18:06:47 -07002587bool Dumpstate::FinishZipFile() {
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002588 // Runs all enqueued adding zip entry and cleanup tasks before finishing the zip file.
2589 if (zip_entry_tasks_) {
2590 zip_entry_tasks_->run(/* do_cancel = */false);
2591 }
2592
Felipe Leme9a523ae2016-10-20 15:10:33 -07002593 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07002594 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07002595 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002596 // Final timestamp
2597 char date[80];
2598 time_t the_real_now_please_stand_up = time(nullptr);
2599 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002600 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07002601 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002602
Felipe Leme9a523ae2016-10-20 15:10:33 -07002603 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002604 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08002605 return false;
2606 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07002607 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002608 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08002609 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08002610 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08002611
Felipe Leme0f3fb202016-06-10 17:10:53 -07002612 // Add log file (which contains stderr output) to zip...
2613 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07002614 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07002615 MYLOGE("Failed to add dumpstate log to .zip file\n");
2616 return false;
2617 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002618 // TODO: Should truncate the existing file.
2619 // ... and re-open it for further logging.
Nandana Dutta344cb62019-02-22 15:12:35 +00002620 if (!redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()))) {
2621 return false;
2622 }
Felipe Leme0f3fb202016-06-10 17:10:53 -07002623 fprintf(stderr, "\n");
2624
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002625 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07002626 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002627 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002628 return false;
2629 }
2630
Felipe Leme1d486fe2016-10-14 18:06:47 -07002631 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
2632 ds.zip_file.reset(nullptr);
2633
Felipe Lemee9d2c542016-11-15 11:48:26 -08002634 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002635 android::os::UnlinkAndLogOnError(tmp_path_);
Felipe Lemec4eee562016-04-21 15:42:55 -07002636
Felipe Leme1e9edc62015-12-21 16:02:13 -08002637 return true;
2638}
Felipe Leme6e01fa62015-11-11 19:35:14 -08002639
Nikhil Kumar28ce35e2023-01-10 14:32:44 +00002640static void SendBroadcast(const std::string& action,
2641 const std::vector<std::string>& args,
2642 int32_t user_id) {
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002643 // clang-format off
Nikhil Kumar28ce35e2023-01-10 14:32:44 +00002644 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user",
2645 std::to_string(user_id), "--receiver-foreground",
2646 "--receiver-include-background", "-a", action};
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002647 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08002648
2649 am.insert(am.end(), args.begin(), args.end());
2650
Felipe Leme8d2410e2017-02-08 09:46:08 -08002651 RunCommand("", am,
2652 CommandOptions::WithTimeout(20)
2653 .Log("Sending broadcast: '%s'\n")
2654 .Always()
2655 .DropRoot()
2656 .RedirectStderr()
2657 .Build());
2658}
2659
Felipe Leme35b8cf12017-02-10 15:47:29 -08002660static void Vibrate(int duration_ms) {
2661 // clang-format off
Lais Andrade51156962021-02-22 19:21:35 +00002662 std::vector<std::string> args = {"cmd", "vibrator_manager", "synced", "-f", "-d", "dumpstate",
2663 "oneshot", std::to_string(duration_ms)};
2664 RunCommand("", args,
Felipe Leme35b8cf12017-02-10 15:47:29 -08002665 CommandOptions::WithTimeout(10)
2666 .Log("Vibrate: '%s'\n")
2667 .Always()
2668 .Build());
2669 // clang-format on
2670}
2671
Nandana Dutt979388e2018-11-30 16:48:55 +00002672static void MaybeResolveSymlink(std::string* path) {
2673 std::string resolved_path;
2674 if (android::base::Readlink(*path, &resolved_path)) {
2675 *path = resolved_path;
2676 }
2677}
2678
Nandana Dutt4be45d12018-09-26 15:04:23 +01002679/*
2680 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002681 * and adds the version file. Return false if zip_file could not be open to write.
Nandana Dutt4be45d12018-09-26 15:04:23 +01002682 */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002683static bool PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002684 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
2685
Nandana Dutt4be45d12018-09-26 15:04:23 +01002686 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
2687 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002688 ds.base_name_ = StringPrintf("bugreport-%s-%s", device_name.c_str(), build_id.c_str());
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002689 char date[80];
2690 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
2691 ds.name_ = date;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002692
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002693 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002694 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002695 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002696 ds.base_name_ += "-wifi";
2697 }
2698
Paul Chang0d2aad72020-02-13 20:04:03 +08002699 if (ds.options_->do_screenshot) {
Nandana Dutt9d17b942020-03-26 10:02:59 +00002700 ds.screenshot_path_ = ds.GetPath(ds.CalledByApi() ? "-png.tmp" : ".png");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002701 }
2702 ds.tmp_path_ = ds.GetPath(".tmp");
2703 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
2704
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002705 std::string destination = ds.CalledByApi()
Nandana Dutt54dbd672019-01-11 12:58:05 +00002706 ? StringPrintf("[fd:%d]", ds.options_->bugreport_fd.get())
Nandana Dutt9a76d202019-01-21 15:56:48 +00002707 : ds.bugreport_internal_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01002708 MYLOGD(
Nandana Dutt235c6672019-11-14 15:22:32 +00002709 "Bugreport dir: [%s] "
2710 "Base name: [%s] "
2711 "Suffix: [%s] "
2712 "Log path: [%s] "
2713 "Temporary path: [%s] "
2714 "Screenshot path: [%s]\n",
Nandana Dutt9a76d202019-01-21 15:56:48 +00002715 destination.c_str(), ds.base_name_.c_str(), ds.name_.c_str(), ds.log_path_.c_str(),
2716 ds.tmp_path_.c_str(), ds.screenshot_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002717
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002718 ds.path_ = ds.GetPath(ds.CalledByApi() ? "-zip.tmp" : ".zip");
2719 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
2720 create_parent_dirs(ds.path_.c_str());
2721 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
2722 if (ds.zip_file == nullptr) {
2723 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
2724 return false;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002725 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002726 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
2727 ds.AddTextZipEntry("version.txt", ds.version_);
2728 return true;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002729}
2730
2731/*
Abhijeet Kaure370d682019-10-01 16:49:30 +01002732 * Finalizes writing to the file by zipping the tmp file to the final location,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002733 * printing zipped file status, etc.
2734 */
2735static void FinalizeFile() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002736 bool do_text_file = !ds.FinishZipFile();
2737 if (do_text_file) {
2738 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002739 }
mhasank2d75c442020-06-11 15:05:25 -07002740
2741 std::string final_path = ds.path_;
2742 if (ds.options_->OutputToCustomFile()) {
mhasank3a4cfb42020-06-15 18:06:43 -07002743 final_path = ds.GetPath(ds.options_->out_dir, ".zip");
mhasank2d75c442020-06-11 15:05:25 -07002744 android::os::CopyFileToFile(ds.path_, final_path);
2745 }
2746
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002747 if (ds.options_->stream_to_socket) {
2748 android::os::CopyFileToFd(ds.path_, ds.control_socket_fd_);
2749 } else if (ds.options_->progress_updates_to_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002750 if (do_text_file) {
2751 dprintf(ds.control_socket_fd_,
2752 "FAIL:could not create zip file, check %s "
2753 "for more details\n",
2754 ds.log_path_.c_str());
2755 } else {
mhasank2d75c442020-06-11 15:05:25 -07002756 dprintf(ds.control_socket_fd_, "OK:%s\n", final_path.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002757 }
2758 }
2759}
2760
Nandana Dutt4be45d12018-09-26 15:04:23 +01002761
Nandana Dutt58d72e22018-11-16 10:30:48 +00002762static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2763 switch (mode) {
2764 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2765 return "BUGREPORT_FULL";
2766 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2767 return "BUGREPORT_INTERACTIVE";
2768 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2769 return "BUGREPORT_REMOTE";
2770 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2771 return "BUGREPORT_WEAR";
2772 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2773 return "BUGREPORT_TELEPHONY";
2774 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2775 return "BUGREPORT_WIFI";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002776 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2777 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002778 }
2779}
2780
Steven Leeb573eb82022-11-29 22:31:35 +08002781static bool IsConsentlessBugreportAllowed(const Dumpstate::DumpOptions& options) {
2782 // only BUGREPORT_TELEPHONY does not allow using consentless bugreport
2783 return !options.telephony_only;
2784}
2785
Paul Changf59c2b72020-03-10 02:08:55 +08002786static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options,
2787 bool is_screenshot_requested) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002788 // Modify com.android.shell.BugreportProgressService#isDefaultScreenshotRequired as well for
2789 // default system screenshots.
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002790 options->bugreport_mode = mode;
2791 options->bugreport_mode_string = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002792 switch (mode) {
2793 case Dumpstate::BugreportMode::BUGREPORT_FULL:
Paul Changf59c2b72020-03-10 02:08:55 +08002794 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002795 break;
2796 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002797 // Currently, the dumpstate binder is only used by Shell to update progress.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002798 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002799 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002800 break;
2801 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002802 options->do_vibrate = false;
2803 options->is_remote_mode = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002804 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002805 break;
2806 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002807 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002808 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002809 break;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002810 // TODO(b/148168577) rename TELEPHONY everywhere to CONNECTIVITY.
Nandana Dutt58d72e22018-11-16 10:30:48 +00002811 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002812 options->telephony_only = true;
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002813 options->do_progress_updates = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002814 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002815 break;
2816 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002817 options->wifi_only = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002818 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002819 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002820 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2821 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002822 }
2823}
2824
Nandana Dutt58d72e22018-11-16 10:30:48 +00002825static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
Nandana Dutt235c6672019-11-14 15:22:32 +00002826 MYLOGI(
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002827 "do_vibrate: %d stream_to_socket: %d progress_updates_to_socket: %d do_screenshot: %d "
Rhed Jao25f50e02020-08-20 00:10:32 +08002828 "is_remote_mode: %d show_header_only: %d telephony_only: %d "
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002829 "wifi_only: %d do_progress_updates: %d fd: %d bugreport_mode: %s "
mhasankd451a472020-05-26 18:02:39 -07002830 "limited_only: %d args: %s\n",
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002831 options.do_vibrate, options.stream_to_socket, options.progress_updates_to_socket,
Paul Chang0d2aad72020-02-13 20:04:03 +08002832 options.do_screenshot, options.is_remote_mode, options.show_header_only,
Rhed Jao25f50e02020-08-20 00:10:32 +08002833 options.telephony_only, options.wifi_only,
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002834 options.do_progress_updates, options.bugreport_fd.get(),
2835 options.bugreport_mode_string.c_str(),
2836 options.limited_only, options.args.c_str());
Nandana Dutt58d72e22018-11-16 10:30:48 +00002837}
2838
Nandana Dutt54dbd672019-01-11 12:58:05 +00002839void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode,
Kean Mariotti306633e2022-09-05 16:30:47 +00002840 int bugreport_flags,
Nandana Dutt54dbd672019-01-11 12:58:05 +00002841 const android::base::unique_fd& bugreport_fd_in,
Paul Changf59c2b72020-03-10 02:08:55 +08002842 const android::base::unique_fd& screenshot_fd_in,
2843 bool is_screenshot_requested) {
Kean Mariotti306633e2022-09-05 16:30:47 +00002844 this->use_predumped_ui_data = bugreport_flags & BugreportFlag::BUGREPORT_USE_PREDUMPED_UI_DATA;
Gavin Corkerya44686c2022-11-23 18:16:51 +00002845 this->is_consent_deferred = bugreport_flags & BugreportFlag::BUGREPORT_FLAG_DEFER_CONSENT;
Nandana Dutt54dbd672019-01-11 12:58:05 +00002846 // Duplicate the fds because the passed in fds don't outlive the binder transaction.
Todd Frederick621533f2022-03-26 02:54:17 +00002847 bugreport_fd.reset(fcntl(bugreport_fd_in.get(), F_DUPFD_CLOEXEC, 0));
2848 screenshot_fd.reset(fcntl(screenshot_fd_in.get(), F_DUPFD_CLOEXEC, 0));
Nandana Dutt58d72e22018-11-16 10:30:48 +00002849
Paul Changf59c2b72020-03-10 02:08:55 +08002850 SetOptionsFromMode(bugreport_mode, this, is_screenshot_requested);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002851}
2852
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002853Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
2854 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002855 int c;
mhasankd451a472020-05-26 18:02:39 -07002856 while ((c = getopt(argc, argv, "dho:svqzpLPBRSV:w")) != -1) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002857 switch (c) {
2858 // clang-format off
mhasank3a4cfb42020-06-15 18:06:43 -07002859 case 'o': out_dir = optarg; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002860 case 's': stream_to_socket = true; break;
2861 case 'S': progress_updates_to_socket = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002862 case 'v': show_header_only = true; break;
2863 case 'q': do_vibrate = false; break;
Paul Chang0d2aad72020-02-13 20:04:03 +08002864 case 'p': do_screenshot = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002865 case 'P': do_progress_updates = true; break;
2866 case 'R': is_remote_mode = true; break;
mhasankd451a472020-05-26 18:02:39 -07002867 case 'L': limited_only = true; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002868 case 'V':
2869 case 'd':
2870 case 'z':
2871 // compatibility no-op
2872 break;
Nandana Dutt235864b2019-01-22 12:10:16 +00002873 case 'w':
2874 // This was already processed
2875 break;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002876 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002877 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002878 break;
2879 default:
2880 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002881 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002882 break;
2883 // clang-format on
2884 }
2885 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08002886
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002887 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002888 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002889 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002890 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002891 }
2892 }
2893
2894 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
2895 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002896
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002897 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002898}
2899
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002900bool Dumpstate::DumpOptions::ValidateOptions() const {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002901 if (bugreport_fd.get() != -1 && stream_to_socket) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002902 return false;
2903 }
2904
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002905 if ((progress_updates_to_socket || do_progress_updates) && stream_to_socket) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002906 return false;
2907 }
2908
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002909 if (is_remote_mode && (do_progress_updates || stream_to_socket)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002910 return false;
2911 }
2912 return true;
2913}
2914
Nandana Dutt197661d2018-11-16 16:40:21 +00002915void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
2916 options_ = std::move(options);
2917}
2918
Abhijeet Kaura407fb82020-03-27 12:51:12 +00002919void Dumpstate::Initialize() {
2920 /* gets the sequential id */
2921 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
2922 id_ = ++last_id;
2923 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
2924}
2925
Nandana Duttd2f5f082019-01-18 17:13:52 +00002926Dumpstate::RunStatus Dumpstate::Run(int32_t calling_uid, const std::string& calling_package) {
2927 Dumpstate::RunStatus status = RunInternal(calling_uid, calling_package);
Gavin Corkerya44686c2022-11-23 18:16:51 +00002928 HandleRunStatus(status);
2929 return status;
2930}
2931
2932Dumpstate::RunStatus Dumpstate::Retrieve(int32_t calling_uid, const std::string& calling_package) {
2933 Dumpstate::RunStatus status = RetrieveInternal(calling_uid, calling_package);
2934 HandleRunStatus(status);
2935 return status;
2936}
2937
2938Dumpstate::RunStatus Dumpstate::RetrieveInternal(int32_t calling_uid,
2939 const std::string& calling_package) {
2940 consent_callback_ = new ConsentCallback();
2941 const String16 incidentcompanion("incidentcompanion");
2942 sp<android::IBinder> ics(
2943 defaultServiceManager()->checkService(incidentcompanion));
2944 android::String16 package(calling_package.c_str());
2945 if (ics != nullptr) {
2946 MYLOGD("Checking user consent via incidentcompanion service\n");
2947 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
2948 calling_uid, package, String16(), String16(),
2949 0x1 /* FLAG_CONFIRMATION_DIALOG */, consent_callback_.get());
2950 } else {
2951 MYLOGD(
2952 "Unable to check user consent; incidentcompanion service unavailable\n");
2953 return RunStatus::USER_CONSENT_TIMED_OUT;
2954 }
2955 UserConsentResult consent_result = consent_callback_->getResult();
2956 int timeout_ms = 30 * 1000;
2957 while (consent_result == UserConsentResult::UNAVAILABLE &&
2958 consent_callback_->getElapsedTimeMs() < timeout_ms) {
2959 sleep(1);
2960 consent_result = consent_callback_->getResult();
2961 }
2962 if (consent_result == UserConsentResult::DENIED) {
2963 return RunStatus::USER_CONSENT_DENIED;
2964 }
2965 if (consent_result == UserConsentResult::UNAVAILABLE) {
2966 MYLOGD("Canceling user consent request via incidentcompanion service\n");
2967 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
2968 consent_callback_.get());
2969 return RunStatus::USER_CONSENT_TIMED_OUT;
2970 }
2971
2972 bool copy_succeeded =
2973 android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
2974 if (copy_succeeded) {
2975 android::os::UnlinkAndLogOnError(path_);
2976 }
2977 return copy_succeeded ? Dumpstate::RunStatus::OK
2978 : Dumpstate::RunStatus::ERROR;
2979}
2980
2981void Dumpstate::HandleRunStatus(Dumpstate::RunStatus status) {
2982 if (listener_ != nullptr) {
Nandana Duttbabf6c72019-01-15 14:11:12 +00002983 switch (status) {
2984 case Dumpstate::RunStatus::OK:
Gavin Corkerya44686c2022-11-23 18:16:51 +00002985 listener_->onFinished(path_.c_str());
Nandana Duttbabf6c72019-01-15 14:11:12 +00002986 break;
2987 case Dumpstate::RunStatus::HELP:
2988 break;
2989 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002990 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_INVALID_INPUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002991 break;
2992 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002993 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_RUNTIME_ERROR);
2994 break;
2995 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2996 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_DENIED_CONSENT);
2997 break;
2998 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
2999 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_CONSENT_TIMED_OUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00003000 break;
3001 }
3002 }
Nandana Duttbabf6c72019-01-15 14:11:12 +00003003}
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003004void Dumpstate::Cancel() {
3005 CleanupTmpFiles();
3006 android::os::UnlinkAndLogOnError(log_path_);
3007 for (int i = 0; i < NUM_OF_DUMPS; i++) {
3008 android::os::UnlinkAndLogOnError(ds.bugreport_internal_dir_ + "/" +
3009 kDumpstateBoardFiles[i]);
3010 }
3011 tombstone_data_.clear();
3012 anr_data_.clear();
Woody Lin20767a92022-11-29 15:50:24 +08003013 shutdown_checkpoints_.clear();
Rhed Jao0daac912020-08-21 14:48:20 +08003014
3015 // Instead of shutdown the pool, we delete temporary files directly since
3016 // shutdown blocking the call.
3017 if (dump_pool_) {
3018 dump_pool_->deleteTempFiles();
3019 }
3020 if (zip_entry_tasks_) {
3021 zip_entry_tasks_->run(/*do_cancel =*/ true);
3022 }
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003023}
3024
Kean Mariotti306633e2022-09-05 16:30:47 +00003025void Dumpstate::PreDumpUiData() {
3026 MaybeSnapshotUiTraces();
3027}
3028
Nandana Dutt979388e2018-11-30 16:48:55 +00003029/*
3030 * Dumps relevant information to a bugreport based on the given options.
3031 *
3032 * The bugreport can be dumped to a file or streamed to a socket.
3033 *
3034 * How dumping to file works:
3035 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
3036 * stderr is redirected a log file.
3037 *
3038 * The temporary bugreport is then populated via printfs, dumping contents of files and
3039 * output of commands to stdout.
3040 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003041 * A bunch of other files and dumps are added to the zip archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00003042 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003043 * The temporary bugreport file and the log file also get added to the archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00003044 *
mhasank2d75c442020-06-11 15:05:25 -07003045 * Bugreports are first generated in a local directory and later copied to the caller's fd
3046 * or directory if supplied.
Nandana Dutt979388e2018-11-30 16:48:55 +00003047 */
Nandana Duttd2f5f082019-01-18 17:13:52 +00003048Dumpstate::RunStatus Dumpstate::RunInternal(int32_t calling_uid,
3049 const std::string& calling_package) {
Rhed Jao5377d792020-07-16 17:37:39 +08003050 DurationReporter duration_reporter("RUN INTERNAL", /* logcat_only = */true);
Nandana Dutt979388e2018-11-30 16:48:55 +00003051 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00003052 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00003053 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003054 return RunStatus::INVALID_INPUT;
3055 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003056 /* set as high priority, and protect from OOM killer */
3057 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07003058
Felipe Lemed071c682016-10-20 16:48:00 -07003059 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07003060 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07003061 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07003062 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07003063 } else {
3064 /* fallback to kernels <= 2.6.35 */
3065 oom_adj = fopen("/proc/self/oom_adj", "we");
3066 if (oom_adj) {
3067 fputs("-17", oom_adj);
3068 fclose(oom_adj);
3069 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003070 }
3071
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003072 if (version_ == VERSION_DEFAULT) {
3073 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00003074 }
3075
Chris Morin5a50d482022-02-01 17:41:18 -08003076 if (version_ != VERSION_CURRENT) {
3077 MYLOGE("invalid version requested ('%s'); supported values are: ('%s', '%s')\n",
3078 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003079 return RunStatus::INVALID_INPUT;
Felipe Lemed071c682016-10-20 16:48:00 -07003080 }
3081
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003082 if (options_->show_header_only) {
3083 PrintHeader();
3084 return RunStatus::OK;
Felipe Lemed071c682016-10-20 16:48:00 -07003085 }
3086
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003087 MYLOGD("dumpstate calling_uid = %d ; calling package = %s \n",
3088 calling_uid, calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003089
Felipe Leme7447d7c2016-11-03 18:12:22 -07003090 // TODO: temporarily set progress until it's part of the Dumpstate constructor
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003091 std::string stats_path =
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003092 android::base::StringPrintf("%s/dumpstate-stats.txt", bugreport_internal_dir_.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003093 progress_.reset(new Progress(stats_path));
Felipe Leme7447d7c2016-11-03 18:12:22 -07003094
Sahana Raof35ed432019-07-12 10:47:52 +01003095 if (acquire_wake_lock(PARTIAL_WAKE_LOCK, WAKE_LOCK_NAME) < 0) {
3096 MYLOGE("Failed to acquire wake lock: %s\n", strerror(errno));
3097 } else {
3098 // Wake lock will be released automatically on process death
3099 MYLOGD("Wake lock acquired.\n");
3100 }
3101
Felipe Leme6ae5c4f2017-01-10 14:13:22 -08003102 register_sig_handler();
Felipe Lemed071c682016-10-20 16:48:00 -07003103
Felipe Lemef0292972016-11-22 13:57:05 -08003104 if (PropertiesHelper::IsDryRun()) {
Felipe Lemed071c682016-10-20 16:48:00 -07003105 MYLOGI("Running on dry-run mode (to disable it, call 'setprop dumpstate.dry_run false')\n");
3106 }
3107
Nandana Dutt235c6672019-11-14 15:22:32 +00003108 MYLOGI("dumpstate info: id=%d, args='%s', bugreport_mode= %s bugreport format version: %s\n",
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00003109 id_, options_->args.c_str(), options_->bugreport_mode_string.c_str(), version_.c_str());
Felipe Leme809d74e2016-02-02 12:57:00 -08003110
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003111 do_early_screenshot_ = options_->do_progress_updates;
Felipe Lemee338bf62015-12-07 14:03:50 -08003112
Christopher Ferrised9354f2014-10-01 17:35:01 -07003113 // If we are going to use a socket, do it as early as possible
3114 // to avoid timeouts from bugreport.
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003115 if (options_->stream_to_socket || options_->progress_updates_to_socket) {
Felipe Leme2628e9e2016-04-12 16:36:51 -07003116 MYLOGD("Opening control socket\n");
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003117 control_socket_fd_ = open_socket_fn_("dumpstate");
Nandana Dutta344cb62019-02-22 15:12:35 +00003118 if (control_socket_fd_ == -1) {
3119 return ERROR;
3120 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003121 if (options_->progress_updates_to_socket) {
3122 options_->do_progress_updates = 1;
3123 }
Felipe Leme2628e9e2016-04-12 16:36:51 -07003124 }
3125
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003126 if (!PrepareToWriteToFile()) {
3127 return ERROR;
3128 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08003129
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003130 // Interactive, wear & telephony modes are default to true.
3131 // and may enable from cli option or when using control socket
3132 if (options_->do_progress_updates) {
3133 // clang-format off
3134 std::vector<std::string> am_args = {
3135 "--receiver-permission", "android.permission.DUMP",
3136 };
3137 // clang-format on
3138 // Send STARTED broadcast for apps that listen to bugreport generation events
Nikhil Kumar28ce35e2023-01-10 14:32:44 +00003139 SendBroadcast("com.android.internal.intent.action.BUGREPORT_STARTED",
3140 am_args, multiuser_get_user_id(calling_uid));
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003141 if (options_->progress_updates_to_socket) {
3142 dprintf(control_socket_fd_, "BEGIN:%s\n", path_.c_str());
Felipe Leme71bbfc52015-11-23 14:14:51 -08003143 }
3144 }
3145
Nick Kralevichf3599b32016-01-25 15:05:16 -08003146 /* read /proc/cmdline before dropping root */
3147 FILE *cmdline = fopen("/proc/cmdline", "re");
3148 if (cmdline) {
3149 fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
3150 fclose(cmdline);
3151 }
3152
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003153 if (options_->do_vibrate) {
Felipe Leme35b8cf12017-02-10 15:47:29 -08003154 Vibrate(150);
John Michelau1f794c42012-09-17 11:20:19 -05003155 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003156
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003157 if (zip_file != nullptr) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003158 if (chown(path_.c_str(), AID_SHELL, AID_SHELL)) {
3159 MYLOGE("Unable to change ownership of zip file %s: %s\n", path_.c_str(),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003160 strerror(errno));
Felipe Leme1e9edc62015-12-21 16:02:13 -08003161 }
3162 }
3163
Nandana Dutt3f8c7172018-09-25 12:01:54 +01003164 int dup_stdout_fd;
3165 int dup_stderr_fd;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003166 // Redirect stderr to log_path_ for debugging.
3167 TEMP_FAILURE_RETRY(dup_stderr_fd = dup(fileno(stderr)));
3168 if (!redirect_to_file(stderr, const_cast<char*>(log_path_.c_str()))) {
3169 return ERROR;
3170 }
3171 if (chown(log_path_.c_str(), AID_SHELL, AID_SHELL)) {
3172 MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n", log_path_.c_str(),
3173 strerror(errno));
3174 }
Nandana Dutt979388e2018-11-30 16:48:55 +00003175
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003176 // Redirect stdout to tmp_path_. This is the main bugreport entry and will be
3177 // moved into zip file later, if zipping.
3178 TEMP_FAILURE_RETRY(dup_stdout_fd = dup(fileno(stdout)));
3179 // TODO: why not write to a file instead of stdout to overcome this problem?
3180 /* TODO: rather than generating a text file now and zipping it later,
3181 it would be more efficient to redirect stdout to the zip entry
3182 directly, but the libziparchive doesn't support that option yet. */
3183 if (!redirect_to_file(stdout, const_cast<char*>(tmp_path_.c_str()))) {
3184 return ERROR;
3185 }
3186 if (chown(tmp_path_.c_str(), AID_SHELL, AID_SHELL)) {
3187 MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
3188 tmp_path_.c_str(), strerror(errno));
Colin Crossf45fa6b2012-03-26 12:38:26 -07003189 }
Felipe Lemed8b94e52016-12-08 10:21:44 -08003190
3191 // Don't buffer stdout
3192 setvbuf(stdout, nullptr, _IONBF, 0);
3193
Rhed Jao5377d792020-07-16 17:37:39 +08003194 // Enable the parallel run if the client requests to output to a file.
3195 EnableParallelRunIfNeeded();
3196 // Using scope guard to make sure the dump pool can be shut down correctly.
3197 auto scope_guard_to_shutdown_pool = android::base::make_scope_guard([=]() {
3198 ShutdownDumpPool();
3199 });
3200
Felipe Leme608385d2016-02-01 10:35:38 -08003201 // NOTE: there should be no stdout output until now, otherwise it would break the header.
3202 // In particular, DurationReport objects should be created passing 'title, NULL', so their
Felipe Lemecbce55d2016-02-08 09:53:18 -08003203 // duration is logged into MYLOG instead.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003204 PrintHeader();
Colin Crossf45fa6b2012-03-26 12:38:26 -07003205
Gavin Corkery6968f552020-11-22 18:09:05 +00003206 bool is_dumpstate_restricted = options_->telephony_only
3207 || options_->wifi_only
3208 || options_->limited_only;
3209 if (!is_dumpstate_restricted) {
Paul Chang0d2aad72020-02-13 20:04:03 +08003210 // Invoke critical dumpsys first to preserve system state, before doing anything else.
Jichao Lie89d9c12019-11-21 19:02:51 -08003211 RunDumpsysCritical();
Gavin Corkery6968f552020-11-22 18:09:05 +00003212 }
3213 MaybeTakeEarlyScreenshot();
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003214
3215 if (!is_dumpstate_restricted) {
3216 // Snapshot the system trace now (if running) to avoid that dumpstate's
3217 // own activity pushes out interesting data from the trace ring buffer.
3218 // The trace file is added to the zip by MaybeAddSystemTraceToZip().
3219 MaybeSnapshotSystemTrace();
Yohei Yukawa95305b32021-03-09 07:54:27 -08003220
Kean Mariotti306633e2022-09-05 16:30:47 +00003221 // Snapshot the UI traces now (if running).
3222 // The trace files will be added to bugreport later.
3223 MaybeSnapshotUiTraces();
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003224 }
Gavin Corkery6968f552020-11-22 18:09:05 +00003225 onUiIntensiveBugreportDumpsFinished(calling_uid);
3226 MaybeCheckUserConsent(calling_uid, calling_package);
3227 if (options_->telephony_only) {
3228 DumpstateTelephonyOnly(calling_package);
3229 } else if (options_->wifi_only) {
3230 DumpstateWifiOnly();
3231 } else if (options_->limited_only) {
3232 DumpstateLimitedOnly();
3233 } else {
Nandana Dutt4be45d12018-09-26 15:04:23 +01003234 // Dump state for the default case. This also drops root.
Jichao Lie89d9c12019-11-21 19:02:51 -08003235 RunStatus s = DumpstateDefaultAfterCritical();
Nandana Dutt5c390032019-03-12 10:52:56 +00003236 if (s != RunStatus::OK) {
Nandana Duttaac6f582019-07-26 14:32:47 +01003237 if (s == RunStatus::USER_CONSENT_DENIED) {
Nandana Dutt5c390032019-03-12 10:52:56 +00003238 HandleUserConsentDenied();
3239 }
3240 return s;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08003241 }
Zhengyin Qian068ecc72016-08-10 16:48:14 -07003242 }
Felipe Leme71a74ac2016-03-17 15:43:25 -07003243
Felipe Leme55b42a62015-11-10 17:39:08 -08003244 /* close output if needed */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003245 TEMP_FAILURE_RETRY(dup2(dup_stdout_fd, fileno(stdout)));
Colin Crossf45fa6b2012-03-26 12:38:26 -07003246
Abhijeet Kaure370d682019-10-01 16:49:30 +01003247 // Zip the (now complete) .tmp file within the internal directory.
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003248 ATRACE_BEGIN("FinalizeFile");
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003249 FinalizeFile();
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003250 ATRACE_END();
Colin Crossf45fa6b2012-03-26 12:38:26 -07003251
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003252 // Share the final file with the caller if the user has consented or Shell is the caller.
Nandana Duttd2f5f082019-01-18 17:13:52 +00003253 Dumpstate::RunStatus status = Dumpstate::RunStatus::OK;
Gavin Corkerya44686c2022-11-23 18:16:51 +00003254 if (CalledByApi() && !options_->is_consent_deferred) {
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003255 status = CopyBugreportIfUserConsented(calling_uid);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003256 if (status != Dumpstate::RunStatus::OK &&
3257 status != Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
3258 // Do an early return if there were errors. We make an exception for consent
3259 // timing out because it's possible the user got distracted. In this case the
3260 // bugreport is not shared but made available for manual retrieval.
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003261 MYLOGI("User denied consent. Returning\n");
Nandana Duttd2f5f082019-01-18 17:13:52 +00003262 return status;
3263 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003264 if (status == Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
3265 MYLOGI(
3266 "Did not receive user consent yet."
3267 " Will not copy the bugreport artifacts to caller.\n");
Abhijeet Kaur57627412019-04-17 16:00:09 +01003268 const String16 incidentcompanion("incidentcompanion");
3269 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
3270 if (ics != nullptr) {
3271 MYLOGD("Canceling user consent request via incidentcompanion service\n");
3272 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
3273 consent_callback_.get());
3274 } else {
3275 MYLOGD("Unable to cancel user consent; incidentcompanion service unavailable\n");
3276 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003277 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003278 }
3279
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08003280 /* vibrate a few but shortly times to let user know it's finished */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003281 if (options_->do_vibrate) {
Takuya Ogawa47f644e2017-12-20 18:09:09 +09003282 for (int i = 0; i < 3; i++) {
3283 Vibrate(75);
3284 usleep((75 + 50) * 1000);
3285 }
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08003286 }
3287
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003288 MYLOGD("Final progress: %d/%d (estimated %d)\n", progress_->Get(), progress_->GetMax(),
3289 progress_->GetInitialMax());
3290 progress_->Save();
3291 MYLOGI("done (id %d)\n", id_);
Colin Crossf45fa6b2012-03-26 12:38:26 -07003292
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003293 TEMP_FAILURE_RETRY(dup2(dup_stderr_fd, fileno(stderr)));
Felipe Leme107a05f2016-03-08 15:11:15 -08003294
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003295 if (control_socket_fd_ != -1) {
Felipe Lemee844a9d2016-09-21 15:01:39 -07003296 MYLOGD("Closing control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003297 close(control_socket_fd_);
Felipe Leme2628e9e2016-04-12 16:36:51 -07003298 }
3299
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003300 tombstone_data_.clear();
3301 anr_data_.clear();
Woody Lin20767a92022-11-29 15:50:24 +08003302 shutdown_checkpoints_.clear();
Narayan Kamath6b9516c2017-10-27 11:15:51 +01003303
Nandana Duttd2f5f082019-01-18 17:13:52 +00003304 return (consent_callback_ != nullptr &&
3305 consent_callback_->getResult() == UserConsentResult::UNAVAILABLE)
3306 ? USER_CONSENT_TIMED_OUT
3307 : RunStatus::OK;
3308}
3309
Paul Chang0d2aad72020-02-13 20:04:03 +08003310void Dumpstate::MaybeTakeEarlyScreenshot() {
3311 if (!options_->do_screenshot || !do_early_screenshot_) {
3312 return;
3313 }
3314
3315 TakeScreenshot();
3316}
3317
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003318void Dumpstate::MaybeSnapshotSystemTrace() {
3319 // If a background system trace is happening and is marked as "suitable for
3320 // bugreport" (i.e. bugreport_score > 0 in the trace config), this command
3321 // will stop it and serialize into SYSTEM_TRACE_SNAPSHOT. In the (likely)
3322 // case that no trace is ongoing, this command is a no-op.
3323 // Note: this should not be enqueued as we need to freeze the trace before
3324 // dumpstate starts. Otherwise the trace ring buffers will contain mostly
3325 // the dumpstate's own activity which is irrelevant.
3326 int res = RunCommand(
3327 "SERIALIZE PERFETTO TRACE",
3328 {"perfetto", "--save-for-bugreport"},
3329 CommandOptions::WithTimeout(10)
3330 .DropRoot()
3331 .CloseAllFileDescriptorsOnExec()
3332 .Build());
3333 has_system_trace_ = res == 0;
3334 // MaybeAddSystemTraceToZip() will take care of copying the trace in the zip
3335 // file in the later stages.
3336}
3337
Kean Mariotti306633e2022-09-05 16:30:47 +00003338void Dumpstate::MaybeSnapshotUiTraces() {
3339 if (PropertiesHelper::IsUserBuild() || options_->use_predumped_ui_data) {
3340 return;
3341 }
3342
Hongwei Wang39229132023-01-24 15:09:59 -08003343 // Include the proto logging from WMShell.
3344 RunCommand(
3345 // Empty name because it's not intended to be classified as a bugreport section.
3346 // Actual logging files can be found as "/data/misc/wmtrace/shell_log.winscope"
3347 // in the bugreport.
3348 "", {"dumpsys", "activity", "service", "SystemUIService",
3349 "WMShell", "protolog", "save-for-bugreport"},
3350 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3351
Yohei Yukawa02b1d2c2021-03-16 09:20:30 -07003352 // Currently WindowManagerService and InputMethodManagerSerivice support WinScope protocol.
Kean Mariotti306633e2022-09-05 16:30:47 +00003353 for (const auto& service : {"input_method", "window"}) {
Yohei Yukawa02b1d2c2021-03-16 09:20:30 -07003354 RunCommand(
3355 // Empty name because it's not intended to be classified as a bugreport section.
3356 // Actual tracing files can be found in "/data/misc/wmtrace/" in the bugreport.
3357 "", {"cmd", service, "tracing", "save-for-bugreport"},
3358 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3359 }
Kean Mariotti306633e2022-09-05 16:30:47 +00003360
3361 static const auto SURFACEFLINGER_COMMAND_SAVE_ALL_TRACES = std::vector<std::string> {
3362 "service", "call", "SurfaceFlinger", "1042"
3363 };
3364 // Empty name because it's not intended to be classified as a bugreport section.
3365 // Actual tracing files can be found in "/data/misc/wmtrace/" in the bugreport.
3366 RunCommand(
3367 "", SURFACEFLINGER_COMMAND_SAVE_ALL_TRACES,
3368 CommandOptions::WithTimeout(10).Always().AsRoot().RedirectStderr().Build());
3369}
3370
3371void Dumpstate::MaybePostProcessUiTraces() {
3372 if (PropertiesHelper::IsUserBuild()) {
3373 return;
3374 }
3375
3376 RunCommand(
3377 // Empty name because it's not intended to be classified as a bugreport section.
3378 // Actual tracing files can be found in "/data/misc/wmtrace/" in the bugreport.
3379 "", {
3380 "/system/xbin/su", "system",
3381 "/system/bin/layertracegenerator",
3382 "/data/misc/wmtrace/transactions_trace.winscope",
3383 "/data/misc/wmtrace/layers_trace_from_transactions.winscope"
3384 },
3385 CommandOptions::WithTimeout(120).Always().RedirectStderr().Build());
3386}
3387
3388void Dumpstate::MaybeAddUiTracesToZip() {
3389 if (PropertiesHelper::IsUserBuild()) {
3390 return;
3391 }
3392
3393 ds.AddDir(WMTRACE_DATA_DIR, false);
Yohei Yukawa95305b32021-03-09 07:54:27 -08003394}
3395
Paul Changeb4b4642020-05-28 22:05:47 +08003396void Dumpstate::onUiIntensiveBugreportDumpsFinished(int32_t calling_uid) {
Nikhil Kumar28ce35e2023-01-10 14:32:44 +00003397 if (multiuser_get_app_id(calling_uid) == AID_SHELL || !CalledByApi()) {
Paul Changc490e662020-04-11 18:14:09 +08003398 return;
3399 }
3400 if (listener_ != nullptr) {
3401 // Let listener know ui intensive bugreport dumps are finished, then it can do event
3402 // handling if required.
Paul Changeb4b4642020-05-28 22:05:47 +08003403 listener_->onUiIntensiveBugreportDumpsFinished();
Paul Changc490e662020-04-11 18:14:09 +08003404 }
3405}
3406
Jichao Lie89d9c12019-11-21 19:02:51 -08003407void Dumpstate::MaybeCheckUserConsent(int32_t calling_uid, const std::string& calling_package) {
Gavin Corkerya44686c2022-11-23 18:16:51 +00003408 if (multiuser_get_app_id(calling_uid) == AID_SHELL ||
3409 !CalledByApi() || options_->is_consent_deferred) {
3410 // No need to get consent for shell triggered dumpstates, or not
3411 // through bugreporting API (i.e. no fd to copy back), or when consent
3412 // is deferred.
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003413 return;
3414 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003415 consent_callback_ = new ConsentCallback();
3416 const String16 incidentcompanion("incidentcompanion");
3417 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
Jichao Lie89d9c12019-11-21 19:02:51 -08003418 android::String16 package(calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003419 if (ics != nullptr) {
3420 MYLOGD("Checking user consent via incidentcompanion service\n");
Steven Leeb573eb82022-11-29 22:31:35 +08003421 int flags = 0x1; // IncidentManager.FLAG_CONFIRMATION_DIALOG
3422 if (IsConsentlessBugreportAllowed(*options_)) {
3423 flags |= 0x2; // IncidentManager.FLAG_ALLOW_CONSENTLESS_BUGREPORT
3424 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003425 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
Steven Leeb573eb82022-11-29 22:31:35 +08003426 calling_uid, package, String16(), String16(), flags, consent_callback_.get());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003427 } else {
3428 MYLOGD("Unable to check user consent; incidentcompanion service unavailable\n");
3429 }
3430}
3431
Nandana Dutt5c390032019-03-12 10:52:56 +00003432bool Dumpstate::IsUserConsentDenied() const {
3433 return ds.consent_callback_ != nullptr &&
3434 ds.consent_callback_->getResult() == UserConsentResult::DENIED;
3435}
3436
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01003437bool Dumpstate::CalledByApi() const {
3438 return ds.options_->bugreport_fd.get() != -1 ? true : false;
3439}
3440
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003441void Dumpstate::CleanupTmpFiles() {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003442 android::os::UnlinkAndLogOnError(tmp_path_);
3443 android::os::UnlinkAndLogOnError(screenshot_path_);
3444 android::os::UnlinkAndLogOnError(path_);
Gavin Corkery789d7a52021-02-24 23:52:35 +00003445 if (dump_traces_path != nullptr) {
3446 android::os::UnlinkAndLogOnError(dump_traces_path);
3447 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003448}
3449
Rhed Jao5377d792020-07-16 17:37:39 +08003450void Dumpstate::EnableParallelRunIfNeeded() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003451 if (!PropertiesHelper::IsParallelRun()) {
Rhed Jao5377d792020-07-16 17:37:39 +08003452 return;
3453 }
3454 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003455 zip_entry_tasks_ = std::make_unique<TaskQueue>();
Rhed Jao5377d792020-07-16 17:37:39 +08003456}
3457
3458void Dumpstate::ShutdownDumpPool() {
3459 if (dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08003460 dump_pool_.reset();
Rhed Jao5377d792020-07-16 17:37:39 +08003461 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003462 if (zip_entry_tasks_) {
3463 zip_entry_tasks_->run(/* do_cancel = */true);
3464 zip_entry_tasks_ = nullptr;
3465 }
3466}
3467
3468void Dumpstate::EnqueueAddZipEntryAndCleanupIfNeeded(const std::string& entry_name,
3469 const std::string& entry_path) {
3470 auto func_add_zip_entry_and_cleanup = [=](bool task_cancelled) {
3471 if (!task_cancelled) {
3472 AddZipEntry(entry_name, entry_path);
3473 }
3474 android::os::UnlinkAndLogOnError(entry_path);
3475 };
3476 if (zip_entry_tasks_) {
3477 // Enqueues AddZipEntryAndCleanup function if the parallel run is enabled.
3478 zip_entry_tasks_->add(func_add_zip_entry_and_cleanup, _1);
3479 } else {
3480 // Invokes AddZipEntryAndCleanup immediately
3481 std::invoke(func_add_zip_entry_and_cleanup, /* task_cancelled = */false);
3482 }
Rhed Jao5377d792020-07-16 17:37:39 +08003483}
3484
Nandana Duttd2f5f082019-01-18 17:13:52 +00003485Dumpstate::RunStatus Dumpstate::HandleUserConsentDenied() {
3486 MYLOGD("User denied consent; deleting files and returning\n");
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003487 CleanupTmpFiles();
Nandana Duttd2f5f082019-01-18 17:13:52 +00003488 return USER_CONSENT_DENIED;
3489}
3490
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003491Dumpstate::RunStatus Dumpstate::CopyBugreportIfUserConsented(int32_t calling_uid) {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003492 // If the caller has asked to copy the bugreport over to their directory, we need explicit
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003493 // user consent (unless the caller is Shell).
3494 UserConsentResult consent_result;
Nikhil Kumar28ce35e2023-01-10 14:32:44 +00003495 if (multiuser_get_app_id(calling_uid) == AID_SHELL) {
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003496 consent_result = UserConsentResult::APPROVED;
3497 } else {
3498 consent_result = consent_callback_->getResult();
3499 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003500 if (consent_result == UserConsentResult::UNAVAILABLE) {
3501 // User has not responded yet.
3502 uint64_t elapsed_ms = consent_callback_->getElapsedTimeMs();
Hunter Knepshield70610fa2020-01-03 15:27:33 -08003503 // Telephony is a fast report type, particularly on user builds where information may be
3504 // more aggressively limited. To give the user time to read the consent dialog, increase the
3505 // timeout.
3506 uint64_t timeout_ms = options_->telephony_only ? TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS
3507 : USER_CONSENT_TIMEOUT_MS;
3508 if (elapsed_ms < timeout_ms) {
3509 uint delay_seconds = (timeout_ms - elapsed_ms) / 1000;
Nandana Duttd2f5f082019-01-18 17:13:52 +00003510 MYLOGD("Did not receive user consent yet; going to wait for %d seconds", delay_seconds);
3511 sleep(delay_seconds);
3512 }
3513 consent_result = consent_callback_->getResult();
3514 }
3515 if (consent_result == UserConsentResult::DENIED) {
3516 // User has explicitly denied sharing with the app. To be safe delete the
3517 // internal bugreport & tmp files.
3518 return HandleUserConsentDenied();
3519 }
3520 if (consent_result == UserConsentResult::APPROVED) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00003521 bool copy_succeeded = android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
3522 if (copy_succeeded) {
3523 android::os::UnlinkAndLogOnError(path_);
Abhijeet Kaur9ce94672020-04-01 17:22:36 +01003524 if (options_->do_screenshot &&
3525 options_->screenshot_fd.get() != -1 &&
3526 !options_->is_screenshot_copied) {
3527 copy_succeeded = android::os::CopyFileToFd(screenshot_path_,
3528 options_->screenshot_fd.get());
3529 options_->is_screenshot_copied = copy_succeeded;
3530 if (copy_succeeded) {
3531 android::os::UnlinkAndLogOnError(screenshot_path_);
3532 }
3533 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003534 }
3535 return copy_succeeded ? Dumpstate::RunStatus::OK : Dumpstate::RunStatus::ERROR;
3536 } else if (consent_result == UserConsentResult::UNAVAILABLE) {
3537 // consent_result is still UNAVAILABLE. The user has likely not responded yet.
3538 // Since we do not have user consent to share the bugreport it does not get
3539 // copied over to the calling app but remains in the internal directory from
3540 // where the user can manually pull it.
Paul Changce644212021-05-11 16:06:45 +08003541 std::string final_path = GetPath(".zip");
3542 bool copy_succeeded = android::os::CopyFileToFile(path_, final_path);
3543 if (copy_succeeded) {
3544 android::os::UnlinkAndLogOnError(path_);
3545 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003546 return Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT;
3547 }
3548 // Unknown result; must be a programming error.
3549 MYLOGE("Unknown user consent result:%d\n", consent_result);
3550 return Dumpstate::RunStatus::ERROR;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003551}
3552
Nandana Duttf02564e2019-02-15 15:24:24 +00003553Dumpstate::RunStatus Dumpstate::ParseCommandlineAndRun(int argc, char* argv[]) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003554 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
3555 Dumpstate::RunStatus status = options->Initialize(argc, argv);
3556 if (status == Dumpstate::RunStatus::OK) {
Nandana Duttf02564e2019-02-15 15:24:24 +00003557 SetOptions(std::move(options));
Nandana Duttd2f5f082019-01-18 17:13:52 +00003558 // When directly running dumpstate binary, the output is not expected to be written
3559 // to any external file descriptor.
Nandana Duttf02564e2019-02-15 15:24:24 +00003560 assert(options_->bugreport_fd.get() == -1);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003561
3562 // calling_uid and calling_package are for user consent to share the bugreport with
Abhijeet Kaura407fb82020-03-27 12:51:12 +00003563 // an app; they are irrelevant here because bugreport is triggered via command line.
3564 // Update Last ID before calling Run().
3565 Initialize();
Nandana Duttf02564e2019-02-15 15:24:24 +00003566 status = Run(-1 /* calling_uid */, "" /* calling_package */);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003567 }
Nandana Duttf02564e2019-02-15 15:24:24 +00003568 return status;
3569}
3570
3571/* Main entry point for dumpstate binary. */
3572int run_main(int argc, char* argv[]) {
3573 Dumpstate::RunStatus status = ds.ParseCommandlineAndRun(argc, argv);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003574
3575 switch (status) {
3576 case Dumpstate::RunStatus::OK:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003577 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003578 case Dumpstate::RunStatus::HELP:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003579 ShowUsage();
3580 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003581 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003582 fprintf(stderr, "Invalid combination of args\n");
3583 ShowUsage();
3584 exit(1);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003585 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00003586 FALLTHROUGH_INTENDED;
3587 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
3588 FALLTHROUGH_INTENDED;
3589 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003590 exit(2);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003591 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003592}
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003593
3594// TODO(111441001): Default DumpOptions to sensible values.
3595Dumpstate::Dumpstate(const std::string& version)
3596 : pid_(getpid()),
3597 options_(new Dumpstate::DumpOptions()),
Nandana Dutt402a8392019-06-14 14:25:13 +01003598 last_reported_percent_progress_(0),
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003599 version_(version),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003600 now_(time(nullptr)),
3601 open_socket_fn_(open_socket) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003602}
3603
3604Dumpstate& Dumpstate::GetInstance() {
3605 static Dumpstate singleton_(android::base::GetProperty("dumpstate.version", VERSION_CURRENT));
3606 return singleton_;
3607}
3608
Rhed Jao5377d792020-07-16 17:37:39 +08003609DurationReporter::DurationReporter(const std::string& title, bool logcat_only, bool verbose,
3610 int duration_fd) : title_(title), logcat_only_(logcat_only), verbose_(verbose),
3611 duration_fd_(duration_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003612 if (!title_.empty()) {
3613 started_ = Nanotime();
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003614 if (title_.find("SHOW MAP") == std::string::npos) {
3615 ATRACE_ASYNC_BEGIN(title_.c_str(), 0);
3616 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003617 }
3618}
3619
3620DurationReporter::~DurationReporter() {
3621 if (!title_.empty()) {
3622 float elapsed = (float)(Nanotime() - started_) / NANOS_PER_SEC;
chenqiwuaf8b2d92019-12-12 18:53:51 +08003623 if (elapsed >= .5f || verbose_) {
3624 MYLOGD("Duration of '%s': %.2fs\n", title_.c_str(), elapsed);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003625 }
chenqiwuaf8b2d92019-12-12 18:53:51 +08003626 if (!logcat_only_) {
3627 // Use "Yoda grammar" to make it easier to grep|sort sections.
Rhed Jao5377d792020-07-16 17:37:39 +08003628 dprintf(duration_fd_, "------ %.3fs was the duration of '%s' ------\n",
3629 elapsed, title_.c_str());
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003630 }
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003631 if (title_.find("SHOW MAP") == std::string::npos) {
3632 ATRACE_ASYNC_END(title_.c_str(), 0);
3633 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003634 }
3635}
3636
3637const int32_t Progress::kDefaultMax = 5000;
3638
3639Progress::Progress(const std::string& path) : Progress(Progress::kDefaultMax, 1.1, path) {
3640}
3641
3642Progress::Progress(int32_t initial_max, int32_t progress, float growth_factor)
3643 : Progress(initial_max, growth_factor, "") {
3644 progress_ = progress;
3645}
3646
3647Progress::Progress(int32_t initial_max, float growth_factor, const std::string& path)
3648 : initial_max_(initial_max),
3649 progress_(0),
3650 max_(initial_max),
3651 growth_factor_(growth_factor),
3652 n_runs_(0),
3653 average_max_(0),
3654 path_(path) {
3655 if (!path_.empty()) {
3656 Load();
3657 }
3658}
3659
3660void Progress::Load() {
3661 MYLOGD("Loading stats from %s\n", path_.c_str());
3662 std::string content;
3663 if (!android::base::ReadFileToString(path_, &content)) {
3664 MYLOGI("Could not read stats from %s; using max of %d\n", path_.c_str(), max_);
3665 return;
3666 }
3667 if (content.empty()) {
3668 MYLOGE("No stats (empty file) on %s; using max of %d\n", path_.c_str(), max_);
3669 return;
3670 }
3671 std::vector<std::string> lines = android::base::Split(content, "\n");
3672
3673 if (lines.size() < 1) {
3674 MYLOGE("Invalid stats on file %s: not enough lines (%d). Using max of %d\n", path_.c_str(),
3675 (int)lines.size(), max_);
3676 return;
3677 }
3678 char* ptr;
3679 n_runs_ = strtol(lines[0].c_str(), &ptr, 10);
3680 average_max_ = strtol(ptr, nullptr, 10);
3681 if (n_runs_ <= 0 || average_max_ <= 0 || n_runs_ > STATS_MAX_N_RUNS ||
3682 average_max_ > STATS_MAX_AVERAGE) {
3683 MYLOGE("Invalid stats line on file %s: %s\n", path_.c_str(), lines[0].c_str());
3684 initial_max_ = Progress::kDefaultMax;
3685 } else {
3686 initial_max_ = average_max_;
3687 }
3688 max_ = initial_max_;
3689
3690 MYLOGI("Average max progress: %d in %d runs; estimated max: %d\n", average_max_, n_runs_, max_);
3691}
3692
3693void Progress::Save() {
3694 int32_t total = n_runs_ * average_max_ + progress_;
3695 int32_t runs = n_runs_ + 1;
3696 int32_t average = floor(((float)total) / runs);
3697 MYLOGI("Saving stats (total=%d, runs=%d, average=%d) on %s\n", total, runs, average,
3698 path_.c_str());
3699 if (path_.empty()) {
3700 return;
3701 }
3702
3703 std::string content = android::base::StringPrintf("%d %d\n", runs, average);
3704 if (!android::base::WriteStringToFile(content, path_)) {
3705 MYLOGE("Could not save stats on %s\n", path_.c_str());
3706 }
3707}
3708
3709int32_t Progress::Get() const {
3710 return progress_;
3711}
3712
3713bool Progress::Inc(int32_t delta_sec) {
3714 bool changed = false;
3715 if (delta_sec >= 0) {
3716 progress_ += delta_sec;
3717 if (progress_ > max_) {
3718 int32_t old_max = max_;
3719 max_ = floor((float)progress_ * growth_factor_);
3720 MYLOGD("Adjusting max progress from %d to %d\n", old_max, max_);
3721 changed = true;
3722 }
3723 }
3724 return changed;
3725}
3726
3727int32_t Progress::GetMax() const {
3728 return max_;
3729}
3730
3731int32_t Progress::GetInitialMax() const {
3732 return initial_max_;
3733}
3734
3735void Progress::Dump(int fd, const std::string& prefix) const {
3736 const char* pr = prefix.c_str();
3737 dprintf(fd, "%sprogress: %d\n", pr, progress_);
3738 dprintf(fd, "%smax: %d\n", pr, max_);
3739 dprintf(fd, "%sinitial_max: %d\n", pr, initial_max_);
3740 dprintf(fd, "%sgrowth_factor: %0.2f\n", pr, growth_factor_);
3741 dprintf(fd, "%spath: %s\n", pr, path_.c_str());
3742 dprintf(fd, "%sn_runs: %d\n", pr, n_runs_);
3743 dprintf(fd, "%saverage_max: %d\n", pr, average_max_);
3744}
3745
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003746std::string Dumpstate::GetPath(const std::string& suffix) const {
3747 return GetPath(bugreport_internal_dir_, suffix);
3748}
3749
3750std::string Dumpstate::GetPath(const std::string& directory, const std::string& suffix) const {
3751 return android::base::StringPrintf("%s/%s-%s%s", directory.c_str(), base_name_.c_str(),
3752 name_.c_str(), suffix.c_str());
3753}
3754
3755void Dumpstate::SetProgress(std::unique_ptr<Progress> progress) {
3756 progress_ = std::move(progress);
3757}
3758
3759void for_each_userid(void (*func)(int), const char *header) {
3760 std::string title = header == nullptr ? "for_each_userid" : android::base::StringPrintf(
3761 "for_each_userid(%s)", header);
3762 DurationReporter duration_reporter(title);
3763 if (PropertiesHelper::IsDryRun()) return;
3764
3765 DIR *d;
3766 struct dirent *de;
3767
3768 if (header) printf("\n------ %s ------\n", header);
3769 func(0);
3770
3771 if (!(d = opendir("/data/system/users"))) {
3772 printf("Failed to open /data/system/users (%s)\n", strerror(errno));
3773 return;
3774 }
3775
3776 while ((de = readdir(d))) {
3777 int userid;
3778 if (de->d_type != DT_DIR || !(userid = atoi(de->d_name))) {
3779 continue;
3780 }
3781 func(userid);
3782 }
3783
3784 closedir(d);
3785}
3786
3787static void __for_each_pid(void (*helper)(int, const char *, void *), const char *header, void *arg) {
3788 DIR *d;
3789 struct dirent *de;
3790
3791 if (!(d = opendir("/proc"))) {
3792 printf("Failed to open /proc (%s)\n", strerror(errno));
3793 return;
3794 }
3795
3796 if (header) printf("\n------ %s ------\n", header);
3797 while ((de = readdir(d))) {
3798 if (ds.IsUserConsentDenied()) {
3799 MYLOGE(
3800 "Returning early because user denied consent to share bugreport with calling app.");
3801 closedir(d);
3802 return;
3803 }
3804 int pid;
3805 int fd;
3806 char cmdpath[255];
3807 char cmdline[255];
3808
3809 if (!(pid = atoi(de->d_name))) {
3810 continue;
3811 }
3812
3813 memset(cmdline, 0, sizeof(cmdline));
3814
3815 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/cmdline", pid);
3816 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3817 TEMP_FAILURE_RETRY(read(fd, cmdline, sizeof(cmdline) - 2));
3818 close(fd);
3819 if (cmdline[0]) {
3820 helper(pid, cmdline, arg);
3821 continue;
3822 }
3823 }
3824
3825 // if no cmdline, a kernel thread has comm
3826 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/comm", pid);
3827 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3828 TEMP_FAILURE_RETRY(read(fd, cmdline + 1, sizeof(cmdline) - 4));
3829 close(fd);
3830 if (cmdline[1]) {
3831 cmdline[0] = '[';
3832 size_t len = strcspn(cmdline, "\f\b\r\n");
3833 cmdline[len] = ']';
3834 cmdline[len+1] = '\0';
3835 }
3836 }
3837 if (!cmdline[0]) {
3838 strcpy(cmdline, "N/A");
3839 }
3840 helper(pid, cmdline, arg);
3841 }
3842
3843 closedir(d);
3844}
3845
3846static void for_each_pid_helper(int pid, const char *cmdline, void *arg) {
3847 for_each_pid_func *func = (for_each_pid_func*) arg;
3848 func(pid, cmdline);
3849}
3850
3851void for_each_pid(for_each_pid_func func, const char *header) {
3852 std::string title = header == nullptr ? "for_each_pid"
3853 : android::base::StringPrintf("for_each_pid(%s)", header);
3854 DurationReporter duration_reporter(title);
3855 if (PropertiesHelper::IsDryRun()) return;
3856
3857 __for_each_pid(for_each_pid_helper, header, (void *) func);
3858}
3859
3860static void for_each_tid_helper(int pid, const char *cmdline, void *arg) {
3861 DIR *d;
3862 struct dirent *de;
3863 char taskpath[255];
3864 for_each_tid_func *func = (for_each_tid_func *) arg;
3865
3866 snprintf(taskpath, sizeof(taskpath), "/proc/%d/task", pid);
3867
3868 if (!(d = opendir(taskpath))) {
3869 printf("Failed to open %s (%s)\n", taskpath, strerror(errno));
3870 return;
3871 }
3872
3873 func(pid, pid, cmdline);
3874
3875 while ((de = readdir(d))) {
3876 if (ds.IsUserConsentDenied()) {
3877 MYLOGE(
3878 "Returning early because user denied consent to share bugreport with calling app.");
3879 closedir(d);
3880 return;
3881 }
3882 int tid;
3883 int fd;
3884 char commpath[255];
3885 char comm[255];
3886
3887 if (!(tid = atoi(de->d_name))) {
3888 continue;
3889 }
3890
3891 if (tid == pid)
3892 continue;
3893
3894 snprintf(commpath, sizeof(commpath), "/proc/%d/comm", tid);
3895 memset(comm, 0, sizeof(comm));
3896 if ((fd = TEMP_FAILURE_RETRY(open(commpath, O_RDONLY | O_CLOEXEC))) < 0) {
3897 strcpy(comm, "N/A");
3898 } else {
3899 char *c;
3900 TEMP_FAILURE_RETRY(read(fd, comm, sizeof(comm) - 2));
3901 close(fd);
3902
3903 c = strrchr(comm, '\n');
3904 if (c) {
3905 *c = '\0';
3906 }
3907 }
3908 func(pid, tid, comm);
3909 }
3910
3911 closedir(d);
3912}
3913
3914void for_each_tid(for_each_tid_func func, const char *header) {
3915 std::string title = header == nullptr ? "for_each_tid"
3916 : android::base::StringPrintf("for_each_tid(%s)", header);
3917 DurationReporter duration_reporter(title);
3918
3919 if (PropertiesHelper::IsDryRun()) return;
3920
3921 __for_each_pid(for_each_tid_helper, header, (void *) func);
3922}
3923
3924void show_wchan(int pid, int tid, const char *name) {
3925 if (PropertiesHelper::IsDryRun()) return;
3926
3927 char path[255];
3928 char buffer[255];
3929 int fd, ret, save_errno;
3930 char name_buffer[255];
3931
3932 memset(buffer, 0, sizeof(buffer));
3933
3934 snprintf(path, sizeof(path), "/proc/%d/wchan", tid);
3935 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3936 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3937 return;
3938 }
3939
3940 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3941 save_errno = errno;
3942 close(fd);
3943
3944 if (ret < 0) {
3945 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3946 return;
3947 }
3948
3949 snprintf(name_buffer, sizeof(name_buffer), "%*s%s",
3950 pid == tid ? 0 : 3, "", name);
3951
3952 printf("%-7d %-32s %s\n", tid, name_buffer, buffer);
3953
3954 return;
3955}
3956
3957// print time in centiseconds
3958static void snprcent(char *buffer, size_t len, size_t spc,
3959 unsigned long long time) {
3960 static long hz; // cache discovered hz
3961
3962 if (hz <= 0) {
3963 hz = sysconf(_SC_CLK_TCK);
3964 if (hz <= 0) {
3965 hz = 1000;
3966 }
3967 }
3968
3969 // convert to centiseconds
3970 time = (time * 100 + (hz / 2)) / hz;
3971
3972 char str[16];
3973
3974 snprintf(str, sizeof(str), " %llu.%02u",
3975 time / 100, (unsigned)(time % 100));
3976 size_t offset = strlen(buffer);
3977 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3978 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3979}
3980
3981// print permille as a percent
3982static void snprdec(char *buffer, size_t len, size_t spc, unsigned permille) {
3983 char str[16];
3984
3985 snprintf(str, sizeof(str), " %u.%u%%", permille / 10, permille % 10);
3986 size_t offset = strlen(buffer);
3987 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3988 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3989}
3990
3991void show_showtime(int pid, const char *name) {
3992 if (PropertiesHelper::IsDryRun()) return;
3993
3994 char path[255];
3995 char buffer[1023];
3996 int fd, ret, save_errno;
3997
3998 memset(buffer, 0, sizeof(buffer));
3999
4000 snprintf(path, sizeof(path), "/proc/%d/stat", pid);
4001 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
4002 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
4003 return;
4004 }
4005
4006 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
4007 save_errno = errno;
4008 close(fd);
4009
4010 if (ret < 0) {
4011 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
4012 return;
4013 }
4014
4015 // field 14 is utime
4016 // field 15 is stime
4017 // field 42 is iotime
4018 unsigned long long utime = 0, stime = 0, iotime = 0;
4019 if (sscanf(buffer,
4020 "%*u %*s %*s %*d %*d %*d %*d %*d %*d %*d %*d "
4021 "%*d %*d %llu %llu %*d %*d %*d %*d %*d %*d "
4022 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %*d "
4023 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %llu ",
4024 &utime, &stime, &iotime) != 3) {
4025 return;
4026 }
4027
4028 unsigned long long total = utime + stime;
4029 if (!total) {
4030 return;
4031 }
4032
4033 unsigned permille = (iotime * 1000 + (total / 2)) / total;
4034 if (permille > 1000) {
4035 permille = 1000;
4036 }
4037
4038 // try to beautify and stabilize columns at <80 characters
4039 snprintf(buffer, sizeof(buffer), "%-6d%s", pid, name);
4040 if ((name[0] != '[') || utime) {
4041 snprcent(buffer, sizeof(buffer), 57, utime);
4042 }
4043 snprcent(buffer, sizeof(buffer), 65, stime);
4044 if ((name[0] != '[') || iotime) {
4045 snprcent(buffer, sizeof(buffer), 73, iotime);
4046 }
4047 if (iotime) {
4048 snprdec(buffer, sizeof(buffer), 79, permille);
4049 }
4050 puts(buffer); // adds a trailing newline
4051
4052 return;
4053}
4054
4055void do_dmesg() {
4056 const char *title = "KERNEL LOG (dmesg)";
4057 DurationReporter duration_reporter(title);
4058 printf("------ %s ------\n", title);
4059
4060 if (PropertiesHelper::IsDryRun()) return;
4061
4062 /* Get size of kernel buffer */
4063 int size = klogctl(KLOG_SIZE_BUFFER, nullptr, 0);
4064 if (size <= 0) {
4065 printf("Unexpected klogctl return value: %d\n\n", size);
4066 return;
4067 }
4068 char *buf = (char *) malloc(size + 1);
4069 if (buf == nullptr) {
4070 printf("memory allocation failed\n\n");
4071 return;
4072 }
4073 int retval = klogctl(KLOG_READ_ALL, buf, size);
4074 if (retval < 0) {
4075 printf("klogctl failure\n\n");
4076 free(buf);
4077 return;
4078 }
4079 buf[retval] = '\0';
4080 printf("%s\n\n", buf);
4081 free(buf);
4082 return;
4083}
4084
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004085int Dumpstate::DumpFile(const std::string& title, const std::string& path) {
4086 DurationReporter duration_reporter(title);
4087
4088 int status = DumpFileToFd(STDOUT_FILENO, title, path);
4089
4090 UpdateProgress(WEIGHT_FILE);
4091
4092 return status;
4093}
4094
4095int read_file_as_long(const char *path, long int *output) {
4096 int fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC));
4097 if (fd < 0) {
4098 int err = errno;
4099 MYLOGE("Error opening file descriptor for %s: %s\n", path, strerror(err));
4100 return -1;
4101 }
4102 char buffer[50];
4103 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
4104 if (bytes_read == -1) {
4105 MYLOGE("Error reading file %s: %s\n", path, strerror(errno));
4106 return -2;
4107 }
4108 if (bytes_read == 0) {
4109 MYLOGE("File %s is empty\n", path);
4110 return -3;
4111 }
4112 *output = atoi(buffer);
4113 return 0;
4114}
4115
4116/* calls skip to gate calling dump_from_fd recursively
4117 * in the specified directory. dump_from_fd defaults to
4118 * dump_file_from_fd above when set to NULL. skip defaults
4119 * to false when set to NULL. dump_from_fd will always be
4120 * called with title NULL.
4121 */
4122int dump_files(const std::string& title, const char* dir, bool (*skip)(const char* path),
4123 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
4124 DurationReporter duration_reporter(title);
4125 DIR *dirp;
4126 struct dirent *d;
4127 char *newpath = nullptr;
4128 const char *slash = "/";
4129 int retval = 0;
4130
4131 if (!title.empty()) {
4132 printf("------ %s (%s) ------\n", title.c_str(), dir);
4133 }
4134 if (PropertiesHelper::IsDryRun()) return 0;
4135
4136 if (dir[strlen(dir) - 1] == '/') {
4137 ++slash;
4138 }
4139 dirp = opendir(dir);
4140 if (dirp == nullptr) {
4141 retval = -errno;
4142 MYLOGE("%s: %s\n", dir, strerror(errno));
4143 return retval;
4144 }
4145
4146 if (!dump_from_fd) {
4147 dump_from_fd = dump_file_from_fd;
4148 }
4149 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
4150 if ((d->d_name[0] == '.')
4151 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
4152 || (d->d_name[1] == '\0'))) {
4153 continue;
4154 }
4155 asprintf(&newpath, "%s%s%s%s", dir, slash, d->d_name,
4156 (d->d_type == DT_DIR) ? "/" : "");
4157 if (!newpath) {
4158 retval = -errno;
4159 continue;
4160 }
4161 if (skip && (*skip)(newpath)) {
4162 continue;
4163 }
4164 if (d->d_type == DT_DIR) {
4165 int ret = dump_files("", newpath, skip, dump_from_fd);
4166 if (ret < 0) {
4167 retval = ret;
4168 }
4169 continue;
4170 }
4171 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(newpath, O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
4172 if (fd.get() < 0) {
4173 retval = -1;
4174 printf("*** %s: %s\n", newpath, strerror(errno));
4175 continue;
4176 }
4177 (*dump_from_fd)(nullptr, newpath, fd.get());
4178 }
4179 closedir(dirp);
4180 if (!title.empty()) {
4181 printf("\n");
4182 }
4183 return retval;
4184}
4185
4186/* fd must have been opened with the flag O_NONBLOCK. With this flag set,
4187 * it's possible to avoid issues where opening the file itself can get
4188 * stuck.
4189 */
4190int dump_file_from_fd(const char *title, const char *path, int fd) {
4191 if (PropertiesHelper::IsDryRun()) return 0;
4192
4193 int flags = fcntl(fd, F_GETFL);
4194 if (flags == -1) {
4195 printf("*** %s: failed to get flags on fd %d: %s\n", path, fd, strerror(errno));
4196 return -1;
4197 } else if (!(flags & O_NONBLOCK)) {
4198 printf("*** %s: fd must have O_NONBLOCK set.\n", path);
4199 return -1;
4200 }
4201 return DumpFileFromFdToFd(title, path, fd, STDOUT_FILENO, PropertiesHelper::IsDryRun());
4202}
4203
4204int Dumpstate::RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08004205 const CommandOptions& options, bool verbose_duration, int out_fd) {
4206 DurationReporter duration_reporter(title, false /* logcat_only */,
4207 verbose_duration, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004208
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08004209 int status = RunCommandToFd(out_fd, title, full_command, options);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004210
4211 /* TODO: for now we're simplifying the progress calculation by using the
4212 * timeout as the weight. It's a good approximation for most cases, except when calling dumpsys,
4213 * where its weight should be much higher proportionally to its timeout.
4214 * Ideally, it should use a options.EstimatedDuration() instead...*/
4215 UpdateProgress(options.Timeout());
4216
4217 return status;
4218}
4219
4220void Dumpstate::RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsys_args,
Rhed Jaoe017f982020-07-21 17:58:41 +08004221 const CommandOptions& options, long dumpsysTimeoutMs, int out_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004222 long timeout_ms = dumpsysTimeoutMs > 0 ? dumpsysTimeoutMs : options.TimeoutInMs();
4223 std::vector<std::string> dumpsys = {"/system/bin/dumpsys", "-T", std::to_string(timeout_ms)};
4224 dumpsys.insert(dumpsys.end(), dumpsys_args.begin(), dumpsys_args.end());
Rhed Jaoe017f982020-07-21 17:58:41 +08004225 RunCommand(title, dumpsys, options, false, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004226}
4227
Dieter Hsu105ad0c2020-09-29 15:23:33 +08004228static int open_socket(const char* service) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004229 int s = android_get_control_socket(service);
4230 if (s < 0) {
4231 MYLOGE("android_get_control_socket(%s): %s\n", service, strerror(errno));
4232 return -1;
4233 }
4234 fcntl(s, F_SETFD, FD_CLOEXEC);
4235
4236 // Set backlog to 0 to make sure that queue size will be minimum.
4237 // In Linux, because the minimum queue will be 1, connect() will be blocked
4238 // if the other clients already called connect() and the connection request was not accepted.
4239 if (listen(s, 0) < 0) {
4240 MYLOGE("listen(control socket): %s\n", strerror(errno));
4241 return -1;
4242 }
4243
4244 struct sockaddr addr;
4245 socklen_t alen = sizeof(addr);
Abhijeet Kaur2113cae2019-09-13 09:24:15 +01004246 int fd = accept4(s, &addr, &alen, SOCK_CLOEXEC);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004247
4248 // Close socket just after accept(), to make sure that connect() by client will get error
4249 // when the socket is used by the other services.
4250 // There is still a race condition possibility between accept and close, but there is no way
4251 // to close-on-accept atomically.
4252 // See detail; b/123306389#comment25
4253 close(s);
4254
4255 if (fd < 0) {
4256 MYLOGE("accept(control socket): %s\n", strerror(errno));
4257 return -1;
4258 }
4259
4260 return fd;
4261}
4262
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004263// TODO: should call is_valid_output_file and/or be merged into it.
4264void create_parent_dirs(const char *path) {
4265 char *chp = const_cast<char *> (path);
4266
4267 /* skip initial slash */
4268 if (chp[0] == '/')
4269 chp++;
4270
4271 /* create leading directories, if necessary */
4272 struct stat dir_stat;
4273 while (chp && chp[0]) {
4274 chp = strchr(chp, '/');
4275 if (chp) {
4276 *chp = 0;
4277 if (stat(path, &dir_stat) == -1 || !S_ISDIR(dir_stat.st_mode)) {
4278 MYLOGI("Creating directory %s\n", path);
4279 if (mkdir(path, 0770)) { /* drwxrwx--- */
4280 MYLOGE("Unable to create directory %s: %s\n", path, strerror(errno));
4281 } else if (chown(path, AID_SHELL, AID_SHELL)) {
4282 MYLOGE("Unable to change ownership of dir %s: %s\n", path, strerror(errno));
4283 }
4284 }
4285 *chp++ = '/';
4286 }
4287 }
4288}
4289
4290bool _redirect_to_file(FILE* redirect, char* path, int truncate_flag) {
4291 create_parent_dirs(path);
4292
4293 int fd = TEMP_FAILURE_RETRY(open(path,
4294 O_WRONLY | O_CREAT | truncate_flag | O_CLOEXEC | O_NOFOLLOW,
4295 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH));
4296 if (fd < 0) {
4297 MYLOGE("%s: %s\n", path, strerror(errno));
4298 return false;
4299 }
4300
4301 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
4302 close(fd);
4303 return true;
4304}
4305
4306bool redirect_to_file(FILE* redirect, char* path) {
4307 return _redirect_to_file(redirect, path, O_TRUNC);
4308}
4309
4310bool redirect_to_existing_file(FILE* redirect, char* path) {
4311 return _redirect_to_file(redirect, path, O_APPEND);
4312}
4313
4314void dump_route_tables() {
4315 DurationReporter duration_reporter("DUMP ROUTE TABLES");
4316 if (PropertiesHelper::IsDryRun()) return;
4317 const char* const RT_TABLES_PATH = "/data/misc/net/rt_tables";
4318 ds.DumpFile("RT_TABLES", RT_TABLES_PATH);
4319 FILE* fp = fopen(RT_TABLES_PATH, "re");
4320 if (!fp) {
4321 printf("*** %s: %s\n", RT_TABLES_PATH, strerror(errno));
4322 return;
4323 }
4324 char table[16];
4325 // Each line has an integer (the table number), a space, and a string (the table name). We only
4326 // need the table number. It's a 32-bit unsigned number, so max 10 chars. Skip the table name.
4327 // Add a fixed max limit so this doesn't go awry.
4328 for (int i = 0; i < 64 && fscanf(fp, " %10s %*s", table) == 1; ++i) {
4329 RunCommand("ROUTE TABLE IPv4", {"ip", "-4", "route", "show", "table", table});
4330 RunCommand("ROUTE TABLE IPv6", {"ip", "-6", "route", "show", "table", table});
4331 }
4332 fclose(fp);
4333}
4334
Li Li830179f2022-01-04 12:53:29 -08004335void dump_frozen_cgroupfs(const char *dir, int level,
4336 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
4337 DIR *dirp;
4338 struct dirent *d;
4339 char *newpath = nullptr;
4340
4341 dirp = opendir(dir);
4342 if (dirp == nullptr) {
4343 MYLOGE("%s: %s\n", dir, strerror(errno));
4344 return;
4345 }
4346
4347 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
4348 if ((d->d_name[0] == '.')
4349 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
4350 || (d->d_name[1] == '\0'))) {
4351 continue;
4352 }
4353 if (d->d_type == DT_DIR) {
4354 asprintf(&newpath, "%s/%s/", dir, d->d_name);
4355 if (!newpath) {
4356 continue;
4357 }
4358 if (level == 0 && !strncmp(d->d_name, "uid_", 4)) {
4359 dump_frozen_cgroupfs(newpath, 1, dump_from_fd);
4360 } else if (level == 1 && !strncmp(d->d_name, "pid_", 4)) {
4361 char *freezer = nullptr;
4362 asprintf(&freezer, "%s/%s", newpath, "cgroup.freeze");
4363 if (freezer) {
4364 FILE* fp = fopen(freezer, "r");
4365 if (fp != NULL) {
4366 int frozen;
4367 fscanf(fp, "%d", &frozen);
4368 if (frozen > 0) {
4369 dump_files("", newpath, skip_none, dump_from_fd);
4370 }
4371 fclose(fp);
4372 }
4373 free(freezer);
4374 }
4375 }
4376 }
4377 }
4378 closedir(dirp);
4379}
4380
4381void dump_frozen_cgroupfs() {
Li Li830179f2022-01-04 12:53:29 -08004382 MYLOGD("Adding frozen processes from %s\n", CGROUPFS_DIR);
4383 DurationReporter duration_reporter("FROZEN CGROUPFS");
4384 if (PropertiesHelper::IsDryRun()) return;
4385 dump_frozen_cgroupfs(CGROUPFS_DIR, 0, _add_file_from_fd);
4386}
4387
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004388void Dumpstate::UpdateProgress(int32_t delta_sec) {
4389 if (progress_ == nullptr) {
4390 MYLOGE("UpdateProgress: progress_ not set\n");
4391 return;
4392 }
Rhed Jaobf63d8a2020-07-21 15:42:55 +08004393 // This function updates progress related members of the dumpstate and reports
4394 // progress percentage to the bugreport client. Since it could be called by
4395 // different dump tasks at the same time if the parallel run is enabled, a
4396 // mutex lock is necessary here to synchronize the call.
4397 std::lock_guard<std::recursive_mutex> lock(mutex_);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004398
4399 // Always update progess so stats can be tuned...
Nandana Dutt402a8392019-06-14 14:25:13 +01004400 progress_->Inc(delta_sec);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004401
4402 // ...but only notifiy listeners when necessary.
4403 if (!options_->do_progress_updates) return;
4404
4405 int progress = progress_->Get();
4406 int max = progress_->GetMax();
Nandana Dutt402a8392019-06-14 14:25:13 +01004407 int percent = 100 * progress / max;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004408
Nandana Dutt402a8392019-06-14 14:25:13 +01004409 if (last_reported_percent_progress_ > 0 && percent <= last_reported_percent_progress_) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004410 return;
4411 }
Nandana Dutt402a8392019-06-14 14:25:13 +01004412 last_reported_percent_progress_ = percent;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004413
4414 if (control_socket_fd_ >= 0) {
4415 dprintf(control_socket_fd_, "PROGRESS:%d/%d\n", progress, max);
4416 fsync(control_socket_fd_);
4417 }
4418
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004419 if (listener_ != nullptr) {
Nandana Dutt235c6672019-11-14 15:22:32 +00004420 if (percent % 10 == 0) {
4421 // We don't want to spam logcat, so only log multiples of 10.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004422 MYLOGD("Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004423 } else {
4424 // stderr is ignored on normal invocations, but useful when calling
4425 // /system/bin/dumpstate directly for debuggging.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004426 fprintf(stderr, "Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004427 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004428
4429 listener_->onProgress(percent);
4430 }
4431}
4432
4433void Dumpstate::TakeScreenshot(const std::string& path) {
4434 const std::string& real_path = path.empty() ? screenshot_path_ : path;
4435 int status =
4436 RunCommand("", {"/system/bin/screencap", "-p", real_path},
4437 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
4438 if (status == 0) {
4439 MYLOGD("Screenshot saved on %s\n", real_path.c_str());
4440 } else {
4441 MYLOGE("Failed to take screenshot on %s\n", real_path.c_str());
4442 }
Paul Chang0d2aad72020-02-13 20:04:03 +08004443 if (listener_ != nullptr) {
4444 // Show a visual indication to indicate screenshot is taken via
4445 // IDumpstateListener.onScreenshotTaken()
4446 listener_->onScreenshotTaken(status == 0);
4447 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004448}
4449
4450bool is_dir(const char* pathname) {
4451 struct stat info;
4452 if (stat(pathname, &info) == -1) {
4453 return false;
4454 }
4455 return S_ISDIR(info.st_mode);
4456}
4457
4458time_t get_mtime(int fd, time_t default_mtime) {
4459 struct stat info;
4460 if (fstat(fd, &info) == -1) {
4461 return default_mtime;
4462 }
4463 return info.st_mtime;
4464}