blob: 9b453826c464af5fb249f84ede8e14786feaf5d6 [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>
Kholoud Mohamed7c3fb7c2023-10-18 12:56:22 +000062#include <android_app_admin_flags.h>
Felipe Leme96c2bbb2016-09-26 09:21:21 -070063#include <android-base/file.h>
64#include <android-base/properties.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070065#include <android-base/scopeguard.h>
Elliott Hughes9dc117c2015-12-07 14:21:50 -080066#include <android-base/stringprintf.h>
Naveen Kalla058e1e82016-10-19 21:38:44 -070067#include <android-base/strings.h>
Andreas Gampeaff68432016-07-18 18:01:27 -070068#include <android-base/unique_fd.h>
Kedar Chitnis9fd8c052021-11-16 09:09:22 +000069#include <android/binder_manager.h>
70#include <android/binder_process.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010071#include <android/content/pm/IPackageManagerNative.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080072#include <android/hardware/dumpstate/1.0/IDumpstateDevice.h>
Hunter Knepshield8540faf2020-02-04 19:47:20 -080073#include <android/hardware/dumpstate/1.1/IDumpstateDevice.h>
74#include <android/hardware/dumpstate/1.1/types.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080075#include <android/hidl/manager/1.0/IServiceManager.h>
Nandana Duttd2f5f082019-01-18 17:13:52 +000076#include <android/os/IIncidentCompanion.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010077#include <binder/IServiceManager.h>
Nikhil Kumar28ce35e2023-01-10 14:32:44 +000078#include <cutils/multiuser.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080079#include <cutils/native_handle.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070080#include <cutils/properties.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010081#include <cutils/sockets.h>
Kevin Jeon2c02e8e2022-07-07 21:45:17 +000082#include <cutils/trace.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000083#include <debuggerd/client.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080084#include <dumpsys.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000085#include <dumputils/dump_utils.h>
Sahana Raof35ed432019-07-12 10:47:52 +010086#include <hardware_legacy/power.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080087#include <hidl/ServiceManagement.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010088#include <log/log.h>
Tom Cherryf4472f32020-08-05 09:31:17 -070089#include <log/log_read.h>
Felipe Leme75876a22016-10-27 16:31:27 -070090#include <openssl/sha.h>
Mark Salyzyn6c3d90f2016-09-27 14:55:27 -070091#include <private/android_filesystem_config.h>
92#include <private/android_logger.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080093#include <serviceutils/PriorityDumper.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070094#include <utils/StrongPointer.h>
Devin Moore8df81bb2022-06-08 22:47:02 +000095#include <vintf/VintfObject.h>
Felipe Lemef0292972016-11-22 13:57:05 -080096#include "DumpstateInternal.h"
Felipe Leme75876a22016-10-27 16:31:27 -070097#include "DumpstateService.h"
Colin Crossf45fa6b2012-03-26 12:38:26 -070098#include "dumpstate.h"
Felipe Leme6e01fa62015-11-11 19:35:14 -080099
Kedar Chitnis9fd8c052021-11-16 09:09:22 +0000100namespace dumpstate_hal_hidl_1_0 = android::hardware::dumpstate::V1_0;
101namespace dumpstate_hal_hidl = android::hardware::dumpstate::V1_1;
102namespace dumpstate_hal_aidl = aidl::android::hardware::dumpstate;
103
Vishnu Naire97d6122018-01-18 13:58:56 -0800104using ::std::literals::chrono_literals::operator""ms;
105using ::std::literals::chrono_literals::operator""s;
Rhed Jao5377d792020-07-16 17:37:39 +0800106using ::std::placeholders::_1;
Steven Morelandcb7ef822016-11-29 13:20:37 -0800107
Felipe Leme47e9be22016-12-21 15:37:07 -0800108// TODO: remove once moved to namespace
Vishnu Naire97d6122018-01-18 13:58:56 -0800109using android::defaultServiceManager;
110using android::Dumpsys;
111using android::INVALID_OPERATION;
112using android::IServiceManager;
113using android::OK;
114using android::sp;
115using android::status_t;
116using android::String16;
117using android::String8;
118using android::TIMED_OUT;
119using android::UNKNOWN_ERROR;
120using android::Vector;
Nandana Dutt979388e2018-11-30 16:48:55 +0000121using android::base::StringPrintf;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000122using android::os::IDumpstateListener;
Felipe Leme47e9be22016-12-21 15:37:07 -0800123using android::os::dumpstate::CommandOptions;
124using android::os::dumpstate::DumpFileToFd;
Rhed Jao5377d792020-07-16 17:37:39 +0800125using android::os::dumpstate::DumpPool;
Vishnu Naire97d6122018-01-18 13:58:56 -0800126using android::os::dumpstate::PropertiesHelper;
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800127using android::os::dumpstate::TaskQueue;
Chris Morinbc223142022-02-04 14:17:11 -0800128using android::os::dumpstate::WaitForTask;
Felipe Leme47e9be22016-12-21 15:37:07 -0800129
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100130// Keep in sync with
131// frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
132static const int TRACE_DUMP_TIMEOUT_MS = 10000; // 10 seconds
133
134/* Most simple commands have 10 as timeout, so 5 is a good estimate */
135static const int32_t WEIGHT_FILE = 5;
136
137// TODO: temporary variables and functions used during C++ refactoring
138static Dumpstate& ds = Dumpstate::GetInstance();
139static int RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Nandana Dutt8d945c02019-08-14 13:30:07 +0100140 const CommandOptions& options = CommandOptions::DEFAULT,
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800141 bool verbose_duration = false, int out_fd = STDOUT_FILENO) {
142 return ds.RunCommand(title, full_command, options, verbose_duration, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100143}
144
145// Reasonable value for max stats.
146static const int STATS_MAX_N_RUNS = 1000;
147static const long STATS_MAX_AVERAGE = 100000;
148
149CommandOptions Dumpstate::DEFAULT_DUMPSYS = CommandOptions::WithTimeout(30).Build();
150
Nandana Duttd2f5f082019-01-18 17:13:52 +0000151typedef Dumpstate::ConsentCallback::ConsentResult UserConsentResult;
152
Colin Crossf45fa6b2012-03-26 12:38:26 -0700153/* read before root is shed */
154static char cmdline_buf[16384] = "(unknown)";
Yi Kong19d5c002018-07-20 13:39:55 -0700155static const char *dump_traces_path = nullptr;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000156static const uint64_t USER_CONSENT_TIMEOUT_MS = 30 * 1000;
Hunter Knepshield70610fa2020-01-03 15:27:33 -0800157// Because telephony reports are significantly faster to collect (< 10 seconds vs. > 2 minutes),
158// it's often the case that they time out far too quickly for consent with such a hefty dialog for
159// the user to read. For telephony reports only, we increase the default timeout to 2 minutes to
160// roughly match full reports' durations.
161static const uint64_t TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS = 2 * 60 * 1000;
Colin Crossf45fa6b2012-03-26 12:38:26 -0700162
Felipe Leme1d486fe2016-10-14 18:06:47 -0700163// TODO: variables and functions below should be part of dumpstate object
164
Felipe Leme635ca312016-01-05 14:23:02 -0800165static std::set<std::string> mount_points;
166void add_mountinfo();
Felipe Leme78f2c862015-12-21 09:55:22 -0800167
Todd Poynor2a83daa2013-11-22 15:44:22 -0800168#define PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops"
Mark Salyzyn7d0a7622016-06-24 14:06:15 -0700169#define ALT_PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops-0"
Wei Wang509bb5d2017-06-09 14:42:12 -0700170#define BLK_DEV_SYS_DIR "/sys/block"
Todd Poynor2a83daa2013-11-22 15:44:22 -0800171
Felipe Lemee82a27d2016-01-05 13:35:44 -0800172#define RECOVERY_DIR "/cache/recovery"
Mark Salyzynd6ab0112016-03-25 12:56:39 -0700173#define RECOVERY_DATA_DIR "/data/misc/recovery"
Tianjie Xu75d53362018-04-11 16:42:28 -0700174#define UPDATE_ENGINE_LOG_DIR "/data/misc/update_engine_log"
Kelvin Zhang6eaa0f92022-09-12 09:29:19 -0700175#define UPDATE_ENGINE_PREF_DIR "/data/misc/update_engine/prefs"
Mark Salyzyn4d42dea2016-04-01 10:03:14 -0700176#define LOGPERSIST_DATA_DIR "/data/misc/logd"
Jerry Changa1df8a92020-01-02 16:03:39 +0800177#define PREREBOOT_DATA_DIR "/data/misc/prereboot"
David Brazdild2991962016-06-03 14:40:44 +0100178#define PROFILE_DATA_DIR_CUR "/data/misc/profiles/cur"
179#define PROFILE_DATA_DIR_REF "/data/misc/profiles/ref"
Benedict Wong8f9d8a42019-01-03 16:19:38 -0800180#define XFRM_STAT_PROC_FILE "/proc/net/xfrm_stat"
Steven Moreland9379c462023-12-21 02:04:27 +0000181#define KERNEL_CONFIG "/proc/config.gz"
Erik Kline08165202016-05-30 11:55:44 +0900182#define WLUTIL "/vendor/xbin/wlutil"
Vishnu Nair36b4cdb2017-11-17 10:27:05 -0800183#define WMTRACE_DATA_DIR "/data/misc/wmtrace"
Yifan Hong3945e1b2019-10-29 12:59:23 -0700184#define OTA_METADATA_DIR "/metadata/ota"
Yifan Hong0efa7972020-02-03 16:45:02 -0800185#define SNAPSHOTCTL_LOG_DIR "/data/misc/snapshotctl_log"
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +0900186#define LINKERCONFIG_DIR "/linkerconfig"
Calin Juravlef84d3692020-04-28 15:31:12 -0700187#define PACKAGE_DEX_USE_LIST "/data/system/package-dex-usage.list"
Primiano Tuccifaaaafb2021-01-14 12:26:29 +0000188#define SYSTEM_TRACE_SNAPSHOT "/data/misc/perfetto-traces/bugreport/systrace.pftrace"
Li Li2eedd412021-06-30 15:11:53 -0700189#define CGROUPFS_DIR "/sys/fs/cgroup"
Mårten Kongstad60195a72022-09-20 14:14:20 +0200190#define SDK_EXT_INFO "/apex/com.android.sdkext/bin/derive_sdk"
Jeff Sharkey9df29d52023-02-06 14:26:30 -0700191#define DROPBOX_DIR "/data/system/dropbox"
Mårten Kongstad5ad813f2023-09-28 10:09:18 +0200192#define PRINT_FLAGS "/system/bin/printflags"
Nattharat Jariyanuntanaetb250cae2024-05-15 07:48:19 +0000193#define UWB_LOG_DIR "/data/misc/apexdata/com.android.uwb/log"
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700194
Narayan Kamath8f788292017-05-25 13:20:39 +0100195// TODO(narayan): Since this information has to be kept in sync
196// with tombstoned, we should just put it in a common header.
197//
198// File: system/core/debuggerd/tombstoned/tombstoned.cpp
Narayan Kamathbd863722017-06-01 18:50:12 +0100199static const std::string TOMBSTONE_DIR = "/data/tombstones/";
200static const std::string TOMBSTONE_FILE_PREFIX = "tombstone_";
201static const std::string ANR_DIR = "/data/anr/";
202static const std::string ANR_FILE_PREFIX = "anr_";
Andy Hungd62f7e62024-01-11 15:47:52 -0800203static const std::string ANR_TRACE_FILE_PREFIX = "trace_";
Woody Lin20767a92022-11-29 15:50:24 +0800204static const std::string SHUTDOWN_CHECKPOINTS_DIR = "/data/system/shutdown-checkpoints/";
205static const std::string SHUTDOWN_CHECKPOINTS_FILE_PREFIX = "checkpoints-";
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700206
Felipe Lemee844a9d2016-09-21 15:01:39 -0700207// TODO: temporary variables and functions used during C++ refactoring
Nandana Dutt979388e2018-11-30 16:48:55 +0000208
Nandana Dutt5c390032019-03-12 10:52:56 +0000209#define RETURN_IF_USER_DENIED_CONSENT() \
210 if (ds.IsUserConsentDenied()) { \
211 MYLOGE("Returning early as user denied consent to share bugreport with calling app."); \
212 return Dumpstate::RunStatus::USER_CONSENT_DENIED; \
213 }
214
215// Runs func_ptr, but checks user consent before and after running it. Returns USER_CONSENT_DENIED
216// if consent is found to be denied.
217#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(func_ptr, ...) \
218 RETURN_IF_USER_DENIED_CONSENT(); \
219 func_ptr(__VA_ARGS__); \
220 RETURN_IF_USER_DENIED_CONSENT();
221
Rhed Jao5377d792020-07-16 17:37:39 +0800222// Runs func_ptr, and logs a duration report after it's finished.
223#define RUN_SLOW_FUNCTION_AND_LOG(log_title, func_ptr, ...) \
224 { \
225 DurationReporter duration_reporter_in_macro(log_title); \
226 func_ptr(__VA_ARGS__); \
227 }
228
229// Similar with RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK, an additional duration report
230// is output after a slow function is finished.
231#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(log_title, func_ptr, ...) \
232 RETURN_IF_USER_DENIED_CONSENT(); \
233 RUN_SLOW_FUNCTION_AND_LOG(log_title, func_ptr, __VA_ARGS__); \
234 RETURN_IF_USER_DENIED_CONSENT();
235
Chris Morinbc223142022-02-04 14:17:11 -0800236#define WAIT_TASK_WITH_CONSENT_CHECK(future) \
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800237 RETURN_IF_USER_DENIED_CONSENT(); \
Chris Morinbc223142022-02-04 14:17:11 -0800238 WaitForTask(future); \
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800239 RETURN_IF_USER_DENIED_CONSENT();
240
Sahana Raof35ed432019-07-12 10:47:52 +0100241static const char* WAKE_LOCK_NAME = "dumpstate_wakelock";
242
Rhed Jao5377d792020-07-16 17:37:39 +0800243// Names of parallel tasks, they are used for the DumpPool to identify the dump
244// task and the log title of the duration report.
245static const std::string DUMP_TRACES_TASK = "DUMP TRACES";
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800246static const std::string DUMP_INCIDENT_REPORT_TASK = "INCIDENT REPORT";
Aaron Huanga99452a2022-04-27 18:51:16 +0800247static const std::string DUMP_NETSTATS_PROTO_TASK = "DUMP NETSTATS PROTO";
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800248static const std::string DUMP_HALS_TASK = "DUMP HALS";
249static const std::string DUMP_BOARD_TASK = "dumpstate_board()";
Rhed Jaoe017f982020-07-21 17:58:41 +0800250static const std::string DUMP_CHECKINS_TASK = "DUMP CHECKINS";
Kean Mariotti306633e2022-09-05 16:30:47 +0000251static const std::string POST_PROCESS_UI_TRACES_TASK = "POST-PROCESS UI TRACES";
Rhed Jao5377d792020-07-16 17:37:39 +0800252
Nandana Dutt979388e2018-11-30 16:48:55 +0000253namespace android {
254namespace os {
255namespace {
256
257static int Open(std::string path, int flags, mode_t mode = 0) {
258 int fd = TEMP_FAILURE_RETRY(open(path.c_str(), flags, mode));
259 if (fd == -1) {
260 MYLOGE("open(%s, %s)\n", path.c_str(), strerror(errno));
261 }
262 return fd;
263}
264
mhasank2d75c442020-06-11 15:05:25 -0700265static int OpenForWrite(std::string path) {
266 return Open(path, O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
267 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH);
268}
Nandana Dutt979388e2018-11-30 16:48:55 +0000269
270static int OpenForRead(std::string path) {
271 return Open(path, O_RDONLY | O_CLOEXEC | O_NOFOLLOW);
272}
273
274bool CopyFile(int in_fd, int out_fd) {
275 char buf[4096];
276 ssize_t byte_count;
277 while ((byte_count = TEMP_FAILURE_RETRY(read(in_fd, buf, sizeof(buf)))) > 0) {
278 if (!android::base::WriteFully(out_fd, buf, byte_count)) {
279 return false;
280 }
281 }
282 return (byte_count != -1);
283}
284
285static bool CopyFileToFd(const std::string& input_file, int out_fd) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000286 MYLOGD("Going to copy file (%s) to %d\n", input_file.c_str(), out_fd);
Nandana Dutt979388e2018-11-30 16:48:55 +0000287
288 // Obtain a handle to the source file.
289 android::base::unique_fd in_fd(OpenForRead(input_file));
290 if (out_fd != -1 && in_fd.get() != -1) {
291 if (CopyFile(in_fd.get(), out_fd)) {
292 return true;
293 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000294 MYLOGE("Failed to copy file: %s\n", strerror(errno));
Nandana Dutt979388e2018-11-30 16:48:55 +0000295 }
296 return false;
297}
298
Nandana Duttd2f5f082019-01-18 17:13:52 +0000299static bool UnlinkAndLogOnError(const std::string& file) {
Nandana Dutt8ae16e62020-03-27 10:20:22 +0000300 if (file.empty()) {
301 return false;
302 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000303 if (unlink(file.c_str())) {
304 MYLOGE("Failed to unlink file (%s): %s\n", file.c_str(), strerror(errno));
Nandana Duttd2f5f082019-01-18 17:13:52 +0000305 return false;
306 }
307 return true;
308}
Nandana Dutt979388e2018-11-30 16:48:55 +0000309
Nikita Ioffea325a572019-05-16 19:49:47 +0100310int64_t GetModuleMetadataVersion() {
311 auto binder = defaultServiceManager()->getService(android::String16("package_native"));
312 if (binder == nullptr) {
313 MYLOGE("Failed to retrieve package_native service");
314 return 0L;
315 }
316 auto package_service = android::interface_cast<content::pm::IPackageManagerNative>(binder);
317 std::string package_name;
318 auto status = package_service->getModuleMetadataPackageName(&package_name);
319 if (!status.isOk()) {
320 MYLOGE("Failed to retrieve module metadata package name: %s", status.toString8().c_str());
321 return 0L;
322 }
Nandana Duttdb379fa2019-10-09 16:54:41 +0100323 MYLOGD("Module metadata package name: %s\n", package_name.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100324 int64_t version_code;
325 status = package_service->getVersionCodeForPackage(android::String16(package_name.c_str()),
326 &version_code);
327 if (!status.isOk()) {
328 MYLOGE("Failed to retrieve module metadata version: %s", status.toString8().c_str());
329 return 0L;
330 }
331 return version_code;
332}
333
mhasank2d75c442020-06-11 15:05:25 -0700334static bool PathExists(const std::string& path) {
335 struct stat sb;
336 return stat(path.c_str(), &sb) == 0;
337}
338
339static bool CopyFileToFile(const std::string& input_file, const std::string& output_file) {
340 if (input_file == output_file) {
341 MYLOGD("Skipping copying bugreport file since the destination is the same (%s)\n",
342 output_file.c_str());
343 return false;
344 }
345 else if (PathExists(output_file)) {
346 MYLOGD("Cannot overwrite an existing file (%s)\n", output_file.c_str());
347 return false;
348 }
349
350 MYLOGD("Going to copy bugreport file (%s) to %s\n", input_file.c_str(), output_file.c_str());
351 android::base::unique_fd out_fd(OpenForWrite(output_file));
352 return CopyFileToFd(input_file, out_fd.get());
353}
354
Nandana Dutt979388e2018-11-30 16:48:55 +0000355} // namespace
356} // namespace os
357} // namespace android
358
Felipe Leme678727a2016-09-21 17:22:11 -0700359static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
Felipe Lemebda15a02016-11-16 17:48:25 -0800360 const CommandOptions& options = Dumpstate::DEFAULT_DUMPSYS,
Rhed Jaoe017f982020-07-21 17:58:41 +0800361 long dumpsysTimeoutMs = 0, int out_fd = STDOUT_FILENO) {
362 return ds.RunDumpsys(title, dumpsysArgs, options, dumpsysTimeoutMs, out_fd);
363}
364static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
365 int out_fd) {
366 return ds.RunDumpsys(title, dumpsysArgs, Dumpstate::DEFAULT_DUMPSYS, 0, out_fd);
Felipe Leme678727a2016-09-21 17:22:11 -0700367}
368static int DumpFile(const std::string& title, const std::string& path) {
369 return ds.DumpFile(title, path);
370}
Felipe Lemee82a27d2016-01-05 13:35:44 -0800371
Felipe Lemee844a9d2016-09-21 15:01:39 -0700372// Relative directory (inside the zip) for all files copied as-is into the bugreport.
373static const std::string ZIP_ROOT_DIR = "FS";
374
Vishnu Naire97d6122018-01-18 13:58:56 -0800375static const std::string kProtoPath = "proto/";
376static const std::string kProtoExt = ".proto";
Jie Song9fbfad02017-06-20 16:29:42 -0700377static const std::string kDumpstateBoardFiles[] = {
378 "dumpstate_board.txt",
Felipe Leme95d6ca52017-08-01 16:35:56 -0700379 "dumpstate_board.bin"
Jie Song9fbfad02017-06-20 16:29:42 -0700380};
381static const int NUM_OF_DUMPS = arraysize(kDumpstateBoardFiles);
382
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700383static constexpr char PROPERTY_LAST_ID[] = "dumpstate.last_id";
Felipe Lemed071c682016-10-20 16:48:00 -0700384static constexpr char PROPERTY_VERSION[] = "dumpstate.version";
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700385
Felipe Lemef0292972016-11-22 13:57:05 -0800386static const CommandOptions AS_ROOT_20 = CommandOptions::WithTimeout(20).AsRoot().Build();
387
Narayan Kamath8f788292017-05-25 13:20:39 +0100388/*
Narayan Kamathbd863722017-06-01 18:50:12 +0100389 * Returns a vector of dump fds under |dir_path| with a given |file_prefix|.
Rhed Jao01dc0c62020-06-03 17:13:30 +0800390 * The returned vector is sorted by the mtimes of the dumps with descending
Chris Morinc2cba7a2022-02-01 17:06:50 -0800391 * order.
Narayan Kamath8f788292017-05-25 13:20:39 +0100392 */
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700393static std::vector<DumpData> GetDumpFds(const std::string& dir_path,
Chris Morinc2cba7a2022-02-01 17:06:50 -0800394 const std::string& file_prefix) {
Narayan Kamathbd863722017-06-01 18:50:12 +0100395 std::unique_ptr<DIR, decltype(&closedir)> dump_dir(opendir(dir_path.c_str()), closedir);
Narayan Kamath8f788292017-05-25 13:20:39 +0100396
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700397 if (dump_dir == nullptr) {
398 MYLOGW("Unable to open directory %s: %s\n", dir_path.c_str(), strerror(errno));
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700399 return std::vector<DumpData>();
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700400 }
401
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700402 std::vector<DumpData> dump_data;
Narayan Kamathbd863722017-06-01 18:50:12 +0100403 struct dirent* entry = nullptr;
404 while ((entry = readdir(dump_dir.get()))) {
405 if (entry->d_type != DT_REG) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100406 continue;
407 }
408
Narayan Kamathbd863722017-06-01 18:50:12 +0100409 const std::string base_name(entry->d_name);
410 if (base_name.find(file_prefix) != 0) {
411 continue;
412 }
413
414 const std::string abs_path = dir_path + base_name;
415 android::base::unique_fd fd(
416 TEMP_FAILURE_RETRY(open(abs_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW | O_NONBLOCK)));
417 if (fd == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700418 MYLOGW("Unable to open dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamathbd863722017-06-01 18:50:12 +0100419 break;
420 }
421
422 struct stat st = {};
423 if (fstat(fd, &st) == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700424 MYLOGW("Unable to stat dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamath8f788292017-05-25 13:20:39 +0100425 continue;
426 }
427
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700428 dump_data.emplace_back(DumpData{abs_path, std::move(fd), st.st_mtime});
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700429 }
Rhed Jao01dc0c62020-06-03 17:13:30 +0800430 if (!dump_data.empty()) {
431 std::sort(dump_data.begin(), dump_data.end(),
432 [](const auto& a, const auto& b) { return a.mtime > b.mtime; });
433 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100434
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700435 return dump_data;
Narayan Kamath8f788292017-05-25 13:20:39 +0100436}
437
Narayan Kamathbd863722017-06-01 18:50:12 +0100438static bool AddDumps(const std::vector<DumpData>::const_iterator start,
439 const std::vector<DumpData>::const_iterator end,
440 const char* type_name, const bool add_to_zip) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100441 bool dumped = false;
Narayan Kamathbd863722017-06-01 18:50:12 +0100442 for (auto it = start; it != end; ++it) {
443 const std::string& name = it->name;
444 const int fd = it->fd;
Narayan Kamath8f788292017-05-25 13:20:39 +0100445 dumped = true;
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100446
447 // Seek to the beginning of the file before dumping any data. A given
448 // DumpData entry might be dumped multiple times in the report.
449 //
450 // For example, the most recent ANR entry is dumped to the body of the
451 // main entry and it also shows up as a separate entry in the bugreport
452 // ZIP file.
453 if (lseek(fd, 0, SEEK_SET) != static_cast<off_t>(0)) {
454 MYLOGE("Unable to add %s to zip file, lseek failed: %s\n", name.c_str(),
455 strerror(errno));
456 }
457
Chris Morinc2cba7a2022-02-01 17:06:50 -0800458 if (add_to_zip) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800459 if (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + name, fd, /* timeout = */ 0ms) != OK) {
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100460 MYLOGE("Unable to add %s to zip file, addZipEntryFromFd failed\n", name.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100461 }
462 } else {
463 dump_file_from_fd(type_name, name.c_str(), fd);
464 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100465 }
466
467 return dumped;
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700468}
469
Felipe Leme635ca312016-01-05 14:23:02 -0800470// for_each_pid() callback to get mount info about a process.
Felipe Leme4c2d6632016-09-28 14:32:00 -0700471void do_mountinfo(int pid, const char* name __attribute__((unused))) {
Felipe Leme635ca312016-01-05 14:23:02 -0800472 char path[PATH_MAX];
473
474 // Gets the the content of the /proc/PID/ns/mnt link, so only unique mount points
475 // are added.
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700476 snprintf(path, sizeof(path), "/proc/%d/ns/mnt", pid);
Felipe Leme635ca312016-01-05 14:23:02 -0800477 char linkname[PATH_MAX];
478 ssize_t r = readlink(path, linkname, PATH_MAX);
479 if (r == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800480 MYLOGE("Unable to read link for %s: %s\n", path, strerror(errno));
Felipe Leme635ca312016-01-05 14:23:02 -0800481 return;
482 }
483 linkname[r] = '\0';
484
485 if (mount_points.find(linkname) == mount_points.end()) {
486 // First time this mount point was found: add it
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700487 snprintf(path, sizeof(path), "/proc/%d/mountinfo", pid);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700488 if (ds.AddZipEntry(ZIP_ROOT_DIR + path, path)) {
Felipe Leme635ca312016-01-05 14:23:02 -0800489 mount_points.insert(linkname);
490 } else {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800491 MYLOGE("Unable to add mountinfo %s to zip file\n", path);
Felipe Leme635ca312016-01-05 14:23:02 -0800492 }
493 }
494}
495
496void add_mountinfo() {
Felipe Leme678727a2016-09-21 17:22:11 -0700497 std::string title = "MOUNT INFO";
Felipe Leme635ca312016-01-05 14:23:02 -0800498 mount_points.clear();
Felipe Leme46b85da2016-11-21 17:40:45 -0800499 DurationReporter duration_reporter(title, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700500 for_each_pid(do_mountinfo, nullptr);
501 MYLOGD("%s: %d entries added to zip file\n", title.c_str(), (int)mount_points.size());
Felipe Leme635ca312016-01-05 14:23:02 -0800502}
503
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700504static void dump_dev_files(const char *title, const char *driverpath, const char *filename)
505{
506 DIR *d;
507 struct dirent *de;
508 char path[PATH_MAX];
509
510 d = opendir(driverpath);
Yi Kong19d5c002018-07-20 13:39:55 -0700511 if (d == nullptr) {
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700512 return;
513 }
514
515 while ((de = readdir(d))) {
516 if (de->d_type != DT_LNK) {
517 continue;
518 }
519 snprintf(path, sizeof(path), "%s/%s/%s", driverpath, de->d_name, filename);
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700520 DumpFile(title, path);
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700521 }
522
523 closedir(d);
524}
525
Mark Salyzyn326842f2015-04-30 09:49:41 -0700526static bool skip_not_stat(const char *path) {
527 static const char stat[] = "/stat";
528 size_t len = strlen(path);
529 if (path[len - 1] == '/') { /* Directory? */
530 return false;
531 }
532 return strcmp(path + len - sizeof(stat) + 1, stat); /* .../stat? */
533}
534
Jeff Sharkey9df29d52023-02-06 14:26:30 -0700535static bool skip_wtf_strictmode(const char *path) {
536 if (strstr(path, "_wtf")) {
537 return true;
538 } else if (strstr(path, "_strictmode")) {
539 return true;
540 }
541 return false;
542}
543
Felipe Leme4c2d6632016-09-28 14:32:00 -0700544static bool skip_none(const char* path __attribute__((unused))) {
Felipe Lemee82a27d2016-01-05 13:35:44 -0800545 return false;
546}
547
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700548unsigned long worst_write_perf = 20000; /* in KB/s */
Mark Salyzyn326842f2015-04-30 09:49:41 -0700549
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800550//
551// stat offsets
552// Name units description
553// ---- ----- -----------
554// read I/Os requests number of read I/Os processed
555#define __STAT_READ_IOS 0
556// read merges requests number of read I/Os merged with in-queue I/O
557#define __STAT_READ_MERGES 1
558// read sectors sectors number of sectors read
559#define __STAT_READ_SECTORS 2
560// read ticks milliseconds total wait time for read requests
561#define __STAT_READ_TICKS 3
562// write I/Os requests number of write I/Os processed
563#define __STAT_WRITE_IOS 4
564// write merges requests number of write I/Os merged with in-queue I/O
565#define __STAT_WRITE_MERGES 5
566// write sectors sectors number of sectors written
567#define __STAT_WRITE_SECTORS 6
568// write ticks milliseconds total wait time for write requests
569#define __STAT_WRITE_TICKS 7
570// in_flight requests number of I/Os currently in flight
571#define __STAT_IN_FLIGHT 8
572// io_ticks milliseconds total time this block device has been active
573#define __STAT_IO_TICKS 9
574// time_in_queue milliseconds total wait time for all requests
575#define __STAT_IN_QUEUE 10
576#define __STAT_NUMBER_FIELD 11
577//
578// read I/Os, write I/Os
579// =====================
580//
581// These values increment when an I/O request completes.
582//
583// read merges, write merges
584// =========================
585//
586// These values increment when an I/O request is merged with an
587// already-queued I/O request.
588//
589// read sectors, write sectors
590// ===========================
591//
592// These values count the number of sectors read from or written to this
593// block device. The "sectors" in question are the standard UNIX 512-byte
594// sectors, not any device- or filesystem-specific block size. The
595// counters are incremented when the I/O completes.
596#define SECTOR_SIZE 512
597//
598// read ticks, write ticks
599// =======================
600//
601// These values count the number of milliseconds that I/O requests have
602// waited on this block device. If there are multiple I/O requests waiting,
603// these values will increase at a rate greater than 1000/second; for
604// example, if 60 read requests wait for an average of 30 ms, the read_ticks
605// field will increase by 60*30 = 1800.
606//
607// in_flight
608// =========
609//
610// This value counts the number of I/O requests that have been issued to
611// the device driver but have not yet completed. It does not include I/O
612// requests that are in the queue but not yet issued to the device driver.
613//
614// io_ticks
615// ========
616//
617// This value counts the number of milliseconds during which the device has
618// had I/O requests queued.
619//
620// time_in_queue
621// =============
622//
623// This value counts the number of milliseconds that I/O requests have waited
624// on this block device. If there are multiple I/O requests waiting, this
625// value will increase as the product of the number of milliseconds times the
626// number of requests waiting (see "read ticks" above for an example).
627#define S_TO_MS 1000
628//
629
Mark Salyzyn326842f2015-04-30 09:49:41 -0700630static int dump_stat_from_fd(const char *title __unused, const char *path, int fd) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800631 unsigned long long fields[__STAT_NUMBER_FIELD];
Mark Salyzyn326842f2015-04-30 09:49:41 -0700632 bool z;
Yi Kong19d5c002018-07-20 13:39:55 -0700633 char *cp, *buffer = nullptr;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700634 size_t i = 0;
Josh Gao7c4258c2018-06-25 13:40:08 -0700635 FILE *fp = fdopen(dup(fd), "rb");
Mark Salyzyn326842f2015-04-30 09:49:41 -0700636 getline(&buffer, &i, fp);
637 fclose(fp);
638 if (!buffer) {
639 return -errno;
640 }
641 i = strlen(buffer);
642 while ((i > 0) && (buffer[i - 1] == '\n')) {
643 buffer[--i] = '\0';
644 }
645 if (!*buffer) {
646 free(buffer);
647 return 0;
648 }
649 z = true;
650 for (cp = buffer, i = 0; i < (sizeof(fields) / sizeof(fields[0])); ++i) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800651 fields[i] = strtoull(cp, &cp, 10);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700652 if (fields[i] != 0) {
653 z = false;
654 }
655 }
656 if (z) { /* never accessed */
657 free(buffer);
658 return 0;
659 }
660
Wei Wang509bb5d2017-06-09 14:42:12 -0700661 if (!strncmp(path, BLK_DEV_SYS_DIR, sizeof(BLK_DEV_SYS_DIR) - 1)) {
662 path += sizeof(BLK_DEV_SYS_DIR) - 1;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700663 }
Wei Wang1dc1ef52017-06-12 11:28:37 -0700664
665 printf("%-30s:%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s\n%-30s:\t%s\n", "Block-Dev",
666 "R-IOs", "R-merg", "R-sect", "R-wait", "W-IOs", "W-merg", "W-sect",
667 "W-wait", "in-fli", "activ", "T-wait", path, buffer);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700668 free(buffer);
669
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800670 if (fields[__STAT_IO_TICKS]) {
671 unsigned long read_perf = 0;
672 unsigned long read_ios = 0;
673 if (fields[__STAT_READ_TICKS]) {
674 unsigned long long divisor = fields[__STAT_READ_TICKS]
675 * fields[__STAT_IO_TICKS];
676 read_perf = ((unsigned long long)SECTOR_SIZE
677 * fields[__STAT_READ_SECTORS]
678 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
679 / divisor;
680 read_ios = ((unsigned long long)S_TO_MS * fields[__STAT_READ_IOS]
681 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
682 / divisor;
683 }
684
685 unsigned long write_perf = 0;
686 unsigned long write_ios = 0;
687 if (fields[__STAT_WRITE_TICKS]) {
688 unsigned long long divisor = fields[__STAT_WRITE_TICKS]
689 * fields[__STAT_IO_TICKS];
690 write_perf = ((unsigned long long)SECTOR_SIZE
691 * fields[__STAT_WRITE_SECTORS]
692 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
693 / divisor;
694 write_ios = ((unsigned long long)S_TO_MS * fields[__STAT_WRITE_IOS]
695 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
696 / divisor;
697 }
698
699 unsigned queue = (fields[__STAT_IN_QUEUE]
700 + (fields[__STAT_IO_TICKS] >> 1))
701 / fields[__STAT_IO_TICKS];
702
703 if (!write_perf && !write_ios) {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700704 printf("%-30s: perf(ios) rd: %luKB/s(%lu/s) q: %u\n", path, read_perf, read_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800705 } else {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700706 printf("%-30s: perf(ios) rd: %luKB/s(%lu/s) wr: %luKB/s(%lu/s) q: %u\n", path, read_perf,
Felipe Lemed8b94e52016-12-08 10:21:44 -0800707 read_ios, write_perf, write_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800708 }
709
710 /* bugreport timeout factor adjustment */
711 if ((write_perf > 1) && (write_perf < worst_write_perf)) {
712 worst_write_perf = write_perf;
713 }
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700714 }
Mark Salyzyn326842f2015-04-30 09:49:41 -0700715 return 0;
716}
717
Yao Chenbe3bbc12018-01-17 16:31:10 -0800718static const long MINIMUM_LOGCAT_TIMEOUT_MS = 50000;
719
Tom Cherryf4472f32020-08-05 09:31:17 -0700720// Returns the actual readable size of the given buffer or -1 on error.
721static long logcat_buffer_readable_size(const std::string& buffer) {
722 std::unique_ptr<logger_list, decltype(&android_logger_list_free)> logger_list{
723 android_logger_list_alloc(0, 0, 0), &android_logger_list_free};
724 auto logger = android_logger_open(logger_list.get(), android_name_to_log_id(buffer.c_str()));
725
726 return android_logger_get_log_readable_size(logger);
727}
728
729// Returns timeout in ms to read a list of buffers.
Yao Chenbe3bbc12018-01-17 16:31:10 -0800730static unsigned long logcat_timeout(const std::vector<std::string>& buffers) {
731 unsigned long timeout_ms = 0;
732 for (const auto& buffer : buffers) {
Tom Cherryf4472f32020-08-05 09:31:17 -0700733 long readable_size = logcat_buffer_readable_size(buffer);
734 if (readable_size > 0) {
735 // Engineering margin is ten-fold our guess.
736 timeout_ms += 10 * (readable_size + worst_write_perf) / worst_write_perf;
737 }
Yao Chenbe3bbc12018-01-17 16:31:10 -0800738 }
739 return timeout_ms > MINIMUM_LOGCAT_TIMEOUT_MS ? timeout_ms : MINIMUM_LOGCAT_TIMEOUT_MS;
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700740}
741
Dieter Hsu105ad0c2020-09-29 15:23:33 +0800742// Opens a socket and returns its file descriptor.
743static int open_socket(const char* service);
744
Nandana Duttd2f5f082019-01-18 17:13:52 +0000745Dumpstate::ConsentCallback::ConsentCallback() : result_(UNAVAILABLE), start_time_(Nanotime()) {
746}
747
748android::binder::Status Dumpstate::ConsentCallback::onReportApproved() {
749 std::lock_guard<std::mutex> lock(lock_);
750 result_ = APPROVED;
751 MYLOGD("User approved consent to share bugreport\n");
Paul Chang0d2aad72020-02-13 20:04:03 +0800752
753 // Maybe copy screenshot so calling app can display the screenshot to the user as soon as
754 // consent is granted.
755 if (ds.options_->is_screenshot_copied) {
756 return android::binder::Status::ok();
757 }
758
759 if (!ds.options_->do_screenshot || ds.options_->screenshot_fd.get() == -1 ||
760 !ds.do_early_screenshot_) {
761 return android::binder::Status::ok();
762 }
763
764 bool copy_succeeded = android::os::CopyFileToFd(ds.screenshot_path_,
765 ds.options_->screenshot_fd.get());
766 ds.options_->is_screenshot_copied = copy_succeeded;
767 if (copy_succeeded) {
768 android::os::UnlinkAndLogOnError(ds.screenshot_path_);
769 }
Nandana Duttd2f5f082019-01-18 17:13:52 +0000770 return android::binder::Status::ok();
771}
772
773android::binder::Status Dumpstate::ConsentCallback::onReportDenied() {
774 std::lock_guard<std::mutex> lock(lock_);
775 result_ = DENIED;
776 MYLOGW("User denied consent to share bugreport\n");
777 return android::binder::Status::ok();
778}
779
780UserConsentResult Dumpstate::ConsentCallback::getResult() {
781 std::lock_guard<std::mutex> lock(lock_);
782 return result_;
783}
784
785uint64_t Dumpstate::ConsentCallback::getElapsedTimeMs() const {
Hunter Knepshieldf0a39052020-01-03 14:53:04 -0800786 return (Nanotime() - start_time_) / NANOS_PER_MILLI;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000787}
788
Felipe Leme2b9b06c2016-10-14 09:13:06 -0700789void Dumpstate::PrintHeader() const {
Mårten Kongstad60195a72022-09-20 14:14:20 +0200790 std::string build, fingerprint, radio, bootloader, network, sdkversion;
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700791 char date[80];
Colin Crossf45fa6b2012-03-26 12:38:26 -0700792
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700793 build = android::base::GetProperty("ro.build.display.id", "(unknown)");
794 fingerprint = android::base::GetProperty("ro.build.fingerprint", "(unknown)");
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700795 radio = android::base::GetProperty("gsm.version.baseband", "(unknown)");
796 bootloader = android::base::GetProperty("ro.bootloader", "(unknown)");
797 network = android::base::GetProperty("gsm.operator.alpha", "(unknown)");
Mårten Kongstad60195a72022-09-20 14:14:20 +0200798 sdkversion = android::base::GetProperty("ro.build.version.sdk", "(unknown)");
Felipe Lemebbaf3c12016-10-11 14:32:25 -0700799 strftime(date, sizeof(date), "%Y-%m-%d %H:%M:%S", localtime(&now_));
Colin Crossf45fa6b2012-03-26 12:38:26 -0700800
Felipe Lemed8b94e52016-12-08 10:21:44 -0800801 printf("========================================================\n");
802 printf("== dumpstate: %s\n", date);
803 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -0700804
Felipe Lemed8b94e52016-12-08 10:21:44 -0800805 printf("\n");
806 printf("Build: %s\n", build.c_str());
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700807 // NOTE: fingerprint entry format is important for other tools.
Felipe Lemed8b94e52016-12-08 10:21:44 -0800808 printf("Build fingerprint: '%s'\n", fingerprint.c_str());
809 printf("Bootloader: %s\n", bootloader.c_str());
810 printf("Radio: %s\n", radio.c_str());
811 printf("Network: %s\n", network.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100812 int64_t module_metadata_version = android::os::GetModuleMetadataVersion();
813 if (module_metadata_version != 0) {
814 printf("Module Metadata version: %" PRId64 "\n", module_metadata_version);
815 }
Mårten Kongstad60195a72022-09-20 14:14:20 +0200816 printf("Android SDK version: %s\n", sdkversion.c_str());
817 printf("SDK extensions: ");
818 RunCommandToFd(STDOUT_FILENO, "", {SDK_EXT_INFO, "--header"},
819 CommandOptions::WithTimeout(1).Always().DropRoot().Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -0700820
Felipe Lemed8b94e52016-12-08 10:21:44 -0800821 printf("Kernel: ");
Felipe Lemef0292972016-11-22 13:57:05 -0800822 DumpFileToFd(STDOUT_FILENO, "", "/proc/version");
Felipe Lemed8b94e52016-12-08 10:21:44 -0800823 printf("Command line: %s\n", strtok(cmdline_buf, "\n"));
Devin Moore09fde8d2023-03-21 16:28:22 +0000824 printf("Bootconfig: ");
825 DumpFileToFd(STDOUT_FILENO, "", "/proc/bootconfig");
Felipe Leme7709f8a2017-12-05 09:30:09 -0800826 printf("Uptime: ");
827 RunCommandToFd(STDOUT_FILENO, "", {"uptime", "-p"},
828 CommandOptions::WithTimeout(1).Always().Build());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800829 printf("Bugreport format version: %s\n", version_.c_str());
Kevin Jeonfa64e642023-07-27 11:36:41 -0400830 printf(
831 "Dumpstate info: id=%d pid=%d dry_run=%d parallel_run=%d strict_run=%d args=%s "
832 "bugreport_mode=%s\n",
833 id_, pid_, PropertiesHelper::IsDryRun(), PropertiesHelper::IsParallelRun(),
834 PropertiesHelper::IsStrictRun(), options_->args.c_str(),
835 options_->bugreport_mode_string.c_str());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800836 printf("\n");
Felipe Leme78f2c862015-12-21 09:55:22 -0800837}
838
Felipe Leme24b66ee2016-06-16 10:55:26 -0700839// List of file extensions that can cause a zip file attachment to be rejected by some email
840// service providers.
841static const std::set<std::string> PROBLEMATIC_FILE_EXTENSIONS = {
842 ".ade", ".adp", ".bat", ".chm", ".cmd", ".com", ".cpl", ".exe", ".hta", ".ins", ".isp",
843 ".jar", ".jse", ".lib", ".lnk", ".mde", ".msc", ".msp", ".mst", ".pif", ".scr", ".sct",
844 ".shb", ".sys", ".vb", ".vbe", ".vbs", ".vxd", ".wsc", ".wsf", ".wsh"
845};
846
Vishnu Naire97d6122018-01-18 13:58:56 -0800847status_t Dumpstate::AddZipEntryFromFd(const std::string& entry_name, int fd,
848 std::chrono::milliseconds timeout = 0ms) {
Felipe Leme24b66ee2016-06-16 10:55:26 -0700849 std::string valid_name = entry_name;
850
851 // Rename extension if necessary.
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -0700852 size_t idx = entry_name.rfind('.');
Felipe Leme24b66ee2016-06-16 10:55:26 -0700853 if (idx != std::string::npos) {
854 std::string extension = entry_name.substr(idx);
855 std::transform(extension.begin(), extension.end(), extension.begin(), ::tolower);
856 if (PROBLEMATIC_FILE_EXTENSIONS.count(extension) != 0) {
857 valid_name = entry_name + ".renamed";
858 MYLOGI("Renaming entry %s to %s\n", entry_name.c_str(), valid_name.c_str());
859 }
860 }
861
Felipe Leme6fe9db62016-02-12 09:04:16 -0800862 // Logging statement below is useful to time how long each entry takes, but it's too verbose.
863 // MYLOGD("Adding zip entry %s\n", entry_name.c_str());
Kevin Jeon9bbe0ac2022-05-05 22:05:43 +0000864 size_t flags = ZipWriter::kCompress | ZipWriter::kDefaultCompression;
865 int32_t err = zip_writer_->StartEntryWithTime(valid_name.c_str(), flags,
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700866 get_mtime(fd, ds.now_));
Felipe Leme1d486fe2016-10-14 18:06:47 -0700867 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700868 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", valid_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700869 ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800870 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800871 }
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000872 bool finished_entry = false;
873 auto finish_entry = [this, &finished_entry] {
874 if (!finished_entry) {
875 // This should only be called when we're going to return an earlier error,
876 // which would've been logged. This may imply the file is already corrupt
877 // and any further logging from FinishEntry is more likely to mislead than
878 // not.
879 this->zip_writer_->FinishEntry();
880 }
881 };
882 auto scope_guard = android::base::make_scope_guard(finish_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -0800883 auto start = std::chrono::steady_clock::now();
884 auto end = start + timeout;
885 struct pollfd pfd = {fd, POLLIN};
Felipe Lemee82a27d2016-01-05 13:35:44 -0800886
Felipe Leme770410d2016-01-26 17:07:14 -0800887 std::vector<uint8_t> buffer(65536);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800888 while (1) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800889 if (timeout.count() > 0) {
890 // lambda to recalculate the timeout.
891 auto time_left_ms = [end]() {
892 auto now = std::chrono::steady_clock::now();
893 auto diff = std::chrono::duration_cast<std::chrono::milliseconds>(end - now);
894 return std::max(diff.count(), 0LL);
895 };
896
897 int rc = TEMP_FAILURE_RETRY(poll(&pfd, 1, time_left_ms()));
898 if (rc < 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000899 MYLOGE("Error in poll while adding from fd to zip entry %s:%s\n",
900 entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800901 return -errno;
902 } else if (rc == 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000903 MYLOGE("Timed out adding from fd to zip entry %s:%s Timeout:%lldms\n",
Vishnu Naire97d6122018-01-18 13:58:56 -0800904 entry_name.c_str(), strerror(errno), timeout.count());
905 return TIMED_OUT;
906 }
907 }
908
Zach Riggle22200402016-08-18 01:01:24 -0400909 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800910 if (bytes_read == 0) {
911 break;
912 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800913 MYLOGE("read(%s): %s\n", entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800914 return -errno;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800915 }
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700916 err = zip_writer_->WriteBytes(buffer.data(), bytes_read);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800917 if (err) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700918 MYLOGE("zip_writer_->WriteBytes(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800919 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800920 }
921 }
922
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700923 err = zip_writer_->FinishEntry();
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000924 finished_entry = true;
Felipe Leme1d486fe2016-10-14 18:06:47 -0700925 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700926 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800927 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800928 }
929
Vishnu Naire97d6122018-01-18 13:58:56 -0800930 return OK;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800931}
932
Felipe Leme1d486fe2016-10-14 18:06:47 -0700933bool Dumpstate::AddZipEntry(const std::string& entry_name, const std::string& entry_path) {
934 android::base::unique_fd fd(
935 TEMP_FAILURE_RETRY(open(entry_path.c_str(), O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
Andreas Gampeaff68432016-07-18 18:01:27 -0700936 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800937 MYLOGE("open(%s): %s\n", entry_path.c_str(), strerror(errno));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800938 return false;
939 }
940
Vishnu Naire97d6122018-01-18 13:58:56 -0800941 return (AddZipEntryFromFd(entry_name, fd.get()) == OK);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800942}
943
944/* adds a file to the existing zipped bugreport */
Felipe Leme4c2d6632016-09-28 14:32:00 -0700945static int _add_file_from_fd(const char* title __attribute__((unused)), const char* path, int fd) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800946 return (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + path, fd) == OK) ? 0 : 1;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800947}
948
Felipe Leme1d486fe2016-10-14 18:06:47 -0700949void Dumpstate::AddDir(const std::string& dir, bool recursive) {
Felipe Leme678727a2016-09-21 17:22:11 -0700950 MYLOGD("Adding dir %s (recursive: %d)\n", dir.c_str(), recursive);
Felipe Leme46b85da2016-11-21 17:40:45 -0800951 DurationReporter duration_reporter(dir, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700952 dump_files("", dir.c_str(), recursive ? skip_none : is_dir, _add_file_from_fd);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800953}
954
Felipe Leme1d486fe2016-10-14 18:06:47 -0700955bool Dumpstate::AddTextZipEntry(const std::string& entry_name, const std::string& content) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800956 MYLOGD("Adding zip text entry %s\n", entry_name.c_str());
Kevin Jeon9bbe0ac2022-05-05 22:05:43 +0000957 size_t flags = ZipWriter::kCompress | ZipWriter::kDefaultCompression;
958 int32_t err = zip_writer_->StartEntryWithTime(entry_name.c_str(), flags, ds.now_);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700959 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700960 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700961 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800962 return false;
963 }
964
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700965 err = zip_writer_->WriteBytes(content.c_str(), content.length());
Felipe Leme1d486fe2016-10-14 18:06:47 -0700966 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700967 MYLOGE("zip_writer_->WriteBytes(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700968 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800969 return false;
970 }
971
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700972 err = zip_writer_->FinishEntry();
Felipe Leme1d486fe2016-10-14 18:06:47 -0700973 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700974 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800975 return false;
976 }
977
978 return true;
979}
980
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800981static void DoKmsg() {
982 struct stat st;
983 if (!stat(PSTORE_LAST_KMSG, &st)) {
984 /* Also TODO: Make console-ramoops CAP_SYSLOG protected. */
985 DumpFile("LAST KMSG", PSTORE_LAST_KMSG);
986 } else if (!stat(ALT_PSTORE_LAST_KMSG, &st)) {
987 DumpFile("LAST KMSG", ALT_PSTORE_LAST_KMSG);
988 } else {
989 /* TODO: Make last_kmsg CAP_SYSLOG protected. b/5555691 */
990 DumpFile("LAST KMSG", "/proc/last_kmsg");
991 }
992}
993
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800994static void DoKernelLogcat() {
Yao Chenbe3bbc12018-01-17 16:31:10 -0800995 unsigned long timeout_ms = logcat_timeout({"kernel"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800996 RunCommand(
997 "KERNEL LOG",
998 {"logcat", "-b", "kernel", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
999 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1000}
1001
Nandana Duttdb379fa2019-10-09 16:54:41 +01001002static void DoSystemLogcat(time_t since) {
1003 char since_str[80];
1004 strftime(since_str, sizeof(since_str), "%Y-%m-%d %H:%M:%S.000", localtime(&since));
1005
1006 unsigned long timeout_ms = logcat_timeout({"main", "system", "crash"});
1007 RunCommand("SYSTEM LOG",
1008 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v", "-T",
1009 since_str},
1010 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1011}
1012
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001013static void DoRadioLogcat() {
1014 unsigned long timeout_ms = logcat_timeout({"radio"});
1015 RunCommand(
1016 "RADIO LOG",
1017 {"logcat", "-b", "radio", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1018 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
1019}
1020
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001021static void DoLogcat() {
Vishnu Nair6921f802017-11-22 09:17:23 -08001022 unsigned long timeout_ms;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001023 // DumpFile("EVENT LOG TAGS", "/etc/event-log-tags");
1024 // calculate timeout
Yao Chenbe3bbc12018-01-17 16:31:10 -08001025 timeout_ms = logcat_timeout({"main", "system", "crash"});
Tony Makae737652017-03-30 17:47:09 +01001026 RunCommand("SYSTEM LOG",
Vishnu Nair6921f802017-11-22 09:17:23 -08001027 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1028 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -08001029 timeout_ms = logcat_timeout({"events"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001030 RunCommand(
1031 "EVENT LOG",
1032 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001033 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Yao Chenbe3bbc12018-01-17 16:31:10 -08001034 timeout_ms = logcat_timeout({"stats"});
1035 RunCommand(
1036 "STATS LOG",
1037 {"logcat", "-b", "stats", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001038 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001039 DoRadioLogcat();
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001040
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001041 /* kernels must set CONFIG_PSTORE_PMSG, slice up pstore with device tree */
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001042 RunCommand("LAST LOGCAT", {"logcat", "-L", "-b", "all", "-v", "threadtime", "-v", "printable",
1043 "-v", "uid", "-d", "*:v"});
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001044}
1045
Mike Ma5c267872019-08-21 11:31:34 -07001046static void DumpIncidentReport() {
Mike Ma5c267872019-08-21 11:31:34 -07001047 const std::string path = ds.bugreport_internal_dir_ + "/tmp_incident_report";
1048 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1049 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1050 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1051 if (fd < 0) {
1052 MYLOGE("Could not open %s to dump incident report.\n", path.c_str());
1053 return;
1054 }
Kevin Jeonfa64e642023-07-27 11:36:41 -04001055 RunCommandToFd(fd, "", {"incident", "-u"},
1056 CommandOptions::WithTimeout(PropertiesHelper::IsStrictRun() ? 20 : 120).Build());
Mike Ma5c267872019-08-21 11:31:34 -07001057 bool empty = 0 == lseek(fd, 0, SEEK_END);
1058 if (!empty) {
1059 // Use a different name from "incident.proto"
1060 // /proto/incident.proto is reserved for incident service dump
1061 // i.e. metadata for debugging.
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001062 ds.EnqueueAddZipEntryAndCleanupIfNeeded(kProtoPath + "incident_report" + kProtoExt,
1063 path);
1064 } else {
1065 unlink(path.c_str());
Mike Ma5c267872019-08-21 11:31:34 -07001066 }
Mike Ma5c267872019-08-21 11:31:34 -07001067}
1068
Aaron Huanga99452a2022-04-27 18:51:16 +08001069static void DumpNetstatsProto() {
1070 const std::string path = ds.bugreport_internal_dir_ + "/tmp_netstats_proto";
1071 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1072 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1073 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1074 if (fd < 0) {
1075 MYLOGE("Could not open %s to dump netstats proto.\n", path.c_str());
1076 return;
1077 }
1078 RunCommandToFd(fd, "", {"dumpsys", "netstats", "--proto"},
Kevin Jeon2fb3dd62022-09-28 18:48:55 +00001079 CommandOptions::WithTimeout(5).Build());
Aaron Huanga99452a2022-04-27 18:51:16 +08001080 bool empty = 0 == lseek(fd, 0, SEEK_END);
1081 if (!empty) {
1082 ds.EnqueueAddZipEntryAndCleanupIfNeeded(kProtoPath + "netstats" + kProtoExt,
1083 path);
1084 } else {
1085 unlink(path.c_str());
1086 }
1087}
1088
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001089static void MaybeAddSystemTraceToZip() {
1090 // This function copies into the .zip the system trace that was snapshotted
1091 // by the early call to MaybeSnapshotSystemTrace(), if any background
1092 // tracing was happening.
Kean Mariotti853b73a2023-07-27 12:40:30 +00001093 bool system_trace_exists = access(SYSTEM_TRACE_SNAPSHOT, F_OK) == 0;
1094 if (!system_trace_exists) {
1095 // No background trace was happening at the time MaybeSnapshotSystemTrace() was invoked.
1096 if (!PropertiesHelper::IsUserBuild()) {
1097 MYLOGI(
1098 "No system traces found. Check for previously uploaded traces by looking for "
1099 "go/trace-uuid in logcat")
1100 }
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001101 return;
1102 }
1103 ds.AddZipEntry(
1104 ZIP_ROOT_DIR + SYSTEM_TRACE_SNAPSHOT,
1105 SYSTEM_TRACE_SNAPSHOT);
1106 android::os::UnlinkAndLogOnError(SYSTEM_TRACE_SNAPSHOT);
1107}
1108
Sunny Goyal35949782019-11-19 15:54:36 -08001109static void DumpVisibleWindowViews() {
Sunny Goyal35949782019-11-19 15:54:36 -08001110 DurationReporter duration_reporter("VISIBLE WINDOW VIEWS");
1111 const std::string path = ds.bugreport_internal_dir_ + "/tmp_visible_window_views";
1112 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1113 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1114 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1115 if (fd < 0) {
1116 MYLOGE("Could not open %s to dump visible views.\n", path.c_str());
1117 return;
1118 }
1119 RunCommandToFd(fd, "", {"cmd", "window", "dump-visible-window-views"},
Kevin Jeon774abde2022-09-28 18:20:43 +00001120 CommandOptions::WithTimeout(10).Build());
Sunny Goyal35949782019-11-19 15:54:36 -08001121 bool empty = 0 == lseek(fd, 0, SEEK_END);
1122 if (!empty) {
1123 ds.AddZipEntry("visible_windows.zip", path);
1124 } else {
1125 MYLOGW("Failed to dump visible windows\n");
1126 }
1127 unlink(path.c_str());
1128}
1129
Jayachandran Ca94c7172017-06-10 15:08:12 -07001130static void DumpIpTablesAsRoot() {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001131 RunCommand("IPTABLES", {"iptables", "-L", "-nvx"});
1132 RunCommand("IP6TABLES", {"ip6tables", "-L", "-nvx"});
Erik Kline32af8c22016-09-28 17:26:26 +09001133 RunCommand("IPTABLES NAT", {"iptables", "-t", "nat", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001134 /* no ip6 nat */
Erik Kline32af8c22016-09-28 17:26:26 +09001135 RunCommand("IPTABLES MANGLE", {"iptables", "-t", "mangle", "-L", "-nvx"});
1136 RunCommand("IP6TABLES MANGLE", {"ip6tables", "-t", "mangle", "-L", "-nvx"});
1137 RunCommand("IPTABLES RAW", {"iptables", "-t", "raw", "-L", "-nvx"});
1138 RunCommand("IP6TABLES RAW", {"ip6tables", "-t", "raw", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001139}
1140
Woody Lin20767a92022-11-29 15:50:24 +08001141static void DumpShutdownCheckpoints() {
1142 const bool shutdown_checkpoints_dumped = AddDumps(
1143 ds.shutdown_checkpoints_.begin(), ds.shutdown_checkpoints_.end(),
1144 "SHUTDOWN CHECKPOINTS", false /* add_to_zip */);
1145 if (!shutdown_checkpoints_dumped) {
1146 printf("*** NO SHUTDOWN CHECKPOINTS to dump in %s\n\n",
1147 SHUTDOWN_CHECKPOINTS_DIR.c_str());
1148 }
1149}
1150
David Andersond9ba4752018-12-11 18:26:59 -08001151static void DumpDynamicPartitionInfo() {
1152 if (!::android::base::GetBoolProperty("ro.boot.dynamic_partitions", false)) {
1153 return;
1154 }
1155
1156 RunCommand("LPDUMP", {"lpdump", "--all"});
David Anderson6650ade2019-10-02 15:18:59 -07001157 RunCommand("DEVICE-MAPPER", {"gsid", "dump-device-mapper"});
David Andersond9ba4752018-12-11 18:26:59 -08001158}
1159
Chris Morin5a50d482022-02-01 17:41:18 -08001160static void AddAnrTraceDir(const std::string& anr_traces_dir) {
Narayan Kamath8f788292017-05-25 13:20:39 +01001161 MYLOGD("AddAnrTraceDir(): dump_traces_file=%s, anr_traces_dir=%s\n", dump_traces_path,
1162 anr_traces_dir.c_str());
1163
1164 // If we're here, dump_traces_path will always be a temporary file
1165 // (created with mkostemp or similar) that contains dumps taken earlier
1166 // on in the process.
1167 if (dump_traces_path != nullptr) {
Chris Morin5a50d482022-02-01 17:41:18 -08001168 MYLOGD("Dumping current ANR traces (%s) to the main bugreport entry\n",
1169 dump_traces_path);
1170 ds.DumpFile("VM TRACES JUST NOW", dump_traces_path);
Narayan Kamath8f788292017-05-25 13:20:39 +01001171
1172 const int ret = unlink(dump_traces_path);
1173 if (ret == -1) {
1174 MYLOGW("Error unlinking temporary trace path %s: %s\n", dump_traces_path,
1175 strerror(errno));
Felipe Lemee184f662016-10-27 10:04:47 -07001176 }
1177 }
1178
Narayan Kamathbd863722017-06-01 18:50:12 +01001179 // Add a specific message for the first ANR Dump.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001180 if (ds.anr_data_.size() > 0) {
Chris Morin5a50d482022-02-01 17:41:18 -08001181 // The "last" ANR will always be present in the body of the main entry.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001182 AddDumps(ds.anr_data_.begin(), ds.anr_data_.begin() + 1,
Chris Morin5a50d482022-02-01 17:41:18 -08001183 "VM TRACES AT LAST ANR", false /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001184
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001185 // Historical ANRs are always included as separate entries in the bugreport zip file.
Chris Morin5a50d482022-02-01 17:41:18 -08001186 AddDumps(ds.anr_data_.begin(), ds.anr_data_.end(),
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001187 "HISTORICAL ANR", true /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001188 } else {
Narayan Kamath8f788292017-05-25 13:20:39 +01001189 printf("*** NO ANRs to dump in %s\n\n", ANR_DIR.c_str());
1190 }
Andy Hungd62f7e62024-01-11 15:47:52 -08001191
1192 // Add Java anr traces (such as generated by the Finalizer Watchdog).
1193 AddDumps(ds.anr_trace_data_.begin(), ds.anr_trace_data_.end(), "JAVA ANR TRACES",
1194 true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001195}
1196
1197static void AddAnrTraceFiles() {
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001198 std::string anr_traces_dir = "/data/anr";
Narayan Kamath8f788292017-05-25 13:20:39 +01001199
Chris Morin5a50d482022-02-01 17:41:18 -08001200 AddAnrTraceDir(anr_traces_dir);
Narayan Kamath8f788292017-05-25 13:20:39 +01001201
Makoto Onuki83ec63f2019-01-31 17:08:59 -08001202 RunCommand("ANR FILES", {"ls", "-lt", ANR_DIR});
1203
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001204 // Slow traces for slow operations.
Felipe Lemee184f662016-10-27 10:04:47 -07001205 struct stat st;
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001206 int i = 0;
1207 while (true) {
1208 const std::string slow_trace_path =
1209 anr_traces_dir + android::base::StringPrintf("slow%02d.txt", i);
1210 if (stat(slow_trace_path.c_str(), &st)) {
1211 // No traces file at this index, done with the files.
1212 break;
Felipe Lemee184f662016-10-27 10:04:47 -07001213 }
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001214 ds.DumpFile("VM TRACES WHEN SLOW", slow_trace_path.c_str());
1215 i++;
Felipe Lemee184f662016-10-27 10:04:47 -07001216 }
1217}
1218
Wei Wang509bb5d2017-06-09 14:42:12 -07001219static void DumpBlockStatFiles() {
1220 DurationReporter duration_reporter("DUMP BLOCK STAT");
Wei Wang509bb5d2017-06-09 14:42:12 -07001221
Wei Wang1dc1ef52017-06-12 11:28:37 -07001222 std::unique_ptr<DIR, std::function<int(DIR*)>> dirptr(opendir(BLK_DEV_SYS_DIR), closedir);
1223
1224 if (dirptr == nullptr) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001225 MYLOGE("Failed to open %s: %s\n", BLK_DEV_SYS_DIR, strerror(errno));
1226 return;
1227 }
1228
1229 printf("------ DUMP BLOCK STAT ------\n\n");
Wei Wang1dc1ef52017-06-12 11:28:37 -07001230 while (struct dirent *d = readdir(dirptr.get())) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001231 if ((d->d_name[0] == '.')
1232 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
1233 || (d->d_name[1] == '\0'))) {
1234 continue;
1235 }
1236 const std::string new_path =
1237 android::base::StringPrintf("%s/%s", BLK_DEV_SYS_DIR, d->d_name);
1238 printf("------ BLOCK STAT (%s) ------\n", new_path.c_str());
1239 dump_files("", new_path.c_str(), skip_not_stat, dump_stat_from_fd);
1240 printf("\n");
1241 }
Wei Wang1dc1ef52017-06-12 11:28:37 -07001242 return;
Wei Wang509bb5d2017-06-09 14:42:12 -07001243}
Jayachandran Ca94c7172017-06-10 15:08:12 -07001244
1245static void DumpPacketStats() {
1246 DumpFile("NETWORK DEV INFO", "/proc/net/dev");
Jayachandran Ca94c7172017-06-10 15:08:12 -07001247}
1248
1249static void DumpIpAddrAndRules() {
1250 /* The following have a tendency to get wedged when wifi drivers/fw goes belly-up. */
Ray Chencbf278a2023-11-20 07:49:45 +00001251 RunCommand("NETWORK INTERFACES", {"ip", "-s", "link"});
Jayachandran Ca94c7172017-06-10 15:08:12 -07001252 RunCommand("IPv4 ADDRESSES", {"ip", "-4", "addr", "show"});
1253 RunCommand("IPv6 ADDRESSES", {"ip", "-6", "addr", "show"});
1254 RunCommand("IP RULES", {"ip", "rule", "show"});
1255 RunCommand("IP RULES v6", {"ip", "-6", "rule", "show"});
1256}
1257
Nandana Dutt5c390032019-03-12 10:52:56 +00001258static Dumpstate::RunStatus RunDumpsysTextByPriority(const std::string& title, int priority,
1259 std::chrono::milliseconds timeout,
1260 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001261 auto start = std::chrono::steady_clock::now();
Vishnu Naire97d6122018-01-18 13:58:56 -08001262 sp<android::IServiceManager> sm = defaultServiceManager();
1263 Dumpsys dumpsys(sm.get());
Vishnu Naire97d6122018-01-18 13:58:56 -08001264 Vector<String16> args;
1265 Dumpsys::setServiceArgs(args, /* asProto = */ false, priority);
Vishnu Naire97d6122018-01-18 13:58:56 -08001266 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ false);
1267 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001268 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001269 std::string path(title);
1270 path.append(" - ").append(String8(service).c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -08001271 size_t bytes_written = 0;
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001272 if (PropertiesHelper::IsDryRun()) {
1273 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1274 dumpsys.writeDumpFooter(STDOUT_FILENO, service, std::chrono::milliseconds(1));
1275 } else {
Devin Mooref492c1a2023-03-15 19:19:03 +00001276 status_t status = dumpsys.startDumpThread(Dumpsys::TYPE_DUMP | Dumpsys::TYPE_PID |
1277 Dumpsys::TYPE_CLIENTS | Dumpsys::TYPE_THREAD,
Devin Mooreae68df22023-02-24 20:59:51 +00001278 service, args);
1279 if (status == OK) {
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001280 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1281 std::chrono::duration<double> elapsed_seconds;
1282 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH &&
1283 service == String16("meminfo")) {
1284 // Use a longer timeout for meminfo, since 30s is not always enough.
1285 status = dumpsys.writeDump(STDOUT_FILENO, service, 60s,
1286 /* as_proto = */ false, elapsed_seconds,
1287 bytes_written);
1288 } else {
1289 status = dumpsys.writeDump(STDOUT_FILENO, service, service_timeout,
1290 /* as_proto = */ false, elapsed_seconds,
1291 bytes_written);
1292 }
1293 dumpsys.writeDumpFooter(STDOUT_FILENO, service, elapsed_seconds);
1294 bool dump_complete = (status == OK);
1295 dumpsys.stopDumpThread(dump_complete);
Devin Moorecdfa4602023-03-16 20:49:39 +00001296 } else {
1297 MYLOGE("Failed to start dump thread for service: %s, status: %d",
1298 String8(service).c_str(), status);
Gavin Corkeryfac7e2b2021-07-08 22:39:02 +01001299 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001300 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001301
1302 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1303 std::chrono::steady_clock::now() - start);
1304 if (elapsed_duration > timeout) {
1305 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1306 elapsed_duration.count());
1307 break;
1308 }
1309 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001310 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001311}
1312
Vishnu Nair64afc022018-02-01 15:29:34 -08001313static void RunDumpsysText(const std::string& title, int priority,
1314 std::chrono::milliseconds timeout,
1315 std::chrono::milliseconds service_timeout) {
1316 DurationReporter duration_reporter(title);
1317 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1318 fsync(STDOUT_FILENO);
1319 RunDumpsysTextByPriority(title, priority, timeout, service_timeout);
1320}
1321
1322/* Dump all services registered with Normal or Default priority. */
Nandana Dutt5c390032019-03-12 10:52:56 +00001323static Dumpstate::RunStatus RunDumpsysTextNormalPriority(const std::string& title,
1324 std::chrono::milliseconds timeout,
1325 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001326 DurationReporter duration_reporter(title);
1327 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1328 fsync(STDOUT_FILENO);
1329 RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_NORMAL, timeout,
1330 service_timeout);
Nandana Dutt5c390032019-03-12 10:52:56 +00001331
1332 RETURN_IF_USER_DENIED_CONSENT();
1333
1334 return RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_DEFAULT, timeout,
1335 service_timeout);
Vishnu Nair64afc022018-02-01 15:29:34 -08001336}
1337
Nandana Dutt5c390032019-03-12 10:52:56 +00001338static Dumpstate::RunStatus RunDumpsysProto(const std::string& title, int priority,
1339 std::chrono::milliseconds timeout,
1340 std::chrono::milliseconds service_timeout) {
Vishnu Naire97d6122018-01-18 13:58:56 -08001341 sp<android::IServiceManager> sm = defaultServiceManager();
1342 Dumpsys dumpsys(sm.get());
1343 Vector<String16> args;
1344 Dumpsys::setServiceArgs(args, /* asProto = */ true, priority);
1345 DurationReporter duration_reporter(title);
1346
1347 auto start = std::chrono::steady_clock::now();
1348 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ true);
1349 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001350 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001351 std::string path(kProtoPath);
1352 path.append(String8(service).c_str());
1353 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL) {
1354 path.append("_CRITICAL");
1355 } else if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH) {
1356 path.append("_HIGH");
1357 }
1358 path.append(kProtoExt);
Steven Morelandcbd69fc2021-07-20 20:45:43 +00001359 status_t status = dumpsys.startDumpThread(Dumpsys::TYPE_DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001360 if (status == OK) {
1361 status = ds.AddZipEntryFromFd(path, dumpsys.getDumpFd(), service_timeout);
1362 bool dumpTerminated = (status == OK);
1363 dumpsys.stopDumpThread(dumpTerminated);
1364 }
1365 ZipWriter::FileEntry file_entry;
1366 ds.zip_writer_->GetLastEntry(&file_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -08001367
1368 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1369 std::chrono::steady_clock::now() - start);
1370 if (elapsed_duration > timeout) {
1371 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1372 elapsed_duration.count());
1373 break;
1374 }
1375 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001376 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001377}
1378
Nandana Dutta7db6342018-11-21 14:53:34 +00001379// Runs dumpsys on services that must dump first and will take less than 100ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001380static Dumpstate::RunStatus RunDumpsysCritical() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001381 RunDumpsysText("DUMPSYS CRITICAL", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1382 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Nandana Dutt5c390032019-03-12 10:52:56 +00001383
1384 RETURN_IF_USER_DENIED_CONSENT();
1385
1386 return RunDumpsysProto("DUMPSYS CRITICAL PROTO", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1387 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Vishnu Nair780b1282017-10-10 13:57:24 -07001388}
1389
1390// Runs dumpsys on services that must dump first but can take up to 250ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001391static Dumpstate::RunStatus RunDumpsysHigh() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001392 // TODO meminfo takes ~10s, connectivity takes ~5sec to dump. They are both
1393 // high priority. Reduce timeout once they are able to dump in a shorter time or
1394 // moved to a parallel task.
1395 RunDumpsysText("DUMPSYS HIGH", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1396 /* timeout= */ 90s, /* service_timeout= */ 30s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001397
1398 RETURN_IF_USER_DENIED_CONSENT();
1399
1400 return RunDumpsysProto("DUMPSYS HIGH PROTO", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1401 /* timeout= */ 5s, /* service_timeout= */ 1s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001402}
1403
1404// Runs dumpsys on services that must dump but can take up to 10s to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001405static Dumpstate::RunStatus RunDumpsysNormal() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001406 RunDumpsysTextNormalPriority("DUMPSYS", /* timeout= */ 90s, /* service_timeout= */ 10s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001407
1408 RETURN_IF_USER_DENIED_CONSENT();
1409
1410 return RunDumpsysProto("DUMPSYS PROTO", IServiceManager::DUMP_FLAG_PRIORITY_NORMAL,
1411 /* timeout= */ 90s, /* service_timeout= */ 10s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001412}
1413
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001414/*
1415 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1416 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1417 * if it's not running in the parallel task.
1418 */
1419static void DumpHals(int out_fd = STDOUT_FILENO) {
Yifan Hong30528a22020-08-07 18:24:06 -07001420 RunCommand("HARDWARE HALS", {"lshal", "--all", "--types=all"},
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001421 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build(),
1422 false, out_fd);
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001423
Steven Moreland44cd9482018-01-04 16:24:13 -08001424 using android::hidl::manager::V1_0::IServiceManager;
1425 using android::hardware::defaultServiceManager;
1426
1427 sp<IServiceManager> sm = defaultServiceManager();
1428 if (sm == nullptr) {
1429 MYLOGE("Could not retrieve hwservicemanager to dump hals.\n");
1430 return;
1431 }
1432
1433 auto ret = sm->list([&](const auto& interfaces) {
1434 for (const std::string& interface : interfaces) {
1435 std::string cleanName = interface;
Steven Morelandc6b1fc22023-07-26 23:53:58 +00001436 std::replace_if(
1437 cleanName.begin(), cleanName.end(),
1438 [](char c) {
1439 return !isalnum(c) && std::string("@-_.").find(c) == std::string::npos;
1440 },
1441 '_');
Nandana Dutt979388e2018-11-30 16:48:55 +00001442 const std::string path = ds.bugreport_internal_dir_ + "/lshal_debug_" + cleanName;
Steven Moreland44cd9482018-01-04 16:24:13 -08001443
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001444 bool empty = false;
Steven Moreland44cd9482018-01-04 16:24:13 -08001445 {
1446 auto fd = android::base::unique_fd(
1447 TEMP_FAILURE_RETRY(open(path.c_str(),
1448 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1449 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1450 if (fd < 0) {
1451 MYLOGE("Could not open %s to dump additional hal information.\n", path.c_str());
1452 continue;
1453 }
1454 RunCommandToFd(fd,
1455 "",
Steven Morelandc81cd3c2018-01-18 14:36:26 -08001456 {"lshal", "debug", "-E", interface},
Steven Moreland44cd9482018-01-04 16:24:13 -08001457 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
1458
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001459 empty = 0 == lseek(fd, 0, SEEK_END);
Steven Moreland44cd9482018-01-04 16:24:13 -08001460 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001461 if (!empty) {
1462 ds.EnqueueAddZipEntryAndCleanupIfNeeded("lshal-debug/" + cleanName + ".txt",
1463 path);
1464 } else {
1465 unlink(path.c_str());
1466 }
Steven Moreland44cd9482018-01-04 16:24:13 -08001467 }
1468 });
1469
1470 if (!ret.isOk()) {
1471 MYLOGE("Could not list hals from hwservicemanager.\n");
1472 }
1473}
1474
Devin Moore8df81bb2022-06-08 22:47:02 +00001475// Dump all of the files that make up the vendor interface.
1476// See the files listed in dumpFileList() for the latest list of files.
1477static void DumpVintf() {
Devin Moore16271d92022-09-22 18:28:48 +00001478
1479 const std::string sku = android::base::GetProperty("ro.boot.product.hardware.sku", "");
1480 const auto vintfFiles = android::vintf::details::dumpFileList(sku);
Devin Moore8df81bb2022-06-08 22:47:02 +00001481 for (const auto vintfFile : vintfFiles) {
1482 struct stat st;
1483 if (stat(vintfFile.c_str(), &st) == 0) {
1484 if (S_ISDIR(st.st_mode)) {
1485 ds.AddDir(vintfFile, true /* recursive */);
1486 } else {
1487 ds.EnqueueAddZipEntryAndCleanupIfNeeded(ZIP_ROOT_DIR + vintfFile,
1488 vintfFile);
1489 }
1490 }
1491 }
1492}
1493
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001494static void DumpExternalFragmentationInfo() {
1495 struct stat st;
1496 if (stat("/proc/buddyinfo", &st) != 0) {
1497 MYLOGE("Unable to dump external fragmentation info\n");
1498 return;
1499 }
1500
1501 printf("------ EXTERNAL FRAGMENTATION INFO ------\n");
1502 std::ifstream ifs("/proc/buddyinfo");
1503 auto unusable_index_regex = std::regex{"Node\\s+([0-9]+),\\s+zone\\s+(\\S+)\\s+(.*)"};
1504 for (std::string line; std::getline(ifs, line);) {
1505 std::smatch match_results;
1506 if (std::regex_match(line, match_results, unusable_index_regex)) {
1507 std::stringstream free_pages(std::string{match_results[3]});
1508 std::vector<int> free_pages_per_order(std::istream_iterator<int>{free_pages},
1509 std::istream_iterator<int>());
1510
1511 int total_free_pages = 0;
1512 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1513 total_free_pages += (free_pages_per_order[i] * std::pow(2, i));
1514 }
1515
1516 printf("Node %s, zone %8s", match_results[1].str().c_str(),
1517 match_results[2].str().c_str());
1518
1519 int usable_free_pages = total_free_pages;
1520 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1521 auto unusable_index = (total_free_pages - usable_free_pages) /
1522 static_cast<double>(total_free_pages);
1523 printf(" %5.3f", unusable_index);
1524 usable_free_pages -= (free_pages_per_order[i] * std::pow(2, i));
1525 }
1526
1527 printf("\n");
1528 }
1529 }
1530 printf("\n");
1531}
1532
mhasankd451a472020-05-26 18:02:39 -07001533static void DumpstateLimitedOnly() {
EdenSue8fe4522023-11-20 15:37:23 +08001534 // Trimmed-down version of dumpstate to only include a allowlisted
mhasankd451a472020-05-26 18:02:39 -07001535 // set of logs (system log, event log, and system server / system app
1536 // crashes, and networking logs). See b/136273873 and b/138459828
1537 // for context.
1538 DurationReporter duration_reporter("DUMPSTATE");
1539 unsigned long timeout_ms;
1540 // calculate timeout
1541 timeout_ms = logcat_timeout({"main", "system", "crash"});
1542 RunCommand("SYSTEM LOG",
1543 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1544 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1545 timeout_ms = logcat_timeout({"events"});
1546 RunCommand(
1547 "EVENT LOG",
1548 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1549 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1550
1551 printf("========================================================\n");
1552 printf("== Networking Service\n");
1553 printf("========================================================\n");
1554
1555 RunDumpsys("DUMPSYS NETWORK_SERVICE_LIMITED", {"wifi", "-a"},
1556 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hugo Benichiaa162682020-10-30 23:28:56 +09001557 RunDumpsys("DUMPSYS CONNECTIVITY REQUESTS", {"connectivity", "requests"},
1558 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
mhasankd451a472020-05-26 18:02:39 -07001559
1560 printf("========================================================\n");
1561 printf("== Dropbox crashes\n");
1562 printf("========================================================\n");
1563
1564 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1565 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1566
1567 printf("========================================================\n");
1568 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1569 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1570 printf("========================================================\n");
1571 printf("== dumpstate: done (id %d)\n", ds.id_);
1572 printf("========================================================\n");
1573}
1574
Rhed Jaoe017f982020-07-21 17:58:41 +08001575/*
1576 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1577 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1578 * if it's not running in the parallel task.
1579 */
1580static void DumpCheckins(int out_fd = STDOUT_FILENO) {
1581 dprintf(out_fd, "========================================================\n");
1582 dprintf(out_fd, "== Checkins\n");
1583 dprintf(out_fd, "========================================================\n");
1584
1585 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"}, out_fd);
Rhed Jaoe017f982020-07-21 17:58:41 +08001586 RunDumpsys("CHECKIN NETSTATS", {"netstats", "--checkin"}, out_fd);
1587 RunDumpsys("CHECKIN PROCSTATS", {"procstats", "-c"}, out_fd);
1588 RunDumpsys("CHECKIN USAGESTATS", {"usagestats", "-c"}, out_fd);
1589 RunDumpsys("CHECKIN PACKAGE", {"package", "--checkin"}, out_fd);
1590}
1591
1592/*
1593 * Runs dumpsys on activity service to dump all application activities, services
1594 * and providers in the device.
1595 *
1596 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1597 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1598 * if it's not running in the parallel task.
1599 */
1600static void DumpAppInfos(int out_fd = STDOUT_FILENO) {
1601 dprintf(out_fd, "========================================================\n");
1602 dprintf(out_fd, "== Running Application Activities\n");
1603 dprintf(out_fd, "========================================================\n");
1604
1605 // The following dumpsys internally collects output from running apps, so it can take a long
1606 // time. So let's extend the timeout.
1607
1608 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
1609
1610 RunDumpsys("APP ACTIVITIES", {"activity", "-v", "all"}, DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1611
1612 dprintf(out_fd, "========================================================\n");
1613 dprintf(out_fd, "== Running Application Services (platform)\n");
1614 dprintf(out_fd, "========================================================\n");
1615
1616 RunDumpsys("APP SERVICES PLATFORM", {"activity", "service", "all-platform-non-critical"},
1617 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1618
1619 dprintf(out_fd, "========================================================\n");
1620 dprintf(out_fd, "== Running Application Services (non-platform)\n");
1621 dprintf(out_fd, "========================================================\n");
1622
1623 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1624 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1625
1626 dprintf(out_fd, "========================================================\n");
1627 dprintf(out_fd, "== Running Application Providers (platform)\n");
1628 dprintf(out_fd, "========================================================\n");
1629
1630 RunDumpsys("APP PROVIDERS PLATFORM", {"activity", "provider", "all-platform"},
Rhed Jaob049f182021-01-11 21:08:43 +08001631 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
Rhed Jaoe017f982020-07-21 17:58:41 +08001632
1633 dprintf(out_fd, "========================================================\n");
1634 dprintf(out_fd, "== Running Application Providers (non-platform)\n");
1635 dprintf(out_fd, "========================================================\n");
1636
1637 RunDumpsys("APP PROVIDERS NON-PLATFORM", {"activity", "provider", "all-non-platform"},
1638 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1639}
1640
Nandana Dutt5c390032019-03-12 10:52:56 +00001641// Dumps various things. Returns early with status USER_CONSENT_DENIED if user denies consent
1642// via the consent they are shown. Ignores other errors that occur while running various
1643// commands. The consent checking is currently done around long running tasks, which happen to
1644// be distributed fairly evenly throughout the function.
Kean Mariotti306633e2022-09-05 16:30:47 +00001645Dumpstate::RunStatus Dumpstate::dumpstate() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001646 DurationReporter duration_reporter("DUMPSTATE");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001647
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001648 // Enqueue slow functions into the thread pool, if the parallel run is enabled.
Aaron Huanga99452a2022-04-27 18:51:16 +08001649 std::future<std::string> dump_hals, dump_incident_report, dump_board, dump_checkins,
Kean Mariotti306633e2022-09-05 16:30:47 +00001650 dump_netstats_report, post_process_ui_traces;
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001651 if (ds.dump_pool_) {
1652 // Pool was shutdown in DumpstateDefaultAfterCritical method in order to
Kean Mariotti306633e2022-09-05 16:30:47 +00001653 // drop root user. Restarts it.
1654 ds.dump_pool_->start(/* thread_counts = */3);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001655
Chris Morinbc223142022-02-04 14:17:11 -08001656 dump_hals = ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
1657 dump_incident_report = ds.dump_pool_->enqueueTask(
1658 DUMP_INCIDENT_REPORT_TASK, &DumpIncidentReport);
Aaron Huanga99452a2022-04-27 18:51:16 +08001659 dump_netstats_report = ds.dump_pool_->enqueueTask(
1660 DUMP_NETSTATS_PROTO_TASK, &DumpNetstatsProto);
Chris Morinbc223142022-02-04 14:17:11 -08001661 dump_board = ds.dump_pool_->enqueueTaskWithFd(
1662 DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
1663 dump_checkins = ds.dump_pool_->enqueueTaskWithFd(DUMP_CHECKINS_TASK, &DumpCheckins, _1);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001664 }
1665
Nandana Dutt5c390032019-03-12 10:52:56 +00001666 // Dump various things. Note that anything that takes "long" (i.e. several seconds) should
1667 // check intermittently (if it's intrerruptable like a foreach on pids) and/or should be wrapped
1668 // in a consent check (via RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK).
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -07001669 dump_dev_files("TRUSTY VERSION", "/sys/bus/platform/drivers/trusty", "trusty_version");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001670 RunCommand("UPTIME", {"uptime"});
Wei Wang509bb5d2017-06-09 14:42:12 -07001671 DumpBlockStatFiles();
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001672 DumpFile("MEMORY INFO", "/proc/meminfo");
1673 RunCommand("CPU INFO", {"top", "-b", "-n", "1", "-H", "-s", "6", "-o",
Felipe Leme30dbfa12016-09-02 12:43:26 -07001674 "pid,tid,user,pr,ni,%cpu,s,virt,res,pcy,cmd,name"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001675
Kevin Jeon947922b2022-09-21 00:29:18 +00001676 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "BUGREPORT_PROCDUMP", {"bugreport_procdump"},
1677 CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001678
Sunny Goyal35949782019-11-19 15:54:36 -08001679 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpVisibleWindowViews);
1680
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001681 DumpFile("VIRTUAL MEMORY STATS", "/proc/vmstat");
1682 DumpFile("VMALLOC INFO", "/proc/vmallocinfo");
1683 DumpFile("SLAB INFO", "/proc/slabinfo");
1684 DumpFile("ZONEINFO", "/proc/zoneinfo");
1685 DumpFile("PAGETYPEINFO", "/proc/pagetypeinfo");
1686 DumpFile("BUDDYINFO", "/proc/buddyinfo");
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001687 DumpExternalFragmentationInfo();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001688
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001689 DumpFile("KERNEL CPUFREQ", "/sys/devices/system/cpu/cpu0/cpufreq/stats/time_in_state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001690
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001691 RunCommand("PROCESSES AND THREADS",
Yohei Yukawa591a72d2017-10-05 21:36:35 -07001692 {"ps", "-A", "-T", "-Z", "-O", "pri,nice,rtprio,sched,pcy,time"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001693
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001694 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001695 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_hals));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001696 } else {
1697 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_HALS_TASK, DumpHals);
1698 }
Steven Moreland81b429e2017-01-31 19:50:46 -08001699
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001700 RunCommand("PRINTENV", {"printenv"});
Elliott Hughes21b7c8d2016-10-28 08:53:02 -07001701 RunCommand("NETSTAT", {"netstat", "-nW"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001702 struct stat s;
1703 if (stat("/proc/modules", &s) != 0) {
1704 MYLOGD("Skipping 'lsmod' because /proc/modules does not exist\n");
1705 } else {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001706 RunCommand("LSMOD", {"lsmod"});
Woody Linc198f252021-05-04 16:37:11 +08001707 RunCommand("MODULES INFO",
1708 {"sh", "-c", "cat /proc/modules | cut -d' ' -f1 | "
1709 " while read MOD ; do echo modinfo:$MOD ; modinfo $MOD ; "
1710 "done"}, CommandOptions::AS_ROOT);
Felipe Lemee4eca582016-06-10 17:48:08 -07001711 }
Michal Karpinski4db754f2015-12-11 18:04:32 +00001712
Tom Cherryb87dbfa2020-07-28 11:28:53 -07001713 if (android::base::GetBoolProperty("ro.logd.kernel", false)) {
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001714 DoKernelLogcat();
1715 } else {
1716 do_dmesg();
1717 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001718
Devin Moore8df81bb2022-06-08 22:47:02 +00001719 DumpVintf();
1720
Felipe Lemef0292972016-11-22 13:57:05 -08001721 RunCommand("LIST OF OPEN FILES", {"lsof"}, CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001722
Jeff Brown1dc94e32014-09-11 14:15:27 -07001723 for_each_tid(show_wchan, "BLOCKED PROCESS WAIT-CHANNELS");
Mark Salyzyna297c322016-02-05 15:33:17 -08001724 for_each_pid(show_showtime, "PROCESS TIMES (pid cmd user system iowait+percentage)");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001725
Jack Yu5a6b2e22020-08-14 18:13:35 +08001726 /* Dump Nfc NCI logs */
1727 ds.AddDir("/data/misc/nfc/logs", true);
Ajay Panickerd886ec42016-09-14 12:26:46 -07001728
Paul Chang0d2aad72020-02-13 20:04:03 +08001729 if (ds.options_->do_screenshot && !ds.do_early_screenshot_) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001730 MYLOGI("taking late screenshot\n");
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001731 ds.TakeScreenshot();
Jeff Sharkey5a930032013-03-19 15:05:19 -07001732 }
1733
Felipe Lemee184f662016-10-27 10:04:47 -07001734 AddAnrTraceFiles();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001735
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001736 MaybeAddSystemTraceToZip();
1737
Narayan Kamath8f788292017-05-25 13:20:39 +01001738 // NOTE: tombstones are always added as separate entries in the zip archive
1739 // and are not interspersed with the main report.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001740 const bool tombstones_dumped = AddDumps(ds.tombstone_data_.begin(), ds.tombstone_data_.end(),
Narayan Kamathbd863722017-06-01 18:50:12 +01001741 "TOMBSTONE", true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001742 if (!tombstones_dumped) {
1743 printf("*** NO TOMBSTONES to dump in %s\n\n", TOMBSTONE_DIR.c_str());
Christopher Ferris7dc7f322014-07-22 16:08:19 -07001744 }
1745
Jayachandran Ca94c7172017-06-10 15:08:12 -07001746 DumpPacketStats();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001747
Lorenzo Colitti807f2dd2022-05-27 12:48:37 +09001748 RunDumpsys("EBPF MAP STATS", {"connectivity", "trafficcontroller"});
Chenbo Feng276a3b62018-08-07 11:44:49 -07001749
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001750 DoKmsg();
Mark Salyzyn2262c162014-12-16 09:09:26 -08001751
Woody Lin20767a92022-11-29 15:50:24 +08001752 DumpShutdownCheckpoints();
1753
Jayachandran Ca94c7172017-06-10 15:08:12 -07001754 DumpIpAddrAndRules();
Sreeram Ramachandran2b3bba32014-07-08 15:40:55 -07001755
1756 dump_route_tables();
1757
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001758 RunCommand("ARP CACHE", {"ip", "-4", "neigh", "show"});
1759 RunCommand("IPv6 ND CACHE", {"ip", "-6", "neigh", "show"});
1760 RunCommand("MULTICAST ADDRESSES", {"ip", "maddr"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001761
Nandana Dutt5c390032019-03-12 10:52:56 +00001762 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysHigh);
Lorenzo Colitti6afc38c2015-09-09 22:59:25 +09001763
Chiachang Wang668ede42021-05-17 17:14:20 +08001764 // The dump mechanism in connectivity is refactored due to modularization work. Connectivity can
1765 // only register with a default priority(NORMAL priority). Dumpstate has to call connectivity
1766 // dump with priority parameters to dump high priority information.
1767 RunDumpsys("SERVICE HIGH connectivity", {"connectivity", "--dump-priority", "HIGH"},
1768 CommandOptions::WithTimeout(10).Build());
1769
Elliott Hughes23ccc622017-02-28 10:14:22 -08001770 RunCommand("SYSTEM PROPERTIES", {"getprop"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001771
Joe Onoratod38bc3a2023-06-29 15:48:28 -07001772 DumpFile("SYSTEM BUILD-TIME RELEASE FLAGS", "/system/etc/build_flags.json");
1773 DumpFile("SYSTEM_EXT BUILD-TIME RELEASE FLAGS", "/system_ext/etc/build_flags.json");
1774 DumpFile("PRODUCT BUILD-TIME RELEASE FLAGS", "/product/etc/build_flags.json");
1775 DumpFile("VENDOR BUILD-TIME RELEASE FLAGS", "/vendor/etc/build_flags.json");
1776
Mårten Kongstad5ad813f2023-09-28 10:09:18 +02001777 RunCommand("ACONFIG FLAGS", {PRINT_FLAGS},
1778 CommandOptions::WithTimeout(10).Always().DropRoot().Build());
Joe Onoratod38bc3a2023-06-29 15:48:28 -07001779
Jin Qianf334d662017-10-10 14:41:37 -07001780 RunCommand("STORAGED IO INFO", {"storaged", "-u", "-p"});
ynwangf649a6e2016-07-17 21:56:00 -07001781
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001782 RunCommand("FILESYSTEMS & FREE SPACE", {"df"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001783
Colin Crossf45fa6b2012-03-26 12:38:26 -07001784 /* Binder state is expensive to look at as it uses a lot of memory. */
Hridya Valsaraju920ba712020-02-09 16:27:01 -08001785 std::string binder_logs_dir = access("/dev/binderfs/binder_logs", R_OK) ?
1786 "/sys/kernel/debug/binder" : "/dev/binderfs/binder_logs";
1787
1788 DumpFile("BINDER FAILED TRANSACTION LOG", binder_logs_dir + "/failed_transaction_log");
1789 DumpFile("BINDER TRANSACTION LOG", binder_logs_dir + "/transaction_log");
1790 DumpFile("BINDER TRANSACTIONS", binder_logs_dir + "/transactions");
1791 DumpFile("BINDER STATS", binder_logs_dir + "/stats");
1792 DumpFile("BINDER STATE", binder_logs_dir + "/state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001793
Yifan Hongd90cc652020-02-08 16:52:02 -08001794 ds.AddDir(SNAPSHOTCTL_LOG_DIR, false);
1795
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001796 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001797 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_board));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001798 } else {
1799 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
1800 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001801
Steven Moreland7440ddb2016-12-15 16:13:39 -08001802 /* Migrate the ril_dumpstate to a device specific dumpstate? */
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001803 int rilDumpstateTimeout = android::base::GetIntProperty("ril.dumpstate.timeout", 0);
1804 if (rilDumpstateTimeout > 0) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001805 // su does not exist on user builds, so try running without it.
1806 // This way any implementations of vril-dump that do not require
1807 // root can run on user builds.
1808 CommandOptions::CommandOptionsBuilder options =
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001809 CommandOptions::WithTimeout(rilDumpstateTimeout);
Felipe Lemef0292972016-11-22 13:57:05 -08001810 if (!PropertiesHelper::IsUserBuild()) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001811 options.AsRoot();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001812 }
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001813 RunCommand("DUMP VENDOR RIL LOGS", {"vril-dump"}, options.Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -07001814 }
1815
Felipe Lemed8b94e52016-12-08 10:21:44 -08001816 printf("========================================================\n");
1817 printf("== Android Framework Services\n");
1818 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001819
Nandana Dutt5c390032019-03-12 10:52:56 +00001820 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysNormal);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001821
Jack He91ff2fe2021-02-18 18:23:43 -08001822 /* Dump Bluetooth HCI logs after getting bluetooth_manager dumpsys */
1823 ds.AddDir("/data/misc/bluetooth/logs", true);
1824
Rhed Jaoe017f982020-07-21 17:58:41 +08001825 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001826 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_checkins));
Rhed Jaoe017f982020-07-21 17:58:41 +08001827 } else {
1828 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_CHECKINS_TASK, DumpCheckins);
1829 }
Dianne Hackborn02bea972013-06-26 18:59:09 -07001830
Rhed Jaoc5f7ec32020-12-22 22:11:08 +08001831 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpAppInfos);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001832
Adrian Roos8b397ab2017-04-04 16:35:44 -07001833 printf("========================================================\n");
1834 printf("== Dropbox crashes\n");
1835 printf("========================================================\n");
1836
1837 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1838 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1839
Felipe Lemed8b94e52016-12-08 10:21:44 -08001840 printf("========================================================\n");
1841 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1842 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1843 printf("========================================================\n");
1844 printf("== dumpstate: done (id %d)\n", ds.id_);
1845 printf("========================================================\n");
Bookatz38472142018-09-28 10:20:24 -07001846
1847 printf("========================================================\n");
1848 printf("== Obtaining statsd metadata\n");
1849 printf("========================================================\n");
1850 // This differs from the usual dumpsys stats, which is the stats report data.
1851 RunDumpsys("STATSDSTATS", {"stats", "--metadata"});
Mike Ma5c267872019-08-21 11:31:34 -07001852
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +09001853 // Add linker configuration directory
1854 ds.AddDir(LINKERCONFIG_DIR, true);
1855
Li Li830179f2022-01-04 12:53:29 -08001856 /* Dump frozen cgroupfs */
1857 dump_frozen_cgroupfs();
Li Li2eedd412021-06-30 15:11:53 -07001858
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001859 if (ds.dump_pool_) {
Aaron Huanga99452a2022-04-27 18:51:16 +08001860 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_netstats_report));
1861 } else {
1862 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_NETSTATS_PROTO_TASK,
1863 DumpNetstatsProto);
1864 }
1865
1866 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001867 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_incident_report));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001868 } else {
1869 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_INCIDENT_REPORT_TASK,
1870 DumpIncidentReport);
1871 }
Mike Ma5c267872019-08-21 11:31:34 -07001872
Kean Mariotti306633e2022-09-05 16:30:47 +00001873 MaybeAddUiTracesToZip();
1874
Nandana Dutt5c390032019-03-12 10:52:56 +00001875 return Dumpstate::RunStatus::OK;
Colin Crossf45fa6b2012-03-26 12:38:26 -07001876}
1877
Nandana Dutt5c390032019-03-12 10:52:56 +00001878/*
1879 * Dumps state for the default case; drops root after it's no longer necessary.
1880 *
1881 * Returns RunStatus::OK if everything went fine.
1882 * Returns RunStatus::ERROR if there was an error.
1883 * Returns RunStatus::USER_DENIED_CONSENT if user explicitly denied consent to sharing the bugreport
1884 * with the caller.
1885 */
Jichao Lie89d9c12019-11-21 19:02:51 -08001886Dumpstate::RunStatus Dumpstate::DumpstateDefaultAfterCritical() {
Nandana Duttdb379fa2019-10-09 16:54:41 +01001887 // Capture first logcat early on; useful to take a snapshot before dumpstate logs take over the
1888 // buffer.
1889 DoLogcat();
1890 // Capture timestamp after first logcat to use in next logcat
1891 time_t logcat_ts = time(nullptr);
1892
Nandana Dutt4be45d12018-09-26 15:04:23 +01001893 /* collect stack traces from Dalvik and native processes (needs root) */
Chris Morinbc223142022-02-04 14:17:11 -08001894 std::future<std::string> dump_traces;
Rhed Jao5377d792020-07-16 17:37:39 +08001895 if (dump_pool_) {
1896 RETURN_IF_USER_DENIED_CONSENT();
1897 // One thread is enough since we only need to enqueue DumpTraces here.
1898 dump_pool_->start(/* thread_counts = */1);
1899
1900 // DumpTraces takes long time, post it to the another thread in the
1901 // pool, if pool is available
Chris Morinbc223142022-02-04 14:17:11 -08001902 dump_traces = dump_pool_->enqueueTask(
1903 DUMP_TRACES_TASK, &Dumpstate::DumpTraces, &ds, &dump_traces_path);
Rhed Jao5377d792020-07-16 17:37:39 +08001904 } else {
1905 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_TRACES_TASK, ds.DumpTraces,
1906 &dump_traces_path);
1907 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001908
1909 /* Run some operations that require root. */
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001910 if (!PropertiesHelper::IsDryRun()) {
Chris Morinc2cba7a2022-02-01 17:06:50 -08001911 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX);
1912 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX);
Andy Hungd62f7e62024-01-11 15:47:52 -08001913 ds.anr_trace_data_ = GetDumpFds(ANR_DIR, ANR_TRACE_FILE_PREFIX);
Woody Lin20767a92022-11-29 15:50:24 +08001914 ds.shutdown_checkpoints_ = GetDumpFds(
1915 SHUTDOWN_CHECKPOINTS_DIR, SHUTDOWN_CHECKPOINTS_FILE_PREFIX);
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001916 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001917
1918 ds.AddDir(RECOVERY_DIR, true);
1919 ds.AddDir(RECOVERY_DATA_DIR, true);
1920 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
Kelvin Zhang6eaa0f92022-09-12 09:29:19 -07001921 ds.AddDir(UPDATE_ENGINE_PREF_DIR, true);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001922 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1923 if (!PropertiesHelper::IsUserBuild()) {
1924 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1925 ds.AddDir(PROFILE_DATA_DIR_REF, true);
Calin Juravlef84d3692020-04-28 15:31:12 -07001926 ds.AddZipEntry(ZIP_ROOT_DIR + PACKAGE_DEX_USE_LIST, PACKAGE_DEX_USE_LIST);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001927 }
Jerry Changa1df8a92020-01-02 16:03:39 +08001928 ds.AddDir(PREREBOOT_DATA_DIR, false);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001929 add_mountinfo();
Peter Collingbourne78aa2942023-02-15 14:50:31 -08001930 for (const char* path : {"/proc/cpuinfo", "/proc/meminfo"}) {
1931 ds.AddZipEntry(ZIP_ROOT_DIR + path, path);
1932 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001933 DumpIpTablesAsRoot();
David Andersond9ba4752018-12-11 18:26:59 -08001934 DumpDynamicPartitionInfo();
Yifan Hong3945e1b2019-10-29 12:59:23 -07001935 ds.AddDir(OTA_METADATA_DIR, true);
Jeff Sharkey9df29d52023-02-06 14:26:30 -07001936 if (!PropertiesHelper::IsUserBuild()) {
1937 // Include dropbox entry files inside ZIP, but exclude
1938 // noisy WTF and StrictMode entries
1939 dump_files("", DROPBOX_DIR, skip_wtf_strictmode, _add_file_from_fd);
1940 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001941
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001942 // Capture any IPSec policies in play. No keys are exposed here.
Nandana Dutt4be45d12018-09-26 15:04:23 +01001943 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1944
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001945 // Dump IPsec stats. No keys are exposed here.
1946 DumpFile("XFRM STATS", XFRM_STAT_PROC_FILE);
1947
Nandana Dutt4be45d12018-09-26 15:04:23 +01001948 // Run ss as root so we can see socket marks.
1949 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
1950
1951 // Run iotop as root to show top 100 IO threads
1952 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
1953
Erick Reyese68df822019-02-11 14:46:36 -08001954 // Gather shared memory buffer info if the product implements it
Hridya Valsaraju1da80c52021-01-09 22:10:11 -08001955 RunCommand("Dmabuf dump", {"dmabuf_dump"});
1956 RunCommand("Dmabuf per-buffer/per-exporter/per-device stats", {"dmabuf_dump", "-b"});
Erick Reyese68df822019-02-11 14:46:36 -08001957
Minchan Kim22c6a1e2019-09-30 15:58:10 -07001958 DumpFile("PSI cpu", "/proc/pressure/cpu");
1959 DumpFile("PSI memory", "/proc/pressure/memory");
1960 DumpFile("PSI io", "/proc/pressure/io");
1961
Steven Moreland9379c462023-12-21 02:04:27 +00001962 ds.AddZipEntry(ZIP_ROOT_DIR + KERNEL_CONFIG, KERNEL_CONFIG);
1963
Mårten Kongstad60195a72022-09-20 14:14:20 +02001964 RunCommand("SDK EXTENSIONS", {SDK_EXT_INFO, "--dump"},
1965 CommandOptions::WithTimeout(10).Always().DropRoot().Build());
1966
Nattharat Jariyanuntanaetb250cae2024-05-15 07:48:19 +00001967 // Dump UWB UCI logs here because apexdata requires root access
1968 ds.AddDir(UWB_LOG_DIR, true);
1969
Rhed Jao5377d792020-07-16 17:37:39 +08001970 if (dump_pool_) {
1971 RETURN_IF_USER_DENIED_CONSENT();
Chris Morinbc223142022-02-04 14:17:11 -08001972 WaitForTask(std::move(dump_traces));
Rhed Jao5377d792020-07-16 17:37:39 +08001973
Chris Morinbc223142022-02-04 14:17:11 -08001974 // Current running thread in the pool is the root user also. Delete
1975 // the pool and make a new one later to ensure none of threads in the pool are root.
1976 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao5377d792020-07-16 17:37:39 +08001977 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001978 if (!DropRootUser()) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001979 return Dumpstate::RunStatus::ERROR;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001980 }
1981
Nandana Dutt5c390032019-03-12 10:52:56 +00001982 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttdb379fa2019-10-09 16:54:41 +01001983 Dumpstate::RunStatus status = dumpstate();
1984 // Capture logcat since the last time we did it.
1985 DoSystemLogcat(logcat_ts);
1986 return status;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001987}
1988
Rhed Jaob5685b32020-08-14 17:19:17 +08001989// Common states for telephony and wifi which are needed to be collected before
1990// dumpstate drop the root user.
1991static void DumpstateRadioAsRoot() {
1992 DumpIpTablesAsRoot();
1993 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1994}
1995
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001996// This method collects common dumpsys for telephony and wifi. Typically, wifi
1997// reports are fine to include all information, but telephony reports on user
1998// builds need to strip some content (see DumpstateTelephonyOnly).
1999static void DumpstateRadioCommon(bool include_sensitive_info = true) {
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002000 // We need to be picky about some stuff for telephony reports on user builds.
2001 if (!include_sensitive_info) {
2002 // Only dump the radio log buffer (other buffers and dumps contain too much unrelated info).
2003 DoRadioLogcat();
2004 } else {
Rhed Jaob5685b32020-08-14 17:19:17 +08002005 // DumpHals takes long time, post it to the another thread in the pool,
2006 // if pool is available.
Chris Morinbc223142022-02-04 14:17:11 -08002007 std::future<std::string> dump_hals;
Rhed Jaob5685b32020-08-14 17:19:17 +08002008 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08002009 dump_hals = ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
Rhed Jaob5685b32020-08-14 17:19:17 +08002010 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002011 // Contains various system properties and process startup info.
2012 do_dmesg();
2013 // Logs other than the radio buffer may contain package/component names and potential PII.
2014 DoLogcat();
2015 // Too broad for connectivity problems.
2016 DoKmsg();
Rhed Jaob5685b32020-08-14 17:19:17 +08002017 // DumpHals contains unrelated hardware info (camera, NFC, biometrics, ...).
2018 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08002019 WaitForTask(std::move(dump_hals));
Rhed Jaob5685b32020-08-14 17:19:17 +08002020 } else {
2021 RUN_SLOW_FUNCTION_AND_LOG(DUMP_HALS_TASK, DumpHals);
2022 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002023 }
2024
Jayachandran Ca94c7172017-06-10 15:08:12 -07002025 DumpPacketStats();
Jayachandran Ca94c7172017-06-10 15:08:12 -07002026 DumpIpAddrAndRules();
2027 dump_route_tables();
Jayachandran Ca94c7172017-06-10 15:08:12 -07002028 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
2029 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08002030}
2031
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002032// We use "telephony" here for legacy reasons, though this now really means "connectivity" (cellular
2033// + wifi + networking). This method collects dumpsys for connectivity debugging only. General rules
2034// for what can be included on user builds: all reported information MUST directly relate to
2035// connectivity debugging or customer support and MUST NOT contain unrelated personally identifiable
2036// information. This information MUST NOT identify user-installed packages (UIDs are OK, package
2037// names are not), and MUST NOT contain logs of user application traffic.
2038// TODO(b/148168577) rename this and other related fields/methods to "connectivity" instead.
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08002039static void DumpstateTelephonyOnly(const std::string& calling_package) {
mukesh agrawal253dad42018-01-23 21:59:59 -08002040 DurationReporter duration_reporter("DUMPSTATE");
Jichao Lie89d9c12019-11-21 19:02:51 -08002041
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002042 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08002043
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002044 const bool include_sensitive_info = !PropertiesHelper::IsUserBuild();
Jayachandran Ca94c7172017-06-10 15:08:12 -07002045
Rhed Jaob5685b32020-08-14 17:19:17 +08002046 DumpstateRadioAsRoot();
2047 if (!DropRootUser()) {
2048 return;
2049 }
2050
2051 // Starts thread pool after the root user is dropped, and two additional threads
2052 // are created for DumpHals in the DumpstateRadioCommon and DumpstateBoard.
Chris Morinbc223142022-02-04 14:17:11 -08002053 std::future<std::string> dump_board;
Rhed Jaob5685b32020-08-14 17:19:17 +08002054 if (ds.dump_pool_) {
2055 ds.dump_pool_->start(/*thread_counts =*/2);
2056
2057 // DumpstateBoard takes long time, post it to the another thread in the pool,
2058 // if pool is available.
Chris Morinbc223142022-02-04 14:17:11 -08002059 dump_board = ds.dump_pool_->enqueueTaskWithFd(
2060 DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
Rhed Jaob5685b32020-08-14 17:19:17 +08002061 }
2062
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002063 DumpstateRadioCommon(include_sensitive_info);
2064
2065 if (include_sensitive_info) {
2066 // Contains too much unrelated PII, and given the unstructured nature of sysprops, we can't
2067 // really cherrypick all of the connectivity-related ones. Apps generally have no business
2068 // reading these anyway, and there should be APIs to supply the info in a more app-friendly
2069 // way.
2070 RunCommand("SYSTEM PROPERTIES", {"getprop"});
2071 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002072
2073 printf("========================================================\n");
2074 printf("== Android Framework Services\n");
2075 printf("========================================================\n");
2076
Vishnu Nair652cc802017-11-30 15:18:30 -08002077 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
2078 SEC_TO_MSEC(10));
Hunter Knepshield31cbae12021-05-11 16:23:24 -07002079 RunDumpsys("DUMPSYS", {"vcn_management"}, CommandOptions::WithTimeout(90).Build(),
2080 SEC_TO_MSEC(10));
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08002081 if (include_sensitive_info) {
2082 // Carrier apps' services will be dumped below in dumpsys activity service all-non-platform.
2083 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
2084 SEC_TO_MSEC(10));
2085 } else {
2086 // If the caller is a carrier app and has a carrier service, dump it here since we aren't
2087 // running dumpsys activity service all-non-platform below. Due to the increased output, we
2088 // give a higher timeout as well.
2089 RunDumpsys("DUMPSYS", {"carrier_config", "--requesting-package", calling_package},
2090 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(30));
2091 }
2092 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002093 RunDumpsys("DUMPSYS", {"netpolicy"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
2094 RunDumpsys("DUMPSYS", {"network_management"}, CommandOptions::WithTimeout(90).Build(),
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07002095 SEC_TO_MSEC(10));
Hunter Knepshield0fe51b12020-03-05 16:58:20 -08002096 RunDumpsys("DUMPSYS", {"telephony.registry"}, CommandOptions::WithTimeout(90).Build(),
2097 SEC_TO_MSEC(10));
Jack Yu773cc032023-03-16 22:43:39 -07002098 RunDumpsys("DUMPSYS", {"isub"}, CommandOptions::WithTimeout(90).Build(),
2099 SEC_TO_MSEC(10));
Grant Menke9bf3b2b2023-02-24 13:11:07 -08002100 RunDumpsys("DUMPSYS", {"telecom"}, CommandOptions::WithTimeout(90).Build(),
2101 SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002102 if (include_sensitive_info) {
2103 // Contains raw IP addresses, omit from reports on user builds.
2104 RunDumpsys("DUMPSYS", {"netd"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
2105 // Contains raw destination IP/MAC addresses, omit from reports on user builds.
2106 RunDumpsys("DUMPSYS", {"connmetrics"}, CommandOptions::WithTimeout(90).Build(),
2107 SEC_TO_MSEC(10));
2108 // Contains package/component names, omit from reports on user builds.
2109 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
2110 SEC_TO_MSEC(10));
2111 // Contains package names, but should be relatively simple to remove them (also contains
2112 // UIDs already), omit from reports on user builds.
2113 RunDumpsys("BATTERYSTATS", {"deviceidle"}, CommandOptions::WithTimeout(90).Build(),
2114 SEC_TO_MSEC(10));
2115 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002116
2117 printf("========================================================\n");
2118 printf("== Running Application Services\n");
2119 printf("========================================================\n");
2120
2121 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
2122
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002123 if (include_sensitive_info) {
2124 printf("========================================================\n");
2125 printf("== Running Application Services (non-platform)\n");
2126 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002127
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002128 // Contains package/component names and potential PII, omit from reports on user builds.
2129 // To get dumps of the active CarrierService(s) on user builds, we supply an argument to the
2130 // carrier_config dumpsys instead.
2131 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
2132 DUMPSYS_COMPONENTS_OPTIONS);
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002133
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002134 printf("========================================================\n");
2135 printf("== Checkins\n");
2136 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002137
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002138 // Contains package/component names, omit from reports on user builds.
2139 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
2140 }
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002141
2142 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07002143 printf("== dumpstate: done (id %d)\n", ds.id_);
2144 printf("========================================================\n");
Rhed Jaob5685b32020-08-14 17:19:17 +08002145
2146 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08002147 WaitForTask(std::move(dump_board));
Rhed Jaob5685b32020-08-14 17:19:17 +08002148 } else {
2149 RUN_SLOW_FUNCTION_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
2150 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002151}
2152
mukesh agrawal253dad42018-01-23 21:59:59 -08002153// This method collects dumpsys for wifi debugging only
2154static void DumpstateWifiOnly() {
2155 DurationReporter duration_reporter("DUMPSTATE");
2156
Rhed Jaob5685b32020-08-14 17:19:17 +08002157 DumpstateRadioAsRoot();
2158 if (!DropRootUser()) {
2159 return;
2160 }
2161
2162 // Starts thread pool after the root user is dropped. Only one additional
2163 // thread is needed for DumpHals in the DumpstateRadioCommon.
2164 if (ds.dump_pool_) {
2165 ds.dump_pool_->start(/*thread_counts =*/1);
2166 }
2167
mukesh agrawal253dad42018-01-23 21:59:59 -08002168 DumpstateRadioCommon();
2169
2170 printf("========================================================\n");
2171 printf("== Android Framework Services\n");
2172 printf("========================================================\n");
2173
2174 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
2175 SEC_TO_MSEC(10));
2176 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
2177 SEC_TO_MSEC(10));
2178
2179 printf("========================================================\n");
2180 printf("== dumpstate: done (id %d)\n", ds.id_);
2181 printf("========================================================\n");
2182}
2183
Elis Elliott8e401ad2023-08-08 11:18:59 +00002184// Collects a lightweight dumpstate to be used for debugging onboarding related flows.
2185static void DumpstateOnboardingOnly() {
2186 ds.AddDir(LOGPERSIST_DATA_DIR, false);
2187}
2188
Nandana Duttcf419a72019-03-14 10:40:17 +00002189Dumpstate::RunStatus Dumpstate::DumpTraces(const char** path) {
Gavin Corkery789d7a52021-02-24 23:52:35 +00002190 const std::string temp_file_pattern = ds.bugreport_internal_dir_ + "/dumptrace_XXXXXX";
Nandana Duttfaafd522019-03-11 09:23:09 +00002191 const size_t buf_size = temp_file_pattern.length() + 1;
2192 std::unique_ptr<char[]> file_name_buf(new char[buf_size]);
2193 memcpy(file_name_buf.get(), temp_file_pattern.c_str(), buf_size);
2194
2195 // Create a new, empty file to receive all trace dumps.
2196 //
2197 // TODO: This can be simplified once we remove support for the old style
2198 // dumps. We can have a file descriptor passed in to dump_traces instead
2199 // of creating a file, closing it and then reopening it again.
2200 android::base::unique_fd fd(mkostemp(file_name_buf.get(), O_APPEND | O_CLOEXEC));
2201 if (fd < 0) {
2202 MYLOGE("mkostemp on pattern %s: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002203 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002204 }
2205
2206 // Nobody should have access to this temporary file except dumpstate, but we
2207 // temporarily grant 'read' to 'others' here because this file is created
2208 // when tombstoned is still running as root, but dumped after dropping. This
2209 // can go away once support for old style dumping has.
2210 const int chmod_ret = fchmod(fd, 0666);
2211 if (chmod_ret < 0) {
2212 MYLOGE("fchmod on %s failed: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002213 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002214 }
2215
2216 std::unique_ptr<DIR, decltype(&closedir)> proc(opendir("/proc"), closedir);
2217 if (proc.get() == nullptr) {
2218 MYLOGE("opendir /proc failed: %s\n", strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002219 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002220 }
2221
2222 // Number of times process dumping has timed out. If we encounter too many
2223 // failures, we'll give up.
2224 int timeout_failures = 0;
2225 bool dalvik_found = false;
2226
Jayant Chowdharya0a8eb22022-05-20 03:30:09 +00002227 const std::set<int> hal_pids = get_interesting_pids();
Nandana Duttfaafd522019-03-11 09:23:09 +00002228
2229 struct dirent* d;
2230 while ((d = readdir(proc.get()))) {
Nandana Duttcf419a72019-03-14 10:40:17 +00002231 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttfaafd522019-03-11 09:23:09 +00002232 int pid = atoi(d->d_name);
2233 if (pid <= 0) {
2234 continue;
2235 }
2236
Kevin Jeond0f8a982023-04-07 14:27:11 -04002237 // Skip cached processes.
2238 if (IsCached(pid)) {
2239 // For consistency, the header and footer to this message match those
2240 // dumped by debuggerd in the success case.
2241 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
2242 dprintf(fd, "Dump skipped for cached process.\n");
2243 dprintf(fd, "---- end %d ----", pid);
2244 continue;
2245 }
2246
Nandana Duttfaafd522019-03-11 09:23:09 +00002247 const std::string link_name = android::base::StringPrintf("/proc/%d/exe", pid);
2248 std::string exe;
2249 if (!android::base::Readlink(link_name, &exe)) {
2250 continue;
2251 }
2252
2253 bool is_java_process;
2254 if (exe == "/system/bin/app_process32" || exe == "/system/bin/app_process64") {
2255 // Don't bother dumping backtraces for the zygote.
2256 if (IsZygote(pid)) {
2257 continue;
2258 }
2259
2260 dalvik_found = true;
2261 is_java_process = true;
2262 } else if (should_dump_native_traces(exe.c_str()) || hal_pids.find(pid) != hal_pids.end()) {
2263 is_java_process = false;
2264 } else {
2265 // Probably a native process we don't care about, continue.
2266 continue;
2267 }
2268
2269 // If 3 backtrace dumps fail in a row, consider debuggerd dead.
2270 if (timeout_failures == 3) {
2271 dprintf(fd, "ERROR: Too many stack dump failures, exiting.\n");
2272 break;
2273 }
2274
2275 const uint64_t start = Nanotime();
2276 const int ret = dump_backtrace_to_file_timeout(
Kevin Jeonb8a39362023-04-04 15:00:34 -04002277 pid, is_java_process ? kDebuggerdJavaBacktrace : kDebuggerdNativeBacktrace, 3, fd);
Nandana Duttfaafd522019-03-11 09:23:09 +00002278
2279 if (ret == -1) {
2280 // For consistency, the header and footer to this message match those
2281 // dumped by debuggerd in the success case.
2282 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
2283 dprintf(fd, "Dump failed, likely due to a timeout.\n");
2284 dprintf(fd, "---- end %d ----", pid);
2285 timeout_failures++;
2286 continue;
2287 }
2288
2289 // We've successfully dumped stack traces, reset the failure count
2290 // and write a summary of the elapsed time to the file and continue with the
2291 // next process.
2292 timeout_failures = 0;
2293
2294 dprintf(fd, "[dump %s stack %d: %.3fs elapsed]\n", is_java_process ? "dalvik" : "native",
2295 pid, (float)(Nanotime() - start) / NANOS_PER_SEC);
2296 }
2297
2298 if (!dalvik_found) {
2299 MYLOGE("Warning: no Dalvik processes found to dump stacks\n");
2300 }
2301
Nandana Duttcf419a72019-03-14 10:40:17 +00002302 *path = file_name_buf.release();
2303 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002304}
2305
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002306static dumpstate_hal_hidl::DumpstateMode GetDumpstateHalModeHidl(
2307 const Dumpstate::BugreportMode bugreport_mode) {
2308 switch (bugreport_mode) {
2309 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2310 return dumpstate_hal_hidl::DumpstateMode::FULL;
2311 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2312 return dumpstate_hal_hidl::DumpstateMode::INTERACTIVE;
2313 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2314 return dumpstate_hal_hidl::DumpstateMode::REMOTE;
2315 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2316 return dumpstate_hal_hidl::DumpstateMode::WEAR;
2317 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2318 return dumpstate_hal_hidl::DumpstateMode::CONNECTIVITY;
2319 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2320 return dumpstate_hal_hidl::DumpstateMode::WIFI;
Elis Elliott8e401ad2023-08-08 11:18:59 +00002321 case Dumpstate::BugreportMode::BUGREPORT_ONBOARDING:
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002322 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2323 return dumpstate_hal_hidl::DumpstateMode::DEFAULT;
2324 }
2325 return dumpstate_hal_hidl::DumpstateMode::DEFAULT;
2326}
2327
2328static dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode GetDumpstateHalModeAidl(
2329 const Dumpstate::BugreportMode bugreport_mode) {
2330 switch (bugreport_mode) {
2331 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2332 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::FULL;
2333 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2334 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::INTERACTIVE;
2335 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2336 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::REMOTE;
2337 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2338 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::WEAR;
2339 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2340 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::CONNECTIVITY;
2341 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2342 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::WIFI;
Elis Elliott8e401ad2023-08-08 11:18:59 +00002343 case Dumpstate::BugreportMode::BUGREPORT_ONBOARDING:
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002344 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2345 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::DEFAULT;
2346 }
2347 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::DEFAULT;
2348}
2349
2350static void DoDumpstateBoardHidl(
2351 const sp<dumpstate_hal_hidl_1_0::IDumpstateDevice> dumpstate_hal_1_0,
2352 const std::vector<::ndk::ScopedFileDescriptor>& dumpstate_fds,
2353 const Dumpstate::BugreportMode bugreport_mode,
2354 const size_t timeout_sec) {
2355
2356 using ScopedNativeHandle =
2357 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
2358 ScopedNativeHandle handle(native_handle_create(static_cast<int>(dumpstate_fds.size()), 0),
2359 [](native_handle_t* handle) {
2360 // we don't close file handle's here
2361 // via native_handle_close(handle)
2362 // instead we let dumpstate_fds close the file handles when
2363 // dumpstate_fds gets destroyed
2364 native_handle_delete(handle);
2365 });
2366 if (handle == nullptr) {
2367 MYLOGE("Could not create native_handle for dumpstate HAL\n");
2368 return;
2369 }
2370
2371 for (size_t i = 0; i < dumpstate_fds.size(); i++) {
2372 handle.get()->data[i] = dumpstate_fds[i].get();
2373 }
2374
2375 // Prefer version 1.1 if available. New devices launching with R are no longer allowed to
2376 // implement just 1.0.
2377 const char* descriptor_to_kill;
2378 using DumpstateBoardTask = std::packaged_task<bool()>;
2379 DumpstateBoardTask dumpstate_board_task;
2380 sp<dumpstate_hal_hidl::IDumpstateDevice> dumpstate_hal(
2381 dumpstate_hal_hidl::IDumpstateDevice::castFrom(dumpstate_hal_1_0));
2382 if (dumpstate_hal != nullptr) {
2383 MYLOGI("Using IDumpstateDevice v1.1 HIDL HAL");
2384
2385 dumpstate_hal_hidl::DumpstateMode dumpstate_hal_mode =
2386 GetDumpstateHalModeHidl(bugreport_mode);
2387
2388 descriptor_to_kill = dumpstate_hal_hidl::IDumpstateDevice::descriptor;
2389 dumpstate_board_task =
2390 DumpstateBoardTask([timeout_sec, dumpstate_hal_mode, dumpstate_hal, &handle]() -> bool {
2391 ::android::hardware::Return<dumpstate_hal_hidl::DumpstateStatus> status =
2392 dumpstate_hal->dumpstateBoard_1_1(handle.get(), dumpstate_hal_mode,
2393 SEC_TO_MSEC(timeout_sec));
2394 if (!status.isOk()) {
2395 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2396 return false;
2397 } else if (status != dumpstate_hal_hidl::DumpstateStatus::OK) {
2398 MYLOGE("dumpstateBoard failed with DumpstateStatus::%s\n",
2399 dumpstate_hal_hidl::toString(status).c_str());
2400 return false;
2401 }
2402 return true;
2403 });
2404 } else {
2405 MYLOGI("Using IDumpstateDevice v1.0 HIDL HAL");
2406
2407 descriptor_to_kill = dumpstate_hal_hidl_1_0::IDumpstateDevice::descriptor;
2408 dumpstate_board_task = DumpstateBoardTask([dumpstate_hal_1_0, &handle]() -> bool {
2409 ::android::hardware::Return<void> status =
2410 dumpstate_hal_1_0->dumpstateBoard(handle.get());
2411 if (!status.isOk()) {
2412 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2413 return false;
2414 }
2415 return true;
2416 });
2417 }
2418 auto result = dumpstate_board_task.get_future();
2419 std::thread(std::move(dumpstate_board_task)).detach();
2420
2421 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2422 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate HAL\n", timeout_sec);
2423 if (!android::base::SetProperty(
2424 "ctl.interface_restart",
2425 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
2426 MYLOGE("Couldn't restart dumpstate HAL\n");
2427 }
2428 }
2429 // Wait some time for init to kill dumpstate vendor HAL
2430 constexpr size_t killing_timeout_sec = 10;
2431 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2432 MYLOGE(
2433 "killing dumpstateBoard timed out after %zus, continue and "
2434 "there might be racing in content\n",
2435 killing_timeout_sec);
2436 }
2437}
2438
2439static void DoDumpstateBoardAidl(
2440 const std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> dumpstate_hal,
2441 const std::vector<::ndk::ScopedFileDescriptor>& dumpstate_fds,
2442 const Dumpstate::BugreportMode bugreport_mode, const size_t timeout_sec) {
2443 MYLOGI("Using IDumpstateDevice AIDL HAL");
2444
2445 const char* descriptor_to_kill;
2446 using DumpstateBoardTask = std::packaged_task<bool()>;
2447 DumpstateBoardTask dumpstate_board_task;
2448 dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode dumpstate_hal_mode =
2449 GetDumpstateHalModeAidl(bugreport_mode);
2450
2451 descriptor_to_kill = dumpstate_hal_aidl::IDumpstateDevice::descriptor;
2452 dumpstate_board_task = DumpstateBoardTask([dumpstate_hal, &dumpstate_fds, dumpstate_hal_mode,
2453 timeout_sec]() -> bool {
2454 auto status = dumpstate_hal->dumpstateBoard(dumpstate_fds, dumpstate_hal_mode, timeout_sec);
2455
2456 if (!status.isOk()) {
2457 MYLOGE("dumpstateBoard failed: %s\n", status.getDescription().c_str());
2458 return false;
2459 }
2460 return true;
2461 });
2462 auto result = dumpstate_board_task.get_future();
2463 std::thread(std::move(dumpstate_board_task)).detach();
2464
2465 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2466 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate HAL\n", timeout_sec);
2467 if (!android::base::SetProperty(
2468 "ctl.interface_restart",
2469 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
2470 MYLOGE("Couldn't restart dumpstate HAL\n");
2471 }
2472 }
2473 // Wait some time for init to kill dumpstate vendor HAL
2474 constexpr size_t killing_timeout_sec = 10;
2475 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2476 MYLOGE(
2477 "killing dumpstateBoard timed out after %zus, continue and "
2478 "there might be racing in content\n",
2479 killing_timeout_sec);
2480 }
2481}
2482
2483static std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> GetDumpstateBoardAidlService() {
2484 const std::string aidl_instance_name =
2485 std::string(dumpstate_hal_aidl::IDumpstateDevice::descriptor) + "/default";
2486
2487 if (!AServiceManager_isDeclared(aidl_instance_name.c_str())) {
2488 return nullptr;
2489 }
2490
2491 ndk::SpAIBinder dumpstateBinder(AServiceManager_waitForService(aidl_instance_name.c_str()));
2492
2493 return dumpstate_hal_aidl::IDumpstateDevice::fromBinder(dumpstateBinder);
2494}
2495
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002496void Dumpstate::DumpstateBoard(int out_fd) {
2497 dprintf(out_fd, "========================================================\n");
2498 dprintf(out_fd, "== Board\n");
2499 dprintf(out_fd, "========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08002500
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002501 /*
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002502 * mount debugfs for non-user builds with ro.product.debugfs_restrictions.enabled
Hridya Valsaraju51101602021-04-02 14:32:46 -07002503 * set to true and unmount it after invoking dumpstateBoard_* methods.
2504 * This is to enable debug builds to not have debugfs mounted during runtime.
2505 * It will also ensure that debugfs is only accessed by the dumpstate HAL.
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002506 */
Hridya Valsaraju51101602021-04-02 14:32:46 -07002507 auto mount_debugfs =
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002508 android::base::GetBoolProperty("ro.product.debugfs_restrictions.enabled", false);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002509 if (mount_debugfs) {
2510 RunCommand("mount debugfs", {"mount", "-t", "debugfs", "debugfs", "/sys/kernel/debug"},
2511 AS_ROOT_20);
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002512 RunCommand("chmod debugfs", {"chmod", "0755", "/sys/kernel/debug"}, AS_ROOT_20);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002513 }
2514
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002515 std::vector<std::string> paths;
2516 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07002517 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002518 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
2519 kDumpstateBoardFiles[i].c_str()));
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002520 remover.emplace_back(android::base::make_scope_guard(
2521 std::bind([](std::string path) { android::os::UnlinkAndLogOnError(path); }, paths[i])));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002522 }
Jie Song9fbfad02017-06-20 16:29:42 -07002523
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002524 // get dumpstate HAL AIDL implementation
2525 std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> dumpstate_hal_handle_aidl(
2526 GetDumpstateBoardAidlService());
2527 if (dumpstate_hal_handle_aidl == nullptr) {
2528 MYLOGI("No IDumpstateDevice AIDL implementation\n");
2529 }
2530
2531 // get dumpstate HAL HIDL implementation, only if AIDL HAL implementation not found
2532 sp<dumpstate_hal_hidl_1_0::IDumpstateDevice> dumpstate_hal_handle_hidl_1_0 = nullptr;
2533 if (dumpstate_hal_handle_aidl == nullptr) {
2534 dumpstate_hal_handle_hidl_1_0 = dumpstate_hal_hidl_1_0::IDumpstateDevice::getService();
2535 if (dumpstate_hal_handle_hidl_1_0 == nullptr) {
2536 MYLOGI("No IDumpstateDevice HIDL implementation\n");
2537 }
2538 }
2539
2540 // if neither HIDL nor AIDL implementation found, then return
2541 if (dumpstate_hal_handle_hidl_1_0 == nullptr && dumpstate_hal_handle_aidl == nullptr) {
2542 MYLOGE("Could not find IDumpstateDevice implementation\n");
Wei Wang587eac92018-04-05 12:17:20 -07002543 return;
2544 }
2545
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002546 // this is used to hold the file descriptors and when this variable goes out of scope
2547 // the file descriptors are closed
2548 std::vector<::ndk::ScopedFileDescriptor> dumpstate_fds;
Wei Wang587eac92018-04-05 12:17:20 -07002549
Nandana Dutt5c390032019-03-12 10:52:56 +00002550 // TODO(128270426): Check for consent in between?
Wei Wang587eac92018-04-05 12:17:20 -07002551 for (size_t i = 0; i < paths.size(); i++) {
2552 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
2553
2554 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
2555 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
2556 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
2557 if (fd < 0) {
2558 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
2559 return;
2560 }
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002561
2562 dumpstate_fds.emplace_back(fd.release());
2563 // we call fd.release() here to make sure "fd" does not get closed
2564 // after "fd" goes out of scope after this block.
2565 // "fd" will be closed when "dumpstate_fds" goes out of scope
2566 // i.e. when we exit this function
Wei Wang587eac92018-04-05 12:17:20 -07002567 }
2568
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002569 // Given that bugreport is required to diagnose failures, it's better to set an arbitrary amount
2570 // of timeout for IDumpstateDevice than to block the rest of bugreport. In the timeout case, we
2571 // will kill the HAL and grab whatever it dumped in time.
Michael Eastwood8523ea02022-03-10 16:33:08 -08002572 constexpr size_t timeout_sec = 45;
Wei Wang587eac92018-04-05 12:17:20 -07002573
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002574 if (dumpstate_hal_handle_aidl != nullptr) {
2575 DoDumpstateBoardAidl(dumpstate_hal_handle_aidl, dumpstate_fds, options_->bugreport_mode,
2576 timeout_sec);
2577 } else if (dumpstate_hal_handle_hidl_1_0 != nullptr) {
2578 // run HIDL HAL only if AIDL HAL not found
2579 DoDumpstateBoardHidl(dumpstate_hal_handle_hidl_1_0, dumpstate_fds, options_->bugreport_mode,
2580 timeout_sec);
Wei Wang587eac92018-04-05 12:17:20 -07002581 }
2582
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002583 if (mount_debugfs) {
Hridya Valsaraju51101602021-04-02 14:32:46 -07002584 auto keep_debugfs_mounted =
2585 android::base::GetProperty("persist.dbg.keep_debugfs_mounted", "");
2586 if (keep_debugfs_mounted.empty())
2587 RunCommand("unmount debugfs", {"umount", "/sys/kernel/debug"}, AS_ROOT_20);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002588 }
2589
Wei Wang587eac92018-04-05 12:17:20 -07002590 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
2591 for (size_t i = 0; i < paths.size(); i++) {
2592 struct stat s;
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002593 if (fstat(dumpstate_fds[i].get(), &s) == -1) {
2594 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(), strerror(errno));
Wei Wang587eac92018-04-05 12:17:20 -07002595 file_sizes[i] = -1;
2596 continue;
2597 }
2598 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002599 }
2600
2601 for (size_t i = 0; i < paths.size(); i++) {
2602 if (file_sizes[i] == -1) {
2603 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002604 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002605 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07002606 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002607 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002608 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002609 remover[i].Disable();
2610 EnqueueAddZipEntryAndCleanupIfNeeded(kDumpstateBoardFiles[i], paths[i]);
2611 dprintf(out_fd, "*** See %s entry ***\n", kDumpstateBoardFiles[i].c_str());
Jie Song9fbfad02017-06-20 16:29:42 -07002612 }
Felipe Leme6f674ae2016-11-18 17:10:33 -08002613}
2614
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002615static void ShowUsage() {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002616 fprintf(stderr,
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002617 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-o directory] [-p] "
2618 "[-s] [-S] [-q] [-P] [-R] [-L] [-V version]\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002619 " -h: display this help message\n"
2620 " -b: play sound file instead of vibrate, at beginning of job\n"
2621 " -e: play sound file instead of vibrate, at end of job\n"
mhasank2d75c442020-06-11 15:05:25 -07002622 " -o: write to custom directory (only in limited mode)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01002623 " -p: capture screenshot to filename.png\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002624 " -s: write zipped file to control socket (for init)\n"
2625 " -S: write file location to control socket (for init)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002626 " -q: disable vibrate\n"
Abhijeet Kaure370d682019-10-01 16:49:30 +01002627 " -P: send broadcast when started and do progress updates\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002628 " -R: take bugreport in remote mode (shouldn't be used with -P)\n"
Nandana Dutt235864b2019-01-22 12:10:16 +00002629 " -w: start binder service and make it wait for a call to startBugreport\n"
mhasankd451a472020-05-26 18:02:39 -07002630 " -L: output limited information that is safe for submission in feedback reports\n"
Felipe Lemed071c682016-10-20 16:48:00 -07002631 " -v: prints the dumpstate header and exit\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002632}
2633
Wei Liuf87959e2016-08-26 14:51:42 -07002634static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07002635 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07002636}
2637
Felipe Leme1d486fe2016-10-14 18:06:47 -07002638bool Dumpstate::FinishZipFile() {
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002639 // Runs all enqueued adding zip entry and cleanup tasks before finishing the zip file.
2640 if (zip_entry_tasks_) {
2641 zip_entry_tasks_->run(/* do_cancel = */false);
2642 }
2643
Felipe Leme9a523ae2016-10-20 15:10:33 -07002644 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07002645 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07002646 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002647 // Final timestamp
2648 char date[80];
2649 time_t the_real_now_please_stand_up = time(nullptr);
2650 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002651 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07002652 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002653
Felipe Leme9a523ae2016-10-20 15:10:33 -07002654 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002655 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08002656 return false;
2657 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07002658 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002659 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08002660 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08002661 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08002662
Felipe Leme0f3fb202016-06-10 17:10:53 -07002663 // Add log file (which contains stderr output) to zip...
2664 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07002665 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07002666 MYLOGE("Failed to add dumpstate log to .zip file\n");
2667 return false;
2668 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002669 // TODO: Should truncate the existing file.
2670 // ... and re-open it for further logging.
Nandana Dutta344cb62019-02-22 15:12:35 +00002671 if (!redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()))) {
2672 return false;
2673 }
Felipe Leme0f3fb202016-06-10 17:10:53 -07002674 fprintf(stderr, "\n");
2675
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002676 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07002677 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002678 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002679 return false;
2680 }
2681
Felipe Leme1d486fe2016-10-14 18:06:47 -07002682 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
2683 ds.zip_file.reset(nullptr);
2684
Felipe Lemee9d2c542016-11-15 11:48:26 -08002685 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002686 android::os::UnlinkAndLogOnError(tmp_path_);
Felipe Lemec4eee562016-04-21 15:42:55 -07002687
Felipe Leme1e9edc62015-12-21 16:02:13 -08002688 return true;
2689}
Felipe Leme6e01fa62015-11-11 19:35:14 -08002690
Nikhil Kumar28ce35e2023-01-10 14:32:44 +00002691static void SendBroadcast(const std::string& action,
2692 const std::vector<std::string>& args,
2693 int32_t user_id) {
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002694 // clang-format off
Nikhil Kumar28ce35e2023-01-10 14:32:44 +00002695 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user",
2696 std::to_string(user_id), "--receiver-foreground",
2697 "--receiver-include-background", "-a", action};
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002698 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08002699
2700 am.insert(am.end(), args.begin(), args.end());
2701
Felipe Leme8d2410e2017-02-08 09:46:08 -08002702 RunCommand("", am,
2703 CommandOptions::WithTimeout(20)
2704 .Log("Sending broadcast: '%s'\n")
2705 .Always()
2706 .DropRoot()
2707 .RedirectStderr()
2708 .Build());
2709}
2710
Felipe Leme35b8cf12017-02-10 15:47:29 -08002711static void Vibrate(int duration_ms) {
2712 // clang-format off
Lais Andrade51156962021-02-22 19:21:35 +00002713 std::vector<std::string> args = {"cmd", "vibrator_manager", "synced", "-f", "-d", "dumpstate",
2714 "oneshot", std::to_string(duration_ms)};
2715 RunCommand("", args,
Felipe Leme35b8cf12017-02-10 15:47:29 -08002716 CommandOptions::WithTimeout(10)
2717 .Log("Vibrate: '%s'\n")
2718 .Always()
2719 .Build());
2720 // clang-format on
2721}
2722
Nandana Dutt979388e2018-11-30 16:48:55 +00002723static void MaybeResolveSymlink(std::string* path) {
2724 std::string resolved_path;
2725 if (android::base::Readlink(*path, &resolved_path)) {
2726 *path = resolved_path;
2727 }
2728}
2729
Nandana Dutt4be45d12018-09-26 15:04:23 +01002730/*
2731 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002732 * and adds the version file. Return false if zip_file could not be open to write.
Nandana Dutt4be45d12018-09-26 15:04:23 +01002733 */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002734static bool PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002735 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
2736
Nandana Dutt4be45d12018-09-26 15:04:23 +01002737 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
2738 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002739 ds.base_name_ = StringPrintf("bugreport-%s-%s", device_name.c_str(), build_id.c_str());
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002740 char date[80];
2741 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
2742 ds.name_ = date;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002743
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002744 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002745 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002746 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002747 ds.base_name_ += "-wifi";
2748 }
2749
Paul Chang0d2aad72020-02-13 20:04:03 +08002750 if (ds.options_->do_screenshot) {
Nandana Dutt9d17b942020-03-26 10:02:59 +00002751 ds.screenshot_path_ = ds.GetPath(ds.CalledByApi() ? "-png.tmp" : ".png");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002752 }
2753 ds.tmp_path_ = ds.GetPath(".tmp");
2754 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
2755
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002756 std::string destination = ds.CalledByApi()
Nandana Dutt54dbd672019-01-11 12:58:05 +00002757 ? StringPrintf("[fd:%d]", ds.options_->bugreport_fd.get())
Nandana Dutt9a76d202019-01-21 15:56:48 +00002758 : ds.bugreport_internal_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01002759 MYLOGD(
Nandana Dutt235c6672019-11-14 15:22:32 +00002760 "Bugreport dir: [%s] "
2761 "Base name: [%s] "
2762 "Suffix: [%s] "
2763 "Log path: [%s] "
2764 "Temporary path: [%s] "
2765 "Screenshot path: [%s]\n",
Nandana Dutt9a76d202019-01-21 15:56:48 +00002766 destination.c_str(), ds.base_name_.c_str(), ds.name_.c_str(), ds.log_path_.c_str(),
2767 ds.tmp_path_.c_str(), ds.screenshot_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002768
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002769 ds.path_ = ds.GetPath(ds.CalledByApi() ? "-zip.tmp" : ".zip");
2770 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
2771 create_parent_dirs(ds.path_.c_str());
2772 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
2773 if (ds.zip_file == nullptr) {
2774 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
2775 return false;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002776 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002777 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
2778 ds.AddTextZipEntry("version.txt", ds.version_);
2779 return true;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002780}
2781
2782/*
Abhijeet Kaure370d682019-10-01 16:49:30 +01002783 * Finalizes writing to the file by zipping the tmp file to the final location,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002784 * printing zipped file status, etc.
2785 */
2786static void FinalizeFile() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002787 bool do_text_file = !ds.FinishZipFile();
2788 if (do_text_file) {
2789 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002790 }
mhasank2d75c442020-06-11 15:05:25 -07002791
2792 std::string final_path = ds.path_;
2793 if (ds.options_->OutputToCustomFile()) {
mhasank3a4cfb42020-06-15 18:06:43 -07002794 final_path = ds.GetPath(ds.options_->out_dir, ".zip");
mhasank2d75c442020-06-11 15:05:25 -07002795 android::os::CopyFileToFile(ds.path_, final_path);
2796 }
2797
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002798 if (ds.options_->stream_to_socket) {
2799 android::os::CopyFileToFd(ds.path_, ds.control_socket_fd_);
2800 } else if (ds.options_->progress_updates_to_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002801 if (do_text_file) {
2802 dprintf(ds.control_socket_fd_,
2803 "FAIL:could not create zip file, check %s "
2804 "for more details\n",
2805 ds.log_path_.c_str());
2806 } else {
mhasank2d75c442020-06-11 15:05:25 -07002807 dprintf(ds.control_socket_fd_, "OK:%s\n", final_path.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002808 }
2809 }
2810}
2811
Nandana Dutt4be45d12018-09-26 15:04:23 +01002812
Nandana Dutt58d72e22018-11-16 10:30:48 +00002813static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2814 switch (mode) {
2815 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2816 return "BUGREPORT_FULL";
2817 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2818 return "BUGREPORT_INTERACTIVE";
2819 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2820 return "BUGREPORT_REMOTE";
2821 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2822 return "BUGREPORT_WEAR";
2823 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2824 return "BUGREPORT_TELEPHONY";
2825 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2826 return "BUGREPORT_WIFI";
Elis Elliott8e401ad2023-08-08 11:18:59 +00002827 case Dumpstate::BugreportMode::BUGREPORT_ONBOARDING:
2828 return "BUGREPORT_ONBOARDING";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002829 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2830 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002831 }
2832}
2833
Steven Leeb573eb82022-11-29 22:31:35 +08002834static bool IsConsentlessBugreportAllowed(const Dumpstate::DumpOptions& options) {
2835 // only BUGREPORT_TELEPHONY does not allow using consentless bugreport
2836 return !options.telephony_only;
2837}
2838
Paul Changf59c2b72020-03-10 02:08:55 +08002839static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options,
2840 bool is_screenshot_requested) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002841 // Modify com.android.shell.BugreportProgressService#isDefaultScreenshotRequired as well for
2842 // default system screenshots.
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002843 options->bugreport_mode = mode;
2844 options->bugreport_mode_string = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002845 switch (mode) {
2846 case Dumpstate::BugreportMode::BUGREPORT_FULL:
Paul Changf59c2b72020-03-10 02:08:55 +08002847 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002848 break;
2849 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002850 // Currently, the dumpstate binder is only used by Shell to update progress.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002851 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002852 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002853 break;
2854 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002855 options->do_vibrate = false;
2856 options->is_remote_mode = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002857 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002858 break;
2859 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
Robert Ginda55ecebd2023-04-03 22:53:13 +00002860 options->do_vibrate = false;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002861 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002862 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002863 break;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002864 // TODO(b/148168577) rename TELEPHONY everywhere to CONNECTIVITY.
Nandana Dutt58d72e22018-11-16 10:30:48 +00002865 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002866 options->telephony_only = true;
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002867 options->do_progress_updates = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002868 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002869 break;
2870 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002871 options->wifi_only = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002872 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002873 break;
Elis Elliott8e401ad2023-08-08 11:18:59 +00002874 case Dumpstate::BugreportMode::BUGREPORT_ONBOARDING:
2875 options->onboarding_only = true;
2876 options->do_screenshot = false;
2877 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002878 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2879 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002880 }
2881}
2882
Nandana Dutt58d72e22018-11-16 10:30:48 +00002883static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
Nandana Dutt235c6672019-11-14 15:22:32 +00002884 MYLOGI(
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002885 "do_vibrate: %d stream_to_socket: %d progress_updates_to_socket: %d do_screenshot: %d "
Rhed Jao25f50e02020-08-20 00:10:32 +08002886 "is_remote_mode: %d show_header_only: %d telephony_only: %d "
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002887 "wifi_only: %d do_progress_updates: %d fd: %d bugreport_mode: %s "
mhasankd451a472020-05-26 18:02:39 -07002888 "limited_only: %d args: %s\n",
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002889 options.do_vibrate, options.stream_to_socket, options.progress_updates_to_socket,
Paul Chang0d2aad72020-02-13 20:04:03 +08002890 options.do_screenshot, options.is_remote_mode, options.show_header_only,
Rhed Jao25f50e02020-08-20 00:10:32 +08002891 options.telephony_only, options.wifi_only,
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002892 options.do_progress_updates, options.bugreport_fd.get(),
2893 options.bugreport_mode_string.c_str(),
2894 options.limited_only, options.args.c_str());
Nandana Dutt58d72e22018-11-16 10:30:48 +00002895}
2896
Nandana Dutt54dbd672019-01-11 12:58:05 +00002897void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode,
Kean Mariotti306633e2022-09-05 16:30:47 +00002898 int bugreport_flags,
Nandana Dutt54dbd672019-01-11 12:58:05 +00002899 const android::base::unique_fd& bugreport_fd_in,
Paul Changf59c2b72020-03-10 02:08:55 +08002900 const android::base::unique_fd& screenshot_fd_in,
2901 bool is_screenshot_requested) {
Kean Mariotti306633e2022-09-05 16:30:47 +00002902 this->use_predumped_ui_data = bugreport_flags & BugreportFlag::BUGREPORT_USE_PREDUMPED_UI_DATA;
Gavin Corkerya44686c2022-11-23 18:16:51 +00002903 this->is_consent_deferred = bugreport_flags & BugreportFlag::BUGREPORT_FLAG_DEFER_CONSENT;
Nandana Dutt54dbd672019-01-11 12:58:05 +00002904 // Duplicate the fds because the passed in fds don't outlive the binder transaction.
Todd Frederick621533f2022-03-26 02:54:17 +00002905 bugreport_fd.reset(fcntl(bugreport_fd_in.get(), F_DUPFD_CLOEXEC, 0));
2906 screenshot_fd.reset(fcntl(screenshot_fd_in.get(), F_DUPFD_CLOEXEC, 0));
Nandana Dutt58d72e22018-11-16 10:30:48 +00002907
Paul Changf59c2b72020-03-10 02:08:55 +08002908 SetOptionsFromMode(bugreport_mode, this, is_screenshot_requested);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002909}
2910
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002911Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
2912 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002913 int c;
mhasankd451a472020-05-26 18:02:39 -07002914 while ((c = getopt(argc, argv, "dho:svqzpLPBRSV:w")) != -1) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002915 switch (c) {
2916 // clang-format off
mhasank3a4cfb42020-06-15 18:06:43 -07002917 case 'o': out_dir = optarg; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002918 case 's': stream_to_socket = true; break;
2919 case 'S': progress_updates_to_socket = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002920 case 'v': show_header_only = true; break;
2921 case 'q': do_vibrate = false; break;
Paul Chang0d2aad72020-02-13 20:04:03 +08002922 case 'p': do_screenshot = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002923 case 'P': do_progress_updates = true; break;
2924 case 'R': is_remote_mode = true; break;
mhasankd451a472020-05-26 18:02:39 -07002925 case 'L': limited_only = true; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002926 case 'V':
2927 case 'd':
2928 case 'z':
2929 // compatibility no-op
2930 break;
Nandana Dutt235864b2019-01-22 12:10:16 +00002931 case 'w':
2932 // This was already processed
2933 break;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002934 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002935 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002936 break;
2937 default:
2938 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002939 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002940 break;
2941 // clang-format on
2942 }
2943 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08002944
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002945 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002946 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002947 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002948 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002949 }
2950 }
2951
2952 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
2953 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002954
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002955 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002956}
2957
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002958bool Dumpstate::DumpOptions::ValidateOptions() const {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002959 if (bugreport_fd.get() != -1 && stream_to_socket) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002960 return false;
2961 }
2962
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002963 if ((progress_updates_to_socket || do_progress_updates) && stream_to_socket) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002964 return false;
2965 }
2966
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002967 if (is_remote_mode && (do_progress_updates || stream_to_socket)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002968 return false;
2969 }
2970 return true;
2971}
2972
Nandana Dutt197661d2018-11-16 16:40:21 +00002973void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
2974 options_ = std::move(options);
2975}
2976
Abhijeet Kaura407fb82020-03-27 12:51:12 +00002977void Dumpstate::Initialize() {
2978 /* gets the sequential id */
2979 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
2980 id_ = ++last_id;
2981 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
2982}
2983
Nandana Duttd2f5f082019-01-18 17:13:52 +00002984Dumpstate::RunStatus Dumpstate::Run(int32_t calling_uid, const std::string& calling_package) {
2985 Dumpstate::RunStatus status = RunInternal(calling_uid, calling_package);
Gavin Corkerya44686c2022-11-23 18:16:51 +00002986 HandleRunStatus(status);
2987 return status;
2988}
2989
Kholoud Mohamed7c3fb7c2023-10-18 12:56:22 +00002990Dumpstate::RunStatus Dumpstate::Retrieve(int32_t calling_uid, const std::string& calling_package,
2991 const bool keep_bugreport_on_retrieval) {
2992 Dumpstate::RunStatus status = RetrieveInternal(calling_uid, calling_package,
2993 keep_bugreport_on_retrieval);
Gavin Corkerya44686c2022-11-23 18:16:51 +00002994 HandleRunStatus(status);
2995 return status;
2996}
2997
2998Dumpstate::RunStatus Dumpstate::RetrieveInternal(int32_t calling_uid,
Kholoud Mohamed7c3fb7c2023-10-18 12:56:22 +00002999 const std::string& calling_package,
3000 const bool keep_bugreport_on_retrieval) {
Gavin Corkerya44686c2022-11-23 18:16:51 +00003001 consent_callback_ = new ConsentCallback();
3002 const String16 incidentcompanion("incidentcompanion");
3003 sp<android::IBinder> ics(
3004 defaultServiceManager()->checkService(incidentcompanion));
3005 android::String16 package(calling_package.c_str());
3006 if (ics != nullptr) {
3007 MYLOGD("Checking user consent via incidentcompanion service\n");
3008 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
3009 calling_uid, package, String16(), String16(),
3010 0x1 /* FLAG_CONFIRMATION_DIALOG */, consent_callback_.get());
3011 } else {
3012 MYLOGD(
3013 "Unable to check user consent; incidentcompanion service unavailable\n");
3014 return RunStatus::USER_CONSENT_TIMED_OUT;
3015 }
3016 UserConsentResult consent_result = consent_callback_->getResult();
3017 int timeout_ms = 30 * 1000;
3018 while (consent_result == UserConsentResult::UNAVAILABLE &&
3019 consent_callback_->getElapsedTimeMs() < timeout_ms) {
3020 sleep(1);
3021 consent_result = consent_callback_->getResult();
3022 }
3023 if (consent_result == UserConsentResult::DENIED) {
3024 return RunStatus::USER_CONSENT_DENIED;
3025 }
3026 if (consent_result == UserConsentResult::UNAVAILABLE) {
3027 MYLOGD("Canceling user consent request via incidentcompanion service\n");
3028 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
3029 consent_callback_.get());
3030 return RunStatus::USER_CONSENT_TIMED_OUT;
3031 }
3032
3033 bool copy_succeeded =
3034 android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
Kholoud Mohamed7c3fb7c2023-10-18 12:56:22 +00003035
3036 if (copy_succeeded && (!android::app::admin::flags::onboarding_bugreport_v2_enabled()
3037 || !keep_bugreport_on_retrieval)) {
3038 android::os::UnlinkAndLogOnError(path_);
Gavin Corkerya44686c2022-11-23 18:16:51 +00003039 }
Kholoud Mohamed7c3fb7c2023-10-18 12:56:22 +00003040
Gavin Corkerya44686c2022-11-23 18:16:51 +00003041 return copy_succeeded ? Dumpstate::RunStatus::OK
3042 : Dumpstate::RunStatus::ERROR;
3043}
3044
3045void Dumpstate::HandleRunStatus(Dumpstate::RunStatus status) {
3046 if (listener_ != nullptr) {
Nandana Duttbabf6c72019-01-15 14:11:12 +00003047 switch (status) {
3048 case Dumpstate::RunStatus::OK:
Gavin Corkerya44686c2022-11-23 18:16:51 +00003049 listener_->onFinished(path_.c_str());
Nandana Duttbabf6c72019-01-15 14:11:12 +00003050 break;
3051 case Dumpstate::RunStatus::HELP:
3052 break;
3053 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Duttd2f5f082019-01-18 17:13:52 +00003054 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_INVALID_INPUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00003055 break;
3056 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00003057 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_RUNTIME_ERROR);
3058 break;
3059 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
3060 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_DENIED_CONSENT);
3061 break;
3062 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
3063 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_CONSENT_TIMED_OUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00003064 break;
3065 }
3066 }
Nandana Duttbabf6c72019-01-15 14:11:12 +00003067}
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003068void Dumpstate::Cancel() {
3069 CleanupTmpFiles();
3070 android::os::UnlinkAndLogOnError(log_path_);
3071 for (int i = 0; i < NUM_OF_DUMPS; i++) {
3072 android::os::UnlinkAndLogOnError(ds.bugreport_internal_dir_ + "/" +
3073 kDumpstateBoardFiles[i]);
3074 }
3075 tombstone_data_.clear();
3076 anr_data_.clear();
Andy Hungd62f7e62024-01-11 15:47:52 -08003077 anr_trace_data_.clear();
Woody Lin20767a92022-11-29 15:50:24 +08003078 shutdown_checkpoints_.clear();
Rhed Jao0daac912020-08-21 14:48:20 +08003079
3080 // Instead of shutdown the pool, we delete temporary files directly since
3081 // shutdown blocking the call.
3082 if (dump_pool_) {
3083 dump_pool_->deleteTempFiles();
3084 }
3085 if (zip_entry_tasks_) {
3086 zip_entry_tasks_->run(/*do_cancel =*/ true);
3087 }
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003088}
3089
Kean Mariotti306633e2022-09-05 16:30:47 +00003090void Dumpstate::PreDumpUiData() {
Kean Mariotti853b73a2023-07-27 12:40:30 +00003091 MaybeSnapshotSystemTrace();
Kean Mariotti306633e2022-09-05 16:30:47 +00003092 MaybeSnapshotUiTraces();
3093}
3094
Nandana Dutt979388e2018-11-30 16:48:55 +00003095/*
3096 * Dumps relevant information to a bugreport based on the given options.
3097 *
3098 * The bugreport can be dumped to a file or streamed to a socket.
3099 *
3100 * How dumping to file works:
3101 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
3102 * stderr is redirected a log file.
3103 *
3104 * The temporary bugreport is then populated via printfs, dumping contents of files and
3105 * output of commands to stdout.
3106 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003107 * A bunch of other files and dumps are added to the zip archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00003108 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003109 * The temporary bugreport file and the log file also get added to the archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00003110 *
mhasank2d75c442020-06-11 15:05:25 -07003111 * Bugreports are first generated in a local directory and later copied to the caller's fd
3112 * or directory if supplied.
Nandana Dutt979388e2018-11-30 16:48:55 +00003113 */
Nandana Duttd2f5f082019-01-18 17:13:52 +00003114Dumpstate::RunStatus Dumpstate::RunInternal(int32_t calling_uid,
3115 const std::string& calling_package) {
Rhed Jao5377d792020-07-16 17:37:39 +08003116 DurationReporter duration_reporter("RUN INTERNAL", /* logcat_only = */true);
Nandana Dutt979388e2018-11-30 16:48:55 +00003117 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00003118 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00003119 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003120 return RunStatus::INVALID_INPUT;
3121 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003122 /* set as high priority, and protect from OOM killer */
3123 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07003124
Felipe Lemed071c682016-10-20 16:48:00 -07003125 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07003126 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07003127 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07003128 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07003129 } else {
3130 /* fallback to kernels <= 2.6.35 */
3131 oom_adj = fopen("/proc/self/oom_adj", "we");
3132 if (oom_adj) {
3133 fputs("-17", oom_adj);
3134 fclose(oom_adj);
3135 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003136 }
3137
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003138 if (version_ == VERSION_DEFAULT) {
3139 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00003140 }
3141
Chris Morin5a50d482022-02-01 17:41:18 -08003142 if (version_ != VERSION_CURRENT) {
3143 MYLOGE("invalid version requested ('%s'); supported values are: ('%s', '%s')\n",
3144 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003145 return RunStatus::INVALID_INPUT;
Felipe Lemed071c682016-10-20 16:48:00 -07003146 }
3147
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003148 if (options_->show_header_only) {
3149 PrintHeader();
3150 return RunStatus::OK;
Felipe Lemed071c682016-10-20 16:48:00 -07003151 }
3152
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003153 MYLOGD("dumpstate calling_uid = %d ; calling package = %s \n",
3154 calling_uid, calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003155
Felipe Leme7447d7c2016-11-03 18:12:22 -07003156 // TODO: temporarily set progress until it's part of the Dumpstate constructor
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003157 std::string stats_path =
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003158 android::base::StringPrintf("%s/dumpstate-stats.txt", bugreport_internal_dir_.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003159 progress_.reset(new Progress(stats_path));
Felipe Leme7447d7c2016-11-03 18:12:22 -07003160
Sahana Raof35ed432019-07-12 10:47:52 +01003161 if (acquire_wake_lock(PARTIAL_WAKE_LOCK, WAKE_LOCK_NAME) < 0) {
3162 MYLOGE("Failed to acquire wake lock: %s\n", strerror(errno));
3163 } else {
3164 // Wake lock will be released automatically on process death
3165 MYLOGD("Wake lock acquired.\n");
3166 }
3167
Felipe Leme6ae5c4f2017-01-10 14:13:22 -08003168 register_sig_handler();
Felipe Lemed071c682016-10-20 16:48:00 -07003169
Felipe Lemef0292972016-11-22 13:57:05 -08003170 if (PropertiesHelper::IsDryRun()) {
Felipe Lemed071c682016-10-20 16:48:00 -07003171 MYLOGI("Running on dry-run mode (to disable it, call 'setprop dumpstate.dry_run false')\n");
3172 }
3173
Kevin Jeonfa64e642023-07-27 11:36:41 -04003174 if (PropertiesHelper::IsStrictRun()) {
3175 MYLOGI(
3176 "Running on strict-run mode, which has shorter timeouts "
3177 "(to disable, call 'setprop dumpstate.strict_run false')\n");
3178 }
3179
Nandana Dutt235c6672019-11-14 15:22:32 +00003180 MYLOGI("dumpstate info: id=%d, args='%s', bugreport_mode= %s bugreport format version: %s\n",
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00003181 id_, options_->args.c_str(), options_->bugreport_mode_string.c_str(), version_.c_str());
Felipe Leme809d74e2016-02-02 12:57:00 -08003182
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003183 do_early_screenshot_ = options_->do_progress_updates;
Felipe Lemee338bf62015-12-07 14:03:50 -08003184
Christopher Ferrised9354f2014-10-01 17:35:01 -07003185 // If we are going to use a socket, do it as early as possible
3186 // to avoid timeouts from bugreport.
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003187 if (options_->stream_to_socket || options_->progress_updates_to_socket) {
Felipe Leme2628e9e2016-04-12 16:36:51 -07003188 MYLOGD("Opening control socket\n");
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003189 control_socket_fd_ = open_socket_fn_("dumpstate");
Nandana Dutta344cb62019-02-22 15:12:35 +00003190 if (control_socket_fd_ == -1) {
3191 return ERROR;
3192 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003193 if (options_->progress_updates_to_socket) {
3194 options_->do_progress_updates = 1;
3195 }
Felipe Leme2628e9e2016-04-12 16:36:51 -07003196 }
3197
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003198 if (!PrepareToWriteToFile()) {
3199 return ERROR;
3200 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08003201
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003202 // Interactive, wear & telephony modes are default to true.
3203 // and may enable from cli option or when using control socket
3204 if (options_->do_progress_updates) {
3205 // clang-format off
3206 std::vector<std::string> am_args = {
3207 "--receiver-permission", "android.permission.DUMP",
3208 };
3209 // clang-format on
3210 // Send STARTED broadcast for apps that listen to bugreport generation events
Nikhil Kumar28ce35e2023-01-10 14:32:44 +00003211 SendBroadcast("com.android.internal.intent.action.BUGREPORT_STARTED",
3212 am_args, multiuser_get_user_id(calling_uid));
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003213 if (options_->progress_updates_to_socket) {
3214 dprintf(control_socket_fd_, "BEGIN:%s\n", path_.c_str());
Felipe Leme71bbfc52015-11-23 14:14:51 -08003215 }
3216 }
3217
Nick Kralevichf3599b32016-01-25 15:05:16 -08003218 /* read /proc/cmdline before dropping root */
3219 FILE *cmdline = fopen("/proc/cmdline", "re");
3220 if (cmdline) {
3221 fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
3222 fclose(cmdline);
3223 }
3224
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003225 if (options_->do_vibrate) {
Felipe Leme35b8cf12017-02-10 15:47:29 -08003226 Vibrate(150);
John Michelau1f794c42012-09-17 11:20:19 -05003227 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003228
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003229 if (zip_file != nullptr) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003230 if (chown(path_.c_str(), AID_SHELL, AID_SHELL)) {
3231 MYLOGE("Unable to change ownership of zip file %s: %s\n", path_.c_str(),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003232 strerror(errno));
Felipe Leme1e9edc62015-12-21 16:02:13 -08003233 }
3234 }
3235
Nandana Dutt3f8c7172018-09-25 12:01:54 +01003236 int dup_stdout_fd;
3237 int dup_stderr_fd;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003238 // Redirect stderr to log_path_ for debugging.
3239 TEMP_FAILURE_RETRY(dup_stderr_fd = dup(fileno(stderr)));
3240 if (!redirect_to_file(stderr, const_cast<char*>(log_path_.c_str()))) {
3241 return ERROR;
3242 }
3243 if (chown(log_path_.c_str(), AID_SHELL, AID_SHELL)) {
3244 MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n", log_path_.c_str(),
3245 strerror(errno));
3246 }
Nandana Dutt979388e2018-11-30 16:48:55 +00003247
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003248 // Redirect stdout to tmp_path_. This is the main bugreport entry and will be
3249 // moved into zip file later, if zipping.
3250 TEMP_FAILURE_RETRY(dup_stdout_fd = dup(fileno(stdout)));
3251 // TODO: why not write to a file instead of stdout to overcome this problem?
3252 /* TODO: rather than generating a text file now and zipping it later,
3253 it would be more efficient to redirect stdout to the zip entry
3254 directly, but the libziparchive doesn't support that option yet. */
3255 if (!redirect_to_file(stdout, const_cast<char*>(tmp_path_.c_str()))) {
3256 return ERROR;
3257 }
3258 if (chown(tmp_path_.c_str(), AID_SHELL, AID_SHELL)) {
3259 MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
3260 tmp_path_.c_str(), strerror(errno));
Colin Crossf45fa6b2012-03-26 12:38:26 -07003261 }
Felipe Lemed8b94e52016-12-08 10:21:44 -08003262
3263 // Don't buffer stdout
3264 setvbuf(stdout, nullptr, _IONBF, 0);
3265
Rhed Jao5377d792020-07-16 17:37:39 +08003266 // Enable the parallel run if the client requests to output to a file.
3267 EnableParallelRunIfNeeded();
3268 // Using scope guard to make sure the dump pool can be shut down correctly.
3269 auto scope_guard_to_shutdown_pool = android::base::make_scope_guard([=]() {
3270 ShutdownDumpPool();
3271 });
3272
Felipe Leme608385d2016-02-01 10:35:38 -08003273 // NOTE: there should be no stdout output until now, otherwise it would break the header.
3274 // In particular, DurationReport objects should be created passing 'title, NULL', so their
Felipe Lemecbce55d2016-02-08 09:53:18 -08003275 // duration is logged into MYLOG instead.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003276 PrintHeader();
Colin Crossf45fa6b2012-03-26 12:38:26 -07003277
Kean Mariotti853b73a2023-07-27 12:40:30 +00003278 bool is_dumpstate_restricted =
3279 options_->telephony_only || options_->wifi_only || options_->limited_only;
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003280 if (!is_dumpstate_restricted) {
3281 // Snapshot the system trace now (if running) to avoid that dumpstate's
3282 // own activity pushes out interesting data from the trace ring buffer.
3283 // The trace file is added to the zip by MaybeAddSystemTraceToZip().
3284 MaybeSnapshotSystemTrace();
Yohei Yukawa95305b32021-03-09 07:54:27 -08003285
Kean Mariotti853b73a2023-07-27 12:40:30 +00003286 // Invoke critical dumpsys to preserve system state, before doing anything else.
3287 RunDumpsysCritical();
3288
Kean Mariotti306633e2022-09-05 16:30:47 +00003289 // Snapshot the UI traces now (if running).
3290 // The trace files will be added to bugreport later.
3291 MaybeSnapshotUiTraces();
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003292 }
Kean Mariotti853b73a2023-07-27 12:40:30 +00003293
3294 MaybeTakeEarlyScreenshot();
Gavin Corkery6968f552020-11-22 18:09:05 +00003295 onUiIntensiveBugreportDumpsFinished(calling_uid);
3296 MaybeCheckUserConsent(calling_uid, calling_package);
3297 if (options_->telephony_only) {
3298 DumpstateTelephonyOnly(calling_package);
3299 } else if (options_->wifi_only) {
3300 DumpstateWifiOnly();
3301 } else if (options_->limited_only) {
3302 DumpstateLimitedOnly();
Elis Elliott8e401ad2023-08-08 11:18:59 +00003303 } else if (options_->onboarding_only) {
3304 DumpstateOnboardingOnly();
Gavin Corkery6968f552020-11-22 18:09:05 +00003305 } else {
Nandana Dutt4be45d12018-09-26 15:04:23 +01003306 // Dump state for the default case. This also drops root.
Jichao Lie89d9c12019-11-21 19:02:51 -08003307 RunStatus s = DumpstateDefaultAfterCritical();
Nandana Dutt5c390032019-03-12 10:52:56 +00003308 if (s != RunStatus::OK) {
Nandana Duttaac6f582019-07-26 14:32:47 +01003309 if (s == RunStatus::USER_CONSENT_DENIED) {
Nandana Dutt5c390032019-03-12 10:52:56 +00003310 HandleUserConsentDenied();
3311 }
3312 return s;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08003313 }
Zhengyin Qian068ecc72016-08-10 16:48:14 -07003314 }
Felipe Leme71a74ac2016-03-17 15:43:25 -07003315
Felipe Leme55b42a62015-11-10 17:39:08 -08003316 /* close output if needed */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003317 TEMP_FAILURE_RETRY(dup2(dup_stdout_fd, fileno(stdout)));
Colin Crossf45fa6b2012-03-26 12:38:26 -07003318
Abhijeet Kaure370d682019-10-01 16:49:30 +01003319 // Zip the (now complete) .tmp file within the internal directory.
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003320 ATRACE_BEGIN("FinalizeFile");
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003321 FinalizeFile();
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003322 ATRACE_END();
Colin Crossf45fa6b2012-03-26 12:38:26 -07003323
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003324 // Share the final file with the caller if the user has consented or Shell is the caller.
Nandana Duttd2f5f082019-01-18 17:13:52 +00003325 Dumpstate::RunStatus status = Dumpstate::RunStatus::OK;
Gavin Corkerya44686c2022-11-23 18:16:51 +00003326 if (CalledByApi() && !options_->is_consent_deferred) {
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003327 status = CopyBugreportIfUserConsented(calling_uid);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003328 if (status != Dumpstate::RunStatus::OK &&
3329 status != Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
3330 // Do an early return if there were errors. We make an exception for consent
3331 // timing out because it's possible the user got distracted. In this case the
3332 // bugreport is not shared but made available for manual retrieval.
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003333 MYLOGI("User denied consent. Returning\n");
Nandana Duttd2f5f082019-01-18 17:13:52 +00003334 return status;
3335 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003336 if (status == Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
3337 MYLOGI(
3338 "Did not receive user consent yet."
3339 " Will not copy the bugreport artifacts to caller.\n");
Abhijeet Kaur57627412019-04-17 16:00:09 +01003340 const String16 incidentcompanion("incidentcompanion");
3341 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
3342 if (ics != nullptr) {
3343 MYLOGD("Canceling user consent request via incidentcompanion service\n");
3344 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
3345 consent_callback_.get());
3346 } else {
3347 MYLOGD("Unable to cancel user consent; incidentcompanion service unavailable\n");
3348 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003349 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003350 }
3351
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08003352 /* vibrate a few but shortly times to let user know it's finished */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003353 if (options_->do_vibrate) {
Takuya Ogawa47f644e2017-12-20 18:09:09 +09003354 for (int i = 0; i < 3; i++) {
3355 Vibrate(75);
3356 usleep((75 + 50) * 1000);
3357 }
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08003358 }
3359
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003360 MYLOGD("Final progress: %d/%d (estimated %d)\n", progress_->Get(), progress_->GetMax(),
3361 progress_->GetInitialMax());
3362 progress_->Save();
3363 MYLOGI("done (id %d)\n", id_);
Colin Crossf45fa6b2012-03-26 12:38:26 -07003364
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003365 TEMP_FAILURE_RETRY(dup2(dup_stderr_fd, fileno(stderr)));
Felipe Leme107a05f2016-03-08 15:11:15 -08003366
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003367 if (control_socket_fd_ != -1) {
Felipe Lemee844a9d2016-09-21 15:01:39 -07003368 MYLOGD("Closing control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003369 close(control_socket_fd_);
Felipe Leme2628e9e2016-04-12 16:36:51 -07003370 }
3371
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003372 tombstone_data_.clear();
3373 anr_data_.clear();
Andy Hungd62f7e62024-01-11 15:47:52 -08003374 anr_trace_data_.clear();
Woody Lin20767a92022-11-29 15:50:24 +08003375 shutdown_checkpoints_.clear();
Narayan Kamath6b9516c2017-10-27 11:15:51 +01003376
Nandana Duttd2f5f082019-01-18 17:13:52 +00003377 return (consent_callback_ != nullptr &&
3378 consent_callback_->getResult() == UserConsentResult::UNAVAILABLE)
3379 ? USER_CONSENT_TIMED_OUT
3380 : RunStatus::OK;
3381}
3382
Paul Chang0d2aad72020-02-13 20:04:03 +08003383void Dumpstate::MaybeTakeEarlyScreenshot() {
3384 if (!options_->do_screenshot || !do_early_screenshot_) {
3385 return;
3386 }
3387
3388 TakeScreenshot();
3389}
3390
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003391void Dumpstate::MaybeSnapshotSystemTrace() {
Kean Mariotti853b73a2023-07-27 12:40:30 +00003392 // When capturing traces via bugreport handler (BH), this function will be invoked twice:
3393 // 1) When BH invokes IDumpstate::PreDumpUiData()
3394 // 2) When BH invokes IDumpstate::startBugreport(flags = BUGREPORT_USE_PREDUMPED_UI_DATA)
3395 // In this case we don't want to re-invoke perfetto in step 2.
3396 // In all other standard invocation states, this function is invoked once
3397 // without the flag BUGREPORT_USE_PREDUMPED_UI_DATA.
3398 if (options_->use_predumped_ui_data) {
3399 return;
3400 }
3401
3402 // If a stale file exists already, remove it.
3403 unlink(SYSTEM_TRACE_SNAPSHOT);
3404
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003405 // If a background system trace is happening and is marked as "suitable for
3406 // bugreport" (i.e. bugreport_score > 0 in the trace config), this command
3407 // will stop it and serialize into SYSTEM_TRACE_SNAPSHOT. In the (likely)
3408 // case that no trace is ongoing, this command is a no-op.
3409 // Note: this should not be enqueued as we need to freeze the trace before
3410 // dumpstate starts. Otherwise the trace ring buffers will contain mostly
3411 // the dumpstate's own activity which is irrelevant.
Kean Mariotti853b73a2023-07-27 12:40:30 +00003412 RunCommand("SERIALIZE PERFETTO TRACE", {"perfetto", "--save-for-bugreport"},
3413 CommandOptions::WithTimeout(10).DropRoot().CloseAllFileDescriptorsOnExec().Build());
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003414 // MaybeAddSystemTraceToZip() will take care of copying the trace in the zip
3415 // file in the later stages.
3416}
3417
Kean Mariotti306633e2022-09-05 16:30:47 +00003418void Dumpstate::MaybeSnapshotUiTraces() {
3419 if (PropertiesHelper::IsUserBuild() || options_->use_predumped_ui_data) {
3420 return;
3421 }
Hongwei Wang9ec5c252023-01-24 15:09:59 -08003422
Pablo Gamitoefdc5922023-04-19 09:44:47 +00003423 const std::vector<std::vector<std::string>> dumpTracesForBugReportCommands = {
3424 {"dumpsys", "activity", "service", "SystemUIService", "WMShell", "protolog",
3425 "save-for-bugreport"},
3426 {"dumpsys", "activity", "service", "SystemUIService", "WMShell", "transitions", "tracing",
3427 "save-for-bugreport"},
3428 {"cmd", "input_method", "tracing", "save-for-bugreport"},
3429 {"cmd", "window", "tracing", "save-for-bugreport"},
3430 {"cmd", "window", "shell", "tracing", "save-for-bugreport"},
3431 };
Hongwei Wang39229132023-01-24 15:09:59 -08003432
Pablo Gamitoefdc5922023-04-19 09:44:47 +00003433 for (const auto& command : dumpTracesForBugReportCommands) {
Yohei Yukawa02b1d2c2021-03-16 09:20:30 -07003434 RunCommand(
3435 // Empty name because it's not intended to be classified as a bugreport section.
3436 // Actual tracing files can be found in "/data/misc/wmtrace/" in the bugreport.
Pablo Gamitoefdc5922023-04-19 09:44:47 +00003437 "", command,
Yohei Yukawa02b1d2c2021-03-16 09:20:30 -07003438 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3439 }
Kean Mariotti306633e2022-09-05 16:30:47 +00003440}
3441
3442void Dumpstate::MaybeAddUiTracesToZip() {
3443 if (PropertiesHelper::IsUserBuild()) {
3444 return;
3445 }
3446
3447 ds.AddDir(WMTRACE_DATA_DIR, false);
Yohei Yukawa95305b32021-03-09 07:54:27 -08003448}
3449
Paul Changeb4b4642020-05-28 22:05:47 +08003450void Dumpstate::onUiIntensiveBugreportDumpsFinished(int32_t calling_uid) {
Nikhil Kumar28ce35e2023-01-10 14:32:44 +00003451 if (multiuser_get_app_id(calling_uid) == AID_SHELL || !CalledByApi()) {
Paul Changc490e662020-04-11 18:14:09 +08003452 return;
3453 }
3454 if (listener_ != nullptr) {
3455 // Let listener know ui intensive bugreport dumps are finished, then it can do event
3456 // handling if required.
Paul Changeb4b4642020-05-28 22:05:47 +08003457 listener_->onUiIntensiveBugreportDumpsFinished();
Paul Changc490e662020-04-11 18:14:09 +08003458 }
3459}
3460
Jichao Lie89d9c12019-11-21 19:02:51 -08003461void Dumpstate::MaybeCheckUserConsent(int32_t calling_uid, const std::string& calling_package) {
Gavin Corkerya44686c2022-11-23 18:16:51 +00003462 if (multiuser_get_app_id(calling_uid) == AID_SHELL ||
3463 !CalledByApi() || options_->is_consent_deferred) {
3464 // No need to get consent for shell triggered dumpstates, or not
3465 // through bugreporting API (i.e. no fd to copy back), or when consent
3466 // is deferred.
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003467 return;
3468 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003469 consent_callback_ = new ConsentCallback();
3470 const String16 incidentcompanion("incidentcompanion");
3471 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
Jichao Lie89d9c12019-11-21 19:02:51 -08003472 android::String16 package(calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003473 if (ics != nullptr) {
3474 MYLOGD("Checking user consent via incidentcompanion service\n");
Steven Leeb573eb82022-11-29 22:31:35 +08003475 int flags = 0x1; // IncidentManager.FLAG_CONFIRMATION_DIALOG
3476 if (IsConsentlessBugreportAllowed(*options_)) {
3477 flags |= 0x2; // IncidentManager.FLAG_ALLOW_CONSENTLESS_BUGREPORT
3478 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003479 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
Steven Leeb573eb82022-11-29 22:31:35 +08003480 calling_uid, package, String16(), String16(), flags, consent_callback_.get());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003481 } else {
3482 MYLOGD("Unable to check user consent; incidentcompanion service unavailable\n");
3483 }
3484}
3485
Nandana Dutt5c390032019-03-12 10:52:56 +00003486bool Dumpstate::IsUserConsentDenied() const {
3487 return ds.consent_callback_ != nullptr &&
3488 ds.consent_callback_->getResult() == UserConsentResult::DENIED;
3489}
3490
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01003491bool Dumpstate::CalledByApi() const {
3492 return ds.options_->bugreport_fd.get() != -1 ? true : false;
3493}
3494
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003495void Dumpstate::CleanupTmpFiles() {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003496 android::os::UnlinkAndLogOnError(tmp_path_);
3497 android::os::UnlinkAndLogOnError(screenshot_path_);
3498 android::os::UnlinkAndLogOnError(path_);
Gavin Corkery789d7a52021-02-24 23:52:35 +00003499 if (dump_traces_path != nullptr) {
3500 android::os::UnlinkAndLogOnError(dump_traces_path);
3501 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003502}
3503
Rhed Jao5377d792020-07-16 17:37:39 +08003504void Dumpstate::EnableParallelRunIfNeeded() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003505 if (!PropertiesHelper::IsParallelRun()) {
Rhed Jao5377d792020-07-16 17:37:39 +08003506 return;
3507 }
3508 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003509 zip_entry_tasks_ = std::make_unique<TaskQueue>();
Rhed Jao5377d792020-07-16 17:37:39 +08003510}
3511
3512void Dumpstate::ShutdownDumpPool() {
3513 if (dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08003514 dump_pool_.reset();
Rhed Jao5377d792020-07-16 17:37:39 +08003515 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003516 if (zip_entry_tasks_) {
3517 zip_entry_tasks_->run(/* do_cancel = */true);
3518 zip_entry_tasks_ = nullptr;
3519 }
3520}
3521
3522void Dumpstate::EnqueueAddZipEntryAndCleanupIfNeeded(const std::string& entry_name,
3523 const std::string& entry_path) {
3524 auto func_add_zip_entry_and_cleanup = [=](bool task_cancelled) {
3525 if (!task_cancelled) {
3526 AddZipEntry(entry_name, entry_path);
3527 }
3528 android::os::UnlinkAndLogOnError(entry_path);
3529 };
3530 if (zip_entry_tasks_) {
3531 // Enqueues AddZipEntryAndCleanup function if the parallel run is enabled.
3532 zip_entry_tasks_->add(func_add_zip_entry_and_cleanup, _1);
3533 } else {
3534 // Invokes AddZipEntryAndCleanup immediately
3535 std::invoke(func_add_zip_entry_and_cleanup, /* task_cancelled = */false);
3536 }
Rhed Jao5377d792020-07-16 17:37:39 +08003537}
3538
Nandana Duttd2f5f082019-01-18 17:13:52 +00003539Dumpstate::RunStatus Dumpstate::HandleUserConsentDenied() {
3540 MYLOGD("User denied consent; deleting files and returning\n");
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003541 CleanupTmpFiles();
Nandana Duttd2f5f082019-01-18 17:13:52 +00003542 return USER_CONSENT_DENIED;
3543}
3544
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003545Dumpstate::RunStatus Dumpstate::CopyBugreportIfUserConsented(int32_t calling_uid) {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003546 // If the caller has asked to copy the bugreport over to their directory, we need explicit
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003547 // user consent (unless the caller is Shell).
3548 UserConsentResult consent_result;
Nikhil Kumar28ce35e2023-01-10 14:32:44 +00003549 if (multiuser_get_app_id(calling_uid) == AID_SHELL) {
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003550 consent_result = UserConsentResult::APPROVED;
3551 } else {
3552 consent_result = consent_callback_->getResult();
3553 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003554 if (consent_result == UserConsentResult::UNAVAILABLE) {
3555 // User has not responded yet.
3556 uint64_t elapsed_ms = consent_callback_->getElapsedTimeMs();
Hunter Knepshield70610fa2020-01-03 15:27:33 -08003557 // Telephony is a fast report type, particularly on user builds where information may be
3558 // more aggressively limited. To give the user time to read the consent dialog, increase the
3559 // timeout.
3560 uint64_t timeout_ms = options_->telephony_only ? TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS
3561 : USER_CONSENT_TIMEOUT_MS;
3562 if (elapsed_ms < timeout_ms) {
3563 uint delay_seconds = (timeout_ms - elapsed_ms) / 1000;
Nandana Duttd2f5f082019-01-18 17:13:52 +00003564 MYLOGD("Did not receive user consent yet; going to wait for %d seconds", delay_seconds);
3565 sleep(delay_seconds);
3566 }
3567 consent_result = consent_callback_->getResult();
3568 }
3569 if (consent_result == UserConsentResult::DENIED) {
3570 // User has explicitly denied sharing with the app. To be safe delete the
3571 // internal bugreport & tmp files.
3572 return HandleUserConsentDenied();
3573 }
3574 if (consent_result == UserConsentResult::APPROVED) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00003575 bool copy_succeeded = android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
3576 if (copy_succeeded) {
3577 android::os::UnlinkAndLogOnError(path_);
Abhijeet Kaur9ce94672020-04-01 17:22:36 +01003578 if (options_->do_screenshot &&
3579 options_->screenshot_fd.get() != -1 &&
3580 !options_->is_screenshot_copied) {
3581 copy_succeeded = android::os::CopyFileToFd(screenshot_path_,
3582 options_->screenshot_fd.get());
3583 options_->is_screenshot_copied = copy_succeeded;
3584 if (copy_succeeded) {
3585 android::os::UnlinkAndLogOnError(screenshot_path_);
3586 }
3587 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003588 }
3589 return copy_succeeded ? Dumpstate::RunStatus::OK : Dumpstate::RunStatus::ERROR;
3590 } else if (consent_result == UserConsentResult::UNAVAILABLE) {
3591 // consent_result is still UNAVAILABLE. The user has likely not responded yet.
3592 // Since we do not have user consent to share the bugreport it does not get
3593 // copied over to the calling app but remains in the internal directory from
3594 // where the user can manually pull it.
Paul Changce644212021-05-11 16:06:45 +08003595 std::string final_path = GetPath(".zip");
3596 bool copy_succeeded = android::os::CopyFileToFile(path_, final_path);
3597 if (copy_succeeded) {
3598 android::os::UnlinkAndLogOnError(path_);
3599 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003600 return Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT;
3601 }
3602 // Unknown result; must be a programming error.
3603 MYLOGE("Unknown user consent result:%d\n", consent_result);
3604 return Dumpstate::RunStatus::ERROR;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003605}
3606
Nandana Duttf02564e2019-02-15 15:24:24 +00003607Dumpstate::RunStatus Dumpstate::ParseCommandlineAndRun(int argc, char* argv[]) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003608 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
3609 Dumpstate::RunStatus status = options->Initialize(argc, argv);
3610 if (status == Dumpstate::RunStatus::OK) {
Nandana Duttf02564e2019-02-15 15:24:24 +00003611 SetOptions(std::move(options));
Nandana Duttd2f5f082019-01-18 17:13:52 +00003612 // When directly running dumpstate binary, the output is not expected to be written
3613 // to any external file descriptor.
Nandana Duttf02564e2019-02-15 15:24:24 +00003614 assert(options_->bugreport_fd.get() == -1);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003615
3616 // calling_uid and calling_package are for user consent to share the bugreport with
Abhijeet Kaura407fb82020-03-27 12:51:12 +00003617 // an app; they are irrelevant here because bugreport is triggered via command line.
3618 // Update Last ID before calling Run().
3619 Initialize();
Nikhil Kumarb70622a2023-06-15 15:37:19 +01003620 status = Run(0 /* calling_uid */, "" /* calling_package */);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003621 }
Nandana Duttf02564e2019-02-15 15:24:24 +00003622 return status;
3623}
3624
3625/* Main entry point for dumpstate binary. */
3626int run_main(int argc, char* argv[]) {
3627 Dumpstate::RunStatus status = ds.ParseCommandlineAndRun(argc, argv);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003628
3629 switch (status) {
3630 case Dumpstate::RunStatus::OK:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003631 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003632 case Dumpstate::RunStatus::HELP:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003633 ShowUsage();
3634 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003635 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003636 fprintf(stderr, "Invalid combination of args\n");
3637 ShowUsage();
3638 exit(1);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003639 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00003640 FALLTHROUGH_INTENDED;
3641 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
3642 FALLTHROUGH_INTENDED;
3643 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003644 exit(2);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003645 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003646}
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003647
3648// TODO(111441001): Default DumpOptions to sensible values.
3649Dumpstate::Dumpstate(const std::string& version)
3650 : pid_(getpid()),
3651 options_(new Dumpstate::DumpOptions()),
Nandana Dutt402a8392019-06-14 14:25:13 +01003652 last_reported_percent_progress_(0),
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003653 version_(version),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003654 now_(time(nullptr)),
3655 open_socket_fn_(open_socket) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003656}
3657
3658Dumpstate& Dumpstate::GetInstance() {
3659 static Dumpstate singleton_(android::base::GetProperty("dumpstate.version", VERSION_CURRENT));
3660 return singleton_;
3661}
3662
Rhed Jao5377d792020-07-16 17:37:39 +08003663DurationReporter::DurationReporter(const std::string& title, bool logcat_only, bool verbose,
3664 int duration_fd) : title_(title), logcat_only_(logcat_only), verbose_(verbose),
3665 duration_fd_(duration_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003666 if (!title_.empty()) {
3667 started_ = Nanotime();
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003668 if (title_.find("SHOW MAP") == std::string::npos) {
3669 ATRACE_ASYNC_BEGIN(title_.c_str(), 0);
3670 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003671 }
3672}
3673
3674DurationReporter::~DurationReporter() {
3675 if (!title_.empty()) {
3676 float elapsed = (float)(Nanotime() - started_) / NANOS_PER_SEC;
chenqiwuaf8b2d92019-12-12 18:53:51 +08003677 if (elapsed >= .5f || verbose_) {
3678 MYLOGD("Duration of '%s': %.2fs\n", title_.c_str(), elapsed);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003679 }
chenqiwuaf8b2d92019-12-12 18:53:51 +08003680 if (!logcat_only_) {
3681 // Use "Yoda grammar" to make it easier to grep|sort sections.
Rhed Jao5377d792020-07-16 17:37:39 +08003682 dprintf(duration_fd_, "------ %.3fs was the duration of '%s' ------\n",
3683 elapsed, title_.c_str());
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003684 }
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003685 if (title_.find("SHOW MAP") == std::string::npos) {
3686 ATRACE_ASYNC_END(title_.c_str(), 0);
3687 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003688 }
3689}
3690
3691const int32_t Progress::kDefaultMax = 5000;
3692
3693Progress::Progress(const std::string& path) : Progress(Progress::kDefaultMax, 1.1, path) {
3694}
3695
3696Progress::Progress(int32_t initial_max, int32_t progress, float growth_factor)
3697 : Progress(initial_max, growth_factor, "") {
3698 progress_ = progress;
3699}
3700
3701Progress::Progress(int32_t initial_max, float growth_factor, const std::string& path)
3702 : initial_max_(initial_max),
3703 progress_(0),
3704 max_(initial_max),
3705 growth_factor_(growth_factor),
3706 n_runs_(0),
3707 average_max_(0),
3708 path_(path) {
3709 if (!path_.empty()) {
3710 Load();
3711 }
3712}
3713
3714void Progress::Load() {
3715 MYLOGD("Loading stats from %s\n", path_.c_str());
3716 std::string content;
3717 if (!android::base::ReadFileToString(path_, &content)) {
3718 MYLOGI("Could not read stats from %s; using max of %d\n", path_.c_str(), max_);
3719 return;
3720 }
3721 if (content.empty()) {
3722 MYLOGE("No stats (empty file) on %s; using max of %d\n", path_.c_str(), max_);
3723 return;
3724 }
3725 std::vector<std::string> lines = android::base::Split(content, "\n");
3726
3727 if (lines.size() < 1) {
3728 MYLOGE("Invalid stats on file %s: not enough lines (%d). Using max of %d\n", path_.c_str(),
3729 (int)lines.size(), max_);
3730 return;
3731 }
3732 char* ptr;
3733 n_runs_ = strtol(lines[0].c_str(), &ptr, 10);
3734 average_max_ = strtol(ptr, nullptr, 10);
3735 if (n_runs_ <= 0 || average_max_ <= 0 || n_runs_ > STATS_MAX_N_RUNS ||
3736 average_max_ > STATS_MAX_AVERAGE) {
3737 MYLOGE("Invalid stats line on file %s: %s\n", path_.c_str(), lines[0].c_str());
3738 initial_max_ = Progress::kDefaultMax;
3739 } else {
3740 initial_max_ = average_max_;
3741 }
3742 max_ = initial_max_;
3743
3744 MYLOGI("Average max progress: %d in %d runs; estimated max: %d\n", average_max_, n_runs_, max_);
3745}
3746
3747void Progress::Save() {
3748 int32_t total = n_runs_ * average_max_ + progress_;
3749 int32_t runs = n_runs_ + 1;
3750 int32_t average = floor(((float)total) / runs);
3751 MYLOGI("Saving stats (total=%d, runs=%d, average=%d) on %s\n", total, runs, average,
3752 path_.c_str());
3753 if (path_.empty()) {
3754 return;
3755 }
3756
3757 std::string content = android::base::StringPrintf("%d %d\n", runs, average);
3758 if (!android::base::WriteStringToFile(content, path_)) {
3759 MYLOGE("Could not save stats on %s\n", path_.c_str());
3760 }
3761}
3762
3763int32_t Progress::Get() const {
3764 return progress_;
3765}
3766
3767bool Progress::Inc(int32_t delta_sec) {
3768 bool changed = false;
3769 if (delta_sec >= 0) {
3770 progress_ += delta_sec;
3771 if (progress_ > max_) {
3772 int32_t old_max = max_;
3773 max_ = floor((float)progress_ * growth_factor_);
3774 MYLOGD("Adjusting max progress from %d to %d\n", old_max, max_);
3775 changed = true;
3776 }
3777 }
3778 return changed;
3779}
3780
3781int32_t Progress::GetMax() const {
3782 return max_;
3783}
3784
3785int32_t Progress::GetInitialMax() const {
3786 return initial_max_;
3787}
3788
3789void Progress::Dump(int fd, const std::string& prefix) const {
3790 const char* pr = prefix.c_str();
3791 dprintf(fd, "%sprogress: %d\n", pr, progress_);
3792 dprintf(fd, "%smax: %d\n", pr, max_);
3793 dprintf(fd, "%sinitial_max: %d\n", pr, initial_max_);
3794 dprintf(fd, "%sgrowth_factor: %0.2f\n", pr, growth_factor_);
3795 dprintf(fd, "%spath: %s\n", pr, path_.c_str());
3796 dprintf(fd, "%sn_runs: %d\n", pr, n_runs_);
3797 dprintf(fd, "%saverage_max: %d\n", pr, average_max_);
3798}
3799
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003800std::string Dumpstate::GetPath(const std::string& suffix) const {
3801 return GetPath(bugreport_internal_dir_, suffix);
3802}
3803
3804std::string Dumpstate::GetPath(const std::string& directory, const std::string& suffix) const {
3805 return android::base::StringPrintf("%s/%s-%s%s", directory.c_str(), base_name_.c_str(),
3806 name_.c_str(), suffix.c_str());
3807}
3808
3809void Dumpstate::SetProgress(std::unique_ptr<Progress> progress) {
3810 progress_ = std::move(progress);
3811}
3812
3813void for_each_userid(void (*func)(int), const char *header) {
3814 std::string title = header == nullptr ? "for_each_userid" : android::base::StringPrintf(
3815 "for_each_userid(%s)", header);
3816 DurationReporter duration_reporter(title);
3817 if (PropertiesHelper::IsDryRun()) return;
3818
3819 DIR *d;
3820 struct dirent *de;
3821
3822 if (header) printf("\n------ %s ------\n", header);
3823 func(0);
3824
3825 if (!(d = opendir("/data/system/users"))) {
3826 printf("Failed to open /data/system/users (%s)\n", strerror(errno));
3827 return;
3828 }
3829
3830 while ((de = readdir(d))) {
3831 int userid;
3832 if (de->d_type != DT_DIR || !(userid = atoi(de->d_name))) {
3833 continue;
3834 }
3835 func(userid);
3836 }
3837
3838 closedir(d);
3839}
3840
3841static void __for_each_pid(void (*helper)(int, const char *, void *), const char *header, void *arg) {
3842 DIR *d;
3843 struct dirent *de;
3844
3845 if (!(d = opendir("/proc"))) {
3846 printf("Failed to open /proc (%s)\n", strerror(errno));
3847 return;
3848 }
3849
3850 if (header) printf("\n------ %s ------\n", header);
3851 while ((de = readdir(d))) {
3852 if (ds.IsUserConsentDenied()) {
3853 MYLOGE(
3854 "Returning early because user denied consent to share bugreport with calling app.");
3855 closedir(d);
3856 return;
3857 }
3858 int pid;
3859 int fd;
3860 char cmdpath[255];
3861 char cmdline[255];
3862
3863 if (!(pid = atoi(de->d_name))) {
3864 continue;
3865 }
3866
3867 memset(cmdline, 0, sizeof(cmdline));
3868
3869 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/cmdline", pid);
3870 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3871 TEMP_FAILURE_RETRY(read(fd, cmdline, sizeof(cmdline) - 2));
3872 close(fd);
3873 if (cmdline[0]) {
3874 helper(pid, cmdline, arg);
3875 continue;
3876 }
3877 }
3878
3879 // if no cmdline, a kernel thread has comm
3880 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/comm", pid);
3881 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3882 TEMP_FAILURE_RETRY(read(fd, cmdline + 1, sizeof(cmdline) - 4));
3883 close(fd);
3884 if (cmdline[1]) {
3885 cmdline[0] = '[';
3886 size_t len = strcspn(cmdline, "\f\b\r\n");
3887 cmdline[len] = ']';
3888 cmdline[len+1] = '\0';
3889 }
3890 }
3891 if (!cmdline[0]) {
3892 strcpy(cmdline, "N/A");
3893 }
3894 helper(pid, cmdline, arg);
3895 }
3896
3897 closedir(d);
3898}
3899
3900static void for_each_pid_helper(int pid, const char *cmdline, void *arg) {
3901 for_each_pid_func *func = (for_each_pid_func*) arg;
3902 func(pid, cmdline);
3903}
3904
3905void for_each_pid(for_each_pid_func func, const char *header) {
3906 std::string title = header == nullptr ? "for_each_pid"
3907 : android::base::StringPrintf("for_each_pid(%s)", header);
3908 DurationReporter duration_reporter(title);
3909 if (PropertiesHelper::IsDryRun()) return;
3910
3911 __for_each_pid(for_each_pid_helper, header, (void *) func);
3912}
3913
3914static void for_each_tid_helper(int pid, const char *cmdline, void *arg) {
3915 DIR *d;
3916 struct dirent *de;
3917 char taskpath[255];
3918 for_each_tid_func *func = (for_each_tid_func *) arg;
3919
3920 snprintf(taskpath, sizeof(taskpath), "/proc/%d/task", pid);
3921
3922 if (!(d = opendir(taskpath))) {
3923 printf("Failed to open %s (%s)\n", taskpath, strerror(errno));
3924 return;
3925 }
3926
3927 func(pid, pid, cmdline);
3928
3929 while ((de = readdir(d))) {
3930 if (ds.IsUserConsentDenied()) {
3931 MYLOGE(
3932 "Returning early because user denied consent to share bugreport with calling app.");
3933 closedir(d);
3934 return;
3935 }
3936 int tid;
3937 int fd;
3938 char commpath[255];
3939 char comm[255];
3940
3941 if (!(tid = atoi(de->d_name))) {
3942 continue;
3943 }
3944
3945 if (tid == pid)
3946 continue;
3947
3948 snprintf(commpath, sizeof(commpath), "/proc/%d/comm", tid);
3949 memset(comm, 0, sizeof(comm));
3950 if ((fd = TEMP_FAILURE_RETRY(open(commpath, O_RDONLY | O_CLOEXEC))) < 0) {
3951 strcpy(comm, "N/A");
3952 } else {
3953 char *c;
3954 TEMP_FAILURE_RETRY(read(fd, comm, sizeof(comm) - 2));
3955 close(fd);
3956
3957 c = strrchr(comm, '\n');
3958 if (c) {
3959 *c = '\0';
3960 }
3961 }
3962 func(pid, tid, comm);
3963 }
3964
3965 closedir(d);
3966}
3967
3968void for_each_tid(for_each_tid_func func, const char *header) {
3969 std::string title = header == nullptr ? "for_each_tid"
3970 : android::base::StringPrintf("for_each_tid(%s)", header);
3971 DurationReporter duration_reporter(title);
3972
3973 if (PropertiesHelper::IsDryRun()) return;
3974
3975 __for_each_pid(for_each_tid_helper, header, (void *) func);
3976}
3977
3978void show_wchan(int pid, int tid, const char *name) {
3979 if (PropertiesHelper::IsDryRun()) return;
3980
3981 char path[255];
3982 char buffer[255];
3983 int fd, ret, save_errno;
3984 char name_buffer[255];
3985
3986 memset(buffer, 0, sizeof(buffer));
3987
3988 snprintf(path, sizeof(path), "/proc/%d/wchan", tid);
3989 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3990 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3991 return;
3992 }
3993
3994 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3995 save_errno = errno;
3996 close(fd);
3997
3998 if (ret < 0) {
3999 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
4000 return;
4001 }
4002
4003 snprintf(name_buffer, sizeof(name_buffer), "%*s%s",
4004 pid == tid ? 0 : 3, "", name);
4005
4006 printf("%-7d %-32s %s\n", tid, name_buffer, buffer);
4007
4008 return;
4009}
4010
4011// print time in centiseconds
4012static void snprcent(char *buffer, size_t len, size_t spc,
4013 unsigned long long time) {
4014 static long hz; // cache discovered hz
4015
4016 if (hz <= 0) {
4017 hz = sysconf(_SC_CLK_TCK);
4018 if (hz <= 0) {
4019 hz = 1000;
4020 }
4021 }
4022
4023 // convert to centiseconds
4024 time = (time * 100 + (hz / 2)) / hz;
4025
4026 char str[16];
4027
4028 snprintf(str, sizeof(str), " %llu.%02u",
4029 time / 100, (unsigned)(time % 100));
4030 size_t offset = strlen(buffer);
4031 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
4032 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
4033}
4034
4035// print permille as a percent
4036static void snprdec(char *buffer, size_t len, size_t spc, unsigned permille) {
4037 char str[16];
4038
4039 snprintf(str, sizeof(str), " %u.%u%%", permille / 10, permille % 10);
4040 size_t offset = strlen(buffer);
4041 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
4042 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
4043}
4044
4045void show_showtime(int pid, const char *name) {
4046 if (PropertiesHelper::IsDryRun()) return;
4047
4048 char path[255];
4049 char buffer[1023];
4050 int fd, ret, save_errno;
4051
4052 memset(buffer, 0, sizeof(buffer));
4053
4054 snprintf(path, sizeof(path), "/proc/%d/stat", pid);
4055 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
4056 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
4057 return;
4058 }
4059
4060 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
4061 save_errno = errno;
4062 close(fd);
4063
4064 if (ret < 0) {
4065 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
4066 return;
4067 }
4068
4069 // field 14 is utime
4070 // field 15 is stime
4071 // field 42 is iotime
4072 unsigned long long utime = 0, stime = 0, iotime = 0;
4073 if (sscanf(buffer,
4074 "%*u %*s %*s %*d %*d %*d %*d %*d %*d %*d %*d "
4075 "%*d %*d %llu %llu %*d %*d %*d %*d %*d %*d "
4076 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %*d "
4077 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %llu ",
4078 &utime, &stime, &iotime) != 3) {
4079 return;
4080 }
4081
4082 unsigned long long total = utime + stime;
4083 if (!total) {
4084 return;
4085 }
4086
4087 unsigned permille = (iotime * 1000 + (total / 2)) / total;
4088 if (permille > 1000) {
4089 permille = 1000;
4090 }
4091
4092 // try to beautify and stabilize columns at <80 characters
4093 snprintf(buffer, sizeof(buffer), "%-6d%s", pid, name);
4094 if ((name[0] != '[') || utime) {
4095 snprcent(buffer, sizeof(buffer), 57, utime);
4096 }
4097 snprcent(buffer, sizeof(buffer), 65, stime);
4098 if ((name[0] != '[') || iotime) {
4099 snprcent(buffer, sizeof(buffer), 73, iotime);
4100 }
4101 if (iotime) {
4102 snprdec(buffer, sizeof(buffer), 79, permille);
4103 }
4104 puts(buffer); // adds a trailing newline
4105
4106 return;
4107}
4108
4109void do_dmesg() {
4110 const char *title = "KERNEL LOG (dmesg)";
4111 DurationReporter duration_reporter(title);
4112 printf("------ %s ------\n", title);
4113
4114 if (PropertiesHelper::IsDryRun()) return;
4115
4116 /* Get size of kernel buffer */
4117 int size = klogctl(KLOG_SIZE_BUFFER, nullptr, 0);
4118 if (size <= 0) {
4119 printf("Unexpected klogctl return value: %d\n\n", size);
4120 return;
4121 }
4122 char *buf = (char *) malloc(size + 1);
4123 if (buf == nullptr) {
4124 printf("memory allocation failed\n\n");
4125 return;
4126 }
4127 int retval = klogctl(KLOG_READ_ALL, buf, size);
4128 if (retval < 0) {
4129 printf("klogctl failure\n\n");
4130 free(buf);
4131 return;
4132 }
4133 buf[retval] = '\0';
4134 printf("%s\n\n", buf);
4135 free(buf);
4136 return;
4137}
4138
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004139int Dumpstate::DumpFile(const std::string& title, const std::string& path) {
4140 DurationReporter duration_reporter(title);
4141
4142 int status = DumpFileToFd(STDOUT_FILENO, title, path);
4143
4144 UpdateProgress(WEIGHT_FILE);
4145
4146 return status;
4147}
4148
4149int read_file_as_long(const char *path, long int *output) {
luoqiangwei15fcf2022024-03-07 15:29:20 +08004150 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
4151 if (fd.get() < 0) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004152 int err = errno;
4153 MYLOGE("Error opening file descriptor for %s: %s\n", path, strerror(err));
4154 return -1;
4155 }
4156 char buffer[50];
luoqiangwei15fcf2022024-03-07 15:29:20 +08004157 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd.get(), buffer, sizeof(buffer)));
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004158 if (bytes_read == -1) {
4159 MYLOGE("Error reading file %s: %s\n", path, strerror(errno));
4160 return -2;
4161 }
4162 if (bytes_read == 0) {
4163 MYLOGE("File %s is empty\n", path);
4164 return -3;
4165 }
4166 *output = atoi(buffer);
4167 return 0;
4168}
4169
4170/* calls skip to gate calling dump_from_fd recursively
4171 * in the specified directory. dump_from_fd defaults to
4172 * dump_file_from_fd above when set to NULL. skip defaults
4173 * to false when set to NULL. dump_from_fd will always be
4174 * called with title NULL.
4175 */
4176int dump_files(const std::string& title, const char* dir, bool (*skip)(const char* path),
4177 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
4178 DurationReporter duration_reporter(title);
4179 DIR *dirp;
4180 struct dirent *d;
4181 char *newpath = nullptr;
4182 const char *slash = "/";
4183 int retval = 0;
4184
4185 if (!title.empty()) {
4186 printf("------ %s (%s) ------\n", title.c_str(), dir);
4187 }
4188 if (PropertiesHelper::IsDryRun()) return 0;
4189
4190 if (dir[strlen(dir) - 1] == '/') {
4191 ++slash;
4192 }
4193 dirp = opendir(dir);
4194 if (dirp == nullptr) {
4195 retval = -errno;
4196 MYLOGE("%s: %s\n", dir, strerror(errno));
4197 return retval;
4198 }
4199
4200 if (!dump_from_fd) {
4201 dump_from_fd = dump_file_from_fd;
4202 }
4203 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
4204 if ((d->d_name[0] == '.')
4205 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
4206 || (d->d_name[1] == '\0'))) {
4207 continue;
4208 }
4209 asprintf(&newpath, "%s%s%s%s", dir, slash, d->d_name,
4210 (d->d_type == DT_DIR) ? "/" : "");
4211 if (!newpath) {
4212 retval = -errno;
4213 continue;
4214 }
4215 if (skip && (*skip)(newpath)) {
4216 continue;
4217 }
4218 if (d->d_type == DT_DIR) {
4219 int ret = dump_files("", newpath, skip, dump_from_fd);
4220 if (ret < 0) {
4221 retval = ret;
4222 }
4223 continue;
4224 }
4225 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(newpath, O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
4226 if (fd.get() < 0) {
4227 retval = -1;
4228 printf("*** %s: %s\n", newpath, strerror(errno));
4229 continue;
4230 }
4231 (*dump_from_fd)(nullptr, newpath, fd.get());
4232 }
4233 closedir(dirp);
4234 if (!title.empty()) {
4235 printf("\n");
4236 }
4237 return retval;
4238}
4239
4240/* fd must have been opened with the flag O_NONBLOCK. With this flag set,
4241 * it's possible to avoid issues where opening the file itself can get
4242 * stuck.
4243 */
4244int dump_file_from_fd(const char *title, const char *path, int fd) {
4245 if (PropertiesHelper::IsDryRun()) return 0;
4246
4247 int flags = fcntl(fd, F_GETFL);
4248 if (flags == -1) {
4249 printf("*** %s: failed to get flags on fd %d: %s\n", path, fd, strerror(errno));
4250 return -1;
4251 } else if (!(flags & O_NONBLOCK)) {
4252 printf("*** %s: fd must have O_NONBLOCK set.\n", path);
4253 return -1;
4254 }
4255 return DumpFileFromFdToFd(title, path, fd, STDOUT_FILENO, PropertiesHelper::IsDryRun());
4256}
4257
4258int Dumpstate::RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08004259 const CommandOptions& options, bool verbose_duration, int out_fd) {
4260 DurationReporter duration_reporter(title, false /* logcat_only */,
4261 verbose_duration, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004262
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08004263 int status = RunCommandToFd(out_fd, title, full_command, options);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004264
4265 /* TODO: for now we're simplifying the progress calculation by using the
4266 * timeout as the weight. It's a good approximation for most cases, except when calling dumpsys,
4267 * where its weight should be much higher proportionally to its timeout.
4268 * Ideally, it should use a options.EstimatedDuration() instead...*/
4269 UpdateProgress(options.Timeout());
4270
4271 return status;
4272}
4273
4274void Dumpstate::RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsys_args,
Rhed Jaoe017f982020-07-21 17:58:41 +08004275 const CommandOptions& options, long dumpsysTimeoutMs, int out_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004276 long timeout_ms = dumpsysTimeoutMs > 0 ? dumpsysTimeoutMs : options.TimeoutInMs();
4277 std::vector<std::string> dumpsys = {"/system/bin/dumpsys", "-T", std::to_string(timeout_ms)};
4278 dumpsys.insert(dumpsys.end(), dumpsys_args.begin(), dumpsys_args.end());
Rhed Jaoe017f982020-07-21 17:58:41 +08004279 RunCommand(title, dumpsys, options, false, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004280}
4281
Dieter Hsu105ad0c2020-09-29 15:23:33 +08004282static int open_socket(const char* service) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004283 int s = android_get_control_socket(service);
4284 if (s < 0) {
4285 MYLOGE("android_get_control_socket(%s): %s\n", service, strerror(errno));
4286 return -1;
4287 }
4288 fcntl(s, F_SETFD, FD_CLOEXEC);
4289
4290 // Set backlog to 0 to make sure that queue size will be minimum.
4291 // In Linux, because the minimum queue will be 1, connect() will be blocked
4292 // if the other clients already called connect() and the connection request was not accepted.
4293 if (listen(s, 0) < 0) {
4294 MYLOGE("listen(control socket): %s\n", strerror(errno));
4295 return -1;
4296 }
4297
4298 struct sockaddr addr;
4299 socklen_t alen = sizeof(addr);
Abhijeet Kaur2113cae2019-09-13 09:24:15 +01004300 int fd = accept4(s, &addr, &alen, SOCK_CLOEXEC);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004301
4302 // Close socket just after accept(), to make sure that connect() by client will get error
4303 // when the socket is used by the other services.
4304 // There is still a race condition possibility between accept and close, but there is no way
4305 // to close-on-accept atomically.
4306 // See detail; b/123306389#comment25
4307 close(s);
4308
4309 if (fd < 0) {
4310 MYLOGE("accept(control socket): %s\n", strerror(errno));
4311 return -1;
4312 }
4313
4314 return fd;
4315}
4316
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004317// TODO: should call is_valid_output_file and/or be merged into it.
4318void create_parent_dirs(const char *path) {
4319 char *chp = const_cast<char *> (path);
4320
4321 /* skip initial slash */
4322 if (chp[0] == '/')
4323 chp++;
4324
4325 /* create leading directories, if necessary */
4326 struct stat dir_stat;
4327 while (chp && chp[0]) {
4328 chp = strchr(chp, '/');
4329 if (chp) {
4330 *chp = 0;
4331 if (stat(path, &dir_stat) == -1 || !S_ISDIR(dir_stat.st_mode)) {
4332 MYLOGI("Creating directory %s\n", path);
4333 if (mkdir(path, 0770)) { /* drwxrwx--- */
4334 MYLOGE("Unable to create directory %s: %s\n", path, strerror(errno));
4335 } else if (chown(path, AID_SHELL, AID_SHELL)) {
4336 MYLOGE("Unable to change ownership of dir %s: %s\n", path, strerror(errno));
4337 }
4338 }
4339 *chp++ = '/';
4340 }
4341 }
4342}
4343
4344bool _redirect_to_file(FILE* redirect, char* path, int truncate_flag) {
4345 create_parent_dirs(path);
4346
4347 int fd = TEMP_FAILURE_RETRY(open(path,
4348 O_WRONLY | O_CREAT | truncate_flag | O_CLOEXEC | O_NOFOLLOW,
4349 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH));
4350 if (fd < 0) {
4351 MYLOGE("%s: %s\n", path, strerror(errno));
4352 return false;
4353 }
4354
4355 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
4356 close(fd);
4357 return true;
4358}
4359
4360bool redirect_to_file(FILE* redirect, char* path) {
4361 return _redirect_to_file(redirect, path, O_TRUNC);
4362}
4363
4364bool redirect_to_existing_file(FILE* redirect, char* path) {
4365 return _redirect_to_file(redirect, path, O_APPEND);
4366}
4367
4368void dump_route_tables() {
4369 DurationReporter duration_reporter("DUMP ROUTE TABLES");
4370 if (PropertiesHelper::IsDryRun()) return;
4371 const char* const RT_TABLES_PATH = "/data/misc/net/rt_tables";
4372 ds.DumpFile("RT_TABLES", RT_TABLES_PATH);
4373 FILE* fp = fopen(RT_TABLES_PATH, "re");
4374 if (!fp) {
4375 printf("*** %s: %s\n", RT_TABLES_PATH, strerror(errno));
4376 return;
4377 }
4378 char table[16];
4379 // Each line has an integer (the table number), a space, and a string (the table name). We only
4380 // need the table number. It's a 32-bit unsigned number, so max 10 chars. Skip the table name.
4381 // Add a fixed max limit so this doesn't go awry.
4382 for (int i = 0; i < 64 && fscanf(fp, " %10s %*s", table) == 1; ++i) {
4383 RunCommand("ROUTE TABLE IPv4", {"ip", "-4", "route", "show", "table", table});
4384 RunCommand("ROUTE TABLE IPv6", {"ip", "-6", "route", "show", "table", table});
4385 }
4386 fclose(fp);
4387}
4388
Li Li830179f2022-01-04 12:53:29 -08004389void dump_frozen_cgroupfs(const char *dir, int level,
4390 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
4391 DIR *dirp;
4392 struct dirent *d;
4393 char *newpath = nullptr;
4394
4395 dirp = opendir(dir);
4396 if (dirp == nullptr) {
4397 MYLOGE("%s: %s\n", dir, strerror(errno));
4398 return;
4399 }
4400
4401 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
4402 if ((d->d_name[0] == '.')
4403 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
4404 || (d->d_name[1] == '\0'))) {
4405 continue;
4406 }
4407 if (d->d_type == DT_DIR) {
4408 asprintf(&newpath, "%s/%s/", dir, d->d_name);
4409 if (!newpath) {
4410 continue;
4411 }
4412 if (level == 0 && !strncmp(d->d_name, "uid_", 4)) {
4413 dump_frozen_cgroupfs(newpath, 1, dump_from_fd);
4414 } else if (level == 1 && !strncmp(d->d_name, "pid_", 4)) {
4415 char *freezer = nullptr;
4416 asprintf(&freezer, "%s/%s", newpath, "cgroup.freeze");
4417 if (freezer) {
4418 FILE* fp = fopen(freezer, "r");
4419 if (fp != NULL) {
4420 int frozen;
4421 fscanf(fp, "%d", &frozen);
4422 if (frozen > 0) {
4423 dump_files("", newpath, skip_none, dump_from_fd);
4424 }
4425 fclose(fp);
4426 }
4427 free(freezer);
4428 }
4429 }
4430 }
4431 }
4432 closedir(dirp);
4433}
4434
4435void dump_frozen_cgroupfs() {
Li Li830179f2022-01-04 12:53:29 -08004436 MYLOGD("Adding frozen processes from %s\n", CGROUPFS_DIR);
4437 DurationReporter duration_reporter("FROZEN CGROUPFS");
4438 if (PropertiesHelper::IsDryRun()) return;
4439 dump_frozen_cgroupfs(CGROUPFS_DIR, 0, _add_file_from_fd);
4440}
4441
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004442void Dumpstate::UpdateProgress(int32_t delta_sec) {
4443 if (progress_ == nullptr) {
4444 MYLOGE("UpdateProgress: progress_ not set\n");
4445 return;
4446 }
Rhed Jaobf63d8a2020-07-21 15:42:55 +08004447 // This function updates progress related members of the dumpstate and reports
4448 // progress percentage to the bugreport client. Since it could be called by
4449 // different dump tasks at the same time if the parallel run is enabled, a
4450 // mutex lock is necessary here to synchronize the call.
4451 std::lock_guard<std::recursive_mutex> lock(mutex_);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004452
4453 // Always update progess so stats can be tuned...
Nandana Dutt402a8392019-06-14 14:25:13 +01004454 progress_->Inc(delta_sec);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004455
4456 // ...but only notifiy listeners when necessary.
4457 if (!options_->do_progress_updates) return;
4458
4459 int progress = progress_->Get();
4460 int max = progress_->GetMax();
Nandana Dutt402a8392019-06-14 14:25:13 +01004461 int percent = 100 * progress / max;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004462
Nandana Dutt402a8392019-06-14 14:25:13 +01004463 if (last_reported_percent_progress_ > 0 && percent <= last_reported_percent_progress_) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004464 return;
4465 }
Nandana Dutt402a8392019-06-14 14:25:13 +01004466 last_reported_percent_progress_ = percent;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004467
4468 if (control_socket_fd_ >= 0) {
4469 dprintf(control_socket_fd_, "PROGRESS:%d/%d\n", progress, max);
4470 fsync(control_socket_fd_);
4471 }
4472
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004473 if (listener_ != nullptr) {
Nandana Dutt235c6672019-11-14 15:22:32 +00004474 if (percent % 10 == 0) {
4475 // We don't want to spam logcat, so only log multiples of 10.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004476 MYLOGD("Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004477 } else {
4478 // stderr is ignored on normal invocations, but useful when calling
4479 // /system/bin/dumpstate directly for debuggging.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004480 fprintf(stderr, "Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004481 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004482
4483 listener_->onProgress(percent);
4484 }
4485}
4486
4487void Dumpstate::TakeScreenshot(const std::string& path) {
4488 const std::string& real_path = path.empty() ? screenshot_path_ : path;
4489 int status =
4490 RunCommand("", {"/system/bin/screencap", "-p", real_path},
4491 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
4492 if (status == 0) {
4493 MYLOGD("Screenshot saved on %s\n", real_path.c_str());
4494 } else {
4495 MYLOGE("Failed to take screenshot on %s\n", real_path.c_str());
4496 }
Paul Chang0d2aad72020-02-13 20:04:03 +08004497 if (listener_ != nullptr) {
4498 // Show a visual indication to indicate screenshot is taken via
4499 // IDumpstateListener.onScreenshotTaken()
4500 listener_->onScreenshotTaken(status == 0);
4501 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004502}
4503
4504bool is_dir(const char* pathname) {
4505 struct stat info;
4506 if (stat(pathname, &info) == -1) {
4507 return false;
4508 }
4509 return S_ISDIR(info.st_mode);
4510}
4511
4512time_t get_mtime(int fd, time_t default_mtime) {
4513 struct stat info;
4514 if (fstat(fd, &info) == -1) {
4515 return default_mtime;
4516 }
4517 return info.st_mtime;
4518}