blob: ccb03599f38d00090b08e05365069520ba0012d7 [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"
Colin Crossf45fa6b2012-03-26 12:38:26 -070018
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -070019#include <dirent.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070020#include <errno.h>
21#include <fcntl.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010022#include <inttypes.h>
Felipe Lemead5f6c42015-11-30 14:26:46 -080023#include <libgen.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070024#include <limits.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010025#include <math.h>
26#include <poll.h>
Mark Salyzyn8f37aa52015-06-12 12:28:24 -070027#include <stdbool.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070028#include <stdio.h>
29#include <stdlib.h>
30#include <string.h>
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -070031#include <sys/mount.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080032#include <sys/poll.h>
Christopher Ferris7dc7f322014-07-22 16:08:19 -070033#include <sys/prctl.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070034#include <sys/resource.h>
35#include <sys/stat.h>
36#include <sys/time.h>
37#include <sys/wait.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010038#include <signal.h>
39#include <stdarg.h>
40#include <string.h>
41#include <sys/capability.h>
42#include <sys/inotify.h>
43#include <sys/klog.h>
44#include <time.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070045#include <unistd.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070046
47#include <chrono>
Hridya Valsarajuac582cd2019-08-05 15:39:54 -070048#include <cmath>
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +000049#include <fstream>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070050#include <functional>
51#include <future>
Narayan Kamath8f788292017-05-25 13:20:39 +010052#include <memory>
Hridya Valsarajuac582cd2019-08-05 15:39:54 -070053#include <numeric>
Narayan Kamath8f788292017-05-25 13:20:39 +010054#include <regex>
55#include <set>
56#include <string>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070057#include <utility>
Narayan Kamath8f788292017-05-25 13:20:39 +010058#include <vector>
Colin Crossf45fa6b2012-03-26 12:38:26 -070059
Kedar Chitnis9fd8c052021-11-16 09:09:22 +000060#include <aidl/android/hardware/dumpstate/IDumpstateDevice.h>
Felipe Leme96c2bbb2016-09-26 09:21:21 -070061#include <android-base/file.h>
62#include <android-base/properties.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070063#include <android-base/scopeguard.h>
Elliott Hughes9dc117c2015-12-07 14:21:50 -080064#include <android-base/stringprintf.h>
Naveen Kalla058e1e82016-10-19 21:38:44 -070065#include <android-base/strings.h>
Andreas Gampeaff68432016-07-18 18:01:27 -070066#include <android-base/unique_fd.h>
Kedar Chitnis9fd8c052021-11-16 09:09:22 +000067#include <android/binder_manager.h>
68#include <android/binder_process.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010069#include <android/content/pm/IPackageManagerNative.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080070#include <android/hardware/dumpstate/1.0/IDumpstateDevice.h>
Hunter Knepshield8540faf2020-02-04 19:47:20 -080071#include <android/hardware/dumpstate/1.1/IDumpstateDevice.h>
72#include <android/hardware/dumpstate/1.1/types.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080073#include <android/hidl/manager/1.0/IServiceManager.h>
Nandana Duttd2f5f082019-01-18 17:13:52 +000074#include <android/os/IIncidentCompanion.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010075#include <binder/IServiceManager.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080076#include <cutils/native_handle.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070077#include <cutils/properties.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010078#include <cutils/sockets.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000079#include <debuggerd/client.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080080#include <dumpsys.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000081#include <dumputils/dump_utils.h>
Sahana Raof35ed432019-07-12 10:47:52 +010082#include <hardware_legacy/power.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080083#include <hidl/ServiceManagement.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010084#include <log/log.h>
Tom Cherryf4472f32020-08-05 09:31:17 -070085#include <log/log_read.h>
Felipe Leme75876a22016-10-27 16:31:27 -070086#include <openssl/sha.h>
Mark Salyzyn6c3d90f2016-09-27 14:55:27 -070087#include <private/android_filesystem_config.h>
88#include <private/android_logger.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080089#include <serviceutils/PriorityDumper.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070090#include <utils/StrongPointer.h>
Felipe Lemef0292972016-11-22 13:57:05 -080091#include "DumpstateInternal.h"
Felipe Leme75876a22016-10-27 16:31:27 -070092#include "DumpstateService.h"
Colin Crossf45fa6b2012-03-26 12:38:26 -070093#include "dumpstate.h"
Felipe Leme6e01fa62015-11-11 19:35:14 -080094
Kedar Chitnis9fd8c052021-11-16 09:09:22 +000095namespace dumpstate_hal_hidl_1_0 = android::hardware::dumpstate::V1_0;
96namespace dumpstate_hal_hidl = android::hardware::dumpstate::V1_1;
97namespace dumpstate_hal_aidl = aidl::android::hardware::dumpstate;
98
Vishnu Naire97d6122018-01-18 13:58:56 -080099using ::std::literals::chrono_literals::operator""ms;
100using ::std::literals::chrono_literals::operator""s;
Rhed Jao5377d792020-07-16 17:37:39 +0800101using ::std::placeholders::_1;
Steven Morelandcb7ef822016-11-29 13:20:37 -0800102
Felipe Leme47e9be22016-12-21 15:37:07 -0800103// TODO: remove once moved to namespace
Vishnu Naire97d6122018-01-18 13:58:56 -0800104using android::defaultServiceManager;
105using android::Dumpsys;
106using android::INVALID_OPERATION;
107using android::IServiceManager;
108using android::OK;
109using android::sp;
110using android::status_t;
111using android::String16;
112using android::String8;
113using android::TIMED_OUT;
114using android::UNKNOWN_ERROR;
115using android::Vector;
Nandana Dutt979388e2018-11-30 16:48:55 +0000116using android::base::StringPrintf;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000117using android::os::IDumpstateListener;
Felipe Leme47e9be22016-12-21 15:37:07 -0800118using android::os::dumpstate::CommandOptions;
119using android::os::dumpstate::DumpFileToFd;
Rhed Jao5377d792020-07-16 17:37:39 +0800120using android::os::dumpstate::DumpPool;
Vishnu Naire97d6122018-01-18 13:58:56 -0800121using android::os::dumpstate::PropertiesHelper;
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800122using android::os::dumpstate::TaskQueue;
Chris Morinbc223142022-02-04 14:17:11 -0800123using android::os::dumpstate::WaitForTask;
Felipe Leme47e9be22016-12-21 15:37:07 -0800124
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100125// Keep in sync with
126// frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
127static const int TRACE_DUMP_TIMEOUT_MS = 10000; // 10 seconds
128
129/* Most simple commands have 10 as timeout, so 5 is a good estimate */
130static const int32_t WEIGHT_FILE = 5;
131
132// TODO: temporary variables and functions used during C++ refactoring
133static Dumpstate& ds = Dumpstate::GetInstance();
134static int RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Nandana Dutt8d945c02019-08-14 13:30:07 +0100135 const CommandOptions& options = CommandOptions::DEFAULT,
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800136 bool verbose_duration = false, int out_fd = STDOUT_FILENO) {
137 return ds.RunCommand(title, full_command, options, verbose_duration, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100138}
139
140// Reasonable value for max stats.
141static const int STATS_MAX_N_RUNS = 1000;
142static const long STATS_MAX_AVERAGE = 100000;
143
144CommandOptions Dumpstate::DEFAULT_DUMPSYS = CommandOptions::WithTimeout(30).Build();
145
Nandana Duttd2f5f082019-01-18 17:13:52 +0000146typedef Dumpstate::ConsentCallback::ConsentResult UserConsentResult;
147
Colin Crossf45fa6b2012-03-26 12:38:26 -0700148/* read before root is shed */
149static char cmdline_buf[16384] = "(unknown)";
Yi Kong19d5c002018-07-20 13:39:55 -0700150static const char *dump_traces_path = nullptr;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000151static const uint64_t USER_CONSENT_TIMEOUT_MS = 30 * 1000;
Hunter Knepshield70610fa2020-01-03 15:27:33 -0800152// Because telephony reports are significantly faster to collect (< 10 seconds vs. > 2 minutes),
153// it's often the case that they time out far too quickly for consent with such a hefty dialog for
154// the user to read. For telephony reports only, we increase the default timeout to 2 minutes to
155// roughly match full reports' durations.
156static const uint64_t TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS = 2 * 60 * 1000;
Colin Crossf45fa6b2012-03-26 12:38:26 -0700157
Felipe Leme1d486fe2016-10-14 18:06:47 -0700158// TODO: variables and functions below should be part of dumpstate object
159
Felipe Leme635ca312016-01-05 14:23:02 -0800160static std::set<std::string> mount_points;
161void add_mountinfo();
Felipe Leme78f2c862015-12-21 09:55:22 -0800162
Todd Poynor2a83daa2013-11-22 15:44:22 -0800163#define PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops"
Mark Salyzyn7d0a7622016-06-24 14:06:15 -0700164#define ALT_PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops-0"
Wei Wang509bb5d2017-06-09 14:42:12 -0700165#define BLK_DEV_SYS_DIR "/sys/block"
Todd Poynor2a83daa2013-11-22 15:44:22 -0800166
Felipe Lemee82a27d2016-01-05 13:35:44 -0800167#define RECOVERY_DIR "/cache/recovery"
Mark Salyzynd6ab0112016-03-25 12:56:39 -0700168#define RECOVERY_DATA_DIR "/data/misc/recovery"
Tianjie Xu75d53362018-04-11 16:42:28 -0700169#define UPDATE_ENGINE_LOG_DIR "/data/misc/update_engine_log"
Mark Salyzyn4d42dea2016-04-01 10:03:14 -0700170#define LOGPERSIST_DATA_DIR "/data/misc/logd"
Jerry Changa1df8a92020-01-02 16:03:39 +0800171#define PREREBOOT_DATA_DIR "/data/misc/prereboot"
David Brazdild2991962016-06-03 14:40:44 +0100172#define PROFILE_DATA_DIR_CUR "/data/misc/profiles/cur"
173#define PROFILE_DATA_DIR_REF "/data/misc/profiles/ref"
Benedict Wong8f9d8a42019-01-03 16:19:38 -0800174#define XFRM_STAT_PROC_FILE "/proc/net/xfrm_stat"
Erik Kline08165202016-05-30 11:55:44 +0900175#define WLUTIL "/vendor/xbin/wlutil"
Vishnu Nair36b4cdb2017-11-17 10:27:05 -0800176#define WMTRACE_DATA_DIR "/data/misc/wmtrace"
Yifan Hong3945e1b2019-10-29 12:59:23 -0700177#define OTA_METADATA_DIR "/metadata/ota"
Yifan Hong0efa7972020-02-03 16:45:02 -0800178#define SNAPSHOTCTL_LOG_DIR "/data/misc/snapshotctl_log"
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +0900179#define LINKERCONFIG_DIR "/linkerconfig"
Calin Juravlef84d3692020-04-28 15:31:12 -0700180#define PACKAGE_DEX_USE_LIST "/data/system/package-dex-usage.list"
Primiano Tuccifaaaafb2021-01-14 12:26:29 +0000181#define SYSTEM_TRACE_SNAPSHOT "/data/misc/perfetto-traces/bugreport/systrace.pftrace"
Li Li2eedd412021-06-30 15:11:53 -0700182#define CGROUPFS_DIR "/sys/fs/cgroup"
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700183
Narayan Kamath8f788292017-05-25 13:20:39 +0100184// TODO(narayan): Since this information has to be kept in sync
185// with tombstoned, we should just put it in a common header.
186//
187// File: system/core/debuggerd/tombstoned/tombstoned.cpp
Narayan Kamathbd863722017-06-01 18:50:12 +0100188static const std::string TOMBSTONE_DIR = "/data/tombstones/";
189static const std::string TOMBSTONE_FILE_PREFIX = "tombstone_";
190static const std::string ANR_DIR = "/data/anr/";
191static const std::string ANR_FILE_PREFIX = "anr_";
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700192
Felipe Lemee844a9d2016-09-21 15:01:39 -0700193// TODO: temporary variables and functions used during C++ refactoring
Nandana Dutt979388e2018-11-30 16:48:55 +0000194
Nandana Dutt5c390032019-03-12 10:52:56 +0000195#define RETURN_IF_USER_DENIED_CONSENT() \
196 if (ds.IsUserConsentDenied()) { \
197 MYLOGE("Returning early as user denied consent to share bugreport with calling app."); \
198 return Dumpstate::RunStatus::USER_CONSENT_DENIED; \
199 }
200
201// Runs func_ptr, but checks user consent before and after running it. Returns USER_CONSENT_DENIED
202// if consent is found to be denied.
203#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(func_ptr, ...) \
204 RETURN_IF_USER_DENIED_CONSENT(); \
205 func_ptr(__VA_ARGS__); \
206 RETURN_IF_USER_DENIED_CONSENT();
207
Rhed Jao5377d792020-07-16 17:37:39 +0800208// Runs func_ptr, and logs a duration report after it's finished.
209#define RUN_SLOW_FUNCTION_AND_LOG(log_title, func_ptr, ...) \
210 { \
211 DurationReporter duration_reporter_in_macro(log_title); \
212 func_ptr(__VA_ARGS__); \
213 }
214
215// Similar with RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK, an additional duration report
216// is output after a slow function is finished.
217#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(log_title, func_ptr, ...) \
218 RETURN_IF_USER_DENIED_CONSENT(); \
219 RUN_SLOW_FUNCTION_AND_LOG(log_title, func_ptr, __VA_ARGS__); \
220 RETURN_IF_USER_DENIED_CONSENT();
221
Chris Morinbc223142022-02-04 14:17:11 -0800222#define WAIT_TASK_WITH_CONSENT_CHECK(future) \
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800223 RETURN_IF_USER_DENIED_CONSENT(); \
Chris Morinbc223142022-02-04 14:17:11 -0800224 WaitForTask(future); \
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800225 RETURN_IF_USER_DENIED_CONSENT();
226
Sahana Raof35ed432019-07-12 10:47:52 +0100227static const char* WAKE_LOCK_NAME = "dumpstate_wakelock";
228
Rhed Jao5377d792020-07-16 17:37:39 +0800229// Names of parallel tasks, they are used for the DumpPool to identify the dump
230// task and the log title of the duration report.
231static const std::string DUMP_TRACES_TASK = "DUMP TRACES";
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800232static const std::string DUMP_INCIDENT_REPORT_TASK = "INCIDENT REPORT";
233static const std::string DUMP_HALS_TASK = "DUMP HALS";
234static const std::string DUMP_BOARD_TASK = "dumpstate_board()";
Rhed Jaoe017f982020-07-21 17:58:41 +0800235static const std::string DUMP_CHECKINS_TASK = "DUMP CHECKINS";
Rhed Jao5377d792020-07-16 17:37:39 +0800236
Nandana Dutt979388e2018-11-30 16:48:55 +0000237namespace android {
238namespace os {
239namespace {
240
241static int Open(std::string path, int flags, mode_t mode = 0) {
242 int fd = TEMP_FAILURE_RETRY(open(path.c_str(), flags, mode));
243 if (fd == -1) {
244 MYLOGE("open(%s, %s)\n", path.c_str(), strerror(errno));
245 }
246 return fd;
247}
248
mhasank2d75c442020-06-11 15:05:25 -0700249static int OpenForWrite(std::string path) {
250 return Open(path, O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
251 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH);
252}
Nandana Dutt979388e2018-11-30 16:48:55 +0000253
254static int OpenForRead(std::string path) {
255 return Open(path, O_RDONLY | O_CLOEXEC | O_NOFOLLOW);
256}
257
258bool CopyFile(int in_fd, int out_fd) {
259 char buf[4096];
260 ssize_t byte_count;
261 while ((byte_count = TEMP_FAILURE_RETRY(read(in_fd, buf, sizeof(buf)))) > 0) {
262 if (!android::base::WriteFully(out_fd, buf, byte_count)) {
263 return false;
264 }
265 }
266 return (byte_count != -1);
267}
268
269static bool CopyFileToFd(const std::string& input_file, int out_fd) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000270 MYLOGD("Going to copy file (%s) to %d\n", input_file.c_str(), out_fd);
Nandana Dutt979388e2018-11-30 16:48:55 +0000271
272 // Obtain a handle to the source file.
273 android::base::unique_fd in_fd(OpenForRead(input_file));
274 if (out_fd != -1 && in_fd.get() != -1) {
275 if (CopyFile(in_fd.get(), out_fd)) {
276 return true;
277 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000278 MYLOGE("Failed to copy file: %s\n", strerror(errno));
Nandana Dutt979388e2018-11-30 16:48:55 +0000279 }
280 return false;
281}
282
Nandana Duttd2f5f082019-01-18 17:13:52 +0000283static bool UnlinkAndLogOnError(const std::string& file) {
Nandana Dutt8ae16e62020-03-27 10:20:22 +0000284 if (file.empty()) {
285 return false;
286 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000287 if (unlink(file.c_str())) {
288 MYLOGE("Failed to unlink file (%s): %s\n", file.c_str(), strerror(errno));
Nandana Duttd2f5f082019-01-18 17:13:52 +0000289 return false;
290 }
291 return true;
292}
Nandana Dutt979388e2018-11-30 16:48:55 +0000293
Nikita Ioffea325a572019-05-16 19:49:47 +0100294int64_t GetModuleMetadataVersion() {
295 auto binder = defaultServiceManager()->getService(android::String16("package_native"));
296 if (binder == nullptr) {
297 MYLOGE("Failed to retrieve package_native service");
298 return 0L;
299 }
300 auto package_service = android::interface_cast<content::pm::IPackageManagerNative>(binder);
301 std::string package_name;
302 auto status = package_service->getModuleMetadataPackageName(&package_name);
303 if (!status.isOk()) {
304 MYLOGE("Failed to retrieve module metadata package name: %s", status.toString8().c_str());
305 return 0L;
306 }
Nandana Duttdb379fa2019-10-09 16:54:41 +0100307 MYLOGD("Module metadata package name: %s\n", package_name.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100308 int64_t version_code;
309 status = package_service->getVersionCodeForPackage(android::String16(package_name.c_str()),
310 &version_code);
311 if (!status.isOk()) {
312 MYLOGE("Failed to retrieve module metadata version: %s", status.toString8().c_str());
313 return 0L;
314 }
315 return version_code;
316}
317
mhasank2d75c442020-06-11 15:05:25 -0700318static bool PathExists(const std::string& path) {
319 struct stat sb;
320 return stat(path.c_str(), &sb) == 0;
321}
322
323static bool CopyFileToFile(const std::string& input_file, const std::string& output_file) {
324 if (input_file == output_file) {
325 MYLOGD("Skipping copying bugreport file since the destination is the same (%s)\n",
326 output_file.c_str());
327 return false;
328 }
329 else if (PathExists(output_file)) {
330 MYLOGD("Cannot overwrite an existing file (%s)\n", output_file.c_str());
331 return false;
332 }
333
334 MYLOGD("Going to copy bugreport file (%s) to %s\n", input_file.c_str(), output_file.c_str());
335 android::base::unique_fd out_fd(OpenForWrite(output_file));
336 return CopyFileToFd(input_file, out_fd.get());
337}
338
Nandana Dutt979388e2018-11-30 16:48:55 +0000339} // namespace
340} // namespace os
341} // namespace android
342
Felipe Leme678727a2016-09-21 17:22:11 -0700343static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
Felipe Lemebda15a02016-11-16 17:48:25 -0800344 const CommandOptions& options = Dumpstate::DEFAULT_DUMPSYS,
Rhed Jaoe017f982020-07-21 17:58:41 +0800345 long dumpsysTimeoutMs = 0, int out_fd = STDOUT_FILENO) {
346 return ds.RunDumpsys(title, dumpsysArgs, options, dumpsysTimeoutMs, out_fd);
347}
348static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
349 int out_fd) {
350 return ds.RunDumpsys(title, dumpsysArgs, Dumpstate::DEFAULT_DUMPSYS, 0, out_fd);
Felipe Leme678727a2016-09-21 17:22:11 -0700351}
352static int DumpFile(const std::string& title, const std::string& path) {
353 return ds.DumpFile(title, path);
354}
Felipe Lemee82a27d2016-01-05 13:35:44 -0800355
Felipe Lemee844a9d2016-09-21 15:01:39 -0700356// Relative directory (inside the zip) for all files copied as-is into the bugreport.
357static const std::string ZIP_ROOT_DIR = "FS";
358
Vishnu Naire97d6122018-01-18 13:58:56 -0800359static const std::string kProtoPath = "proto/";
360static const std::string kProtoExt = ".proto";
Jie Song9fbfad02017-06-20 16:29:42 -0700361static const std::string kDumpstateBoardFiles[] = {
362 "dumpstate_board.txt",
Felipe Leme95d6ca52017-08-01 16:35:56 -0700363 "dumpstate_board.bin"
Jie Song9fbfad02017-06-20 16:29:42 -0700364};
365static const int NUM_OF_DUMPS = arraysize(kDumpstateBoardFiles);
366
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700367static constexpr char PROPERTY_LAST_ID[] = "dumpstate.last_id";
Felipe Lemed071c682016-10-20 16:48:00 -0700368static constexpr char PROPERTY_VERSION[] = "dumpstate.version";
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700369
Felipe Lemef0292972016-11-22 13:57:05 -0800370static const CommandOptions AS_ROOT_20 = CommandOptions::WithTimeout(20).AsRoot().Build();
371
Narayan Kamath8f788292017-05-25 13:20:39 +0100372/*
Narayan Kamathbd863722017-06-01 18:50:12 +0100373 * Returns a vector of dump fds under |dir_path| with a given |file_prefix|.
Rhed Jao01dc0c62020-06-03 17:13:30 +0800374 * The returned vector is sorted by the mtimes of the dumps with descending
Chris Morinc2cba7a2022-02-01 17:06:50 -0800375 * order.
Narayan Kamath8f788292017-05-25 13:20:39 +0100376 */
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700377static std::vector<DumpData> GetDumpFds(const std::string& dir_path,
Chris Morinc2cba7a2022-02-01 17:06:50 -0800378 const std::string& file_prefix) {
Narayan Kamathbd863722017-06-01 18:50:12 +0100379 std::unique_ptr<DIR, decltype(&closedir)> dump_dir(opendir(dir_path.c_str()), closedir);
Narayan Kamath8f788292017-05-25 13:20:39 +0100380
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700381 if (dump_dir == nullptr) {
382 MYLOGW("Unable to open directory %s: %s\n", dir_path.c_str(), strerror(errno));
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700383 return std::vector<DumpData>();
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700384 }
385
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700386 std::vector<DumpData> dump_data;
Narayan Kamathbd863722017-06-01 18:50:12 +0100387 struct dirent* entry = nullptr;
388 while ((entry = readdir(dump_dir.get()))) {
389 if (entry->d_type != DT_REG) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100390 continue;
391 }
392
Narayan Kamathbd863722017-06-01 18:50:12 +0100393 const std::string base_name(entry->d_name);
394 if (base_name.find(file_prefix) != 0) {
395 continue;
396 }
397
398 const std::string abs_path = dir_path + base_name;
399 android::base::unique_fd fd(
400 TEMP_FAILURE_RETRY(open(abs_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW | O_NONBLOCK)));
401 if (fd == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700402 MYLOGW("Unable to open dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamathbd863722017-06-01 18:50:12 +0100403 break;
404 }
405
406 struct stat st = {};
407 if (fstat(fd, &st) == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700408 MYLOGW("Unable to stat dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamath8f788292017-05-25 13:20:39 +0100409 continue;
410 }
411
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700412 dump_data.emplace_back(DumpData{abs_path, std::move(fd), st.st_mtime});
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700413 }
Rhed Jao01dc0c62020-06-03 17:13:30 +0800414 if (!dump_data.empty()) {
415 std::sort(dump_data.begin(), dump_data.end(),
416 [](const auto& a, const auto& b) { return a.mtime > b.mtime; });
417 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100418
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700419 return dump_data;
Narayan Kamath8f788292017-05-25 13:20:39 +0100420}
421
Narayan Kamathbd863722017-06-01 18:50:12 +0100422static bool AddDumps(const std::vector<DumpData>::const_iterator start,
423 const std::vector<DumpData>::const_iterator end,
424 const char* type_name, const bool add_to_zip) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100425 bool dumped = false;
Narayan Kamathbd863722017-06-01 18:50:12 +0100426 for (auto it = start; it != end; ++it) {
427 const std::string& name = it->name;
428 const int fd = it->fd;
Narayan Kamath8f788292017-05-25 13:20:39 +0100429 dumped = true;
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100430
431 // Seek to the beginning of the file before dumping any data. A given
432 // DumpData entry might be dumped multiple times in the report.
433 //
434 // For example, the most recent ANR entry is dumped to the body of the
435 // main entry and it also shows up as a separate entry in the bugreport
436 // ZIP file.
437 if (lseek(fd, 0, SEEK_SET) != static_cast<off_t>(0)) {
438 MYLOGE("Unable to add %s to zip file, lseek failed: %s\n", name.c_str(),
439 strerror(errno));
440 }
441
Chris Morinc2cba7a2022-02-01 17:06:50 -0800442 if (add_to_zip) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800443 if (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + name, fd, /* timeout = */ 0ms) != OK) {
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100444 MYLOGE("Unable to add %s to zip file, addZipEntryFromFd failed\n", name.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100445 }
446 } else {
447 dump_file_from_fd(type_name, name.c_str(), fd);
448 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100449 }
450
451 return dumped;
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700452}
453
Felipe Leme635ca312016-01-05 14:23:02 -0800454// for_each_pid() callback to get mount info about a process.
Felipe Leme4c2d6632016-09-28 14:32:00 -0700455void do_mountinfo(int pid, const char* name __attribute__((unused))) {
Felipe Leme635ca312016-01-05 14:23:02 -0800456 char path[PATH_MAX];
457
458 // Gets the the content of the /proc/PID/ns/mnt link, so only unique mount points
459 // are added.
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700460 snprintf(path, sizeof(path), "/proc/%d/ns/mnt", pid);
Felipe Leme635ca312016-01-05 14:23:02 -0800461 char linkname[PATH_MAX];
462 ssize_t r = readlink(path, linkname, PATH_MAX);
463 if (r == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800464 MYLOGE("Unable to read link for %s: %s\n", path, strerror(errno));
Felipe Leme635ca312016-01-05 14:23:02 -0800465 return;
466 }
467 linkname[r] = '\0';
468
469 if (mount_points.find(linkname) == mount_points.end()) {
470 // First time this mount point was found: add it
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700471 snprintf(path, sizeof(path), "/proc/%d/mountinfo", pid);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700472 if (ds.AddZipEntry(ZIP_ROOT_DIR + path, path)) {
Felipe Leme635ca312016-01-05 14:23:02 -0800473 mount_points.insert(linkname);
474 } else {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800475 MYLOGE("Unable to add mountinfo %s to zip file\n", path);
Felipe Leme635ca312016-01-05 14:23:02 -0800476 }
477 }
478}
479
480void add_mountinfo() {
Felipe Leme678727a2016-09-21 17:22:11 -0700481 std::string title = "MOUNT INFO";
Felipe Leme635ca312016-01-05 14:23:02 -0800482 mount_points.clear();
Felipe Leme46b85da2016-11-21 17:40:45 -0800483 DurationReporter duration_reporter(title, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700484 for_each_pid(do_mountinfo, nullptr);
485 MYLOGD("%s: %d entries added to zip file\n", title.c_str(), (int)mount_points.size());
Felipe Leme635ca312016-01-05 14:23:02 -0800486}
487
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700488static void dump_dev_files(const char *title, const char *driverpath, const char *filename)
489{
490 DIR *d;
491 struct dirent *de;
492 char path[PATH_MAX];
493
494 d = opendir(driverpath);
Yi Kong19d5c002018-07-20 13:39:55 -0700495 if (d == nullptr) {
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700496 return;
497 }
498
499 while ((de = readdir(d))) {
500 if (de->d_type != DT_LNK) {
501 continue;
502 }
503 snprintf(path, sizeof(path), "%s/%s/%s", driverpath, de->d_name, filename);
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700504 DumpFile(title, path);
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700505 }
506
507 closedir(d);
508}
509
Mark Salyzyn326842f2015-04-30 09:49:41 -0700510static bool skip_not_stat(const char *path) {
511 static const char stat[] = "/stat";
512 size_t len = strlen(path);
513 if (path[len - 1] == '/') { /* Directory? */
514 return false;
515 }
516 return strcmp(path + len - sizeof(stat) + 1, stat); /* .../stat? */
517}
518
Felipe Leme4c2d6632016-09-28 14:32:00 -0700519static bool skip_none(const char* path __attribute__((unused))) {
Felipe Lemee82a27d2016-01-05 13:35:44 -0800520 return false;
521}
522
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700523unsigned long worst_write_perf = 20000; /* in KB/s */
Mark Salyzyn326842f2015-04-30 09:49:41 -0700524
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800525//
526// stat offsets
527// Name units description
528// ---- ----- -----------
529// read I/Os requests number of read I/Os processed
530#define __STAT_READ_IOS 0
531// read merges requests number of read I/Os merged with in-queue I/O
532#define __STAT_READ_MERGES 1
533// read sectors sectors number of sectors read
534#define __STAT_READ_SECTORS 2
535// read ticks milliseconds total wait time for read requests
536#define __STAT_READ_TICKS 3
537// write I/Os requests number of write I/Os processed
538#define __STAT_WRITE_IOS 4
539// write merges requests number of write I/Os merged with in-queue I/O
540#define __STAT_WRITE_MERGES 5
541// write sectors sectors number of sectors written
542#define __STAT_WRITE_SECTORS 6
543// write ticks milliseconds total wait time for write requests
544#define __STAT_WRITE_TICKS 7
545// in_flight requests number of I/Os currently in flight
546#define __STAT_IN_FLIGHT 8
547// io_ticks milliseconds total time this block device has been active
548#define __STAT_IO_TICKS 9
549// time_in_queue milliseconds total wait time for all requests
550#define __STAT_IN_QUEUE 10
551#define __STAT_NUMBER_FIELD 11
552//
553// read I/Os, write I/Os
554// =====================
555//
556// These values increment when an I/O request completes.
557//
558// read merges, write merges
559// =========================
560//
561// These values increment when an I/O request is merged with an
562// already-queued I/O request.
563//
564// read sectors, write sectors
565// ===========================
566//
567// These values count the number of sectors read from or written to this
568// block device. The "sectors" in question are the standard UNIX 512-byte
569// sectors, not any device- or filesystem-specific block size. The
570// counters are incremented when the I/O completes.
571#define SECTOR_SIZE 512
572//
573// read ticks, write ticks
574// =======================
575//
576// These values count the number of milliseconds that I/O requests have
577// waited on this block device. If there are multiple I/O requests waiting,
578// these values will increase at a rate greater than 1000/second; for
579// example, if 60 read requests wait for an average of 30 ms, the read_ticks
580// field will increase by 60*30 = 1800.
581//
582// in_flight
583// =========
584//
585// This value counts the number of I/O requests that have been issued to
586// the device driver but have not yet completed. It does not include I/O
587// requests that are in the queue but not yet issued to the device driver.
588//
589// io_ticks
590// ========
591//
592// This value counts the number of milliseconds during which the device has
593// had I/O requests queued.
594//
595// time_in_queue
596// =============
597//
598// This value counts the number of milliseconds that I/O requests have waited
599// on this block device. If there are multiple I/O requests waiting, this
600// value will increase as the product of the number of milliseconds times the
601// number of requests waiting (see "read ticks" above for an example).
602#define S_TO_MS 1000
603//
604
Mark Salyzyn326842f2015-04-30 09:49:41 -0700605static int dump_stat_from_fd(const char *title __unused, const char *path, int fd) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800606 unsigned long long fields[__STAT_NUMBER_FIELD];
Mark Salyzyn326842f2015-04-30 09:49:41 -0700607 bool z;
Yi Kong19d5c002018-07-20 13:39:55 -0700608 char *cp, *buffer = nullptr;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700609 size_t i = 0;
Josh Gao7c4258c2018-06-25 13:40:08 -0700610 FILE *fp = fdopen(dup(fd), "rb");
Mark Salyzyn326842f2015-04-30 09:49:41 -0700611 getline(&buffer, &i, fp);
612 fclose(fp);
613 if (!buffer) {
614 return -errno;
615 }
616 i = strlen(buffer);
617 while ((i > 0) && (buffer[i - 1] == '\n')) {
618 buffer[--i] = '\0';
619 }
620 if (!*buffer) {
621 free(buffer);
622 return 0;
623 }
624 z = true;
625 for (cp = buffer, i = 0; i < (sizeof(fields) / sizeof(fields[0])); ++i) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800626 fields[i] = strtoull(cp, &cp, 10);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700627 if (fields[i] != 0) {
628 z = false;
629 }
630 }
631 if (z) { /* never accessed */
632 free(buffer);
633 return 0;
634 }
635
Wei Wang509bb5d2017-06-09 14:42:12 -0700636 if (!strncmp(path, BLK_DEV_SYS_DIR, sizeof(BLK_DEV_SYS_DIR) - 1)) {
637 path += sizeof(BLK_DEV_SYS_DIR) - 1;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700638 }
Wei Wang1dc1ef52017-06-12 11:28:37 -0700639
640 printf("%-30s:%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s\n%-30s:\t%s\n", "Block-Dev",
641 "R-IOs", "R-merg", "R-sect", "R-wait", "W-IOs", "W-merg", "W-sect",
642 "W-wait", "in-fli", "activ", "T-wait", path, buffer);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700643 free(buffer);
644
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800645 if (fields[__STAT_IO_TICKS]) {
646 unsigned long read_perf = 0;
647 unsigned long read_ios = 0;
648 if (fields[__STAT_READ_TICKS]) {
649 unsigned long long divisor = fields[__STAT_READ_TICKS]
650 * fields[__STAT_IO_TICKS];
651 read_perf = ((unsigned long long)SECTOR_SIZE
652 * fields[__STAT_READ_SECTORS]
653 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
654 / divisor;
655 read_ios = ((unsigned long long)S_TO_MS * fields[__STAT_READ_IOS]
656 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
657 / divisor;
658 }
659
660 unsigned long write_perf = 0;
661 unsigned long write_ios = 0;
662 if (fields[__STAT_WRITE_TICKS]) {
663 unsigned long long divisor = fields[__STAT_WRITE_TICKS]
664 * fields[__STAT_IO_TICKS];
665 write_perf = ((unsigned long long)SECTOR_SIZE
666 * fields[__STAT_WRITE_SECTORS]
667 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
668 / divisor;
669 write_ios = ((unsigned long long)S_TO_MS * fields[__STAT_WRITE_IOS]
670 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
671 / divisor;
672 }
673
674 unsigned queue = (fields[__STAT_IN_QUEUE]
675 + (fields[__STAT_IO_TICKS] >> 1))
676 / fields[__STAT_IO_TICKS];
677
678 if (!write_perf && !write_ios) {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700679 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 -0800680 } else {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700681 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 -0800682 read_ios, write_perf, write_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800683 }
684
685 /* bugreport timeout factor adjustment */
686 if ((write_perf > 1) && (write_perf < worst_write_perf)) {
687 worst_write_perf = write_perf;
688 }
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700689 }
Mark Salyzyn326842f2015-04-30 09:49:41 -0700690 return 0;
691}
692
Yao Chenbe3bbc12018-01-17 16:31:10 -0800693static const long MINIMUM_LOGCAT_TIMEOUT_MS = 50000;
694
Tom Cherryf4472f32020-08-05 09:31:17 -0700695// Returns the actual readable size of the given buffer or -1 on error.
696static long logcat_buffer_readable_size(const std::string& buffer) {
697 std::unique_ptr<logger_list, decltype(&android_logger_list_free)> logger_list{
698 android_logger_list_alloc(0, 0, 0), &android_logger_list_free};
699 auto logger = android_logger_open(logger_list.get(), android_name_to_log_id(buffer.c_str()));
700
701 return android_logger_get_log_readable_size(logger);
702}
703
704// Returns timeout in ms to read a list of buffers.
Yao Chenbe3bbc12018-01-17 16:31:10 -0800705static unsigned long logcat_timeout(const std::vector<std::string>& buffers) {
706 unsigned long timeout_ms = 0;
707 for (const auto& buffer : buffers) {
Tom Cherryf4472f32020-08-05 09:31:17 -0700708 long readable_size = logcat_buffer_readable_size(buffer);
709 if (readable_size > 0) {
710 // Engineering margin is ten-fold our guess.
711 timeout_ms += 10 * (readable_size + worst_write_perf) / worst_write_perf;
712 }
Yao Chenbe3bbc12018-01-17 16:31:10 -0800713 }
714 return timeout_ms > MINIMUM_LOGCAT_TIMEOUT_MS ? timeout_ms : MINIMUM_LOGCAT_TIMEOUT_MS;
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700715}
716
Dieter Hsu105ad0c2020-09-29 15:23:33 +0800717// Opens a socket and returns its file descriptor.
718static int open_socket(const char* service);
719
Nandana Duttd2f5f082019-01-18 17:13:52 +0000720Dumpstate::ConsentCallback::ConsentCallback() : result_(UNAVAILABLE), start_time_(Nanotime()) {
721}
722
723android::binder::Status Dumpstate::ConsentCallback::onReportApproved() {
724 std::lock_guard<std::mutex> lock(lock_);
725 result_ = APPROVED;
726 MYLOGD("User approved consent to share bugreport\n");
Paul Chang0d2aad72020-02-13 20:04:03 +0800727
728 // Maybe copy screenshot so calling app can display the screenshot to the user as soon as
729 // consent is granted.
730 if (ds.options_->is_screenshot_copied) {
731 return android::binder::Status::ok();
732 }
733
734 if (!ds.options_->do_screenshot || ds.options_->screenshot_fd.get() == -1 ||
735 !ds.do_early_screenshot_) {
736 return android::binder::Status::ok();
737 }
738
739 bool copy_succeeded = android::os::CopyFileToFd(ds.screenshot_path_,
740 ds.options_->screenshot_fd.get());
741 ds.options_->is_screenshot_copied = copy_succeeded;
742 if (copy_succeeded) {
743 android::os::UnlinkAndLogOnError(ds.screenshot_path_);
744 }
Nandana Duttd2f5f082019-01-18 17:13:52 +0000745 return android::binder::Status::ok();
746}
747
748android::binder::Status Dumpstate::ConsentCallback::onReportDenied() {
749 std::lock_guard<std::mutex> lock(lock_);
750 result_ = DENIED;
751 MYLOGW("User denied consent to share bugreport\n");
752 return android::binder::Status::ok();
753}
754
755UserConsentResult Dumpstate::ConsentCallback::getResult() {
756 std::lock_guard<std::mutex> lock(lock_);
757 return result_;
758}
759
760uint64_t Dumpstate::ConsentCallback::getElapsedTimeMs() const {
Hunter Knepshieldf0a39052020-01-03 14:53:04 -0800761 return (Nanotime() - start_time_) / NANOS_PER_MILLI;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000762}
763
Felipe Leme2b9b06c2016-10-14 09:13:06 -0700764void Dumpstate::PrintHeader() const {
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700765 std::string build, fingerprint, radio, bootloader, network;
766 char date[80];
Colin Crossf45fa6b2012-03-26 12:38:26 -0700767
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700768 build = android::base::GetProperty("ro.build.display.id", "(unknown)");
769 fingerprint = android::base::GetProperty("ro.build.fingerprint", "(unknown)");
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700770 radio = android::base::GetProperty("gsm.version.baseband", "(unknown)");
771 bootloader = android::base::GetProperty("ro.bootloader", "(unknown)");
772 network = android::base::GetProperty("gsm.operator.alpha", "(unknown)");
Felipe Lemebbaf3c12016-10-11 14:32:25 -0700773 strftime(date, sizeof(date), "%Y-%m-%d %H:%M:%S", localtime(&now_));
Colin Crossf45fa6b2012-03-26 12:38:26 -0700774
Felipe Lemed8b94e52016-12-08 10:21:44 -0800775 printf("========================================================\n");
776 printf("== dumpstate: %s\n", date);
777 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -0700778
Felipe Lemed8b94e52016-12-08 10:21:44 -0800779 printf("\n");
780 printf("Build: %s\n", build.c_str());
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700781 // NOTE: fingerprint entry format is important for other tools.
Felipe Lemed8b94e52016-12-08 10:21:44 -0800782 printf("Build fingerprint: '%s'\n", fingerprint.c_str());
783 printf("Bootloader: %s\n", bootloader.c_str());
784 printf("Radio: %s\n", radio.c_str());
785 printf("Network: %s\n", network.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100786 int64_t module_metadata_version = android::os::GetModuleMetadataVersion();
787 if (module_metadata_version != 0) {
788 printf("Module Metadata version: %" PRId64 "\n", module_metadata_version);
789 }
Anton Hansson37c041d2021-04-14 17:49:06 +0100790 printf("SDK extension versions [r=%s s=%s]\n",
791 android::base::GetProperty("build.version.extensions.r", "-").c_str(),
792 android::base::GetProperty("build.version.extensions.s", "-").c_str());
Colin Crossf45fa6b2012-03-26 12:38:26 -0700793
Felipe Lemed8b94e52016-12-08 10:21:44 -0800794 printf("Kernel: ");
Felipe Lemef0292972016-11-22 13:57:05 -0800795 DumpFileToFd(STDOUT_FILENO, "", "/proc/version");
Felipe Lemed8b94e52016-12-08 10:21:44 -0800796 printf("Command line: %s\n", strtok(cmdline_buf, "\n"));
Felipe Leme7709f8a2017-12-05 09:30:09 -0800797 printf("Uptime: ");
798 RunCommandToFd(STDOUT_FILENO, "", {"uptime", "-p"},
799 CommandOptions::WithTimeout(1).Always().Build());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800800 printf("Bugreport format version: %s\n", version_.c_str());
Rhed Jao5377d792020-07-16 17:37:39 +0800801 printf("Dumpstate info: id=%d pid=%d dry_run=%d parallel_run=%d args=%s bugreport_mode=%s\n",
802 id_, pid_, PropertiesHelper::IsDryRun(), PropertiesHelper::IsParallelRun(),
Kedar Chitnis9fd8c052021-11-16 09:09:22 +0000803 options_->args.c_str(), options_->bugreport_mode_string.c_str());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800804 printf("\n");
Felipe Leme78f2c862015-12-21 09:55:22 -0800805}
806
Felipe Leme24b66ee2016-06-16 10:55:26 -0700807// List of file extensions that can cause a zip file attachment to be rejected by some email
808// service providers.
809static const std::set<std::string> PROBLEMATIC_FILE_EXTENSIONS = {
810 ".ade", ".adp", ".bat", ".chm", ".cmd", ".com", ".cpl", ".exe", ".hta", ".ins", ".isp",
811 ".jar", ".jse", ".lib", ".lnk", ".mde", ".msc", ".msp", ".mst", ".pif", ".scr", ".sct",
812 ".shb", ".sys", ".vb", ".vbe", ".vbs", ".vxd", ".wsc", ".wsf", ".wsh"
813};
814
Vishnu Naire97d6122018-01-18 13:58:56 -0800815status_t Dumpstate::AddZipEntryFromFd(const std::string& entry_name, int fd,
816 std::chrono::milliseconds timeout = 0ms) {
Felipe Leme24b66ee2016-06-16 10:55:26 -0700817 std::string valid_name = entry_name;
818
819 // Rename extension if necessary.
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -0700820 size_t idx = entry_name.rfind('.');
Felipe Leme24b66ee2016-06-16 10:55:26 -0700821 if (idx != std::string::npos) {
822 std::string extension = entry_name.substr(idx);
823 std::transform(extension.begin(), extension.end(), extension.begin(), ::tolower);
824 if (PROBLEMATIC_FILE_EXTENSIONS.count(extension) != 0) {
825 valid_name = entry_name + ".renamed";
826 MYLOGI("Renaming entry %s to %s\n", entry_name.c_str(), valid_name.c_str());
827 }
828 }
829
Felipe Leme6fe9db62016-02-12 09:04:16 -0800830 // Logging statement below is useful to time how long each entry takes, but it's too verbose.
831 // MYLOGD("Adding zip entry %s\n", entry_name.c_str());
Kevin Jeon9bbe0ac2022-05-05 22:05:43 +0000832 size_t flags = ZipWriter::kCompress | ZipWriter::kDefaultCompression;
833 int32_t err = zip_writer_->StartEntryWithTime(valid_name.c_str(), flags,
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700834 get_mtime(fd, ds.now_));
Felipe Leme1d486fe2016-10-14 18:06:47 -0700835 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700836 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", valid_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700837 ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800838 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800839 }
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000840 bool finished_entry = false;
841 auto finish_entry = [this, &finished_entry] {
842 if (!finished_entry) {
843 // This should only be called when we're going to return an earlier error,
844 // which would've been logged. This may imply the file is already corrupt
845 // and any further logging from FinishEntry is more likely to mislead than
846 // not.
847 this->zip_writer_->FinishEntry();
848 }
849 };
850 auto scope_guard = android::base::make_scope_guard(finish_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -0800851 auto start = std::chrono::steady_clock::now();
852 auto end = start + timeout;
853 struct pollfd pfd = {fd, POLLIN};
Felipe Lemee82a27d2016-01-05 13:35:44 -0800854
Felipe Leme770410d2016-01-26 17:07:14 -0800855 std::vector<uint8_t> buffer(65536);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800856 while (1) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800857 if (timeout.count() > 0) {
858 // lambda to recalculate the timeout.
859 auto time_left_ms = [end]() {
860 auto now = std::chrono::steady_clock::now();
861 auto diff = std::chrono::duration_cast<std::chrono::milliseconds>(end - now);
862 return std::max(diff.count(), 0LL);
863 };
864
865 int rc = TEMP_FAILURE_RETRY(poll(&pfd, 1, time_left_ms()));
866 if (rc < 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000867 MYLOGE("Error in poll while adding from fd to zip entry %s:%s\n",
868 entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800869 return -errno;
870 } else if (rc == 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000871 MYLOGE("Timed out adding from fd to zip entry %s:%s Timeout:%lldms\n",
Vishnu Naire97d6122018-01-18 13:58:56 -0800872 entry_name.c_str(), strerror(errno), timeout.count());
873 return TIMED_OUT;
874 }
875 }
876
Zach Riggle22200402016-08-18 01:01:24 -0400877 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800878 if (bytes_read == 0) {
879 break;
880 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800881 MYLOGE("read(%s): %s\n", entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800882 return -errno;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800883 }
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700884 err = zip_writer_->WriteBytes(buffer.data(), bytes_read);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800885 if (err) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700886 MYLOGE("zip_writer_->WriteBytes(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800887 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800888 }
889 }
890
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700891 err = zip_writer_->FinishEntry();
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000892 finished_entry = true;
Felipe Leme1d486fe2016-10-14 18:06:47 -0700893 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700894 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800895 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800896 }
897
Vishnu Naire97d6122018-01-18 13:58:56 -0800898 return OK;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800899}
900
Felipe Leme1d486fe2016-10-14 18:06:47 -0700901bool Dumpstate::AddZipEntry(const std::string& entry_name, const std::string& entry_path) {
902 android::base::unique_fd fd(
903 TEMP_FAILURE_RETRY(open(entry_path.c_str(), O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
Andreas Gampeaff68432016-07-18 18:01:27 -0700904 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800905 MYLOGE("open(%s): %s\n", entry_path.c_str(), strerror(errno));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800906 return false;
907 }
908
Vishnu Naire97d6122018-01-18 13:58:56 -0800909 return (AddZipEntryFromFd(entry_name, fd.get()) == OK);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800910}
911
912/* adds a file to the existing zipped bugreport */
Felipe Leme4c2d6632016-09-28 14:32:00 -0700913static int _add_file_from_fd(const char* title __attribute__((unused)), const char* path, int fd) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800914 return (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + path, fd) == OK) ? 0 : 1;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800915}
916
Felipe Leme1d486fe2016-10-14 18:06:47 -0700917void Dumpstate::AddDir(const std::string& dir, bool recursive) {
Felipe Leme678727a2016-09-21 17:22:11 -0700918 MYLOGD("Adding dir %s (recursive: %d)\n", dir.c_str(), recursive);
Felipe Leme46b85da2016-11-21 17:40:45 -0800919 DurationReporter duration_reporter(dir, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700920 dump_files("", dir.c_str(), recursive ? skip_none : is_dir, _add_file_from_fd);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800921}
922
Felipe Leme1d486fe2016-10-14 18:06:47 -0700923bool Dumpstate::AddTextZipEntry(const std::string& entry_name, const std::string& content) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800924 MYLOGD("Adding zip text entry %s\n", entry_name.c_str());
Kevin Jeon9bbe0ac2022-05-05 22:05:43 +0000925 size_t flags = ZipWriter::kCompress | ZipWriter::kDefaultCompression;
926 int32_t err = zip_writer_->StartEntryWithTime(entry_name.c_str(), flags, ds.now_);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700927 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700928 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700929 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800930 return false;
931 }
932
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700933 err = zip_writer_->WriteBytes(content.c_str(), content.length());
Felipe Leme1d486fe2016-10-14 18:06:47 -0700934 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700935 MYLOGE("zip_writer_->WriteBytes(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700936 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800937 return false;
938 }
939
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700940 err = zip_writer_->FinishEntry();
Felipe Leme1d486fe2016-10-14 18:06:47 -0700941 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700942 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800943 return false;
944 }
945
946 return true;
947}
948
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800949static void DoKmsg() {
950 struct stat st;
951 if (!stat(PSTORE_LAST_KMSG, &st)) {
952 /* Also TODO: Make console-ramoops CAP_SYSLOG protected. */
953 DumpFile("LAST KMSG", PSTORE_LAST_KMSG);
954 } else if (!stat(ALT_PSTORE_LAST_KMSG, &st)) {
955 DumpFile("LAST KMSG", ALT_PSTORE_LAST_KMSG);
956 } else {
957 /* TODO: Make last_kmsg CAP_SYSLOG protected. b/5555691 */
958 DumpFile("LAST KMSG", "/proc/last_kmsg");
959 }
960}
961
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800962static void DoKernelLogcat() {
Yao Chenbe3bbc12018-01-17 16:31:10 -0800963 unsigned long timeout_ms = logcat_timeout({"kernel"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800964 RunCommand(
965 "KERNEL LOG",
966 {"logcat", "-b", "kernel", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
967 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
968}
969
Nandana Duttdb379fa2019-10-09 16:54:41 +0100970static void DoSystemLogcat(time_t since) {
971 char since_str[80];
972 strftime(since_str, sizeof(since_str), "%Y-%m-%d %H:%M:%S.000", localtime(&since));
973
974 unsigned long timeout_ms = logcat_timeout({"main", "system", "crash"});
975 RunCommand("SYSTEM LOG",
976 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v", "-T",
977 since_str},
978 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
979}
980
Hunter Knepshield820f9bc2020-02-05 20:10:53 -0800981static void DoRadioLogcat() {
982 unsigned long timeout_ms = logcat_timeout({"radio"});
983 RunCommand(
984 "RADIO LOG",
985 {"logcat", "-b", "radio", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
986 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
987}
988
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800989static void DoLogcat() {
Vishnu Nair6921f802017-11-22 09:17:23 -0800990 unsigned long timeout_ms;
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800991 // DumpFile("EVENT LOG TAGS", "/etc/event-log-tags");
992 // calculate timeout
Yao Chenbe3bbc12018-01-17 16:31:10 -0800993 timeout_ms = logcat_timeout({"main", "system", "crash"});
Tony Makae737652017-03-30 17:47:09 +0100994 RunCommand("SYSTEM LOG",
Vishnu Nair6921f802017-11-22 09:17:23 -0800995 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
996 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -0800997 timeout_ms = logcat_timeout({"events"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800998 RunCommand(
999 "EVENT LOG",
1000 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001001 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Yao Chenbe3bbc12018-01-17 16:31:10 -08001002 timeout_ms = logcat_timeout({"stats"});
1003 RunCommand(
1004 "STATS LOG",
1005 {"logcat", "-b", "stats", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001006 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001007 DoRadioLogcat();
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001008
1009 RunCommand("LOG STATISTICS", {"logcat", "-b", "all", "-S"});
1010
1011 /* kernels must set CONFIG_PSTORE_PMSG, slice up pstore with device tree */
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001012 RunCommand("LAST LOGCAT", {"logcat", "-L", "-b", "all", "-v", "threadtime", "-v", "printable",
1013 "-v", "uid", "-d", "*:v"});
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001014}
1015
Mike Ma5c267872019-08-21 11:31:34 -07001016static void DumpIncidentReport() {
Mike Ma5c267872019-08-21 11:31:34 -07001017 const std::string path = ds.bugreport_internal_dir_ + "/tmp_incident_report";
1018 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1019 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1020 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1021 if (fd < 0) {
1022 MYLOGE("Could not open %s to dump incident report.\n", path.c_str());
1023 return;
1024 }
1025 RunCommandToFd(fd, "", {"incident", "-u"}, CommandOptions::WithTimeout(120).Build());
1026 bool empty = 0 == lseek(fd, 0, SEEK_END);
1027 if (!empty) {
1028 // Use a different name from "incident.proto"
1029 // /proto/incident.proto is reserved for incident service dump
1030 // i.e. metadata for debugging.
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001031 ds.EnqueueAddZipEntryAndCleanupIfNeeded(kProtoPath + "incident_report" + kProtoExt,
1032 path);
1033 } else {
1034 unlink(path.c_str());
Mike Ma5c267872019-08-21 11:31:34 -07001035 }
Mike Ma5c267872019-08-21 11:31:34 -07001036}
1037
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001038static void MaybeAddSystemTraceToZip() {
1039 // This function copies into the .zip the system trace that was snapshotted
1040 // by the early call to MaybeSnapshotSystemTrace(), if any background
1041 // tracing was happening.
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001042 if (!ds.has_system_trace_) {
1043 // No background trace was happening at the time dumpstate was invoked.
1044 return;
1045 }
1046 ds.AddZipEntry(
1047 ZIP_ROOT_DIR + SYSTEM_TRACE_SNAPSHOT,
1048 SYSTEM_TRACE_SNAPSHOT);
1049 android::os::UnlinkAndLogOnError(SYSTEM_TRACE_SNAPSHOT);
1050}
1051
Sunny Goyal35949782019-11-19 15:54:36 -08001052static void DumpVisibleWindowViews() {
Sunny Goyal35949782019-11-19 15:54:36 -08001053 DurationReporter duration_reporter("VISIBLE WINDOW VIEWS");
1054 const std::string path = ds.bugreport_internal_dir_ + "/tmp_visible_window_views";
1055 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1056 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1057 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1058 if (fd < 0) {
1059 MYLOGE("Could not open %s to dump visible views.\n", path.c_str());
1060 return;
1061 }
1062 RunCommandToFd(fd, "", {"cmd", "window", "dump-visible-window-views"},
1063 CommandOptions::WithTimeout(120).Build());
1064 bool empty = 0 == lseek(fd, 0, SEEK_END);
1065 if (!empty) {
1066 ds.AddZipEntry("visible_windows.zip", path);
1067 } else {
1068 MYLOGW("Failed to dump visible windows\n");
1069 }
1070 unlink(path.c_str());
1071}
1072
Jayachandran Ca94c7172017-06-10 15:08:12 -07001073static void DumpIpTablesAsRoot() {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001074 RunCommand("IPTABLES", {"iptables", "-L", "-nvx"});
1075 RunCommand("IP6TABLES", {"ip6tables", "-L", "-nvx"});
Erik Kline32af8c22016-09-28 17:26:26 +09001076 RunCommand("IPTABLES NAT", {"iptables", "-t", "nat", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001077 /* no ip6 nat */
Erik Kline32af8c22016-09-28 17:26:26 +09001078 RunCommand("IPTABLES MANGLE", {"iptables", "-t", "mangle", "-L", "-nvx"});
1079 RunCommand("IP6TABLES MANGLE", {"ip6tables", "-t", "mangle", "-L", "-nvx"});
1080 RunCommand("IPTABLES RAW", {"iptables", "-t", "raw", "-L", "-nvx"});
1081 RunCommand("IP6TABLES RAW", {"ip6tables", "-t", "raw", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001082}
1083
David Andersond9ba4752018-12-11 18:26:59 -08001084static void DumpDynamicPartitionInfo() {
1085 if (!::android::base::GetBoolProperty("ro.boot.dynamic_partitions", false)) {
1086 return;
1087 }
1088
1089 RunCommand("LPDUMP", {"lpdump", "--all"});
David Anderson6650ade2019-10-02 15:18:59 -07001090 RunCommand("DEVICE-MAPPER", {"gsid", "dump-device-mapper"});
David Andersond9ba4752018-12-11 18:26:59 -08001091}
1092
Chris Morin5a50d482022-02-01 17:41:18 -08001093static void AddAnrTraceDir(const std::string& anr_traces_dir) {
Narayan Kamath8f788292017-05-25 13:20:39 +01001094 MYLOGD("AddAnrTraceDir(): dump_traces_file=%s, anr_traces_dir=%s\n", dump_traces_path,
1095 anr_traces_dir.c_str());
1096
1097 // If we're here, dump_traces_path will always be a temporary file
1098 // (created with mkostemp or similar) that contains dumps taken earlier
1099 // on in the process.
1100 if (dump_traces_path != nullptr) {
Chris Morin5a50d482022-02-01 17:41:18 -08001101 MYLOGD("Dumping current ANR traces (%s) to the main bugreport entry\n",
1102 dump_traces_path);
1103 ds.DumpFile("VM TRACES JUST NOW", dump_traces_path);
Narayan Kamath8f788292017-05-25 13:20:39 +01001104
1105 const int ret = unlink(dump_traces_path);
1106 if (ret == -1) {
1107 MYLOGW("Error unlinking temporary trace path %s: %s\n", dump_traces_path,
1108 strerror(errno));
Felipe Lemee184f662016-10-27 10:04:47 -07001109 }
1110 }
1111
Narayan Kamathbd863722017-06-01 18:50:12 +01001112 // Add a specific message for the first ANR Dump.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001113 if (ds.anr_data_.size() > 0) {
Chris Morin5a50d482022-02-01 17:41:18 -08001114 // The "last" ANR will always be present in the body of the main entry.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001115 AddDumps(ds.anr_data_.begin(), ds.anr_data_.begin() + 1,
Chris Morin5a50d482022-02-01 17:41:18 -08001116 "VM TRACES AT LAST ANR", false /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001117
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001118 // Historical ANRs are always included as separate entries in the bugreport zip file.
Chris Morin5a50d482022-02-01 17:41:18 -08001119 AddDumps(ds.anr_data_.begin(), ds.anr_data_.end(),
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001120 "HISTORICAL ANR", true /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001121 } else {
Narayan Kamath8f788292017-05-25 13:20:39 +01001122 printf("*** NO ANRs to dump in %s\n\n", ANR_DIR.c_str());
1123 }
1124}
1125
1126static void AddAnrTraceFiles() {
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001127 std::string anr_traces_dir = "/data/anr";
Narayan Kamath8f788292017-05-25 13:20:39 +01001128
Chris Morin5a50d482022-02-01 17:41:18 -08001129 AddAnrTraceDir(anr_traces_dir);
Narayan Kamath8f788292017-05-25 13:20:39 +01001130
Makoto Onuki83ec63f2019-01-31 17:08:59 -08001131 RunCommand("ANR FILES", {"ls", "-lt", ANR_DIR});
1132
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001133 // Slow traces for slow operations.
Felipe Lemee184f662016-10-27 10:04:47 -07001134 struct stat st;
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001135 int i = 0;
1136 while (true) {
1137 const std::string slow_trace_path =
1138 anr_traces_dir + android::base::StringPrintf("slow%02d.txt", i);
1139 if (stat(slow_trace_path.c_str(), &st)) {
1140 // No traces file at this index, done with the files.
1141 break;
Felipe Lemee184f662016-10-27 10:04:47 -07001142 }
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001143 ds.DumpFile("VM TRACES WHEN SLOW", slow_trace_path.c_str());
1144 i++;
Felipe Lemee184f662016-10-27 10:04:47 -07001145 }
1146}
1147
Wei Wang509bb5d2017-06-09 14:42:12 -07001148static void DumpBlockStatFiles() {
1149 DurationReporter duration_reporter("DUMP BLOCK STAT");
Wei Wang509bb5d2017-06-09 14:42:12 -07001150
Wei Wang1dc1ef52017-06-12 11:28:37 -07001151 std::unique_ptr<DIR, std::function<int(DIR*)>> dirptr(opendir(BLK_DEV_SYS_DIR), closedir);
1152
1153 if (dirptr == nullptr) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001154 MYLOGE("Failed to open %s: %s\n", BLK_DEV_SYS_DIR, strerror(errno));
1155 return;
1156 }
1157
1158 printf("------ DUMP BLOCK STAT ------\n\n");
Wei Wang1dc1ef52017-06-12 11:28:37 -07001159 while (struct dirent *d = readdir(dirptr.get())) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001160 if ((d->d_name[0] == '.')
1161 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
1162 || (d->d_name[1] == '\0'))) {
1163 continue;
1164 }
1165 const std::string new_path =
1166 android::base::StringPrintf("%s/%s", BLK_DEV_SYS_DIR, d->d_name);
1167 printf("------ BLOCK STAT (%s) ------\n", new_path.c_str());
1168 dump_files("", new_path.c_str(), skip_not_stat, dump_stat_from_fd);
1169 printf("\n");
1170 }
Wei Wang1dc1ef52017-06-12 11:28:37 -07001171 return;
Wei Wang509bb5d2017-06-09 14:42:12 -07001172}
Jayachandran Ca94c7172017-06-10 15:08:12 -07001173
1174static void DumpPacketStats() {
1175 DumpFile("NETWORK DEV INFO", "/proc/net/dev");
Jayachandran Ca94c7172017-06-10 15:08:12 -07001176}
1177
1178static void DumpIpAddrAndRules() {
1179 /* The following have a tendency to get wedged when wifi drivers/fw goes belly-up. */
1180 RunCommand("NETWORK INTERFACES", {"ip", "link"});
1181 RunCommand("IPv4 ADDRESSES", {"ip", "-4", "addr", "show"});
1182 RunCommand("IPv6 ADDRESSES", {"ip", "-6", "addr", "show"});
1183 RunCommand("IP RULES", {"ip", "rule", "show"});
1184 RunCommand("IP RULES v6", {"ip", "-6", "rule", "show"});
1185}
1186
Nandana Dutt5c390032019-03-12 10:52:56 +00001187static Dumpstate::RunStatus RunDumpsysTextByPriority(const std::string& title, int priority,
1188 std::chrono::milliseconds timeout,
1189 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001190 auto start = std::chrono::steady_clock::now();
Vishnu Naire97d6122018-01-18 13:58:56 -08001191 sp<android::IServiceManager> sm = defaultServiceManager();
1192 Dumpsys dumpsys(sm.get());
Vishnu Naire97d6122018-01-18 13:58:56 -08001193 Vector<String16> args;
1194 Dumpsys::setServiceArgs(args, /* asProto = */ false, priority);
Vishnu Naire97d6122018-01-18 13:58:56 -08001195 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ false);
1196 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001197 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001198 std::string path(title);
1199 path.append(" - ").append(String8(service).c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -08001200 size_t bytes_written = 0;
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001201 if (PropertiesHelper::IsDryRun()) {
1202 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1203 dumpsys.writeDumpFooter(STDOUT_FILENO, service, std::chrono::milliseconds(1));
1204 } else {
1205 status_t status = dumpsys.startDumpThread(Dumpsys::TYPE_DUMP, service, args);
1206 if (status == OK) {
1207 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1208 std::chrono::duration<double> elapsed_seconds;
1209 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH &&
1210 service == String16("meminfo")) {
1211 // Use a longer timeout for meminfo, since 30s is not always enough.
1212 status = dumpsys.writeDump(STDOUT_FILENO, service, 60s,
1213 /* as_proto = */ false, elapsed_seconds,
1214 bytes_written);
1215 } else {
1216 status = dumpsys.writeDump(STDOUT_FILENO, service, service_timeout,
1217 /* as_proto = */ false, elapsed_seconds,
1218 bytes_written);
1219 }
1220 dumpsys.writeDumpFooter(STDOUT_FILENO, service, elapsed_seconds);
1221 bool dump_complete = (status == OK);
1222 dumpsys.stopDumpThread(dump_complete);
Gavin Corkeryfac7e2b2021-07-08 22:39:02 +01001223 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001224 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001225
1226 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1227 std::chrono::steady_clock::now() - start);
1228 if (elapsed_duration > timeout) {
1229 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1230 elapsed_duration.count());
1231 break;
1232 }
1233 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001234 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001235}
1236
Vishnu Nair64afc022018-02-01 15:29:34 -08001237static void RunDumpsysText(const std::string& title, int priority,
1238 std::chrono::milliseconds timeout,
1239 std::chrono::milliseconds service_timeout) {
1240 DurationReporter duration_reporter(title);
1241 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1242 fsync(STDOUT_FILENO);
1243 RunDumpsysTextByPriority(title, priority, timeout, service_timeout);
1244}
1245
1246/* Dump all services registered with Normal or Default priority. */
Nandana Dutt5c390032019-03-12 10:52:56 +00001247static Dumpstate::RunStatus RunDumpsysTextNormalPriority(const std::string& title,
1248 std::chrono::milliseconds timeout,
1249 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001250 DurationReporter duration_reporter(title);
1251 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1252 fsync(STDOUT_FILENO);
1253 RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_NORMAL, timeout,
1254 service_timeout);
Nandana Dutt5c390032019-03-12 10:52:56 +00001255
1256 RETURN_IF_USER_DENIED_CONSENT();
1257
1258 return RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_DEFAULT, timeout,
1259 service_timeout);
Vishnu Nair64afc022018-02-01 15:29:34 -08001260}
1261
Nandana Dutt5c390032019-03-12 10:52:56 +00001262static Dumpstate::RunStatus RunDumpsysProto(const std::string& title, int priority,
1263 std::chrono::milliseconds timeout,
1264 std::chrono::milliseconds service_timeout) {
Vishnu Naire97d6122018-01-18 13:58:56 -08001265 sp<android::IServiceManager> sm = defaultServiceManager();
1266 Dumpsys dumpsys(sm.get());
1267 Vector<String16> args;
1268 Dumpsys::setServiceArgs(args, /* asProto = */ true, priority);
1269 DurationReporter duration_reporter(title);
1270
1271 auto start = std::chrono::steady_clock::now();
1272 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ true);
1273 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001274 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001275 std::string path(kProtoPath);
1276 path.append(String8(service).c_str());
1277 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL) {
1278 path.append("_CRITICAL");
1279 } else if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH) {
1280 path.append("_HIGH");
1281 }
1282 path.append(kProtoExt);
Steven Morelandcbd69fc2021-07-20 20:45:43 +00001283 status_t status = dumpsys.startDumpThread(Dumpsys::TYPE_DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001284 if (status == OK) {
1285 status = ds.AddZipEntryFromFd(path, dumpsys.getDumpFd(), service_timeout);
1286 bool dumpTerminated = (status == OK);
1287 dumpsys.stopDumpThread(dumpTerminated);
1288 }
1289 ZipWriter::FileEntry file_entry;
1290 ds.zip_writer_->GetLastEntry(&file_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -08001291
1292 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1293 std::chrono::steady_clock::now() - start);
1294 if (elapsed_duration > timeout) {
1295 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1296 elapsed_duration.count());
1297 break;
1298 }
1299 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001300 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001301}
1302
Nandana Dutta7db6342018-11-21 14:53:34 +00001303// Runs dumpsys on services that must dump first and will take less than 100ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001304static Dumpstate::RunStatus RunDumpsysCritical() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001305 RunDumpsysText("DUMPSYS CRITICAL", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1306 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Nandana Dutt5c390032019-03-12 10:52:56 +00001307
1308 RETURN_IF_USER_DENIED_CONSENT();
1309
1310 return RunDumpsysProto("DUMPSYS CRITICAL PROTO", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1311 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Vishnu Nair780b1282017-10-10 13:57:24 -07001312}
1313
1314// Runs dumpsys on services that must dump first but can take up to 250ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001315static Dumpstate::RunStatus RunDumpsysHigh() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001316 // TODO meminfo takes ~10s, connectivity takes ~5sec to dump. They are both
1317 // high priority. Reduce timeout once they are able to dump in a shorter time or
1318 // moved to a parallel task.
1319 RunDumpsysText("DUMPSYS HIGH", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1320 /* timeout= */ 90s, /* service_timeout= */ 30s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001321
1322 RETURN_IF_USER_DENIED_CONSENT();
1323
1324 return RunDumpsysProto("DUMPSYS HIGH PROTO", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1325 /* timeout= */ 5s, /* service_timeout= */ 1s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001326}
1327
1328// Runs dumpsys on services that must dump but can take up to 10s to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001329static Dumpstate::RunStatus RunDumpsysNormal() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001330 RunDumpsysTextNormalPriority("DUMPSYS", /* timeout= */ 90s, /* service_timeout= */ 10s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001331
1332 RETURN_IF_USER_DENIED_CONSENT();
1333
1334 return RunDumpsysProto("DUMPSYS PROTO", IServiceManager::DUMP_FLAG_PRIORITY_NORMAL,
1335 /* timeout= */ 90s, /* service_timeout= */ 10s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001336}
1337
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001338/*
1339 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1340 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1341 * if it's not running in the parallel task.
1342 */
1343static void DumpHals(int out_fd = STDOUT_FILENO) {
Yifan Hong30528a22020-08-07 18:24:06 -07001344 RunCommand("HARDWARE HALS", {"lshal", "--all", "--types=all"},
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001345 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build(),
1346 false, out_fd);
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001347
Steven Moreland44cd9482018-01-04 16:24:13 -08001348 using android::hidl::manager::V1_0::IServiceManager;
1349 using android::hardware::defaultServiceManager;
1350
1351 sp<IServiceManager> sm = defaultServiceManager();
1352 if (sm == nullptr) {
1353 MYLOGE("Could not retrieve hwservicemanager to dump hals.\n");
1354 return;
1355 }
1356
1357 auto ret = sm->list([&](const auto& interfaces) {
1358 for (const std::string& interface : interfaces) {
1359 std::string cleanName = interface;
1360 std::replace_if(cleanName.begin(),
1361 cleanName.end(),
1362 [](char c) {
1363 return !isalnum(c) &&
1364 std::string("@-_:.").find(c) == std::string::npos;
1365 }, '_');
Nandana Dutt979388e2018-11-30 16:48:55 +00001366 const std::string path = ds.bugreport_internal_dir_ + "/lshal_debug_" + cleanName;
Steven Moreland44cd9482018-01-04 16:24:13 -08001367
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001368 bool empty = false;
Steven Moreland44cd9482018-01-04 16:24:13 -08001369 {
1370 auto fd = android::base::unique_fd(
1371 TEMP_FAILURE_RETRY(open(path.c_str(),
1372 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1373 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1374 if (fd < 0) {
1375 MYLOGE("Could not open %s to dump additional hal information.\n", path.c_str());
1376 continue;
1377 }
1378 RunCommandToFd(fd,
1379 "",
Steven Morelandc81cd3c2018-01-18 14:36:26 -08001380 {"lshal", "debug", "-E", interface},
Steven Moreland44cd9482018-01-04 16:24:13 -08001381 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
1382
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001383 empty = 0 == lseek(fd, 0, SEEK_END);
Steven Moreland44cd9482018-01-04 16:24:13 -08001384 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001385 if (!empty) {
1386 ds.EnqueueAddZipEntryAndCleanupIfNeeded("lshal-debug/" + cleanName + ".txt",
1387 path);
1388 } else {
1389 unlink(path.c_str());
1390 }
Steven Moreland44cd9482018-01-04 16:24:13 -08001391 }
1392 });
1393
1394 if (!ret.isOk()) {
1395 MYLOGE("Could not list hals from hwservicemanager.\n");
1396 }
1397}
1398
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001399static void DumpExternalFragmentationInfo() {
1400 struct stat st;
1401 if (stat("/proc/buddyinfo", &st) != 0) {
1402 MYLOGE("Unable to dump external fragmentation info\n");
1403 return;
1404 }
1405
1406 printf("------ EXTERNAL FRAGMENTATION INFO ------\n");
1407 std::ifstream ifs("/proc/buddyinfo");
1408 auto unusable_index_regex = std::regex{"Node\\s+([0-9]+),\\s+zone\\s+(\\S+)\\s+(.*)"};
1409 for (std::string line; std::getline(ifs, line);) {
1410 std::smatch match_results;
1411 if (std::regex_match(line, match_results, unusable_index_regex)) {
1412 std::stringstream free_pages(std::string{match_results[3]});
1413 std::vector<int> free_pages_per_order(std::istream_iterator<int>{free_pages},
1414 std::istream_iterator<int>());
1415
1416 int total_free_pages = 0;
1417 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1418 total_free_pages += (free_pages_per_order[i] * std::pow(2, i));
1419 }
1420
1421 printf("Node %s, zone %8s", match_results[1].str().c_str(),
1422 match_results[2].str().c_str());
1423
1424 int usable_free_pages = total_free_pages;
1425 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1426 auto unusable_index = (total_free_pages - usable_free_pages) /
1427 static_cast<double>(total_free_pages);
1428 printf(" %5.3f", unusable_index);
1429 usable_free_pages -= (free_pages_per_order[i] * std::pow(2, i));
1430 }
1431
1432 printf("\n");
1433 }
1434 }
1435 printf("\n");
1436}
1437
mhasankd451a472020-05-26 18:02:39 -07001438static void DumpstateLimitedOnly() {
1439 // Trimmed-down version of dumpstate to only include a whitelisted
1440 // set of logs (system log, event log, and system server / system app
1441 // crashes, and networking logs). See b/136273873 and b/138459828
1442 // for context.
1443 DurationReporter duration_reporter("DUMPSTATE");
1444 unsigned long timeout_ms;
1445 // calculate timeout
1446 timeout_ms = logcat_timeout({"main", "system", "crash"});
1447 RunCommand("SYSTEM LOG",
1448 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1449 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1450 timeout_ms = logcat_timeout({"events"});
1451 RunCommand(
1452 "EVENT LOG",
1453 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1454 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1455
1456 printf("========================================================\n");
1457 printf("== Networking Service\n");
1458 printf("========================================================\n");
1459
1460 RunDumpsys("DUMPSYS NETWORK_SERVICE_LIMITED", {"wifi", "-a"},
1461 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hugo Benichiaa162682020-10-30 23:28:56 +09001462 RunDumpsys("DUMPSYS CONNECTIVITY REQUESTS", {"connectivity", "requests"},
1463 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
mhasankd451a472020-05-26 18:02:39 -07001464
1465 printf("========================================================\n");
1466 printf("== Dropbox crashes\n");
1467 printf("========================================================\n");
1468
1469 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1470 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1471
1472 printf("========================================================\n");
1473 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1474 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1475 printf("========================================================\n");
1476 printf("== dumpstate: done (id %d)\n", ds.id_);
1477 printf("========================================================\n");
1478}
1479
Rhed Jaoe017f982020-07-21 17:58:41 +08001480/*
1481 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1482 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1483 * if it's not running in the parallel task.
1484 */
1485static void DumpCheckins(int out_fd = STDOUT_FILENO) {
1486 dprintf(out_fd, "========================================================\n");
1487 dprintf(out_fd, "== Checkins\n");
1488 dprintf(out_fd, "========================================================\n");
1489
1490 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"}, out_fd);
1491 RunDumpsys("CHECKIN MEMINFO", {"meminfo", "--checkin"}, out_fd);
1492 RunDumpsys("CHECKIN NETSTATS", {"netstats", "--checkin"}, out_fd);
1493 RunDumpsys("CHECKIN PROCSTATS", {"procstats", "-c"}, out_fd);
1494 RunDumpsys("CHECKIN USAGESTATS", {"usagestats", "-c"}, out_fd);
1495 RunDumpsys("CHECKIN PACKAGE", {"package", "--checkin"}, out_fd);
1496}
1497
1498/*
1499 * Runs dumpsys on activity service to dump all application activities, services
1500 * and providers in the device.
1501 *
1502 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1503 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1504 * if it's not running in the parallel task.
1505 */
1506static void DumpAppInfos(int out_fd = STDOUT_FILENO) {
1507 dprintf(out_fd, "========================================================\n");
1508 dprintf(out_fd, "== Running Application Activities\n");
1509 dprintf(out_fd, "========================================================\n");
1510
1511 // The following dumpsys internally collects output from running apps, so it can take a long
1512 // time. So let's extend the timeout.
1513
1514 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
1515
1516 RunDumpsys("APP ACTIVITIES", {"activity", "-v", "all"}, DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1517
1518 dprintf(out_fd, "========================================================\n");
1519 dprintf(out_fd, "== Running Application Services (platform)\n");
1520 dprintf(out_fd, "========================================================\n");
1521
1522 RunDumpsys("APP SERVICES PLATFORM", {"activity", "service", "all-platform-non-critical"},
1523 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1524
1525 dprintf(out_fd, "========================================================\n");
1526 dprintf(out_fd, "== Running Application Services (non-platform)\n");
1527 dprintf(out_fd, "========================================================\n");
1528
1529 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1530 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1531
1532 dprintf(out_fd, "========================================================\n");
1533 dprintf(out_fd, "== Running Application Providers (platform)\n");
1534 dprintf(out_fd, "========================================================\n");
1535
1536 RunDumpsys("APP PROVIDERS PLATFORM", {"activity", "provider", "all-platform"},
Rhed Jaob049f182021-01-11 21:08:43 +08001537 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
Rhed Jaoe017f982020-07-21 17:58:41 +08001538
1539 dprintf(out_fd, "========================================================\n");
1540 dprintf(out_fd, "== Running Application Providers (non-platform)\n");
1541 dprintf(out_fd, "========================================================\n");
1542
1543 RunDumpsys("APP PROVIDERS NON-PLATFORM", {"activity", "provider", "all-non-platform"},
1544 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1545}
1546
Nandana Dutt5c390032019-03-12 10:52:56 +00001547// Dumps various things. Returns early with status USER_CONSENT_DENIED if user denies consent
1548// via the consent they are shown. Ignores other errors that occur while running various
1549// commands. The consent checking is currently done around long running tasks, which happen to
1550// be distributed fairly evenly throughout the function.
1551static Dumpstate::RunStatus dumpstate() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001552 DurationReporter duration_reporter("DUMPSTATE");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001553
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001554 // Enqueue slow functions into the thread pool, if the parallel run is enabled.
Chris Morinbc223142022-02-04 14:17:11 -08001555 std::future<std::string> dump_hals, dump_incident_report, dump_board, dump_checkins;
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001556 if (ds.dump_pool_) {
1557 // Pool was shutdown in DumpstateDefaultAfterCritical method in order to
1558 // drop root user. Restarts it with two threads for the parallel run.
1559 ds.dump_pool_->start(/* thread_counts = */2);
1560
Chris Morinbc223142022-02-04 14:17:11 -08001561 dump_hals = ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
1562 dump_incident_report = ds.dump_pool_->enqueueTask(
1563 DUMP_INCIDENT_REPORT_TASK, &DumpIncidentReport);
1564 dump_board = ds.dump_pool_->enqueueTaskWithFd(
1565 DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
1566 dump_checkins = ds.dump_pool_->enqueueTaskWithFd(DUMP_CHECKINS_TASK, &DumpCheckins, _1);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001567 }
1568
Nandana Dutt5c390032019-03-12 10:52:56 +00001569 // Dump various things. Note that anything that takes "long" (i.e. several seconds) should
1570 // check intermittently (if it's intrerruptable like a foreach on pids) and/or should be wrapped
1571 // in a consent check (via RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK).
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -07001572 dump_dev_files("TRUSTY VERSION", "/sys/bus/platform/drivers/trusty", "trusty_version");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001573 RunCommand("UPTIME", {"uptime"});
Wei Wang509bb5d2017-06-09 14:42:12 -07001574 DumpBlockStatFiles();
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001575 DumpFile("MEMORY INFO", "/proc/meminfo");
1576 RunCommand("CPU INFO", {"top", "-b", "-n", "1", "-H", "-s", "6", "-o",
Felipe Leme30dbfa12016-09-02 12:43:26 -07001577 "pid,tid,user,pr,ni,%cpu,s,virt,res,pcy,cmd,name"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001578
1579 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "PROCRANK", {"procrank"}, AS_ROOT_20);
1580
Sunny Goyal35949782019-11-19 15:54:36 -08001581 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpVisibleWindowViews);
1582
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001583 DumpFile("VIRTUAL MEMORY STATS", "/proc/vmstat");
1584 DumpFile("VMALLOC INFO", "/proc/vmallocinfo");
1585 DumpFile("SLAB INFO", "/proc/slabinfo");
1586 DumpFile("ZONEINFO", "/proc/zoneinfo");
1587 DumpFile("PAGETYPEINFO", "/proc/pagetypeinfo");
1588 DumpFile("BUDDYINFO", "/proc/buddyinfo");
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001589 DumpExternalFragmentationInfo();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001590
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001591 DumpFile("KERNEL CPUFREQ", "/sys/devices/system/cpu/cpu0/cpufreq/stats/time_in_state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001592
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001593 RunCommand("PROCESSES AND THREADS",
Yohei Yukawa591a72d2017-10-05 21:36:35 -07001594 {"ps", "-A", "-T", "-Z", "-O", "pri,nice,rtprio,sched,pcy,time"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001595
1596 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "LIBRANK", {"librank"},
1597 CommandOptions::AS_ROOT);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001598
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001599 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001600 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_hals));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001601 } else {
1602 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_HALS_TASK, DumpHals);
1603 }
Steven Moreland81b429e2017-01-31 19:50:46 -08001604
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001605 RunCommand("PRINTENV", {"printenv"});
Elliott Hughes21b7c8d2016-10-28 08:53:02 -07001606 RunCommand("NETSTAT", {"netstat", "-nW"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001607 struct stat s;
1608 if (stat("/proc/modules", &s) != 0) {
1609 MYLOGD("Skipping 'lsmod' because /proc/modules does not exist\n");
1610 } else {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001611 RunCommand("LSMOD", {"lsmod"});
Woody Linc198f252021-05-04 16:37:11 +08001612 RunCommand("MODULES INFO",
1613 {"sh", "-c", "cat /proc/modules | cut -d' ' -f1 | "
1614 " while read MOD ; do echo modinfo:$MOD ; modinfo $MOD ; "
1615 "done"}, CommandOptions::AS_ROOT);
Felipe Lemee4eca582016-06-10 17:48:08 -07001616 }
Michal Karpinski4db754f2015-12-11 18:04:32 +00001617
Tom Cherryb87dbfa2020-07-28 11:28:53 -07001618 if (android::base::GetBoolProperty("ro.logd.kernel", false)) {
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001619 DoKernelLogcat();
1620 } else {
1621 do_dmesg();
1622 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001623
Felipe Lemef0292972016-11-22 13:57:05 -08001624 RunCommand("LIST OF OPEN FILES", {"lsof"}, CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001625
1626 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(for_each_pid, do_showmap, "SMAPS OF ALL PROCESSES");
1627
Jeff Brown1dc94e32014-09-11 14:15:27 -07001628 for_each_tid(show_wchan, "BLOCKED PROCESS WAIT-CHANNELS");
Mark Salyzyna297c322016-02-05 15:33:17 -08001629 for_each_pid(show_showtime, "PROCESS TIMES (pid cmd user system iowait+percentage)");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001630
Jack Yu5a6b2e22020-08-14 18:13:35 +08001631 /* Dump Nfc NCI logs */
1632 ds.AddDir("/data/misc/nfc/logs", true);
Ajay Panickerd886ec42016-09-14 12:26:46 -07001633
Paul Chang0d2aad72020-02-13 20:04:03 +08001634 if (ds.options_->do_screenshot && !ds.do_early_screenshot_) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001635 MYLOGI("taking late screenshot\n");
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001636 ds.TakeScreenshot();
Jeff Sharkey5a930032013-03-19 15:05:19 -07001637 }
1638
Felipe Lemee184f662016-10-27 10:04:47 -07001639 AddAnrTraceFiles();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001640
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001641 MaybeAddSystemTraceToZip();
1642
Narayan Kamath8f788292017-05-25 13:20:39 +01001643 // NOTE: tombstones are always added as separate entries in the zip archive
1644 // and are not interspersed with the main report.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001645 const bool tombstones_dumped = AddDumps(ds.tombstone_data_.begin(), ds.tombstone_data_.end(),
Narayan Kamathbd863722017-06-01 18:50:12 +01001646 "TOMBSTONE", true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001647 if (!tombstones_dumped) {
1648 printf("*** NO TOMBSTONES to dump in %s\n\n", TOMBSTONE_DIR.c_str());
Christopher Ferris7dc7f322014-07-22 16:08:19 -07001649 }
1650
Jayachandran Ca94c7172017-06-10 15:08:12 -07001651 DumpPacketStats();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001652
Chenbo Feng276a3b62018-08-07 11:44:49 -07001653 RunDumpsys("EBPF MAP STATS", {"netd", "trafficcontroller"});
1654
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001655 DoKmsg();
Mark Salyzyn2262c162014-12-16 09:09:26 -08001656
Jayachandran Ca94c7172017-06-10 15:08:12 -07001657 DumpIpAddrAndRules();
Sreeram Ramachandran2b3bba32014-07-08 15:40:55 -07001658
1659 dump_route_tables();
1660
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001661 RunCommand("ARP CACHE", {"ip", "-4", "neigh", "show"});
1662 RunCommand("IPv6 ND CACHE", {"ip", "-6", "neigh", "show"});
1663 RunCommand("MULTICAST ADDRESSES", {"ip", "maddr"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001664
Nandana Dutt5c390032019-03-12 10:52:56 +00001665 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysHigh);
Lorenzo Colitti6afc38c2015-09-09 22:59:25 +09001666
Chiachang Wang668ede42021-05-17 17:14:20 +08001667 // The dump mechanism in connectivity is refactored due to modularization work. Connectivity can
1668 // only register with a default priority(NORMAL priority). Dumpstate has to call connectivity
1669 // dump with priority parameters to dump high priority information.
1670 RunDumpsys("SERVICE HIGH connectivity", {"connectivity", "--dump-priority", "HIGH"},
1671 CommandOptions::WithTimeout(10).Build());
1672
Elliott Hughes23ccc622017-02-28 10:14:22 -08001673 RunCommand("SYSTEM PROPERTIES", {"getprop"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001674
Jin Qianf334d662017-10-10 14:41:37 -07001675 RunCommand("STORAGED IO INFO", {"storaged", "-u", "-p"});
ynwangf649a6e2016-07-17 21:56:00 -07001676
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001677 RunCommand("FILESYSTEMS & FREE SPACE", {"df"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001678
Colin Crossf45fa6b2012-03-26 12:38:26 -07001679 /* Binder state is expensive to look at as it uses a lot of memory. */
Hridya Valsaraju920ba712020-02-09 16:27:01 -08001680 std::string binder_logs_dir = access("/dev/binderfs/binder_logs", R_OK) ?
1681 "/sys/kernel/debug/binder" : "/dev/binderfs/binder_logs";
1682
1683 DumpFile("BINDER FAILED TRANSACTION LOG", binder_logs_dir + "/failed_transaction_log");
1684 DumpFile("BINDER TRANSACTION LOG", binder_logs_dir + "/transaction_log");
1685 DumpFile("BINDER TRANSACTIONS", binder_logs_dir + "/transactions");
1686 DumpFile("BINDER STATS", binder_logs_dir + "/stats");
1687 DumpFile("BINDER STATE", binder_logs_dir + "/state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001688
Vishnu Nair36b4cdb2017-11-17 10:27:05 -08001689 /* Add window and surface trace files. */
1690 if (!PropertiesHelper::IsUserBuild()) {
1691 ds.AddDir(WMTRACE_DATA_DIR, false);
1692 }
1693
Yifan Hongd90cc652020-02-08 16:52:02 -08001694 ds.AddDir(SNAPSHOTCTL_LOG_DIR, false);
1695
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001696 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001697 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_board));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001698 } else {
1699 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
1700 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001701
Steven Moreland7440ddb2016-12-15 16:13:39 -08001702 /* Migrate the ril_dumpstate to a device specific dumpstate? */
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001703 int rilDumpstateTimeout = android::base::GetIntProperty("ril.dumpstate.timeout", 0);
1704 if (rilDumpstateTimeout > 0) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001705 // su does not exist on user builds, so try running without it.
1706 // This way any implementations of vril-dump that do not require
1707 // root can run on user builds.
1708 CommandOptions::CommandOptionsBuilder options =
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001709 CommandOptions::WithTimeout(rilDumpstateTimeout);
Felipe Lemef0292972016-11-22 13:57:05 -08001710 if (!PropertiesHelper::IsUserBuild()) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001711 options.AsRoot();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001712 }
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001713 RunCommand("DUMP VENDOR RIL LOGS", {"vril-dump"}, options.Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -07001714 }
1715
Felipe Lemed8b94e52016-12-08 10:21:44 -08001716 printf("========================================================\n");
1717 printf("== Android Framework Services\n");
1718 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001719
Nandana Dutt5c390032019-03-12 10:52:56 +00001720 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysNormal);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001721
Jack He91ff2fe2021-02-18 18:23:43 -08001722 /* Dump Bluetooth HCI logs after getting bluetooth_manager dumpsys */
1723 ds.AddDir("/data/misc/bluetooth/logs", true);
1724
Rhed Jaoe017f982020-07-21 17:58:41 +08001725 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001726 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_checkins));
Rhed Jaoe017f982020-07-21 17:58:41 +08001727 } else {
1728 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_CHECKINS_TASK, DumpCheckins);
1729 }
Dianne Hackborn02bea972013-06-26 18:59:09 -07001730
Rhed Jaoc5f7ec32020-12-22 22:11:08 +08001731 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpAppInfos);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001732
Adrian Roos8b397ab2017-04-04 16:35:44 -07001733 printf("========================================================\n");
1734 printf("== Dropbox crashes\n");
1735 printf("========================================================\n");
1736
1737 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1738 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1739
Felipe Lemed8b94e52016-12-08 10:21:44 -08001740 printf("========================================================\n");
1741 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1742 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1743 printf("========================================================\n");
1744 printf("== dumpstate: done (id %d)\n", ds.id_);
1745 printf("========================================================\n");
Bookatz38472142018-09-28 10:20:24 -07001746
1747 printf("========================================================\n");
1748 printf("== Obtaining statsd metadata\n");
1749 printf("========================================================\n");
1750 // This differs from the usual dumpsys stats, which is the stats report data.
1751 RunDumpsys("STATSDSTATS", {"stats", "--metadata"});
Mike Ma5c267872019-08-21 11:31:34 -07001752
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +09001753 // Add linker configuration directory
1754 ds.AddDir(LINKERCONFIG_DIR, true);
1755
Li Li830179f2022-01-04 12:53:29 -08001756 /* Dump frozen cgroupfs */
1757 dump_frozen_cgroupfs();
Li Li2eedd412021-06-30 15:11:53 -07001758
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001759 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001760 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_incident_report));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001761 } else {
1762 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_INCIDENT_REPORT_TASK,
1763 DumpIncidentReport);
1764 }
Mike Ma5c267872019-08-21 11:31:34 -07001765
Nandana Dutt5c390032019-03-12 10:52:56 +00001766 return Dumpstate::RunStatus::OK;
Colin Crossf45fa6b2012-03-26 12:38:26 -07001767}
1768
Nandana Dutt5c390032019-03-12 10:52:56 +00001769/*
1770 * Dumps state for the default case; drops root after it's no longer necessary.
1771 *
1772 * Returns RunStatus::OK if everything went fine.
1773 * Returns RunStatus::ERROR if there was an error.
1774 * Returns RunStatus::USER_DENIED_CONSENT if user explicitly denied consent to sharing the bugreport
1775 * with the caller.
1776 */
Jichao Lie89d9c12019-11-21 19:02:51 -08001777Dumpstate::RunStatus Dumpstate::DumpstateDefaultAfterCritical() {
Nandana Duttdb379fa2019-10-09 16:54:41 +01001778 // Capture first logcat early on; useful to take a snapshot before dumpstate logs take over the
1779 // buffer.
1780 DoLogcat();
1781 // Capture timestamp after first logcat to use in next logcat
1782 time_t logcat_ts = time(nullptr);
1783
Nandana Dutt4be45d12018-09-26 15:04:23 +01001784 /* collect stack traces from Dalvik and native processes (needs root) */
Chris Morinbc223142022-02-04 14:17:11 -08001785 std::future<std::string> dump_traces;
Rhed Jao5377d792020-07-16 17:37:39 +08001786 if (dump_pool_) {
1787 RETURN_IF_USER_DENIED_CONSENT();
1788 // One thread is enough since we only need to enqueue DumpTraces here.
1789 dump_pool_->start(/* thread_counts = */1);
1790
1791 // DumpTraces takes long time, post it to the another thread in the
1792 // pool, if pool is available
Chris Morinbc223142022-02-04 14:17:11 -08001793 dump_traces = dump_pool_->enqueueTask(
1794 DUMP_TRACES_TASK, &Dumpstate::DumpTraces, &ds, &dump_traces_path);
Rhed Jao5377d792020-07-16 17:37:39 +08001795 } else {
1796 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_TRACES_TASK, ds.DumpTraces,
1797 &dump_traces_path);
1798 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001799
1800 /* Run some operations that require root. */
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001801 if (!PropertiesHelper::IsDryRun()) {
Chris Morinc2cba7a2022-02-01 17:06:50 -08001802 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX);
1803 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX);
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001804 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001805
1806 ds.AddDir(RECOVERY_DIR, true);
1807 ds.AddDir(RECOVERY_DATA_DIR, true);
1808 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
1809 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1810 if (!PropertiesHelper::IsUserBuild()) {
1811 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1812 ds.AddDir(PROFILE_DATA_DIR_REF, true);
Calin Juravlef84d3692020-04-28 15:31:12 -07001813 ds.AddZipEntry(ZIP_ROOT_DIR + PACKAGE_DEX_USE_LIST, PACKAGE_DEX_USE_LIST);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001814 }
Jerry Changa1df8a92020-01-02 16:03:39 +08001815 ds.AddDir(PREREBOOT_DATA_DIR, false);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001816 add_mountinfo();
1817 DumpIpTablesAsRoot();
David Andersond9ba4752018-12-11 18:26:59 -08001818 DumpDynamicPartitionInfo();
Yifan Hong3945e1b2019-10-29 12:59:23 -07001819 ds.AddDir(OTA_METADATA_DIR, true);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001820
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001821 // Capture any IPSec policies in play. No keys are exposed here.
Nandana Dutt4be45d12018-09-26 15:04:23 +01001822 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1823
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001824 // Dump IPsec stats. No keys are exposed here.
1825 DumpFile("XFRM STATS", XFRM_STAT_PROC_FILE);
1826
Nandana Dutt4be45d12018-09-26 15:04:23 +01001827 // Run ss as root so we can see socket marks.
1828 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
1829
1830 // Run iotop as root to show top 100 IO threads
1831 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
1832
Erick Reyese68df822019-02-11 14:46:36 -08001833 // Gather shared memory buffer info if the product implements it
Hridya Valsaraju1da80c52021-01-09 22:10:11 -08001834 RunCommand("Dmabuf dump", {"dmabuf_dump"});
1835 RunCommand("Dmabuf per-buffer/per-exporter/per-device stats", {"dmabuf_dump", "-b"});
Erick Reyese68df822019-02-11 14:46:36 -08001836
Minchan Kim22c6a1e2019-09-30 15:58:10 -07001837 DumpFile("PSI cpu", "/proc/pressure/cpu");
1838 DumpFile("PSI memory", "/proc/pressure/memory");
1839 DumpFile("PSI io", "/proc/pressure/io");
1840
Rhed Jao5377d792020-07-16 17:37:39 +08001841 if (dump_pool_) {
1842 RETURN_IF_USER_DENIED_CONSENT();
Chris Morinbc223142022-02-04 14:17:11 -08001843 WaitForTask(std::move(dump_traces));
Rhed Jao5377d792020-07-16 17:37:39 +08001844
Chris Morinbc223142022-02-04 14:17:11 -08001845 // Current running thread in the pool is the root user also. Delete
1846 // the pool and make a new one later to ensure none of threads in the pool are root.
1847 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao5377d792020-07-16 17:37:39 +08001848 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001849 if (!DropRootUser()) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001850 return Dumpstate::RunStatus::ERROR;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001851 }
1852
Nandana Dutt5c390032019-03-12 10:52:56 +00001853 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttdb379fa2019-10-09 16:54:41 +01001854 Dumpstate::RunStatus status = dumpstate();
1855 // Capture logcat since the last time we did it.
1856 DoSystemLogcat(logcat_ts);
1857 return status;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001858}
1859
Rhed Jaob5685b32020-08-14 17:19:17 +08001860// Common states for telephony and wifi which are needed to be collected before
1861// dumpstate drop the root user.
1862static void DumpstateRadioAsRoot() {
1863 DumpIpTablesAsRoot();
1864 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1865}
1866
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001867// This method collects common dumpsys for telephony and wifi. Typically, wifi
1868// reports are fine to include all information, but telephony reports on user
1869// builds need to strip some content (see DumpstateTelephonyOnly).
1870static void DumpstateRadioCommon(bool include_sensitive_info = true) {
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001871 // We need to be picky about some stuff for telephony reports on user builds.
1872 if (!include_sensitive_info) {
1873 // Only dump the radio log buffer (other buffers and dumps contain too much unrelated info).
1874 DoRadioLogcat();
1875 } else {
Rhed Jaob5685b32020-08-14 17:19:17 +08001876 // DumpHals takes long time, post it to the another thread in the pool,
1877 // if pool is available.
Chris Morinbc223142022-02-04 14:17:11 -08001878 std::future<std::string> dump_hals;
Rhed Jaob5685b32020-08-14 17:19:17 +08001879 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001880 dump_hals = ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
Rhed Jaob5685b32020-08-14 17:19:17 +08001881 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001882 // Contains various system properties and process startup info.
1883 do_dmesg();
1884 // Logs other than the radio buffer may contain package/component names and potential PII.
1885 DoLogcat();
1886 // Too broad for connectivity problems.
1887 DoKmsg();
Rhed Jaob5685b32020-08-14 17:19:17 +08001888 // DumpHals contains unrelated hardware info (camera, NFC, biometrics, ...).
1889 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001890 WaitForTask(std::move(dump_hals));
Rhed Jaob5685b32020-08-14 17:19:17 +08001891 } else {
1892 RUN_SLOW_FUNCTION_AND_LOG(DUMP_HALS_TASK, DumpHals);
1893 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001894 }
1895
Jayachandran Ca94c7172017-06-10 15:08:12 -07001896 DumpPacketStats();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001897 DumpIpAddrAndRules();
1898 dump_route_tables();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001899 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
1900 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08001901}
1902
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001903// We use "telephony" here for legacy reasons, though this now really means "connectivity" (cellular
1904// + wifi + networking). This method collects dumpsys for connectivity debugging only. General rules
1905// for what can be included on user builds: all reported information MUST directly relate to
1906// connectivity debugging or customer support and MUST NOT contain unrelated personally identifiable
1907// information. This information MUST NOT identify user-installed packages (UIDs are OK, package
1908// names are not), and MUST NOT contain logs of user application traffic.
1909// TODO(b/148168577) rename this and other related fields/methods to "connectivity" instead.
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08001910static void DumpstateTelephonyOnly(const std::string& calling_package) {
mukesh agrawal253dad42018-01-23 21:59:59 -08001911 DurationReporter duration_reporter("DUMPSTATE");
Jichao Lie89d9c12019-11-21 19:02:51 -08001912
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001913 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08001914
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001915 const bool include_sensitive_info = !PropertiesHelper::IsUserBuild();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001916
Rhed Jaob5685b32020-08-14 17:19:17 +08001917 DumpstateRadioAsRoot();
1918 if (!DropRootUser()) {
1919 return;
1920 }
1921
1922 // Starts thread pool after the root user is dropped, and two additional threads
1923 // are created for DumpHals in the DumpstateRadioCommon and DumpstateBoard.
Chris Morinbc223142022-02-04 14:17:11 -08001924 std::future<std::string> dump_board;
Rhed Jaob5685b32020-08-14 17:19:17 +08001925 if (ds.dump_pool_) {
1926 ds.dump_pool_->start(/*thread_counts =*/2);
1927
1928 // DumpstateBoard takes long time, post it to the another thread in the pool,
1929 // if pool is available.
Chris Morinbc223142022-02-04 14:17:11 -08001930 dump_board = ds.dump_pool_->enqueueTaskWithFd(
1931 DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
Rhed Jaob5685b32020-08-14 17:19:17 +08001932 }
1933
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001934 DumpstateRadioCommon(include_sensitive_info);
1935
1936 if (include_sensitive_info) {
1937 // Contains too much unrelated PII, and given the unstructured nature of sysprops, we can't
1938 // really cherrypick all of the connectivity-related ones. Apps generally have no business
1939 // reading these anyway, and there should be APIs to supply the info in a more app-friendly
1940 // way.
1941 RunCommand("SYSTEM PROPERTIES", {"getprop"});
1942 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07001943
1944 printf("========================================================\n");
1945 printf("== Android Framework Services\n");
1946 printf("========================================================\n");
1947
Vishnu Nair652cc802017-11-30 15:18:30 -08001948 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1949 SEC_TO_MSEC(10));
Hunter Knepshield31cbae12021-05-11 16:23:24 -07001950 RunDumpsys("DUMPSYS", {"vcn_management"}, CommandOptions::WithTimeout(90).Build(),
1951 SEC_TO_MSEC(10));
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08001952 if (include_sensitive_info) {
1953 // Carrier apps' services will be dumped below in dumpsys activity service all-non-platform.
1954 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
1955 SEC_TO_MSEC(10));
1956 } else {
1957 // If the caller is a carrier app and has a carrier service, dump it here since we aren't
1958 // running dumpsys activity service all-non-platform below. Due to the increased output, we
1959 // give a higher timeout as well.
1960 RunDumpsys("DUMPSYS", {"carrier_config", "--requesting-package", calling_package},
1961 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(30));
1962 }
1963 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001964 RunDumpsys("DUMPSYS", {"netpolicy"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
1965 RunDumpsys("DUMPSYS", {"network_management"}, CommandOptions::WithTimeout(90).Build(),
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07001966 SEC_TO_MSEC(10));
Hunter Knepshield0fe51b12020-03-05 16:58:20 -08001967 RunDumpsys("DUMPSYS", {"telephony.registry"}, CommandOptions::WithTimeout(90).Build(),
1968 SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001969 if (include_sensitive_info) {
1970 // Contains raw IP addresses, omit from reports on user builds.
1971 RunDumpsys("DUMPSYS", {"netd"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
1972 // Contains raw destination IP/MAC addresses, omit from reports on user builds.
1973 RunDumpsys("DUMPSYS", {"connmetrics"}, CommandOptions::WithTimeout(90).Build(),
1974 SEC_TO_MSEC(10));
1975 // Contains package/component names, omit from reports on user builds.
1976 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
1977 SEC_TO_MSEC(10));
1978 // Contains package names, but should be relatively simple to remove them (also contains
1979 // UIDs already), omit from reports on user builds.
1980 RunDumpsys("BATTERYSTATS", {"deviceidle"}, CommandOptions::WithTimeout(90).Build(),
1981 SEC_TO_MSEC(10));
1982 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07001983
1984 printf("========================================================\n");
1985 printf("== Running Application Services\n");
1986 printf("========================================================\n");
1987
1988 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
1989
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001990 if (include_sensitive_info) {
1991 printf("========================================================\n");
1992 printf("== Running Application Services (non-platform)\n");
1993 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001994
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001995 // Contains package/component names and potential PII, omit from reports on user builds.
1996 // To get dumps of the active CarrierService(s) on user builds, we supply an argument to the
1997 // carrier_config dumpsys instead.
1998 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1999 DUMPSYS_COMPONENTS_OPTIONS);
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002000
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002001 printf("========================================================\n");
2002 printf("== Checkins\n");
2003 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002004
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002005 // Contains package/component names, omit from reports on user builds.
2006 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
2007 }
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002008
2009 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07002010 printf("== dumpstate: done (id %d)\n", ds.id_);
2011 printf("========================================================\n");
Rhed Jaob5685b32020-08-14 17:19:17 +08002012
2013 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08002014 WaitForTask(std::move(dump_board));
Rhed Jaob5685b32020-08-14 17:19:17 +08002015 } else {
2016 RUN_SLOW_FUNCTION_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
2017 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002018}
2019
mukesh agrawal253dad42018-01-23 21:59:59 -08002020// This method collects dumpsys for wifi debugging only
2021static void DumpstateWifiOnly() {
2022 DurationReporter duration_reporter("DUMPSTATE");
2023
Rhed Jaob5685b32020-08-14 17:19:17 +08002024 DumpstateRadioAsRoot();
2025 if (!DropRootUser()) {
2026 return;
2027 }
2028
2029 // Starts thread pool after the root user is dropped. Only one additional
2030 // thread is needed for DumpHals in the DumpstateRadioCommon.
2031 if (ds.dump_pool_) {
2032 ds.dump_pool_->start(/*thread_counts =*/1);
2033 }
2034
mukesh agrawal253dad42018-01-23 21:59:59 -08002035 DumpstateRadioCommon();
2036
2037 printf("========================================================\n");
2038 printf("== Android Framework Services\n");
2039 printf("========================================================\n");
2040
2041 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
2042 SEC_TO_MSEC(10));
2043 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
2044 SEC_TO_MSEC(10));
2045
2046 printf("========================================================\n");
2047 printf("== dumpstate: done (id %d)\n", ds.id_);
2048 printf("========================================================\n");
2049}
2050
Nandana Duttcf419a72019-03-14 10:40:17 +00002051Dumpstate::RunStatus Dumpstate::DumpTraces(const char** path) {
Gavin Corkery789d7a52021-02-24 23:52:35 +00002052 const std::string temp_file_pattern = ds.bugreport_internal_dir_ + "/dumptrace_XXXXXX";
Nandana Duttfaafd522019-03-11 09:23:09 +00002053 const size_t buf_size = temp_file_pattern.length() + 1;
2054 std::unique_ptr<char[]> file_name_buf(new char[buf_size]);
2055 memcpy(file_name_buf.get(), temp_file_pattern.c_str(), buf_size);
2056
2057 // Create a new, empty file to receive all trace dumps.
2058 //
2059 // TODO: This can be simplified once we remove support for the old style
2060 // dumps. We can have a file descriptor passed in to dump_traces instead
2061 // of creating a file, closing it and then reopening it again.
2062 android::base::unique_fd fd(mkostemp(file_name_buf.get(), O_APPEND | O_CLOEXEC));
2063 if (fd < 0) {
2064 MYLOGE("mkostemp on pattern %s: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002065 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002066 }
2067
2068 // Nobody should have access to this temporary file except dumpstate, but we
2069 // temporarily grant 'read' to 'others' here because this file is created
2070 // when tombstoned is still running as root, but dumped after dropping. This
2071 // can go away once support for old style dumping has.
2072 const int chmod_ret = fchmod(fd, 0666);
2073 if (chmod_ret < 0) {
2074 MYLOGE("fchmod on %s failed: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002075 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002076 }
2077
2078 std::unique_ptr<DIR, decltype(&closedir)> proc(opendir("/proc"), closedir);
2079 if (proc.get() == nullptr) {
2080 MYLOGE("opendir /proc failed: %s\n", strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002081 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002082 }
2083
2084 // Number of times process dumping has timed out. If we encounter too many
2085 // failures, we'll give up.
2086 int timeout_failures = 0;
2087 bool dalvik_found = false;
2088
2089 const std::set<int> hal_pids = get_interesting_hal_pids();
2090
2091 struct dirent* d;
2092 while ((d = readdir(proc.get()))) {
Nandana Duttcf419a72019-03-14 10:40:17 +00002093 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttfaafd522019-03-11 09:23:09 +00002094 int pid = atoi(d->d_name);
2095 if (pid <= 0) {
2096 continue;
2097 }
2098
2099 const std::string link_name = android::base::StringPrintf("/proc/%d/exe", pid);
2100 std::string exe;
2101 if (!android::base::Readlink(link_name, &exe)) {
2102 continue;
2103 }
2104
2105 bool is_java_process;
2106 if (exe == "/system/bin/app_process32" || exe == "/system/bin/app_process64") {
2107 // Don't bother dumping backtraces for the zygote.
2108 if (IsZygote(pid)) {
2109 continue;
2110 }
2111
2112 dalvik_found = true;
2113 is_java_process = true;
2114 } else if (should_dump_native_traces(exe.c_str()) || hal_pids.find(pid) != hal_pids.end()) {
2115 is_java_process = false;
2116 } else {
2117 // Probably a native process we don't care about, continue.
2118 continue;
2119 }
2120
2121 // If 3 backtrace dumps fail in a row, consider debuggerd dead.
2122 if (timeout_failures == 3) {
2123 dprintf(fd, "ERROR: Too many stack dump failures, exiting.\n");
2124 break;
2125 }
2126
2127 const uint64_t start = Nanotime();
2128 const int ret = dump_backtrace_to_file_timeout(
2129 pid, is_java_process ? kDebuggerdJavaBacktrace : kDebuggerdNativeBacktrace,
2130 is_java_process ? 5 : 20, fd);
2131
2132 if (ret == -1) {
2133 // For consistency, the header and footer to this message match those
2134 // dumped by debuggerd in the success case.
2135 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
2136 dprintf(fd, "Dump failed, likely due to a timeout.\n");
2137 dprintf(fd, "---- end %d ----", pid);
2138 timeout_failures++;
2139 continue;
2140 }
2141
2142 // We've successfully dumped stack traces, reset the failure count
2143 // and write a summary of the elapsed time to the file and continue with the
2144 // next process.
2145 timeout_failures = 0;
2146
2147 dprintf(fd, "[dump %s stack %d: %.3fs elapsed]\n", is_java_process ? "dalvik" : "native",
2148 pid, (float)(Nanotime() - start) / NANOS_PER_SEC);
2149 }
2150
2151 if (!dalvik_found) {
2152 MYLOGE("Warning: no Dalvik processes found to dump stacks\n");
2153 }
2154
Nandana Duttcf419a72019-03-14 10:40:17 +00002155 *path = file_name_buf.release();
2156 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002157}
2158
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002159static dumpstate_hal_hidl::DumpstateMode GetDumpstateHalModeHidl(
2160 const Dumpstate::BugreportMode bugreport_mode) {
2161 switch (bugreport_mode) {
2162 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2163 return dumpstate_hal_hidl::DumpstateMode::FULL;
2164 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2165 return dumpstate_hal_hidl::DumpstateMode::INTERACTIVE;
2166 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2167 return dumpstate_hal_hidl::DumpstateMode::REMOTE;
2168 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2169 return dumpstate_hal_hidl::DumpstateMode::WEAR;
2170 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2171 return dumpstate_hal_hidl::DumpstateMode::CONNECTIVITY;
2172 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2173 return dumpstate_hal_hidl::DumpstateMode::WIFI;
2174 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2175 return dumpstate_hal_hidl::DumpstateMode::DEFAULT;
2176 }
2177 return dumpstate_hal_hidl::DumpstateMode::DEFAULT;
2178}
2179
2180static dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode GetDumpstateHalModeAidl(
2181 const Dumpstate::BugreportMode bugreport_mode) {
2182 switch (bugreport_mode) {
2183 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2184 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::FULL;
2185 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2186 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::INTERACTIVE;
2187 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2188 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::REMOTE;
2189 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2190 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::WEAR;
2191 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2192 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::CONNECTIVITY;
2193 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2194 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::WIFI;
2195 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2196 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::DEFAULT;
2197 }
2198 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::DEFAULT;
2199}
2200
2201static void DoDumpstateBoardHidl(
2202 const sp<dumpstate_hal_hidl_1_0::IDumpstateDevice> dumpstate_hal_1_0,
2203 const std::vector<::ndk::ScopedFileDescriptor>& dumpstate_fds,
2204 const Dumpstate::BugreportMode bugreport_mode,
2205 const size_t timeout_sec) {
2206
2207 using ScopedNativeHandle =
2208 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
2209 ScopedNativeHandle handle(native_handle_create(static_cast<int>(dumpstate_fds.size()), 0),
2210 [](native_handle_t* handle) {
2211 // we don't close file handle's here
2212 // via native_handle_close(handle)
2213 // instead we let dumpstate_fds close the file handles when
2214 // dumpstate_fds gets destroyed
2215 native_handle_delete(handle);
2216 });
2217 if (handle == nullptr) {
2218 MYLOGE("Could not create native_handle for dumpstate HAL\n");
2219 return;
2220 }
2221
2222 for (size_t i = 0; i < dumpstate_fds.size(); i++) {
2223 handle.get()->data[i] = dumpstate_fds[i].get();
2224 }
2225
2226 // Prefer version 1.1 if available. New devices launching with R are no longer allowed to
2227 // implement just 1.0.
2228 const char* descriptor_to_kill;
2229 using DumpstateBoardTask = std::packaged_task<bool()>;
2230 DumpstateBoardTask dumpstate_board_task;
2231 sp<dumpstate_hal_hidl::IDumpstateDevice> dumpstate_hal(
2232 dumpstate_hal_hidl::IDumpstateDevice::castFrom(dumpstate_hal_1_0));
2233 if (dumpstate_hal != nullptr) {
2234 MYLOGI("Using IDumpstateDevice v1.1 HIDL HAL");
2235
2236 dumpstate_hal_hidl::DumpstateMode dumpstate_hal_mode =
2237 GetDumpstateHalModeHidl(bugreport_mode);
2238
2239 descriptor_to_kill = dumpstate_hal_hidl::IDumpstateDevice::descriptor;
2240 dumpstate_board_task =
2241 DumpstateBoardTask([timeout_sec, dumpstate_hal_mode, dumpstate_hal, &handle]() -> bool {
2242 ::android::hardware::Return<dumpstate_hal_hidl::DumpstateStatus> status =
2243 dumpstate_hal->dumpstateBoard_1_1(handle.get(), dumpstate_hal_mode,
2244 SEC_TO_MSEC(timeout_sec));
2245 if (!status.isOk()) {
2246 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2247 return false;
2248 } else if (status != dumpstate_hal_hidl::DumpstateStatus::OK) {
2249 MYLOGE("dumpstateBoard failed with DumpstateStatus::%s\n",
2250 dumpstate_hal_hidl::toString(status).c_str());
2251 return false;
2252 }
2253 return true;
2254 });
2255 } else {
2256 MYLOGI("Using IDumpstateDevice v1.0 HIDL HAL");
2257
2258 descriptor_to_kill = dumpstate_hal_hidl_1_0::IDumpstateDevice::descriptor;
2259 dumpstate_board_task = DumpstateBoardTask([dumpstate_hal_1_0, &handle]() -> bool {
2260 ::android::hardware::Return<void> status =
2261 dumpstate_hal_1_0->dumpstateBoard(handle.get());
2262 if (!status.isOk()) {
2263 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2264 return false;
2265 }
2266 return true;
2267 });
2268 }
2269 auto result = dumpstate_board_task.get_future();
2270 std::thread(std::move(dumpstate_board_task)).detach();
2271
2272 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2273 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate HAL\n", timeout_sec);
2274 if (!android::base::SetProperty(
2275 "ctl.interface_restart",
2276 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
2277 MYLOGE("Couldn't restart dumpstate HAL\n");
2278 }
2279 }
2280 // Wait some time for init to kill dumpstate vendor HAL
2281 constexpr size_t killing_timeout_sec = 10;
2282 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2283 MYLOGE(
2284 "killing dumpstateBoard timed out after %zus, continue and "
2285 "there might be racing in content\n",
2286 killing_timeout_sec);
2287 }
2288}
2289
2290static void DoDumpstateBoardAidl(
2291 const std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> dumpstate_hal,
2292 const std::vector<::ndk::ScopedFileDescriptor>& dumpstate_fds,
2293 const Dumpstate::BugreportMode bugreport_mode, const size_t timeout_sec) {
2294 MYLOGI("Using IDumpstateDevice AIDL HAL");
2295
2296 const char* descriptor_to_kill;
2297 using DumpstateBoardTask = std::packaged_task<bool()>;
2298 DumpstateBoardTask dumpstate_board_task;
2299 dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode dumpstate_hal_mode =
2300 GetDumpstateHalModeAidl(bugreport_mode);
2301
2302 descriptor_to_kill = dumpstate_hal_aidl::IDumpstateDevice::descriptor;
2303 dumpstate_board_task = DumpstateBoardTask([dumpstate_hal, &dumpstate_fds, dumpstate_hal_mode,
2304 timeout_sec]() -> bool {
2305 auto status = dumpstate_hal->dumpstateBoard(dumpstate_fds, dumpstate_hal_mode, timeout_sec);
2306
2307 if (!status.isOk()) {
2308 MYLOGE("dumpstateBoard failed: %s\n", status.getDescription().c_str());
2309 return false;
2310 }
2311 return true;
2312 });
2313 auto result = dumpstate_board_task.get_future();
2314 std::thread(std::move(dumpstate_board_task)).detach();
2315
2316 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2317 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate HAL\n", timeout_sec);
2318 if (!android::base::SetProperty(
2319 "ctl.interface_restart",
2320 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
2321 MYLOGE("Couldn't restart dumpstate HAL\n");
2322 }
2323 }
2324 // Wait some time for init to kill dumpstate vendor HAL
2325 constexpr size_t killing_timeout_sec = 10;
2326 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2327 MYLOGE(
2328 "killing dumpstateBoard timed out after %zus, continue and "
2329 "there might be racing in content\n",
2330 killing_timeout_sec);
2331 }
2332}
2333
2334static std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> GetDumpstateBoardAidlService() {
2335 const std::string aidl_instance_name =
2336 std::string(dumpstate_hal_aidl::IDumpstateDevice::descriptor) + "/default";
2337
2338 if (!AServiceManager_isDeclared(aidl_instance_name.c_str())) {
2339 return nullptr;
2340 }
2341
2342 ndk::SpAIBinder dumpstateBinder(AServiceManager_waitForService(aidl_instance_name.c_str()));
2343
2344 return dumpstate_hal_aidl::IDumpstateDevice::fromBinder(dumpstateBinder);
2345}
2346
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002347void Dumpstate::DumpstateBoard(int out_fd) {
2348 dprintf(out_fd, "========================================================\n");
2349 dprintf(out_fd, "== Board\n");
2350 dprintf(out_fd, "========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08002351
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002352 /*
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002353 * mount debugfs for non-user builds with ro.product.debugfs_restrictions.enabled
Hridya Valsaraju51101602021-04-02 14:32:46 -07002354 * set to true and unmount it after invoking dumpstateBoard_* methods.
2355 * This is to enable debug builds to not have debugfs mounted during runtime.
2356 * It will also ensure that debugfs is only accessed by the dumpstate HAL.
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002357 */
Hridya Valsaraju51101602021-04-02 14:32:46 -07002358 auto mount_debugfs =
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002359 android::base::GetBoolProperty("ro.product.debugfs_restrictions.enabled", false);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002360 if (mount_debugfs) {
2361 RunCommand("mount debugfs", {"mount", "-t", "debugfs", "debugfs", "/sys/kernel/debug"},
2362 AS_ROOT_20);
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002363 RunCommand("chmod debugfs", {"chmod", "0755", "/sys/kernel/debug"}, AS_ROOT_20);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002364 }
2365
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002366 std::vector<std::string> paths;
2367 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07002368 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002369 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
2370 kDumpstateBoardFiles[i].c_str()));
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002371 remover.emplace_back(android::base::make_scope_guard(
2372 std::bind([](std::string path) { android::os::UnlinkAndLogOnError(path); }, paths[i])));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002373 }
Jie Song9fbfad02017-06-20 16:29:42 -07002374
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002375 // get dumpstate HAL AIDL implementation
2376 std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> dumpstate_hal_handle_aidl(
2377 GetDumpstateBoardAidlService());
2378 if (dumpstate_hal_handle_aidl == nullptr) {
2379 MYLOGI("No IDumpstateDevice AIDL implementation\n");
2380 }
2381
2382 // get dumpstate HAL HIDL implementation, only if AIDL HAL implementation not found
2383 sp<dumpstate_hal_hidl_1_0::IDumpstateDevice> dumpstate_hal_handle_hidl_1_0 = nullptr;
2384 if (dumpstate_hal_handle_aidl == nullptr) {
2385 dumpstate_hal_handle_hidl_1_0 = dumpstate_hal_hidl_1_0::IDumpstateDevice::getService();
2386 if (dumpstate_hal_handle_hidl_1_0 == nullptr) {
2387 MYLOGI("No IDumpstateDevice HIDL implementation\n");
2388 }
2389 }
2390
2391 // if neither HIDL nor AIDL implementation found, then return
2392 if (dumpstate_hal_handle_hidl_1_0 == nullptr && dumpstate_hal_handle_aidl == nullptr) {
2393 MYLOGE("Could not find IDumpstateDevice implementation\n");
Wei Wang587eac92018-04-05 12:17:20 -07002394 return;
2395 }
2396
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002397 // this is used to hold the file descriptors and when this variable goes out of scope
2398 // the file descriptors are closed
2399 std::vector<::ndk::ScopedFileDescriptor> dumpstate_fds;
Wei Wang587eac92018-04-05 12:17:20 -07002400
Nandana Dutt5c390032019-03-12 10:52:56 +00002401 // TODO(128270426): Check for consent in between?
Wei Wang587eac92018-04-05 12:17:20 -07002402 for (size_t i = 0; i < paths.size(); i++) {
2403 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
2404
2405 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
2406 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
2407 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
2408 if (fd < 0) {
2409 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
2410 return;
2411 }
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002412
2413 dumpstate_fds.emplace_back(fd.release());
2414 // we call fd.release() here to make sure "fd" does not get closed
2415 // after "fd" goes out of scope after this block.
2416 // "fd" will be closed when "dumpstate_fds" goes out of scope
2417 // i.e. when we exit this function
Wei Wang587eac92018-04-05 12:17:20 -07002418 }
2419
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002420 // Given that bugreport is required to diagnose failures, it's better to set an arbitrary amount
2421 // of timeout for IDumpstateDevice than to block the rest of bugreport. In the timeout case, we
2422 // will kill the HAL and grab whatever it dumped in time.
Michael Eastwood8523ea02022-03-10 16:33:08 -08002423 constexpr size_t timeout_sec = 45;
Wei Wang587eac92018-04-05 12:17:20 -07002424
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002425 if (dumpstate_hal_handle_aidl != nullptr) {
2426 DoDumpstateBoardAidl(dumpstate_hal_handle_aidl, dumpstate_fds, options_->bugreport_mode,
2427 timeout_sec);
2428 } else if (dumpstate_hal_handle_hidl_1_0 != nullptr) {
2429 // run HIDL HAL only if AIDL HAL not found
2430 DoDumpstateBoardHidl(dumpstate_hal_handle_hidl_1_0, dumpstate_fds, options_->bugreport_mode,
2431 timeout_sec);
Wei Wang587eac92018-04-05 12:17:20 -07002432 }
2433
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002434 if (mount_debugfs) {
Hridya Valsaraju51101602021-04-02 14:32:46 -07002435 auto keep_debugfs_mounted =
2436 android::base::GetProperty("persist.dbg.keep_debugfs_mounted", "");
2437 if (keep_debugfs_mounted.empty())
2438 RunCommand("unmount debugfs", {"umount", "/sys/kernel/debug"}, AS_ROOT_20);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002439 }
2440
Wei Wang587eac92018-04-05 12:17:20 -07002441 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
2442 for (size_t i = 0; i < paths.size(); i++) {
2443 struct stat s;
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002444 if (fstat(dumpstate_fds[i].get(), &s) == -1) {
2445 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(), strerror(errno));
Wei Wang587eac92018-04-05 12:17:20 -07002446 file_sizes[i] = -1;
2447 continue;
2448 }
2449 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002450 }
2451
2452 for (size_t i = 0; i < paths.size(); i++) {
2453 if (file_sizes[i] == -1) {
2454 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002455 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002456 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07002457 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002458 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002459 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002460 remover[i].Disable();
2461 EnqueueAddZipEntryAndCleanupIfNeeded(kDumpstateBoardFiles[i], paths[i]);
2462 dprintf(out_fd, "*** See %s entry ***\n", kDumpstateBoardFiles[i].c_str());
Jie Song9fbfad02017-06-20 16:29:42 -07002463 }
Felipe Leme6f674ae2016-11-18 17:10:33 -08002464}
2465
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002466static void ShowUsage() {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002467 fprintf(stderr,
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002468 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-o directory] [-p] "
2469 "[-s] [-S] [-q] [-P] [-R] [-L] [-V version]\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002470 " -h: display this help message\n"
2471 " -b: play sound file instead of vibrate, at beginning of job\n"
2472 " -e: play sound file instead of vibrate, at end of job\n"
mhasank2d75c442020-06-11 15:05:25 -07002473 " -o: write to custom directory (only in limited mode)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01002474 " -p: capture screenshot to filename.png\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002475 " -s: write zipped file to control socket (for init)\n"
2476 " -S: write file location to control socket (for init)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002477 " -q: disable vibrate\n"
Abhijeet Kaure370d682019-10-01 16:49:30 +01002478 " -P: send broadcast when started and do progress updates\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002479 " -R: take bugreport in remote mode (shouldn't be used with -P)\n"
Nandana Dutt235864b2019-01-22 12:10:16 +00002480 " -w: start binder service and make it wait for a call to startBugreport\n"
mhasankd451a472020-05-26 18:02:39 -07002481 " -L: output limited information that is safe for submission in feedback reports\n"
Felipe Lemed071c682016-10-20 16:48:00 -07002482 " -v: prints the dumpstate header and exit\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002483}
2484
Wei Liuf87959e2016-08-26 14:51:42 -07002485static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07002486 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07002487}
2488
Felipe Leme1d486fe2016-10-14 18:06:47 -07002489bool Dumpstate::FinishZipFile() {
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002490 // Runs all enqueued adding zip entry and cleanup tasks before finishing the zip file.
2491 if (zip_entry_tasks_) {
2492 zip_entry_tasks_->run(/* do_cancel = */false);
2493 }
2494
Felipe Leme9a523ae2016-10-20 15:10:33 -07002495 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07002496 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07002497 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002498 // Final timestamp
2499 char date[80];
2500 time_t the_real_now_please_stand_up = time(nullptr);
2501 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002502 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07002503 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002504
Felipe Leme9a523ae2016-10-20 15:10:33 -07002505 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002506 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08002507 return false;
2508 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07002509 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002510 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08002511 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08002512 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08002513
Felipe Leme0f3fb202016-06-10 17:10:53 -07002514 // Add log file (which contains stderr output) to zip...
2515 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07002516 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07002517 MYLOGE("Failed to add dumpstate log to .zip file\n");
2518 return false;
2519 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002520 // TODO: Should truncate the existing file.
2521 // ... and re-open it for further logging.
Nandana Dutta344cb62019-02-22 15:12:35 +00002522 if (!redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()))) {
2523 return false;
2524 }
Felipe Leme0f3fb202016-06-10 17:10:53 -07002525 fprintf(stderr, "\n");
2526
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002527 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07002528 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002529 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002530 return false;
2531 }
2532
Felipe Leme1d486fe2016-10-14 18:06:47 -07002533 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
2534 ds.zip_file.reset(nullptr);
2535
Felipe Lemee9d2c542016-11-15 11:48:26 -08002536 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002537 android::os::UnlinkAndLogOnError(tmp_path_);
Felipe Lemec4eee562016-04-21 15:42:55 -07002538
Felipe Leme1e9edc62015-12-21 16:02:13 -08002539 return true;
2540}
Felipe Leme6e01fa62015-11-11 19:35:14 -08002541
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002542static void SendBroadcast(const std::string& action, const std::vector<std::string>& args) {
2543 // clang-format off
2544 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user", "0",
2545 "--receiver-foreground", "--receiver-include-background", "-a", action};
2546 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08002547
2548 am.insert(am.end(), args.begin(), args.end());
2549
Felipe Leme8d2410e2017-02-08 09:46:08 -08002550 RunCommand("", am,
2551 CommandOptions::WithTimeout(20)
2552 .Log("Sending broadcast: '%s'\n")
2553 .Always()
2554 .DropRoot()
2555 .RedirectStderr()
2556 .Build());
2557}
2558
Felipe Leme35b8cf12017-02-10 15:47:29 -08002559static void Vibrate(int duration_ms) {
2560 // clang-format off
Lais Andrade51156962021-02-22 19:21:35 +00002561 std::vector<std::string> args = {"cmd", "vibrator_manager", "synced", "-f", "-d", "dumpstate",
2562 "oneshot", std::to_string(duration_ms)};
2563 RunCommand("", args,
Felipe Leme35b8cf12017-02-10 15:47:29 -08002564 CommandOptions::WithTimeout(10)
2565 .Log("Vibrate: '%s'\n")
2566 .Always()
2567 .Build());
2568 // clang-format on
2569}
2570
Nandana Dutt979388e2018-11-30 16:48:55 +00002571static void MaybeResolveSymlink(std::string* path) {
2572 std::string resolved_path;
2573 if (android::base::Readlink(*path, &resolved_path)) {
2574 *path = resolved_path;
2575 }
2576}
2577
Nandana Dutt4be45d12018-09-26 15:04:23 +01002578/*
2579 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002580 * and adds the version file. Return false if zip_file could not be open to write.
Nandana Dutt4be45d12018-09-26 15:04:23 +01002581 */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002582static bool PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002583 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
2584
Nandana Dutt4be45d12018-09-26 15:04:23 +01002585 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
2586 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002587 ds.base_name_ = StringPrintf("bugreport-%s-%s", device_name.c_str(), build_id.c_str());
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002588 char date[80];
2589 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
2590 ds.name_ = date;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002591
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002592 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002593 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002594 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002595 ds.base_name_ += "-wifi";
2596 }
2597
Paul Chang0d2aad72020-02-13 20:04:03 +08002598 if (ds.options_->do_screenshot) {
Nandana Dutt9d17b942020-03-26 10:02:59 +00002599 ds.screenshot_path_ = ds.GetPath(ds.CalledByApi() ? "-png.tmp" : ".png");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002600 }
2601 ds.tmp_path_ = ds.GetPath(".tmp");
2602 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
2603
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002604 std::string destination = ds.CalledByApi()
Nandana Dutt54dbd672019-01-11 12:58:05 +00002605 ? StringPrintf("[fd:%d]", ds.options_->bugreport_fd.get())
Nandana Dutt9a76d202019-01-21 15:56:48 +00002606 : ds.bugreport_internal_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01002607 MYLOGD(
Nandana Dutt235c6672019-11-14 15:22:32 +00002608 "Bugreport dir: [%s] "
2609 "Base name: [%s] "
2610 "Suffix: [%s] "
2611 "Log path: [%s] "
2612 "Temporary path: [%s] "
2613 "Screenshot path: [%s]\n",
Nandana Dutt9a76d202019-01-21 15:56:48 +00002614 destination.c_str(), ds.base_name_.c_str(), ds.name_.c_str(), ds.log_path_.c_str(),
2615 ds.tmp_path_.c_str(), ds.screenshot_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002616
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002617 ds.path_ = ds.GetPath(ds.CalledByApi() ? "-zip.tmp" : ".zip");
2618 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
2619 create_parent_dirs(ds.path_.c_str());
2620 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
2621 if (ds.zip_file == nullptr) {
2622 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
2623 return false;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002624 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002625 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
2626 ds.AddTextZipEntry("version.txt", ds.version_);
2627 return true;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002628}
2629
2630/*
Abhijeet Kaure370d682019-10-01 16:49:30 +01002631 * Finalizes writing to the file by zipping the tmp file to the final location,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002632 * printing zipped file status, etc.
2633 */
2634static void FinalizeFile() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002635 bool do_text_file = !ds.FinishZipFile();
2636 if (do_text_file) {
2637 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002638 }
mhasank2d75c442020-06-11 15:05:25 -07002639
2640 std::string final_path = ds.path_;
2641 if (ds.options_->OutputToCustomFile()) {
mhasank3a4cfb42020-06-15 18:06:43 -07002642 final_path = ds.GetPath(ds.options_->out_dir, ".zip");
mhasank2d75c442020-06-11 15:05:25 -07002643 android::os::CopyFileToFile(ds.path_, final_path);
2644 }
2645
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002646 if (ds.options_->stream_to_socket) {
2647 android::os::CopyFileToFd(ds.path_, ds.control_socket_fd_);
2648 } else if (ds.options_->progress_updates_to_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002649 if (do_text_file) {
2650 dprintf(ds.control_socket_fd_,
2651 "FAIL:could not create zip file, check %s "
2652 "for more details\n",
2653 ds.log_path_.c_str());
2654 } else {
mhasank2d75c442020-06-11 15:05:25 -07002655 dprintf(ds.control_socket_fd_, "OK:%s\n", final_path.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002656 }
2657 }
2658}
2659
Nandana Dutt4be45d12018-09-26 15:04:23 +01002660
Nandana Dutt58d72e22018-11-16 10:30:48 +00002661static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2662 switch (mode) {
2663 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2664 return "BUGREPORT_FULL";
2665 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2666 return "BUGREPORT_INTERACTIVE";
2667 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2668 return "BUGREPORT_REMOTE";
2669 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2670 return "BUGREPORT_WEAR";
2671 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2672 return "BUGREPORT_TELEPHONY";
2673 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2674 return "BUGREPORT_WIFI";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002675 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2676 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002677 }
2678}
2679
Paul Changf59c2b72020-03-10 02:08:55 +08002680static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options,
2681 bool is_screenshot_requested) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002682 // Modify com.android.shell.BugreportProgressService#isDefaultScreenshotRequired as well for
2683 // default system screenshots.
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002684 options->bugreport_mode = mode;
2685 options->bugreport_mode_string = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002686 switch (mode) {
2687 case Dumpstate::BugreportMode::BUGREPORT_FULL:
Paul Changf59c2b72020-03-10 02:08:55 +08002688 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002689 break;
2690 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002691 // Currently, the dumpstate binder is only used by Shell to update progress.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002692 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002693 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002694 break;
2695 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002696 options->do_vibrate = false;
2697 options->is_remote_mode = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002698 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002699 break;
2700 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002701 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002702 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002703 break;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002704 // TODO(b/148168577) rename TELEPHONY everywhere to CONNECTIVITY.
Nandana Dutt58d72e22018-11-16 10:30:48 +00002705 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002706 options->telephony_only = true;
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002707 options->do_progress_updates = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002708 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002709 break;
2710 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002711 options->wifi_only = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002712 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002713 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002714 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2715 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002716 }
2717}
2718
Nandana Dutt58d72e22018-11-16 10:30:48 +00002719static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
Nandana Dutt235c6672019-11-14 15:22:32 +00002720 MYLOGI(
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002721 "do_vibrate: %d stream_to_socket: %d progress_updates_to_socket: %d do_screenshot: %d "
Rhed Jao25f50e02020-08-20 00:10:32 +08002722 "is_remote_mode: %d show_header_only: %d telephony_only: %d "
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002723 "wifi_only: %d do_progress_updates: %d fd: %d bugreport_mode: %s "
mhasankd451a472020-05-26 18:02:39 -07002724 "limited_only: %d args: %s\n",
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002725 options.do_vibrate, options.stream_to_socket, options.progress_updates_to_socket,
Paul Chang0d2aad72020-02-13 20:04:03 +08002726 options.do_screenshot, options.is_remote_mode, options.show_header_only,
Rhed Jao25f50e02020-08-20 00:10:32 +08002727 options.telephony_only, options.wifi_only,
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002728 options.do_progress_updates, options.bugreport_fd.get(),
2729 options.bugreport_mode_string.c_str(),
2730 options.limited_only, options.args.c_str());
Nandana Dutt58d72e22018-11-16 10:30:48 +00002731}
2732
Nandana Dutt54dbd672019-01-11 12:58:05 +00002733void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode,
2734 const android::base::unique_fd& bugreport_fd_in,
Paul Changf59c2b72020-03-10 02:08:55 +08002735 const android::base::unique_fd& screenshot_fd_in,
2736 bool is_screenshot_requested) {
Nandana Dutt54dbd672019-01-11 12:58:05 +00002737 // Duplicate the fds because the passed in fds don't outlive the binder transaction.
Todd Frederick621533f2022-03-26 02:54:17 +00002738 bugreport_fd.reset(fcntl(bugreport_fd_in.get(), F_DUPFD_CLOEXEC, 0));
2739 screenshot_fd.reset(fcntl(screenshot_fd_in.get(), F_DUPFD_CLOEXEC, 0));
Nandana Dutt58d72e22018-11-16 10:30:48 +00002740
Paul Changf59c2b72020-03-10 02:08:55 +08002741 SetOptionsFromMode(bugreport_mode, this, is_screenshot_requested);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002742}
2743
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002744Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
2745 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002746 int c;
mhasankd451a472020-05-26 18:02:39 -07002747 while ((c = getopt(argc, argv, "dho:svqzpLPBRSV:w")) != -1) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002748 switch (c) {
2749 // clang-format off
mhasank3a4cfb42020-06-15 18:06:43 -07002750 case 'o': out_dir = optarg; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002751 case 's': stream_to_socket = true; break;
2752 case 'S': progress_updates_to_socket = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002753 case 'v': show_header_only = true; break;
2754 case 'q': do_vibrate = false; break;
Paul Chang0d2aad72020-02-13 20:04:03 +08002755 case 'p': do_screenshot = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002756 case 'P': do_progress_updates = true; break;
2757 case 'R': is_remote_mode = true; break;
mhasankd451a472020-05-26 18:02:39 -07002758 case 'L': limited_only = true; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002759 case 'V':
2760 case 'd':
2761 case 'z':
2762 // compatibility no-op
2763 break;
Nandana Dutt235864b2019-01-22 12:10:16 +00002764 case 'w':
2765 // This was already processed
2766 break;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002767 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002768 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002769 break;
2770 default:
2771 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002772 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002773 break;
2774 // clang-format on
2775 }
2776 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08002777
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002778 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002779 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002780 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002781 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002782 }
2783 }
2784
2785 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
2786 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002787
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002788 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002789}
2790
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002791bool Dumpstate::DumpOptions::ValidateOptions() const {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002792 if (bugreport_fd.get() != -1 && stream_to_socket) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002793 return false;
2794 }
2795
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002796 if ((progress_updates_to_socket || do_progress_updates) && stream_to_socket) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002797 return false;
2798 }
2799
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002800 if (is_remote_mode && (do_progress_updates || stream_to_socket)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002801 return false;
2802 }
2803 return true;
2804}
2805
Nandana Dutt197661d2018-11-16 16:40:21 +00002806void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
2807 options_ = std::move(options);
2808}
2809
Abhijeet Kaura407fb82020-03-27 12:51:12 +00002810void Dumpstate::Initialize() {
2811 /* gets the sequential id */
2812 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
2813 id_ = ++last_id;
2814 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
2815}
2816
Nandana Duttd2f5f082019-01-18 17:13:52 +00002817Dumpstate::RunStatus Dumpstate::Run(int32_t calling_uid, const std::string& calling_package) {
2818 Dumpstate::RunStatus status = RunInternal(calling_uid, calling_package);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002819 if (listener_ != nullptr) {
2820 switch (status) {
2821 case Dumpstate::RunStatus::OK:
Nandana Duttcc4ead82019-01-23 08:29:23 +00002822 listener_->onFinished();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002823 break;
2824 case Dumpstate::RunStatus::HELP:
2825 break;
2826 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002827 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_INVALID_INPUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002828 break;
2829 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002830 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_RUNTIME_ERROR);
2831 break;
2832 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2833 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_DENIED_CONSENT);
2834 break;
2835 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
2836 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_CONSENT_TIMED_OUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002837 break;
2838 }
2839 }
2840 return status;
2841}
2842
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002843void Dumpstate::Cancel() {
2844 CleanupTmpFiles();
2845 android::os::UnlinkAndLogOnError(log_path_);
2846 for (int i = 0; i < NUM_OF_DUMPS; i++) {
2847 android::os::UnlinkAndLogOnError(ds.bugreport_internal_dir_ + "/" +
2848 kDumpstateBoardFiles[i]);
2849 }
2850 tombstone_data_.clear();
2851 anr_data_.clear();
Rhed Jao0daac912020-08-21 14:48:20 +08002852
2853 // Instead of shutdown the pool, we delete temporary files directly since
2854 // shutdown blocking the call.
2855 if (dump_pool_) {
2856 dump_pool_->deleteTempFiles();
2857 }
2858 if (zip_entry_tasks_) {
2859 zip_entry_tasks_->run(/*do_cancel =*/ true);
2860 }
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002861}
2862
Nandana Dutt979388e2018-11-30 16:48:55 +00002863/*
2864 * Dumps relevant information to a bugreport based on the given options.
2865 *
2866 * The bugreport can be dumped to a file or streamed to a socket.
2867 *
2868 * How dumping to file works:
2869 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
2870 * stderr is redirected a log file.
2871 *
2872 * The temporary bugreport is then populated via printfs, dumping contents of files and
2873 * output of commands to stdout.
2874 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002875 * A bunch of other files and dumps are added to the zip archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00002876 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002877 * The temporary bugreport file and the log file also get added to the archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00002878 *
mhasank2d75c442020-06-11 15:05:25 -07002879 * Bugreports are first generated in a local directory and later copied to the caller's fd
2880 * or directory if supplied.
Nandana Dutt979388e2018-11-30 16:48:55 +00002881 */
Nandana Duttd2f5f082019-01-18 17:13:52 +00002882Dumpstate::RunStatus Dumpstate::RunInternal(int32_t calling_uid,
2883 const std::string& calling_package) {
Rhed Jao5377d792020-07-16 17:37:39 +08002884 DurationReporter duration_reporter("RUN INTERNAL", /* logcat_only = */true);
Nandana Dutt979388e2018-11-30 16:48:55 +00002885 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00002886 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002887 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002888 return RunStatus::INVALID_INPUT;
2889 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002890 /* set as high priority, and protect from OOM killer */
2891 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002892
Felipe Lemed071c682016-10-20 16:48:00 -07002893 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002894 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002895 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002896 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002897 } else {
2898 /* fallback to kernels <= 2.6.35 */
2899 oom_adj = fopen("/proc/self/oom_adj", "we");
2900 if (oom_adj) {
2901 fputs("-17", oom_adj);
2902 fclose(oom_adj);
2903 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002904 }
2905
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002906 if (version_ == VERSION_DEFAULT) {
2907 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00002908 }
2909
Chris Morin5a50d482022-02-01 17:41:18 -08002910 if (version_ != VERSION_CURRENT) {
2911 MYLOGE("invalid version requested ('%s'); supported values are: ('%s', '%s')\n",
2912 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002913 return RunStatus::INVALID_INPUT;
Felipe Lemed071c682016-10-20 16:48:00 -07002914 }
2915
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002916 if (options_->show_header_only) {
2917 PrintHeader();
2918 return RunStatus::OK;
Felipe Lemed071c682016-10-20 16:48:00 -07002919 }
2920
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002921 MYLOGD("dumpstate calling_uid = %d ; calling package = %s \n",
2922 calling_uid, calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00002923
Felipe Leme7447d7c2016-11-03 18:12:22 -07002924 // TODO: temporarily set progress until it's part of the Dumpstate constructor
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002925 std::string stats_path =
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002926 android::base::StringPrintf("%s/dumpstate-stats.txt", bugreport_internal_dir_.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002927 progress_.reset(new Progress(stats_path));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002928
Sahana Raof35ed432019-07-12 10:47:52 +01002929 if (acquire_wake_lock(PARTIAL_WAKE_LOCK, WAKE_LOCK_NAME) < 0) {
2930 MYLOGE("Failed to acquire wake lock: %s\n", strerror(errno));
2931 } else {
2932 // Wake lock will be released automatically on process death
2933 MYLOGD("Wake lock acquired.\n");
2934 }
2935
Felipe Leme6ae5c4f2017-01-10 14:13:22 -08002936 register_sig_handler();
Felipe Lemed071c682016-10-20 16:48:00 -07002937
Felipe Lemef0292972016-11-22 13:57:05 -08002938 if (PropertiesHelper::IsDryRun()) {
Felipe Lemed071c682016-10-20 16:48:00 -07002939 MYLOGI("Running on dry-run mode (to disable it, call 'setprop dumpstate.dry_run false')\n");
2940 }
2941
Nandana Dutt235c6672019-11-14 15:22:32 +00002942 MYLOGI("dumpstate info: id=%d, args='%s', bugreport_mode= %s bugreport format version: %s\n",
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002943 id_, options_->args.c_str(), options_->bugreport_mode_string.c_str(), version_.c_str());
Felipe Leme809d74e2016-02-02 12:57:00 -08002944
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002945 do_early_screenshot_ = options_->do_progress_updates;
Felipe Lemee338bf62015-12-07 14:03:50 -08002946
Christopher Ferrised9354f2014-10-01 17:35:01 -07002947 // If we are going to use a socket, do it as early as possible
2948 // to avoid timeouts from bugreport.
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002949 if (options_->stream_to_socket || options_->progress_updates_to_socket) {
Felipe Leme2628e9e2016-04-12 16:36:51 -07002950 MYLOGD("Opening control socket\n");
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002951 control_socket_fd_ = open_socket_fn_("dumpstate");
Nandana Dutta344cb62019-02-22 15:12:35 +00002952 if (control_socket_fd_ == -1) {
2953 return ERROR;
2954 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002955 if (options_->progress_updates_to_socket) {
2956 options_->do_progress_updates = 1;
2957 }
Felipe Leme2628e9e2016-04-12 16:36:51 -07002958 }
2959
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002960 if (!PrepareToWriteToFile()) {
2961 return ERROR;
2962 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08002963
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002964 // Interactive, wear & telephony modes are default to true.
2965 // and may enable from cli option or when using control socket
2966 if (options_->do_progress_updates) {
2967 // clang-format off
2968 std::vector<std::string> am_args = {
2969 "--receiver-permission", "android.permission.DUMP",
2970 };
2971 // clang-format on
2972 // Send STARTED broadcast for apps that listen to bugreport generation events
2973 SendBroadcast("com.android.internal.intent.action.BUGREPORT_STARTED", am_args);
2974 if (options_->progress_updates_to_socket) {
2975 dprintf(control_socket_fd_, "BEGIN:%s\n", path_.c_str());
Felipe Leme71bbfc52015-11-23 14:14:51 -08002976 }
2977 }
2978
Nick Kralevichf3599b32016-01-25 15:05:16 -08002979 /* read /proc/cmdline before dropping root */
2980 FILE *cmdline = fopen("/proc/cmdline", "re");
2981 if (cmdline) {
2982 fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
2983 fclose(cmdline);
2984 }
2985
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002986 if (options_->do_vibrate) {
Felipe Leme35b8cf12017-02-10 15:47:29 -08002987 Vibrate(150);
John Michelau1f794c42012-09-17 11:20:19 -05002988 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002989
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002990 if (zip_file != nullptr) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002991 if (chown(path_.c_str(), AID_SHELL, AID_SHELL)) {
2992 MYLOGE("Unable to change ownership of zip file %s: %s\n", path_.c_str(),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002993 strerror(errno));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002994 }
2995 }
2996
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002997 int dup_stdout_fd;
2998 int dup_stderr_fd;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002999 // Redirect stderr to log_path_ for debugging.
3000 TEMP_FAILURE_RETRY(dup_stderr_fd = dup(fileno(stderr)));
3001 if (!redirect_to_file(stderr, const_cast<char*>(log_path_.c_str()))) {
3002 return ERROR;
3003 }
3004 if (chown(log_path_.c_str(), AID_SHELL, AID_SHELL)) {
3005 MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n", log_path_.c_str(),
3006 strerror(errno));
3007 }
Nandana Dutt979388e2018-11-30 16:48:55 +00003008
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003009 // Redirect stdout to tmp_path_. This is the main bugreport entry and will be
3010 // moved into zip file later, if zipping.
3011 TEMP_FAILURE_RETRY(dup_stdout_fd = dup(fileno(stdout)));
3012 // TODO: why not write to a file instead of stdout to overcome this problem?
3013 /* TODO: rather than generating a text file now and zipping it later,
3014 it would be more efficient to redirect stdout to the zip entry
3015 directly, but the libziparchive doesn't support that option yet. */
3016 if (!redirect_to_file(stdout, const_cast<char*>(tmp_path_.c_str()))) {
3017 return ERROR;
3018 }
3019 if (chown(tmp_path_.c_str(), AID_SHELL, AID_SHELL)) {
3020 MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
3021 tmp_path_.c_str(), strerror(errno));
Colin Crossf45fa6b2012-03-26 12:38:26 -07003022 }
Felipe Lemed8b94e52016-12-08 10:21:44 -08003023
3024 // Don't buffer stdout
3025 setvbuf(stdout, nullptr, _IONBF, 0);
3026
Rhed Jao5377d792020-07-16 17:37:39 +08003027 // Enable the parallel run if the client requests to output to a file.
3028 EnableParallelRunIfNeeded();
3029 // Using scope guard to make sure the dump pool can be shut down correctly.
3030 auto scope_guard_to_shutdown_pool = android::base::make_scope_guard([=]() {
3031 ShutdownDumpPool();
3032 });
3033
Felipe Leme608385d2016-02-01 10:35:38 -08003034 // NOTE: there should be no stdout output until now, otherwise it would break the header.
3035 // In particular, DurationReport objects should be created passing 'title, NULL', so their
Felipe Lemecbce55d2016-02-08 09:53:18 -08003036 // duration is logged into MYLOG instead.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003037 PrintHeader();
Colin Crossf45fa6b2012-03-26 12:38:26 -07003038
Gavin Corkery6968f552020-11-22 18:09:05 +00003039 bool is_dumpstate_restricted = options_->telephony_only
3040 || options_->wifi_only
3041 || options_->limited_only;
3042 if (!is_dumpstate_restricted) {
Paul Chang0d2aad72020-02-13 20:04:03 +08003043 // Invoke critical dumpsys first to preserve system state, before doing anything else.
Jichao Lie89d9c12019-11-21 19:02:51 -08003044 RunDumpsysCritical();
Gavin Corkery6968f552020-11-22 18:09:05 +00003045 }
3046 MaybeTakeEarlyScreenshot();
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003047
3048 if (!is_dumpstate_restricted) {
3049 // Snapshot the system trace now (if running) to avoid that dumpstate's
3050 // own activity pushes out interesting data from the trace ring buffer.
3051 // The trace file is added to the zip by MaybeAddSystemTraceToZip().
3052 MaybeSnapshotSystemTrace();
Yohei Yukawa95305b32021-03-09 07:54:27 -08003053
3054 // If a winscope trace is running, snapshot it now. It will be pulled into bugreport later
3055 // from WMTRACE_DATA_DIR.
3056 MaybeSnapshotWinTrace();
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003057 }
Gavin Corkery6968f552020-11-22 18:09:05 +00003058 onUiIntensiveBugreportDumpsFinished(calling_uid);
3059 MaybeCheckUserConsent(calling_uid, calling_package);
3060 if (options_->telephony_only) {
3061 DumpstateTelephonyOnly(calling_package);
3062 } else if (options_->wifi_only) {
3063 DumpstateWifiOnly();
3064 } else if (options_->limited_only) {
3065 DumpstateLimitedOnly();
3066 } else {
Nandana Dutt4be45d12018-09-26 15:04:23 +01003067 // Dump state for the default case. This also drops root.
Jichao Lie89d9c12019-11-21 19:02:51 -08003068 RunStatus s = DumpstateDefaultAfterCritical();
Nandana Dutt5c390032019-03-12 10:52:56 +00003069 if (s != RunStatus::OK) {
Nandana Duttaac6f582019-07-26 14:32:47 +01003070 if (s == RunStatus::USER_CONSENT_DENIED) {
Nandana Dutt5c390032019-03-12 10:52:56 +00003071 HandleUserConsentDenied();
3072 }
3073 return s;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08003074 }
Zhengyin Qian068ecc72016-08-10 16:48:14 -07003075 }
Felipe Leme71a74ac2016-03-17 15:43:25 -07003076
Felipe Leme55b42a62015-11-10 17:39:08 -08003077 /* close output if needed */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003078 TEMP_FAILURE_RETRY(dup2(dup_stdout_fd, fileno(stdout)));
Colin Crossf45fa6b2012-03-26 12:38:26 -07003079
Abhijeet Kaure370d682019-10-01 16:49:30 +01003080 // Zip the (now complete) .tmp file within the internal directory.
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003081 FinalizeFile();
Colin Crossf45fa6b2012-03-26 12:38:26 -07003082
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003083 // Share the final file with the caller if the user has consented or Shell is the caller.
Nandana Duttd2f5f082019-01-18 17:13:52 +00003084 Dumpstate::RunStatus status = Dumpstate::RunStatus::OK;
Abhijeet Kaure370d682019-10-01 16:49:30 +01003085 if (CalledByApi()) {
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003086 status = CopyBugreportIfUserConsented(calling_uid);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003087 if (status != Dumpstate::RunStatus::OK &&
3088 status != Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
3089 // Do an early return if there were errors. We make an exception for consent
3090 // timing out because it's possible the user got distracted. In this case the
3091 // bugreport is not shared but made available for manual retrieval.
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003092 MYLOGI("User denied consent. Returning\n");
Nandana Duttd2f5f082019-01-18 17:13:52 +00003093 return status;
3094 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003095 if (status == Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
3096 MYLOGI(
3097 "Did not receive user consent yet."
3098 " Will not copy the bugreport artifacts to caller.\n");
Abhijeet Kaur57627412019-04-17 16:00:09 +01003099 const String16 incidentcompanion("incidentcompanion");
3100 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
3101 if (ics != nullptr) {
3102 MYLOGD("Canceling user consent request via incidentcompanion service\n");
3103 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
3104 consent_callback_.get());
3105 } else {
3106 MYLOGD("Unable to cancel user consent; incidentcompanion service unavailable\n");
3107 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003108 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003109 }
3110
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08003111 /* vibrate a few but shortly times to let user know it's finished */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003112 if (options_->do_vibrate) {
Takuya Ogawa47f644e2017-12-20 18:09:09 +09003113 for (int i = 0; i < 3; i++) {
3114 Vibrate(75);
3115 usleep((75 + 50) * 1000);
3116 }
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08003117 }
3118
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003119 MYLOGD("Final progress: %d/%d (estimated %d)\n", progress_->Get(), progress_->GetMax(),
3120 progress_->GetInitialMax());
3121 progress_->Save();
3122 MYLOGI("done (id %d)\n", id_);
Colin Crossf45fa6b2012-03-26 12:38:26 -07003123
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003124 TEMP_FAILURE_RETRY(dup2(dup_stderr_fd, fileno(stderr)));
Felipe Leme107a05f2016-03-08 15:11:15 -08003125
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003126 if (control_socket_fd_ != -1) {
Felipe Lemee844a9d2016-09-21 15:01:39 -07003127 MYLOGD("Closing control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003128 close(control_socket_fd_);
Felipe Leme2628e9e2016-04-12 16:36:51 -07003129 }
3130
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003131 tombstone_data_.clear();
3132 anr_data_.clear();
Narayan Kamath6b9516c2017-10-27 11:15:51 +01003133
Nandana Duttd2f5f082019-01-18 17:13:52 +00003134 return (consent_callback_ != nullptr &&
3135 consent_callback_->getResult() == UserConsentResult::UNAVAILABLE)
3136 ? USER_CONSENT_TIMED_OUT
3137 : RunStatus::OK;
3138}
3139
Paul Chang0d2aad72020-02-13 20:04:03 +08003140void Dumpstate::MaybeTakeEarlyScreenshot() {
3141 if (!options_->do_screenshot || !do_early_screenshot_) {
3142 return;
3143 }
3144
3145 TakeScreenshot();
3146}
3147
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003148void Dumpstate::MaybeSnapshotSystemTrace() {
3149 // If a background system trace is happening and is marked as "suitable for
3150 // bugreport" (i.e. bugreport_score > 0 in the trace config), this command
3151 // will stop it and serialize into SYSTEM_TRACE_SNAPSHOT. In the (likely)
3152 // case that no trace is ongoing, this command is a no-op.
3153 // Note: this should not be enqueued as we need to freeze the trace before
3154 // dumpstate starts. Otherwise the trace ring buffers will contain mostly
3155 // the dumpstate's own activity which is irrelevant.
3156 int res = RunCommand(
3157 "SERIALIZE PERFETTO TRACE",
3158 {"perfetto", "--save-for-bugreport"},
3159 CommandOptions::WithTimeout(10)
3160 .DropRoot()
3161 .CloseAllFileDescriptorsOnExec()
3162 .Build());
3163 has_system_trace_ = res == 0;
3164 // MaybeAddSystemTraceToZip() will take care of copying the trace in the zip
3165 // file in the later stages.
3166}
3167
Yohei Yukawa95305b32021-03-09 07:54:27 -08003168void Dumpstate::MaybeSnapshotWinTrace() {
Yohei Yukawa02b1d2c2021-03-16 09:20:30 -07003169 // Currently WindowManagerService and InputMethodManagerSerivice support WinScope protocol.
3170 for (const auto& service : {"window", "input_method"}) {
3171 RunCommand(
3172 // Empty name because it's not intended to be classified as a bugreport section.
3173 // Actual tracing files can be found in "/data/misc/wmtrace/" in the bugreport.
3174 "", {"cmd", service, "tracing", "save-for-bugreport"},
3175 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3176 }
Yohei Yukawa95305b32021-03-09 07:54:27 -08003177}
3178
Paul Changeb4b4642020-05-28 22:05:47 +08003179void Dumpstate::onUiIntensiveBugreportDumpsFinished(int32_t calling_uid) {
Paul Changc490e662020-04-11 18:14:09 +08003180 if (calling_uid == AID_SHELL || !CalledByApi()) {
3181 return;
3182 }
3183 if (listener_ != nullptr) {
3184 // Let listener know ui intensive bugreport dumps are finished, then it can do event
3185 // handling if required.
Paul Changeb4b4642020-05-28 22:05:47 +08003186 listener_->onUiIntensiveBugreportDumpsFinished();
Paul Changc490e662020-04-11 18:14:09 +08003187 }
3188}
3189
Jichao Lie89d9c12019-11-21 19:02:51 -08003190void Dumpstate::MaybeCheckUserConsent(int32_t calling_uid, const std::string& calling_package) {
3191 if (calling_uid == AID_SHELL || !CalledByApi()) {
3192 // No need to get consent for shell triggered dumpstates, or not through
3193 // bugreporting API (i.e. no fd to copy back).
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003194 return;
3195 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003196 consent_callback_ = new ConsentCallback();
3197 const String16 incidentcompanion("incidentcompanion");
3198 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
Jichao Lie89d9c12019-11-21 19:02:51 -08003199 android::String16 package(calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003200 if (ics != nullptr) {
3201 MYLOGD("Checking user consent via incidentcompanion service\n");
3202 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
Jichao Lie89d9c12019-11-21 19:02:51 -08003203 calling_uid, package, String16(), String16(),
Joe Onorato1c36d752019-03-17 18:26:43 -07003204 0x1 /* FLAG_CONFIRMATION_DIALOG */, consent_callback_.get());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003205 } else {
3206 MYLOGD("Unable to check user consent; incidentcompanion service unavailable\n");
3207 }
3208}
3209
Nandana Dutt5c390032019-03-12 10:52:56 +00003210bool Dumpstate::IsUserConsentDenied() const {
3211 return ds.consent_callback_ != nullptr &&
3212 ds.consent_callback_->getResult() == UserConsentResult::DENIED;
3213}
3214
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01003215bool Dumpstate::CalledByApi() const {
3216 return ds.options_->bugreport_fd.get() != -1 ? true : false;
3217}
3218
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003219void Dumpstate::CleanupTmpFiles() {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003220 android::os::UnlinkAndLogOnError(tmp_path_);
3221 android::os::UnlinkAndLogOnError(screenshot_path_);
3222 android::os::UnlinkAndLogOnError(path_);
Gavin Corkery789d7a52021-02-24 23:52:35 +00003223 if (dump_traces_path != nullptr) {
3224 android::os::UnlinkAndLogOnError(dump_traces_path);
3225 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003226}
3227
Rhed Jao5377d792020-07-16 17:37:39 +08003228void Dumpstate::EnableParallelRunIfNeeded() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003229 if (!PropertiesHelper::IsParallelRun()) {
Rhed Jao5377d792020-07-16 17:37:39 +08003230 return;
3231 }
3232 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003233 zip_entry_tasks_ = std::make_unique<TaskQueue>();
Rhed Jao5377d792020-07-16 17:37:39 +08003234}
3235
3236void Dumpstate::ShutdownDumpPool() {
3237 if (dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08003238 dump_pool_.reset();
Rhed Jao5377d792020-07-16 17:37:39 +08003239 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003240 if (zip_entry_tasks_) {
3241 zip_entry_tasks_->run(/* do_cancel = */true);
3242 zip_entry_tasks_ = nullptr;
3243 }
3244}
3245
3246void Dumpstate::EnqueueAddZipEntryAndCleanupIfNeeded(const std::string& entry_name,
3247 const std::string& entry_path) {
3248 auto func_add_zip_entry_and_cleanup = [=](bool task_cancelled) {
3249 if (!task_cancelled) {
3250 AddZipEntry(entry_name, entry_path);
3251 }
3252 android::os::UnlinkAndLogOnError(entry_path);
3253 };
3254 if (zip_entry_tasks_) {
3255 // Enqueues AddZipEntryAndCleanup function if the parallel run is enabled.
3256 zip_entry_tasks_->add(func_add_zip_entry_and_cleanup, _1);
3257 } else {
3258 // Invokes AddZipEntryAndCleanup immediately
3259 std::invoke(func_add_zip_entry_and_cleanup, /* task_cancelled = */false);
3260 }
Rhed Jao5377d792020-07-16 17:37:39 +08003261}
3262
Nandana Duttd2f5f082019-01-18 17:13:52 +00003263Dumpstate::RunStatus Dumpstate::HandleUserConsentDenied() {
3264 MYLOGD("User denied consent; deleting files and returning\n");
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003265 CleanupTmpFiles();
Nandana Duttd2f5f082019-01-18 17:13:52 +00003266 return USER_CONSENT_DENIED;
3267}
3268
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003269Dumpstate::RunStatus Dumpstate::CopyBugreportIfUserConsented(int32_t calling_uid) {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003270 // If the caller has asked to copy the bugreport over to their directory, we need explicit
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003271 // user consent (unless the caller is Shell).
3272 UserConsentResult consent_result;
3273 if (calling_uid == AID_SHELL) {
3274 consent_result = UserConsentResult::APPROVED;
3275 } else {
3276 consent_result = consent_callback_->getResult();
3277 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003278 if (consent_result == UserConsentResult::UNAVAILABLE) {
3279 // User has not responded yet.
3280 uint64_t elapsed_ms = consent_callback_->getElapsedTimeMs();
Hunter Knepshield70610fa2020-01-03 15:27:33 -08003281 // Telephony is a fast report type, particularly on user builds where information may be
3282 // more aggressively limited. To give the user time to read the consent dialog, increase the
3283 // timeout.
3284 uint64_t timeout_ms = options_->telephony_only ? TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS
3285 : USER_CONSENT_TIMEOUT_MS;
3286 if (elapsed_ms < timeout_ms) {
3287 uint delay_seconds = (timeout_ms - elapsed_ms) / 1000;
Nandana Duttd2f5f082019-01-18 17:13:52 +00003288 MYLOGD("Did not receive user consent yet; going to wait for %d seconds", delay_seconds);
3289 sleep(delay_seconds);
3290 }
3291 consent_result = consent_callback_->getResult();
3292 }
3293 if (consent_result == UserConsentResult::DENIED) {
3294 // User has explicitly denied sharing with the app. To be safe delete the
3295 // internal bugreport & tmp files.
3296 return HandleUserConsentDenied();
3297 }
3298 if (consent_result == UserConsentResult::APPROVED) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00003299 bool copy_succeeded = android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
3300 if (copy_succeeded) {
3301 android::os::UnlinkAndLogOnError(path_);
Abhijeet Kaur9ce94672020-04-01 17:22:36 +01003302 if (options_->do_screenshot &&
3303 options_->screenshot_fd.get() != -1 &&
3304 !options_->is_screenshot_copied) {
3305 copy_succeeded = android::os::CopyFileToFd(screenshot_path_,
3306 options_->screenshot_fd.get());
3307 options_->is_screenshot_copied = copy_succeeded;
3308 if (copy_succeeded) {
3309 android::os::UnlinkAndLogOnError(screenshot_path_);
3310 }
3311 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003312 }
3313 return copy_succeeded ? Dumpstate::RunStatus::OK : Dumpstate::RunStatus::ERROR;
3314 } else if (consent_result == UserConsentResult::UNAVAILABLE) {
3315 // consent_result is still UNAVAILABLE. The user has likely not responded yet.
3316 // Since we do not have user consent to share the bugreport it does not get
3317 // copied over to the calling app but remains in the internal directory from
3318 // where the user can manually pull it.
Paul Changce644212021-05-11 16:06:45 +08003319 std::string final_path = GetPath(".zip");
3320 bool copy_succeeded = android::os::CopyFileToFile(path_, final_path);
3321 if (copy_succeeded) {
3322 android::os::UnlinkAndLogOnError(path_);
3323 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003324 return Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT;
3325 }
3326 // Unknown result; must be a programming error.
3327 MYLOGE("Unknown user consent result:%d\n", consent_result);
3328 return Dumpstate::RunStatus::ERROR;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003329}
3330
Nandana Duttf02564e2019-02-15 15:24:24 +00003331Dumpstate::RunStatus Dumpstate::ParseCommandlineAndRun(int argc, char* argv[]) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003332 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
3333 Dumpstate::RunStatus status = options->Initialize(argc, argv);
3334 if (status == Dumpstate::RunStatus::OK) {
Nandana Duttf02564e2019-02-15 15:24:24 +00003335 SetOptions(std::move(options));
Nandana Duttd2f5f082019-01-18 17:13:52 +00003336 // When directly running dumpstate binary, the output is not expected to be written
3337 // to any external file descriptor.
Nandana Duttf02564e2019-02-15 15:24:24 +00003338 assert(options_->bugreport_fd.get() == -1);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003339
3340 // calling_uid and calling_package are for user consent to share the bugreport with
Abhijeet Kaura407fb82020-03-27 12:51:12 +00003341 // an app; they are irrelevant here because bugreport is triggered via command line.
3342 // Update Last ID before calling Run().
3343 Initialize();
Nandana Duttf02564e2019-02-15 15:24:24 +00003344 status = Run(-1 /* calling_uid */, "" /* calling_package */);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003345 }
Nandana Duttf02564e2019-02-15 15:24:24 +00003346 return status;
3347}
3348
3349/* Main entry point for dumpstate binary. */
3350int run_main(int argc, char* argv[]) {
3351 Dumpstate::RunStatus status = ds.ParseCommandlineAndRun(argc, argv);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003352
3353 switch (status) {
3354 case Dumpstate::RunStatus::OK:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003355 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003356 case Dumpstate::RunStatus::HELP:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003357 ShowUsage();
3358 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003359 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003360 fprintf(stderr, "Invalid combination of args\n");
3361 ShowUsage();
3362 exit(1);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003363 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00003364 FALLTHROUGH_INTENDED;
3365 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
3366 FALLTHROUGH_INTENDED;
3367 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003368 exit(2);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003369 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003370}
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003371
3372// TODO(111441001): Default DumpOptions to sensible values.
3373Dumpstate::Dumpstate(const std::string& version)
3374 : pid_(getpid()),
3375 options_(new Dumpstate::DumpOptions()),
Nandana Dutt402a8392019-06-14 14:25:13 +01003376 last_reported_percent_progress_(0),
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003377 version_(version),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003378 now_(time(nullptr)),
3379 open_socket_fn_(open_socket) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003380}
3381
3382Dumpstate& Dumpstate::GetInstance() {
3383 static Dumpstate singleton_(android::base::GetProperty("dumpstate.version", VERSION_CURRENT));
3384 return singleton_;
3385}
3386
Rhed Jao5377d792020-07-16 17:37:39 +08003387DurationReporter::DurationReporter(const std::string& title, bool logcat_only, bool verbose,
3388 int duration_fd) : title_(title), logcat_only_(logcat_only), verbose_(verbose),
3389 duration_fd_(duration_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003390 if (!title_.empty()) {
3391 started_ = Nanotime();
3392 }
3393}
3394
3395DurationReporter::~DurationReporter() {
3396 if (!title_.empty()) {
3397 float elapsed = (float)(Nanotime() - started_) / NANOS_PER_SEC;
chenqiwuaf8b2d92019-12-12 18:53:51 +08003398 if (elapsed >= .5f || verbose_) {
3399 MYLOGD("Duration of '%s': %.2fs\n", title_.c_str(), elapsed);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003400 }
chenqiwuaf8b2d92019-12-12 18:53:51 +08003401 if (!logcat_only_) {
3402 // Use "Yoda grammar" to make it easier to grep|sort sections.
Rhed Jao5377d792020-07-16 17:37:39 +08003403 dprintf(duration_fd_, "------ %.3fs was the duration of '%s' ------\n",
3404 elapsed, title_.c_str());
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003405 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003406 }
3407}
3408
3409const int32_t Progress::kDefaultMax = 5000;
3410
3411Progress::Progress(const std::string& path) : Progress(Progress::kDefaultMax, 1.1, path) {
3412}
3413
3414Progress::Progress(int32_t initial_max, int32_t progress, float growth_factor)
3415 : Progress(initial_max, growth_factor, "") {
3416 progress_ = progress;
3417}
3418
3419Progress::Progress(int32_t initial_max, float growth_factor, const std::string& path)
3420 : initial_max_(initial_max),
3421 progress_(0),
3422 max_(initial_max),
3423 growth_factor_(growth_factor),
3424 n_runs_(0),
3425 average_max_(0),
3426 path_(path) {
3427 if (!path_.empty()) {
3428 Load();
3429 }
3430}
3431
3432void Progress::Load() {
3433 MYLOGD("Loading stats from %s\n", path_.c_str());
3434 std::string content;
3435 if (!android::base::ReadFileToString(path_, &content)) {
3436 MYLOGI("Could not read stats from %s; using max of %d\n", path_.c_str(), max_);
3437 return;
3438 }
3439 if (content.empty()) {
3440 MYLOGE("No stats (empty file) on %s; using max of %d\n", path_.c_str(), max_);
3441 return;
3442 }
3443 std::vector<std::string> lines = android::base::Split(content, "\n");
3444
3445 if (lines.size() < 1) {
3446 MYLOGE("Invalid stats on file %s: not enough lines (%d). Using max of %d\n", path_.c_str(),
3447 (int)lines.size(), max_);
3448 return;
3449 }
3450 char* ptr;
3451 n_runs_ = strtol(lines[0].c_str(), &ptr, 10);
3452 average_max_ = strtol(ptr, nullptr, 10);
3453 if (n_runs_ <= 0 || average_max_ <= 0 || n_runs_ > STATS_MAX_N_RUNS ||
3454 average_max_ > STATS_MAX_AVERAGE) {
3455 MYLOGE("Invalid stats line on file %s: %s\n", path_.c_str(), lines[0].c_str());
3456 initial_max_ = Progress::kDefaultMax;
3457 } else {
3458 initial_max_ = average_max_;
3459 }
3460 max_ = initial_max_;
3461
3462 MYLOGI("Average max progress: %d in %d runs; estimated max: %d\n", average_max_, n_runs_, max_);
3463}
3464
3465void Progress::Save() {
3466 int32_t total = n_runs_ * average_max_ + progress_;
3467 int32_t runs = n_runs_ + 1;
3468 int32_t average = floor(((float)total) / runs);
3469 MYLOGI("Saving stats (total=%d, runs=%d, average=%d) on %s\n", total, runs, average,
3470 path_.c_str());
3471 if (path_.empty()) {
3472 return;
3473 }
3474
3475 std::string content = android::base::StringPrintf("%d %d\n", runs, average);
3476 if (!android::base::WriteStringToFile(content, path_)) {
3477 MYLOGE("Could not save stats on %s\n", path_.c_str());
3478 }
3479}
3480
3481int32_t Progress::Get() const {
3482 return progress_;
3483}
3484
3485bool Progress::Inc(int32_t delta_sec) {
3486 bool changed = false;
3487 if (delta_sec >= 0) {
3488 progress_ += delta_sec;
3489 if (progress_ > max_) {
3490 int32_t old_max = max_;
3491 max_ = floor((float)progress_ * growth_factor_);
3492 MYLOGD("Adjusting max progress from %d to %d\n", old_max, max_);
3493 changed = true;
3494 }
3495 }
3496 return changed;
3497}
3498
3499int32_t Progress::GetMax() const {
3500 return max_;
3501}
3502
3503int32_t Progress::GetInitialMax() const {
3504 return initial_max_;
3505}
3506
3507void Progress::Dump(int fd, const std::string& prefix) const {
3508 const char* pr = prefix.c_str();
3509 dprintf(fd, "%sprogress: %d\n", pr, progress_);
3510 dprintf(fd, "%smax: %d\n", pr, max_);
3511 dprintf(fd, "%sinitial_max: %d\n", pr, initial_max_);
3512 dprintf(fd, "%sgrowth_factor: %0.2f\n", pr, growth_factor_);
3513 dprintf(fd, "%spath: %s\n", pr, path_.c_str());
3514 dprintf(fd, "%sn_runs: %d\n", pr, n_runs_);
3515 dprintf(fd, "%saverage_max: %d\n", pr, average_max_);
3516}
3517
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003518std::string Dumpstate::GetPath(const std::string& suffix) const {
3519 return GetPath(bugreport_internal_dir_, suffix);
3520}
3521
3522std::string Dumpstate::GetPath(const std::string& directory, const std::string& suffix) const {
3523 return android::base::StringPrintf("%s/%s-%s%s", directory.c_str(), base_name_.c_str(),
3524 name_.c_str(), suffix.c_str());
3525}
3526
3527void Dumpstate::SetProgress(std::unique_ptr<Progress> progress) {
3528 progress_ = std::move(progress);
3529}
3530
3531void for_each_userid(void (*func)(int), const char *header) {
3532 std::string title = header == nullptr ? "for_each_userid" : android::base::StringPrintf(
3533 "for_each_userid(%s)", header);
3534 DurationReporter duration_reporter(title);
3535 if (PropertiesHelper::IsDryRun()) return;
3536
3537 DIR *d;
3538 struct dirent *de;
3539
3540 if (header) printf("\n------ %s ------\n", header);
3541 func(0);
3542
3543 if (!(d = opendir("/data/system/users"))) {
3544 printf("Failed to open /data/system/users (%s)\n", strerror(errno));
3545 return;
3546 }
3547
3548 while ((de = readdir(d))) {
3549 int userid;
3550 if (de->d_type != DT_DIR || !(userid = atoi(de->d_name))) {
3551 continue;
3552 }
3553 func(userid);
3554 }
3555
3556 closedir(d);
3557}
3558
3559static void __for_each_pid(void (*helper)(int, const char *, void *), const char *header, void *arg) {
3560 DIR *d;
3561 struct dirent *de;
3562
3563 if (!(d = opendir("/proc"))) {
3564 printf("Failed to open /proc (%s)\n", strerror(errno));
3565 return;
3566 }
3567
3568 if (header) printf("\n------ %s ------\n", header);
3569 while ((de = readdir(d))) {
3570 if (ds.IsUserConsentDenied()) {
3571 MYLOGE(
3572 "Returning early because user denied consent to share bugreport with calling app.");
3573 closedir(d);
3574 return;
3575 }
3576 int pid;
3577 int fd;
3578 char cmdpath[255];
3579 char cmdline[255];
3580
3581 if (!(pid = atoi(de->d_name))) {
3582 continue;
3583 }
3584
3585 memset(cmdline, 0, sizeof(cmdline));
3586
3587 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/cmdline", pid);
3588 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3589 TEMP_FAILURE_RETRY(read(fd, cmdline, sizeof(cmdline) - 2));
3590 close(fd);
3591 if (cmdline[0]) {
3592 helper(pid, cmdline, arg);
3593 continue;
3594 }
3595 }
3596
3597 // if no cmdline, a kernel thread has comm
3598 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/comm", pid);
3599 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3600 TEMP_FAILURE_RETRY(read(fd, cmdline + 1, sizeof(cmdline) - 4));
3601 close(fd);
3602 if (cmdline[1]) {
3603 cmdline[0] = '[';
3604 size_t len = strcspn(cmdline, "\f\b\r\n");
3605 cmdline[len] = ']';
3606 cmdline[len+1] = '\0';
3607 }
3608 }
3609 if (!cmdline[0]) {
3610 strcpy(cmdline, "N/A");
3611 }
3612 helper(pid, cmdline, arg);
3613 }
3614
3615 closedir(d);
3616}
3617
3618static void for_each_pid_helper(int pid, const char *cmdline, void *arg) {
3619 for_each_pid_func *func = (for_each_pid_func*) arg;
3620 func(pid, cmdline);
3621}
3622
3623void for_each_pid(for_each_pid_func func, const char *header) {
3624 std::string title = header == nullptr ? "for_each_pid"
3625 : android::base::StringPrintf("for_each_pid(%s)", header);
3626 DurationReporter duration_reporter(title);
3627 if (PropertiesHelper::IsDryRun()) return;
3628
3629 __for_each_pid(for_each_pid_helper, header, (void *) func);
3630}
3631
3632static void for_each_tid_helper(int pid, const char *cmdline, void *arg) {
3633 DIR *d;
3634 struct dirent *de;
3635 char taskpath[255];
3636 for_each_tid_func *func = (for_each_tid_func *) arg;
3637
3638 snprintf(taskpath, sizeof(taskpath), "/proc/%d/task", pid);
3639
3640 if (!(d = opendir(taskpath))) {
3641 printf("Failed to open %s (%s)\n", taskpath, strerror(errno));
3642 return;
3643 }
3644
3645 func(pid, pid, cmdline);
3646
3647 while ((de = readdir(d))) {
3648 if (ds.IsUserConsentDenied()) {
3649 MYLOGE(
3650 "Returning early because user denied consent to share bugreport with calling app.");
3651 closedir(d);
3652 return;
3653 }
3654 int tid;
3655 int fd;
3656 char commpath[255];
3657 char comm[255];
3658
3659 if (!(tid = atoi(de->d_name))) {
3660 continue;
3661 }
3662
3663 if (tid == pid)
3664 continue;
3665
3666 snprintf(commpath, sizeof(commpath), "/proc/%d/comm", tid);
3667 memset(comm, 0, sizeof(comm));
3668 if ((fd = TEMP_FAILURE_RETRY(open(commpath, O_RDONLY | O_CLOEXEC))) < 0) {
3669 strcpy(comm, "N/A");
3670 } else {
3671 char *c;
3672 TEMP_FAILURE_RETRY(read(fd, comm, sizeof(comm) - 2));
3673 close(fd);
3674
3675 c = strrchr(comm, '\n');
3676 if (c) {
3677 *c = '\0';
3678 }
3679 }
3680 func(pid, tid, comm);
3681 }
3682
3683 closedir(d);
3684}
3685
3686void for_each_tid(for_each_tid_func func, const char *header) {
3687 std::string title = header == nullptr ? "for_each_tid"
3688 : android::base::StringPrintf("for_each_tid(%s)", header);
3689 DurationReporter duration_reporter(title);
3690
3691 if (PropertiesHelper::IsDryRun()) return;
3692
3693 __for_each_pid(for_each_tid_helper, header, (void *) func);
3694}
3695
3696void show_wchan(int pid, int tid, const char *name) {
3697 if (PropertiesHelper::IsDryRun()) return;
3698
3699 char path[255];
3700 char buffer[255];
3701 int fd, ret, save_errno;
3702 char name_buffer[255];
3703
3704 memset(buffer, 0, sizeof(buffer));
3705
3706 snprintf(path, sizeof(path), "/proc/%d/wchan", tid);
3707 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3708 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3709 return;
3710 }
3711
3712 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3713 save_errno = errno;
3714 close(fd);
3715
3716 if (ret < 0) {
3717 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3718 return;
3719 }
3720
3721 snprintf(name_buffer, sizeof(name_buffer), "%*s%s",
3722 pid == tid ? 0 : 3, "", name);
3723
3724 printf("%-7d %-32s %s\n", tid, name_buffer, buffer);
3725
3726 return;
3727}
3728
3729// print time in centiseconds
3730static void snprcent(char *buffer, size_t len, size_t spc,
3731 unsigned long long time) {
3732 static long hz; // cache discovered hz
3733
3734 if (hz <= 0) {
3735 hz = sysconf(_SC_CLK_TCK);
3736 if (hz <= 0) {
3737 hz = 1000;
3738 }
3739 }
3740
3741 // convert to centiseconds
3742 time = (time * 100 + (hz / 2)) / hz;
3743
3744 char str[16];
3745
3746 snprintf(str, sizeof(str), " %llu.%02u",
3747 time / 100, (unsigned)(time % 100));
3748 size_t offset = strlen(buffer);
3749 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3750 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3751}
3752
3753// print permille as a percent
3754static void snprdec(char *buffer, size_t len, size_t spc, unsigned permille) {
3755 char str[16];
3756
3757 snprintf(str, sizeof(str), " %u.%u%%", permille / 10, permille % 10);
3758 size_t offset = strlen(buffer);
3759 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3760 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3761}
3762
3763void show_showtime(int pid, const char *name) {
3764 if (PropertiesHelper::IsDryRun()) return;
3765
3766 char path[255];
3767 char buffer[1023];
3768 int fd, ret, save_errno;
3769
3770 memset(buffer, 0, sizeof(buffer));
3771
3772 snprintf(path, sizeof(path), "/proc/%d/stat", pid);
3773 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3774 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3775 return;
3776 }
3777
3778 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3779 save_errno = errno;
3780 close(fd);
3781
3782 if (ret < 0) {
3783 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3784 return;
3785 }
3786
3787 // field 14 is utime
3788 // field 15 is stime
3789 // field 42 is iotime
3790 unsigned long long utime = 0, stime = 0, iotime = 0;
3791 if (sscanf(buffer,
3792 "%*u %*s %*s %*d %*d %*d %*d %*d %*d %*d %*d "
3793 "%*d %*d %llu %llu %*d %*d %*d %*d %*d %*d "
3794 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %*d "
3795 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %llu ",
3796 &utime, &stime, &iotime) != 3) {
3797 return;
3798 }
3799
3800 unsigned long long total = utime + stime;
3801 if (!total) {
3802 return;
3803 }
3804
3805 unsigned permille = (iotime * 1000 + (total / 2)) / total;
3806 if (permille > 1000) {
3807 permille = 1000;
3808 }
3809
3810 // try to beautify and stabilize columns at <80 characters
3811 snprintf(buffer, sizeof(buffer), "%-6d%s", pid, name);
3812 if ((name[0] != '[') || utime) {
3813 snprcent(buffer, sizeof(buffer), 57, utime);
3814 }
3815 snprcent(buffer, sizeof(buffer), 65, stime);
3816 if ((name[0] != '[') || iotime) {
3817 snprcent(buffer, sizeof(buffer), 73, iotime);
3818 }
3819 if (iotime) {
3820 snprdec(buffer, sizeof(buffer), 79, permille);
3821 }
3822 puts(buffer); // adds a trailing newline
3823
3824 return;
3825}
3826
3827void do_dmesg() {
3828 const char *title = "KERNEL LOG (dmesg)";
3829 DurationReporter duration_reporter(title);
3830 printf("------ %s ------\n", title);
3831
3832 if (PropertiesHelper::IsDryRun()) return;
3833
3834 /* Get size of kernel buffer */
3835 int size = klogctl(KLOG_SIZE_BUFFER, nullptr, 0);
3836 if (size <= 0) {
3837 printf("Unexpected klogctl return value: %d\n\n", size);
3838 return;
3839 }
3840 char *buf = (char *) malloc(size + 1);
3841 if (buf == nullptr) {
3842 printf("memory allocation failed\n\n");
3843 return;
3844 }
3845 int retval = klogctl(KLOG_READ_ALL, buf, size);
3846 if (retval < 0) {
3847 printf("klogctl failure\n\n");
3848 free(buf);
3849 return;
3850 }
3851 buf[retval] = '\0';
3852 printf("%s\n\n", buf);
3853 free(buf);
3854 return;
3855}
3856
3857void do_showmap(int pid, const char *name) {
3858 char title[255];
3859 char arg[255];
3860
3861 snprintf(title, sizeof(title), "SHOW MAP %d (%s)", pid, name);
3862 snprintf(arg, sizeof(arg), "%d", pid);
3863 RunCommand(title, {"showmap", "-q", arg}, CommandOptions::AS_ROOT);
3864}
3865
3866int Dumpstate::DumpFile(const std::string& title, const std::string& path) {
3867 DurationReporter duration_reporter(title);
3868
3869 int status = DumpFileToFd(STDOUT_FILENO, title, path);
3870
3871 UpdateProgress(WEIGHT_FILE);
3872
3873 return status;
3874}
3875
3876int read_file_as_long(const char *path, long int *output) {
3877 int fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC));
3878 if (fd < 0) {
3879 int err = errno;
3880 MYLOGE("Error opening file descriptor for %s: %s\n", path, strerror(err));
3881 return -1;
3882 }
3883 char buffer[50];
3884 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3885 if (bytes_read == -1) {
3886 MYLOGE("Error reading file %s: %s\n", path, strerror(errno));
3887 return -2;
3888 }
3889 if (bytes_read == 0) {
3890 MYLOGE("File %s is empty\n", path);
3891 return -3;
3892 }
3893 *output = atoi(buffer);
3894 return 0;
3895}
3896
3897/* calls skip to gate calling dump_from_fd recursively
3898 * in the specified directory. dump_from_fd defaults to
3899 * dump_file_from_fd above when set to NULL. skip defaults
3900 * to false when set to NULL. dump_from_fd will always be
3901 * called with title NULL.
3902 */
3903int dump_files(const std::string& title, const char* dir, bool (*skip)(const char* path),
3904 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
3905 DurationReporter duration_reporter(title);
3906 DIR *dirp;
3907 struct dirent *d;
3908 char *newpath = nullptr;
3909 const char *slash = "/";
3910 int retval = 0;
3911
3912 if (!title.empty()) {
3913 printf("------ %s (%s) ------\n", title.c_str(), dir);
3914 }
3915 if (PropertiesHelper::IsDryRun()) return 0;
3916
3917 if (dir[strlen(dir) - 1] == '/') {
3918 ++slash;
3919 }
3920 dirp = opendir(dir);
3921 if (dirp == nullptr) {
3922 retval = -errno;
3923 MYLOGE("%s: %s\n", dir, strerror(errno));
3924 return retval;
3925 }
3926
3927 if (!dump_from_fd) {
3928 dump_from_fd = dump_file_from_fd;
3929 }
3930 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
3931 if ((d->d_name[0] == '.')
3932 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
3933 || (d->d_name[1] == '\0'))) {
3934 continue;
3935 }
3936 asprintf(&newpath, "%s%s%s%s", dir, slash, d->d_name,
3937 (d->d_type == DT_DIR) ? "/" : "");
3938 if (!newpath) {
3939 retval = -errno;
3940 continue;
3941 }
3942 if (skip && (*skip)(newpath)) {
3943 continue;
3944 }
3945 if (d->d_type == DT_DIR) {
3946 int ret = dump_files("", newpath, skip, dump_from_fd);
3947 if (ret < 0) {
3948 retval = ret;
3949 }
3950 continue;
3951 }
3952 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(newpath, O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
3953 if (fd.get() < 0) {
3954 retval = -1;
3955 printf("*** %s: %s\n", newpath, strerror(errno));
3956 continue;
3957 }
3958 (*dump_from_fd)(nullptr, newpath, fd.get());
3959 }
3960 closedir(dirp);
3961 if (!title.empty()) {
3962 printf("\n");
3963 }
3964 return retval;
3965}
3966
3967/* fd must have been opened with the flag O_NONBLOCK. With this flag set,
3968 * it's possible to avoid issues where opening the file itself can get
3969 * stuck.
3970 */
3971int dump_file_from_fd(const char *title, const char *path, int fd) {
3972 if (PropertiesHelper::IsDryRun()) return 0;
3973
3974 int flags = fcntl(fd, F_GETFL);
3975 if (flags == -1) {
3976 printf("*** %s: failed to get flags on fd %d: %s\n", path, fd, strerror(errno));
3977 return -1;
3978 } else if (!(flags & O_NONBLOCK)) {
3979 printf("*** %s: fd must have O_NONBLOCK set.\n", path);
3980 return -1;
3981 }
3982 return DumpFileFromFdToFd(title, path, fd, STDOUT_FILENO, PropertiesHelper::IsDryRun());
3983}
3984
3985int Dumpstate::RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003986 const CommandOptions& options, bool verbose_duration, int out_fd) {
3987 DurationReporter duration_reporter(title, false /* logcat_only */,
3988 verbose_duration, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003989
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003990 int status = RunCommandToFd(out_fd, title, full_command, options);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003991
3992 /* TODO: for now we're simplifying the progress calculation by using the
3993 * timeout as the weight. It's a good approximation for most cases, except when calling dumpsys,
3994 * where its weight should be much higher proportionally to its timeout.
3995 * Ideally, it should use a options.EstimatedDuration() instead...*/
3996 UpdateProgress(options.Timeout());
3997
3998 return status;
3999}
4000
4001void Dumpstate::RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsys_args,
Rhed Jaoe017f982020-07-21 17:58:41 +08004002 const CommandOptions& options, long dumpsysTimeoutMs, int out_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004003 long timeout_ms = dumpsysTimeoutMs > 0 ? dumpsysTimeoutMs : options.TimeoutInMs();
4004 std::vector<std::string> dumpsys = {"/system/bin/dumpsys", "-T", std::to_string(timeout_ms)};
4005 dumpsys.insert(dumpsys.end(), dumpsys_args.begin(), dumpsys_args.end());
Rhed Jaoe017f982020-07-21 17:58:41 +08004006 RunCommand(title, dumpsys, options, false, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004007}
4008
Dieter Hsu105ad0c2020-09-29 15:23:33 +08004009static int open_socket(const char* service) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004010 int s = android_get_control_socket(service);
4011 if (s < 0) {
4012 MYLOGE("android_get_control_socket(%s): %s\n", service, strerror(errno));
4013 return -1;
4014 }
4015 fcntl(s, F_SETFD, FD_CLOEXEC);
4016
4017 // Set backlog to 0 to make sure that queue size will be minimum.
4018 // In Linux, because the minimum queue will be 1, connect() will be blocked
4019 // if the other clients already called connect() and the connection request was not accepted.
4020 if (listen(s, 0) < 0) {
4021 MYLOGE("listen(control socket): %s\n", strerror(errno));
4022 return -1;
4023 }
4024
4025 struct sockaddr addr;
4026 socklen_t alen = sizeof(addr);
Abhijeet Kaur2113cae2019-09-13 09:24:15 +01004027 int fd = accept4(s, &addr, &alen, SOCK_CLOEXEC);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004028
4029 // Close socket just after accept(), to make sure that connect() by client will get error
4030 // when the socket is used by the other services.
4031 // There is still a race condition possibility between accept and close, but there is no way
4032 // to close-on-accept atomically.
4033 // See detail; b/123306389#comment25
4034 close(s);
4035
4036 if (fd < 0) {
4037 MYLOGE("accept(control socket): %s\n", strerror(errno));
4038 return -1;
4039 }
4040
4041 return fd;
4042}
4043
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004044// TODO: should call is_valid_output_file and/or be merged into it.
4045void create_parent_dirs(const char *path) {
4046 char *chp = const_cast<char *> (path);
4047
4048 /* skip initial slash */
4049 if (chp[0] == '/')
4050 chp++;
4051
4052 /* create leading directories, if necessary */
4053 struct stat dir_stat;
4054 while (chp && chp[0]) {
4055 chp = strchr(chp, '/');
4056 if (chp) {
4057 *chp = 0;
4058 if (stat(path, &dir_stat) == -1 || !S_ISDIR(dir_stat.st_mode)) {
4059 MYLOGI("Creating directory %s\n", path);
4060 if (mkdir(path, 0770)) { /* drwxrwx--- */
4061 MYLOGE("Unable to create directory %s: %s\n", path, strerror(errno));
4062 } else if (chown(path, AID_SHELL, AID_SHELL)) {
4063 MYLOGE("Unable to change ownership of dir %s: %s\n", path, strerror(errno));
4064 }
4065 }
4066 *chp++ = '/';
4067 }
4068 }
4069}
4070
4071bool _redirect_to_file(FILE* redirect, char* path, int truncate_flag) {
4072 create_parent_dirs(path);
4073
4074 int fd = TEMP_FAILURE_RETRY(open(path,
4075 O_WRONLY | O_CREAT | truncate_flag | O_CLOEXEC | O_NOFOLLOW,
4076 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH));
4077 if (fd < 0) {
4078 MYLOGE("%s: %s\n", path, strerror(errno));
4079 return false;
4080 }
4081
4082 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
4083 close(fd);
4084 return true;
4085}
4086
4087bool redirect_to_file(FILE* redirect, char* path) {
4088 return _redirect_to_file(redirect, path, O_TRUNC);
4089}
4090
4091bool redirect_to_existing_file(FILE* redirect, char* path) {
4092 return _redirect_to_file(redirect, path, O_APPEND);
4093}
4094
4095void dump_route_tables() {
4096 DurationReporter duration_reporter("DUMP ROUTE TABLES");
4097 if (PropertiesHelper::IsDryRun()) return;
4098 const char* const RT_TABLES_PATH = "/data/misc/net/rt_tables";
4099 ds.DumpFile("RT_TABLES", RT_TABLES_PATH);
4100 FILE* fp = fopen(RT_TABLES_PATH, "re");
4101 if (!fp) {
4102 printf("*** %s: %s\n", RT_TABLES_PATH, strerror(errno));
4103 return;
4104 }
4105 char table[16];
4106 // Each line has an integer (the table number), a space, and a string (the table name). We only
4107 // need the table number. It's a 32-bit unsigned number, so max 10 chars. Skip the table name.
4108 // Add a fixed max limit so this doesn't go awry.
4109 for (int i = 0; i < 64 && fscanf(fp, " %10s %*s", table) == 1; ++i) {
4110 RunCommand("ROUTE TABLE IPv4", {"ip", "-4", "route", "show", "table", table});
4111 RunCommand("ROUTE TABLE IPv6", {"ip", "-6", "route", "show", "table", table});
4112 }
4113 fclose(fp);
4114}
4115
Li Li830179f2022-01-04 12:53:29 -08004116void dump_frozen_cgroupfs(const char *dir, int level,
4117 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
4118 DIR *dirp;
4119 struct dirent *d;
4120 char *newpath = nullptr;
4121
4122 dirp = opendir(dir);
4123 if (dirp == nullptr) {
4124 MYLOGE("%s: %s\n", dir, strerror(errno));
4125 return;
4126 }
4127
4128 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
4129 if ((d->d_name[0] == '.')
4130 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
4131 || (d->d_name[1] == '\0'))) {
4132 continue;
4133 }
4134 if (d->d_type == DT_DIR) {
4135 asprintf(&newpath, "%s/%s/", dir, d->d_name);
4136 if (!newpath) {
4137 continue;
4138 }
4139 if (level == 0 && !strncmp(d->d_name, "uid_", 4)) {
4140 dump_frozen_cgroupfs(newpath, 1, dump_from_fd);
4141 } else if (level == 1 && !strncmp(d->d_name, "pid_", 4)) {
4142 char *freezer = nullptr;
4143 asprintf(&freezer, "%s/%s", newpath, "cgroup.freeze");
4144 if (freezer) {
4145 FILE* fp = fopen(freezer, "r");
4146 if (fp != NULL) {
4147 int frozen;
4148 fscanf(fp, "%d", &frozen);
4149 if (frozen > 0) {
4150 dump_files("", newpath, skip_none, dump_from_fd);
4151 }
4152 fclose(fp);
4153 }
4154 free(freezer);
4155 }
4156 }
4157 }
4158 }
4159 closedir(dirp);
4160}
4161
4162void dump_frozen_cgroupfs() {
Li Li830179f2022-01-04 12:53:29 -08004163 MYLOGD("Adding frozen processes from %s\n", CGROUPFS_DIR);
4164 DurationReporter duration_reporter("FROZEN CGROUPFS");
4165 if (PropertiesHelper::IsDryRun()) return;
4166 dump_frozen_cgroupfs(CGROUPFS_DIR, 0, _add_file_from_fd);
4167}
4168
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004169void Dumpstate::UpdateProgress(int32_t delta_sec) {
4170 if (progress_ == nullptr) {
4171 MYLOGE("UpdateProgress: progress_ not set\n");
4172 return;
4173 }
Rhed Jaobf63d8a2020-07-21 15:42:55 +08004174 // This function updates progress related members of the dumpstate and reports
4175 // progress percentage to the bugreport client. Since it could be called by
4176 // different dump tasks at the same time if the parallel run is enabled, a
4177 // mutex lock is necessary here to synchronize the call.
4178 std::lock_guard<std::recursive_mutex> lock(mutex_);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004179
4180 // Always update progess so stats can be tuned...
Nandana Dutt402a8392019-06-14 14:25:13 +01004181 progress_->Inc(delta_sec);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004182
4183 // ...but only notifiy listeners when necessary.
4184 if (!options_->do_progress_updates) return;
4185
4186 int progress = progress_->Get();
4187 int max = progress_->GetMax();
Nandana Dutt402a8392019-06-14 14:25:13 +01004188 int percent = 100 * progress / max;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004189
Nandana Dutt402a8392019-06-14 14:25:13 +01004190 if (last_reported_percent_progress_ > 0 && percent <= last_reported_percent_progress_) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004191 return;
4192 }
Nandana Dutt402a8392019-06-14 14:25:13 +01004193 last_reported_percent_progress_ = percent;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004194
4195 if (control_socket_fd_ >= 0) {
4196 dprintf(control_socket_fd_, "PROGRESS:%d/%d\n", progress, max);
4197 fsync(control_socket_fd_);
4198 }
4199
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004200 if (listener_ != nullptr) {
Nandana Dutt235c6672019-11-14 15:22:32 +00004201 if (percent % 10 == 0) {
4202 // We don't want to spam logcat, so only log multiples of 10.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004203 MYLOGD("Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004204 } else {
4205 // stderr is ignored on normal invocations, but useful when calling
4206 // /system/bin/dumpstate directly for debuggging.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004207 fprintf(stderr, "Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004208 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004209
4210 listener_->onProgress(percent);
4211 }
4212}
4213
4214void Dumpstate::TakeScreenshot(const std::string& path) {
4215 const std::string& real_path = path.empty() ? screenshot_path_ : path;
4216 int status =
4217 RunCommand("", {"/system/bin/screencap", "-p", real_path},
4218 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
4219 if (status == 0) {
4220 MYLOGD("Screenshot saved on %s\n", real_path.c_str());
4221 } else {
4222 MYLOGE("Failed to take screenshot on %s\n", real_path.c_str());
4223 }
Paul Chang0d2aad72020-02-13 20:04:03 +08004224 if (listener_ != nullptr) {
4225 // Show a visual indication to indicate screenshot is taken via
4226 // IDumpstateListener.onScreenshotTaken()
4227 listener_->onScreenshotTaken(status == 0);
4228 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004229}
4230
4231bool is_dir(const char* pathname) {
4232 struct stat info;
4233 if (stat(pathname, &info) == -1) {
4234 return false;
4235 }
4236 return S_ISDIR(info.st_mode);
4237}
4238
4239time_t get_mtime(int fd, time_t default_mtime) {
4240 struct stat info;
4241 if (fstat(fd, &info) == -1) {
4242 return default_mtime;
4243 }
4244 return info.st_mtime;
4245}