blob: a951c4f0af4bd187d24f7f729239fdad01560e4d [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;
Felipe Leme47e9be22016-12-21 15:37:07 -0800123
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100124// Keep in sync with
125// frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
126static const int TRACE_DUMP_TIMEOUT_MS = 10000; // 10 seconds
127
128/* Most simple commands have 10 as timeout, so 5 is a good estimate */
129static const int32_t WEIGHT_FILE = 5;
130
131// TODO: temporary variables and functions used during C++ refactoring
132static Dumpstate& ds = Dumpstate::GetInstance();
133static int RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Nandana Dutt8d945c02019-08-14 13:30:07 +0100134 const CommandOptions& options = CommandOptions::DEFAULT,
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800135 bool verbose_duration = false, int out_fd = STDOUT_FILENO) {
136 return ds.RunCommand(title, full_command, options, verbose_duration, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100137}
138
139// Reasonable value for max stats.
140static const int STATS_MAX_N_RUNS = 1000;
141static const long STATS_MAX_AVERAGE = 100000;
142
143CommandOptions Dumpstate::DEFAULT_DUMPSYS = CommandOptions::WithTimeout(30).Build();
144
Nandana Duttd2f5f082019-01-18 17:13:52 +0000145typedef Dumpstate::ConsentCallback::ConsentResult UserConsentResult;
146
Colin Crossf45fa6b2012-03-26 12:38:26 -0700147/* read before root is shed */
148static char cmdline_buf[16384] = "(unknown)";
Yi Kong19d5c002018-07-20 13:39:55 -0700149static const char *dump_traces_path = nullptr;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000150static const uint64_t USER_CONSENT_TIMEOUT_MS = 30 * 1000;
Hunter Knepshield70610fa2020-01-03 15:27:33 -0800151// Because telephony reports are significantly faster to collect (< 10 seconds vs. > 2 minutes),
152// it's often the case that they time out far too quickly for consent with such a hefty dialog for
153// the user to read. For telephony reports only, we increase the default timeout to 2 minutes to
154// roughly match full reports' durations.
155static const uint64_t TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS = 2 * 60 * 1000;
Colin Crossf45fa6b2012-03-26 12:38:26 -0700156
Felipe Leme1d486fe2016-10-14 18:06:47 -0700157// TODO: variables and functions below should be part of dumpstate object
158
Felipe Leme635ca312016-01-05 14:23:02 -0800159static std::set<std::string> mount_points;
160void add_mountinfo();
Felipe Leme78f2c862015-12-21 09:55:22 -0800161
Todd Poynor2a83daa2013-11-22 15:44:22 -0800162#define PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops"
Mark Salyzyn7d0a7622016-06-24 14:06:15 -0700163#define ALT_PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops-0"
Wei Wang509bb5d2017-06-09 14:42:12 -0700164#define BLK_DEV_SYS_DIR "/sys/block"
Todd Poynor2a83daa2013-11-22 15:44:22 -0800165
Felipe Lemee82a27d2016-01-05 13:35:44 -0800166#define RECOVERY_DIR "/cache/recovery"
Mark Salyzynd6ab0112016-03-25 12:56:39 -0700167#define RECOVERY_DATA_DIR "/data/misc/recovery"
Tianjie Xu75d53362018-04-11 16:42:28 -0700168#define UPDATE_ENGINE_LOG_DIR "/data/misc/update_engine_log"
Mark Salyzyn4d42dea2016-04-01 10:03:14 -0700169#define LOGPERSIST_DATA_DIR "/data/misc/logd"
Jerry Changa1df8a92020-01-02 16:03:39 +0800170#define PREREBOOT_DATA_DIR "/data/misc/prereboot"
David Brazdild2991962016-06-03 14:40:44 +0100171#define PROFILE_DATA_DIR_CUR "/data/misc/profiles/cur"
172#define PROFILE_DATA_DIR_REF "/data/misc/profiles/ref"
Benedict Wong8f9d8a42019-01-03 16:19:38 -0800173#define XFRM_STAT_PROC_FILE "/proc/net/xfrm_stat"
Erik Kline08165202016-05-30 11:55:44 +0900174#define WLUTIL "/vendor/xbin/wlutil"
Vishnu Nair36b4cdb2017-11-17 10:27:05 -0800175#define WMTRACE_DATA_DIR "/data/misc/wmtrace"
Yifan Hong3945e1b2019-10-29 12:59:23 -0700176#define OTA_METADATA_DIR "/metadata/ota"
Yifan Hong0efa7972020-02-03 16:45:02 -0800177#define SNAPSHOTCTL_LOG_DIR "/data/misc/snapshotctl_log"
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +0900178#define LINKERCONFIG_DIR "/linkerconfig"
Calin Juravlef84d3692020-04-28 15:31:12 -0700179#define PACKAGE_DEX_USE_LIST "/data/system/package-dex-usage.list"
Primiano Tuccifaaaafb2021-01-14 12:26:29 +0000180#define SYSTEM_TRACE_SNAPSHOT "/data/misc/perfetto-traces/bugreport/systrace.pftrace"
Li Li2eedd412021-06-30 15:11:53 -0700181#define CGROUPFS_DIR "/sys/fs/cgroup"
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700182
Narayan Kamath8f788292017-05-25 13:20:39 +0100183// TODO(narayan): Since this information has to be kept in sync
184// with tombstoned, we should just put it in a common header.
185//
186// File: system/core/debuggerd/tombstoned/tombstoned.cpp
Narayan Kamathbd863722017-06-01 18:50:12 +0100187static const std::string TOMBSTONE_DIR = "/data/tombstones/";
188static const std::string TOMBSTONE_FILE_PREFIX = "tombstone_";
189static const std::string ANR_DIR = "/data/anr/";
190static const std::string ANR_FILE_PREFIX = "anr_";
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700191
Felipe Lemee844a9d2016-09-21 15:01:39 -0700192// TODO: temporary variables and functions used during C++ refactoring
Nandana Dutt979388e2018-11-30 16:48:55 +0000193
Nandana Dutt5c390032019-03-12 10:52:56 +0000194#define RETURN_IF_USER_DENIED_CONSENT() \
195 if (ds.IsUserConsentDenied()) { \
196 MYLOGE("Returning early as user denied consent to share bugreport with calling app."); \
197 return Dumpstate::RunStatus::USER_CONSENT_DENIED; \
198 }
199
200// Runs func_ptr, but checks user consent before and after running it. Returns USER_CONSENT_DENIED
201// if consent is found to be denied.
202#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(func_ptr, ...) \
203 RETURN_IF_USER_DENIED_CONSENT(); \
204 func_ptr(__VA_ARGS__); \
205 RETURN_IF_USER_DENIED_CONSENT();
206
Rhed Jao5377d792020-07-16 17:37:39 +0800207// Runs func_ptr, and logs a duration report after it's finished.
208#define RUN_SLOW_FUNCTION_AND_LOG(log_title, func_ptr, ...) \
209 { \
210 DurationReporter duration_reporter_in_macro(log_title); \
211 func_ptr(__VA_ARGS__); \
212 }
213
214// Similar with RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK, an additional duration report
215// is output after a slow function is finished.
216#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(log_title, func_ptr, ...) \
217 RETURN_IF_USER_DENIED_CONSENT(); \
218 RUN_SLOW_FUNCTION_AND_LOG(log_title, func_ptr, __VA_ARGS__); \
219 RETURN_IF_USER_DENIED_CONSENT();
220
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800221#define WAIT_TASK_WITH_CONSENT_CHECK(task_name, pool_ptr) \
222 RETURN_IF_USER_DENIED_CONSENT(); \
223 pool_ptr->waitForTask(task_name); \
224 RETURN_IF_USER_DENIED_CONSENT();
225
Sahana Raof35ed432019-07-12 10:47:52 +0100226static const char* WAKE_LOCK_NAME = "dumpstate_wakelock";
227
Rhed Jao5377d792020-07-16 17:37:39 +0800228// Names of parallel tasks, they are used for the DumpPool to identify the dump
229// task and the log title of the duration report.
230static const std::string DUMP_TRACES_TASK = "DUMP TRACES";
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800231static const std::string DUMP_INCIDENT_REPORT_TASK = "INCIDENT REPORT";
232static const std::string DUMP_HALS_TASK = "DUMP HALS";
233static const std::string DUMP_BOARD_TASK = "dumpstate_board()";
Rhed Jaoe017f982020-07-21 17:58:41 +0800234static const std::string DUMP_CHECKINS_TASK = "DUMP CHECKINS";
Rhed Jao5377d792020-07-16 17:37:39 +0800235
Nandana Dutt979388e2018-11-30 16:48:55 +0000236namespace android {
237namespace os {
238namespace {
239
240static int Open(std::string path, int flags, mode_t mode = 0) {
241 int fd = TEMP_FAILURE_RETRY(open(path.c_str(), flags, mode));
242 if (fd == -1) {
243 MYLOGE("open(%s, %s)\n", path.c_str(), strerror(errno));
244 }
245 return fd;
246}
247
mhasank2d75c442020-06-11 15:05:25 -0700248static int OpenForWrite(std::string path) {
249 return Open(path, O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
250 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH);
251}
Nandana Dutt979388e2018-11-30 16:48:55 +0000252
253static int OpenForRead(std::string path) {
254 return Open(path, O_RDONLY | O_CLOEXEC | O_NOFOLLOW);
255}
256
257bool CopyFile(int in_fd, int out_fd) {
258 char buf[4096];
259 ssize_t byte_count;
260 while ((byte_count = TEMP_FAILURE_RETRY(read(in_fd, buf, sizeof(buf)))) > 0) {
261 if (!android::base::WriteFully(out_fd, buf, byte_count)) {
262 return false;
263 }
264 }
265 return (byte_count != -1);
266}
267
268static bool CopyFileToFd(const std::string& input_file, int out_fd) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000269 MYLOGD("Going to copy file (%s) to %d\n", input_file.c_str(), out_fd);
Nandana Dutt979388e2018-11-30 16:48:55 +0000270
271 // Obtain a handle to the source file.
272 android::base::unique_fd in_fd(OpenForRead(input_file));
273 if (out_fd != -1 && in_fd.get() != -1) {
274 if (CopyFile(in_fd.get(), out_fd)) {
275 return true;
276 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000277 MYLOGE("Failed to copy file: %s\n", strerror(errno));
Nandana Dutt979388e2018-11-30 16:48:55 +0000278 }
279 return false;
280}
281
Nandana Duttd2f5f082019-01-18 17:13:52 +0000282static bool UnlinkAndLogOnError(const std::string& file) {
Nandana Dutt8ae16e62020-03-27 10:20:22 +0000283 if (file.empty()) {
284 return false;
285 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000286 if (unlink(file.c_str())) {
287 MYLOGE("Failed to unlink file (%s): %s\n", file.c_str(), strerror(errno));
Nandana Duttd2f5f082019-01-18 17:13:52 +0000288 return false;
289 }
290 return true;
291}
Nandana Dutt979388e2018-11-30 16:48:55 +0000292
Nikita Ioffea325a572019-05-16 19:49:47 +0100293int64_t GetModuleMetadataVersion() {
294 auto binder = defaultServiceManager()->getService(android::String16("package_native"));
295 if (binder == nullptr) {
296 MYLOGE("Failed to retrieve package_native service");
297 return 0L;
298 }
299 auto package_service = android::interface_cast<content::pm::IPackageManagerNative>(binder);
300 std::string package_name;
301 auto status = package_service->getModuleMetadataPackageName(&package_name);
302 if (!status.isOk()) {
303 MYLOGE("Failed to retrieve module metadata package name: %s", status.toString8().c_str());
304 return 0L;
305 }
Nandana Duttdb379fa2019-10-09 16:54:41 +0100306 MYLOGD("Module metadata package name: %s\n", package_name.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100307 int64_t version_code;
308 status = package_service->getVersionCodeForPackage(android::String16(package_name.c_str()),
309 &version_code);
310 if (!status.isOk()) {
311 MYLOGE("Failed to retrieve module metadata version: %s", status.toString8().c_str());
312 return 0L;
313 }
314 return version_code;
315}
316
mhasank2d75c442020-06-11 15:05:25 -0700317static bool PathExists(const std::string& path) {
318 struct stat sb;
319 return stat(path.c_str(), &sb) == 0;
320}
321
322static bool CopyFileToFile(const std::string& input_file, const std::string& output_file) {
323 if (input_file == output_file) {
324 MYLOGD("Skipping copying bugreport file since the destination is the same (%s)\n",
325 output_file.c_str());
326 return false;
327 }
328 else if (PathExists(output_file)) {
329 MYLOGD("Cannot overwrite an existing file (%s)\n", output_file.c_str());
330 return false;
331 }
332
333 MYLOGD("Going to copy bugreport file (%s) to %s\n", input_file.c_str(), output_file.c_str());
334 android::base::unique_fd out_fd(OpenForWrite(output_file));
335 return CopyFileToFd(input_file, out_fd.get());
336}
337
Nandana Dutt979388e2018-11-30 16:48:55 +0000338} // namespace
339} // namespace os
340} // namespace android
341
Felipe Leme678727a2016-09-21 17:22:11 -0700342static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
Felipe Lemebda15a02016-11-16 17:48:25 -0800343 const CommandOptions& options = Dumpstate::DEFAULT_DUMPSYS,
Rhed Jaoe017f982020-07-21 17:58:41 +0800344 long dumpsysTimeoutMs = 0, int out_fd = STDOUT_FILENO) {
345 return ds.RunDumpsys(title, dumpsysArgs, options, dumpsysTimeoutMs, out_fd);
346}
347static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
348 int out_fd) {
349 return ds.RunDumpsys(title, dumpsysArgs, Dumpstate::DEFAULT_DUMPSYS, 0, out_fd);
Felipe Leme678727a2016-09-21 17:22:11 -0700350}
351static int DumpFile(const std::string& title, const std::string& path) {
352 return ds.DumpFile(title, path);
353}
Felipe Lemee82a27d2016-01-05 13:35:44 -0800354
Felipe Lemee844a9d2016-09-21 15:01:39 -0700355// Relative directory (inside the zip) for all files copied as-is into the bugreport.
356static const std::string ZIP_ROOT_DIR = "FS";
357
Vishnu Naire97d6122018-01-18 13:58:56 -0800358static const std::string kProtoPath = "proto/";
359static const std::string kProtoExt = ".proto";
Jie Song9fbfad02017-06-20 16:29:42 -0700360static const std::string kDumpstateBoardFiles[] = {
361 "dumpstate_board.txt",
Felipe Leme95d6ca52017-08-01 16:35:56 -0700362 "dumpstate_board.bin"
Jie Song9fbfad02017-06-20 16:29:42 -0700363};
364static const int NUM_OF_DUMPS = arraysize(kDumpstateBoardFiles);
365
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700366static constexpr char PROPERTY_LAST_ID[] = "dumpstate.last_id";
Felipe Lemed071c682016-10-20 16:48:00 -0700367static constexpr char PROPERTY_VERSION[] = "dumpstate.version";
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700368
Felipe Lemef0292972016-11-22 13:57:05 -0800369static const CommandOptions AS_ROOT_20 = CommandOptions::WithTimeout(20).AsRoot().Build();
370
Narayan Kamath8f788292017-05-25 13:20:39 +0100371/*
Narayan Kamathbd863722017-06-01 18:50:12 +0100372 * Returns a vector of dump fds under |dir_path| with a given |file_prefix|.
Rhed Jao01dc0c62020-06-03 17:13:30 +0800373 * The returned vector is sorted by the mtimes of the dumps with descending
Chris Morinc2cba7a2022-02-01 17:06:50 -0800374 * order.
Narayan Kamath8f788292017-05-25 13:20:39 +0100375 */
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700376static std::vector<DumpData> GetDumpFds(const std::string& dir_path,
Chris Morinc2cba7a2022-02-01 17:06:50 -0800377 const std::string& file_prefix) {
Narayan Kamathbd863722017-06-01 18:50:12 +0100378 std::unique_ptr<DIR, decltype(&closedir)> dump_dir(opendir(dir_path.c_str()), closedir);
Narayan Kamath8f788292017-05-25 13:20:39 +0100379
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700380 if (dump_dir == nullptr) {
381 MYLOGW("Unable to open directory %s: %s\n", dir_path.c_str(), strerror(errno));
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700382 return std::vector<DumpData>();
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700383 }
384
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700385 std::vector<DumpData> dump_data;
Narayan Kamathbd863722017-06-01 18:50:12 +0100386 struct dirent* entry = nullptr;
387 while ((entry = readdir(dump_dir.get()))) {
388 if (entry->d_type != DT_REG) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100389 continue;
390 }
391
Narayan Kamathbd863722017-06-01 18:50:12 +0100392 const std::string base_name(entry->d_name);
393 if (base_name.find(file_prefix) != 0) {
394 continue;
395 }
396
397 const std::string abs_path = dir_path + base_name;
398 android::base::unique_fd fd(
399 TEMP_FAILURE_RETRY(open(abs_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW | O_NONBLOCK)));
400 if (fd == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700401 MYLOGW("Unable to open dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamathbd863722017-06-01 18:50:12 +0100402 break;
403 }
404
405 struct stat st = {};
406 if (fstat(fd, &st) == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700407 MYLOGW("Unable to stat dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamath8f788292017-05-25 13:20:39 +0100408 continue;
409 }
410
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700411 dump_data.emplace_back(DumpData{abs_path, std::move(fd), st.st_mtime});
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700412 }
Rhed Jao01dc0c62020-06-03 17:13:30 +0800413 if (!dump_data.empty()) {
414 std::sort(dump_data.begin(), dump_data.end(),
415 [](const auto& a, const auto& b) { return a.mtime > b.mtime; });
416 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100417
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700418 return dump_data;
Narayan Kamath8f788292017-05-25 13:20:39 +0100419}
420
Narayan Kamathbd863722017-06-01 18:50:12 +0100421static bool AddDumps(const std::vector<DumpData>::const_iterator start,
422 const std::vector<DumpData>::const_iterator end,
423 const char* type_name, const bool add_to_zip) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100424 bool dumped = false;
Narayan Kamathbd863722017-06-01 18:50:12 +0100425 for (auto it = start; it != end; ++it) {
426 const std::string& name = it->name;
427 const int fd = it->fd;
Narayan Kamath8f788292017-05-25 13:20:39 +0100428 dumped = true;
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100429
430 // Seek to the beginning of the file before dumping any data. A given
431 // DumpData entry might be dumped multiple times in the report.
432 //
433 // For example, the most recent ANR entry is dumped to the body of the
434 // main entry and it also shows up as a separate entry in the bugreport
435 // ZIP file.
436 if (lseek(fd, 0, SEEK_SET) != static_cast<off_t>(0)) {
437 MYLOGE("Unable to add %s to zip file, lseek failed: %s\n", name.c_str(),
438 strerror(errno));
439 }
440
Chris Morinc2cba7a2022-02-01 17:06:50 -0800441 if (add_to_zip) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800442 if (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + name, fd, /* timeout = */ 0ms) != OK) {
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100443 MYLOGE("Unable to add %s to zip file, addZipEntryFromFd failed\n", name.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100444 }
445 } else {
446 dump_file_from_fd(type_name, name.c_str(), fd);
447 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100448 }
449
450 return dumped;
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700451}
452
Felipe Leme635ca312016-01-05 14:23:02 -0800453// for_each_pid() callback to get mount info about a process.
Felipe Leme4c2d6632016-09-28 14:32:00 -0700454void do_mountinfo(int pid, const char* name __attribute__((unused))) {
Felipe Leme635ca312016-01-05 14:23:02 -0800455 char path[PATH_MAX];
456
457 // Gets the the content of the /proc/PID/ns/mnt link, so only unique mount points
458 // are added.
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700459 snprintf(path, sizeof(path), "/proc/%d/ns/mnt", pid);
Felipe Leme635ca312016-01-05 14:23:02 -0800460 char linkname[PATH_MAX];
461 ssize_t r = readlink(path, linkname, PATH_MAX);
462 if (r == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800463 MYLOGE("Unable to read link for %s: %s\n", path, strerror(errno));
Felipe Leme635ca312016-01-05 14:23:02 -0800464 return;
465 }
466 linkname[r] = '\0';
467
468 if (mount_points.find(linkname) == mount_points.end()) {
469 // First time this mount point was found: add it
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700470 snprintf(path, sizeof(path), "/proc/%d/mountinfo", pid);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700471 if (ds.AddZipEntry(ZIP_ROOT_DIR + path, path)) {
Felipe Leme635ca312016-01-05 14:23:02 -0800472 mount_points.insert(linkname);
473 } else {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800474 MYLOGE("Unable to add mountinfo %s to zip file\n", path);
Felipe Leme635ca312016-01-05 14:23:02 -0800475 }
476 }
477}
478
479void add_mountinfo() {
Felipe Leme678727a2016-09-21 17:22:11 -0700480 std::string title = "MOUNT INFO";
Felipe Leme635ca312016-01-05 14:23:02 -0800481 mount_points.clear();
Felipe Leme46b85da2016-11-21 17:40:45 -0800482 DurationReporter duration_reporter(title, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700483 for_each_pid(do_mountinfo, nullptr);
484 MYLOGD("%s: %d entries added to zip file\n", title.c_str(), (int)mount_points.size());
Felipe Leme635ca312016-01-05 14:23:02 -0800485}
486
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700487static void dump_dev_files(const char *title, const char *driverpath, const char *filename)
488{
489 DIR *d;
490 struct dirent *de;
491 char path[PATH_MAX];
492
493 d = opendir(driverpath);
Yi Kong19d5c002018-07-20 13:39:55 -0700494 if (d == nullptr) {
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700495 return;
496 }
497
498 while ((de = readdir(d))) {
499 if (de->d_type != DT_LNK) {
500 continue;
501 }
502 snprintf(path, sizeof(path), "%s/%s/%s", driverpath, de->d_name, filename);
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700503 DumpFile(title, path);
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700504 }
505
506 closedir(d);
507}
508
Mark Salyzyn326842f2015-04-30 09:49:41 -0700509static bool skip_not_stat(const char *path) {
510 static const char stat[] = "/stat";
511 size_t len = strlen(path);
512 if (path[len - 1] == '/') { /* Directory? */
513 return false;
514 }
515 return strcmp(path + len - sizeof(stat) + 1, stat); /* .../stat? */
516}
517
Felipe Leme4c2d6632016-09-28 14:32:00 -0700518static bool skip_none(const char* path __attribute__((unused))) {
Felipe Lemee82a27d2016-01-05 13:35:44 -0800519 return false;
520}
521
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700522unsigned long worst_write_perf = 20000; /* in KB/s */
Mark Salyzyn326842f2015-04-30 09:49:41 -0700523
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800524//
525// stat offsets
526// Name units description
527// ---- ----- -----------
528// read I/Os requests number of read I/Os processed
529#define __STAT_READ_IOS 0
530// read merges requests number of read I/Os merged with in-queue I/O
531#define __STAT_READ_MERGES 1
532// read sectors sectors number of sectors read
533#define __STAT_READ_SECTORS 2
534// read ticks milliseconds total wait time for read requests
535#define __STAT_READ_TICKS 3
536// write I/Os requests number of write I/Os processed
537#define __STAT_WRITE_IOS 4
538// write merges requests number of write I/Os merged with in-queue I/O
539#define __STAT_WRITE_MERGES 5
540// write sectors sectors number of sectors written
541#define __STAT_WRITE_SECTORS 6
542// write ticks milliseconds total wait time for write requests
543#define __STAT_WRITE_TICKS 7
544// in_flight requests number of I/Os currently in flight
545#define __STAT_IN_FLIGHT 8
546// io_ticks milliseconds total time this block device has been active
547#define __STAT_IO_TICKS 9
548// time_in_queue milliseconds total wait time for all requests
549#define __STAT_IN_QUEUE 10
550#define __STAT_NUMBER_FIELD 11
551//
552// read I/Os, write I/Os
553// =====================
554//
555// These values increment when an I/O request completes.
556//
557// read merges, write merges
558// =========================
559//
560// These values increment when an I/O request is merged with an
561// already-queued I/O request.
562//
563// read sectors, write sectors
564// ===========================
565//
566// These values count the number of sectors read from or written to this
567// block device. The "sectors" in question are the standard UNIX 512-byte
568// sectors, not any device- or filesystem-specific block size. The
569// counters are incremented when the I/O completes.
570#define SECTOR_SIZE 512
571//
572// read ticks, write ticks
573// =======================
574//
575// These values count the number of milliseconds that I/O requests have
576// waited on this block device. If there are multiple I/O requests waiting,
577// these values will increase at a rate greater than 1000/second; for
578// example, if 60 read requests wait for an average of 30 ms, the read_ticks
579// field will increase by 60*30 = 1800.
580//
581// in_flight
582// =========
583//
584// This value counts the number of I/O requests that have been issued to
585// the device driver but have not yet completed. It does not include I/O
586// requests that are in the queue but not yet issued to the device driver.
587//
588// io_ticks
589// ========
590//
591// This value counts the number of milliseconds during which the device has
592// had I/O requests queued.
593//
594// time_in_queue
595// =============
596//
597// This value counts the number of milliseconds that I/O requests have waited
598// on this block device. If there are multiple I/O requests waiting, this
599// value will increase as the product of the number of milliseconds times the
600// number of requests waiting (see "read ticks" above for an example).
601#define S_TO_MS 1000
602//
603
Mark Salyzyn326842f2015-04-30 09:49:41 -0700604static int dump_stat_from_fd(const char *title __unused, const char *path, int fd) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800605 unsigned long long fields[__STAT_NUMBER_FIELD];
Mark Salyzyn326842f2015-04-30 09:49:41 -0700606 bool z;
Yi Kong19d5c002018-07-20 13:39:55 -0700607 char *cp, *buffer = nullptr;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700608 size_t i = 0;
Josh Gao7c4258c2018-06-25 13:40:08 -0700609 FILE *fp = fdopen(dup(fd), "rb");
Mark Salyzyn326842f2015-04-30 09:49:41 -0700610 getline(&buffer, &i, fp);
611 fclose(fp);
612 if (!buffer) {
613 return -errno;
614 }
615 i = strlen(buffer);
616 while ((i > 0) && (buffer[i - 1] == '\n')) {
617 buffer[--i] = '\0';
618 }
619 if (!*buffer) {
620 free(buffer);
621 return 0;
622 }
623 z = true;
624 for (cp = buffer, i = 0; i < (sizeof(fields) / sizeof(fields[0])); ++i) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800625 fields[i] = strtoull(cp, &cp, 10);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700626 if (fields[i] != 0) {
627 z = false;
628 }
629 }
630 if (z) { /* never accessed */
631 free(buffer);
632 return 0;
633 }
634
Wei Wang509bb5d2017-06-09 14:42:12 -0700635 if (!strncmp(path, BLK_DEV_SYS_DIR, sizeof(BLK_DEV_SYS_DIR) - 1)) {
636 path += sizeof(BLK_DEV_SYS_DIR) - 1;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700637 }
Wei Wang1dc1ef52017-06-12 11:28:37 -0700638
639 printf("%-30s:%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s\n%-30s:\t%s\n", "Block-Dev",
640 "R-IOs", "R-merg", "R-sect", "R-wait", "W-IOs", "W-merg", "W-sect",
641 "W-wait", "in-fli", "activ", "T-wait", path, buffer);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700642 free(buffer);
643
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800644 if (fields[__STAT_IO_TICKS]) {
645 unsigned long read_perf = 0;
646 unsigned long read_ios = 0;
647 if (fields[__STAT_READ_TICKS]) {
648 unsigned long long divisor = fields[__STAT_READ_TICKS]
649 * fields[__STAT_IO_TICKS];
650 read_perf = ((unsigned long long)SECTOR_SIZE
651 * fields[__STAT_READ_SECTORS]
652 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
653 / divisor;
654 read_ios = ((unsigned long long)S_TO_MS * fields[__STAT_READ_IOS]
655 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
656 / divisor;
657 }
658
659 unsigned long write_perf = 0;
660 unsigned long write_ios = 0;
661 if (fields[__STAT_WRITE_TICKS]) {
662 unsigned long long divisor = fields[__STAT_WRITE_TICKS]
663 * fields[__STAT_IO_TICKS];
664 write_perf = ((unsigned long long)SECTOR_SIZE
665 * fields[__STAT_WRITE_SECTORS]
666 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
667 / divisor;
668 write_ios = ((unsigned long long)S_TO_MS * fields[__STAT_WRITE_IOS]
669 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
670 / divisor;
671 }
672
673 unsigned queue = (fields[__STAT_IN_QUEUE]
674 + (fields[__STAT_IO_TICKS] >> 1))
675 / fields[__STAT_IO_TICKS];
676
677 if (!write_perf && !write_ios) {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700678 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 -0800679 } else {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700680 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 -0800681 read_ios, write_perf, write_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800682 }
683
684 /* bugreport timeout factor adjustment */
685 if ((write_perf > 1) && (write_perf < worst_write_perf)) {
686 worst_write_perf = write_perf;
687 }
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700688 }
Mark Salyzyn326842f2015-04-30 09:49:41 -0700689 return 0;
690}
691
Yao Chenbe3bbc12018-01-17 16:31:10 -0800692static const long MINIMUM_LOGCAT_TIMEOUT_MS = 50000;
693
Tom Cherryf4472f32020-08-05 09:31:17 -0700694// Returns the actual readable size of the given buffer or -1 on error.
695static long logcat_buffer_readable_size(const std::string& buffer) {
696 std::unique_ptr<logger_list, decltype(&android_logger_list_free)> logger_list{
697 android_logger_list_alloc(0, 0, 0), &android_logger_list_free};
698 auto logger = android_logger_open(logger_list.get(), android_name_to_log_id(buffer.c_str()));
699
700 return android_logger_get_log_readable_size(logger);
701}
702
703// Returns timeout in ms to read a list of buffers.
Yao Chenbe3bbc12018-01-17 16:31:10 -0800704static unsigned long logcat_timeout(const std::vector<std::string>& buffers) {
705 unsigned long timeout_ms = 0;
706 for (const auto& buffer : buffers) {
Tom Cherryf4472f32020-08-05 09:31:17 -0700707 long readable_size = logcat_buffer_readable_size(buffer);
708 if (readable_size > 0) {
709 // Engineering margin is ten-fold our guess.
710 timeout_ms += 10 * (readable_size + worst_write_perf) / worst_write_perf;
711 }
Yao Chenbe3bbc12018-01-17 16:31:10 -0800712 }
713 return timeout_ms > MINIMUM_LOGCAT_TIMEOUT_MS ? timeout_ms : MINIMUM_LOGCAT_TIMEOUT_MS;
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700714}
715
Dieter Hsu105ad0c2020-09-29 15:23:33 +0800716// Opens a socket and returns its file descriptor.
717static int open_socket(const char* service);
718
Nandana Duttd2f5f082019-01-18 17:13:52 +0000719Dumpstate::ConsentCallback::ConsentCallback() : result_(UNAVAILABLE), start_time_(Nanotime()) {
720}
721
722android::binder::Status Dumpstate::ConsentCallback::onReportApproved() {
723 std::lock_guard<std::mutex> lock(lock_);
724 result_ = APPROVED;
725 MYLOGD("User approved consent to share bugreport\n");
Paul Chang0d2aad72020-02-13 20:04:03 +0800726
727 // Maybe copy screenshot so calling app can display the screenshot to the user as soon as
728 // consent is granted.
729 if (ds.options_->is_screenshot_copied) {
730 return android::binder::Status::ok();
731 }
732
733 if (!ds.options_->do_screenshot || ds.options_->screenshot_fd.get() == -1 ||
734 !ds.do_early_screenshot_) {
735 return android::binder::Status::ok();
736 }
737
738 bool copy_succeeded = android::os::CopyFileToFd(ds.screenshot_path_,
739 ds.options_->screenshot_fd.get());
740 ds.options_->is_screenshot_copied = copy_succeeded;
741 if (copy_succeeded) {
742 android::os::UnlinkAndLogOnError(ds.screenshot_path_);
743 }
Nandana Duttd2f5f082019-01-18 17:13:52 +0000744 return android::binder::Status::ok();
745}
746
747android::binder::Status Dumpstate::ConsentCallback::onReportDenied() {
748 std::lock_guard<std::mutex> lock(lock_);
749 result_ = DENIED;
750 MYLOGW("User denied consent to share bugreport\n");
751 return android::binder::Status::ok();
752}
753
754UserConsentResult Dumpstate::ConsentCallback::getResult() {
755 std::lock_guard<std::mutex> lock(lock_);
756 return result_;
757}
758
759uint64_t Dumpstate::ConsentCallback::getElapsedTimeMs() const {
Hunter Knepshieldf0a39052020-01-03 14:53:04 -0800760 return (Nanotime() - start_time_) / NANOS_PER_MILLI;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000761}
762
Felipe Leme2b9b06c2016-10-14 09:13:06 -0700763void Dumpstate::PrintHeader() const {
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700764 std::string build, fingerprint, radio, bootloader, network;
765 char date[80];
Colin Crossf45fa6b2012-03-26 12:38:26 -0700766
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700767 build = android::base::GetProperty("ro.build.display.id", "(unknown)");
768 fingerprint = android::base::GetProperty("ro.build.fingerprint", "(unknown)");
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700769 radio = android::base::GetProperty("gsm.version.baseband", "(unknown)");
770 bootloader = android::base::GetProperty("ro.bootloader", "(unknown)");
771 network = android::base::GetProperty("gsm.operator.alpha", "(unknown)");
Felipe Lemebbaf3c12016-10-11 14:32:25 -0700772 strftime(date, sizeof(date), "%Y-%m-%d %H:%M:%S", localtime(&now_));
Colin Crossf45fa6b2012-03-26 12:38:26 -0700773
Felipe Lemed8b94e52016-12-08 10:21:44 -0800774 printf("========================================================\n");
775 printf("== dumpstate: %s\n", date);
776 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -0700777
Felipe Lemed8b94e52016-12-08 10:21:44 -0800778 printf("\n");
779 printf("Build: %s\n", build.c_str());
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700780 // NOTE: fingerprint entry format is important for other tools.
Felipe Lemed8b94e52016-12-08 10:21:44 -0800781 printf("Build fingerprint: '%s'\n", fingerprint.c_str());
782 printf("Bootloader: %s\n", bootloader.c_str());
783 printf("Radio: %s\n", radio.c_str());
784 printf("Network: %s\n", network.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100785 int64_t module_metadata_version = android::os::GetModuleMetadataVersion();
786 if (module_metadata_version != 0) {
787 printf("Module Metadata version: %" PRId64 "\n", module_metadata_version);
788 }
Anton Hansson37c041d2021-04-14 17:49:06 +0100789 printf("SDK extension versions [r=%s s=%s]\n",
790 android::base::GetProperty("build.version.extensions.r", "-").c_str(),
791 android::base::GetProperty("build.version.extensions.s", "-").c_str());
Colin Crossf45fa6b2012-03-26 12:38:26 -0700792
Felipe Lemed8b94e52016-12-08 10:21:44 -0800793 printf("Kernel: ");
Felipe Lemef0292972016-11-22 13:57:05 -0800794 DumpFileToFd(STDOUT_FILENO, "", "/proc/version");
Felipe Lemed8b94e52016-12-08 10:21:44 -0800795 printf("Command line: %s\n", strtok(cmdline_buf, "\n"));
Felipe Leme7709f8a2017-12-05 09:30:09 -0800796 printf("Uptime: ");
797 RunCommandToFd(STDOUT_FILENO, "", {"uptime", "-p"},
798 CommandOptions::WithTimeout(1).Always().Build());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800799 printf("Bugreport format version: %s\n", version_.c_str());
Rhed Jao5377d792020-07-16 17:37:39 +0800800 printf("Dumpstate info: id=%d pid=%d dry_run=%d parallel_run=%d args=%s bugreport_mode=%s\n",
801 id_, pid_, PropertiesHelper::IsDryRun(), PropertiesHelper::IsParallelRun(),
Kedar Chitnis9fd8c052021-11-16 09:09:22 +0000802 options_->args.c_str(), options_->bugreport_mode_string.c_str());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800803 printf("\n");
Felipe Leme78f2c862015-12-21 09:55:22 -0800804}
805
Felipe Leme24b66ee2016-06-16 10:55:26 -0700806// List of file extensions that can cause a zip file attachment to be rejected by some email
807// service providers.
808static const std::set<std::string> PROBLEMATIC_FILE_EXTENSIONS = {
809 ".ade", ".adp", ".bat", ".chm", ".cmd", ".com", ".cpl", ".exe", ".hta", ".ins", ".isp",
810 ".jar", ".jse", ".lib", ".lnk", ".mde", ".msc", ".msp", ".mst", ".pif", ".scr", ".sct",
811 ".shb", ".sys", ".vb", ".vbe", ".vbs", ".vxd", ".wsc", ".wsf", ".wsh"
812};
813
Vishnu Naire97d6122018-01-18 13:58:56 -0800814status_t Dumpstate::AddZipEntryFromFd(const std::string& entry_name, int fd,
815 std::chrono::milliseconds timeout = 0ms) {
Felipe Leme24b66ee2016-06-16 10:55:26 -0700816 std::string valid_name = entry_name;
817
818 // Rename extension if necessary.
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -0700819 size_t idx = entry_name.rfind('.');
Felipe Leme24b66ee2016-06-16 10:55:26 -0700820 if (idx != std::string::npos) {
821 std::string extension = entry_name.substr(idx);
822 std::transform(extension.begin(), extension.end(), extension.begin(), ::tolower);
823 if (PROBLEMATIC_FILE_EXTENSIONS.count(extension) != 0) {
824 valid_name = entry_name + ".renamed";
825 MYLOGI("Renaming entry %s to %s\n", entry_name.c_str(), valid_name.c_str());
826 }
827 }
828
Felipe Leme6fe9db62016-02-12 09:04:16 -0800829 // Logging statement below is useful to time how long each entry takes, but it's too verbose.
830 // MYLOGD("Adding zip entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700831 int32_t err = zip_writer_->StartEntryWithTime(valid_name.c_str(), ZipWriter::kCompress,
832 get_mtime(fd, ds.now_));
Felipe Leme1d486fe2016-10-14 18:06:47 -0700833 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700834 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", valid_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700835 ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800836 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800837 }
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000838 bool finished_entry = false;
839 auto finish_entry = [this, &finished_entry] {
840 if (!finished_entry) {
841 // This should only be called when we're going to return an earlier error,
842 // which would've been logged. This may imply the file is already corrupt
843 // and any further logging from FinishEntry is more likely to mislead than
844 // not.
845 this->zip_writer_->FinishEntry();
846 }
847 };
848 auto scope_guard = android::base::make_scope_guard(finish_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -0800849 auto start = std::chrono::steady_clock::now();
850 auto end = start + timeout;
851 struct pollfd pfd = {fd, POLLIN};
Felipe Lemee82a27d2016-01-05 13:35:44 -0800852
Felipe Leme770410d2016-01-26 17:07:14 -0800853 std::vector<uint8_t> buffer(65536);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800854 while (1) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800855 if (timeout.count() > 0) {
856 // lambda to recalculate the timeout.
857 auto time_left_ms = [end]() {
858 auto now = std::chrono::steady_clock::now();
859 auto diff = std::chrono::duration_cast<std::chrono::milliseconds>(end - now);
860 return std::max(diff.count(), 0LL);
861 };
862
863 int rc = TEMP_FAILURE_RETRY(poll(&pfd, 1, time_left_ms()));
864 if (rc < 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000865 MYLOGE("Error in poll while adding from fd to zip entry %s:%s\n",
866 entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800867 return -errno;
868 } else if (rc == 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000869 MYLOGE("Timed out adding from fd to zip entry %s:%s Timeout:%lldms\n",
Vishnu Naire97d6122018-01-18 13:58:56 -0800870 entry_name.c_str(), strerror(errno), timeout.count());
871 return TIMED_OUT;
872 }
873 }
874
Zach Riggle22200402016-08-18 01:01:24 -0400875 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800876 if (bytes_read == 0) {
877 break;
878 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800879 MYLOGE("read(%s): %s\n", entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800880 return -errno;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800881 }
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700882 err = zip_writer_->WriteBytes(buffer.data(), bytes_read);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800883 if (err) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700884 MYLOGE("zip_writer_->WriteBytes(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800885 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800886 }
887 }
888
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700889 err = zip_writer_->FinishEntry();
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000890 finished_entry = true;
Felipe Leme1d486fe2016-10-14 18:06:47 -0700891 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700892 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800893 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800894 }
895
Vishnu Naire97d6122018-01-18 13:58:56 -0800896 return OK;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800897}
898
Felipe Leme1d486fe2016-10-14 18:06:47 -0700899bool Dumpstate::AddZipEntry(const std::string& entry_name, const std::string& entry_path) {
900 android::base::unique_fd fd(
901 TEMP_FAILURE_RETRY(open(entry_path.c_str(), O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
Andreas Gampeaff68432016-07-18 18:01:27 -0700902 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800903 MYLOGE("open(%s): %s\n", entry_path.c_str(), strerror(errno));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800904 return false;
905 }
906
Vishnu Naire97d6122018-01-18 13:58:56 -0800907 return (AddZipEntryFromFd(entry_name, fd.get()) == OK);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800908}
909
910/* adds a file to the existing zipped bugreport */
Felipe Leme4c2d6632016-09-28 14:32:00 -0700911static int _add_file_from_fd(const char* title __attribute__((unused)), const char* path, int fd) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800912 return (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + path, fd) == OK) ? 0 : 1;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800913}
914
Felipe Leme1d486fe2016-10-14 18:06:47 -0700915void Dumpstate::AddDir(const std::string& dir, bool recursive) {
Felipe Leme678727a2016-09-21 17:22:11 -0700916 MYLOGD("Adding dir %s (recursive: %d)\n", dir.c_str(), recursive);
Felipe Leme46b85da2016-11-21 17:40:45 -0800917 DurationReporter duration_reporter(dir, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700918 dump_files("", dir.c_str(), recursive ? skip_none : is_dir, _add_file_from_fd);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800919}
920
Felipe Leme1d486fe2016-10-14 18:06:47 -0700921bool Dumpstate::AddTextZipEntry(const std::string& entry_name, const std::string& content) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800922 MYLOGD("Adding zip text entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700923 int32_t err = zip_writer_->StartEntryWithTime(entry_name.c_str(), ZipWriter::kCompress, ds.now_);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700924 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700925 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700926 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800927 return false;
928 }
929
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700930 err = zip_writer_->WriteBytes(content.c_str(), content.length());
Felipe Leme1d486fe2016-10-14 18:06:47 -0700931 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700932 MYLOGE("zip_writer_->WriteBytes(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700933 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800934 return false;
935 }
936
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700937 err = zip_writer_->FinishEntry();
Felipe Leme1d486fe2016-10-14 18:06:47 -0700938 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700939 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800940 return false;
941 }
942
943 return true;
944}
945
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800946static void DoKmsg() {
947 struct stat st;
948 if (!stat(PSTORE_LAST_KMSG, &st)) {
949 /* Also TODO: Make console-ramoops CAP_SYSLOG protected. */
950 DumpFile("LAST KMSG", PSTORE_LAST_KMSG);
951 } else if (!stat(ALT_PSTORE_LAST_KMSG, &st)) {
952 DumpFile("LAST KMSG", ALT_PSTORE_LAST_KMSG);
953 } else {
954 /* TODO: Make last_kmsg CAP_SYSLOG protected. b/5555691 */
955 DumpFile("LAST KMSG", "/proc/last_kmsg");
956 }
957}
958
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800959static void DoKernelLogcat() {
Yao Chenbe3bbc12018-01-17 16:31:10 -0800960 unsigned long timeout_ms = logcat_timeout({"kernel"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800961 RunCommand(
962 "KERNEL LOG",
963 {"logcat", "-b", "kernel", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
964 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
965}
966
Nandana Duttdb379fa2019-10-09 16:54:41 +0100967static void DoSystemLogcat(time_t since) {
968 char since_str[80];
969 strftime(since_str, sizeof(since_str), "%Y-%m-%d %H:%M:%S.000", localtime(&since));
970
971 unsigned long timeout_ms = logcat_timeout({"main", "system", "crash"});
972 RunCommand("SYSTEM LOG",
973 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v", "-T",
974 since_str},
975 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
976}
977
Hunter Knepshield820f9bc2020-02-05 20:10:53 -0800978static void DoRadioLogcat() {
979 unsigned long timeout_ms = logcat_timeout({"radio"});
980 RunCommand(
981 "RADIO LOG",
982 {"logcat", "-b", "radio", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
983 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
984}
985
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800986static void DoLogcat() {
Vishnu Nair6921f802017-11-22 09:17:23 -0800987 unsigned long timeout_ms;
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800988 // DumpFile("EVENT LOG TAGS", "/etc/event-log-tags");
989 // calculate timeout
Yao Chenbe3bbc12018-01-17 16:31:10 -0800990 timeout_ms = logcat_timeout({"main", "system", "crash"});
Tony Makae737652017-03-30 17:47:09 +0100991 RunCommand("SYSTEM LOG",
Vishnu Nair6921f802017-11-22 09:17:23 -0800992 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
993 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -0800994 timeout_ms = logcat_timeout({"events"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800995 RunCommand(
996 "EVENT LOG",
997 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +0100998 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Yao Chenbe3bbc12018-01-17 16:31:10 -0800999 timeout_ms = logcat_timeout({"stats"});
1000 RunCommand(
1001 "STATS LOG",
1002 {"logcat", "-b", "stats", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001003 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001004 DoRadioLogcat();
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001005
1006 RunCommand("LOG STATISTICS", {"logcat", "-b", "all", "-S"});
1007
1008 /* kernels must set CONFIG_PSTORE_PMSG, slice up pstore with device tree */
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001009 RunCommand("LAST LOGCAT", {"logcat", "-L", "-b", "all", "-v", "threadtime", "-v", "printable",
1010 "-v", "uid", "-d", "*:v"});
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001011}
1012
Mike Ma5c267872019-08-21 11:31:34 -07001013static void DumpIncidentReport() {
Mike Ma5c267872019-08-21 11:31:34 -07001014 const std::string path = ds.bugreport_internal_dir_ + "/tmp_incident_report";
1015 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1016 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1017 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1018 if (fd < 0) {
1019 MYLOGE("Could not open %s to dump incident report.\n", path.c_str());
1020 return;
1021 }
1022 RunCommandToFd(fd, "", {"incident", "-u"}, CommandOptions::WithTimeout(120).Build());
1023 bool empty = 0 == lseek(fd, 0, SEEK_END);
1024 if (!empty) {
1025 // Use a different name from "incident.proto"
1026 // /proto/incident.proto is reserved for incident service dump
1027 // i.e. metadata for debugging.
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001028 ds.EnqueueAddZipEntryAndCleanupIfNeeded(kProtoPath + "incident_report" + kProtoExt,
1029 path);
1030 } else {
1031 unlink(path.c_str());
Mike Ma5c267872019-08-21 11:31:34 -07001032 }
Mike Ma5c267872019-08-21 11:31:34 -07001033}
1034
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001035static void MaybeAddSystemTraceToZip() {
1036 // This function copies into the .zip the system trace that was snapshotted
1037 // by the early call to MaybeSnapshotSystemTrace(), if any background
1038 // tracing was happening.
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001039 if (!ds.has_system_trace_) {
1040 // No background trace was happening at the time dumpstate was invoked.
1041 return;
1042 }
1043 ds.AddZipEntry(
1044 ZIP_ROOT_DIR + SYSTEM_TRACE_SNAPSHOT,
1045 SYSTEM_TRACE_SNAPSHOT);
1046 android::os::UnlinkAndLogOnError(SYSTEM_TRACE_SNAPSHOT);
1047}
1048
Sunny Goyal35949782019-11-19 15:54:36 -08001049static void DumpVisibleWindowViews() {
Sunny Goyal35949782019-11-19 15:54:36 -08001050 DurationReporter duration_reporter("VISIBLE WINDOW VIEWS");
1051 const std::string path = ds.bugreport_internal_dir_ + "/tmp_visible_window_views";
1052 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1053 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1054 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1055 if (fd < 0) {
1056 MYLOGE("Could not open %s to dump visible views.\n", path.c_str());
1057 return;
1058 }
1059 RunCommandToFd(fd, "", {"cmd", "window", "dump-visible-window-views"},
1060 CommandOptions::WithTimeout(120).Build());
1061 bool empty = 0 == lseek(fd, 0, SEEK_END);
1062 if (!empty) {
1063 ds.AddZipEntry("visible_windows.zip", path);
1064 } else {
1065 MYLOGW("Failed to dump visible windows\n");
1066 }
1067 unlink(path.c_str());
1068}
1069
Jayachandran Ca94c7172017-06-10 15:08:12 -07001070static void DumpIpTablesAsRoot() {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001071 RunCommand("IPTABLES", {"iptables", "-L", "-nvx"});
1072 RunCommand("IP6TABLES", {"ip6tables", "-L", "-nvx"});
Erik Kline32af8c22016-09-28 17:26:26 +09001073 RunCommand("IPTABLES NAT", {"iptables", "-t", "nat", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001074 /* no ip6 nat */
Erik Kline32af8c22016-09-28 17:26:26 +09001075 RunCommand("IPTABLES MANGLE", {"iptables", "-t", "mangle", "-L", "-nvx"});
1076 RunCommand("IP6TABLES MANGLE", {"ip6tables", "-t", "mangle", "-L", "-nvx"});
1077 RunCommand("IPTABLES RAW", {"iptables", "-t", "raw", "-L", "-nvx"});
1078 RunCommand("IP6TABLES RAW", {"ip6tables", "-t", "raw", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001079}
1080
David Andersond9ba4752018-12-11 18:26:59 -08001081static void DumpDynamicPartitionInfo() {
1082 if (!::android::base::GetBoolProperty("ro.boot.dynamic_partitions", false)) {
1083 return;
1084 }
1085
1086 RunCommand("LPDUMP", {"lpdump", "--all"});
David Anderson6650ade2019-10-02 15:18:59 -07001087 RunCommand("DEVICE-MAPPER", {"gsid", "dump-device-mapper"});
David Andersond9ba4752018-12-11 18:26:59 -08001088}
1089
Narayan Kamath8f788292017-05-25 13:20:39 +01001090static void AddAnrTraceDir(const bool add_to_zip, const std::string& anr_traces_dir) {
1091 MYLOGD("AddAnrTraceDir(): dump_traces_file=%s, anr_traces_dir=%s\n", dump_traces_path,
1092 anr_traces_dir.c_str());
1093
1094 // If we're here, dump_traces_path will always be a temporary file
1095 // (created with mkostemp or similar) that contains dumps taken earlier
1096 // on in the process.
1097 if (dump_traces_path != nullptr) {
1098 if (add_to_zip) {
1099 ds.AddZipEntry(ZIP_ROOT_DIR + anr_traces_dir + "/traces-just-now.txt", dump_traces_path);
1100 } else {
1101 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);
1104 }
1105
1106 const int ret = unlink(dump_traces_path);
1107 if (ret == -1) {
1108 MYLOGW("Error unlinking temporary trace path %s: %s\n", dump_traces_path,
1109 strerror(errno));
Felipe Lemee184f662016-10-27 10:04:47 -07001110 }
1111 }
1112
Narayan Kamathbd863722017-06-01 18:50:12 +01001113 // Add a specific message for the first ANR Dump.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001114 if (ds.anr_data_.size() > 0) {
1115 AddDumps(ds.anr_data_.begin(), ds.anr_data_.begin() + 1,
Narayan Kamathbd863722017-06-01 18:50:12 +01001116 "VM TRACES AT LAST ANR", add_to_zip);
1117
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001118 // The "last" ANR will always be included as separate entry in the zip file. In addition,
1119 // it will be present in the body of the main entry if |add_to_zip| == false.
1120 //
1121 // Historical ANRs are always included as separate entries in the bugreport zip file.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001122 AddDumps(ds.anr_data_.begin() + ((add_to_zip) ? 1 : 0), ds.anr_data_.end(),
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001123 "HISTORICAL ANR", true /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001124 } else {
Narayan Kamath8f788292017-05-25 13:20:39 +01001125 printf("*** NO ANRs to dump in %s\n\n", ANR_DIR.c_str());
1126 }
1127}
1128
1129static void AddAnrTraceFiles() {
Chris Morinc2cba7a2022-02-01 17:06:50 -08001130 const bool add_to_zip = ds.version_ == VERSION_SPLIT_ANR;
Narayan Kamath8f788292017-05-25 13:20:39 +01001131
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001132 std::string anr_traces_dir = "/data/anr";
Narayan Kamath8f788292017-05-25 13:20:39 +01001133
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001134 AddAnrTraceDir(add_to_zip, anr_traces_dir);
Narayan Kamath8f788292017-05-25 13:20:39 +01001135
Makoto Onuki83ec63f2019-01-31 17:08:59 -08001136 RunCommand("ANR FILES", {"ls", "-lt", ANR_DIR});
1137
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001138 // Slow traces for slow operations.
Felipe Lemee184f662016-10-27 10:04:47 -07001139 struct stat st;
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001140 int i = 0;
1141 while (true) {
1142 const std::string slow_trace_path =
1143 anr_traces_dir + android::base::StringPrintf("slow%02d.txt", i);
1144 if (stat(slow_trace_path.c_str(), &st)) {
1145 // No traces file at this index, done with the files.
1146 break;
Felipe Lemee184f662016-10-27 10:04:47 -07001147 }
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001148 ds.DumpFile("VM TRACES WHEN SLOW", slow_trace_path.c_str());
1149 i++;
Felipe Lemee184f662016-10-27 10:04:47 -07001150 }
1151}
1152
Wei Wang509bb5d2017-06-09 14:42:12 -07001153static void DumpBlockStatFiles() {
1154 DurationReporter duration_reporter("DUMP BLOCK STAT");
Wei Wang509bb5d2017-06-09 14:42:12 -07001155
Wei Wang1dc1ef52017-06-12 11:28:37 -07001156 std::unique_ptr<DIR, std::function<int(DIR*)>> dirptr(opendir(BLK_DEV_SYS_DIR), closedir);
1157
1158 if (dirptr == nullptr) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001159 MYLOGE("Failed to open %s: %s\n", BLK_DEV_SYS_DIR, strerror(errno));
1160 return;
1161 }
1162
1163 printf("------ DUMP BLOCK STAT ------\n\n");
Wei Wang1dc1ef52017-06-12 11:28:37 -07001164 while (struct dirent *d = readdir(dirptr.get())) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001165 if ((d->d_name[0] == '.')
1166 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
1167 || (d->d_name[1] == '\0'))) {
1168 continue;
1169 }
1170 const std::string new_path =
1171 android::base::StringPrintf("%s/%s", BLK_DEV_SYS_DIR, d->d_name);
1172 printf("------ BLOCK STAT (%s) ------\n", new_path.c_str());
1173 dump_files("", new_path.c_str(), skip_not_stat, dump_stat_from_fd);
1174 printf("\n");
1175 }
Wei Wang1dc1ef52017-06-12 11:28:37 -07001176 return;
Wei Wang509bb5d2017-06-09 14:42:12 -07001177}
Jayachandran Ca94c7172017-06-10 15:08:12 -07001178
1179static void DumpPacketStats() {
1180 DumpFile("NETWORK DEV INFO", "/proc/net/dev");
Jayachandran Ca94c7172017-06-10 15:08:12 -07001181}
1182
1183static void DumpIpAddrAndRules() {
1184 /* The following have a tendency to get wedged when wifi drivers/fw goes belly-up. */
1185 RunCommand("NETWORK INTERFACES", {"ip", "link"});
1186 RunCommand("IPv4 ADDRESSES", {"ip", "-4", "addr", "show"});
1187 RunCommand("IPv6 ADDRESSES", {"ip", "-6", "addr", "show"});
1188 RunCommand("IP RULES", {"ip", "rule", "show"});
1189 RunCommand("IP RULES v6", {"ip", "-6", "rule", "show"});
1190}
1191
Nandana Dutt5c390032019-03-12 10:52:56 +00001192static Dumpstate::RunStatus RunDumpsysTextByPriority(const std::string& title, int priority,
1193 std::chrono::milliseconds timeout,
1194 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001195 auto start = std::chrono::steady_clock::now();
Vishnu Naire97d6122018-01-18 13:58:56 -08001196 sp<android::IServiceManager> sm = defaultServiceManager();
1197 Dumpsys dumpsys(sm.get());
Vishnu Naire97d6122018-01-18 13:58:56 -08001198 Vector<String16> args;
1199 Dumpsys::setServiceArgs(args, /* asProto = */ false, priority);
Vishnu Naire97d6122018-01-18 13:58:56 -08001200 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ false);
1201 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001202 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001203 std::string path(title);
1204 path.append(" - ").append(String8(service).c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -08001205 size_t bytes_written = 0;
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001206 if (PropertiesHelper::IsDryRun()) {
1207 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1208 dumpsys.writeDumpFooter(STDOUT_FILENO, service, std::chrono::milliseconds(1));
1209 } else {
1210 status_t status = dumpsys.startDumpThread(Dumpsys::TYPE_DUMP, service, args);
1211 if (status == OK) {
1212 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1213 std::chrono::duration<double> elapsed_seconds;
1214 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH &&
1215 service == String16("meminfo")) {
1216 // Use a longer timeout for meminfo, since 30s is not always enough.
1217 status = dumpsys.writeDump(STDOUT_FILENO, service, 60s,
1218 /* as_proto = */ false, elapsed_seconds,
1219 bytes_written);
1220 } else {
1221 status = dumpsys.writeDump(STDOUT_FILENO, service, service_timeout,
1222 /* as_proto = */ false, elapsed_seconds,
1223 bytes_written);
1224 }
1225 dumpsys.writeDumpFooter(STDOUT_FILENO, service, elapsed_seconds);
1226 bool dump_complete = (status == OK);
1227 dumpsys.stopDumpThread(dump_complete);
Gavin Corkeryfac7e2b2021-07-08 22:39:02 +01001228 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001229 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001230
1231 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1232 std::chrono::steady_clock::now() - start);
1233 if (elapsed_duration > timeout) {
1234 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1235 elapsed_duration.count());
1236 break;
1237 }
1238 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001239 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001240}
1241
Vishnu Nair64afc022018-02-01 15:29:34 -08001242static void RunDumpsysText(const std::string& title, int priority,
1243 std::chrono::milliseconds timeout,
1244 std::chrono::milliseconds service_timeout) {
1245 DurationReporter duration_reporter(title);
1246 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1247 fsync(STDOUT_FILENO);
1248 RunDumpsysTextByPriority(title, priority, timeout, service_timeout);
1249}
1250
1251/* Dump all services registered with Normal or Default priority. */
Nandana Dutt5c390032019-03-12 10:52:56 +00001252static Dumpstate::RunStatus RunDumpsysTextNormalPriority(const std::string& title,
1253 std::chrono::milliseconds timeout,
1254 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001255 DurationReporter duration_reporter(title);
1256 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1257 fsync(STDOUT_FILENO);
1258 RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_NORMAL, timeout,
1259 service_timeout);
Nandana Dutt5c390032019-03-12 10:52:56 +00001260
1261 RETURN_IF_USER_DENIED_CONSENT();
1262
1263 return RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_DEFAULT, timeout,
1264 service_timeout);
Vishnu Nair64afc022018-02-01 15:29:34 -08001265}
1266
Nandana Dutt5c390032019-03-12 10:52:56 +00001267static Dumpstate::RunStatus RunDumpsysProto(const std::string& title, int priority,
1268 std::chrono::milliseconds timeout,
1269 std::chrono::milliseconds service_timeout) {
Vishnu Naire97d6122018-01-18 13:58:56 -08001270 sp<android::IServiceManager> sm = defaultServiceManager();
1271 Dumpsys dumpsys(sm.get());
1272 Vector<String16> args;
1273 Dumpsys::setServiceArgs(args, /* asProto = */ true, priority);
1274 DurationReporter duration_reporter(title);
1275
1276 auto start = std::chrono::steady_clock::now();
1277 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ true);
1278 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001279 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001280 std::string path(kProtoPath);
1281 path.append(String8(service).c_str());
1282 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL) {
1283 path.append("_CRITICAL");
1284 } else if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH) {
1285 path.append("_HIGH");
1286 }
1287 path.append(kProtoExt);
Steven Morelandcbd69fc2021-07-20 20:45:43 +00001288 status_t status = dumpsys.startDumpThread(Dumpsys::TYPE_DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001289 if (status == OK) {
1290 status = ds.AddZipEntryFromFd(path, dumpsys.getDumpFd(), service_timeout);
1291 bool dumpTerminated = (status == OK);
1292 dumpsys.stopDumpThread(dumpTerminated);
1293 }
1294 ZipWriter::FileEntry file_entry;
1295 ds.zip_writer_->GetLastEntry(&file_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -08001296
1297 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1298 std::chrono::steady_clock::now() - start);
1299 if (elapsed_duration > timeout) {
1300 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1301 elapsed_duration.count());
1302 break;
1303 }
1304 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001305 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001306}
1307
Nandana Dutta7db6342018-11-21 14:53:34 +00001308// Runs dumpsys on services that must dump first and will take less than 100ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001309static Dumpstate::RunStatus RunDumpsysCritical() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001310 RunDumpsysText("DUMPSYS CRITICAL", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1311 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Nandana Dutt5c390032019-03-12 10:52:56 +00001312
1313 RETURN_IF_USER_DENIED_CONSENT();
1314
1315 return RunDumpsysProto("DUMPSYS CRITICAL PROTO", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1316 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Vishnu Nair780b1282017-10-10 13:57:24 -07001317}
1318
1319// Runs dumpsys on services that must dump first but can take up to 250ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001320static Dumpstate::RunStatus RunDumpsysHigh() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001321 // TODO meminfo takes ~10s, connectivity takes ~5sec to dump. They are both
1322 // high priority. Reduce timeout once they are able to dump in a shorter time or
1323 // moved to a parallel task.
1324 RunDumpsysText("DUMPSYS HIGH", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1325 /* timeout= */ 90s, /* service_timeout= */ 30s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001326
1327 RETURN_IF_USER_DENIED_CONSENT();
1328
1329 return RunDumpsysProto("DUMPSYS HIGH PROTO", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1330 /* timeout= */ 5s, /* service_timeout= */ 1s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001331}
1332
1333// Runs dumpsys on services that must dump but can take up to 10s to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001334static Dumpstate::RunStatus RunDumpsysNormal() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001335 RunDumpsysTextNormalPriority("DUMPSYS", /* timeout= */ 90s, /* service_timeout= */ 10s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001336
1337 RETURN_IF_USER_DENIED_CONSENT();
1338
1339 return RunDumpsysProto("DUMPSYS PROTO", IServiceManager::DUMP_FLAG_PRIORITY_NORMAL,
1340 /* timeout= */ 90s, /* service_timeout= */ 10s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001341}
1342
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001343/*
1344 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1345 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1346 * if it's not running in the parallel task.
1347 */
1348static void DumpHals(int out_fd = STDOUT_FILENO) {
Yifan Hong30528a22020-08-07 18:24:06 -07001349 RunCommand("HARDWARE HALS", {"lshal", "--all", "--types=all"},
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001350 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build(),
1351 false, out_fd);
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001352
Steven Moreland44cd9482018-01-04 16:24:13 -08001353 using android::hidl::manager::V1_0::IServiceManager;
1354 using android::hardware::defaultServiceManager;
1355
1356 sp<IServiceManager> sm = defaultServiceManager();
1357 if (sm == nullptr) {
1358 MYLOGE("Could not retrieve hwservicemanager to dump hals.\n");
1359 return;
1360 }
1361
1362 auto ret = sm->list([&](const auto& interfaces) {
1363 for (const std::string& interface : interfaces) {
1364 std::string cleanName = interface;
1365 std::replace_if(cleanName.begin(),
1366 cleanName.end(),
1367 [](char c) {
1368 return !isalnum(c) &&
1369 std::string("@-_:.").find(c) == std::string::npos;
1370 }, '_');
Nandana Dutt979388e2018-11-30 16:48:55 +00001371 const std::string path = ds.bugreport_internal_dir_ + "/lshal_debug_" + cleanName;
Steven Moreland44cd9482018-01-04 16:24:13 -08001372
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001373 bool empty = false;
Steven Moreland44cd9482018-01-04 16:24:13 -08001374 {
1375 auto fd = android::base::unique_fd(
1376 TEMP_FAILURE_RETRY(open(path.c_str(),
1377 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1378 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1379 if (fd < 0) {
1380 MYLOGE("Could not open %s to dump additional hal information.\n", path.c_str());
1381 continue;
1382 }
1383 RunCommandToFd(fd,
1384 "",
Steven Morelandc81cd3c2018-01-18 14:36:26 -08001385 {"lshal", "debug", "-E", interface},
Steven Moreland44cd9482018-01-04 16:24:13 -08001386 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
1387
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001388 empty = 0 == lseek(fd, 0, SEEK_END);
Steven Moreland44cd9482018-01-04 16:24:13 -08001389 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001390 if (!empty) {
1391 ds.EnqueueAddZipEntryAndCleanupIfNeeded("lshal-debug/" + cleanName + ".txt",
1392 path);
1393 } else {
1394 unlink(path.c_str());
1395 }
Steven Moreland44cd9482018-01-04 16:24:13 -08001396 }
1397 });
1398
1399 if (!ret.isOk()) {
1400 MYLOGE("Could not list hals from hwservicemanager.\n");
1401 }
1402}
1403
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001404static void DumpExternalFragmentationInfo() {
1405 struct stat st;
1406 if (stat("/proc/buddyinfo", &st) != 0) {
1407 MYLOGE("Unable to dump external fragmentation info\n");
1408 return;
1409 }
1410
1411 printf("------ EXTERNAL FRAGMENTATION INFO ------\n");
1412 std::ifstream ifs("/proc/buddyinfo");
1413 auto unusable_index_regex = std::regex{"Node\\s+([0-9]+),\\s+zone\\s+(\\S+)\\s+(.*)"};
1414 for (std::string line; std::getline(ifs, line);) {
1415 std::smatch match_results;
1416 if (std::regex_match(line, match_results, unusable_index_regex)) {
1417 std::stringstream free_pages(std::string{match_results[3]});
1418 std::vector<int> free_pages_per_order(std::istream_iterator<int>{free_pages},
1419 std::istream_iterator<int>());
1420
1421 int total_free_pages = 0;
1422 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1423 total_free_pages += (free_pages_per_order[i] * std::pow(2, i));
1424 }
1425
1426 printf("Node %s, zone %8s", match_results[1].str().c_str(),
1427 match_results[2].str().c_str());
1428
1429 int usable_free_pages = total_free_pages;
1430 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1431 auto unusable_index = (total_free_pages - usable_free_pages) /
1432 static_cast<double>(total_free_pages);
1433 printf(" %5.3f", unusable_index);
1434 usable_free_pages -= (free_pages_per_order[i] * std::pow(2, i));
1435 }
1436
1437 printf("\n");
1438 }
1439 }
1440 printf("\n");
1441}
1442
mhasankd451a472020-05-26 18:02:39 -07001443static void DumpstateLimitedOnly() {
1444 // Trimmed-down version of dumpstate to only include a whitelisted
1445 // set of logs (system log, event log, and system server / system app
1446 // crashes, and networking logs). See b/136273873 and b/138459828
1447 // for context.
1448 DurationReporter duration_reporter("DUMPSTATE");
1449 unsigned long timeout_ms;
1450 // calculate timeout
1451 timeout_ms = logcat_timeout({"main", "system", "crash"});
1452 RunCommand("SYSTEM LOG",
1453 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1454 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1455 timeout_ms = logcat_timeout({"events"});
1456 RunCommand(
1457 "EVENT LOG",
1458 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1459 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1460
1461 printf("========================================================\n");
1462 printf("== Networking Service\n");
1463 printf("========================================================\n");
1464
1465 RunDumpsys("DUMPSYS NETWORK_SERVICE_LIMITED", {"wifi", "-a"},
1466 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hugo Benichiaa162682020-10-30 23:28:56 +09001467 RunDumpsys("DUMPSYS CONNECTIVITY REQUESTS", {"connectivity", "requests"},
1468 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
mhasankd451a472020-05-26 18:02:39 -07001469
1470 printf("========================================================\n");
1471 printf("== Dropbox crashes\n");
1472 printf("========================================================\n");
1473
1474 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1475 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1476
1477 printf("========================================================\n");
1478 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1479 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1480 printf("========================================================\n");
1481 printf("== dumpstate: done (id %d)\n", ds.id_);
1482 printf("========================================================\n");
1483}
1484
Rhed Jaoe017f982020-07-21 17:58:41 +08001485/*
1486 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1487 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1488 * if it's not running in the parallel task.
1489 */
1490static void DumpCheckins(int out_fd = STDOUT_FILENO) {
1491 dprintf(out_fd, "========================================================\n");
1492 dprintf(out_fd, "== Checkins\n");
1493 dprintf(out_fd, "========================================================\n");
1494
1495 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"}, out_fd);
1496 RunDumpsys("CHECKIN MEMINFO", {"meminfo", "--checkin"}, out_fd);
1497 RunDumpsys("CHECKIN NETSTATS", {"netstats", "--checkin"}, out_fd);
1498 RunDumpsys("CHECKIN PROCSTATS", {"procstats", "-c"}, out_fd);
1499 RunDumpsys("CHECKIN USAGESTATS", {"usagestats", "-c"}, out_fd);
1500 RunDumpsys("CHECKIN PACKAGE", {"package", "--checkin"}, out_fd);
1501}
1502
1503/*
1504 * Runs dumpsys on activity service to dump all application activities, services
1505 * and providers in the device.
1506 *
1507 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1508 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1509 * if it's not running in the parallel task.
1510 */
1511static void DumpAppInfos(int out_fd = STDOUT_FILENO) {
1512 dprintf(out_fd, "========================================================\n");
1513 dprintf(out_fd, "== Running Application Activities\n");
1514 dprintf(out_fd, "========================================================\n");
1515
1516 // The following dumpsys internally collects output from running apps, so it can take a long
1517 // time. So let's extend the timeout.
1518
1519 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
1520
1521 RunDumpsys("APP ACTIVITIES", {"activity", "-v", "all"}, DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1522
1523 dprintf(out_fd, "========================================================\n");
1524 dprintf(out_fd, "== Running Application Services (platform)\n");
1525 dprintf(out_fd, "========================================================\n");
1526
1527 RunDumpsys("APP SERVICES PLATFORM", {"activity", "service", "all-platform-non-critical"},
1528 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1529
1530 dprintf(out_fd, "========================================================\n");
1531 dprintf(out_fd, "== Running Application Services (non-platform)\n");
1532 dprintf(out_fd, "========================================================\n");
1533
1534 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1535 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1536
1537 dprintf(out_fd, "========================================================\n");
1538 dprintf(out_fd, "== Running Application Providers (platform)\n");
1539 dprintf(out_fd, "========================================================\n");
1540
1541 RunDumpsys("APP PROVIDERS PLATFORM", {"activity", "provider", "all-platform"},
Rhed Jaob049f182021-01-11 21:08:43 +08001542 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
Rhed Jaoe017f982020-07-21 17:58:41 +08001543
1544 dprintf(out_fd, "========================================================\n");
1545 dprintf(out_fd, "== Running Application Providers (non-platform)\n");
1546 dprintf(out_fd, "========================================================\n");
1547
1548 RunDumpsys("APP PROVIDERS NON-PLATFORM", {"activity", "provider", "all-non-platform"},
1549 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1550}
1551
Nandana Dutt5c390032019-03-12 10:52:56 +00001552// Dumps various things. Returns early with status USER_CONSENT_DENIED if user denies consent
1553// via the consent they are shown. Ignores other errors that occur while running various
1554// commands. The consent checking is currently done around long running tasks, which happen to
1555// be distributed fairly evenly throughout the function.
1556static Dumpstate::RunStatus dumpstate() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001557 DurationReporter duration_reporter("DUMPSTATE");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001558
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001559 // Enqueue slow functions into the thread pool, if the parallel run is enabled.
1560 if (ds.dump_pool_) {
1561 // Pool was shutdown in DumpstateDefaultAfterCritical method in order to
1562 // drop root user. Restarts it with two threads for the parallel run.
1563 ds.dump_pool_->start(/* thread_counts = */2);
1564
1565 ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
1566 ds.dump_pool_->enqueueTask(DUMP_INCIDENT_REPORT_TASK, &DumpIncidentReport);
1567 ds.dump_pool_->enqueueTaskWithFd(DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
Rhed Jaoe017f982020-07-21 17:58:41 +08001568 ds.dump_pool_->enqueueTaskWithFd(DUMP_CHECKINS_TASK, &DumpCheckins, _1);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001569 }
1570
Nandana Dutt5c390032019-03-12 10:52:56 +00001571 // Dump various things. Note that anything that takes "long" (i.e. several seconds) should
1572 // check intermittently (if it's intrerruptable like a foreach on pids) and/or should be wrapped
1573 // in a consent check (via RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK).
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -07001574 dump_dev_files("TRUSTY VERSION", "/sys/bus/platform/drivers/trusty", "trusty_version");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001575 RunCommand("UPTIME", {"uptime"});
Wei Wang509bb5d2017-06-09 14:42:12 -07001576 DumpBlockStatFiles();
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001577 DumpFile("MEMORY INFO", "/proc/meminfo");
1578 RunCommand("CPU INFO", {"top", "-b", "-n", "1", "-H", "-s", "6", "-o",
Felipe Leme30dbfa12016-09-02 12:43:26 -07001579 "pid,tid,user,pr,ni,%cpu,s,virt,res,pcy,cmd,name"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001580
1581 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "PROCRANK", {"procrank"}, AS_ROOT_20);
1582
Sunny Goyal35949782019-11-19 15:54:36 -08001583 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpVisibleWindowViews);
1584
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001585 DumpFile("VIRTUAL MEMORY STATS", "/proc/vmstat");
1586 DumpFile("VMALLOC INFO", "/proc/vmallocinfo");
1587 DumpFile("SLAB INFO", "/proc/slabinfo");
1588 DumpFile("ZONEINFO", "/proc/zoneinfo");
1589 DumpFile("PAGETYPEINFO", "/proc/pagetypeinfo");
1590 DumpFile("BUDDYINFO", "/proc/buddyinfo");
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001591 DumpExternalFragmentationInfo();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001592
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001593 DumpFile("KERNEL WAKE SOURCES", "/d/wakeup_sources");
1594 DumpFile("KERNEL CPUFREQ", "/sys/devices/system/cpu/cpu0/cpufreq/stats/time_in_state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001595
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001596 RunCommand("PROCESSES AND THREADS",
Yohei Yukawa591a72d2017-10-05 21:36:35 -07001597 {"ps", "-A", "-T", "-Z", "-O", "pri,nice,rtprio,sched,pcy,time"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001598
1599 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "LIBRANK", {"librank"},
1600 CommandOptions::AS_ROOT);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001601
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001602 if (ds.dump_pool_) {
1603 WAIT_TASK_WITH_CONSENT_CHECK(DUMP_HALS_TASK, ds.dump_pool_);
1604 } else {
1605 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_HALS_TASK, DumpHals);
1606 }
Steven Moreland81b429e2017-01-31 19:50:46 -08001607
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001608 RunCommand("PRINTENV", {"printenv"});
Elliott Hughes21b7c8d2016-10-28 08:53:02 -07001609 RunCommand("NETSTAT", {"netstat", "-nW"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001610 struct stat s;
1611 if (stat("/proc/modules", &s) != 0) {
1612 MYLOGD("Skipping 'lsmod' because /proc/modules does not exist\n");
1613 } else {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001614 RunCommand("LSMOD", {"lsmod"});
Woody Linc198f252021-05-04 16:37:11 +08001615 RunCommand("MODULES INFO",
1616 {"sh", "-c", "cat /proc/modules | cut -d' ' -f1 | "
1617 " while read MOD ; do echo modinfo:$MOD ; modinfo $MOD ; "
1618 "done"}, CommandOptions::AS_ROOT);
Felipe Lemee4eca582016-06-10 17:48:08 -07001619 }
Michal Karpinski4db754f2015-12-11 18:04:32 +00001620
Tom Cherryb87dbfa2020-07-28 11:28:53 -07001621 if (android::base::GetBoolProperty("ro.logd.kernel", false)) {
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001622 DoKernelLogcat();
1623 } else {
1624 do_dmesg();
1625 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001626
Felipe Lemef0292972016-11-22 13:57:05 -08001627 RunCommand("LIST OF OPEN FILES", {"lsof"}, CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001628
1629 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(for_each_pid, do_showmap, "SMAPS OF ALL PROCESSES");
1630
Jeff Brown1dc94e32014-09-11 14:15:27 -07001631 for_each_tid(show_wchan, "BLOCKED PROCESS WAIT-CHANNELS");
Mark Salyzyna297c322016-02-05 15:33:17 -08001632 for_each_pid(show_showtime, "PROCESS TIMES (pid cmd user system iowait+percentage)");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001633
Jack Yu5a6b2e22020-08-14 18:13:35 +08001634 /* Dump Nfc NCI logs */
1635 ds.AddDir("/data/misc/nfc/logs", true);
Ajay Panickerd886ec42016-09-14 12:26:46 -07001636
Paul Chang0d2aad72020-02-13 20:04:03 +08001637 if (ds.options_->do_screenshot && !ds.do_early_screenshot_) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001638 MYLOGI("taking late screenshot\n");
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001639 ds.TakeScreenshot();
Jeff Sharkey5a930032013-03-19 15:05:19 -07001640 }
1641
Felipe Lemee184f662016-10-27 10:04:47 -07001642 AddAnrTraceFiles();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001643
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001644 MaybeAddSystemTraceToZip();
1645
Narayan Kamath8f788292017-05-25 13:20:39 +01001646 // NOTE: tombstones are always added as separate entries in the zip archive
1647 // and are not interspersed with the main report.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001648 const bool tombstones_dumped = AddDumps(ds.tombstone_data_.begin(), ds.tombstone_data_.end(),
Narayan Kamathbd863722017-06-01 18:50:12 +01001649 "TOMBSTONE", true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001650 if (!tombstones_dumped) {
1651 printf("*** NO TOMBSTONES to dump in %s\n\n", TOMBSTONE_DIR.c_str());
Christopher Ferris7dc7f322014-07-22 16:08:19 -07001652 }
1653
Jayachandran Ca94c7172017-06-10 15:08:12 -07001654 DumpPacketStats();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001655
Chenbo Feng276a3b62018-08-07 11:44:49 -07001656 RunDumpsys("EBPF MAP STATS", {"netd", "trafficcontroller"});
1657
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001658 DoKmsg();
Mark Salyzyn2262c162014-12-16 09:09:26 -08001659
Jayachandran Ca94c7172017-06-10 15:08:12 -07001660 DumpIpAddrAndRules();
Sreeram Ramachandran2b3bba32014-07-08 15:40:55 -07001661
1662 dump_route_tables();
1663
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001664 RunCommand("ARP CACHE", {"ip", "-4", "neigh", "show"});
1665 RunCommand("IPv6 ND CACHE", {"ip", "-6", "neigh", "show"});
1666 RunCommand("MULTICAST ADDRESSES", {"ip", "maddr"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001667
Nandana Dutt5c390032019-03-12 10:52:56 +00001668 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysHigh);
Lorenzo Colitti6afc38c2015-09-09 22:59:25 +09001669
Chiachang Wang668ede42021-05-17 17:14:20 +08001670 // The dump mechanism in connectivity is refactored due to modularization work. Connectivity can
1671 // only register with a default priority(NORMAL priority). Dumpstate has to call connectivity
1672 // dump with priority parameters to dump high priority information.
1673 RunDumpsys("SERVICE HIGH connectivity", {"connectivity", "--dump-priority", "HIGH"},
1674 CommandOptions::WithTimeout(10).Build());
1675
Elliott Hughes23ccc622017-02-28 10:14:22 -08001676 RunCommand("SYSTEM PROPERTIES", {"getprop"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001677
Jin Qianf334d662017-10-10 14:41:37 -07001678 RunCommand("STORAGED IO INFO", {"storaged", "-u", "-p"});
ynwangf649a6e2016-07-17 21:56:00 -07001679
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001680 RunCommand("FILESYSTEMS & FREE SPACE", {"df"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001681
Colin Crossf45fa6b2012-03-26 12:38:26 -07001682 /* Binder state is expensive to look at as it uses a lot of memory. */
Hridya Valsaraju920ba712020-02-09 16:27:01 -08001683 std::string binder_logs_dir = access("/dev/binderfs/binder_logs", R_OK) ?
1684 "/sys/kernel/debug/binder" : "/dev/binderfs/binder_logs";
1685
1686 DumpFile("BINDER FAILED TRANSACTION LOG", binder_logs_dir + "/failed_transaction_log");
1687 DumpFile("BINDER TRANSACTION LOG", binder_logs_dir + "/transaction_log");
1688 DumpFile("BINDER TRANSACTIONS", binder_logs_dir + "/transactions");
1689 DumpFile("BINDER STATS", binder_logs_dir + "/stats");
1690 DumpFile("BINDER STATE", binder_logs_dir + "/state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001691
Vishnu Nair36b4cdb2017-11-17 10:27:05 -08001692 /* Add window and surface trace files. */
1693 if (!PropertiesHelper::IsUserBuild()) {
1694 ds.AddDir(WMTRACE_DATA_DIR, false);
1695 }
1696
Yifan Hongd90cc652020-02-08 16:52:02 -08001697 ds.AddDir(SNAPSHOTCTL_LOG_DIR, false);
1698
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001699 if (ds.dump_pool_) {
1700 WAIT_TASK_WITH_CONSENT_CHECK(DUMP_BOARD_TASK, ds.dump_pool_);
1701 } else {
1702 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
1703 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001704
Steven Moreland7440ddb2016-12-15 16:13:39 -08001705 /* Migrate the ril_dumpstate to a device specific dumpstate? */
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001706 int rilDumpstateTimeout = android::base::GetIntProperty("ril.dumpstate.timeout", 0);
1707 if (rilDumpstateTimeout > 0) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001708 // su does not exist on user builds, so try running without it.
1709 // This way any implementations of vril-dump that do not require
1710 // root can run on user builds.
1711 CommandOptions::CommandOptionsBuilder options =
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001712 CommandOptions::WithTimeout(rilDumpstateTimeout);
Felipe Lemef0292972016-11-22 13:57:05 -08001713 if (!PropertiesHelper::IsUserBuild()) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001714 options.AsRoot();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001715 }
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001716 RunCommand("DUMP VENDOR RIL LOGS", {"vril-dump"}, options.Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -07001717 }
1718
Felipe Lemed8b94e52016-12-08 10:21:44 -08001719 printf("========================================================\n");
1720 printf("== Android Framework Services\n");
1721 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001722
Nandana Dutt5c390032019-03-12 10:52:56 +00001723 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysNormal);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001724
Jack He91ff2fe2021-02-18 18:23:43 -08001725 /* Dump Bluetooth HCI logs after getting bluetooth_manager dumpsys */
1726 ds.AddDir("/data/misc/bluetooth/logs", true);
1727
Rhed Jaoe017f982020-07-21 17:58:41 +08001728 if (ds.dump_pool_) {
1729 WAIT_TASK_WITH_CONSENT_CHECK(DUMP_CHECKINS_TASK, ds.dump_pool_);
1730 } else {
1731 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_CHECKINS_TASK, DumpCheckins);
1732 }
Dianne Hackborn02bea972013-06-26 18:59:09 -07001733
Rhed Jaoc5f7ec32020-12-22 22:11:08 +08001734 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpAppInfos);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001735
Adrian Roos8b397ab2017-04-04 16:35:44 -07001736 printf("========================================================\n");
1737 printf("== Dropbox crashes\n");
1738 printf("========================================================\n");
1739
1740 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1741 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1742
Felipe Lemed8b94e52016-12-08 10:21:44 -08001743 printf("========================================================\n");
1744 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1745 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1746 printf("========================================================\n");
1747 printf("== dumpstate: done (id %d)\n", ds.id_);
1748 printf("========================================================\n");
Bookatz38472142018-09-28 10:20:24 -07001749
1750 printf("========================================================\n");
1751 printf("== Obtaining statsd metadata\n");
1752 printf("========================================================\n");
1753 // This differs from the usual dumpsys stats, which is the stats report data.
1754 RunDumpsys("STATSDSTATS", {"stats", "--metadata"});
Mike Ma5c267872019-08-21 11:31:34 -07001755
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +09001756 // Add linker configuration directory
1757 ds.AddDir(LINKERCONFIG_DIR, true);
1758
Li Li830179f2022-01-04 12:53:29 -08001759 /* Dump frozen cgroupfs */
1760 dump_frozen_cgroupfs();
Li Li2eedd412021-06-30 15:11:53 -07001761
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001762 if (ds.dump_pool_) {
1763 WAIT_TASK_WITH_CONSENT_CHECK(DUMP_INCIDENT_REPORT_TASK, ds.dump_pool_);
1764 } else {
1765 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_INCIDENT_REPORT_TASK,
1766 DumpIncidentReport);
1767 }
Mike Ma5c267872019-08-21 11:31:34 -07001768
Nandana Dutt5c390032019-03-12 10:52:56 +00001769 return Dumpstate::RunStatus::OK;
Colin Crossf45fa6b2012-03-26 12:38:26 -07001770}
1771
Nandana Dutt5c390032019-03-12 10:52:56 +00001772/*
1773 * Dumps state for the default case; drops root after it's no longer necessary.
1774 *
1775 * Returns RunStatus::OK if everything went fine.
1776 * Returns RunStatus::ERROR if there was an error.
1777 * Returns RunStatus::USER_DENIED_CONSENT if user explicitly denied consent to sharing the bugreport
1778 * with the caller.
1779 */
Jichao Lie89d9c12019-11-21 19:02:51 -08001780Dumpstate::RunStatus Dumpstate::DumpstateDefaultAfterCritical() {
Nandana Duttdb379fa2019-10-09 16:54:41 +01001781 // Capture first logcat early on; useful to take a snapshot before dumpstate logs take over the
1782 // buffer.
1783 DoLogcat();
1784 // Capture timestamp after first logcat to use in next logcat
1785 time_t logcat_ts = time(nullptr);
1786
Nandana Dutt4be45d12018-09-26 15:04:23 +01001787 /* collect stack traces from Dalvik and native processes (needs root) */
Rhed Jao5377d792020-07-16 17:37:39 +08001788 if (dump_pool_) {
1789 RETURN_IF_USER_DENIED_CONSENT();
1790 // One thread is enough since we only need to enqueue DumpTraces here.
1791 dump_pool_->start(/* thread_counts = */1);
1792
1793 // DumpTraces takes long time, post it to the another thread in the
1794 // pool, if pool is available
1795 dump_pool_->enqueueTask(DUMP_TRACES_TASK, &Dumpstate::DumpTraces, &ds, &dump_traces_path);
1796 } else {
1797 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_TRACES_TASK, ds.DumpTraces,
1798 &dump_traces_path);
1799 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001800
1801 /* Run some operations that require root. */
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001802 if (!PropertiesHelper::IsDryRun()) {
Chris Morinc2cba7a2022-02-01 17:06:50 -08001803 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX);
1804 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX);
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001805 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001806
1807 ds.AddDir(RECOVERY_DIR, true);
1808 ds.AddDir(RECOVERY_DATA_DIR, true);
1809 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
1810 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1811 if (!PropertiesHelper::IsUserBuild()) {
1812 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1813 ds.AddDir(PROFILE_DATA_DIR_REF, true);
Calin Juravlef84d3692020-04-28 15:31:12 -07001814 ds.AddZipEntry(ZIP_ROOT_DIR + PACKAGE_DEX_USE_LIST, PACKAGE_DEX_USE_LIST);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001815 }
Jerry Changa1df8a92020-01-02 16:03:39 +08001816 ds.AddDir(PREREBOOT_DATA_DIR, false);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001817 add_mountinfo();
1818 DumpIpTablesAsRoot();
David Andersond9ba4752018-12-11 18:26:59 -08001819 DumpDynamicPartitionInfo();
Yifan Hong3945e1b2019-10-29 12:59:23 -07001820 ds.AddDir(OTA_METADATA_DIR, true);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001821
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001822 // Capture any IPSec policies in play. No keys are exposed here.
Nandana Dutt4be45d12018-09-26 15:04:23 +01001823 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1824
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001825 // Dump IPsec stats. No keys are exposed here.
1826 DumpFile("XFRM STATS", XFRM_STAT_PROC_FILE);
1827
Nandana Dutt4be45d12018-09-26 15:04:23 +01001828 // Run ss as root so we can see socket marks.
1829 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
1830
1831 // Run iotop as root to show top 100 IO threads
1832 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
1833
Erick Reyese68df822019-02-11 14:46:36 -08001834 // Gather shared memory buffer info if the product implements it
Hridya Valsaraju1da80c52021-01-09 22:10:11 -08001835 RunCommand("Dmabuf dump", {"dmabuf_dump"});
1836 RunCommand("Dmabuf per-buffer/per-exporter/per-device stats", {"dmabuf_dump", "-b"});
Erick Reyese68df822019-02-11 14:46:36 -08001837
Minchan Kim22c6a1e2019-09-30 15:58:10 -07001838 DumpFile("PSI cpu", "/proc/pressure/cpu");
1839 DumpFile("PSI memory", "/proc/pressure/memory");
1840 DumpFile("PSI io", "/proc/pressure/io");
1841
Rhed Jao5377d792020-07-16 17:37:39 +08001842 if (dump_pool_) {
1843 RETURN_IF_USER_DENIED_CONSENT();
1844 dump_pool_->waitForTask(DUMP_TRACES_TASK);
1845
1846 // Current running thread in the pool is the root user also. Shutdown
1847 // the pool and restart later to ensure all threads in the pool could
1848 // drop the root user.
1849 dump_pool_->shutdown();
1850 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001851 if (!DropRootUser()) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001852 return Dumpstate::RunStatus::ERROR;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001853 }
1854
Nandana Dutt5c390032019-03-12 10:52:56 +00001855 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttdb379fa2019-10-09 16:54:41 +01001856 Dumpstate::RunStatus status = dumpstate();
1857 // Capture logcat since the last time we did it.
1858 DoSystemLogcat(logcat_ts);
1859 return status;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001860}
1861
Rhed Jaob5685b32020-08-14 17:19:17 +08001862// Common states for telephony and wifi which are needed to be collected before
1863// dumpstate drop the root user.
1864static void DumpstateRadioAsRoot() {
1865 DumpIpTablesAsRoot();
1866 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1867}
1868
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001869// This method collects common dumpsys for telephony and wifi. Typically, wifi
1870// reports are fine to include all information, but telephony reports on user
1871// builds need to strip some content (see DumpstateTelephonyOnly).
1872static void DumpstateRadioCommon(bool include_sensitive_info = true) {
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001873 // We need to be picky about some stuff for telephony reports on user builds.
1874 if (!include_sensitive_info) {
1875 // Only dump the radio log buffer (other buffers and dumps contain too much unrelated info).
1876 DoRadioLogcat();
1877 } else {
Rhed Jaob5685b32020-08-14 17:19:17 +08001878 // DumpHals takes long time, post it to the another thread in the pool,
1879 // if pool is available.
1880 if (ds.dump_pool_) {
1881 ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
1882 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001883 // Contains various system properties and process startup info.
1884 do_dmesg();
1885 // Logs other than the radio buffer may contain package/component names and potential PII.
1886 DoLogcat();
1887 // Too broad for connectivity problems.
1888 DoKmsg();
Rhed Jaob5685b32020-08-14 17:19:17 +08001889 // DumpHals contains unrelated hardware info (camera, NFC, biometrics, ...).
1890 if (ds.dump_pool_) {
1891 ds.dump_pool_->waitForTask(DUMP_HALS_TASK);
1892 } else {
1893 RUN_SLOW_FUNCTION_AND_LOG(DUMP_HALS_TASK, DumpHals);
1894 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001895 }
1896
Jayachandran Ca94c7172017-06-10 15:08:12 -07001897 DumpPacketStats();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001898 DumpIpAddrAndRules();
1899 dump_route_tables();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001900 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
1901 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08001902}
1903
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001904// We use "telephony" here for legacy reasons, though this now really means "connectivity" (cellular
1905// + wifi + networking). This method collects dumpsys for connectivity debugging only. General rules
1906// for what can be included on user builds: all reported information MUST directly relate to
1907// connectivity debugging or customer support and MUST NOT contain unrelated personally identifiable
1908// information. This information MUST NOT identify user-installed packages (UIDs are OK, package
1909// names are not), and MUST NOT contain logs of user application traffic.
1910// TODO(b/148168577) rename this and other related fields/methods to "connectivity" instead.
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08001911static void DumpstateTelephonyOnly(const std::string& calling_package) {
mukesh agrawal253dad42018-01-23 21:59:59 -08001912 DurationReporter duration_reporter("DUMPSTATE");
Jichao Lie89d9c12019-11-21 19:02:51 -08001913
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001914 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08001915
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001916 const bool include_sensitive_info = !PropertiesHelper::IsUserBuild();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001917
Rhed Jaob5685b32020-08-14 17:19:17 +08001918 DumpstateRadioAsRoot();
1919 if (!DropRootUser()) {
1920 return;
1921 }
1922
1923 // Starts thread pool after the root user is dropped, and two additional threads
1924 // are created for DumpHals in the DumpstateRadioCommon and DumpstateBoard.
1925 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.
1930 ds.dump_pool_->enqueueTaskWithFd(DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
1931 }
1932
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001933 DumpstateRadioCommon(include_sensitive_info);
1934
1935 if (include_sensitive_info) {
1936 // Contains too much unrelated PII, and given the unstructured nature of sysprops, we can't
1937 // really cherrypick all of the connectivity-related ones. Apps generally have no business
1938 // reading these anyway, and there should be APIs to supply the info in a more app-friendly
1939 // way.
1940 RunCommand("SYSTEM PROPERTIES", {"getprop"});
1941 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07001942
1943 printf("========================================================\n");
1944 printf("== Android Framework Services\n");
1945 printf("========================================================\n");
1946
Vishnu Nair652cc802017-11-30 15:18:30 -08001947 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1948 SEC_TO_MSEC(10));
Hunter Knepshield31cbae12021-05-11 16:23:24 -07001949 RunDumpsys("DUMPSYS", {"vcn_management"}, CommandOptions::WithTimeout(90).Build(),
1950 SEC_TO_MSEC(10));
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08001951 if (include_sensitive_info) {
1952 // Carrier apps' services will be dumped below in dumpsys activity service all-non-platform.
1953 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
1954 SEC_TO_MSEC(10));
1955 } else {
1956 // If the caller is a carrier app and has a carrier service, dump it here since we aren't
1957 // running dumpsys activity service all-non-platform below. Due to the increased output, we
1958 // give a higher timeout as well.
1959 RunDumpsys("DUMPSYS", {"carrier_config", "--requesting-package", calling_package},
1960 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(30));
1961 }
1962 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001963 RunDumpsys("DUMPSYS", {"netpolicy"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
1964 RunDumpsys("DUMPSYS", {"network_management"}, CommandOptions::WithTimeout(90).Build(),
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07001965 SEC_TO_MSEC(10));
Hunter Knepshield0fe51b12020-03-05 16:58:20 -08001966 RunDumpsys("DUMPSYS", {"telephony.registry"}, CommandOptions::WithTimeout(90).Build(),
1967 SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001968 if (include_sensitive_info) {
1969 // Contains raw IP addresses, omit from reports on user builds.
1970 RunDumpsys("DUMPSYS", {"netd"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
1971 // Contains raw destination IP/MAC addresses, omit from reports on user builds.
1972 RunDumpsys("DUMPSYS", {"connmetrics"}, CommandOptions::WithTimeout(90).Build(),
1973 SEC_TO_MSEC(10));
1974 // Contains package/component names, omit from reports on user builds.
1975 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
1976 SEC_TO_MSEC(10));
1977 // Contains package names, but should be relatively simple to remove them (also contains
1978 // UIDs already), omit from reports on user builds.
1979 RunDumpsys("BATTERYSTATS", {"deviceidle"}, CommandOptions::WithTimeout(90).Build(),
1980 SEC_TO_MSEC(10));
1981 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07001982
1983 printf("========================================================\n");
1984 printf("== Running Application Services\n");
1985 printf("========================================================\n");
1986
1987 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
1988
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001989 if (include_sensitive_info) {
1990 printf("========================================================\n");
1991 printf("== Running Application Services (non-platform)\n");
1992 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001993
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001994 // Contains package/component names and potential PII, omit from reports on user builds.
1995 // To get dumps of the active CarrierService(s) on user builds, we supply an argument to the
1996 // carrier_config dumpsys instead.
1997 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1998 DUMPSYS_COMPONENTS_OPTIONS);
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001999
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002000 printf("========================================================\n");
2001 printf("== Checkins\n");
2002 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002003
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002004 // Contains package/component names, omit from reports on user builds.
2005 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
2006 }
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002007
2008 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07002009 printf("== dumpstate: done (id %d)\n", ds.id_);
2010 printf("========================================================\n");
Rhed Jaob5685b32020-08-14 17:19:17 +08002011
2012 if (ds.dump_pool_) {
2013 ds.dump_pool_->waitForTask(DUMP_BOARD_TASK);
2014 } else {
2015 RUN_SLOW_FUNCTION_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
2016 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002017}
2018
mukesh agrawal253dad42018-01-23 21:59:59 -08002019// This method collects dumpsys for wifi debugging only
2020static void DumpstateWifiOnly() {
2021 DurationReporter duration_reporter("DUMPSTATE");
2022
Rhed Jaob5685b32020-08-14 17:19:17 +08002023 DumpstateRadioAsRoot();
2024 if (!DropRootUser()) {
2025 return;
2026 }
2027
2028 // Starts thread pool after the root user is dropped. Only one additional
2029 // thread is needed for DumpHals in the DumpstateRadioCommon.
2030 if (ds.dump_pool_) {
2031 ds.dump_pool_->start(/*thread_counts =*/1);
2032 }
2033
mukesh agrawal253dad42018-01-23 21:59:59 -08002034 DumpstateRadioCommon();
2035
2036 printf("========================================================\n");
2037 printf("== Android Framework Services\n");
2038 printf("========================================================\n");
2039
2040 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
2041 SEC_TO_MSEC(10));
2042 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
2043 SEC_TO_MSEC(10));
2044
2045 printf("========================================================\n");
2046 printf("== dumpstate: done (id %d)\n", ds.id_);
2047 printf("========================================================\n");
2048}
2049
Nandana Duttcf419a72019-03-14 10:40:17 +00002050Dumpstate::RunStatus Dumpstate::DumpTraces(const char** path) {
Gavin Corkery789d7a52021-02-24 23:52:35 +00002051 const std::string temp_file_pattern = ds.bugreport_internal_dir_ + "/dumptrace_XXXXXX";
Nandana Duttfaafd522019-03-11 09:23:09 +00002052 const size_t buf_size = temp_file_pattern.length() + 1;
2053 std::unique_ptr<char[]> file_name_buf(new char[buf_size]);
2054 memcpy(file_name_buf.get(), temp_file_pattern.c_str(), buf_size);
2055
2056 // Create a new, empty file to receive all trace dumps.
2057 //
2058 // TODO: This can be simplified once we remove support for the old style
2059 // dumps. We can have a file descriptor passed in to dump_traces instead
2060 // of creating a file, closing it and then reopening it again.
2061 android::base::unique_fd fd(mkostemp(file_name_buf.get(), O_APPEND | O_CLOEXEC));
2062 if (fd < 0) {
2063 MYLOGE("mkostemp on pattern %s: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002064 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002065 }
2066
2067 // Nobody should have access to this temporary file except dumpstate, but we
2068 // temporarily grant 'read' to 'others' here because this file is created
2069 // when tombstoned is still running as root, but dumped after dropping. This
2070 // can go away once support for old style dumping has.
2071 const int chmod_ret = fchmod(fd, 0666);
2072 if (chmod_ret < 0) {
2073 MYLOGE("fchmod on %s failed: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002074 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002075 }
2076
2077 std::unique_ptr<DIR, decltype(&closedir)> proc(opendir("/proc"), closedir);
2078 if (proc.get() == nullptr) {
2079 MYLOGE("opendir /proc failed: %s\n", strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002080 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002081 }
2082
2083 // Number of times process dumping has timed out. If we encounter too many
2084 // failures, we'll give up.
2085 int timeout_failures = 0;
2086 bool dalvik_found = false;
2087
2088 const std::set<int> hal_pids = get_interesting_hal_pids();
2089
2090 struct dirent* d;
2091 while ((d = readdir(proc.get()))) {
Nandana Duttcf419a72019-03-14 10:40:17 +00002092 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttfaafd522019-03-11 09:23:09 +00002093 int pid = atoi(d->d_name);
2094 if (pid <= 0) {
2095 continue;
2096 }
2097
2098 const std::string link_name = android::base::StringPrintf("/proc/%d/exe", pid);
2099 std::string exe;
2100 if (!android::base::Readlink(link_name, &exe)) {
2101 continue;
2102 }
2103
2104 bool is_java_process;
2105 if (exe == "/system/bin/app_process32" || exe == "/system/bin/app_process64") {
2106 // Don't bother dumping backtraces for the zygote.
2107 if (IsZygote(pid)) {
2108 continue;
2109 }
2110
2111 dalvik_found = true;
2112 is_java_process = true;
2113 } else if (should_dump_native_traces(exe.c_str()) || hal_pids.find(pid) != hal_pids.end()) {
2114 is_java_process = false;
2115 } else {
2116 // Probably a native process we don't care about, continue.
2117 continue;
2118 }
2119
2120 // If 3 backtrace dumps fail in a row, consider debuggerd dead.
2121 if (timeout_failures == 3) {
2122 dprintf(fd, "ERROR: Too many stack dump failures, exiting.\n");
2123 break;
2124 }
2125
2126 const uint64_t start = Nanotime();
2127 const int ret = dump_backtrace_to_file_timeout(
2128 pid, is_java_process ? kDebuggerdJavaBacktrace : kDebuggerdNativeBacktrace,
2129 is_java_process ? 5 : 20, fd);
2130
2131 if (ret == -1) {
2132 // For consistency, the header and footer to this message match those
2133 // dumped by debuggerd in the success case.
2134 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
2135 dprintf(fd, "Dump failed, likely due to a timeout.\n");
2136 dprintf(fd, "---- end %d ----", pid);
2137 timeout_failures++;
2138 continue;
2139 }
2140
2141 // We've successfully dumped stack traces, reset the failure count
2142 // and write a summary of the elapsed time to the file and continue with the
2143 // next process.
2144 timeout_failures = 0;
2145
2146 dprintf(fd, "[dump %s stack %d: %.3fs elapsed]\n", is_java_process ? "dalvik" : "native",
2147 pid, (float)(Nanotime() - start) / NANOS_PER_SEC);
2148 }
2149
2150 if (!dalvik_found) {
2151 MYLOGE("Warning: no Dalvik processes found to dump stacks\n");
2152 }
2153
Nandana Duttcf419a72019-03-14 10:40:17 +00002154 *path = file_name_buf.release();
2155 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002156}
2157
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002158static dumpstate_hal_hidl::DumpstateMode GetDumpstateHalModeHidl(
2159 const Dumpstate::BugreportMode bugreport_mode) {
2160 switch (bugreport_mode) {
2161 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2162 return dumpstate_hal_hidl::DumpstateMode::FULL;
2163 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2164 return dumpstate_hal_hidl::DumpstateMode::INTERACTIVE;
2165 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2166 return dumpstate_hal_hidl::DumpstateMode::REMOTE;
2167 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2168 return dumpstate_hal_hidl::DumpstateMode::WEAR;
2169 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2170 return dumpstate_hal_hidl::DumpstateMode::CONNECTIVITY;
2171 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2172 return dumpstate_hal_hidl::DumpstateMode::WIFI;
2173 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2174 return dumpstate_hal_hidl::DumpstateMode::DEFAULT;
2175 }
2176 return dumpstate_hal_hidl::DumpstateMode::DEFAULT;
2177}
2178
2179static dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode GetDumpstateHalModeAidl(
2180 const Dumpstate::BugreportMode bugreport_mode) {
2181 switch (bugreport_mode) {
2182 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2183 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::FULL;
2184 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2185 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::INTERACTIVE;
2186 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2187 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::REMOTE;
2188 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2189 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::WEAR;
2190 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2191 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::CONNECTIVITY;
2192 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2193 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::WIFI;
2194 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2195 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::DEFAULT;
2196 }
2197 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::DEFAULT;
2198}
2199
2200static void DoDumpstateBoardHidl(
2201 const sp<dumpstate_hal_hidl_1_0::IDumpstateDevice> dumpstate_hal_1_0,
2202 const std::vector<::ndk::ScopedFileDescriptor>& dumpstate_fds,
2203 const Dumpstate::BugreportMode bugreport_mode,
2204 const size_t timeout_sec) {
2205
2206 using ScopedNativeHandle =
2207 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
2208 ScopedNativeHandle handle(native_handle_create(static_cast<int>(dumpstate_fds.size()), 0),
2209 [](native_handle_t* handle) {
2210 // we don't close file handle's here
2211 // via native_handle_close(handle)
2212 // instead we let dumpstate_fds close the file handles when
2213 // dumpstate_fds gets destroyed
2214 native_handle_delete(handle);
2215 });
2216 if (handle == nullptr) {
2217 MYLOGE("Could not create native_handle for dumpstate HAL\n");
2218 return;
2219 }
2220
2221 for (size_t i = 0; i < dumpstate_fds.size(); i++) {
2222 handle.get()->data[i] = dumpstate_fds[i].get();
2223 }
2224
2225 // Prefer version 1.1 if available. New devices launching with R are no longer allowed to
2226 // implement just 1.0.
2227 const char* descriptor_to_kill;
2228 using DumpstateBoardTask = std::packaged_task<bool()>;
2229 DumpstateBoardTask dumpstate_board_task;
2230 sp<dumpstate_hal_hidl::IDumpstateDevice> dumpstate_hal(
2231 dumpstate_hal_hidl::IDumpstateDevice::castFrom(dumpstate_hal_1_0));
2232 if (dumpstate_hal != nullptr) {
2233 MYLOGI("Using IDumpstateDevice v1.1 HIDL HAL");
2234
2235 dumpstate_hal_hidl::DumpstateMode dumpstate_hal_mode =
2236 GetDumpstateHalModeHidl(bugreport_mode);
2237
2238 descriptor_to_kill = dumpstate_hal_hidl::IDumpstateDevice::descriptor;
2239 dumpstate_board_task =
2240 DumpstateBoardTask([timeout_sec, dumpstate_hal_mode, dumpstate_hal, &handle]() -> bool {
2241 ::android::hardware::Return<dumpstate_hal_hidl::DumpstateStatus> status =
2242 dumpstate_hal->dumpstateBoard_1_1(handle.get(), dumpstate_hal_mode,
2243 SEC_TO_MSEC(timeout_sec));
2244 if (!status.isOk()) {
2245 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2246 return false;
2247 } else if (status != dumpstate_hal_hidl::DumpstateStatus::OK) {
2248 MYLOGE("dumpstateBoard failed with DumpstateStatus::%s\n",
2249 dumpstate_hal_hidl::toString(status).c_str());
2250 return false;
2251 }
2252 return true;
2253 });
2254 } else {
2255 MYLOGI("Using IDumpstateDevice v1.0 HIDL HAL");
2256
2257 descriptor_to_kill = dumpstate_hal_hidl_1_0::IDumpstateDevice::descriptor;
2258 dumpstate_board_task = DumpstateBoardTask([dumpstate_hal_1_0, &handle]() -> bool {
2259 ::android::hardware::Return<void> status =
2260 dumpstate_hal_1_0->dumpstateBoard(handle.get());
2261 if (!status.isOk()) {
2262 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2263 return false;
2264 }
2265 return true;
2266 });
2267 }
2268 auto result = dumpstate_board_task.get_future();
2269 std::thread(std::move(dumpstate_board_task)).detach();
2270
2271 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2272 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate HAL\n", timeout_sec);
2273 if (!android::base::SetProperty(
2274 "ctl.interface_restart",
2275 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
2276 MYLOGE("Couldn't restart dumpstate HAL\n");
2277 }
2278 }
2279 // Wait some time for init to kill dumpstate vendor HAL
2280 constexpr size_t killing_timeout_sec = 10;
2281 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2282 MYLOGE(
2283 "killing dumpstateBoard timed out after %zus, continue and "
2284 "there might be racing in content\n",
2285 killing_timeout_sec);
2286 }
2287}
2288
2289static void DoDumpstateBoardAidl(
2290 const std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> dumpstate_hal,
2291 const std::vector<::ndk::ScopedFileDescriptor>& dumpstate_fds,
2292 const Dumpstate::BugreportMode bugreport_mode, const size_t timeout_sec) {
2293 MYLOGI("Using IDumpstateDevice AIDL HAL");
2294
2295 const char* descriptor_to_kill;
2296 using DumpstateBoardTask = std::packaged_task<bool()>;
2297 DumpstateBoardTask dumpstate_board_task;
2298 dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode dumpstate_hal_mode =
2299 GetDumpstateHalModeAidl(bugreport_mode);
2300
2301 descriptor_to_kill = dumpstate_hal_aidl::IDumpstateDevice::descriptor;
2302 dumpstate_board_task = DumpstateBoardTask([dumpstate_hal, &dumpstate_fds, dumpstate_hal_mode,
2303 timeout_sec]() -> bool {
2304 auto status = dumpstate_hal->dumpstateBoard(dumpstate_fds, dumpstate_hal_mode, timeout_sec);
2305
2306 if (!status.isOk()) {
2307 MYLOGE("dumpstateBoard failed: %s\n", status.getDescription().c_str());
2308 return false;
2309 }
2310 return true;
2311 });
2312 auto result = dumpstate_board_task.get_future();
2313 std::thread(std::move(dumpstate_board_task)).detach();
2314
2315 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2316 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate HAL\n", timeout_sec);
2317 if (!android::base::SetProperty(
2318 "ctl.interface_restart",
2319 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
2320 MYLOGE("Couldn't restart dumpstate HAL\n");
2321 }
2322 }
2323 // Wait some time for init to kill dumpstate vendor HAL
2324 constexpr size_t killing_timeout_sec = 10;
2325 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2326 MYLOGE(
2327 "killing dumpstateBoard timed out after %zus, continue and "
2328 "there might be racing in content\n",
2329 killing_timeout_sec);
2330 }
2331}
2332
2333static std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> GetDumpstateBoardAidlService() {
2334 const std::string aidl_instance_name =
2335 std::string(dumpstate_hal_aidl::IDumpstateDevice::descriptor) + "/default";
2336
2337 if (!AServiceManager_isDeclared(aidl_instance_name.c_str())) {
2338 return nullptr;
2339 }
2340
2341 ndk::SpAIBinder dumpstateBinder(AServiceManager_waitForService(aidl_instance_name.c_str()));
2342
2343 return dumpstate_hal_aidl::IDumpstateDevice::fromBinder(dumpstateBinder);
2344}
2345
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002346void Dumpstate::DumpstateBoard(int out_fd) {
2347 dprintf(out_fd, "========================================================\n");
2348 dprintf(out_fd, "== Board\n");
2349 dprintf(out_fd, "========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08002350
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002351 /*
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002352 * mount debugfs for non-user builds with ro.product.debugfs_restrictions.enabled
Hridya Valsaraju51101602021-04-02 14:32:46 -07002353 * set to true and unmount it after invoking dumpstateBoard_* methods.
2354 * This is to enable debug builds to not have debugfs mounted during runtime.
2355 * It will also ensure that debugfs is only accessed by the dumpstate HAL.
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002356 */
Hridya Valsaraju51101602021-04-02 14:32:46 -07002357 auto mount_debugfs =
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002358 android::base::GetBoolProperty("ro.product.debugfs_restrictions.enabled", false);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002359 if (mount_debugfs) {
2360 RunCommand("mount debugfs", {"mount", "-t", "debugfs", "debugfs", "/sys/kernel/debug"},
2361 AS_ROOT_20);
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002362 RunCommand("chmod debugfs", {"chmod", "0755", "/sys/kernel/debug"}, AS_ROOT_20);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002363 }
2364
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002365 std::vector<std::string> paths;
2366 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07002367 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002368 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
2369 kDumpstateBoardFiles[i].c_str()));
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002370 remover.emplace_back(android::base::make_scope_guard(
2371 std::bind([](std::string path) { android::os::UnlinkAndLogOnError(path); }, paths[i])));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002372 }
Jie Song9fbfad02017-06-20 16:29:42 -07002373
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002374 // get dumpstate HAL AIDL implementation
2375 std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> dumpstate_hal_handle_aidl(
2376 GetDumpstateBoardAidlService());
2377 if (dumpstate_hal_handle_aidl == nullptr) {
2378 MYLOGI("No IDumpstateDevice AIDL implementation\n");
2379 }
2380
2381 // get dumpstate HAL HIDL implementation, only if AIDL HAL implementation not found
2382 sp<dumpstate_hal_hidl_1_0::IDumpstateDevice> dumpstate_hal_handle_hidl_1_0 = nullptr;
2383 if (dumpstate_hal_handle_aidl == nullptr) {
2384 dumpstate_hal_handle_hidl_1_0 = dumpstate_hal_hidl_1_0::IDumpstateDevice::getService();
2385 if (dumpstate_hal_handle_hidl_1_0 == nullptr) {
2386 MYLOGI("No IDumpstateDevice HIDL implementation\n");
2387 }
2388 }
2389
2390 // if neither HIDL nor AIDL implementation found, then return
2391 if (dumpstate_hal_handle_hidl_1_0 == nullptr && dumpstate_hal_handle_aidl == nullptr) {
2392 MYLOGE("Could not find IDumpstateDevice implementation\n");
Wei Wang587eac92018-04-05 12:17:20 -07002393 return;
2394 }
2395
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002396 // this is used to hold the file descriptors and when this variable goes out of scope
2397 // the file descriptors are closed
2398 std::vector<::ndk::ScopedFileDescriptor> dumpstate_fds;
Wei Wang587eac92018-04-05 12:17:20 -07002399
Nandana Dutt5c390032019-03-12 10:52:56 +00002400 // TODO(128270426): Check for consent in between?
Wei Wang587eac92018-04-05 12:17:20 -07002401 for (size_t i = 0; i < paths.size(); i++) {
2402 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
2403
2404 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
2405 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
2406 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
2407 if (fd < 0) {
2408 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
2409 return;
2410 }
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002411
2412 dumpstate_fds.emplace_back(fd.release());
2413 // we call fd.release() here to make sure "fd" does not get closed
2414 // after "fd" goes out of scope after this block.
2415 // "fd" will be closed when "dumpstate_fds" goes out of scope
2416 // i.e. when we exit this function
Wei Wang587eac92018-04-05 12:17:20 -07002417 }
2418
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002419 // Given that bugreport is required to diagnose failures, it's better to set an arbitrary amount
2420 // of timeout for IDumpstateDevice than to block the rest of bugreport. In the timeout case, we
2421 // will kill the HAL and grab whatever it dumped in time.
2422 constexpr size_t timeout_sec = 30;
Wei Wang587eac92018-04-05 12:17:20 -07002423
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002424 if (dumpstate_hal_handle_aidl != nullptr) {
2425 DoDumpstateBoardAidl(dumpstate_hal_handle_aidl, dumpstate_fds, options_->bugreport_mode,
2426 timeout_sec);
2427 } else if (dumpstate_hal_handle_hidl_1_0 != nullptr) {
2428 // run HIDL HAL only if AIDL HAL not found
2429 DoDumpstateBoardHidl(dumpstate_hal_handle_hidl_1_0, dumpstate_fds, options_->bugreport_mode,
2430 timeout_sec);
Wei Wang587eac92018-04-05 12:17:20 -07002431 }
2432
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002433 if (mount_debugfs) {
Hridya Valsaraju51101602021-04-02 14:32:46 -07002434 auto keep_debugfs_mounted =
2435 android::base::GetProperty("persist.dbg.keep_debugfs_mounted", "");
2436 if (keep_debugfs_mounted.empty())
2437 RunCommand("unmount debugfs", {"umount", "/sys/kernel/debug"}, AS_ROOT_20);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002438 }
2439
Wei Wang587eac92018-04-05 12:17:20 -07002440 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
2441 for (size_t i = 0; i < paths.size(); i++) {
2442 struct stat s;
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002443 if (fstat(dumpstate_fds[i].get(), &s) == -1) {
2444 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(), strerror(errno));
Wei Wang587eac92018-04-05 12:17:20 -07002445 file_sizes[i] = -1;
2446 continue;
2447 }
2448 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002449 }
2450
2451 for (size_t i = 0; i < paths.size(); i++) {
2452 if (file_sizes[i] == -1) {
2453 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002454 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002455 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07002456 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002457 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002458 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002459 remover[i].Disable();
2460 EnqueueAddZipEntryAndCleanupIfNeeded(kDumpstateBoardFiles[i], paths[i]);
2461 dprintf(out_fd, "*** See %s entry ***\n", kDumpstateBoardFiles[i].c_str());
Jie Song9fbfad02017-06-20 16:29:42 -07002462 }
Felipe Leme6f674ae2016-11-18 17:10:33 -08002463}
2464
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002465static void ShowUsage() {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002466 fprintf(stderr,
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002467 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-o directory] [-p] "
2468 "[-s] [-S] [-q] [-P] [-R] [-L] [-V version]\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002469 " -h: display this help message\n"
2470 " -b: play sound file instead of vibrate, at beginning of job\n"
2471 " -e: play sound file instead of vibrate, at end of job\n"
mhasank2d75c442020-06-11 15:05:25 -07002472 " -o: write to custom directory (only in limited mode)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01002473 " -p: capture screenshot to filename.png\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002474 " -s: write zipped file to control socket (for init)\n"
2475 " -S: write file location to control socket (for init)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002476 " -q: disable vibrate\n"
Abhijeet Kaure370d682019-10-01 16:49:30 +01002477 " -P: send broadcast when started and do progress updates\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002478 " -R: take bugreport in remote mode (shouldn't be used with -P)\n"
Nandana Dutt235864b2019-01-22 12:10:16 +00002479 " -w: start binder service and make it wait for a call to startBugreport\n"
mhasankd451a472020-05-26 18:02:39 -07002480 " -L: output limited information that is safe for submission in feedback reports\n"
Felipe Lemed071c682016-10-20 16:48:00 -07002481 " -v: prints the dumpstate header and exit\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002482}
2483
Wei Liuf87959e2016-08-26 14:51:42 -07002484static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07002485 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07002486}
2487
Felipe Leme1d486fe2016-10-14 18:06:47 -07002488bool Dumpstate::FinishZipFile() {
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002489 // Runs all enqueued adding zip entry and cleanup tasks before finishing the zip file.
2490 if (zip_entry_tasks_) {
2491 zip_entry_tasks_->run(/* do_cancel = */false);
2492 }
2493
Felipe Leme9a523ae2016-10-20 15:10:33 -07002494 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07002495 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07002496 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002497 // Final timestamp
2498 char date[80];
2499 time_t the_real_now_please_stand_up = time(nullptr);
2500 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002501 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07002502 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002503
Felipe Leme9a523ae2016-10-20 15:10:33 -07002504 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002505 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08002506 return false;
2507 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07002508 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002509 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08002510 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08002511 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08002512
Felipe Leme0f3fb202016-06-10 17:10:53 -07002513 // Add log file (which contains stderr output) to zip...
2514 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07002515 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07002516 MYLOGE("Failed to add dumpstate log to .zip file\n");
2517 return false;
2518 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002519 // TODO: Should truncate the existing file.
2520 // ... and re-open it for further logging.
Nandana Dutta344cb62019-02-22 15:12:35 +00002521 if (!redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()))) {
2522 return false;
2523 }
Felipe Leme0f3fb202016-06-10 17:10:53 -07002524 fprintf(stderr, "\n");
2525
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002526 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07002527 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002528 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002529 return false;
2530 }
2531
Felipe Leme1d486fe2016-10-14 18:06:47 -07002532 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
2533 ds.zip_file.reset(nullptr);
2534
Felipe Lemee9d2c542016-11-15 11:48:26 -08002535 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002536 android::os::UnlinkAndLogOnError(tmp_path_);
Felipe Lemec4eee562016-04-21 15:42:55 -07002537
Felipe Leme1e9edc62015-12-21 16:02:13 -08002538 return true;
2539}
Felipe Leme6e01fa62015-11-11 19:35:14 -08002540
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002541static void SendBroadcast(const std::string& action, const std::vector<std::string>& args) {
2542 // clang-format off
2543 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user", "0",
2544 "--receiver-foreground", "--receiver-include-background", "-a", action};
2545 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08002546
2547 am.insert(am.end(), args.begin(), args.end());
2548
Felipe Leme8d2410e2017-02-08 09:46:08 -08002549 RunCommand("", am,
2550 CommandOptions::WithTimeout(20)
2551 .Log("Sending broadcast: '%s'\n")
2552 .Always()
2553 .DropRoot()
2554 .RedirectStderr()
2555 .Build());
2556}
2557
Felipe Leme35b8cf12017-02-10 15:47:29 -08002558static void Vibrate(int duration_ms) {
2559 // clang-format off
Lais Andrade51156962021-02-22 19:21:35 +00002560 std::vector<std::string> args = {"cmd", "vibrator_manager", "synced", "-f", "-d", "dumpstate",
2561 "oneshot", std::to_string(duration_ms)};
2562 RunCommand("", args,
Felipe Leme35b8cf12017-02-10 15:47:29 -08002563 CommandOptions::WithTimeout(10)
2564 .Log("Vibrate: '%s'\n")
2565 .Always()
2566 .Build());
2567 // clang-format on
2568}
2569
Nandana Dutt979388e2018-11-30 16:48:55 +00002570static void MaybeResolveSymlink(std::string* path) {
2571 std::string resolved_path;
2572 if (android::base::Readlink(*path, &resolved_path)) {
2573 *path = resolved_path;
2574 }
2575}
2576
Nandana Dutt4be45d12018-09-26 15:04:23 +01002577/*
2578 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002579 * and adds the version file. Return false if zip_file could not be open to write.
Nandana Dutt4be45d12018-09-26 15:04:23 +01002580 */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002581static bool PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002582 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
2583
Nandana Dutt4be45d12018-09-26 15:04:23 +01002584 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
2585 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002586 ds.base_name_ = StringPrintf("bugreport-%s-%s", device_name.c_str(), build_id.c_str());
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002587 char date[80];
2588 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
2589 ds.name_ = date;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002590
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002591 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002592 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002593 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002594 ds.base_name_ += "-wifi";
2595 }
2596
Paul Chang0d2aad72020-02-13 20:04:03 +08002597 if (ds.options_->do_screenshot) {
Nandana Dutt9d17b942020-03-26 10:02:59 +00002598 ds.screenshot_path_ = ds.GetPath(ds.CalledByApi() ? "-png.tmp" : ".png");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002599 }
2600 ds.tmp_path_ = ds.GetPath(".tmp");
2601 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
2602
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002603 std::string destination = ds.CalledByApi()
Nandana Dutt54dbd672019-01-11 12:58:05 +00002604 ? StringPrintf("[fd:%d]", ds.options_->bugreport_fd.get())
Nandana Dutt9a76d202019-01-21 15:56:48 +00002605 : ds.bugreport_internal_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01002606 MYLOGD(
Nandana Dutt235c6672019-11-14 15:22:32 +00002607 "Bugreport dir: [%s] "
2608 "Base name: [%s] "
2609 "Suffix: [%s] "
2610 "Log path: [%s] "
2611 "Temporary path: [%s] "
2612 "Screenshot path: [%s]\n",
Nandana Dutt9a76d202019-01-21 15:56:48 +00002613 destination.c_str(), ds.base_name_.c_str(), ds.name_.c_str(), ds.log_path_.c_str(),
2614 ds.tmp_path_.c_str(), ds.screenshot_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002615
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002616 ds.path_ = ds.GetPath(ds.CalledByApi() ? "-zip.tmp" : ".zip");
2617 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
2618 create_parent_dirs(ds.path_.c_str());
2619 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
2620 if (ds.zip_file == nullptr) {
2621 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
2622 return false;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002623 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002624 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
2625 ds.AddTextZipEntry("version.txt", ds.version_);
2626 return true;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002627}
2628
2629/*
Abhijeet Kaure370d682019-10-01 16:49:30 +01002630 * Finalizes writing to the file by zipping the tmp file to the final location,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002631 * printing zipped file status, etc.
2632 */
2633static void FinalizeFile() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002634 bool do_text_file = !ds.FinishZipFile();
2635 if (do_text_file) {
2636 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002637 }
mhasank2d75c442020-06-11 15:05:25 -07002638
2639 std::string final_path = ds.path_;
2640 if (ds.options_->OutputToCustomFile()) {
mhasank3a4cfb42020-06-15 18:06:43 -07002641 final_path = ds.GetPath(ds.options_->out_dir, ".zip");
mhasank2d75c442020-06-11 15:05:25 -07002642 android::os::CopyFileToFile(ds.path_, final_path);
2643 }
2644
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002645 if (ds.options_->stream_to_socket) {
2646 android::os::CopyFileToFd(ds.path_, ds.control_socket_fd_);
2647 } else if (ds.options_->progress_updates_to_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002648 if (do_text_file) {
2649 dprintf(ds.control_socket_fd_,
2650 "FAIL:could not create zip file, check %s "
2651 "for more details\n",
2652 ds.log_path_.c_str());
2653 } else {
mhasank2d75c442020-06-11 15:05:25 -07002654 dprintf(ds.control_socket_fd_, "OK:%s\n", final_path.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002655 }
2656 }
2657}
2658
Nandana Dutt4be45d12018-09-26 15:04:23 +01002659
Nandana Dutt58d72e22018-11-16 10:30:48 +00002660static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2661 switch (mode) {
2662 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2663 return "BUGREPORT_FULL";
2664 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2665 return "BUGREPORT_INTERACTIVE";
2666 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2667 return "BUGREPORT_REMOTE";
2668 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2669 return "BUGREPORT_WEAR";
2670 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2671 return "BUGREPORT_TELEPHONY";
2672 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2673 return "BUGREPORT_WIFI";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002674 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2675 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002676 }
2677}
2678
Paul Changf59c2b72020-03-10 02:08:55 +08002679static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options,
2680 bool is_screenshot_requested) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002681 // Modify com.android.shell.BugreportProgressService#isDefaultScreenshotRequired as well for
2682 // default system screenshots.
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002683 options->bugreport_mode = mode;
2684 options->bugreport_mode_string = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002685 switch (mode) {
2686 case Dumpstate::BugreportMode::BUGREPORT_FULL:
Paul Changf59c2b72020-03-10 02:08:55 +08002687 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002688 break;
2689 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002690 // Currently, the dumpstate binder is only used by Shell to update progress.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002691 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002692 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002693 break;
2694 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002695 options->do_vibrate = false;
2696 options->is_remote_mode = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002697 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002698 break;
2699 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002700 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002701 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002702 break;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002703 // TODO(b/148168577) rename TELEPHONY everywhere to CONNECTIVITY.
Nandana Dutt58d72e22018-11-16 10:30:48 +00002704 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002705 options->telephony_only = true;
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002706 options->do_progress_updates = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002707 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002708 break;
2709 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002710 options->wifi_only = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002711 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002712 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002713 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2714 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002715 }
2716}
2717
Nandana Dutt58d72e22018-11-16 10:30:48 +00002718static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
Nandana Dutt235c6672019-11-14 15:22:32 +00002719 MYLOGI(
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002720 "do_vibrate: %d stream_to_socket: %d progress_updates_to_socket: %d do_screenshot: %d "
Rhed Jao25f50e02020-08-20 00:10:32 +08002721 "is_remote_mode: %d show_header_only: %d telephony_only: %d "
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002722 "wifi_only: %d do_progress_updates: %d fd: %d bugreport_mode: %s "
mhasankd451a472020-05-26 18:02:39 -07002723 "limited_only: %d args: %s\n",
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002724 options.do_vibrate, options.stream_to_socket, options.progress_updates_to_socket,
Paul Chang0d2aad72020-02-13 20:04:03 +08002725 options.do_screenshot, options.is_remote_mode, options.show_header_only,
Rhed Jao25f50e02020-08-20 00:10:32 +08002726 options.telephony_only, options.wifi_only,
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002727 options.do_progress_updates, options.bugreport_fd.get(),
2728 options.bugreport_mode_string.c_str(),
2729 options.limited_only, options.args.c_str());
Nandana Dutt58d72e22018-11-16 10:30:48 +00002730}
2731
Nandana Dutt54dbd672019-01-11 12:58:05 +00002732void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode,
2733 const android::base::unique_fd& bugreport_fd_in,
Paul Changf59c2b72020-03-10 02:08:55 +08002734 const android::base::unique_fd& screenshot_fd_in,
2735 bool is_screenshot_requested) {
Nandana Dutt54dbd672019-01-11 12:58:05 +00002736 // Duplicate the fds because the passed in fds don't outlive the binder transaction.
2737 bugreport_fd.reset(dup(bugreport_fd_in.get()));
2738 screenshot_fd.reset(dup(screenshot_fd_in.get()));
Nandana Dutt58d72e22018-11-16 10:30:48 +00002739
Paul Changf59c2b72020-03-10 02:08:55 +08002740 SetOptionsFromMode(bugreport_mode, this, is_screenshot_requested);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002741}
2742
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002743Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
2744 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002745 int c;
mhasankd451a472020-05-26 18:02:39 -07002746 while ((c = getopt(argc, argv, "dho:svqzpLPBRSV:w")) != -1) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002747 switch (c) {
2748 // clang-format off
mhasank3a4cfb42020-06-15 18:06:43 -07002749 case 'o': out_dir = optarg; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002750 case 's': stream_to_socket = true; break;
2751 case 'S': progress_updates_to_socket = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002752 case 'v': show_header_only = true; break;
2753 case 'q': do_vibrate = false; break;
Paul Chang0d2aad72020-02-13 20:04:03 +08002754 case 'p': do_screenshot = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002755 case 'P': do_progress_updates = true; break;
2756 case 'R': is_remote_mode = true; break;
mhasankd451a472020-05-26 18:02:39 -07002757 case 'L': limited_only = true; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002758 case 'V':
2759 case 'd':
2760 case 'z':
2761 // compatibility no-op
2762 break;
Nandana Dutt235864b2019-01-22 12:10:16 +00002763 case 'w':
2764 // This was already processed
2765 break;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002766 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002767 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002768 break;
2769 default:
2770 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002771 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002772 break;
2773 // clang-format on
2774 }
2775 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08002776
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002777 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002778 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002779 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002780 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002781 }
2782 }
2783
2784 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
2785 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002786
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002787 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002788}
2789
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002790bool Dumpstate::DumpOptions::ValidateOptions() const {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002791 if (bugreport_fd.get() != -1 && stream_to_socket) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002792 return false;
2793 }
2794
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002795 if ((progress_updates_to_socket || do_progress_updates) && stream_to_socket) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002796 return false;
2797 }
2798
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002799 if (is_remote_mode && (do_progress_updates || stream_to_socket)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002800 return false;
2801 }
2802 return true;
2803}
2804
Nandana Dutt197661d2018-11-16 16:40:21 +00002805void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
2806 options_ = std::move(options);
2807}
2808
Abhijeet Kaura407fb82020-03-27 12:51:12 +00002809void Dumpstate::Initialize() {
2810 /* gets the sequential id */
2811 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
2812 id_ = ++last_id;
2813 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
2814}
2815
Nandana Duttd2f5f082019-01-18 17:13:52 +00002816Dumpstate::RunStatus Dumpstate::Run(int32_t calling_uid, const std::string& calling_package) {
2817 Dumpstate::RunStatus status = RunInternal(calling_uid, calling_package);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002818 if (listener_ != nullptr) {
2819 switch (status) {
2820 case Dumpstate::RunStatus::OK:
Nandana Duttcc4ead82019-01-23 08:29:23 +00002821 listener_->onFinished();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002822 break;
2823 case Dumpstate::RunStatus::HELP:
2824 break;
2825 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002826 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_INVALID_INPUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002827 break;
2828 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002829 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_RUNTIME_ERROR);
2830 break;
2831 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2832 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_DENIED_CONSENT);
2833 break;
2834 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
2835 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_CONSENT_TIMED_OUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002836 break;
2837 }
2838 }
2839 return status;
2840}
2841
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002842void Dumpstate::Cancel() {
2843 CleanupTmpFiles();
2844 android::os::UnlinkAndLogOnError(log_path_);
2845 for (int i = 0; i < NUM_OF_DUMPS; i++) {
2846 android::os::UnlinkAndLogOnError(ds.bugreport_internal_dir_ + "/" +
2847 kDumpstateBoardFiles[i]);
2848 }
2849 tombstone_data_.clear();
2850 anr_data_.clear();
Rhed Jao0daac912020-08-21 14:48:20 +08002851
2852 // Instead of shutdown the pool, we delete temporary files directly since
2853 // shutdown blocking the call.
2854 if (dump_pool_) {
2855 dump_pool_->deleteTempFiles();
2856 }
2857 if (zip_entry_tasks_) {
2858 zip_entry_tasks_->run(/*do_cancel =*/ true);
2859 }
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002860}
2861
Nandana Dutt979388e2018-11-30 16:48:55 +00002862/*
2863 * Dumps relevant information to a bugreport based on the given options.
2864 *
2865 * The bugreport can be dumped to a file or streamed to a socket.
2866 *
2867 * How dumping to file works:
2868 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
2869 * stderr is redirected a log file.
2870 *
2871 * The temporary bugreport is then populated via printfs, dumping contents of files and
2872 * output of commands to stdout.
2873 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002874 * A bunch of other files and dumps are added to the zip archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00002875 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002876 * The temporary bugreport file and the log file also get added to the archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00002877 *
mhasank2d75c442020-06-11 15:05:25 -07002878 * Bugreports are first generated in a local directory and later copied to the caller's fd
2879 * or directory if supplied.
Nandana Dutt979388e2018-11-30 16:48:55 +00002880 */
Nandana Duttd2f5f082019-01-18 17:13:52 +00002881Dumpstate::RunStatus Dumpstate::RunInternal(int32_t calling_uid,
2882 const std::string& calling_package) {
Rhed Jao5377d792020-07-16 17:37:39 +08002883 DurationReporter duration_reporter("RUN INTERNAL", /* logcat_only = */true);
Nandana Dutt979388e2018-11-30 16:48:55 +00002884 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00002885 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002886 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002887 return RunStatus::INVALID_INPUT;
2888 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002889 /* set as high priority, and protect from OOM killer */
2890 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002891
Felipe Lemed071c682016-10-20 16:48:00 -07002892 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002893 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002894 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002895 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002896 } else {
2897 /* fallback to kernels <= 2.6.35 */
2898 oom_adj = fopen("/proc/self/oom_adj", "we");
2899 if (oom_adj) {
2900 fputs("-17", oom_adj);
2901 fclose(oom_adj);
2902 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002903 }
2904
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002905 if (version_ == VERSION_DEFAULT) {
2906 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00002907 }
2908
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002909 if (version_ != VERSION_CURRENT && version_ != VERSION_SPLIT_ANR) {
Vishnu Nair64afc022018-02-01 15:29:34 -08002910 MYLOGE("invalid version requested ('%s'); suppported values are: ('%s', '%s', '%s')\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002911 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str(),
Vishnu Nair64afc022018-02-01 15:29:34 -08002912 VERSION_SPLIT_ANR.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_) {
3238 dump_pool_->shutdown();
3239 dump_pool_ = nullptr;
3240 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003241 if (zip_entry_tasks_) {
3242 zip_entry_tasks_->run(/* do_cancel = */true);
3243 zip_entry_tasks_ = nullptr;
3244 }
3245}
3246
3247void Dumpstate::EnqueueAddZipEntryAndCleanupIfNeeded(const std::string& entry_name,
3248 const std::string& entry_path) {
3249 auto func_add_zip_entry_and_cleanup = [=](bool task_cancelled) {
3250 if (!task_cancelled) {
3251 AddZipEntry(entry_name, entry_path);
3252 }
3253 android::os::UnlinkAndLogOnError(entry_path);
3254 };
3255 if (zip_entry_tasks_) {
3256 // Enqueues AddZipEntryAndCleanup function if the parallel run is enabled.
3257 zip_entry_tasks_->add(func_add_zip_entry_and_cleanup, _1);
3258 } else {
3259 // Invokes AddZipEntryAndCleanup immediately
3260 std::invoke(func_add_zip_entry_and_cleanup, /* task_cancelled = */false);
3261 }
Rhed Jao5377d792020-07-16 17:37:39 +08003262}
3263
Nandana Duttd2f5f082019-01-18 17:13:52 +00003264Dumpstate::RunStatus Dumpstate::HandleUserConsentDenied() {
3265 MYLOGD("User denied consent; deleting files and returning\n");
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003266 CleanupTmpFiles();
Nandana Duttd2f5f082019-01-18 17:13:52 +00003267 return USER_CONSENT_DENIED;
3268}
3269
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003270Dumpstate::RunStatus Dumpstate::CopyBugreportIfUserConsented(int32_t calling_uid) {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003271 // If the caller has asked to copy the bugreport over to their directory, we need explicit
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003272 // user consent (unless the caller is Shell).
3273 UserConsentResult consent_result;
3274 if (calling_uid == AID_SHELL) {
3275 consent_result = UserConsentResult::APPROVED;
3276 } else {
3277 consent_result = consent_callback_->getResult();
3278 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003279 if (consent_result == UserConsentResult::UNAVAILABLE) {
3280 // User has not responded yet.
3281 uint64_t elapsed_ms = consent_callback_->getElapsedTimeMs();
Hunter Knepshield70610fa2020-01-03 15:27:33 -08003282 // Telephony is a fast report type, particularly on user builds where information may be
3283 // more aggressively limited. To give the user time to read the consent dialog, increase the
3284 // timeout.
3285 uint64_t timeout_ms = options_->telephony_only ? TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS
3286 : USER_CONSENT_TIMEOUT_MS;
3287 if (elapsed_ms < timeout_ms) {
3288 uint delay_seconds = (timeout_ms - elapsed_ms) / 1000;
Nandana Duttd2f5f082019-01-18 17:13:52 +00003289 MYLOGD("Did not receive user consent yet; going to wait for %d seconds", delay_seconds);
3290 sleep(delay_seconds);
3291 }
3292 consent_result = consent_callback_->getResult();
3293 }
3294 if (consent_result == UserConsentResult::DENIED) {
3295 // User has explicitly denied sharing with the app. To be safe delete the
3296 // internal bugreport & tmp files.
3297 return HandleUserConsentDenied();
3298 }
3299 if (consent_result == UserConsentResult::APPROVED) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00003300 bool copy_succeeded = android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
3301 if (copy_succeeded) {
3302 android::os::UnlinkAndLogOnError(path_);
Abhijeet Kaur9ce94672020-04-01 17:22:36 +01003303 if (options_->do_screenshot &&
3304 options_->screenshot_fd.get() != -1 &&
3305 !options_->is_screenshot_copied) {
3306 copy_succeeded = android::os::CopyFileToFd(screenshot_path_,
3307 options_->screenshot_fd.get());
3308 options_->is_screenshot_copied = copy_succeeded;
3309 if (copy_succeeded) {
3310 android::os::UnlinkAndLogOnError(screenshot_path_);
3311 }
3312 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003313 }
3314 return copy_succeeded ? Dumpstate::RunStatus::OK : Dumpstate::RunStatus::ERROR;
3315 } else if (consent_result == UserConsentResult::UNAVAILABLE) {
3316 // consent_result is still UNAVAILABLE. The user has likely not responded yet.
3317 // Since we do not have user consent to share the bugreport it does not get
3318 // copied over to the calling app but remains in the internal directory from
3319 // where the user can manually pull it.
Paul Changce644212021-05-11 16:06:45 +08003320 std::string final_path = GetPath(".zip");
3321 bool copy_succeeded = android::os::CopyFileToFile(path_, final_path);
3322 if (copy_succeeded) {
3323 android::os::UnlinkAndLogOnError(path_);
3324 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003325 return Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT;
3326 }
3327 // Unknown result; must be a programming error.
3328 MYLOGE("Unknown user consent result:%d\n", consent_result);
3329 return Dumpstate::RunStatus::ERROR;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003330}
3331
Nandana Duttf02564e2019-02-15 15:24:24 +00003332Dumpstate::RunStatus Dumpstate::ParseCommandlineAndRun(int argc, char* argv[]) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003333 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
3334 Dumpstate::RunStatus status = options->Initialize(argc, argv);
3335 if (status == Dumpstate::RunStatus::OK) {
Nandana Duttf02564e2019-02-15 15:24:24 +00003336 SetOptions(std::move(options));
Nandana Duttd2f5f082019-01-18 17:13:52 +00003337 // When directly running dumpstate binary, the output is not expected to be written
3338 // to any external file descriptor.
Nandana Duttf02564e2019-02-15 15:24:24 +00003339 assert(options_->bugreport_fd.get() == -1);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003340
3341 // calling_uid and calling_package are for user consent to share the bugreport with
Abhijeet Kaura407fb82020-03-27 12:51:12 +00003342 // an app; they are irrelevant here because bugreport is triggered via command line.
3343 // Update Last ID before calling Run().
3344 Initialize();
Nandana Duttf02564e2019-02-15 15:24:24 +00003345 status = Run(-1 /* calling_uid */, "" /* calling_package */);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003346 }
Nandana Duttf02564e2019-02-15 15:24:24 +00003347 return status;
3348}
3349
3350/* Main entry point for dumpstate binary. */
3351int run_main(int argc, char* argv[]) {
3352 Dumpstate::RunStatus status = ds.ParseCommandlineAndRun(argc, argv);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003353
3354 switch (status) {
3355 case Dumpstate::RunStatus::OK:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003356 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003357 case Dumpstate::RunStatus::HELP:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003358 ShowUsage();
3359 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003360 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003361 fprintf(stderr, "Invalid combination of args\n");
3362 ShowUsage();
3363 exit(1);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003364 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00003365 FALLTHROUGH_INTENDED;
3366 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
3367 FALLTHROUGH_INTENDED;
3368 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003369 exit(2);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003370 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003371}
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003372
3373// TODO(111441001): Default DumpOptions to sensible values.
3374Dumpstate::Dumpstate(const std::string& version)
3375 : pid_(getpid()),
3376 options_(new Dumpstate::DumpOptions()),
Nandana Dutt402a8392019-06-14 14:25:13 +01003377 last_reported_percent_progress_(0),
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003378 version_(version),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003379 now_(time(nullptr)),
3380 open_socket_fn_(open_socket) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003381}
3382
3383Dumpstate& Dumpstate::GetInstance() {
3384 static Dumpstate singleton_(android::base::GetProperty("dumpstate.version", VERSION_CURRENT));
3385 return singleton_;
3386}
3387
Rhed Jao5377d792020-07-16 17:37:39 +08003388DurationReporter::DurationReporter(const std::string& title, bool logcat_only, bool verbose,
3389 int duration_fd) : title_(title), logcat_only_(logcat_only), verbose_(verbose),
3390 duration_fd_(duration_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003391 if (!title_.empty()) {
3392 started_ = Nanotime();
3393 }
3394}
3395
3396DurationReporter::~DurationReporter() {
3397 if (!title_.empty()) {
3398 float elapsed = (float)(Nanotime() - started_) / NANOS_PER_SEC;
chenqiwuaf8b2d92019-12-12 18:53:51 +08003399 if (elapsed >= .5f || verbose_) {
3400 MYLOGD("Duration of '%s': %.2fs\n", title_.c_str(), elapsed);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003401 }
chenqiwuaf8b2d92019-12-12 18:53:51 +08003402 if (!logcat_only_) {
3403 // Use "Yoda grammar" to make it easier to grep|sort sections.
Rhed Jao5377d792020-07-16 17:37:39 +08003404 dprintf(duration_fd_, "------ %.3fs was the duration of '%s' ------\n",
3405 elapsed, title_.c_str());
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003406 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003407 }
3408}
3409
3410const int32_t Progress::kDefaultMax = 5000;
3411
3412Progress::Progress(const std::string& path) : Progress(Progress::kDefaultMax, 1.1, path) {
3413}
3414
3415Progress::Progress(int32_t initial_max, int32_t progress, float growth_factor)
3416 : Progress(initial_max, growth_factor, "") {
3417 progress_ = progress;
3418}
3419
3420Progress::Progress(int32_t initial_max, float growth_factor, const std::string& path)
3421 : initial_max_(initial_max),
3422 progress_(0),
3423 max_(initial_max),
3424 growth_factor_(growth_factor),
3425 n_runs_(0),
3426 average_max_(0),
3427 path_(path) {
3428 if (!path_.empty()) {
3429 Load();
3430 }
3431}
3432
3433void Progress::Load() {
3434 MYLOGD("Loading stats from %s\n", path_.c_str());
3435 std::string content;
3436 if (!android::base::ReadFileToString(path_, &content)) {
3437 MYLOGI("Could not read stats from %s; using max of %d\n", path_.c_str(), max_);
3438 return;
3439 }
3440 if (content.empty()) {
3441 MYLOGE("No stats (empty file) on %s; using max of %d\n", path_.c_str(), max_);
3442 return;
3443 }
3444 std::vector<std::string> lines = android::base::Split(content, "\n");
3445
3446 if (lines.size() < 1) {
3447 MYLOGE("Invalid stats on file %s: not enough lines (%d). Using max of %d\n", path_.c_str(),
3448 (int)lines.size(), max_);
3449 return;
3450 }
3451 char* ptr;
3452 n_runs_ = strtol(lines[0].c_str(), &ptr, 10);
3453 average_max_ = strtol(ptr, nullptr, 10);
3454 if (n_runs_ <= 0 || average_max_ <= 0 || n_runs_ > STATS_MAX_N_RUNS ||
3455 average_max_ > STATS_MAX_AVERAGE) {
3456 MYLOGE("Invalid stats line on file %s: %s\n", path_.c_str(), lines[0].c_str());
3457 initial_max_ = Progress::kDefaultMax;
3458 } else {
3459 initial_max_ = average_max_;
3460 }
3461 max_ = initial_max_;
3462
3463 MYLOGI("Average max progress: %d in %d runs; estimated max: %d\n", average_max_, n_runs_, max_);
3464}
3465
3466void Progress::Save() {
3467 int32_t total = n_runs_ * average_max_ + progress_;
3468 int32_t runs = n_runs_ + 1;
3469 int32_t average = floor(((float)total) / runs);
3470 MYLOGI("Saving stats (total=%d, runs=%d, average=%d) on %s\n", total, runs, average,
3471 path_.c_str());
3472 if (path_.empty()) {
3473 return;
3474 }
3475
3476 std::string content = android::base::StringPrintf("%d %d\n", runs, average);
3477 if (!android::base::WriteStringToFile(content, path_)) {
3478 MYLOGE("Could not save stats on %s\n", path_.c_str());
3479 }
3480}
3481
3482int32_t Progress::Get() const {
3483 return progress_;
3484}
3485
3486bool Progress::Inc(int32_t delta_sec) {
3487 bool changed = false;
3488 if (delta_sec >= 0) {
3489 progress_ += delta_sec;
3490 if (progress_ > max_) {
3491 int32_t old_max = max_;
3492 max_ = floor((float)progress_ * growth_factor_);
3493 MYLOGD("Adjusting max progress from %d to %d\n", old_max, max_);
3494 changed = true;
3495 }
3496 }
3497 return changed;
3498}
3499
3500int32_t Progress::GetMax() const {
3501 return max_;
3502}
3503
3504int32_t Progress::GetInitialMax() const {
3505 return initial_max_;
3506}
3507
3508void Progress::Dump(int fd, const std::string& prefix) const {
3509 const char* pr = prefix.c_str();
3510 dprintf(fd, "%sprogress: %d\n", pr, progress_);
3511 dprintf(fd, "%smax: %d\n", pr, max_);
3512 dprintf(fd, "%sinitial_max: %d\n", pr, initial_max_);
3513 dprintf(fd, "%sgrowth_factor: %0.2f\n", pr, growth_factor_);
3514 dprintf(fd, "%spath: %s\n", pr, path_.c_str());
3515 dprintf(fd, "%sn_runs: %d\n", pr, n_runs_);
3516 dprintf(fd, "%saverage_max: %d\n", pr, average_max_);
3517}
3518
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003519std::string Dumpstate::GetPath(const std::string& suffix) const {
3520 return GetPath(bugreport_internal_dir_, suffix);
3521}
3522
3523std::string Dumpstate::GetPath(const std::string& directory, const std::string& suffix) const {
3524 return android::base::StringPrintf("%s/%s-%s%s", directory.c_str(), base_name_.c_str(),
3525 name_.c_str(), suffix.c_str());
3526}
3527
3528void Dumpstate::SetProgress(std::unique_ptr<Progress> progress) {
3529 progress_ = std::move(progress);
3530}
3531
3532void for_each_userid(void (*func)(int), const char *header) {
3533 std::string title = header == nullptr ? "for_each_userid" : android::base::StringPrintf(
3534 "for_each_userid(%s)", header);
3535 DurationReporter duration_reporter(title);
3536 if (PropertiesHelper::IsDryRun()) return;
3537
3538 DIR *d;
3539 struct dirent *de;
3540
3541 if (header) printf("\n------ %s ------\n", header);
3542 func(0);
3543
3544 if (!(d = opendir("/data/system/users"))) {
3545 printf("Failed to open /data/system/users (%s)\n", strerror(errno));
3546 return;
3547 }
3548
3549 while ((de = readdir(d))) {
3550 int userid;
3551 if (de->d_type != DT_DIR || !(userid = atoi(de->d_name))) {
3552 continue;
3553 }
3554 func(userid);
3555 }
3556
3557 closedir(d);
3558}
3559
3560static void __for_each_pid(void (*helper)(int, const char *, void *), const char *header, void *arg) {
3561 DIR *d;
3562 struct dirent *de;
3563
3564 if (!(d = opendir("/proc"))) {
3565 printf("Failed to open /proc (%s)\n", strerror(errno));
3566 return;
3567 }
3568
3569 if (header) printf("\n------ %s ------\n", header);
3570 while ((de = readdir(d))) {
3571 if (ds.IsUserConsentDenied()) {
3572 MYLOGE(
3573 "Returning early because user denied consent to share bugreport with calling app.");
3574 closedir(d);
3575 return;
3576 }
3577 int pid;
3578 int fd;
3579 char cmdpath[255];
3580 char cmdline[255];
3581
3582 if (!(pid = atoi(de->d_name))) {
3583 continue;
3584 }
3585
3586 memset(cmdline, 0, sizeof(cmdline));
3587
3588 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/cmdline", pid);
3589 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3590 TEMP_FAILURE_RETRY(read(fd, cmdline, sizeof(cmdline) - 2));
3591 close(fd);
3592 if (cmdline[0]) {
3593 helper(pid, cmdline, arg);
3594 continue;
3595 }
3596 }
3597
3598 // if no cmdline, a kernel thread has comm
3599 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/comm", pid);
3600 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3601 TEMP_FAILURE_RETRY(read(fd, cmdline + 1, sizeof(cmdline) - 4));
3602 close(fd);
3603 if (cmdline[1]) {
3604 cmdline[0] = '[';
3605 size_t len = strcspn(cmdline, "\f\b\r\n");
3606 cmdline[len] = ']';
3607 cmdline[len+1] = '\0';
3608 }
3609 }
3610 if (!cmdline[0]) {
3611 strcpy(cmdline, "N/A");
3612 }
3613 helper(pid, cmdline, arg);
3614 }
3615
3616 closedir(d);
3617}
3618
3619static void for_each_pid_helper(int pid, const char *cmdline, void *arg) {
3620 for_each_pid_func *func = (for_each_pid_func*) arg;
3621 func(pid, cmdline);
3622}
3623
3624void for_each_pid(for_each_pid_func func, const char *header) {
3625 std::string title = header == nullptr ? "for_each_pid"
3626 : android::base::StringPrintf("for_each_pid(%s)", header);
3627 DurationReporter duration_reporter(title);
3628 if (PropertiesHelper::IsDryRun()) return;
3629
3630 __for_each_pid(for_each_pid_helper, header, (void *) func);
3631}
3632
3633static void for_each_tid_helper(int pid, const char *cmdline, void *arg) {
3634 DIR *d;
3635 struct dirent *de;
3636 char taskpath[255];
3637 for_each_tid_func *func = (for_each_tid_func *) arg;
3638
3639 snprintf(taskpath, sizeof(taskpath), "/proc/%d/task", pid);
3640
3641 if (!(d = opendir(taskpath))) {
3642 printf("Failed to open %s (%s)\n", taskpath, strerror(errno));
3643 return;
3644 }
3645
3646 func(pid, pid, cmdline);
3647
3648 while ((de = readdir(d))) {
3649 if (ds.IsUserConsentDenied()) {
3650 MYLOGE(
3651 "Returning early because user denied consent to share bugreport with calling app.");
3652 closedir(d);
3653 return;
3654 }
3655 int tid;
3656 int fd;
3657 char commpath[255];
3658 char comm[255];
3659
3660 if (!(tid = atoi(de->d_name))) {
3661 continue;
3662 }
3663
3664 if (tid == pid)
3665 continue;
3666
3667 snprintf(commpath, sizeof(commpath), "/proc/%d/comm", tid);
3668 memset(comm, 0, sizeof(comm));
3669 if ((fd = TEMP_FAILURE_RETRY(open(commpath, O_RDONLY | O_CLOEXEC))) < 0) {
3670 strcpy(comm, "N/A");
3671 } else {
3672 char *c;
3673 TEMP_FAILURE_RETRY(read(fd, comm, sizeof(comm) - 2));
3674 close(fd);
3675
3676 c = strrchr(comm, '\n');
3677 if (c) {
3678 *c = '\0';
3679 }
3680 }
3681 func(pid, tid, comm);
3682 }
3683
3684 closedir(d);
3685}
3686
3687void for_each_tid(for_each_tid_func func, const char *header) {
3688 std::string title = header == nullptr ? "for_each_tid"
3689 : android::base::StringPrintf("for_each_tid(%s)", header);
3690 DurationReporter duration_reporter(title);
3691
3692 if (PropertiesHelper::IsDryRun()) return;
3693
3694 __for_each_pid(for_each_tid_helper, header, (void *) func);
3695}
3696
3697void show_wchan(int pid, int tid, const char *name) {
3698 if (PropertiesHelper::IsDryRun()) return;
3699
3700 char path[255];
3701 char buffer[255];
3702 int fd, ret, save_errno;
3703 char name_buffer[255];
3704
3705 memset(buffer, 0, sizeof(buffer));
3706
3707 snprintf(path, sizeof(path), "/proc/%d/wchan", tid);
3708 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3709 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3710 return;
3711 }
3712
3713 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3714 save_errno = errno;
3715 close(fd);
3716
3717 if (ret < 0) {
3718 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3719 return;
3720 }
3721
3722 snprintf(name_buffer, sizeof(name_buffer), "%*s%s",
3723 pid == tid ? 0 : 3, "", name);
3724
3725 printf("%-7d %-32s %s\n", tid, name_buffer, buffer);
3726
3727 return;
3728}
3729
3730// print time in centiseconds
3731static void snprcent(char *buffer, size_t len, size_t spc,
3732 unsigned long long time) {
3733 static long hz; // cache discovered hz
3734
3735 if (hz <= 0) {
3736 hz = sysconf(_SC_CLK_TCK);
3737 if (hz <= 0) {
3738 hz = 1000;
3739 }
3740 }
3741
3742 // convert to centiseconds
3743 time = (time * 100 + (hz / 2)) / hz;
3744
3745 char str[16];
3746
3747 snprintf(str, sizeof(str), " %llu.%02u",
3748 time / 100, (unsigned)(time % 100));
3749 size_t offset = strlen(buffer);
3750 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3751 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3752}
3753
3754// print permille as a percent
3755static void snprdec(char *buffer, size_t len, size_t spc, unsigned permille) {
3756 char str[16];
3757
3758 snprintf(str, sizeof(str), " %u.%u%%", permille / 10, permille % 10);
3759 size_t offset = strlen(buffer);
3760 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3761 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3762}
3763
3764void show_showtime(int pid, const char *name) {
3765 if (PropertiesHelper::IsDryRun()) return;
3766
3767 char path[255];
3768 char buffer[1023];
3769 int fd, ret, save_errno;
3770
3771 memset(buffer, 0, sizeof(buffer));
3772
3773 snprintf(path, sizeof(path), "/proc/%d/stat", pid);
3774 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3775 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3776 return;
3777 }
3778
3779 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3780 save_errno = errno;
3781 close(fd);
3782
3783 if (ret < 0) {
3784 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3785 return;
3786 }
3787
3788 // field 14 is utime
3789 // field 15 is stime
3790 // field 42 is iotime
3791 unsigned long long utime = 0, stime = 0, iotime = 0;
3792 if (sscanf(buffer,
3793 "%*u %*s %*s %*d %*d %*d %*d %*d %*d %*d %*d "
3794 "%*d %*d %llu %llu %*d %*d %*d %*d %*d %*d "
3795 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %*d "
3796 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %llu ",
3797 &utime, &stime, &iotime) != 3) {
3798 return;
3799 }
3800
3801 unsigned long long total = utime + stime;
3802 if (!total) {
3803 return;
3804 }
3805
3806 unsigned permille = (iotime * 1000 + (total / 2)) / total;
3807 if (permille > 1000) {
3808 permille = 1000;
3809 }
3810
3811 // try to beautify and stabilize columns at <80 characters
3812 snprintf(buffer, sizeof(buffer), "%-6d%s", pid, name);
3813 if ((name[0] != '[') || utime) {
3814 snprcent(buffer, sizeof(buffer), 57, utime);
3815 }
3816 snprcent(buffer, sizeof(buffer), 65, stime);
3817 if ((name[0] != '[') || iotime) {
3818 snprcent(buffer, sizeof(buffer), 73, iotime);
3819 }
3820 if (iotime) {
3821 snprdec(buffer, sizeof(buffer), 79, permille);
3822 }
3823 puts(buffer); // adds a trailing newline
3824
3825 return;
3826}
3827
3828void do_dmesg() {
3829 const char *title = "KERNEL LOG (dmesg)";
3830 DurationReporter duration_reporter(title);
3831 printf("------ %s ------\n", title);
3832
3833 if (PropertiesHelper::IsDryRun()) return;
3834
3835 /* Get size of kernel buffer */
3836 int size = klogctl(KLOG_SIZE_BUFFER, nullptr, 0);
3837 if (size <= 0) {
3838 printf("Unexpected klogctl return value: %d\n\n", size);
3839 return;
3840 }
3841 char *buf = (char *) malloc(size + 1);
3842 if (buf == nullptr) {
3843 printf("memory allocation failed\n\n");
3844 return;
3845 }
3846 int retval = klogctl(KLOG_READ_ALL, buf, size);
3847 if (retval < 0) {
3848 printf("klogctl failure\n\n");
3849 free(buf);
3850 return;
3851 }
3852 buf[retval] = '\0';
3853 printf("%s\n\n", buf);
3854 free(buf);
3855 return;
3856}
3857
3858void do_showmap(int pid, const char *name) {
3859 char title[255];
3860 char arg[255];
3861
3862 snprintf(title, sizeof(title), "SHOW MAP %d (%s)", pid, name);
3863 snprintf(arg, sizeof(arg), "%d", pid);
3864 RunCommand(title, {"showmap", "-q", arg}, CommandOptions::AS_ROOT);
3865}
3866
3867int Dumpstate::DumpFile(const std::string& title, const std::string& path) {
3868 DurationReporter duration_reporter(title);
3869
3870 int status = DumpFileToFd(STDOUT_FILENO, title, path);
3871
3872 UpdateProgress(WEIGHT_FILE);
3873
3874 return status;
3875}
3876
3877int read_file_as_long(const char *path, long int *output) {
3878 int fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC));
3879 if (fd < 0) {
3880 int err = errno;
3881 MYLOGE("Error opening file descriptor for %s: %s\n", path, strerror(err));
3882 return -1;
3883 }
3884 char buffer[50];
3885 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3886 if (bytes_read == -1) {
3887 MYLOGE("Error reading file %s: %s\n", path, strerror(errno));
3888 return -2;
3889 }
3890 if (bytes_read == 0) {
3891 MYLOGE("File %s is empty\n", path);
3892 return -3;
3893 }
3894 *output = atoi(buffer);
3895 return 0;
3896}
3897
3898/* calls skip to gate calling dump_from_fd recursively
3899 * in the specified directory. dump_from_fd defaults to
3900 * dump_file_from_fd above when set to NULL. skip defaults
3901 * to false when set to NULL. dump_from_fd will always be
3902 * called with title NULL.
3903 */
3904int dump_files(const std::string& title, const char* dir, bool (*skip)(const char* path),
3905 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
3906 DurationReporter duration_reporter(title);
3907 DIR *dirp;
3908 struct dirent *d;
3909 char *newpath = nullptr;
3910 const char *slash = "/";
3911 int retval = 0;
3912
3913 if (!title.empty()) {
3914 printf("------ %s (%s) ------\n", title.c_str(), dir);
3915 }
3916 if (PropertiesHelper::IsDryRun()) return 0;
3917
3918 if (dir[strlen(dir) - 1] == '/') {
3919 ++slash;
3920 }
3921 dirp = opendir(dir);
3922 if (dirp == nullptr) {
3923 retval = -errno;
3924 MYLOGE("%s: %s\n", dir, strerror(errno));
3925 return retval;
3926 }
3927
3928 if (!dump_from_fd) {
3929 dump_from_fd = dump_file_from_fd;
3930 }
3931 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
3932 if ((d->d_name[0] == '.')
3933 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
3934 || (d->d_name[1] == '\0'))) {
3935 continue;
3936 }
3937 asprintf(&newpath, "%s%s%s%s", dir, slash, d->d_name,
3938 (d->d_type == DT_DIR) ? "/" : "");
3939 if (!newpath) {
3940 retval = -errno;
3941 continue;
3942 }
3943 if (skip && (*skip)(newpath)) {
3944 continue;
3945 }
3946 if (d->d_type == DT_DIR) {
3947 int ret = dump_files("", newpath, skip, dump_from_fd);
3948 if (ret < 0) {
3949 retval = ret;
3950 }
3951 continue;
3952 }
3953 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(newpath, O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
3954 if (fd.get() < 0) {
3955 retval = -1;
3956 printf("*** %s: %s\n", newpath, strerror(errno));
3957 continue;
3958 }
3959 (*dump_from_fd)(nullptr, newpath, fd.get());
3960 }
3961 closedir(dirp);
3962 if (!title.empty()) {
3963 printf("\n");
3964 }
3965 return retval;
3966}
3967
3968/* fd must have been opened with the flag O_NONBLOCK. With this flag set,
3969 * it's possible to avoid issues where opening the file itself can get
3970 * stuck.
3971 */
3972int dump_file_from_fd(const char *title, const char *path, int fd) {
3973 if (PropertiesHelper::IsDryRun()) return 0;
3974
3975 int flags = fcntl(fd, F_GETFL);
3976 if (flags == -1) {
3977 printf("*** %s: failed to get flags on fd %d: %s\n", path, fd, strerror(errno));
3978 return -1;
3979 } else if (!(flags & O_NONBLOCK)) {
3980 printf("*** %s: fd must have O_NONBLOCK set.\n", path);
3981 return -1;
3982 }
3983 return DumpFileFromFdToFd(title, path, fd, STDOUT_FILENO, PropertiesHelper::IsDryRun());
3984}
3985
3986int Dumpstate::RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003987 const CommandOptions& options, bool verbose_duration, int out_fd) {
3988 DurationReporter duration_reporter(title, false /* logcat_only */,
3989 verbose_duration, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003990
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003991 int status = RunCommandToFd(out_fd, title, full_command, options);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003992
3993 /* TODO: for now we're simplifying the progress calculation by using the
3994 * timeout as the weight. It's a good approximation for most cases, except when calling dumpsys,
3995 * where its weight should be much higher proportionally to its timeout.
3996 * Ideally, it should use a options.EstimatedDuration() instead...*/
3997 UpdateProgress(options.Timeout());
3998
3999 return status;
4000}
4001
4002void Dumpstate::RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsys_args,
Rhed Jaoe017f982020-07-21 17:58:41 +08004003 const CommandOptions& options, long dumpsysTimeoutMs, int out_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004004 long timeout_ms = dumpsysTimeoutMs > 0 ? dumpsysTimeoutMs : options.TimeoutInMs();
4005 std::vector<std::string> dumpsys = {"/system/bin/dumpsys", "-T", std::to_string(timeout_ms)};
4006 dumpsys.insert(dumpsys.end(), dumpsys_args.begin(), dumpsys_args.end());
Rhed Jaoe017f982020-07-21 17:58:41 +08004007 RunCommand(title, dumpsys, options, false, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004008}
4009
Dieter Hsu105ad0c2020-09-29 15:23:33 +08004010static int open_socket(const char* service) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004011 int s = android_get_control_socket(service);
4012 if (s < 0) {
4013 MYLOGE("android_get_control_socket(%s): %s\n", service, strerror(errno));
4014 return -1;
4015 }
4016 fcntl(s, F_SETFD, FD_CLOEXEC);
4017
4018 // Set backlog to 0 to make sure that queue size will be minimum.
4019 // In Linux, because the minimum queue will be 1, connect() will be blocked
4020 // if the other clients already called connect() and the connection request was not accepted.
4021 if (listen(s, 0) < 0) {
4022 MYLOGE("listen(control socket): %s\n", strerror(errno));
4023 return -1;
4024 }
4025
4026 struct sockaddr addr;
4027 socklen_t alen = sizeof(addr);
Abhijeet Kaur2113cae2019-09-13 09:24:15 +01004028 int fd = accept4(s, &addr, &alen, SOCK_CLOEXEC);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004029
4030 // Close socket just after accept(), to make sure that connect() by client will get error
4031 // when the socket is used by the other services.
4032 // There is still a race condition possibility between accept and close, but there is no way
4033 // to close-on-accept atomically.
4034 // See detail; b/123306389#comment25
4035 close(s);
4036
4037 if (fd < 0) {
4038 MYLOGE("accept(control socket): %s\n", strerror(errno));
4039 return -1;
4040 }
4041
4042 return fd;
4043}
4044
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004045// TODO: should call is_valid_output_file and/or be merged into it.
4046void create_parent_dirs(const char *path) {
4047 char *chp = const_cast<char *> (path);
4048
4049 /* skip initial slash */
4050 if (chp[0] == '/')
4051 chp++;
4052
4053 /* create leading directories, if necessary */
4054 struct stat dir_stat;
4055 while (chp && chp[0]) {
4056 chp = strchr(chp, '/');
4057 if (chp) {
4058 *chp = 0;
4059 if (stat(path, &dir_stat) == -1 || !S_ISDIR(dir_stat.st_mode)) {
4060 MYLOGI("Creating directory %s\n", path);
4061 if (mkdir(path, 0770)) { /* drwxrwx--- */
4062 MYLOGE("Unable to create directory %s: %s\n", path, strerror(errno));
4063 } else if (chown(path, AID_SHELL, AID_SHELL)) {
4064 MYLOGE("Unable to change ownership of dir %s: %s\n", path, strerror(errno));
4065 }
4066 }
4067 *chp++ = '/';
4068 }
4069 }
4070}
4071
4072bool _redirect_to_file(FILE* redirect, char* path, int truncate_flag) {
4073 create_parent_dirs(path);
4074
4075 int fd = TEMP_FAILURE_RETRY(open(path,
4076 O_WRONLY | O_CREAT | truncate_flag | O_CLOEXEC | O_NOFOLLOW,
4077 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH));
4078 if (fd < 0) {
4079 MYLOGE("%s: %s\n", path, strerror(errno));
4080 return false;
4081 }
4082
4083 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
4084 close(fd);
4085 return true;
4086}
4087
4088bool redirect_to_file(FILE* redirect, char* path) {
4089 return _redirect_to_file(redirect, path, O_TRUNC);
4090}
4091
4092bool redirect_to_existing_file(FILE* redirect, char* path) {
4093 return _redirect_to_file(redirect, path, O_APPEND);
4094}
4095
4096void dump_route_tables() {
4097 DurationReporter duration_reporter("DUMP ROUTE TABLES");
4098 if (PropertiesHelper::IsDryRun()) return;
4099 const char* const RT_TABLES_PATH = "/data/misc/net/rt_tables";
4100 ds.DumpFile("RT_TABLES", RT_TABLES_PATH);
4101 FILE* fp = fopen(RT_TABLES_PATH, "re");
4102 if (!fp) {
4103 printf("*** %s: %s\n", RT_TABLES_PATH, strerror(errno));
4104 return;
4105 }
4106 char table[16];
4107 // Each line has an integer (the table number), a space, and a string (the table name). We only
4108 // need the table number. It's a 32-bit unsigned number, so max 10 chars. Skip the table name.
4109 // Add a fixed max limit so this doesn't go awry.
4110 for (int i = 0; i < 64 && fscanf(fp, " %10s %*s", table) == 1; ++i) {
4111 RunCommand("ROUTE TABLE IPv4", {"ip", "-4", "route", "show", "table", table});
4112 RunCommand("ROUTE TABLE IPv6", {"ip", "-6", "route", "show", "table", table});
4113 }
4114 fclose(fp);
4115}
4116
Li Li830179f2022-01-04 12:53:29 -08004117void dump_frozen_cgroupfs(const char *dir, int level,
4118 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
4119 DIR *dirp;
4120 struct dirent *d;
4121 char *newpath = nullptr;
4122
4123 dirp = opendir(dir);
4124 if (dirp == nullptr) {
4125 MYLOGE("%s: %s\n", dir, strerror(errno));
4126 return;
4127 }
4128
4129 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
4130 if ((d->d_name[0] == '.')
4131 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
4132 || (d->d_name[1] == '\0'))) {
4133 continue;
4134 }
4135 if (d->d_type == DT_DIR) {
4136 asprintf(&newpath, "%s/%s/", dir, d->d_name);
4137 if (!newpath) {
4138 continue;
4139 }
4140 if (level == 0 && !strncmp(d->d_name, "uid_", 4)) {
4141 dump_frozen_cgroupfs(newpath, 1, dump_from_fd);
4142 } else if (level == 1 && !strncmp(d->d_name, "pid_", 4)) {
4143 char *freezer = nullptr;
4144 asprintf(&freezer, "%s/%s", newpath, "cgroup.freeze");
4145 if (freezer) {
4146 FILE* fp = fopen(freezer, "r");
4147 if (fp != NULL) {
4148 int frozen;
4149 fscanf(fp, "%d", &frozen);
4150 if (frozen > 0) {
4151 dump_files("", newpath, skip_none, dump_from_fd);
4152 }
4153 fclose(fp);
4154 }
4155 free(freezer);
4156 }
4157 }
4158 }
4159 }
4160 closedir(dirp);
4161}
4162
4163void dump_frozen_cgroupfs() {
Li Li830179f2022-01-04 12:53:29 -08004164 MYLOGD("Adding frozen processes from %s\n", CGROUPFS_DIR);
4165 DurationReporter duration_reporter("FROZEN CGROUPFS");
4166 if (PropertiesHelper::IsDryRun()) return;
4167 dump_frozen_cgroupfs(CGROUPFS_DIR, 0, _add_file_from_fd);
4168}
4169
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004170void Dumpstate::UpdateProgress(int32_t delta_sec) {
4171 if (progress_ == nullptr) {
4172 MYLOGE("UpdateProgress: progress_ not set\n");
4173 return;
4174 }
Rhed Jaobf63d8a2020-07-21 15:42:55 +08004175 // This function updates progress related members of the dumpstate and reports
4176 // progress percentage to the bugreport client. Since it could be called by
4177 // different dump tasks at the same time if the parallel run is enabled, a
4178 // mutex lock is necessary here to synchronize the call.
4179 std::lock_guard<std::recursive_mutex> lock(mutex_);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004180
4181 // Always update progess so stats can be tuned...
Nandana Dutt402a8392019-06-14 14:25:13 +01004182 progress_->Inc(delta_sec);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004183
4184 // ...but only notifiy listeners when necessary.
4185 if (!options_->do_progress_updates) return;
4186
4187 int progress = progress_->Get();
4188 int max = progress_->GetMax();
Nandana Dutt402a8392019-06-14 14:25:13 +01004189 int percent = 100 * progress / max;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004190
Nandana Dutt402a8392019-06-14 14:25:13 +01004191 if (last_reported_percent_progress_ > 0 && percent <= last_reported_percent_progress_) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004192 return;
4193 }
Nandana Dutt402a8392019-06-14 14:25:13 +01004194 last_reported_percent_progress_ = percent;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004195
4196 if (control_socket_fd_ >= 0) {
4197 dprintf(control_socket_fd_, "PROGRESS:%d/%d\n", progress, max);
4198 fsync(control_socket_fd_);
4199 }
4200
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004201 if (listener_ != nullptr) {
Nandana Dutt235c6672019-11-14 15:22:32 +00004202 if (percent % 10 == 0) {
4203 // We don't want to spam logcat, so only log multiples of 10.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004204 MYLOGD("Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004205 } else {
4206 // stderr is ignored on normal invocations, but useful when calling
4207 // /system/bin/dumpstate directly for debuggging.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004208 fprintf(stderr, "Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004209 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004210
4211 listener_->onProgress(percent);
4212 }
4213}
4214
4215void Dumpstate::TakeScreenshot(const std::string& path) {
4216 const std::string& real_path = path.empty() ? screenshot_path_ : path;
4217 int status =
4218 RunCommand("", {"/system/bin/screencap", "-p", real_path},
4219 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
4220 if (status == 0) {
4221 MYLOGD("Screenshot saved on %s\n", real_path.c_str());
4222 } else {
4223 MYLOGE("Failed to take screenshot on %s\n", real_path.c_str());
4224 }
Paul Chang0d2aad72020-02-13 20:04:03 +08004225 if (listener_ != nullptr) {
4226 // Show a visual indication to indicate screenshot is taken via
4227 // IDumpstateListener.onScreenshotTaken()
4228 listener_->onScreenshotTaken(status == 0);
4229 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004230}
4231
4232bool is_dir(const char* pathname) {
4233 struct stat info;
4234 if (stat(pathname, &info) == -1) {
4235 return false;
4236 }
4237 return S_ISDIR(info.st_mode);
4238}
4239
4240time_t get_mtime(int fd, time_t default_mtime) {
4241 struct stat info;
4242 if (fstat(fd, &info) == -1) {
4243 return default_mtime;
4244 }
4245 return info.st_mtime;
4246}