blob: 1003aae4af6d0758c29ff1d4c462af7db74fa437 [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
Chris Morin5a50d482022-02-01 17:41:18 -08001090static void AddAnrTraceDir(const std::string& anr_traces_dir) {
Narayan Kamath8f788292017-05-25 13:20:39 +01001091 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) {
Chris Morin5a50d482022-02-01 17:41:18 -08001098 MYLOGD("Dumping current ANR traces (%s) to the main bugreport entry\n",
1099 dump_traces_path);
1100 ds.DumpFile("VM TRACES JUST NOW", dump_traces_path);
Narayan Kamath8f788292017-05-25 13:20:39 +01001101
1102 const int ret = unlink(dump_traces_path);
1103 if (ret == -1) {
1104 MYLOGW("Error unlinking temporary trace path %s: %s\n", dump_traces_path,
1105 strerror(errno));
Felipe Lemee184f662016-10-27 10:04:47 -07001106 }
1107 }
1108
Narayan Kamathbd863722017-06-01 18:50:12 +01001109 // Add a specific message for the first ANR Dump.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001110 if (ds.anr_data_.size() > 0) {
Chris Morin5a50d482022-02-01 17:41:18 -08001111 // The "last" ANR will always be present in the body of the main entry.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001112 AddDumps(ds.anr_data_.begin(), ds.anr_data_.begin() + 1,
Chris Morin5a50d482022-02-01 17:41:18 -08001113 "VM TRACES AT LAST ANR", false /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001114
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001115 // Historical ANRs are always included as separate entries in the bugreport zip file.
Chris Morin5a50d482022-02-01 17:41:18 -08001116 AddDumps(ds.anr_data_.begin(), ds.anr_data_.end(),
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001117 "HISTORICAL ANR", true /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001118 } else {
Narayan Kamath8f788292017-05-25 13:20:39 +01001119 printf("*** NO ANRs to dump in %s\n\n", ANR_DIR.c_str());
1120 }
1121}
1122
1123static void AddAnrTraceFiles() {
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001124 std::string anr_traces_dir = "/data/anr";
Narayan Kamath8f788292017-05-25 13:20:39 +01001125
Chris Morin5a50d482022-02-01 17:41:18 -08001126 AddAnrTraceDir(anr_traces_dir);
Narayan Kamath8f788292017-05-25 13:20:39 +01001127
Makoto Onuki83ec63f2019-01-31 17:08:59 -08001128 RunCommand("ANR FILES", {"ls", "-lt", ANR_DIR});
1129
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001130 // Slow traces for slow operations.
Felipe Lemee184f662016-10-27 10:04:47 -07001131 struct stat st;
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001132 int i = 0;
1133 while (true) {
1134 const std::string slow_trace_path =
1135 anr_traces_dir + android::base::StringPrintf("slow%02d.txt", i);
1136 if (stat(slow_trace_path.c_str(), &st)) {
1137 // No traces file at this index, done with the files.
1138 break;
Felipe Lemee184f662016-10-27 10:04:47 -07001139 }
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001140 ds.DumpFile("VM TRACES WHEN SLOW", slow_trace_path.c_str());
1141 i++;
Felipe Lemee184f662016-10-27 10:04:47 -07001142 }
1143}
1144
Wei Wang509bb5d2017-06-09 14:42:12 -07001145static void DumpBlockStatFiles() {
1146 DurationReporter duration_reporter("DUMP BLOCK STAT");
Wei Wang509bb5d2017-06-09 14:42:12 -07001147
Wei Wang1dc1ef52017-06-12 11:28:37 -07001148 std::unique_ptr<DIR, std::function<int(DIR*)>> dirptr(opendir(BLK_DEV_SYS_DIR), closedir);
1149
1150 if (dirptr == nullptr) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001151 MYLOGE("Failed to open %s: %s\n", BLK_DEV_SYS_DIR, strerror(errno));
1152 return;
1153 }
1154
1155 printf("------ DUMP BLOCK STAT ------\n\n");
Wei Wang1dc1ef52017-06-12 11:28:37 -07001156 while (struct dirent *d = readdir(dirptr.get())) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001157 if ((d->d_name[0] == '.')
1158 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
1159 || (d->d_name[1] == '\0'))) {
1160 continue;
1161 }
1162 const std::string new_path =
1163 android::base::StringPrintf("%s/%s", BLK_DEV_SYS_DIR, d->d_name);
1164 printf("------ BLOCK STAT (%s) ------\n", new_path.c_str());
1165 dump_files("", new_path.c_str(), skip_not_stat, dump_stat_from_fd);
1166 printf("\n");
1167 }
Wei Wang1dc1ef52017-06-12 11:28:37 -07001168 return;
Wei Wang509bb5d2017-06-09 14:42:12 -07001169}
Jayachandran Ca94c7172017-06-10 15:08:12 -07001170
1171static void DumpPacketStats() {
1172 DumpFile("NETWORK DEV INFO", "/proc/net/dev");
Jayachandran Ca94c7172017-06-10 15:08:12 -07001173}
1174
1175static void DumpIpAddrAndRules() {
1176 /* The following have a tendency to get wedged when wifi drivers/fw goes belly-up. */
1177 RunCommand("NETWORK INTERFACES", {"ip", "link"});
1178 RunCommand("IPv4 ADDRESSES", {"ip", "-4", "addr", "show"});
1179 RunCommand("IPv6 ADDRESSES", {"ip", "-6", "addr", "show"});
1180 RunCommand("IP RULES", {"ip", "rule", "show"});
1181 RunCommand("IP RULES v6", {"ip", "-6", "rule", "show"});
1182}
1183
Nandana Dutt5c390032019-03-12 10:52:56 +00001184static Dumpstate::RunStatus RunDumpsysTextByPriority(const std::string& title, int priority,
1185 std::chrono::milliseconds timeout,
1186 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001187 auto start = std::chrono::steady_clock::now();
Vishnu Naire97d6122018-01-18 13:58:56 -08001188 sp<android::IServiceManager> sm = defaultServiceManager();
1189 Dumpsys dumpsys(sm.get());
Vishnu Naire97d6122018-01-18 13:58:56 -08001190 Vector<String16> args;
1191 Dumpsys::setServiceArgs(args, /* asProto = */ false, priority);
Vishnu Naire97d6122018-01-18 13:58:56 -08001192 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ false);
1193 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001194 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001195 std::string path(title);
1196 path.append(" - ").append(String8(service).c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -08001197 size_t bytes_written = 0;
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001198 if (PropertiesHelper::IsDryRun()) {
1199 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1200 dumpsys.writeDumpFooter(STDOUT_FILENO, service, std::chrono::milliseconds(1));
1201 } else {
1202 status_t status = dumpsys.startDumpThread(Dumpsys::TYPE_DUMP, service, args);
1203 if (status == OK) {
1204 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1205 std::chrono::duration<double> elapsed_seconds;
1206 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH &&
1207 service == String16("meminfo")) {
1208 // Use a longer timeout for meminfo, since 30s is not always enough.
1209 status = dumpsys.writeDump(STDOUT_FILENO, service, 60s,
1210 /* as_proto = */ false, elapsed_seconds,
1211 bytes_written);
1212 } else {
1213 status = dumpsys.writeDump(STDOUT_FILENO, service, service_timeout,
1214 /* as_proto = */ false, elapsed_seconds,
1215 bytes_written);
1216 }
1217 dumpsys.writeDumpFooter(STDOUT_FILENO, service, elapsed_seconds);
1218 bool dump_complete = (status == OK);
1219 dumpsys.stopDumpThread(dump_complete);
Gavin Corkeryfac7e2b2021-07-08 22:39:02 +01001220 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001221 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001222
1223 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1224 std::chrono::steady_clock::now() - start);
1225 if (elapsed_duration > timeout) {
1226 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1227 elapsed_duration.count());
1228 break;
1229 }
1230 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001231 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001232}
1233
Vishnu Nair64afc022018-02-01 15:29:34 -08001234static void RunDumpsysText(const std::string& title, int priority,
1235 std::chrono::milliseconds timeout,
1236 std::chrono::milliseconds service_timeout) {
1237 DurationReporter duration_reporter(title);
1238 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1239 fsync(STDOUT_FILENO);
1240 RunDumpsysTextByPriority(title, priority, timeout, service_timeout);
1241}
1242
1243/* Dump all services registered with Normal or Default priority. */
Nandana Dutt5c390032019-03-12 10:52:56 +00001244static Dumpstate::RunStatus RunDumpsysTextNormalPriority(const std::string& title,
1245 std::chrono::milliseconds timeout,
1246 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001247 DurationReporter duration_reporter(title);
1248 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1249 fsync(STDOUT_FILENO);
1250 RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_NORMAL, timeout,
1251 service_timeout);
Nandana Dutt5c390032019-03-12 10:52:56 +00001252
1253 RETURN_IF_USER_DENIED_CONSENT();
1254
1255 return RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_DEFAULT, timeout,
1256 service_timeout);
Vishnu Nair64afc022018-02-01 15:29:34 -08001257}
1258
Nandana Dutt5c390032019-03-12 10:52:56 +00001259static Dumpstate::RunStatus RunDumpsysProto(const std::string& title, int priority,
1260 std::chrono::milliseconds timeout,
1261 std::chrono::milliseconds service_timeout) {
Vishnu Naire97d6122018-01-18 13:58:56 -08001262 sp<android::IServiceManager> sm = defaultServiceManager();
1263 Dumpsys dumpsys(sm.get());
1264 Vector<String16> args;
1265 Dumpsys::setServiceArgs(args, /* asProto = */ true, priority);
1266 DurationReporter duration_reporter(title);
1267
1268 auto start = std::chrono::steady_clock::now();
1269 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ true);
1270 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001271 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001272 std::string path(kProtoPath);
1273 path.append(String8(service).c_str());
1274 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL) {
1275 path.append("_CRITICAL");
1276 } else if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH) {
1277 path.append("_HIGH");
1278 }
1279 path.append(kProtoExt);
Steven Morelandcbd69fc2021-07-20 20:45:43 +00001280 status_t status = dumpsys.startDumpThread(Dumpsys::TYPE_DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001281 if (status == OK) {
1282 status = ds.AddZipEntryFromFd(path, dumpsys.getDumpFd(), service_timeout);
1283 bool dumpTerminated = (status == OK);
1284 dumpsys.stopDumpThread(dumpTerminated);
1285 }
1286 ZipWriter::FileEntry file_entry;
1287 ds.zip_writer_->GetLastEntry(&file_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -08001288
1289 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1290 std::chrono::steady_clock::now() - start);
1291 if (elapsed_duration > timeout) {
1292 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1293 elapsed_duration.count());
1294 break;
1295 }
1296 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001297 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001298}
1299
Nandana Dutta7db6342018-11-21 14:53:34 +00001300// Runs dumpsys on services that must dump first and will take less than 100ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001301static Dumpstate::RunStatus RunDumpsysCritical() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001302 RunDumpsysText("DUMPSYS CRITICAL", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1303 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Nandana Dutt5c390032019-03-12 10:52:56 +00001304
1305 RETURN_IF_USER_DENIED_CONSENT();
1306
1307 return RunDumpsysProto("DUMPSYS CRITICAL PROTO", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1308 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Vishnu Nair780b1282017-10-10 13:57:24 -07001309}
1310
1311// Runs dumpsys on services that must dump first but can take up to 250ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001312static Dumpstate::RunStatus RunDumpsysHigh() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001313 // TODO meminfo takes ~10s, connectivity takes ~5sec to dump. They are both
1314 // high priority. Reduce timeout once they are able to dump in a shorter time or
1315 // moved to a parallel task.
1316 RunDumpsysText("DUMPSYS HIGH", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1317 /* timeout= */ 90s, /* service_timeout= */ 30s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001318
1319 RETURN_IF_USER_DENIED_CONSENT();
1320
1321 return RunDumpsysProto("DUMPSYS HIGH PROTO", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1322 /* timeout= */ 5s, /* service_timeout= */ 1s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001323}
1324
1325// Runs dumpsys on services that must dump but can take up to 10s to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001326static Dumpstate::RunStatus RunDumpsysNormal() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001327 RunDumpsysTextNormalPriority("DUMPSYS", /* timeout= */ 90s, /* service_timeout= */ 10s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001328
1329 RETURN_IF_USER_DENIED_CONSENT();
1330
1331 return RunDumpsysProto("DUMPSYS PROTO", IServiceManager::DUMP_FLAG_PRIORITY_NORMAL,
1332 /* timeout= */ 90s, /* service_timeout= */ 10s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001333}
1334
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001335/*
1336 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1337 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1338 * if it's not running in the parallel task.
1339 */
1340static void DumpHals(int out_fd = STDOUT_FILENO) {
Yifan Hong30528a22020-08-07 18:24:06 -07001341 RunCommand("HARDWARE HALS", {"lshal", "--all", "--types=all"},
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001342 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build(),
1343 false, out_fd);
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001344
Steven Moreland44cd9482018-01-04 16:24:13 -08001345 using android::hidl::manager::V1_0::IServiceManager;
1346 using android::hardware::defaultServiceManager;
1347
1348 sp<IServiceManager> sm = defaultServiceManager();
1349 if (sm == nullptr) {
1350 MYLOGE("Could not retrieve hwservicemanager to dump hals.\n");
1351 return;
1352 }
1353
1354 auto ret = sm->list([&](const auto& interfaces) {
1355 for (const std::string& interface : interfaces) {
1356 std::string cleanName = interface;
1357 std::replace_if(cleanName.begin(),
1358 cleanName.end(),
1359 [](char c) {
1360 return !isalnum(c) &&
1361 std::string("@-_:.").find(c) == std::string::npos;
1362 }, '_');
Nandana Dutt979388e2018-11-30 16:48:55 +00001363 const std::string path = ds.bugreport_internal_dir_ + "/lshal_debug_" + cleanName;
Steven Moreland44cd9482018-01-04 16:24:13 -08001364
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001365 bool empty = false;
Steven Moreland44cd9482018-01-04 16:24:13 -08001366 {
1367 auto fd = android::base::unique_fd(
1368 TEMP_FAILURE_RETRY(open(path.c_str(),
1369 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1370 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1371 if (fd < 0) {
1372 MYLOGE("Could not open %s to dump additional hal information.\n", path.c_str());
1373 continue;
1374 }
1375 RunCommandToFd(fd,
1376 "",
Steven Morelandc81cd3c2018-01-18 14:36:26 -08001377 {"lshal", "debug", "-E", interface},
Steven Moreland44cd9482018-01-04 16:24:13 -08001378 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
1379
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001380 empty = 0 == lseek(fd, 0, SEEK_END);
Steven Moreland44cd9482018-01-04 16:24:13 -08001381 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001382 if (!empty) {
1383 ds.EnqueueAddZipEntryAndCleanupIfNeeded("lshal-debug/" + cleanName + ".txt",
1384 path);
1385 } else {
1386 unlink(path.c_str());
1387 }
Steven Moreland44cd9482018-01-04 16:24:13 -08001388 }
1389 });
1390
1391 if (!ret.isOk()) {
1392 MYLOGE("Could not list hals from hwservicemanager.\n");
1393 }
1394}
1395
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001396static void DumpExternalFragmentationInfo() {
1397 struct stat st;
1398 if (stat("/proc/buddyinfo", &st) != 0) {
1399 MYLOGE("Unable to dump external fragmentation info\n");
1400 return;
1401 }
1402
1403 printf("------ EXTERNAL FRAGMENTATION INFO ------\n");
1404 std::ifstream ifs("/proc/buddyinfo");
1405 auto unusable_index_regex = std::regex{"Node\\s+([0-9]+),\\s+zone\\s+(\\S+)\\s+(.*)"};
1406 for (std::string line; std::getline(ifs, line);) {
1407 std::smatch match_results;
1408 if (std::regex_match(line, match_results, unusable_index_regex)) {
1409 std::stringstream free_pages(std::string{match_results[3]});
1410 std::vector<int> free_pages_per_order(std::istream_iterator<int>{free_pages},
1411 std::istream_iterator<int>());
1412
1413 int total_free_pages = 0;
1414 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1415 total_free_pages += (free_pages_per_order[i] * std::pow(2, i));
1416 }
1417
1418 printf("Node %s, zone %8s", match_results[1].str().c_str(),
1419 match_results[2].str().c_str());
1420
1421 int usable_free_pages = total_free_pages;
1422 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1423 auto unusable_index = (total_free_pages - usable_free_pages) /
1424 static_cast<double>(total_free_pages);
1425 printf(" %5.3f", unusable_index);
1426 usable_free_pages -= (free_pages_per_order[i] * std::pow(2, i));
1427 }
1428
1429 printf("\n");
1430 }
1431 }
1432 printf("\n");
1433}
1434
mhasankd451a472020-05-26 18:02:39 -07001435static void DumpstateLimitedOnly() {
1436 // Trimmed-down version of dumpstate to only include a whitelisted
1437 // set of logs (system log, event log, and system server / system app
1438 // crashes, and networking logs). See b/136273873 and b/138459828
1439 // for context.
1440 DurationReporter duration_reporter("DUMPSTATE");
1441 unsigned long timeout_ms;
1442 // calculate timeout
1443 timeout_ms = logcat_timeout({"main", "system", "crash"});
1444 RunCommand("SYSTEM LOG",
1445 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1446 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1447 timeout_ms = logcat_timeout({"events"});
1448 RunCommand(
1449 "EVENT LOG",
1450 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1451 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1452
1453 printf("========================================================\n");
1454 printf("== Networking Service\n");
1455 printf("========================================================\n");
1456
1457 RunDumpsys("DUMPSYS NETWORK_SERVICE_LIMITED", {"wifi", "-a"},
1458 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hugo Benichiaa162682020-10-30 23:28:56 +09001459 RunDumpsys("DUMPSYS CONNECTIVITY REQUESTS", {"connectivity", "requests"},
1460 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
mhasankd451a472020-05-26 18:02:39 -07001461
1462 printf("========================================================\n");
1463 printf("== Dropbox crashes\n");
1464 printf("========================================================\n");
1465
1466 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1467 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1468
1469 printf("========================================================\n");
1470 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1471 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1472 printf("========================================================\n");
1473 printf("== dumpstate: done (id %d)\n", ds.id_);
1474 printf("========================================================\n");
1475}
1476
Rhed Jaoe017f982020-07-21 17:58:41 +08001477/*
1478 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1479 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1480 * if it's not running in the parallel task.
1481 */
1482static void DumpCheckins(int out_fd = STDOUT_FILENO) {
1483 dprintf(out_fd, "========================================================\n");
1484 dprintf(out_fd, "== Checkins\n");
1485 dprintf(out_fd, "========================================================\n");
1486
1487 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"}, out_fd);
1488 RunDumpsys("CHECKIN MEMINFO", {"meminfo", "--checkin"}, out_fd);
1489 RunDumpsys("CHECKIN NETSTATS", {"netstats", "--checkin"}, out_fd);
1490 RunDumpsys("CHECKIN PROCSTATS", {"procstats", "-c"}, out_fd);
1491 RunDumpsys("CHECKIN USAGESTATS", {"usagestats", "-c"}, out_fd);
1492 RunDumpsys("CHECKIN PACKAGE", {"package", "--checkin"}, out_fd);
1493}
1494
1495/*
1496 * Runs dumpsys on activity service to dump all application activities, services
1497 * and providers in the device.
1498 *
1499 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1500 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1501 * if it's not running in the parallel task.
1502 */
1503static void DumpAppInfos(int out_fd = STDOUT_FILENO) {
1504 dprintf(out_fd, "========================================================\n");
1505 dprintf(out_fd, "== Running Application Activities\n");
1506 dprintf(out_fd, "========================================================\n");
1507
1508 // The following dumpsys internally collects output from running apps, so it can take a long
1509 // time. So let's extend the timeout.
1510
1511 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
1512
1513 RunDumpsys("APP ACTIVITIES", {"activity", "-v", "all"}, DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1514
1515 dprintf(out_fd, "========================================================\n");
1516 dprintf(out_fd, "== Running Application Services (platform)\n");
1517 dprintf(out_fd, "========================================================\n");
1518
1519 RunDumpsys("APP SERVICES PLATFORM", {"activity", "service", "all-platform-non-critical"},
1520 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1521
1522 dprintf(out_fd, "========================================================\n");
1523 dprintf(out_fd, "== Running Application Services (non-platform)\n");
1524 dprintf(out_fd, "========================================================\n");
1525
1526 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1527 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1528
1529 dprintf(out_fd, "========================================================\n");
1530 dprintf(out_fd, "== Running Application Providers (platform)\n");
1531 dprintf(out_fd, "========================================================\n");
1532
1533 RunDumpsys("APP PROVIDERS PLATFORM", {"activity", "provider", "all-platform"},
Rhed Jaob049f182021-01-11 21:08:43 +08001534 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
Rhed Jaoe017f982020-07-21 17:58:41 +08001535
1536 dprintf(out_fd, "========================================================\n");
1537 dprintf(out_fd, "== Running Application Providers (non-platform)\n");
1538 dprintf(out_fd, "========================================================\n");
1539
1540 RunDumpsys("APP PROVIDERS NON-PLATFORM", {"activity", "provider", "all-non-platform"},
1541 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1542}
1543
Nandana Dutt5c390032019-03-12 10:52:56 +00001544// Dumps various things. Returns early with status USER_CONSENT_DENIED if user denies consent
1545// via the consent they are shown. Ignores other errors that occur while running various
1546// commands. The consent checking is currently done around long running tasks, which happen to
1547// be distributed fairly evenly throughout the function.
1548static Dumpstate::RunStatus dumpstate() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001549 DurationReporter duration_reporter("DUMPSTATE");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001550
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001551 // Enqueue slow functions into the thread pool, if the parallel run is enabled.
1552 if (ds.dump_pool_) {
1553 // Pool was shutdown in DumpstateDefaultAfterCritical method in order to
1554 // drop root user. Restarts it with two threads for the parallel run.
1555 ds.dump_pool_->start(/* thread_counts = */2);
1556
1557 ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
1558 ds.dump_pool_->enqueueTask(DUMP_INCIDENT_REPORT_TASK, &DumpIncidentReport);
1559 ds.dump_pool_->enqueueTaskWithFd(DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
Rhed Jaoe017f982020-07-21 17:58:41 +08001560 ds.dump_pool_->enqueueTaskWithFd(DUMP_CHECKINS_TASK, &DumpCheckins, _1);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001561 }
1562
Nandana Dutt5c390032019-03-12 10:52:56 +00001563 // Dump various things. Note that anything that takes "long" (i.e. several seconds) should
1564 // check intermittently (if it's intrerruptable like a foreach on pids) and/or should be wrapped
1565 // in a consent check (via RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK).
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -07001566 dump_dev_files("TRUSTY VERSION", "/sys/bus/platform/drivers/trusty", "trusty_version");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001567 RunCommand("UPTIME", {"uptime"});
Wei Wang509bb5d2017-06-09 14:42:12 -07001568 DumpBlockStatFiles();
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001569 DumpFile("MEMORY INFO", "/proc/meminfo");
1570 RunCommand("CPU INFO", {"top", "-b", "-n", "1", "-H", "-s", "6", "-o",
Felipe Leme30dbfa12016-09-02 12:43:26 -07001571 "pid,tid,user,pr,ni,%cpu,s,virt,res,pcy,cmd,name"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001572
1573 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "PROCRANK", {"procrank"}, AS_ROOT_20);
1574
Sunny Goyal35949782019-11-19 15:54:36 -08001575 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpVisibleWindowViews);
1576
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001577 DumpFile("VIRTUAL MEMORY STATS", "/proc/vmstat");
1578 DumpFile("VMALLOC INFO", "/proc/vmallocinfo");
1579 DumpFile("SLAB INFO", "/proc/slabinfo");
1580 DumpFile("ZONEINFO", "/proc/zoneinfo");
1581 DumpFile("PAGETYPEINFO", "/proc/pagetypeinfo");
1582 DumpFile("BUDDYINFO", "/proc/buddyinfo");
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001583 DumpExternalFragmentationInfo();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001584
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001585 DumpFile("KERNEL CPUFREQ", "/sys/devices/system/cpu/cpu0/cpufreq/stats/time_in_state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001586
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001587 RunCommand("PROCESSES AND THREADS",
Yohei Yukawa591a72d2017-10-05 21:36:35 -07001588 {"ps", "-A", "-T", "-Z", "-O", "pri,nice,rtprio,sched,pcy,time"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001589
1590 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "LIBRANK", {"librank"},
1591 CommandOptions::AS_ROOT);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001592
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001593 if (ds.dump_pool_) {
1594 WAIT_TASK_WITH_CONSENT_CHECK(DUMP_HALS_TASK, ds.dump_pool_);
1595 } else {
1596 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_HALS_TASK, DumpHals);
1597 }
Steven Moreland81b429e2017-01-31 19:50:46 -08001598
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001599 RunCommand("PRINTENV", {"printenv"});
Elliott Hughes21b7c8d2016-10-28 08:53:02 -07001600 RunCommand("NETSTAT", {"netstat", "-nW"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001601 struct stat s;
1602 if (stat("/proc/modules", &s) != 0) {
1603 MYLOGD("Skipping 'lsmod' because /proc/modules does not exist\n");
1604 } else {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001605 RunCommand("LSMOD", {"lsmod"});
Woody Linc198f252021-05-04 16:37:11 +08001606 RunCommand("MODULES INFO",
1607 {"sh", "-c", "cat /proc/modules | cut -d' ' -f1 | "
1608 " while read MOD ; do echo modinfo:$MOD ; modinfo $MOD ; "
1609 "done"}, CommandOptions::AS_ROOT);
Felipe Lemee4eca582016-06-10 17:48:08 -07001610 }
Michal Karpinski4db754f2015-12-11 18:04:32 +00001611
Tom Cherryb87dbfa2020-07-28 11:28:53 -07001612 if (android::base::GetBoolProperty("ro.logd.kernel", false)) {
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001613 DoKernelLogcat();
1614 } else {
1615 do_dmesg();
1616 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001617
Felipe Lemef0292972016-11-22 13:57:05 -08001618 RunCommand("LIST OF OPEN FILES", {"lsof"}, CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001619
1620 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(for_each_pid, do_showmap, "SMAPS OF ALL PROCESSES");
1621
Jeff Brown1dc94e32014-09-11 14:15:27 -07001622 for_each_tid(show_wchan, "BLOCKED PROCESS WAIT-CHANNELS");
Mark Salyzyna297c322016-02-05 15:33:17 -08001623 for_each_pid(show_showtime, "PROCESS TIMES (pid cmd user system iowait+percentage)");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001624
Jack Yu5a6b2e22020-08-14 18:13:35 +08001625 /* Dump Nfc NCI logs */
1626 ds.AddDir("/data/misc/nfc/logs", true);
Ajay Panickerd886ec42016-09-14 12:26:46 -07001627
Paul Chang0d2aad72020-02-13 20:04:03 +08001628 if (ds.options_->do_screenshot && !ds.do_early_screenshot_) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001629 MYLOGI("taking late screenshot\n");
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001630 ds.TakeScreenshot();
Jeff Sharkey5a930032013-03-19 15:05:19 -07001631 }
1632
Felipe Lemee184f662016-10-27 10:04:47 -07001633 AddAnrTraceFiles();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001634
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001635 MaybeAddSystemTraceToZip();
1636
Narayan Kamath8f788292017-05-25 13:20:39 +01001637 // NOTE: tombstones are always added as separate entries in the zip archive
1638 // and are not interspersed with the main report.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001639 const bool tombstones_dumped = AddDumps(ds.tombstone_data_.begin(), ds.tombstone_data_.end(),
Narayan Kamathbd863722017-06-01 18:50:12 +01001640 "TOMBSTONE", true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001641 if (!tombstones_dumped) {
1642 printf("*** NO TOMBSTONES to dump in %s\n\n", TOMBSTONE_DIR.c_str());
Christopher Ferris7dc7f322014-07-22 16:08:19 -07001643 }
1644
Jayachandran Ca94c7172017-06-10 15:08:12 -07001645 DumpPacketStats();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001646
Chenbo Feng276a3b62018-08-07 11:44:49 -07001647 RunDumpsys("EBPF MAP STATS", {"netd", "trafficcontroller"});
1648
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001649 DoKmsg();
Mark Salyzyn2262c162014-12-16 09:09:26 -08001650
Jayachandran Ca94c7172017-06-10 15:08:12 -07001651 DumpIpAddrAndRules();
Sreeram Ramachandran2b3bba32014-07-08 15:40:55 -07001652
1653 dump_route_tables();
1654
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001655 RunCommand("ARP CACHE", {"ip", "-4", "neigh", "show"});
1656 RunCommand("IPv6 ND CACHE", {"ip", "-6", "neigh", "show"});
1657 RunCommand("MULTICAST ADDRESSES", {"ip", "maddr"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001658
Nandana Dutt5c390032019-03-12 10:52:56 +00001659 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysHigh);
Lorenzo Colitti6afc38c2015-09-09 22:59:25 +09001660
Chiachang Wang668ede42021-05-17 17:14:20 +08001661 // The dump mechanism in connectivity is refactored due to modularization work. Connectivity can
1662 // only register with a default priority(NORMAL priority). Dumpstate has to call connectivity
1663 // dump with priority parameters to dump high priority information.
1664 RunDumpsys("SERVICE HIGH connectivity", {"connectivity", "--dump-priority", "HIGH"},
1665 CommandOptions::WithTimeout(10).Build());
1666
Elliott Hughes23ccc622017-02-28 10:14:22 -08001667 RunCommand("SYSTEM PROPERTIES", {"getprop"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001668
Jin Qianf334d662017-10-10 14:41:37 -07001669 RunCommand("STORAGED IO INFO", {"storaged", "-u", "-p"});
ynwangf649a6e2016-07-17 21:56:00 -07001670
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001671 RunCommand("FILESYSTEMS & FREE SPACE", {"df"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001672
Colin Crossf45fa6b2012-03-26 12:38:26 -07001673 /* Binder state is expensive to look at as it uses a lot of memory. */
Hridya Valsaraju920ba712020-02-09 16:27:01 -08001674 std::string binder_logs_dir = access("/dev/binderfs/binder_logs", R_OK) ?
1675 "/sys/kernel/debug/binder" : "/dev/binderfs/binder_logs";
1676
1677 DumpFile("BINDER FAILED TRANSACTION LOG", binder_logs_dir + "/failed_transaction_log");
1678 DumpFile("BINDER TRANSACTION LOG", binder_logs_dir + "/transaction_log");
1679 DumpFile("BINDER TRANSACTIONS", binder_logs_dir + "/transactions");
1680 DumpFile("BINDER STATS", binder_logs_dir + "/stats");
1681 DumpFile("BINDER STATE", binder_logs_dir + "/state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001682
Vishnu Nair36b4cdb2017-11-17 10:27:05 -08001683 /* Add window and surface trace files. */
1684 if (!PropertiesHelper::IsUserBuild()) {
1685 ds.AddDir(WMTRACE_DATA_DIR, false);
1686 }
1687
Yifan Hongd90cc652020-02-08 16:52:02 -08001688 ds.AddDir(SNAPSHOTCTL_LOG_DIR, false);
1689
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001690 if (ds.dump_pool_) {
1691 WAIT_TASK_WITH_CONSENT_CHECK(DUMP_BOARD_TASK, ds.dump_pool_);
1692 } else {
1693 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
1694 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001695
Steven Moreland7440ddb2016-12-15 16:13:39 -08001696 /* Migrate the ril_dumpstate to a device specific dumpstate? */
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001697 int rilDumpstateTimeout = android::base::GetIntProperty("ril.dumpstate.timeout", 0);
1698 if (rilDumpstateTimeout > 0) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001699 // su does not exist on user builds, so try running without it.
1700 // This way any implementations of vril-dump that do not require
1701 // root can run on user builds.
1702 CommandOptions::CommandOptionsBuilder options =
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001703 CommandOptions::WithTimeout(rilDumpstateTimeout);
Felipe Lemef0292972016-11-22 13:57:05 -08001704 if (!PropertiesHelper::IsUserBuild()) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001705 options.AsRoot();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001706 }
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001707 RunCommand("DUMP VENDOR RIL LOGS", {"vril-dump"}, options.Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -07001708 }
1709
Felipe Lemed8b94e52016-12-08 10:21:44 -08001710 printf("========================================================\n");
1711 printf("== Android Framework Services\n");
1712 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001713
Nandana Dutt5c390032019-03-12 10:52:56 +00001714 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysNormal);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001715
Jack He91ff2fe2021-02-18 18:23:43 -08001716 /* Dump Bluetooth HCI logs after getting bluetooth_manager dumpsys */
1717 ds.AddDir("/data/misc/bluetooth/logs", true);
1718
Rhed Jaoe017f982020-07-21 17:58:41 +08001719 if (ds.dump_pool_) {
1720 WAIT_TASK_WITH_CONSENT_CHECK(DUMP_CHECKINS_TASK, ds.dump_pool_);
1721 } else {
1722 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_CHECKINS_TASK, DumpCheckins);
1723 }
Dianne Hackborn02bea972013-06-26 18:59:09 -07001724
Rhed Jaoc5f7ec32020-12-22 22:11:08 +08001725 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpAppInfos);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001726
Adrian Roos8b397ab2017-04-04 16:35:44 -07001727 printf("========================================================\n");
1728 printf("== Dropbox crashes\n");
1729 printf("========================================================\n");
1730
1731 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1732 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1733
Felipe Lemed8b94e52016-12-08 10:21:44 -08001734 printf("========================================================\n");
1735 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1736 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1737 printf("========================================================\n");
1738 printf("== dumpstate: done (id %d)\n", ds.id_);
1739 printf("========================================================\n");
Bookatz38472142018-09-28 10:20:24 -07001740
1741 printf("========================================================\n");
1742 printf("== Obtaining statsd metadata\n");
1743 printf("========================================================\n");
1744 // This differs from the usual dumpsys stats, which is the stats report data.
1745 RunDumpsys("STATSDSTATS", {"stats", "--metadata"});
Mike Ma5c267872019-08-21 11:31:34 -07001746
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +09001747 // Add linker configuration directory
1748 ds.AddDir(LINKERCONFIG_DIR, true);
1749
Li Li830179f2022-01-04 12:53:29 -08001750 /* Dump frozen cgroupfs */
1751 dump_frozen_cgroupfs();
Li Li2eedd412021-06-30 15:11:53 -07001752
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001753 if (ds.dump_pool_) {
1754 WAIT_TASK_WITH_CONSENT_CHECK(DUMP_INCIDENT_REPORT_TASK, ds.dump_pool_);
1755 } else {
1756 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_INCIDENT_REPORT_TASK,
1757 DumpIncidentReport);
1758 }
Mike Ma5c267872019-08-21 11:31:34 -07001759
Nandana Dutt5c390032019-03-12 10:52:56 +00001760 return Dumpstate::RunStatus::OK;
Colin Crossf45fa6b2012-03-26 12:38:26 -07001761}
1762
Nandana Dutt5c390032019-03-12 10:52:56 +00001763/*
1764 * Dumps state for the default case; drops root after it's no longer necessary.
1765 *
1766 * Returns RunStatus::OK if everything went fine.
1767 * Returns RunStatus::ERROR if there was an error.
1768 * Returns RunStatus::USER_DENIED_CONSENT if user explicitly denied consent to sharing the bugreport
1769 * with the caller.
1770 */
Jichao Lie89d9c12019-11-21 19:02:51 -08001771Dumpstate::RunStatus Dumpstate::DumpstateDefaultAfterCritical() {
Nandana Duttdb379fa2019-10-09 16:54:41 +01001772 // Capture first logcat early on; useful to take a snapshot before dumpstate logs take over the
1773 // buffer.
1774 DoLogcat();
1775 // Capture timestamp after first logcat to use in next logcat
1776 time_t logcat_ts = time(nullptr);
1777
Nandana Dutt4be45d12018-09-26 15:04:23 +01001778 /* collect stack traces from Dalvik and native processes (needs root) */
Rhed Jao5377d792020-07-16 17:37:39 +08001779 if (dump_pool_) {
1780 RETURN_IF_USER_DENIED_CONSENT();
1781 // One thread is enough since we only need to enqueue DumpTraces here.
1782 dump_pool_->start(/* thread_counts = */1);
1783
1784 // DumpTraces takes long time, post it to the another thread in the
1785 // pool, if pool is available
1786 dump_pool_->enqueueTask(DUMP_TRACES_TASK, &Dumpstate::DumpTraces, &ds, &dump_traces_path);
1787 } else {
1788 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_TRACES_TASK, ds.DumpTraces,
1789 &dump_traces_path);
1790 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001791
1792 /* Run some operations that require root. */
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001793 if (!PropertiesHelper::IsDryRun()) {
Chris Morinc2cba7a2022-02-01 17:06:50 -08001794 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX);
1795 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX);
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001796 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001797
1798 ds.AddDir(RECOVERY_DIR, true);
1799 ds.AddDir(RECOVERY_DATA_DIR, true);
1800 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
1801 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1802 if (!PropertiesHelper::IsUserBuild()) {
1803 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1804 ds.AddDir(PROFILE_DATA_DIR_REF, true);
Calin Juravlef84d3692020-04-28 15:31:12 -07001805 ds.AddZipEntry(ZIP_ROOT_DIR + PACKAGE_DEX_USE_LIST, PACKAGE_DEX_USE_LIST);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001806 }
Jerry Changa1df8a92020-01-02 16:03:39 +08001807 ds.AddDir(PREREBOOT_DATA_DIR, false);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001808 add_mountinfo();
1809 DumpIpTablesAsRoot();
David Andersond9ba4752018-12-11 18:26:59 -08001810 DumpDynamicPartitionInfo();
Yifan Hong3945e1b2019-10-29 12:59:23 -07001811 ds.AddDir(OTA_METADATA_DIR, true);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001812
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001813 // Capture any IPSec policies in play. No keys are exposed here.
Nandana Dutt4be45d12018-09-26 15:04:23 +01001814 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1815
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001816 // Dump IPsec stats. No keys are exposed here.
1817 DumpFile("XFRM STATS", XFRM_STAT_PROC_FILE);
1818
Nandana Dutt4be45d12018-09-26 15:04:23 +01001819 // Run ss as root so we can see socket marks.
1820 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
1821
1822 // Run iotop as root to show top 100 IO threads
1823 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
1824
Erick Reyese68df822019-02-11 14:46:36 -08001825 // Gather shared memory buffer info if the product implements it
Hridya Valsaraju1da80c52021-01-09 22:10:11 -08001826 RunCommand("Dmabuf dump", {"dmabuf_dump"});
1827 RunCommand("Dmabuf per-buffer/per-exporter/per-device stats", {"dmabuf_dump", "-b"});
Erick Reyese68df822019-02-11 14:46:36 -08001828
Minchan Kim22c6a1e2019-09-30 15:58:10 -07001829 DumpFile("PSI cpu", "/proc/pressure/cpu");
1830 DumpFile("PSI memory", "/proc/pressure/memory");
1831 DumpFile("PSI io", "/proc/pressure/io");
1832
Rhed Jao5377d792020-07-16 17:37:39 +08001833 if (dump_pool_) {
1834 RETURN_IF_USER_DENIED_CONSENT();
1835 dump_pool_->waitForTask(DUMP_TRACES_TASK);
1836
1837 // Current running thread in the pool is the root user also. Shutdown
1838 // the pool and restart later to ensure all threads in the pool could
1839 // drop the root user.
1840 dump_pool_->shutdown();
1841 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001842 if (!DropRootUser()) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001843 return Dumpstate::RunStatus::ERROR;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001844 }
1845
Nandana Dutt5c390032019-03-12 10:52:56 +00001846 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttdb379fa2019-10-09 16:54:41 +01001847 Dumpstate::RunStatus status = dumpstate();
1848 // Capture logcat since the last time we did it.
1849 DoSystemLogcat(logcat_ts);
1850 return status;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001851}
1852
Rhed Jaob5685b32020-08-14 17:19:17 +08001853// Common states for telephony and wifi which are needed to be collected before
1854// dumpstate drop the root user.
1855static void DumpstateRadioAsRoot() {
1856 DumpIpTablesAsRoot();
1857 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1858}
1859
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001860// This method collects common dumpsys for telephony and wifi. Typically, wifi
1861// reports are fine to include all information, but telephony reports on user
1862// builds need to strip some content (see DumpstateTelephonyOnly).
1863static void DumpstateRadioCommon(bool include_sensitive_info = true) {
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001864 // We need to be picky about some stuff for telephony reports on user builds.
1865 if (!include_sensitive_info) {
1866 // Only dump the radio log buffer (other buffers and dumps contain too much unrelated info).
1867 DoRadioLogcat();
1868 } else {
Rhed Jaob5685b32020-08-14 17:19:17 +08001869 // DumpHals takes long time, post it to the another thread in the pool,
1870 // if pool is available.
1871 if (ds.dump_pool_) {
1872 ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
1873 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001874 // Contains various system properties and process startup info.
1875 do_dmesg();
1876 // Logs other than the radio buffer may contain package/component names and potential PII.
1877 DoLogcat();
1878 // Too broad for connectivity problems.
1879 DoKmsg();
Rhed Jaob5685b32020-08-14 17:19:17 +08001880 // DumpHals contains unrelated hardware info (camera, NFC, biometrics, ...).
1881 if (ds.dump_pool_) {
1882 ds.dump_pool_->waitForTask(DUMP_HALS_TASK);
1883 } else {
1884 RUN_SLOW_FUNCTION_AND_LOG(DUMP_HALS_TASK, DumpHals);
1885 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001886 }
1887
Jayachandran Ca94c7172017-06-10 15:08:12 -07001888 DumpPacketStats();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001889 DumpIpAddrAndRules();
1890 dump_route_tables();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001891 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
1892 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08001893}
1894
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001895// We use "telephony" here for legacy reasons, though this now really means "connectivity" (cellular
1896// + wifi + networking). This method collects dumpsys for connectivity debugging only. General rules
1897// for what can be included on user builds: all reported information MUST directly relate to
1898// connectivity debugging or customer support and MUST NOT contain unrelated personally identifiable
1899// information. This information MUST NOT identify user-installed packages (UIDs are OK, package
1900// names are not), and MUST NOT contain logs of user application traffic.
1901// TODO(b/148168577) rename this and other related fields/methods to "connectivity" instead.
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08001902static void DumpstateTelephonyOnly(const std::string& calling_package) {
mukesh agrawal253dad42018-01-23 21:59:59 -08001903 DurationReporter duration_reporter("DUMPSTATE");
Jichao Lie89d9c12019-11-21 19:02:51 -08001904
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001905 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08001906
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001907 const bool include_sensitive_info = !PropertiesHelper::IsUserBuild();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001908
Rhed Jaob5685b32020-08-14 17:19:17 +08001909 DumpstateRadioAsRoot();
1910 if (!DropRootUser()) {
1911 return;
1912 }
1913
1914 // Starts thread pool after the root user is dropped, and two additional threads
1915 // are created for DumpHals in the DumpstateRadioCommon and DumpstateBoard.
1916 if (ds.dump_pool_) {
1917 ds.dump_pool_->start(/*thread_counts =*/2);
1918
1919 // DumpstateBoard takes long time, post it to the another thread in the pool,
1920 // if pool is available.
1921 ds.dump_pool_->enqueueTaskWithFd(DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
1922 }
1923
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001924 DumpstateRadioCommon(include_sensitive_info);
1925
1926 if (include_sensitive_info) {
1927 // Contains too much unrelated PII, and given the unstructured nature of sysprops, we can't
1928 // really cherrypick all of the connectivity-related ones. Apps generally have no business
1929 // reading these anyway, and there should be APIs to supply the info in a more app-friendly
1930 // way.
1931 RunCommand("SYSTEM PROPERTIES", {"getprop"});
1932 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07001933
1934 printf("========================================================\n");
1935 printf("== Android Framework Services\n");
1936 printf("========================================================\n");
1937
Vishnu Nair652cc802017-11-30 15:18:30 -08001938 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1939 SEC_TO_MSEC(10));
Hunter Knepshield31cbae12021-05-11 16:23:24 -07001940 RunDumpsys("DUMPSYS", {"vcn_management"}, CommandOptions::WithTimeout(90).Build(),
1941 SEC_TO_MSEC(10));
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08001942 if (include_sensitive_info) {
1943 // Carrier apps' services will be dumped below in dumpsys activity service all-non-platform.
1944 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
1945 SEC_TO_MSEC(10));
1946 } else {
1947 // If the caller is a carrier app and has a carrier service, dump it here since we aren't
1948 // running dumpsys activity service all-non-platform below. Due to the increased output, we
1949 // give a higher timeout as well.
1950 RunDumpsys("DUMPSYS", {"carrier_config", "--requesting-package", calling_package},
1951 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(30));
1952 }
1953 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001954 RunDumpsys("DUMPSYS", {"netpolicy"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
1955 RunDumpsys("DUMPSYS", {"network_management"}, CommandOptions::WithTimeout(90).Build(),
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07001956 SEC_TO_MSEC(10));
Hunter Knepshield0fe51b12020-03-05 16:58:20 -08001957 RunDumpsys("DUMPSYS", {"telephony.registry"}, CommandOptions::WithTimeout(90).Build(),
1958 SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001959 if (include_sensitive_info) {
1960 // Contains raw IP addresses, omit from reports on user builds.
1961 RunDumpsys("DUMPSYS", {"netd"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
1962 // Contains raw destination IP/MAC addresses, omit from reports on user builds.
1963 RunDumpsys("DUMPSYS", {"connmetrics"}, CommandOptions::WithTimeout(90).Build(),
1964 SEC_TO_MSEC(10));
1965 // Contains package/component names, omit from reports on user builds.
1966 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
1967 SEC_TO_MSEC(10));
1968 // Contains package names, but should be relatively simple to remove them (also contains
1969 // UIDs already), omit from reports on user builds.
1970 RunDumpsys("BATTERYSTATS", {"deviceidle"}, CommandOptions::WithTimeout(90).Build(),
1971 SEC_TO_MSEC(10));
1972 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07001973
1974 printf("========================================================\n");
1975 printf("== Running Application Services\n");
1976 printf("========================================================\n");
1977
1978 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
1979
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001980 if (include_sensitive_info) {
1981 printf("========================================================\n");
1982 printf("== Running Application Services (non-platform)\n");
1983 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001984
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001985 // Contains package/component names and potential PII, omit from reports on user builds.
1986 // To get dumps of the active CarrierService(s) on user builds, we supply an argument to the
1987 // carrier_config dumpsys instead.
1988 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1989 DUMPSYS_COMPONENTS_OPTIONS);
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001990
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001991 printf("========================================================\n");
1992 printf("== Checkins\n");
1993 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07001994
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001995 // Contains package/component names, omit from reports on user builds.
1996 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
1997 }
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07001998
1999 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07002000 printf("== dumpstate: done (id %d)\n", ds.id_);
2001 printf("========================================================\n");
Rhed Jaob5685b32020-08-14 17:19:17 +08002002
2003 if (ds.dump_pool_) {
2004 ds.dump_pool_->waitForTask(DUMP_BOARD_TASK);
2005 } else {
2006 RUN_SLOW_FUNCTION_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
2007 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002008}
2009
mukesh agrawal253dad42018-01-23 21:59:59 -08002010// This method collects dumpsys for wifi debugging only
2011static void DumpstateWifiOnly() {
2012 DurationReporter duration_reporter("DUMPSTATE");
2013
Rhed Jaob5685b32020-08-14 17:19:17 +08002014 DumpstateRadioAsRoot();
2015 if (!DropRootUser()) {
2016 return;
2017 }
2018
2019 // Starts thread pool after the root user is dropped. Only one additional
2020 // thread is needed for DumpHals in the DumpstateRadioCommon.
2021 if (ds.dump_pool_) {
2022 ds.dump_pool_->start(/*thread_counts =*/1);
2023 }
2024
mukesh agrawal253dad42018-01-23 21:59:59 -08002025 DumpstateRadioCommon();
2026
2027 printf("========================================================\n");
2028 printf("== Android Framework Services\n");
2029 printf("========================================================\n");
2030
2031 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
2032 SEC_TO_MSEC(10));
2033 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
2034 SEC_TO_MSEC(10));
2035
2036 printf("========================================================\n");
2037 printf("== dumpstate: done (id %d)\n", ds.id_);
2038 printf("========================================================\n");
2039}
2040
Nandana Duttcf419a72019-03-14 10:40:17 +00002041Dumpstate::RunStatus Dumpstate::DumpTraces(const char** path) {
Gavin Corkery789d7a52021-02-24 23:52:35 +00002042 const std::string temp_file_pattern = ds.bugreport_internal_dir_ + "/dumptrace_XXXXXX";
Nandana Duttfaafd522019-03-11 09:23:09 +00002043 const size_t buf_size = temp_file_pattern.length() + 1;
2044 std::unique_ptr<char[]> file_name_buf(new char[buf_size]);
2045 memcpy(file_name_buf.get(), temp_file_pattern.c_str(), buf_size);
2046
2047 // Create a new, empty file to receive all trace dumps.
2048 //
2049 // TODO: This can be simplified once we remove support for the old style
2050 // dumps. We can have a file descriptor passed in to dump_traces instead
2051 // of creating a file, closing it and then reopening it again.
2052 android::base::unique_fd fd(mkostemp(file_name_buf.get(), O_APPEND | O_CLOEXEC));
2053 if (fd < 0) {
2054 MYLOGE("mkostemp on pattern %s: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002055 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002056 }
2057
2058 // Nobody should have access to this temporary file except dumpstate, but we
2059 // temporarily grant 'read' to 'others' here because this file is created
2060 // when tombstoned is still running as root, but dumped after dropping. This
2061 // can go away once support for old style dumping has.
2062 const int chmod_ret = fchmod(fd, 0666);
2063 if (chmod_ret < 0) {
2064 MYLOGE("fchmod on %s failed: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002065 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002066 }
2067
2068 std::unique_ptr<DIR, decltype(&closedir)> proc(opendir("/proc"), closedir);
2069 if (proc.get() == nullptr) {
2070 MYLOGE("opendir /proc failed: %s\n", strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002071 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002072 }
2073
2074 // Number of times process dumping has timed out. If we encounter too many
2075 // failures, we'll give up.
2076 int timeout_failures = 0;
2077 bool dalvik_found = false;
2078
2079 const std::set<int> hal_pids = get_interesting_hal_pids();
2080
2081 struct dirent* d;
2082 while ((d = readdir(proc.get()))) {
Nandana Duttcf419a72019-03-14 10:40:17 +00002083 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttfaafd522019-03-11 09:23:09 +00002084 int pid = atoi(d->d_name);
2085 if (pid <= 0) {
2086 continue;
2087 }
2088
2089 const std::string link_name = android::base::StringPrintf("/proc/%d/exe", pid);
2090 std::string exe;
2091 if (!android::base::Readlink(link_name, &exe)) {
2092 continue;
2093 }
2094
2095 bool is_java_process;
2096 if (exe == "/system/bin/app_process32" || exe == "/system/bin/app_process64") {
2097 // Don't bother dumping backtraces for the zygote.
2098 if (IsZygote(pid)) {
2099 continue;
2100 }
2101
2102 dalvik_found = true;
2103 is_java_process = true;
2104 } else if (should_dump_native_traces(exe.c_str()) || hal_pids.find(pid) != hal_pids.end()) {
2105 is_java_process = false;
2106 } else {
2107 // Probably a native process we don't care about, continue.
2108 continue;
2109 }
2110
2111 // If 3 backtrace dumps fail in a row, consider debuggerd dead.
2112 if (timeout_failures == 3) {
2113 dprintf(fd, "ERROR: Too many stack dump failures, exiting.\n");
2114 break;
2115 }
2116
2117 const uint64_t start = Nanotime();
2118 const int ret = dump_backtrace_to_file_timeout(
2119 pid, is_java_process ? kDebuggerdJavaBacktrace : kDebuggerdNativeBacktrace,
2120 is_java_process ? 5 : 20, fd);
2121
2122 if (ret == -1) {
2123 // For consistency, the header and footer to this message match those
2124 // dumped by debuggerd in the success case.
2125 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
2126 dprintf(fd, "Dump failed, likely due to a timeout.\n");
2127 dprintf(fd, "---- end %d ----", pid);
2128 timeout_failures++;
2129 continue;
2130 }
2131
2132 // We've successfully dumped stack traces, reset the failure count
2133 // and write a summary of the elapsed time to the file and continue with the
2134 // next process.
2135 timeout_failures = 0;
2136
2137 dprintf(fd, "[dump %s stack %d: %.3fs elapsed]\n", is_java_process ? "dalvik" : "native",
2138 pid, (float)(Nanotime() - start) / NANOS_PER_SEC);
2139 }
2140
2141 if (!dalvik_found) {
2142 MYLOGE("Warning: no Dalvik processes found to dump stacks\n");
2143 }
2144
Nandana Duttcf419a72019-03-14 10:40:17 +00002145 *path = file_name_buf.release();
2146 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002147}
2148
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002149static dumpstate_hal_hidl::DumpstateMode GetDumpstateHalModeHidl(
2150 const Dumpstate::BugreportMode bugreport_mode) {
2151 switch (bugreport_mode) {
2152 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2153 return dumpstate_hal_hidl::DumpstateMode::FULL;
2154 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2155 return dumpstate_hal_hidl::DumpstateMode::INTERACTIVE;
2156 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2157 return dumpstate_hal_hidl::DumpstateMode::REMOTE;
2158 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2159 return dumpstate_hal_hidl::DumpstateMode::WEAR;
2160 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2161 return dumpstate_hal_hidl::DumpstateMode::CONNECTIVITY;
2162 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2163 return dumpstate_hal_hidl::DumpstateMode::WIFI;
2164 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2165 return dumpstate_hal_hidl::DumpstateMode::DEFAULT;
2166 }
2167 return dumpstate_hal_hidl::DumpstateMode::DEFAULT;
2168}
2169
2170static dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode GetDumpstateHalModeAidl(
2171 const Dumpstate::BugreportMode bugreport_mode) {
2172 switch (bugreport_mode) {
2173 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2174 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::FULL;
2175 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2176 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::INTERACTIVE;
2177 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2178 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::REMOTE;
2179 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2180 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::WEAR;
2181 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2182 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::CONNECTIVITY;
2183 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2184 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::WIFI;
2185 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2186 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::DEFAULT;
2187 }
2188 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::DEFAULT;
2189}
2190
2191static void DoDumpstateBoardHidl(
2192 const sp<dumpstate_hal_hidl_1_0::IDumpstateDevice> dumpstate_hal_1_0,
2193 const std::vector<::ndk::ScopedFileDescriptor>& dumpstate_fds,
2194 const Dumpstate::BugreportMode bugreport_mode,
2195 const size_t timeout_sec) {
2196
2197 using ScopedNativeHandle =
2198 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
2199 ScopedNativeHandle handle(native_handle_create(static_cast<int>(dumpstate_fds.size()), 0),
2200 [](native_handle_t* handle) {
2201 // we don't close file handle's here
2202 // via native_handle_close(handle)
2203 // instead we let dumpstate_fds close the file handles when
2204 // dumpstate_fds gets destroyed
2205 native_handle_delete(handle);
2206 });
2207 if (handle == nullptr) {
2208 MYLOGE("Could not create native_handle for dumpstate HAL\n");
2209 return;
2210 }
2211
2212 for (size_t i = 0; i < dumpstate_fds.size(); i++) {
2213 handle.get()->data[i] = dumpstate_fds[i].get();
2214 }
2215
2216 // Prefer version 1.1 if available. New devices launching with R are no longer allowed to
2217 // implement just 1.0.
2218 const char* descriptor_to_kill;
2219 using DumpstateBoardTask = std::packaged_task<bool()>;
2220 DumpstateBoardTask dumpstate_board_task;
2221 sp<dumpstate_hal_hidl::IDumpstateDevice> dumpstate_hal(
2222 dumpstate_hal_hidl::IDumpstateDevice::castFrom(dumpstate_hal_1_0));
2223 if (dumpstate_hal != nullptr) {
2224 MYLOGI("Using IDumpstateDevice v1.1 HIDL HAL");
2225
2226 dumpstate_hal_hidl::DumpstateMode dumpstate_hal_mode =
2227 GetDumpstateHalModeHidl(bugreport_mode);
2228
2229 descriptor_to_kill = dumpstate_hal_hidl::IDumpstateDevice::descriptor;
2230 dumpstate_board_task =
2231 DumpstateBoardTask([timeout_sec, dumpstate_hal_mode, dumpstate_hal, &handle]() -> bool {
2232 ::android::hardware::Return<dumpstate_hal_hidl::DumpstateStatus> status =
2233 dumpstate_hal->dumpstateBoard_1_1(handle.get(), dumpstate_hal_mode,
2234 SEC_TO_MSEC(timeout_sec));
2235 if (!status.isOk()) {
2236 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2237 return false;
2238 } else if (status != dumpstate_hal_hidl::DumpstateStatus::OK) {
2239 MYLOGE("dumpstateBoard failed with DumpstateStatus::%s\n",
2240 dumpstate_hal_hidl::toString(status).c_str());
2241 return false;
2242 }
2243 return true;
2244 });
2245 } else {
2246 MYLOGI("Using IDumpstateDevice v1.0 HIDL HAL");
2247
2248 descriptor_to_kill = dumpstate_hal_hidl_1_0::IDumpstateDevice::descriptor;
2249 dumpstate_board_task = DumpstateBoardTask([dumpstate_hal_1_0, &handle]() -> bool {
2250 ::android::hardware::Return<void> status =
2251 dumpstate_hal_1_0->dumpstateBoard(handle.get());
2252 if (!status.isOk()) {
2253 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2254 return false;
2255 }
2256 return true;
2257 });
2258 }
2259 auto result = dumpstate_board_task.get_future();
2260 std::thread(std::move(dumpstate_board_task)).detach();
2261
2262 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2263 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate HAL\n", timeout_sec);
2264 if (!android::base::SetProperty(
2265 "ctl.interface_restart",
2266 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
2267 MYLOGE("Couldn't restart dumpstate HAL\n");
2268 }
2269 }
2270 // Wait some time for init to kill dumpstate vendor HAL
2271 constexpr size_t killing_timeout_sec = 10;
2272 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2273 MYLOGE(
2274 "killing dumpstateBoard timed out after %zus, continue and "
2275 "there might be racing in content\n",
2276 killing_timeout_sec);
2277 }
2278}
2279
2280static void DoDumpstateBoardAidl(
2281 const std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> dumpstate_hal,
2282 const std::vector<::ndk::ScopedFileDescriptor>& dumpstate_fds,
2283 const Dumpstate::BugreportMode bugreport_mode, const size_t timeout_sec) {
2284 MYLOGI("Using IDumpstateDevice AIDL HAL");
2285
2286 const char* descriptor_to_kill;
2287 using DumpstateBoardTask = std::packaged_task<bool()>;
2288 DumpstateBoardTask dumpstate_board_task;
2289 dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode dumpstate_hal_mode =
2290 GetDumpstateHalModeAidl(bugreport_mode);
2291
2292 descriptor_to_kill = dumpstate_hal_aidl::IDumpstateDevice::descriptor;
2293 dumpstate_board_task = DumpstateBoardTask([dumpstate_hal, &dumpstate_fds, dumpstate_hal_mode,
2294 timeout_sec]() -> bool {
2295 auto status = dumpstate_hal->dumpstateBoard(dumpstate_fds, dumpstate_hal_mode, timeout_sec);
2296
2297 if (!status.isOk()) {
2298 MYLOGE("dumpstateBoard failed: %s\n", status.getDescription().c_str());
2299 return false;
2300 }
2301 return true;
2302 });
2303 auto result = dumpstate_board_task.get_future();
2304 std::thread(std::move(dumpstate_board_task)).detach();
2305
2306 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2307 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate HAL\n", timeout_sec);
2308 if (!android::base::SetProperty(
2309 "ctl.interface_restart",
2310 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
2311 MYLOGE("Couldn't restart dumpstate HAL\n");
2312 }
2313 }
2314 // Wait some time for init to kill dumpstate vendor HAL
2315 constexpr size_t killing_timeout_sec = 10;
2316 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2317 MYLOGE(
2318 "killing dumpstateBoard timed out after %zus, continue and "
2319 "there might be racing in content\n",
2320 killing_timeout_sec);
2321 }
2322}
2323
2324static std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> GetDumpstateBoardAidlService() {
2325 const std::string aidl_instance_name =
2326 std::string(dumpstate_hal_aidl::IDumpstateDevice::descriptor) + "/default";
2327
2328 if (!AServiceManager_isDeclared(aidl_instance_name.c_str())) {
2329 return nullptr;
2330 }
2331
2332 ndk::SpAIBinder dumpstateBinder(AServiceManager_waitForService(aidl_instance_name.c_str()));
2333
2334 return dumpstate_hal_aidl::IDumpstateDevice::fromBinder(dumpstateBinder);
2335}
2336
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002337void Dumpstate::DumpstateBoard(int out_fd) {
2338 dprintf(out_fd, "========================================================\n");
2339 dprintf(out_fd, "== Board\n");
2340 dprintf(out_fd, "========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08002341
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002342 /*
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002343 * mount debugfs for non-user builds with ro.product.debugfs_restrictions.enabled
Hridya Valsaraju51101602021-04-02 14:32:46 -07002344 * set to true and unmount it after invoking dumpstateBoard_* methods.
2345 * This is to enable debug builds to not have debugfs mounted during runtime.
2346 * It will also ensure that debugfs is only accessed by the dumpstate HAL.
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002347 */
Hridya Valsaraju51101602021-04-02 14:32:46 -07002348 auto mount_debugfs =
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002349 android::base::GetBoolProperty("ro.product.debugfs_restrictions.enabled", false);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002350 if (mount_debugfs) {
2351 RunCommand("mount debugfs", {"mount", "-t", "debugfs", "debugfs", "/sys/kernel/debug"},
2352 AS_ROOT_20);
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002353 RunCommand("chmod debugfs", {"chmod", "0755", "/sys/kernel/debug"}, AS_ROOT_20);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002354 }
2355
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002356 std::vector<std::string> paths;
2357 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07002358 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002359 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
2360 kDumpstateBoardFiles[i].c_str()));
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002361 remover.emplace_back(android::base::make_scope_guard(
2362 std::bind([](std::string path) { android::os::UnlinkAndLogOnError(path); }, paths[i])));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002363 }
Jie Song9fbfad02017-06-20 16:29:42 -07002364
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002365 // get dumpstate HAL AIDL implementation
2366 std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> dumpstate_hal_handle_aidl(
2367 GetDumpstateBoardAidlService());
2368 if (dumpstate_hal_handle_aidl == nullptr) {
2369 MYLOGI("No IDumpstateDevice AIDL implementation\n");
2370 }
2371
2372 // get dumpstate HAL HIDL implementation, only if AIDL HAL implementation not found
2373 sp<dumpstate_hal_hidl_1_0::IDumpstateDevice> dumpstate_hal_handle_hidl_1_0 = nullptr;
2374 if (dumpstate_hal_handle_aidl == nullptr) {
2375 dumpstate_hal_handle_hidl_1_0 = dumpstate_hal_hidl_1_0::IDumpstateDevice::getService();
2376 if (dumpstate_hal_handle_hidl_1_0 == nullptr) {
2377 MYLOGI("No IDumpstateDevice HIDL implementation\n");
2378 }
2379 }
2380
2381 // if neither HIDL nor AIDL implementation found, then return
2382 if (dumpstate_hal_handle_hidl_1_0 == nullptr && dumpstate_hal_handle_aidl == nullptr) {
2383 MYLOGE("Could not find IDumpstateDevice implementation\n");
Wei Wang587eac92018-04-05 12:17:20 -07002384 return;
2385 }
2386
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002387 // this is used to hold the file descriptors and when this variable goes out of scope
2388 // the file descriptors are closed
2389 std::vector<::ndk::ScopedFileDescriptor> dumpstate_fds;
Wei Wang587eac92018-04-05 12:17:20 -07002390
Nandana Dutt5c390032019-03-12 10:52:56 +00002391 // TODO(128270426): Check for consent in between?
Wei Wang587eac92018-04-05 12:17:20 -07002392 for (size_t i = 0; i < paths.size(); i++) {
2393 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
2394
2395 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
2396 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
2397 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
2398 if (fd < 0) {
2399 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
2400 return;
2401 }
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002402
2403 dumpstate_fds.emplace_back(fd.release());
2404 // we call fd.release() here to make sure "fd" does not get closed
2405 // after "fd" goes out of scope after this block.
2406 // "fd" will be closed when "dumpstate_fds" goes out of scope
2407 // i.e. when we exit this function
Wei Wang587eac92018-04-05 12:17:20 -07002408 }
2409
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002410 // Given that bugreport is required to diagnose failures, it's better to set an arbitrary amount
2411 // of timeout for IDumpstateDevice than to block the rest of bugreport. In the timeout case, we
2412 // will kill the HAL and grab whatever it dumped in time.
2413 constexpr size_t timeout_sec = 30;
Wei Wang587eac92018-04-05 12:17:20 -07002414
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002415 if (dumpstate_hal_handle_aidl != nullptr) {
2416 DoDumpstateBoardAidl(dumpstate_hal_handle_aidl, dumpstate_fds, options_->bugreport_mode,
2417 timeout_sec);
2418 } else if (dumpstate_hal_handle_hidl_1_0 != nullptr) {
2419 // run HIDL HAL only if AIDL HAL not found
2420 DoDumpstateBoardHidl(dumpstate_hal_handle_hidl_1_0, dumpstate_fds, options_->bugreport_mode,
2421 timeout_sec);
Wei Wang587eac92018-04-05 12:17:20 -07002422 }
2423
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002424 if (mount_debugfs) {
Hridya Valsaraju51101602021-04-02 14:32:46 -07002425 auto keep_debugfs_mounted =
2426 android::base::GetProperty("persist.dbg.keep_debugfs_mounted", "");
2427 if (keep_debugfs_mounted.empty())
2428 RunCommand("unmount debugfs", {"umount", "/sys/kernel/debug"}, AS_ROOT_20);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002429 }
2430
Wei Wang587eac92018-04-05 12:17:20 -07002431 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
2432 for (size_t i = 0; i < paths.size(); i++) {
2433 struct stat s;
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002434 if (fstat(dumpstate_fds[i].get(), &s) == -1) {
2435 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(), strerror(errno));
Wei Wang587eac92018-04-05 12:17:20 -07002436 file_sizes[i] = -1;
2437 continue;
2438 }
2439 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002440 }
2441
2442 for (size_t i = 0; i < paths.size(); i++) {
2443 if (file_sizes[i] == -1) {
2444 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002445 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002446 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07002447 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002448 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002449 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002450 remover[i].Disable();
2451 EnqueueAddZipEntryAndCleanupIfNeeded(kDumpstateBoardFiles[i], paths[i]);
2452 dprintf(out_fd, "*** See %s entry ***\n", kDumpstateBoardFiles[i].c_str());
Jie Song9fbfad02017-06-20 16:29:42 -07002453 }
Felipe Leme6f674ae2016-11-18 17:10:33 -08002454}
2455
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002456static void ShowUsage() {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002457 fprintf(stderr,
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002458 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-o directory] [-p] "
2459 "[-s] [-S] [-q] [-P] [-R] [-L] [-V version]\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002460 " -h: display this help message\n"
2461 " -b: play sound file instead of vibrate, at beginning of job\n"
2462 " -e: play sound file instead of vibrate, at end of job\n"
mhasank2d75c442020-06-11 15:05:25 -07002463 " -o: write to custom directory (only in limited mode)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01002464 " -p: capture screenshot to filename.png\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002465 " -s: write zipped file to control socket (for init)\n"
2466 " -S: write file location to control socket (for init)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002467 " -q: disable vibrate\n"
Abhijeet Kaure370d682019-10-01 16:49:30 +01002468 " -P: send broadcast when started and do progress updates\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002469 " -R: take bugreport in remote mode (shouldn't be used with -P)\n"
Nandana Dutt235864b2019-01-22 12:10:16 +00002470 " -w: start binder service and make it wait for a call to startBugreport\n"
mhasankd451a472020-05-26 18:02:39 -07002471 " -L: output limited information that is safe for submission in feedback reports\n"
Felipe Lemed071c682016-10-20 16:48:00 -07002472 " -v: prints the dumpstate header and exit\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002473}
2474
Wei Liuf87959e2016-08-26 14:51:42 -07002475static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07002476 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07002477}
2478
Felipe Leme1d486fe2016-10-14 18:06:47 -07002479bool Dumpstate::FinishZipFile() {
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002480 // Runs all enqueued adding zip entry and cleanup tasks before finishing the zip file.
2481 if (zip_entry_tasks_) {
2482 zip_entry_tasks_->run(/* do_cancel = */false);
2483 }
2484
Felipe Leme9a523ae2016-10-20 15:10:33 -07002485 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07002486 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07002487 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002488 // Final timestamp
2489 char date[80];
2490 time_t the_real_now_please_stand_up = time(nullptr);
2491 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002492 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07002493 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002494
Felipe Leme9a523ae2016-10-20 15:10:33 -07002495 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002496 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08002497 return false;
2498 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07002499 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002500 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08002501 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08002502 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08002503
Felipe Leme0f3fb202016-06-10 17:10:53 -07002504 // Add log file (which contains stderr output) to zip...
2505 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07002506 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07002507 MYLOGE("Failed to add dumpstate log to .zip file\n");
2508 return false;
2509 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002510 // TODO: Should truncate the existing file.
2511 // ... and re-open it for further logging.
Nandana Dutta344cb62019-02-22 15:12:35 +00002512 if (!redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()))) {
2513 return false;
2514 }
Felipe Leme0f3fb202016-06-10 17:10:53 -07002515 fprintf(stderr, "\n");
2516
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002517 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07002518 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002519 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002520 return false;
2521 }
2522
Felipe Leme1d486fe2016-10-14 18:06:47 -07002523 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
2524 ds.zip_file.reset(nullptr);
2525
Felipe Lemee9d2c542016-11-15 11:48:26 -08002526 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002527 android::os::UnlinkAndLogOnError(tmp_path_);
Felipe Lemec4eee562016-04-21 15:42:55 -07002528
Felipe Leme1e9edc62015-12-21 16:02:13 -08002529 return true;
2530}
Felipe Leme6e01fa62015-11-11 19:35:14 -08002531
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002532static void SendBroadcast(const std::string& action, const std::vector<std::string>& args) {
2533 // clang-format off
2534 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user", "0",
2535 "--receiver-foreground", "--receiver-include-background", "-a", action};
2536 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08002537
2538 am.insert(am.end(), args.begin(), args.end());
2539
Felipe Leme8d2410e2017-02-08 09:46:08 -08002540 RunCommand("", am,
2541 CommandOptions::WithTimeout(20)
2542 .Log("Sending broadcast: '%s'\n")
2543 .Always()
2544 .DropRoot()
2545 .RedirectStderr()
2546 .Build());
2547}
2548
Felipe Leme35b8cf12017-02-10 15:47:29 -08002549static void Vibrate(int duration_ms) {
2550 // clang-format off
Lais Andrade51156962021-02-22 19:21:35 +00002551 std::vector<std::string> args = {"cmd", "vibrator_manager", "synced", "-f", "-d", "dumpstate",
2552 "oneshot", std::to_string(duration_ms)};
2553 RunCommand("", args,
Felipe Leme35b8cf12017-02-10 15:47:29 -08002554 CommandOptions::WithTimeout(10)
2555 .Log("Vibrate: '%s'\n")
2556 .Always()
2557 .Build());
2558 // clang-format on
2559}
2560
Nandana Dutt979388e2018-11-30 16:48:55 +00002561static void MaybeResolveSymlink(std::string* path) {
2562 std::string resolved_path;
2563 if (android::base::Readlink(*path, &resolved_path)) {
2564 *path = resolved_path;
2565 }
2566}
2567
Nandana Dutt4be45d12018-09-26 15:04:23 +01002568/*
2569 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002570 * and adds the version file. Return false if zip_file could not be open to write.
Nandana Dutt4be45d12018-09-26 15:04:23 +01002571 */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002572static bool PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002573 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
2574
Nandana Dutt4be45d12018-09-26 15:04:23 +01002575 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
2576 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002577 ds.base_name_ = StringPrintf("bugreport-%s-%s", device_name.c_str(), build_id.c_str());
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002578 char date[80];
2579 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
2580 ds.name_ = date;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002581
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002582 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002583 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002584 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002585 ds.base_name_ += "-wifi";
2586 }
2587
Paul Chang0d2aad72020-02-13 20:04:03 +08002588 if (ds.options_->do_screenshot) {
Nandana Dutt9d17b942020-03-26 10:02:59 +00002589 ds.screenshot_path_ = ds.GetPath(ds.CalledByApi() ? "-png.tmp" : ".png");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002590 }
2591 ds.tmp_path_ = ds.GetPath(".tmp");
2592 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
2593
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002594 std::string destination = ds.CalledByApi()
Nandana Dutt54dbd672019-01-11 12:58:05 +00002595 ? StringPrintf("[fd:%d]", ds.options_->bugreport_fd.get())
Nandana Dutt9a76d202019-01-21 15:56:48 +00002596 : ds.bugreport_internal_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01002597 MYLOGD(
Nandana Dutt235c6672019-11-14 15:22:32 +00002598 "Bugreport dir: [%s] "
2599 "Base name: [%s] "
2600 "Suffix: [%s] "
2601 "Log path: [%s] "
2602 "Temporary path: [%s] "
2603 "Screenshot path: [%s]\n",
Nandana Dutt9a76d202019-01-21 15:56:48 +00002604 destination.c_str(), ds.base_name_.c_str(), ds.name_.c_str(), ds.log_path_.c_str(),
2605 ds.tmp_path_.c_str(), ds.screenshot_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002606
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002607 ds.path_ = ds.GetPath(ds.CalledByApi() ? "-zip.tmp" : ".zip");
2608 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
2609 create_parent_dirs(ds.path_.c_str());
2610 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
2611 if (ds.zip_file == nullptr) {
2612 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
2613 return false;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002614 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002615 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
2616 ds.AddTextZipEntry("version.txt", ds.version_);
2617 return true;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002618}
2619
2620/*
Abhijeet Kaure370d682019-10-01 16:49:30 +01002621 * Finalizes writing to the file by zipping the tmp file to the final location,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002622 * printing zipped file status, etc.
2623 */
2624static void FinalizeFile() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002625 bool do_text_file = !ds.FinishZipFile();
2626 if (do_text_file) {
2627 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002628 }
mhasank2d75c442020-06-11 15:05:25 -07002629
2630 std::string final_path = ds.path_;
2631 if (ds.options_->OutputToCustomFile()) {
mhasank3a4cfb42020-06-15 18:06:43 -07002632 final_path = ds.GetPath(ds.options_->out_dir, ".zip");
mhasank2d75c442020-06-11 15:05:25 -07002633 android::os::CopyFileToFile(ds.path_, final_path);
2634 }
2635
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002636 if (ds.options_->stream_to_socket) {
2637 android::os::CopyFileToFd(ds.path_, ds.control_socket_fd_);
2638 } else if (ds.options_->progress_updates_to_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002639 if (do_text_file) {
2640 dprintf(ds.control_socket_fd_,
2641 "FAIL:could not create zip file, check %s "
2642 "for more details\n",
2643 ds.log_path_.c_str());
2644 } else {
mhasank2d75c442020-06-11 15:05:25 -07002645 dprintf(ds.control_socket_fd_, "OK:%s\n", final_path.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002646 }
2647 }
2648}
2649
Nandana Dutt4be45d12018-09-26 15:04:23 +01002650
Nandana Dutt58d72e22018-11-16 10:30:48 +00002651static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2652 switch (mode) {
2653 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2654 return "BUGREPORT_FULL";
2655 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2656 return "BUGREPORT_INTERACTIVE";
2657 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2658 return "BUGREPORT_REMOTE";
2659 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2660 return "BUGREPORT_WEAR";
2661 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2662 return "BUGREPORT_TELEPHONY";
2663 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2664 return "BUGREPORT_WIFI";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002665 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2666 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002667 }
2668}
2669
Paul Changf59c2b72020-03-10 02:08:55 +08002670static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options,
2671 bool is_screenshot_requested) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002672 // Modify com.android.shell.BugreportProgressService#isDefaultScreenshotRequired as well for
2673 // default system screenshots.
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002674 options->bugreport_mode = mode;
2675 options->bugreport_mode_string = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002676 switch (mode) {
2677 case Dumpstate::BugreportMode::BUGREPORT_FULL:
Paul Changf59c2b72020-03-10 02:08:55 +08002678 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002679 break;
2680 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002681 // Currently, the dumpstate binder is only used by Shell to update progress.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002682 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002683 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002684 break;
2685 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002686 options->do_vibrate = false;
2687 options->is_remote_mode = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002688 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002689 break;
2690 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
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;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002694 // TODO(b/148168577) rename TELEPHONY everywhere to CONNECTIVITY.
Nandana Dutt58d72e22018-11-16 10:30:48 +00002695 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002696 options->telephony_only = true;
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002697 options->do_progress_updates = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002698 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002699 break;
2700 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002701 options->wifi_only = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002702 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002703 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002704 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2705 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002706 }
2707}
2708
Nandana Dutt58d72e22018-11-16 10:30:48 +00002709static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
Nandana Dutt235c6672019-11-14 15:22:32 +00002710 MYLOGI(
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002711 "do_vibrate: %d stream_to_socket: %d progress_updates_to_socket: %d do_screenshot: %d "
Rhed Jao25f50e02020-08-20 00:10:32 +08002712 "is_remote_mode: %d show_header_only: %d telephony_only: %d "
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002713 "wifi_only: %d do_progress_updates: %d fd: %d bugreport_mode: %s "
mhasankd451a472020-05-26 18:02:39 -07002714 "limited_only: %d args: %s\n",
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002715 options.do_vibrate, options.stream_to_socket, options.progress_updates_to_socket,
Paul Chang0d2aad72020-02-13 20:04:03 +08002716 options.do_screenshot, options.is_remote_mode, options.show_header_only,
Rhed Jao25f50e02020-08-20 00:10:32 +08002717 options.telephony_only, options.wifi_only,
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002718 options.do_progress_updates, options.bugreport_fd.get(),
2719 options.bugreport_mode_string.c_str(),
2720 options.limited_only, options.args.c_str());
Nandana Dutt58d72e22018-11-16 10:30:48 +00002721}
2722
Nandana Dutt54dbd672019-01-11 12:58:05 +00002723void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode,
2724 const android::base::unique_fd& bugreport_fd_in,
Paul Changf59c2b72020-03-10 02:08:55 +08002725 const android::base::unique_fd& screenshot_fd_in,
2726 bool is_screenshot_requested) {
Nandana Dutt54dbd672019-01-11 12:58:05 +00002727 // Duplicate the fds because the passed in fds don't outlive the binder transaction.
2728 bugreport_fd.reset(dup(bugreport_fd_in.get()));
2729 screenshot_fd.reset(dup(screenshot_fd_in.get()));
Nandana Dutt58d72e22018-11-16 10:30:48 +00002730
Paul Changf59c2b72020-03-10 02:08:55 +08002731 SetOptionsFromMode(bugreport_mode, this, is_screenshot_requested);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002732}
2733
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002734Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
2735 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002736 int c;
mhasankd451a472020-05-26 18:02:39 -07002737 while ((c = getopt(argc, argv, "dho:svqzpLPBRSV:w")) != -1) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002738 switch (c) {
2739 // clang-format off
mhasank3a4cfb42020-06-15 18:06:43 -07002740 case 'o': out_dir = optarg; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002741 case 's': stream_to_socket = true; break;
2742 case 'S': progress_updates_to_socket = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002743 case 'v': show_header_only = true; break;
2744 case 'q': do_vibrate = false; break;
Paul Chang0d2aad72020-02-13 20:04:03 +08002745 case 'p': do_screenshot = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002746 case 'P': do_progress_updates = true; break;
2747 case 'R': is_remote_mode = true; break;
mhasankd451a472020-05-26 18:02:39 -07002748 case 'L': limited_only = true; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002749 case 'V':
2750 case 'd':
2751 case 'z':
2752 // compatibility no-op
2753 break;
Nandana Dutt235864b2019-01-22 12:10:16 +00002754 case 'w':
2755 // This was already processed
2756 break;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002757 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002758 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002759 break;
2760 default:
2761 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002762 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002763 break;
2764 // clang-format on
2765 }
2766 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08002767
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002768 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002769 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002770 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002771 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002772 }
2773 }
2774
2775 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
2776 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002777
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002778 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002779}
2780
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002781bool Dumpstate::DumpOptions::ValidateOptions() const {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002782 if (bugreport_fd.get() != -1 && stream_to_socket) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002783 return false;
2784 }
2785
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002786 if ((progress_updates_to_socket || do_progress_updates) && stream_to_socket) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002787 return false;
2788 }
2789
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002790 if (is_remote_mode && (do_progress_updates || stream_to_socket)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002791 return false;
2792 }
2793 return true;
2794}
2795
Nandana Dutt197661d2018-11-16 16:40:21 +00002796void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
2797 options_ = std::move(options);
2798}
2799
Abhijeet Kaura407fb82020-03-27 12:51:12 +00002800void Dumpstate::Initialize() {
2801 /* gets the sequential id */
2802 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
2803 id_ = ++last_id;
2804 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
2805}
2806
Nandana Duttd2f5f082019-01-18 17:13:52 +00002807Dumpstate::RunStatus Dumpstate::Run(int32_t calling_uid, const std::string& calling_package) {
2808 Dumpstate::RunStatus status = RunInternal(calling_uid, calling_package);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002809 if (listener_ != nullptr) {
2810 switch (status) {
2811 case Dumpstate::RunStatus::OK:
Nandana Duttcc4ead82019-01-23 08:29:23 +00002812 listener_->onFinished();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002813 break;
2814 case Dumpstate::RunStatus::HELP:
2815 break;
2816 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002817 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_INVALID_INPUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002818 break;
2819 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002820 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_RUNTIME_ERROR);
2821 break;
2822 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2823 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_DENIED_CONSENT);
2824 break;
2825 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
2826 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_CONSENT_TIMED_OUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002827 break;
2828 }
2829 }
2830 return status;
2831}
2832
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002833void Dumpstate::Cancel() {
2834 CleanupTmpFiles();
2835 android::os::UnlinkAndLogOnError(log_path_);
2836 for (int i = 0; i < NUM_OF_DUMPS; i++) {
2837 android::os::UnlinkAndLogOnError(ds.bugreport_internal_dir_ + "/" +
2838 kDumpstateBoardFiles[i]);
2839 }
2840 tombstone_data_.clear();
2841 anr_data_.clear();
Rhed Jao0daac912020-08-21 14:48:20 +08002842
2843 // Instead of shutdown the pool, we delete temporary files directly since
2844 // shutdown blocking the call.
2845 if (dump_pool_) {
2846 dump_pool_->deleteTempFiles();
2847 }
2848 if (zip_entry_tasks_) {
2849 zip_entry_tasks_->run(/*do_cancel =*/ true);
2850 }
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002851}
2852
Nandana Dutt979388e2018-11-30 16:48:55 +00002853/*
2854 * Dumps relevant information to a bugreport based on the given options.
2855 *
2856 * The bugreport can be dumped to a file or streamed to a socket.
2857 *
2858 * How dumping to file works:
2859 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
2860 * stderr is redirected a log file.
2861 *
2862 * The temporary bugreport is then populated via printfs, dumping contents of files and
2863 * output of commands to stdout.
2864 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002865 * A bunch of other files and dumps are added to the zip archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00002866 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002867 * The temporary bugreport file and the log file also get added to the archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00002868 *
mhasank2d75c442020-06-11 15:05:25 -07002869 * Bugreports are first generated in a local directory and later copied to the caller's fd
2870 * or directory if supplied.
Nandana Dutt979388e2018-11-30 16:48:55 +00002871 */
Nandana Duttd2f5f082019-01-18 17:13:52 +00002872Dumpstate::RunStatus Dumpstate::RunInternal(int32_t calling_uid,
2873 const std::string& calling_package) {
Rhed Jao5377d792020-07-16 17:37:39 +08002874 DurationReporter duration_reporter("RUN INTERNAL", /* logcat_only = */true);
Nandana Dutt979388e2018-11-30 16:48:55 +00002875 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00002876 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002877 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002878 return RunStatus::INVALID_INPUT;
2879 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002880 /* set as high priority, and protect from OOM killer */
2881 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002882
Felipe Lemed071c682016-10-20 16:48:00 -07002883 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002884 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002885 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002886 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002887 } else {
2888 /* fallback to kernels <= 2.6.35 */
2889 oom_adj = fopen("/proc/self/oom_adj", "we");
2890 if (oom_adj) {
2891 fputs("-17", oom_adj);
2892 fclose(oom_adj);
2893 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002894 }
2895
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002896 if (version_ == VERSION_DEFAULT) {
2897 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00002898 }
2899
Chris Morin5a50d482022-02-01 17:41:18 -08002900 if (version_ != VERSION_CURRENT) {
2901 MYLOGE("invalid version requested ('%s'); supported values are: ('%s', '%s')\n",
2902 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002903 return RunStatus::INVALID_INPUT;
Felipe Lemed071c682016-10-20 16:48:00 -07002904 }
2905
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002906 if (options_->show_header_only) {
2907 PrintHeader();
2908 return RunStatus::OK;
Felipe Lemed071c682016-10-20 16:48:00 -07002909 }
2910
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002911 MYLOGD("dumpstate calling_uid = %d ; calling package = %s \n",
2912 calling_uid, calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00002913
Felipe Leme7447d7c2016-11-03 18:12:22 -07002914 // TODO: temporarily set progress until it's part of the Dumpstate constructor
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002915 std::string stats_path =
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002916 android::base::StringPrintf("%s/dumpstate-stats.txt", bugreport_internal_dir_.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002917 progress_.reset(new Progress(stats_path));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002918
Sahana Raof35ed432019-07-12 10:47:52 +01002919 if (acquire_wake_lock(PARTIAL_WAKE_LOCK, WAKE_LOCK_NAME) < 0) {
2920 MYLOGE("Failed to acquire wake lock: %s\n", strerror(errno));
2921 } else {
2922 // Wake lock will be released automatically on process death
2923 MYLOGD("Wake lock acquired.\n");
2924 }
2925
Felipe Leme6ae5c4f2017-01-10 14:13:22 -08002926 register_sig_handler();
Felipe Lemed071c682016-10-20 16:48:00 -07002927
Felipe Lemef0292972016-11-22 13:57:05 -08002928 if (PropertiesHelper::IsDryRun()) {
Felipe Lemed071c682016-10-20 16:48:00 -07002929 MYLOGI("Running on dry-run mode (to disable it, call 'setprop dumpstate.dry_run false')\n");
2930 }
2931
Nandana Dutt235c6672019-11-14 15:22:32 +00002932 MYLOGI("dumpstate info: id=%d, args='%s', bugreport_mode= %s bugreport format version: %s\n",
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002933 id_, options_->args.c_str(), options_->bugreport_mode_string.c_str(), version_.c_str());
Felipe Leme809d74e2016-02-02 12:57:00 -08002934
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002935 do_early_screenshot_ = options_->do_progress_updates;
Felipe Lemee338bf62015-12-07 14:03:50 -08002936
Christopher Ferrised9354f2014-10-01 17:35:01 -07002937 // If we are going to use a socket, do it as early as possible
2938 // to avoid timeouts from bugreport.
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002939 if (options_->stream_to_socket || options_->progress_updates_to_socket) {
Felipe Leme2628e9e2016-04-12 16:36:51 -07002940 MYLOGD("Opening control socket\n");
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002941 control_socket_fd_ = open_socket_fn_("dumpstate");
Nandana Dutta344cb62019-02-22 15:12:35 +00002942 if (control_socket_fd_ == -1) {
2943 return ERROR;
2944 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002945 if (options_->progress_updates_to_socket) {
2946 options_->do_progress_updates = 1;
2947 }
Felipe Leme2628e9e2016-04-12 16:36:51 -07002948 }
2949
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002950 if (!PrepareToWriteToFile()) {
2951 return ERROR;
2952 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08002953
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002954 // Interactive, wear & telephony modes are default to true.
2955 // and may enable from cli option or when using control socket
2956 if (options_->do_progress_updates) {
2957 // clang-format off
2958 std::vector<std::string> am_args = {
2959 "--receiver-permission", "android.permission.DUMP",
2960 };
2961 // clang-format on
2962 // Send STARTED broadcast for apps that listen to bugreport generation events
2963 SendBroadcast("com.android.internal.intent.action.BUGREPORT_STARTED", am_args);
2964 if (options_->progress_updates_to_socket) {
2965 dprintf(control_socket_fd_, "BEGIN:%s\n", path_.c_str());
Felipe Leme71bbfc52015-11-23 14:14:51 -08002966 }
2967 }
2968
Nick Kralevichf3599b32016-01-25 15:05:16 -08002969 /* read /proc/cmdline before dropping root */
2970 FILE *cmdline = fopen("/proc/cmdline", "re");
2971 if (cmdline) {
2972 fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
2973 fclose(cmdline);
2974 }
2975
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002976 if (options_->do_vibrate) {
Felipe Leme35b8cf12017-02-10 15:47:29 -08002977 Vibrate(150);
John Michelau1f794c42012-09-17 11:20:19 -05002978 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002979
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002980 if (zip_file != nullptr) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002981 if (chown(path_.c_str(), AID_SHELL, AID_SHELL)) {
2982 MYLOGE("Unable to change ownership of zip file %s: %s\n", path_.c_str(),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002983 strerror(errno));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002984 }
2985 }
2986
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002987 int dup_stdout_fd;
2988 int dup_stderr_fd;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002989 // Redirect stderr to log_path_ for debugging.
2990 TEMP_FAILURE_RETRY(dup_stderr_fd = dup(fileno(stderr)));
2991 if (!redirect_to_file(stderr, const_cast<char*>(log_path_.c_str()))) {
2992 return ERROR;
2993 }
2994 if (chown(log_path_.c_str(), AID_SHELL, AID_SHELL)) {
2995 MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n", log_path_.c_str(),
2996 strerror(errno));
2997 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002998
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002999 // Redirect stdout to tmp_path_. This is the main bugreport entry and will be
3000 // moved into zip file later, if zipping.
3001 TEMP_FAILURE_RETRY(dup_stdout_fd = dup(fileno(stdout)));
3002 // TODO: why not write to a file instead of stdout to overcome this problem?
3003 /* TODO: rather than generating a text file now and zipping it later,
3004 it would be more efficient to redirect stdout to the zip entry
3005 directly, but the libziparchive doesn't support that option yet. */
3006 if (!redirect_to_file(stdout, const_cast<char*>(tmp_path_.c_str()))) {
3007 return ERROR;
3008 }
3009 if (chown(tmp_path_.c_str(), AID_SHELL, AID_SHELL)) {
3010 MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
3011 tmp_path_.c_str(), strerror(errno));
Colin Crossf45fa6b2012-03-26 12:38:26 -07003012 }
Felipe Lemed8b94e52016-12-08 10:21:44 -08003013
3014 // Don't buffer stdout
3015 setvbuf(stdout, nullptr, _IONBF, 0);
3016
Rhed Jao5377d792020-07-16 17:37:39 +08003017 // Enable the parallel run if the client requests to output to a file.
3018 EnableParallelRunIfNeeded();
3019 // Using scope guard to make sure the dump pool can be shut down correctly.
3020 auto scope_guard_to_shutdown_pool = android::base::make_scope_guard([=]() {
3021 ShutdownDumpPool();
3022 });
3023
Felipe Leme608385d2016-02-01 10:35:38 -08003024 // NOTE: there should be no stdout output until now, otherwise it would break the header.
3025 // In particular, DurationReport objects should be created passing 'title, NULL', so their
Felipe Lemecbce55d2016-02-08 09:53:18 -08003026 // duration is logged into MYLOG instead.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003027 PrintHeader();
Colin Crossf45fa6b2012-03-26 12:38:26 -07003028
Gavin Corkery6968f552020-11-22 18:09:05 +00003029 bool is_dumpstate_restricted = options_->telephony_only
3030 || options_->wifi_only
3031 || options_->limited_only;
3032 if (!is_dumpstate_restricted) {
Paul Chang0d2aad72020-02-13 20:04:03 +08003033 // Invoke critical dumpsys first to preserve system state, before doing anything else.
Jichao Lie89d9c12019-11-21 19:02:51 -08003034 RunDumpsysCritical();
Gavin Corkery6968f552020-11-22 18:09:05 +00003035 }
3036 MaybeTakeEarlyScreenshot();
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003037
3038 if (!is_dumpstate_restricted) {
3039 // Snapshot the system trace now (if running) to avoid that dumpstate's
3040 // own activity pushes out interesting data from the trace ring buffer.
3041 // The trace file is added to the zip by MaybeAddSystemTraceToZip().
3042 MaybeSnapshotSystemTrace();
Yohei Yukawa95305b32021-03-09 07:54:27 -08003043
3044 // If a winscope trace is running, snapshot it now. It will be pulled into bugreport later
3045 // from WMTRACE_DATA_DIR.
3046 MaybeSnapshotWinTrace();
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003047 }
Gavin Corkery6968f552020-11-22 18:09:05 +00003048 onUiIntensiveBugreportDumpsFinished(calling_uid);
3049 MaybeCheckUserConsent(calling_uid, calling_package);
3050 if (options_->telephony_only) {
3051 DumpstateTelephonyOnly(calling_package);
3052 } else if (options_->wifi_only) {
3053 DumpstateWifiOnly();
3054 } else if (options_->limited_only) {
3055 DumpstateLimitedOnly();
3056 } else {
Nandana Dutt4be45d12018-09-26 15:04:23 +01003057 // Dump state for the default case. This also drops root.
Jichao Lie89d9c12019-11-21 19:02:51 -08003058 RunStatus s = DumpstateDefaultAfterCritical();
Nandana Dutt5c390032019-03-12 10:52:56 +00003059 if (s != RunStatus::OK) {
Nandana Duttaac6f582019-07-26 14:32:47 +01003060 if (s == RunStatus::USER_CONSENT_DENIED) {
Nandana Dutt5c390032019-03-12 10:52:56 +00003061 HandleUserConsentDenied();
3062 }
3063 return s;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08003064 }
Zhengyin Qian068ecc72016-08-10 16:48:14 -07003065 }
Felipe Leme71a74ac2016-03-17 15:43:25 -07003066
Felipe Leme55b42a62015-11-10 17:39:08 -08003067 /* close output if needed */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003068 TEMP_FAILURE_RETRY(dup2(dup_stdout_fd, fileno(stdout)));
Colin Crossf45fa6b2012-03-26 12:38:26 -07003069
Abhijeet Kaure370d682019-10-01 16:49:30 +01003070 // Zip the (now complete) .tmp file within the internal directory.
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003071 FinalizeFile();
Colin Crossf45fa6b2012-03-26 12:38:26 -07003072
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003073 // Share the final file with the caller if the user has consented or Shell is the caller.
Nandana Duttd2f5f082019-01-18 17:13:52 +00003074 Dumpstate::RunStatus status = Dumpstate::RunStatus::OK;
Abhijeet Kaure370d682019-10-01 16:49:30 +01003075 if (CalledByApi()) {
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003076 status = CopyBugreportIfUserConsented(calling_uid);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003077 if (status != Dumpstate::RunStatus::OK &&
3078 status != Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
3079 // Do an early return if there were errors. We make an exception for consent
3080 // timing out because it's possible the user got distracted. In this case the
3081 // bugreport is not shared but made available for manual retrieval.
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003082 MYLOGI("User denied consent. Returning\n");
Nandana Duttd2f5f082019-01-18 17:13:52 +00003083 return status;
3084 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003085 if (status == Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
3086 MYLOGI(
3087 "Did not receive user consent yet."
3088 " Will not copy the bugreport artifacts to caller.\n");
Abhijeet Kaur57627412019-04-17 16:00:09 +01003089 const String16 incidentcompanion("incidentcompanion");
3090 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
3091 if (ics != nullptr) {
3092 MYLOGD("Canceling user consent request via incidentcompanion service\n");
3093 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
3094 consent_callback_.get());
3095 } else {
3096 MYLOGD("Unable to cancel user consent; incidentcompanion service unavailable\n");
3097 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003098 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003099 }
3100
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08003101 /* vibrate a few but shortly times to let user know it's finished */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003102 if (options_->do_vibrate) {
Takuya Ogawa47f644e2017-12-20 18:09:09 +09003103 for (int i = 0; i < 3; i++) {
3104 Vibrate(75);
3105 usleep((75 + 50) * 1000);
3106 }
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08003107 }
3108
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003109 MYLOGD("Final progress: %d/%d (estimated %d)\n", progress_->Get(), progress_->GetMax(),
3110 progress_->GetInitialMax());
3111 progress_->Save();
3112 MYLOGI("done (id %d)\n", id_);
Colin Crossf45fa6b2012-03-26 12:38:26 -07003113
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003114 TEMP_FAILURE_RETRY(dup2(dup_stderr_fd, fileno(stderr)));
Felipe Leme107a05f2016-03-08 15:11:15 -08003115
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003116 if (control_socket_fd_ != -1) {
Felipe Lemee844a9d2016-09-21 15:01:39 -07003117 MYLOGD("Closing control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003118 close(control_socket_fd_);
Felipe Leme2628e9e2016-04-12 16:36:51 -07003119 }
3120
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003121 tombstone_data_.clear();
3122 anr_data_.clear();
Narayan Kamath6b9516c2017-10-27 11:15:51 +01003123
Nandana Duttd2f5f082019-01-18 17:13:52 +00003124 return (consent_callback_ != nullptr &&
3125 consent_callback_->getResult() == UserConsentResult::UNAVAILABLE)
3126 ? USER_CONSENT_TIMED_OUT
3127 : RunStatus::OK;
3128}
3129
Paul Chang0d2aad72020-02-13 20:04:03 +08003130void Dumpstate::MaybeTakeEarlyScreenshot() {
3131 if (!options_->do_screenshot || !do_early_screenshot_) {
3132 return;
3133 }
3134
3135 TakeScreenshot();
3136}
3137
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003138void Dumpstate::MaybeSnapshotSystemTrace() {
3139 // If a background system trace is happening and is marked as "suitable for
3140 // bugreport" (i.e. bugreport_score > 0 in the trace config), this command
3141 // will stop it and serialize into SYSTEM_TRACE_SNAPSHOT. In the (likely)
3142 // case that no trace is ongoing, this command is a no-op.
3143 // Note: this should not be enqueued as we need to freeze the trace before
3144 // dumpstate starts. Otherwise the trace ring buffers will contain mostly
3145 // the dumpstate's own activity which is irrelevant.
3146 int res = RunCommand(
3147 "SERIALIZE PERFETTO TRACE",
3148 {"perfetto", "--save-for-bugreport"},
3149 CommandOptions::WithTimeout(10)
3150 .DropRoot()
3151 .CloseAllFileDescriptorsOnExec()
3152 .Build());
3153 has_system_trace_ = res == 0;
3154 // MaybeAddSystemTraceToZip() will take care of copying the trace in the zip
3155 // file in the later stages.
3156}
3157
Yohei Yukawa95305b32021-03-09 07:54:27 -08003158void Dumpstate::MaybeSnapshotWinTrace() {
Yohei Yukawa02b1d2c2021-03-16 09:20:30 -07003159 // Currently WindowManagerService and InputMethodManagerSerivice support WinScope protocol.
3160 for (const auto& service : {"window", "input_method"}) {
3161 RunCommand(
3162 // Empty name because it's not intended to be classified as a bugreport section.
3163 // Actual tracing files can be found in "/data/misc/wmtrace/" in the bugreport.
3164 "", {"cmd", service, "tracing", "save-for-bugreport"},
3165 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3166 }
Yohei Yukawa95305b32021-03-09 07:54:27 -08003167}
3168
Paul Changeb4b4642020-05-28 22:05:47 +08003169void Dumpstate::onUiIntensiveBugreportDumpsFinished(int32_t calling_uid) {
Paul Changc490e662020-04-11 18:14:09 +08003170 if (calling_uid == AID_SHELL || !CalledByApi()) {
3171 return;
3172 }
3173 if (listener_ != nullptr) {
3174 // Let listener know ui intensive bugreport dumps are finished, then it can do event
3175 // handling if required.
Paul Changeb4b4642020-05-28 22:05:47 +08003176 listener_->onUiIntensiveBugreportDumpsFinished();
Paul Changc490e662020-04-11 18:14:09 +08003177 }
3178}
3179
Jichao Lie89d9c12019-11-21 19:02:51 -08003180void Dumpstate::MaybeCheckUserConsent(int32_t calling_uid, const std::string& calling_package) {
3181 if (calling_uid == AID_SHELL || !CalledByApi()) {
3182 // No need to get consent for shell triggered dumpstates, or not through
3183 // bugreporting API (i.e. no fd to copy back).
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003184 return;
3185 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003186 consent_callback_ = new ConsentCallback();
3187 const String16 incidentcompanion("incidentcompanion");
3188 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
Jichao Lie89d9c12019-11-21 19:02:51 -08003189 android::String16 package(calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003190 if (ics != nullptr) {
3191 MYLOGD("Checking user consent via incidentcompanion service\n");
3192 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
Jichao Lie89d9c12019-11-21 19:02:51 -08003193 calling_uid, package, String16(), String16(),
Joe Onorato1c36d752019-03-17 18:26:43 -07003194 0x1 /* FLAG_CONFIRMATION_DIALOG */, consent_callback_.get());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003195 } else {
3196 MYLOGD("Unable to check user consent; incidentcompanion service unavailable\n");
3197 }
3198}
3199
Nandana Dutt5c390032019-03-12 10:52:56 +00003200bool Dumpstate::IsUserConsentDenied() const {
3201 return ds.consent_callback_ != nullptr &&
3202 ds.consent_callback_->getResult() == UserConsentResult::DENIED;
3203}
3204
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01003205bool Dumpstate::CalledByApi() const {
3206 return ds.options_->bugreport_fd.get() != -1 ? true : false;
3207}
3208
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003209void Dumpstate::CleanupTmpFiles() {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003210 android::os::UnlinkAndLogOnError(tmp_path_);
3211 android::os::UnlinkAndLogOnError(screenshot_path_);
3212 android::os::UnlinkAndLogOnError(path_);
Gavin Corkery789d7a52021-02-24 23:52:35 +00003213 if (dump_traces_path != nullptr) {
3214 android::os::UnlinkAndLogOnError(dump_traces_path);
3215 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003216}
3217
Rhed Jao5377d792020-07-16 17:37:39 +08003218void Dumpstate::EnableParallelRunIfNeeded() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003219 if (!PropertiesHelper::IsParallelRun()) {
Rhed Jao5377d792020-07-16 17:37:39 +08003220 return;
3221 }
3222 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003223 zip_entry_tasks_ = std::make_unique<TaskQueue>();
Rhed Jao5377d792020-07-16 17:37:39 +08003224}
3225
3226void Dumpstate::ShutdownDumpPool() {
3227 if (dump_pool_) {
3228 dump_pool_->shutdown();
3229 dump_pool_ = nullptr;
3230 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003231 if (zip_entry_tasks_) {
3232 zip_entry_tasks_->run(/* do_cancel = */true);
3233 zip_entry_tasks_ = nullptr;
3234 }
3235}
3236
3237void Dumpstate::EnqueueAddZipEntryAndCleanupIfNeeded(const std::string& entry_name,
3238 const std::string& entry_path) {
3239 auto func_add_zip_entry_and_cleanup = [=](bool task_cancelled) {
3240 if (!task_cancelled) {
3241 AddZipEntry(entry_name, entry_path);
3242 }
3243 android::os::UnlinkAndLogOnError(entry_path);
3244 };
3245 if (zip_entry_tasks_) {
3246 // Enqueues AddZipEntryAndCleanup function if the parallel run is enabled.
3247 zip_entry_tasks_->add(func_add_zip_entry_and_cleanup, _1);
3248 } else {
3249 // Invokes AddZipEntryAndCleanup immediately
3250 std::invoke(func_add_zip_entry_and_cleanup, /* task_cancelled = */false);
3251 }
Rhed Jao5377d792020-07-16 17:37:39 +08003252}
3253
Nandana Duttd2f5f082019-01-18 17:13:52 +00003254Dumpstate::RunStatus Dumpstate::HandleUserConsentDenied() {
3255 MYLOGD("User denied consent; deleting files and returning\n");
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003256 CleanupTmpFiles();
Nandana Duttd2f5f082019-01-18 17:13:52 +00003257 return USER_CONSENT_DENIED;
3258}
3259
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003260Dumpstate::RunStatus Dumpstate::CopyBugreportIfUserConsented(int32_t calling_uid) {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003261 // If the caller has asked to copy the bugreport over to their directory, we need explicit
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003262 // user consent (unless the caller is Shell).
3263 UserConsentResult consent_result;
3264 if (calling_uid == AID_SHELL) {
3265 consent_result = UserConsentResult::APPROVED;
3266 } else {
3267 consent_result = consent_callback_->getResult();
3268 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003269 if (consent_result == UserConsentResult::UNAVAILABLE) {
3270 // User has not responded yet.
3271 uint64_t elapsed_ms = consent_callback_->getElapsedTimeMs();
Hunter Knepshield70610fa2020-01-03 15:27:33 -08003272 // Telephony is a fast report type, particularly on user builds where information may be
3273 // more aggressively limited. To give the user time to read the consent dialog, increase the
3274 // timeout.
3275 uint64_t timeout_ms = options_->telephony_only ? TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS
3276 : USER_CONSENT_TIMEOUT_MS;
3277 if (elapsed_ms < timeout_ms) {
3278 uint delay_seconds = (timeout_ms - elapsed_ms) / 1000;
Nandana Duttd2f5f082019-01-18 17:13:52 +00003279 MYLOGD("Did not receive user consent yet; going to wait for %d seconds", delay_seconds);
3280 sleep(delay_seconds);
3281 }
3282 consent_result = consent_callback_->getResult();
3283 }
3284 if (consent_result == UserConsentResult::DENIED) {
3285 // User has explicitly denied sharing with the app. To be safe delete the
3286 // internal bugreport & tmp files.
3287 return HandleUserConsentDenied();
3288 }
3289 if (consent_result == UserConsentResult::APPROVED) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00003290 bool copy_succeeded = android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
3291 if (copy_succeeded) {
3292 android::os::UnlinkAndLogOnError(path_);
Abhijeet Kaur9ce94672020-04-01 17:22:36 +01003293 if (options_->do_screenshot &&
3294 options_->screenshot_fd.get() != -1 &&
3295 !options_->is_screenshot_copied) {
3296 copy_succeeded = android::os::CopyFileToFd(screenshot_path_,
3297 options_->screenshot_fd.get());
3298 options_->is_screenshot_copied = copy_succeeded;
3299 if (copy_succeeded) {
3300 android::os::UnlinkAndLogOnError(screenshot_path_);
3301 }
3302 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003303 }
3304 return copy_succeeded ? Dumpstate::RunStatus::OK : Dumpstate::RunStatus::ERROR;
3305 } else if (consent_result == UserConsentResult::UNAVAILABLE) {
3306 // consent_result is still UNAVAILABLE. The user has likely not responded yet.
3307 // Since we do not have user consent to share the bugreport it does not get
3308 // copied over to the calling app but remains in the internal directory from
3309 // where the user can manually pull it.
Paul Changce644212021-05-11 16:06:45 +08003310 std::string final_path = GetPath(".zip");
3311 bool copy_succeeded = android::os::CopyFileToFile(path_, final_path);
3312 if (copy_succeeded) {
3313 android::os::UnlinkAndLogOnError(path_);
3314 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003315 return Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT;
3316 }
3317 // Unknown result; must be a programming error.
3318 MYLOGE("Unknown user consent result:%d\n", consent_result);
3319 return Dumpstate::RunStatus::ERROR;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003320}
3321
Nandana Duttf02564e2019-02-15 15:24:24 +00003322Dumpstate::RunStatus Dumpstate::ParseCommandlineAndRun(int argc, char* argv[]) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003323 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
3324 Dumpstate::RunStatus status = options->Initialize(argc, argv);
3325 if (status == Dumpstate::RunStatus::OK) {
Nandana Duttf02564e2019-02-15 15:24:24 +00003326 SetOptions(std::move(options));
Nandana Duttd2f5f082019-01-18 17:13:52 +00003327 // When directly running dumpstate binary, the output is not expected to be written
3328 // to any external file descriptor.
Nandana Duttf02564e2019-02-15 15:24:24 +00003329 assert(options_->bugreport_fd.get() == -1);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003330
3331 // calling_uid and calling_package are for user consent to share the bugreport with
Abhijeet Kaura407fb82020-03-27 12:51:12 +00003332 // an app; they are irrelevant here because bugreport is triggered via command line.
3333 // Update Last ID before calling Run().
3334 Initialize();
Nandana Duttf02564e2019-02-15 15:24:24 +00003335 status = Run(-1 /* calling_uid */, "" /* calling_package */);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003336 }
Nandana Duttf02564e2019-02-15 15:24:24 +00003337 return status;
3338}
3339
3340/* Main entry point for dumpstate binary. */
3341int run_main(int argc, char* argv[]) {
3342 Dumpstate::RunStatus status = ds.ParseCommandlineAndRun(argc, argv);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003343
3344 switch (status) {
3345 case Dumpstate::RunStatus::OK:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003346 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003347 case Dumpstate::RunStatus::HELP:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003348 ShowUsage();
3349 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003350 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003351 fprintf(stderr, "Invalid combination of args\n");
3352 ShowUsage();
3353 exit(1);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003354 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00003355 FALLTHROUGH_INTENDED;
3356 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
3357 FALLTHROUGH_INTENDED;
3358 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003359 exit(2);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003360 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003361}
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003362
3363// TODO(111441001): Default DumpOptions to sensible values.
3364Dumpstate::Dumpstate(const std::string& version)
3365 : pid_(getpid()),
3366 options_(new Dumpstate::DumpOptions()),
Nandana Dutt402a8392019-06-14 14:25:13 +01003367 last_reported_percent_progress_(0),
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003368 version_(version),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003369 now_(time(nullptr)),
3370 open_socket_fn_(open_socket) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003371}
3372
3373Dumpstate& Dumpstate::GetInstance() {
3374 static Dumpstate singleton_(android::base::GetProperty("dumpstate.version", VERSION_CURRENT));
3375 return singleton_;
3376}
3377
Rhed Jao5377d792020-07-16 17:37:39 +08003378DurationReporter::DurationReporter(const std::string& title, bool logcat_only, bool verbose,
3379 int duration_fd) : title_(title), logcat_only_(logcat_only), verbose_(verbose),
3380 duration_fd_(duration_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003381 if (!title_.empty()) {
3382 started_ = Nanotime();
3383 }
3384}
3385
3386DurationReporter::~DurationReporter() {
3387 if (!title_.empty()) {
3388 float elapsed = (float)(Nanotime() - started_) / NANOS_PER_SEC;
chenqiwuaf8b2d92019-12-12 18:53:51 +08003389 if (elapsed >= .5f || verbose_) {
3390 MYLOGD("Duration of '%s': %.2fs\n", title_.c_str(), elapsed);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003391 }
chenqiwuaf8b2d92019-12-12 18:53:51 +08003392 if (!logcat_only_) {
3393 // Use "Yoda grammar" to make it easier to grep|sort sections.
Rhed Jao5377d792020-07-16 17:37:39 +08003394 dprintf(duration_fd_, "------ %.3fs was the duration of '%s' ------\n",
3395 elapsed, title_.c_str());
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003396 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003397 }
3398}
3399
3400const int32_t Progress::kDefaultMax = 5000;
3401
3402Progress::Progress(const std::string& path) : Progress(Progress::kDefaultMax, 1.1, path) {
3403}
3404
3405Progress::Progress(int32_t initial_max, int32_t progress, float growth_factor)
3406 : Progress(initial_max, growth_factor, "") {
3407 progress_ = progress;
3408}
3409
3410Progress::Progress(int32_t initial_max, float growth_factor, const std::string& path)
3411 : initial_max_(initial_max),
3412 progress_(0),
3413 max_(initial_max),
3414 growth_factor_(growth_factor),
3415 n_runs_(0),
3416 average_max_(0),
3417 path_(path) {
3418 if (!path_.empty()) {
3419 Load();
3420 }
3421}
3422
3423void Progress::Load() {
3424 MYLOGD("Loading stats from %s\n", path_.c_str());
3425 std::string content;
3426 if (!android::base::ReadFileToString(path_, &content)) {
3427 MYLOGI("Could not read stats from %s; using max of %d\n", path_.c_str(), max_);
3428 return;
3429 }
3430 if (content.empty()) {
3431 MYLOGE("No stats (empty file) on %s; using max of %d\n", path_.c_str(), max_);
3432 return;
3433 }
3434 std::vector<std::string> lines = android::base::Split(content, "\n");
3435
3436 if (lines.size() < 1) {
3437 MYLOGE("Invalid stats on file %s: not enough lines (%d). Using max of %d\n", path_.c_str(),
3438 (int)lines.size(), max_);
3439 return;
3440 }
3441 char* ptr;
3442 n_runs_ = strtol(lines[0].c_str(), &ptr, 10);
3443 average_max_ = strtol(ptr, nullptr, 10);
3444 if (n_runs_ <= 0 || average_max_ <= 0 || n_runs_ > STATS_MAX_N_RUNS ||
3445 average_max_ > STATS_MAX_AVERAGE) {
3446 MYLOGE("Invalid stats line on file %s: %s\n", path_.c_str(), lines[0].c_str());
3447 initial_max_ = Progress::kDefaultMax;
3448 } else {
3449 initial_max_ = average_max_;
3450 }
3451 max_ = initial_max_;
3452
3453 MYLOGI("Average max progress: %d in %d runs; estimated max: %d\n", average_max_, n_runs_, max_);
3454}
3455
3456void Progress::Save() {
3457 int32_t total = n_runs_ * average_max_ + progress_;
3458 int32_t runs = n_runs_ + 1;
3459 int32_t average = floor(((float)total) / runs);
3460 MYLOGI("Saving stats (total=%d, runs=%d, average=%d) on %s\n", total, runs, average,
3461 path_.c_str());
3462 if (path_.empty()) {
3463 return;
3464 }
3465
3466 std::string content = android::base::StringPrintf("%d %d\n", runs, average);
3467 if (!android::base::WriteStringToFile(content, path_)) {
3468 MYLOGE("Could not save stats on %s\n", path_.c_str());
3469 }
3470}
3471
3472int32_t Progress::Get() const {
3473 return progress_;
3474}
3475
3476bool Progress::Inc(int32_t delta_sec) {
3477 bool changed = false;
3478 if (delta_sec >= 0) {
3479 progress_ += delta_sec;
3480 if (progress_ > max_) {
3481 int32_t old_max = max_;
3482 max_ = floor((float)progress_ * growth_factor_);
3483 MYLOGD("Adjusting max progress from %d to %d\n", old_max, max_);
3484 changed = true;
3485 }
3486 }
3487 return changed;
3488}
3489
3490int32_t Progress::GetMax() const {
3491 return max_;
3492}
3493
3494int32_t Progress::GetInitialMax() const {
3495 return initial_max_;
3496}
3497
3498void Progress::Dump(int fd, const std::string& prefix) const {
3499 const char* pr = prefix.c_str();
3500 dprintf(fd, "%sprogress: %d\n", pr, progress_);
3501 dprintf(fd, "%smax: %d\n", pr, max_);
3502 dprintf(fd, "%sinitial_max: %d\n", pr, initial_max_);
3503 dprintf(fd, "%sgrowth_factor: %0.2f\n", pr, growth_factor_);
3504 dprintf(fd, "%spath: %s\n", pr, path_.c_str());
3505 dprintf(fd, "%sn_runs: %d\n", pr, n_runs_);
3506 dprintf(fd, "%saverage_max: %d\n", pr, average_max_);
3507}
3508
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003509std::string Dumpstate::GetPath(const std::string& suffix) const {
3510 return GetPath(bugreport_internal_dir_, suffix);
3511}
3512
3513std::string Dumpstate::GetPath(const std::string& directory, const std::string& suffix) const {
3514 return android::base::StringPrintf("%s/%s-%s%s", directory.c_str(), base_name_.c_str(),
3515 name_.c_str(), suffix.c_str());
3516}
3517
3518void Dumpstate::SetProgress(std::unique_ptr<Progress> progress) {
3519 progress_ = std::move(progress);
3520}
3521
3522void for_each_userid(void (*func)(int), const char *header) {
3523 std::string title = header == nullptr ? "for_each_userid" : android::base::StringPrintf(
3524 "for_each_userid(%s)", header);
3525 DurationReporter duration_reporter(title);
3526 if (PropertiesHelper::IsDryRun()) return;
3527
3528 DIR *d;
3529 struct dirent *de;
3530
3531 if (header) printf("\n------ %s ------\n", header);
3532 func(0);
3533
3534 if (!(d = opendir("/data/system/users"))) {
3535 printf("Failed to open /data/system/users (%s)\n", strerror(errno));
3536 return;
3537 }
3538
3539 while ((de = readdir(d))) {
3540 int userid;
3541 if (de->d_type != DT_DIR || !(userid = atoi(de->d_name))) {
3542 continue;
3543 }
3544 func(userid);
3545 }
3546
3547 closedir(d);
3548}
3549
3550static void __for_each_pid(void (*helper)(int, const char *, void *), const char *header, void *arg) {
3551 DIR *d;
3552 struct dirent *de;
3553
3554 if (!(d = opendir("/proc"))) {
3555 printf("Failed to open /proc (%s)\n", strerror(errno));
3556 return;
3557 }
3558
3559 if (header) printf("\n------ %s ------\n", header);
3560 while ((de = readdir(d))) {
3561 if (ds.IsUserConsentDenied()) {
3562 MYLOGE(
3563 "Returning early because user denied consent to share bugreport with calling app.");
3564 closedir(d);
3565 return;
3566 }
3567 int pid;
3568 int fd;
3569 char cmdpath[255];
3570 char cmdline[255];
3571
3572 if (!(pid = atoi(de->d_name))) {
3573 continue;
3574 }
3575
3576 memset(cmdline, 0, sizeof(cmdline));
3577
3578 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/cmdline", pid);
3579 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3580 TEMP_FAILURE_RETRY(read(fd, cmdline, sizeof(cmdline) - 2));
3581 close(fd);
3582 if (cmdline[0]) {
3583 helper(pid, cmdline, arg);
3584 continue;
3585 }
3586 }
3587
3588 // if no cmdline, a kernel thread has comm
3589 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/comm", pid);
3590 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3591 TEMP_FAILURE_RETRY(read(fd, cmdline + 1, sizeof(cmdline) - 4));
3592 close(fd);
3593 if (cmdline[1]) {
3594 cmdline[0] = '[';
3595 size_t len = strcspn(cmdline, "\f\b\r\n");
3596 cmdline[len] = ']';
3597 cmdline[len+1] = '\0';
3598 }
3599 }
3600 if (!cmdline[0]) {
3601 strcpy(cmdline, "N/A");
3602 }
3603 helper(pid, cmdline, arg);
3604 }
3605
3606 closedir(d);
3607}
3608
3609static void for_each_pid_helper(int pid, const char *cmdline, void *arg) {
3610 for_each_pid_func *func = (for_each_pid_func*) arg;
3611 func(pid, cmdline);
3612}
3613
3614void for_each_pid(for_each_pid_func func, const char *header) {
3615 std::string title = header == nullptr ? "for_each_pid"
3616 : android::base::StringPrintf("for_each_pid(%s)", header);
3617 DurationReporter duration_reporter(title);
3618 if (PropertiesHelper::IsDryRun()) return;
3619
3620 __for_each_pid(for_each_pid_helper, header, (void *) func);
3621}
3622
3623static void for_each_tid_helper(int pid, const char *cmdline, void *arg) {
3624 DIR *d;
3625 struct dirent *de;
3626 char taskpath[255];
3627 for_each_tid_func *func = (for_each_tid_func *) arg;
3628
3629 snprintf(taskpath, sizeof(taskpath), "/proc/%d/task", pid);
3630
3631 if (!(d = opendir(taskpath))) {
3632 printf("Failed to open %s (%s)\n", taskpath, strerror(errno));
3633 return;
3634 }
3635
3636 func(pid, pid, cmdline);
3637
3638 while ((de = readdir(d))) {
3639 if (ds.IsUserConsentDenied()) {
3640 MYLOGE(
3641 "Returning early because user denied consent to share bugreport with calling app.");
3642 closedir(d);
3643 return;
3644 }
3645 int tid;
3646 int fd;
3647 char commpath[255];
3648 char comm[255];
3649
3650 if (!(tid = atoi(de->d_name))) {
3651 continue;
3652 }
3653
3654 if (tid == pid)
3655 continue;
3656
3657 snprintf(commpath, sizeof(commpath), "/proc/%d/comm", tid);
3658 memset(comm, 0, sizeof(comm));
3659 if ((fd = TEMP_FAILURE_RETRY(open(commpath, O_RDONLY | O_CLOEXEC))) < 0) {
3660 strcpy(comm, "N/A");
3661 } else {
3662 char *c;
3663 TEMP_FAILURE_RETRY(read(fd, comm, sizeof(comm) - 2));
3664 close(fd);
3665
3666 c = strrchr(comm, '\n');
3667 if (c) {
3668 *c = '\0';
3669 }
3670 }
3671 func(pid, tid, comm);
3672 }
3673
3674 closedir(d);
3675}
3676
3677void for_each_tid(for_each_tid_func func, const char *header) {
3678 std::string title = header == nullptr ? "for_each_tid"
3679 : android::base::StringPrintf("for_each_tid(%s)", header);
3680 DurationReporter duration_reporter(title);
3681
3682 if (PropertiesHelper::IsDryRun()) return;
3683
3684 __for_each_pid(for_each_tid_helper, header, (void *) func);
3685}
3686
3687void show_wchan(int pid, int tid, const char *name) {
3688 if (PropertiesHelper::IsDryRun()) return;
3689
3690 char path[255];
3691 char buffer[255];
3692 int fd, ret, save_errno;
3693 char name_buffer[255];
3694
3695 memset(buffer, 0, sizeof(buffer));
3696
3697 snprintf(path, sizeof(path), "/proc/%d/wchan", tid);
3698 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3699 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3700 return;
3701 }
3702
3703 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3704 save_errno = errno;
3705 close(fd);
3706
3707 if (ret < 0) {
3708 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3709 return;
3710 }
3711
3712 snprintf(name_buffer, sizeof(name_buffer), "%*s%s",
3713 pid == tid ? 0 : 3, "", name);
3714
3715 printf("%-7d %-32s %s\n", tid, name_buffer, buffer);
3716
3717 return;
3718}
3719
3720// print time in centiseconds
3721static void snprcent(char *buffer, size_t len, size_t spc,
3722 unsigned long long time) {
3723 static long hz; // cache discovered hz
3724
3725 if (hz <= 0) {
3726 hz = sysconf(_SC_CLK_TCK);
3727 if (hz <= 0) {
3728 hz = 1000;
3729 }
3730 }
3731
3732 // convert to centiseconds
3733 time = (time * 100 + (hz / 2)) / hz;
3734
3735 char str[16];
3736
3737 snprintf(str, sizeof(str), " %llu.%02u",
3738 time / 100, (unsigned)(time % 100));
3739 size_t offset = strlen(buffer);
3740 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3741 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3742}
3743
3744// print permille as a percent
3745static void snprdec(char *buffer, size_t len, size_t spc, unsigned permille) {
3746 char str[16];
3747
3748 snprintf(str, sizeof(str), " %u.%u%%", permille / 10, permille % 10);
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
3754void show_showtime(int pid, const char *name) {
3755 if (PropertiesHelper::IsDryRun()) return;
3756
3757 char path[255];
3758 char buffer[1023];
3759 int fd, ret, save_errno;
3760
3761 memset(buffer, 0, sizeof(buffer));
3762
3763 snprintf(path, sizeof(path), "/proc/%d/stat", pid);
3764 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3765 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3766 return;
3767 }
3768
3769 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3770 save_errno = errno;
3771 close(fd);
3772
3773 if (ret < 0) {
3774 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3775 return;
3776 }
3777
3778 // field 14 is utime
3779 // field 15 is stime
3780 // field 42 is iotime
3781 unsigned long long utime = 0, stime = 0, iotime = 0;
3782 if (sscanf(buffer,
3783 "%*u %*s %*s %*d %*d %*d %*d %*d %*d %*d %*d "
3784 "%*d %*d %llu %llu %*d %*d %*d %*d %*d %*d "
3785 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %*d "
3786 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %llu ",
3787 &utime, &stime, &iotime) != 3) {
3788 return;
3789 }
3790
3791 unsigned long long total = utime + stime;
3792 if (!total) {
3793 return;
3794 }
3795
3796 unsigned permille = (iotime * 1000 + (total / 2)) / total;
3797 if (permille > 1000) {
3798 permille = 1000;
3799 }
3800
3801 // try to beautify and stabilize columns at <80 characters
3802 snprintf(buffer, sizeof(buffer), "%-6d%s", pid, name);
3803 if ((name[0] != '[') || utime) {
3804 snprcent(buffer, sizeof(buffer), 57, utime);
3805 }
3806 snprcent(buffer, sizeof(buffer), 65, stime);
3807 if ((name[0] != '[') || iotime) {
3808 snprcent(buffer, sizeof(buffer), 73, iotime);
3809 }
3810 if (iotime) {
3811 snprdec(buffer, sizeof(buffer), 79, permille);
3812 }
3813 puts(buffer); // adds a trailing newline
3814
3815 return;
3816}
3817
3818void do_dmesg() {
3819 const char *title = "KERNEL LOG (dmesg)";
3820 DurationReporter duration_reporter(title);
3821 printf("------ %s ------\n", title);
3822
3823 if (PropertiesHelper::IsDryRun()) return;
3824
3825 /* Get size of kernel buffer */
3826 int size = klogctl(KLOG_SIZE_BUFFER, nullptr, 0);
3827 if (size <= 0) {
3828 printf("Unexpected klogctl return value: %d\n\n", size);
3829 return;
3830 }
3831 char *buf = (char *) malloc(size + 1);
3832 if (buf == nullptr) {
3833 printf("memory allocation failed\n\n");
3834 return;
3835 }
3836 int retval = klogctl(KLOG_READ_ALL, buf, size);
3837 if (retval < 0) {
3838 printf("klogctl failure\n\n");
3839 free(buf);
3840 return;
3841 }
3842 buf[retval] = '\0';
3843 printf("%s\n\n", buf);
3844 free(buf);
3845 return;
3846}
3847
3848void do_showmap(int pid, const char *name) {
3849 char title[255];
3850 char arg[255];
3851
3852 snprintf(title, sizeof(title), "SHOW MAP %d (%s)", pid, name);
3853 snprintf(arg, sizeof(arg), "%d", pid);
3854 RunCommand(title, {"showmap", "-q", arg}, CommandOptions::AS_ROOT);
3855}
3856
3857int Dumpstate::DumpFile(const std::string& title, const std::string& path) {
3858 DurationReporter duration_reporter(title);
3859
3860 int status = DumpFileToFd(STDOUT_FILENO, title, path);
3861
3862 UpdateProgress(WEIGHT_FILE);
3863
3864 return status;
3865}
3866
3867int read_file_as_long(const char *path, long int *output) {
3868 int fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC));
3869 if (fd < 0) {
3870 int err = errno;
3871 MYLOGE("Error opening file descriptor for %s: %s\n", path, strerror(err));
3872 return -1;
3873 }
3874 char buffer[50];
3875 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3876 if (bytes_read == -1) {
3877 MYLOGE("Error reading file %s: %s\n", path, strerror(errno));
3878 return -2;
3879 }
3880 if (bytes_read == 0) {
3881 MYLOGE("File %s is empty\n", path);
3882 return -3;
3883 }
3884 *output = atoi(buffer);
3885 return 0;
3886}
3887
3888/* calls skip to gate calling dump_from_fd recursively
3889 * in the specified directory. dump_from_fd defaults to
3890 * dump_file_from_fd above when set to NULL. skip defaults
3891 * to false when set to NULL. dump_from_fd will always be
3892 * called with title NULL.
3893 */
3894int dump_files(const std::string& title, const char* dir, bool (*skip)(const char* path),
3895 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
3896 DurationReporter duration_reporter(title);
3897 DIR *dirp;
3898 struct dirent *d;
3899 char *newpath = nullptr;
3900 const char *slash = "/";
3901 int retval = 0;
3902
3903 if (!title.empty()) {
3904 printf("------ %s (%s) ------\n", title.c_str(), dir);
3905 }
3906 if (PropertiesHelper::IsDryRun()) return 0;
3907
3908 if (dir[strlen(dir) - 1] == '/') {
3909 ++slash;
3910 }
3911 dirp = opendir(dir);
3912 if (dirp == nullptr) {
3913 retval = -errno;
3914 MYLOGE("%s: %s\n", dir, strerror(errno));
3915 return retval;
3916 }
3917
3918 if (!dump_from_fd) {
3919 dump_from_fd = dump_file_from_fd;
3920 }
3921 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
3922 if ((d->d_name[0] == '.')
3923 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
3924 || (d->d_name[1] == '\0'))) {
3925 continue;
3926 }
3927 asprintf(&newpath, "%s%s%s%s", dir, slash, d->d_name,
3928 (d->d_type == DT_DIR) ? "/" : "");
3929 if (!newpath) {
3930 retval = -errno;
3931 continue;
3932 }
3933 if (skip && (*skip)(newpath)) {
3934 continue;
3935 }
3936 if (d->d_type == DT_DIR) {
3937 int ret = dump_files("", newpath, skip, dump_from_fd);
3938 if (ret < 0) {
3939 retval = ret;
3940 }
3941 continue;
3942 }
3943 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(newpath, O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
3944 if (fd.get() < 0) {
3945 retval = -1;
3946 printf("*** %s: %s\n", newpath, strerror(errno));
3947 continue;
3948 }
3949 (*dump_from_fd)(nullptr, newpath, fd.get());
3950 }
3951 closedir(dirp);
3952 if (!title.empty()) {
3953 printf("\n");
3954 }
3955 return retval;
3956}
3957
3958/* fd must have been opened with the flag O_NONBLOCK. With this flag set,
3959 * it's possible to avoid issues where opening the file itself can get
3960 * stuck.
3961 */
3962int dump_file_from_fd(const char *title, const char *path, int fd) {
3963 if (PropertiesHelper::IsDryRun()) return 0;
3964
3965 int flags = fcntl(fd, F_GETFL);
3966 if (flags == -1) {
3967 printf("*** %s: failed to get flags on fd %d: %s\n", path, fd, strerror(errno));
3968 return -1;
3969 } else if (!(flags & O_NONBLOCK)) {
3970 printf("*** %s: fd must have O_NONBLOCK set.\n", path);
3971 return -1;
3972 }
3973 return DumpFileFromFdToFd(title, path, fd, STDOUT_FILENO, PropertiesHelper::IsDryRun());
3974}
3975
3976int Dumpstate::RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003977 const CommandOptions& options, bool verbose_duration, int out_fd) {
3978 DurationReporter duration_reporter(title, false /* logcat_only */,
3979 verbose_duration, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003980
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003981 int status = RunCommandToFd(out_fd, title, full_command, options);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003982
3983 /* TODO: for now we're simplifying the progress calculation by using the
3984 * timeout as the weight. It's a good approximation for most cases, except when calling dumpsys,
3985 * where its weight should be much higher proportionally to its timeout.
3986 * Ideally, it should use a options.EstimatedDuration() instead...*/
3987 UpdateProgress(options.Timeout());
3988
3989 return status;
3990}
3991
3992void Dumpstate::RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsys_args,
Rhed Jaoe017f982020-07-21 17:58:41 +08003993 const CommandOptions& options, long dumpsysTimeoutMs, int out_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003994 long timeout_ms = dumpsysTimeoutMs > 0 ? dumpsysTimeoutMs : options.TimeoutInMs();
3995 std::vector<std::string> dumpsys = {"/system/bin/dumpsys", "-T", std::to_string(timeout_ms)};
3996 dumpsys.insert(dumpsys.end(), dumpsys_args.begin(), dumpsys_args.end());
Rhed Jaoe017f982020-07-21 17:58:41 +08003997 RunCommand(title, dumpsys, options, false, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003998}
3999
Dieter Hsu105ad0c2020-09-29 15:23:33 +08004000static int open_socket(const char* service) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004001 int s = android_get_control_socket(service);
4002 if (s < 0) {
4003 MYLOGE("android_get_control_socket(%s): %s\n", service, strerror(errno));
4004 return -1;
4005 }
4006 fcntl(s, F_SETFD, FD_CLOEXEC);
4007
4008 // Set backlog to 0 to make sure that queue size will be minimum.
4009 // In Linux, because the minimum queue will be 1, connect() will be blocked
4010 // if the other clients already called connect() and the connection request was not accepted.
4011 if (listen(s, 0) < 0) {
4012 MYLOGE("listen(control socket): %s\n", strerror(errno));
4013 return -1;
4014 }
4015
4016 struct sockaddr addr;
4017 socklen_t alen = sizeof(addr);
Abhijeet Kaur2113cae2019-09-13 09:24:15 +01004018 int fd = accept4(s, &addr, &alen, SOCK_CLOEXEC);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004019
4020 // Close socket just after accept(), to make sure that connect() by client will get error
4021 // when the socket is used by the other services.
4022 // There is still a race condition possibility between accept and close, but there is no way
4023 // to close-on-accept atomically.
4024 // See detail; b/123306389#comment25
4025 close(s);
4026
4027 if (fd < 0) {
4028 MYLOGE("accept(control socket): %s\n", strerror(errno));
4029 return -1;
4030 }
4031
4032 return fd;
4033}
4034
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004035// TODO: should call is_valid_output_file and/or be merged into it.
4036void create_parent_dirs(const char *path) {
4037 char *chp = const_cast<char *> (path);
4038
4039 /* skip initial slash */
4040 if (chp[0] == '/')
4041 chp++;
4042
4043 /* create leading directories, if necessary */
4044 struct stat dir_stat;
4045 while (chp && chp[0]) {
4046 chp = strchr(chp, '/');
4047 if (chp) {
4048 *chp = 0;
4049 if (stat(path, &dir_stat) == -1 || !S_ISDIR(dir_stat.st_mode)) {
4050 MYLOGI("Creating directory %s\n", path);
4051 if (mkdir(path, 0770)) { /* drwxrwx--- */
4052 MYLOGE("Unable to create directory %s: %s\n", path, strerror(errno));
4053 } else if (chown(path, AID_SHELL, AID_SHELL)) {
4054 MYLOGE("Unable to change ownership of dir %s: %s\n", path, strerror(errno));
4055 }
4056 }
4057 *chp++ = '/';
4058 }
4059 }
4060}
4061
4062bool _redirect_to_file(FILE* redirect, char* path, int truncate_flag) {
4063 create_parent_dirs(path);
4064
4065 int fd = TEMP_FAILURE_RETRY(open(path,
4066 O_WRONLY | O_CREAT | truncate_flag | O_CLOEXEC | O_NOFOLLOW,
4067 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH));
4068 if (fd < 0) {
4069 MYLOGE("%s: %s\n", path, strerror(errno));
4070 return false;
4071 }
4072
4073 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
4074 close(fd);
4075 return true;
4076}
4077
4078bool redirect_to_file(FILE* redirect, char* path) {
4079 return _redirect_to_file(redirect, path, O_TRUNC);
4080}
4081
4082bool redirect_to_existing_file(FILE* redirect, char* path) {
4083 return _redirect_to_file(redirect, path, O_APPEND);
4084}
4085
4086void dump_route_tables() {
4087 DurationReporter duration_reporter("DUMP ROUTE TABLES");
4088 if (PropertiesHelper::IsDryRun()) return;
4089 const char* const RT_TABLES_PATH = "/data/misc/net/rt_tables";
4090 ds.DumpFile("RT_TABLES", RT_TABLES_PATH);
4091 FILE* fp = fopen(RT_TABLES_PATH, "re");
4092 if (!fp) {
4093 printf("*** %s: %s\n", RT_TABLES_PATH, strerror(errno));
4094 return;
4095 }
4096 char table[16];
4097 // Each line has an integer (the table number), a space, and a string (the table name). We only
4098 // need the table number. It's a 32-bit unsigned number, so max 10 chars. Skip the table name.
4099 // Add a fixed max limit so this doesn't go awry.
4100 for (int i = 0; i < 64 && fscanf(fp, " %10s %*s", table) == 1; ++i) {
4101 RunCommand("ROUTE TABLE IPv4", {"ip", "-4", "route", "show", "table", table});
4102 RunCommand("ROUTE TABLE IPv6", {"ip", "-6", "route", "show", "table", table});
4103 }
4104 fclose(fp);
4105}
4106
Li Li830179f2022-01-04 12:53:29 -08004107void dump_frozen_cgroupfs(const char *dir, int level,
4108 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
4109 DIR *dirp;
4110 struct dirent *d;
4111 char *newpath = nullptr;
4112
4113 dirp = opendir(dir);
4114 if (dirp == nullptr) {
4115 MYLOGE("%s: %s\n", dir, strerror(errno));
4116 return;
4117 }
4118
4119 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
4120 if ((d->d_name[0] == '.')
4121 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
4122 || (d->d_name[1] == '\0'))) {
4123 continue;
4124 }
4125 if (d->d_type == DT_DIR) {
4126 asprintf(&newpath, "%s/%s/", dir, d->d_name);
4127 if (!newpath) {
4128 continue;
4129 }
4130 if (level == 0 && !strncmp(d->d_name, "uid_", 4)) {
4131 dump_frozen_cgroupfs(newpath, 1, dump_from_fd);
4132 } else if (level == 1 && !strncmp(d->d_name, "pid_", 4)) {
4133 char *freezer = nullptr;
4134 asprintf(&freezer, "%s/%s", newpath, "cgroup.freeze");
4135 if (freezer) {
4136 FILE* fp = fopen(freezer, "r");
4137 if (fp != NULL) {
4138 int frozen;
4139 fscanf(fp, "%d", &frozen);
4140 if (frozen > 0) {
4141 dump_files("", newpath, skip_none, dump_from_fd);
4142 }
4143 fclose(fp);
4144 }
4145 free(freezer);
4146 }
4147 }
4148 }
4149 }
4150 closedir(dirp);
4151}
4152
4153void dump_frozen_cgroupfs() {
Li Li830179f2022-01-04 12:53:29 -08004154 MYLOGD("Adding frozen processes from %s\n", CGROUPFS_DIR);
4155 DurationReporter duration_reporter("FROZEN CGROUPFS");
4156 if (PropertiesHelper::IsDryRun()) return;
4157 dump_frozen_cgroupfs(CGROUPFS_DIR, 0, _add_file_from_fd);
4158}
4159
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004160void Dumpstate::UpdateProgress(int32_t delta_sec) {
4161 if (progress_ == nullptr) {
4162 MYLOGE("UpdateProgress: progress_ not set\n");
4163 return;
4164 }
Rhed Jaobf63d8a2020-07-21 15:42:55 +08004165 // This function updates progress related members of the dumpstate and reports
4166 // progress percentage to the bugreport client. Since it could be called by
4167 // different dump tasks at the same time if the parallel run is enabled, a
4168 // mutex lock is necessary here to synchronize the call.
4169 std::lock_guard<std::recursive_mutex> lock(mutex_);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004170
4171 // Always update progess so stats can be tuned...
Nandana Dutt402a8392019-06-14 14:25:13 +01004172 progress_->Inc(delta_sec);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004173
4174 // ...but only notifiy listeners when necessary.
4175 if (!options_->do_progress_updates) return;
4176
4177 int progress = progress_->Get();
4178 int max = progress_->GetMax();
Nandana Dutt402a8392019-06-14 14:25:13 +01004179 int percent = 100 * progress / max;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004180
Nandana Dutt402a8392019-06-14 14:25:13 +01004181 if (last_reported_percent_progress_ > 0 && percent <= last_reported_percent_progress_) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004182 return;
4183 }
Nandana Dutt402a8392019-06-14 14:25:13 +01004184 last_reported_percent_progress_ = percent;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004185
4186 if (control_socket_fd_ >= 0) {
4187 dprintf(control_socket_fd_, "PROGRESS:%d/%d\n", progress, max);
4188 fsync(control_socket_fd_);
4189 }
4190
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004191 if (listener_ != nullptr) {
Nandana Dutt235c6672019-11-14 15:22:32 +00004192 if (percent % 10 == 0) {
4193 // We don't want to spam logcat, so only log multiples of 10.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004194 MYLOGD("Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004195 } else {
4196 // stderr is ignored on normal invocations, but useful when calling
4197 // /system/bin/dumpstate directly for debuggging.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004198 fprintf(stderr, "Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004199 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004200
4201 listener_->onProgress(percent);
4202 }
4203}
4204
4205void Dumpstate::TakeScreenshot(const std::string& path) {
4206 const std::string& real_path = path.empty() ? screenshot_path_ : path;
4207 int status =
4208 RunCommand("", {"/system/bin/screencap", "-p", real_path},
4209 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
4210 if (status == 0) {
4211 MYLOGD("Screenshot saved on %s\n", real_path.c_str());
4212 } else {
4213 MYLOGE("Failed to take screenshot on %s\n", real_path.c_str());
4214 }
Paul Chang0d2aad72020-02-13 20:04:03 +08004215 if (listener_ != nullptr) {
4216 // Show a visual indication to indicate screenshot is taken via
4217 // IDumpstateListener.onScreenshotTaken()
4218 listener_->onScreenshotTaken(status == 0);
4219 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004220}
4221
4222bool is_dir(const char* pathname) {
4223 struct stat info;
4224 if (stat(pathname, &info) == -1) {
4225 return false;
4226 }
4227 return S_ISDIR(info.st_mode);
4228}
4229
4230time_t get_mtime(int fd, time_t default_mtime) {
4231 struct stat info;
4232 if (fstat(fd, &info) == -1) {
4233 return default_mtime;
4234 }
4235 return info.st_mtime;
4236}