blob: 75caac14ae9c4e93e45331e0a8fa5e8391905885 [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
Felipe Leme96c2bbb2016-09-26 09:21:21 -070060#include <android-base/file.h>
61#include <android-base/properties.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070062#include <android-base/scopeguard.h>
Elliott Hughes9dc117c2015-12-07 14:21:50 -080063#include <android-base/stringprintf.h>
Naveen Kalla058e1e82016-10-19 21:38:44 -070064#include <android-base/strings.h>
Andreas Gampeaff68432016-07-18 18:01:27 -070065#include <android-base/unique_fd.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010066#include <android/content/pm/IPackageManagerNative.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080067#include <android/hardware/dumpstate/1.0/IDumpstateDevice.h>
Hunter Knepshield8540faf2020-02-04 19:47:20 -080068#include <android/hardware/dumpstate/1.1/IDumpstateDevice.h>
69#include <android/hardware/dumpstate/1.1/types.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080070#include <android/hidl/manager/1.0/IServiceManager.h>
Nandana Duttd2f5f082019-01-18 17:13:52 +000071#include <android/os/IIncidentCompanion.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010072#include <binder/IServiceManager.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080073#include <cutils/native_handle.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070074#include <cutils/properties.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010075#include <cutils/sockets.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000076#include <debuggerd/client.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080077#include <dumpsys.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000078#include <dumputils/dump_utils.h>
Sahana Raof35ed432019-07-12 10:47:52 +010079#include <hardware_legacy/power.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080080#include <hidl/ServiceManagement.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010081#include <log/log.h>
Tom Cherryf4472f32020-08-05 09:31:17 -070082#include <log/log_read.h>
Felipe Leme75876a22016-10-27 16:31:27 -070083#include <openssl/sha.h>
Mark Salyzyn6c3d90f2016-09-27 14:55:27 -070084#include <private/android_filesystem_config.h>
85#include <private/android_logger.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080086#include <serviceutils/PriorityDumper.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070087#include <utils/StrongPointer.h>
Felipe Lemef0292972016-11-22 13:57:05 -080088#include "DumpstateInternal.h"
Felipe Leme75876a22016-10-27 16:31:27 -070089#include "DumpstateService.h"
Colin Crossf45fa6b2012-03-26 12:38:26 -070090#include "dumpstate.h"
Felipe Leme6e01fa62015-11-11 19:35:14 -080091
Hunter Knepshield8540faf2020-02-04 19:47:20 -080092using IDumpstateDevice_1_0 = ::android::hardware::dumpstate::V1_0::IDumpstateDevice;
93using IDumpstateDevice_1_1 = ::android::hardware::dumpstate::V1_1::IDumpstateDevice;
94using ::android::hardware::dumpstate::V1_1::DumpstateMode;
95using ::android::hardware::dumpstate::V1_1::DumpstateStatus;
96using ::android::hardware::dumpstate::V1_1::toString;
Vishnu Naire97d6122018-01-18 13:58:56 -080097using ::std::literals::chrono_literals::operator""ms;
98using ::std::literals::chrono_literals::operator""s;
Rhed Jao1c855122020-07-16 17:37:39 +080099using ::std::placeholders::_1;
Steven Morelandcb7ef822016-11-29 13:20:37 -0800100
Felipe Leme47e9be22016-12-21 15:37:07 -0800101// TODO: remove once moved to namespace
Vishnu Naire97d6122018-01-18 13:58:56 -0800102using android::defaultServiceManager;
103using android::Dumpsys;
104using android::INVALID_OPERATION;
105using android::IServiceManager;
106using android::OK;
107using android::sp;
108using android::status_t;
109using android::String16;
110using android::String8;
111using android::TIMED_OUT;
112using android::UNKNOWN_ERROR;
113using android::Vector;
Nandana Dutt979388e2018-11-30 16:48:55 +0000114using android::base::StringPrintf;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000115using android::os::IDumpstateListener;
Felipe Leme47e9be22016-12-21 15:37:07 -0800116using android::os::dumpstate::CommandOptions;
117using android::os::dumpstate::DumpFileToFd;
Rhed Jao1c855122020-07-16 17:37:39 +0800118using android::os::dumpstate::DumpPool;
Vishnu Naire97d6122018-01-18 13:58:56 -0800119using android::os::dumpstate::PropertiesHelper;
Rhed Jao4875aa62020-07-20 17:46:29 +0800120using android::os::dumpstate::TaskQueue;
Felipe Leme47e9be22016-12-21 15:37:07 -0800121
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100122// Keep in sync with
123// frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
124static const int TRACE_DUMP_TIMEOUT_MS = 10000; // 10 seconds
125
126/* Most simple commands have 10 as timeout, so 5 is a good estimate */
127static const int32_t WEIGHT_FILE = 5;
128
129// TODO: temporary variables and functions used during C++ refactoring
130static Dumpstate& ds = Dumpstate::GetInstance();
131static int RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Nandana Dutt8d945c02019-08-14 13:30:07 +0100132 const CommandOptions& options = CommandOptions::DEFAULT,
Rhed Jao4875aa62020-07-20 17:46:29 +0800133 bool verbose_duration = false, int out_fd = STDOUT_FILENO) {
134 return ds.RunCommand(title, full_command, options, verbose_duration, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100135}
136
137// Reasonable value for max stats.
138static const int STATS_MAX_N_RUNS = 1000;
139static const long STATS_MAX_AVERAGE = 100000;
140
141CommandOptions Dumpstate::DEFAULT_DUMPSYS = CommandOptions::WithTimeout(30).Build();
142
Nandana Duttd2f5f082019-01-18 17:13:52 +0000143typedef Dumpstate::ConsentCallback::ConsentResult UserConsentResult;
144
Colin Crossf45fa6b2012-03-26 12:38:26 -0700145/* read before root is shed */
146static char cmdline_buf[16384] = "(unknown)";
Yi Kong19d5c002018-07-20 13:39:55 -0700147static const char *dump_traces_path = nullptr;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000148static const uint64_t USER_CONSENT_TIMEOUT_MS = 30 * 1000;
Hunter Knepshield70610fa2020-01-03 15:27:33 -0800149// Because telephony reports are significantly faster to collect (< 10 seconds vs. > 2 minutes),
150// it's often the case that they time out far too quickly for consent with such a hefty dialog for
151// the user to read. For telephony reports only, we increase the default timeout to 2 minutes to
152// roughly match full reports' durations.
153static const uint64_t TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS = 2 * 60 * 1000;
Colin Crossf45fa6b2012-03-26 12:38:26 -0700154
Felipe Leme1d486fe2016-10-14 18:06:47 -0700155// TODO: variables and functions below should be part of dumpstate object
156
Felipe Leme635ca312016-01-05 14:23:02 -0800157static std::set<std::string> mount_points;
158void add_mountinfo();
Felipe Leme78f2c862015-12-21 09:55:22 -0800159
Todd Poynor2a83daa2013-11-22 15:44:22 -0800160#define PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops"
Mark Salyzyn7d0a7622016-06-24 14:06:15 -0700161#define ALT_PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops-0"
Wei Wang509bb5d2017-06-09 14:42:12 -0700162#define BLK_DEV_SYS_DIR "/sys/block"
Todd Poynor2a83daa2013-11-22 15:44:22 -0800163
Felipe Lemee82a27d2016-01-05 13:35:44 -0800164#define RECOVERY_DIR "/cache/recovery"
Mark Salyzynd6ab0112016-03-25 12:56:39 -0700165#define RECOVERY_DATA_DIR "/data/misc/recovery"
Tianjie Xu75d53362018-04-11 16:42:28 -0700166#define UPDATE_ENGINE_LOG_DIR "/data/misc/update_engine_log"
Mark Salyzyn4d42dea2016-04-01 10:03:14 -0700167#define LOGPERSIST_DATA_DIR "/data/misc/logd"
Jerry Changa1df8a92020-01-02 16:03:39 +0800168#define PREREBOOT_DATA_DIR "/data/misc/prereboot"
David Brazdild2991962016-06-03 14:40:44 +0100169#define PROFILE_DATA_DIR_CUR "/data/misc/profiles/cur"
170#define PROFILE_DATA_DIR_REF "/data/misc/profiles/ref"
Benedict Wong8f9d8a42019-01-03 16:19:38 -0800171#define XFRM_STAT_PROC_FILE "/proc/net/xfrm_stat"
Erik Kline08165202016-05-30 11:55:44 +0900172#define WLUTIL "/vendor/xbin/wlutil"
Vishnu Nair36b4cdb2017-11-17 10:27:05 -0800173#define WMTRACE_DATA_DIR "/data/misc/wmtrace"
Yifan Hong3945e1b2019-10-29 12:59:23 -0700174#define OTA_METADATA_DIR "/metadata/ota"
Yifan Hong0efa7972020-02-03 16:45:02 -0800175#define SNAPSHOTCTL_LOG_DIR "/data/misc/snapshotctl_log"
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +0900176#define LINKERCONFIG_DIR "/linkerconfig"
Calin Juravle78a0d842020-04-28 15:31:12 -0700177#define PACKAGE_DEX_USE_LIST "/data/system/package-dex-usage.list"
Primiano Tuccifaaaafb2021-01-14 12:26:29 +0000178#define SYSTEM_TRACE_SNAPSHOT "/data/misc/perfetto-traces/bugreport/systrace.pftrace"
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700179
Narayan Kamath8f788292017-05-25 13:20:39 +0100180// TODO(narayan): Since this information has to be kept in sync
181// with tombstoned, we should just put it in a common header.
182//
183// File: system/core/debuggerd/tombstoned/tombstoned.cpp
Narayan Kamathbd863722017-06-01 18:50:12 +0100184static const std::string TOMBSTONE_DIR = "/data/tombstones/";
185static const std::string TOMBSTONE_FILE_PREFIX = "tombstone_";
186static const std::string ANR_DIR = "/data/anr/";
187static const std::string ANR_FILE_PREFIX = "anr_";
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700188
Felipe Lemee844a9d2016-09-21 15:01:39 -0700189// TODO: temporary variables and functions used during C++ refactoring
Nandana Dutt979388e2018-11-30 16:48:55 +0000190
Nandana Dutt5c390032019-03-12 10:52:56 +0000191#define RETURN_IF_USER_DENIED_CONSENT() \
192 if (ds.IsUserConsentDenied()) { \
193 MYLOGE("Returning early as user denied consent to share bugreport with calling app."); \
194 return Dumpstate::RunStatus::USER_CONSENT_DENIED; \
195 }
196
197// Runs func_ptr, but checks user consent before and after running it. Returns USER_CONSENT_DENIED
198// if consent is found to be denied.
199#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(func_ptr, ...) \
200 RETURN_IF_USER_DENIED_CONSENT(); \
201 func_ptr(__VA_ARGS__); \
202 RETURN_IF_USER_DENIED_CONSENT();
203
Rhed Jao1c855122020-07-16 17:37:39 +0800204// Runs func_ptr, and logs a duration report after it's finished.
205#define RUN_SLOW_FUNCTION_AND_LOG(log_title, func_ptr, ...) \
206 { \
207 DurationReporter duration_reporter_in_macro(log_title); \
208 func_ptr(__VA_ARGS__); \
209 }
210
211// Similar with RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK, an additional duration report
212// is output after a slow function is finished.
213#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(log_title, func_ptr, ...) \
214 RETURN_IF_USER_DENIED_CONSENT(); \
215 RUN_SLOW_FUNCTION_AND_LOG(log_title, func_ptr, __VA_ARGS__); \
216 RETURN_IF_USER_DENIED_CONSENT();
217
Rhed Jao4875aa62020-07-20 17:46:29 +0800218#define WAIT_TASK_WITH_CONSENT_CHECK(task_name, pool_ptr) \
219 RETURN_IF_USER_DENIED_CONSENT(); \
220 pool_ptr->waitForTask(task_name); \
221 RETURN_IF_USER_DENIED_CONSENT();
222
Sahana Raof35ed432019-07-12 10:47:52 +0100223static const char* WAKE_LOCK_NAME = "dumpstate_wakelock";
224
Rhed Jao1c855122020-07-16 17:37:39 +0800225// Names of parallel tasks, they are used for the DumpPool to identify the dump
226// task and the log title of the duration report.
227static const std::string DUMP_TRACES_TASK = "DUMP TRACES";
Rhed Jao4875aa62020-07-20 17:46:29 +0800228static const std::string DUMP_INCIDENT_REPORT_TASK = "INCIDENT REPORT";
229static const std::string DUMP_HALS_TASK = "DUMP HALS";
230static const std::string DUMP_BOARD_TASK = "dumpstate_board()";
Rhed Jao6b1ea2d2020-07-21 17:58:41 +0800231static const std::string DUMP_CHECKINS_TASK = "DUMP CHECKINS";
Rhed Jao1c855122020-07-16 17:37:39 +0800232
Nandana Dutt979388e2018-11-30 16:48:55 +0000233namespace android {
234namespace os {
235namespace {
236
237static int Open(std::string path, int flags, mode_t mode = 0) {
238 int fd = TEMP_FAILURE_RETRY(open(path.c_str(), flags, mode));
239 if (fd == -1) {
240 MYLOGE("open(%s, %s)\n", path.c_str(), strerror(errno));
241 }
242 return fd;
243}
244
mhasank2d75c442020-06-11 15:05:25 -0700245static int OpenForWrite(std::string path) {
246 return Open(path, O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
247 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH);
248}
Nandana Dutt979388e2018-11-30 16:48:55 +0000249
250static int OpenForRead(std::string path) {
251 return Open(path, O_RDONLY | O_CLOEXEC | O_NOFOLLOW);
252}
253
254bool CopyFile(int in_fd, int out_fd) {
255 char buf[4096];
256 ssize_t byte_count;
257 while ((byte_count = TEMP_FAILURE_RETRY(read(in_fd, buf, sizeof(buf)))) > 0) {
258 if (!android::base::WriteFully(out_fd, buf, byte_count)) {
259 return false;
260 }
261 }
262 return (byte_count != -1);
263}
264
265static bool CopyFileToFd(const std::string& input_file, int out_fd) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000266 MYLOGD("Going to copy file (%s) to %d\n", input_file.c_str(), out_fd);
Nandana Dutt979388e2018-11-30 16:48:55 +0000267
268 // Obtain a handle to the source file.
269 android::base::unique_fd in_fd(OpenForRead(input_file));
270 if (out_fd != -1 && in_fd.get() != -1) {
271 if (CopyFile(in_fd.get(), out_fd)) {
272 return true;
273 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000274 MYLOGE("Failed to copy file: %s\n", strerror(errno));
Nandana Dutt979388e2018-11-30 16:48:55 +0000275 }
276 return false;
277}
278
Nandana Duttd2f5f082019-01-18 17:13:52 +0000279static bool UnlinkAndLogOnError(const std::string& file) {
Nandana Dutt8ae16e62020-03-27 10:20:22 +0000280 if (file.empty()) {
281 return false;
282 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000283 if (unlink(file.c_str())) {
284 MYLOGE("Failed to unlink file (%s): %s\n", file.c_str(), strerror(errno));
Nandana Duttd2f5f082019-01-18 17:13:52 +0000285 return false;
286 }
287 return true;
288}
Nandana Dutt979388e2018-11-30 16:48:55 +0000289
Nikita Ioffea325a572019-05-16 19:49:47 +0100290int64_t GetModuleMetadataVersion() {
291 auto binder = defaultServiceManager()->getService(android::String16("package_native"));
292 if (binder == nullptr) {
293 MYLOGE("Failed to retrieve package_native service");
294 return 0L;
295 }
296 auto package_service = android::interface_cast<content::pm::IPackageManagerNative>(binder);
297 std::string package_name;
298 auto status = package_service->getModuleMetadataPackageName(&package_name);
299 if (!status.isOk()) {
300 MYLOGE("Failed to retrieve module metadata package name: %s", status.toString8().c_str());
301 return 0L;
302 }
Nandana Duttdb379fa2019-10-09 16:54:41 +0100303 MYLOGD("Module metadata package name: %s\n", package_name.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100304 int64_t version_code;
305 status = package_service->getVersionCodeForPackage(android::String16(package_name.c_str()),
306 &version_code);
307 if (!status.isOk()) {
308 MYLOGE("Failed to retrieve module metadata version: %s", status.toString8().c_str());
309 return 0L;
310 }
311 return version_code;
312}
313
mhasank2d75c442020-06-11 15:05:25 -0700314static bool PathExists(const std::string& path) {
315 struct stat sb;
316 return stat(path.c_str(), &sb) == 0;
317}
318
319static bool CopyFileToFile(const std::string& input_file, const std::string& output_file) {
320 if (input_file == output_file) {
321 MYLOGD("Skipping copying bugreport file since the destination is the same (%s)\n",
322 output_file.c_str());
323 return false;
324 }
325 else if (PathExists(output_file)) {
326 MYLOGD("Cannot overwrite an existing file (%s)\n", output_file.c_str());
327 return false;
328 }
329
330 MYLOGD("Going to copy bugreport file (%s) to %s\n", input_file.c_str(), output_file.c_str());
331 android::base::unique_fd out_fd(OpenForWrite(output_file));
332 return CopyFileToFd(input_file, out_fd.get());
333}
334
Nandana Dutt979388e2018-11-30 16:48:55 +0000335} // namespace
336} // namespace os
337} // namespace android
338
Felipe Leme678727a2016-09-21 17:22:11 -0700339static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
Felipe Lemebda15a02016-11-16 17:48:25 -0800340 const CommandOptions& options = Dumpstate::DEFAULT_DUMPSYS,
Rhed Jao6b1ea2d2020-07-21 17:58:41 +0800341 long dumpsysTimeoutMs = 0, int out_fd = STDOUT_FILENO) {
342 return ds.RunDumpsys(title, dumpsysArgs, options, dumpsysTimeoutMs, out_fd);
343}
344static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
345 int out_fd) {
346 return ds.RunDumpsys(title, dumpsysArgs, Dumpstate::DEFAULT_DUMPSYS, 0, out_fd);
Felipe Leme678727a2016-09-21 17:22:11 -0700347}
348static int DumpFile(const std::string& title, const std::string& path) {
349 return ds.DumpFile(title, path);
350}
Felipe Lemee82a27d2016-01-05 13:35:44 -0800351
Felipe Lemee844a9d2016-09-21 15:01:39 -0700352// Relative directory (inside the zip) for all files copied as-is into the bugreport.
353static const std::string ZIP_ROOT_DIR = "FS";
354
Vishnu Naire97d6122018-01-18 13:58:56 -0800355static const std::string kProtoPath = "proto/";
356static const std::string kProtoExt = ".proto";
Jie Song9fbfad02017-06-20 16:29:42 -0700357static const std::string kDumpstateBoardFiles[] = {
358 "dumpstate_board.txt",
Felipe Leme95d6ca52017-08-01 16:35:56 -0700359 "dumpstate_board.bin"
Jie Song9fbfad02017-06-20 16:29:42 -0700360};
361static const int NUM_OF_DUMPS = arraysize(kDumpstateBoardFiles);
362
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700363static constexpr char PROPERTY_LAST_ID[] = "dumpstate.last_id";
Felipe Lemed071c682016-10-20 16:48:00 -0700364static constexpr char PROPERTY_VERSION[] = "dumpstate.version";
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700365
Felipe Lemef0292972016-11-22 13:57:05 -0800366static const CommandOptions AS_ROOT_20 = CommandOptions::WithTimeout(20).AsRoot().Build();
367
Narayan Kamath8f788292017-05-25 13:20:39 +0100368/*
Narayan Kamathbd863722017-06-01 18:50:12 +0100369 * Returns a vector of dump fds under |dir_path| with a given |file_prefix|.
Rhed Jao01dc0c62020-06-03 17:13:30 +0800370 * The returned vector is sorted by the mtimes of the dumps with descending
371 * order. If |limit_by_mtime| is set, the vector only contains files that
372 * were written in the last 30 minutes.
Narayan Kamath8f788292017-05-25 13:20:39 +0100373 */
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700374static std::vector<DumpData> GetDumpFds(const std::string& dir_path,
375 const std::string& file_prefix,
Elliott Hughesdb6d2112019-09-26 15:24:51 -0700376 bool limit_by_mtime) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100377 const time_t thirty_minutes_ago = ds.now_ - 60 * 30;
378
Narayan Kamathbd863722017-06-01 18:50:12 +0100379 std::unique_ptr<DIR, decltype(&closedir)> dump_dir(opendir(dir_path.c_str()), closedir);
Narayan Kamath8f788292017-05-25 13:20:39 +0100380
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700381 if (dump_dir == nullptr) {
382 MYLOGW("Unable to open directory %s: %s\n", dir_path.c_str(), strerror(errno));
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700383 return std::vector<DumpData>();
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700384 }
385
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700386 std::vector<DumpData> dump_data;
Narayan Kamathbd863722017-06-01 18:50:12 +0100387 struct dirent* entry = nullptr;
388 while ((entry = readdir(dump_dir.get()))) {
389 if (entry->d_type != DT_REG) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100390 continue;
391 }
392
Narayan Kamathbd863722017-06-01 18:50:12 +0100393 const std::string base_name(entry->d_name);
394 if (base_name.find(file_prefix) != 0) {
395 continue;
396 }
397
398 const std::string abs_path = dir_path + base_name;
399 android::base::unique_fd fd(
400 TEMP_FAILURE_RETRY(open(abs_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW | O_NONBLOCK)));
401 if (fd == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700402 MYLOGW("Unable to open dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamathbd863722017-06-01 18:50:12 +0100403 break;
404 }
405
406 struct stat st = {};
407 if (fstat(fd, &st) == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700408 MYLOGW("Unable to stat dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamath8f788292017-05-25 13:20:39 +0100409 continue;
410 }
411
Narayan Kamath3f31b632018-02-22 19:42:36 +0000412 if (limit_by_mtime && st.st_mtime < thirty_minutes_ago) {
Narayan Kamathbd863722017-06-01 18:50:12 +0100413 MYLOGI("Excluding stale dump file: %s\n", abs_path.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100414 continue;
415 }
416
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700417 dump_data.emplace_back(DumpData{abs_path, std::move(fd), st.st_mtime});
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700418 }
Rhed Jao01dc0c62020-06-03 17:13:30 +0800419 if (!dump_data.empty()) {
420 std::sort(dump_data.begin(), dump_data.end(),
421 [](const auto& a, const auto& b) { return a.mtime > b.mtime; });
422 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100423
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700424 return dump_data;
Narayan Kamath8f788292017-05-25 13:20:39 +0100425}
426
Narayan Kamathbd863722017-06-01 18:50:12 +0100427static bool AddDumps(const std::vector<DumpData>::const_iterator start,
428 const std::vector<DumpData>::const_iterator end,
429 const char* type_name, const bool add_to_zip) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100430 bool dumped = false;
Narayan Kamathbd863722017-06-01 18:50:12 +0100431 for (auto it = start; it != end; ++it) {
432 const std::string& name = it->name;
433 const int fd = it->fd;
Narayan Kamath8f788292017-05-25 13:20:39 +0100434 dumped = true;
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100435
436 // Seek to the beginning of the file before dumping any data. A given
437 // DumpData entry might be dumped multiple times in the report.
438 //
439 // For example, the most recent ANR entry is dumped to the body of the
440 // main entry and it also shows up as a separate entry in the bugreport
441 // ZIP file.
442 if (lseek(fd, 0, SEEK_SET) != static_cast<off_t>(0)) {
443 MYLOGE("Unable to add %s to zip file, lseek failed: %s\n", name.c_str(),
444 strerror(errno));
445 }
446
Narayan Kamath8f788292017-05-25 13:20:39 +0100447 if (ds.IsZipping() && add_to_zip) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800448 if (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + name, fd, /* timeout = */ 0ms) != OK) {
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100449 MYLOGE("Unable to add %s to zip file, addZipEntryFromFd failed\n", name.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100450 }
451 } else {
452 dump_file_from_fd(type_name, name.c_str(), fd);
453 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100454 }
455
456 return dumped;
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700457}
458
Felipe Leme635ca312016-01-05 14:23:02 -0800459// for_each_pid() callback to get mount info about a process.
Felipe Leme4c2d6632016-09-28 14:32:00 -0700460void do_mountinfo(int pid, const char* name __attribute__((unused))) {
Felipe Leme635ca312016-01-05 14:23:02 -0800461 char path[PATH_MAX];
462
463 // Gets the the content of the /proc/PID/ns/mnt link, so only unique mount points
464 // are added.
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700465 snprintf(path, sizeof(path), "/proc/%d/ns/mnt", pid);
Felipe Leme635ca312016-01-05 14:23:02 -0800466 char linkname[PATH_MAX];
467 ssize_t r = readlink(path, linkname, PATH_MAX);
468 if (r == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800469 MYLOGE("Unable to read link for %s: %s\n", path, strerror(errno));
Felipe Leme635ca312016-01-05 14:23:02 -0800470 return;
471 }
472 linkname[r] = '\0';
473
474 if (mount_points.find(linkname) == mount_points.end()) {
475 // First time this mount point was found: add it
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700476 snprintf(path, sizeof(path), "/proc/%d/mountinfo", pid);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700477 if (ds.AddZipEntry(ZIP_ROOT_DIR + path, path)) {
Felipe Leme635ca312016-01-05 14:23:02 -0800478 mount_points.insert(linkname);
479 } else {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800480 MYLOGE("Unable to add mountinfo %s to zip file\n", path);
Felipe Leme635ca312016-01-05 14:23:02 -0800481 }
482 }
483}
484
485void add_mountinfo() {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700486 if (!ds.IsZipping()) return;
Felipe Leme678727a2016-09-21 17:22:11 -0700487 std::string title = "MOUNT INFO";
Felipe Leme635ca312016-01-05 14:23:02 -0800488 mount_points.clear();
Felipe Leme46b85da2016-11-21 17:40:45 -0800489 DurationReporter duration_reporter(title, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700490 for_each_pid(do_mountinfo, nullptr);
491 MYLOGD("%s: %d entries added to zip file\n", title.c_str(), (int)mount_points.size());
Felipe Leme635ca312016-01-05 14:23:02 -0800492}
493
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700494static void dump_dev_files(const char *title, const char *driverpath, const char *filename)
495{
496 DIR *d;
497 struct dirent *de;
498 char path[PATH_MAX];
499
500 d = opendir(driverpath);
Yi Kong19d5c002018-07-20 13:39:55 -0700501 if (d == nullptr) {
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700502 return;
503 }
504
505 while ((de = readdir(d))) {
506 if (de->d_type != DT_LNK) {
507 continue;
508 }
509 snprintf(path, sizeof(path), "%s/%s/%s", driverpath, de->d_name, filename);
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700510 DumpFile(title, path);
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700511 }
512
513 closedir(d);
514}
515
Mark Salyzyn326842f2015-04-30 09:49:41 -0700516static bool skip_not_stat(const char *path) {
517 static const char stat[] = "/stat";
518 size_t len = strlen(path);
519 if (path[len - 1] == '/') { /* Directory? */
520 return false;
521 }
522 return strcmp(path + len - sizeof(stat) + 1, stat); /* .../stat? */
523}
524
Felipe Leme4c2d6632016-09-28 14:32:00 -0700525static bool skip_none(const char* path __attribute__((unused))) {
Felipe Lemee82a27d2016-01-05 13:35:44 -0800526 return false;
527}
528
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700529unsigned long worst_write_perf = 20000; /* in KB/s */
Mark Salyzyn326842f2015-04-30 09:49:41 -0700530
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800531//
532// stat offsets
533// Name units description
534// ---- ----- -----------
535// read I/Os requests number of read I/Os processed
536#define __STAT_READ_IOS 0
537// read merges requests number of read I/Os merged with in-queue I/O
538#define __STAT_READ_MERGES 1
539// read sectors sectors number of sectors read
540#define __STAT_READ_SECTORS 2
541// read ticks milliseconds total wait time for read requests
542#define __STAT_READ_TICKS 3
543// write I/Os requests number of write I/Os processed
544#define __STAT_WRITE_IOS 4
545// write merges requests number of write I/Os merged with in-queue I/O
546#define __STAT_WRITE_MERGES 5
547// write sectors sectors number of sectors written
548#define __STAT_WRITE_SECTORS 6
549// write ticks milliseconds total wait time for write requests
550#define __STAT_WRITE_TICKS 7
551// in_flight requests number of I/Os currently in flight
552#define __STAT_IN_FLIGHT 8
553// io_ticks milliseconds total time this block device has been active
554#define __STAT_IO_TICKS 9
555// time_in_queue milliseconds total wait time for all requests
556#define __STAT_IN_QUEUE 10
557#define __STAT_NUMBER_FIELD 11
558//
559// read I/Os, write I/Os
560// =====================
561//
562// These values increment when an I/O request completes.
563//
564// read merges, write merges
565// =========================
566//
567// These values increment when an I/O request is merged with an
568// already-queued I/O request.
569//
570// read sectors, write sectors
571// ===========================
572//
573// These values count the number of sectors read from or written to this
574// block device. The "sectors" in question are the standard UNIX 512-byte
575// sectors, not any device- or filesystem-specific block size. The
576// counters are incremented when the I/O completes.
577#define SECTOR_SIZE 512
578//
579// read ticks, write ticks
580// =======================
581//
582// These values count the number of milliseconds that I/O requests have
583// waited on this block device. If there are multiple I/O requests waiting,
584// these values will increase at a rate greater than 1000/second; for
585// example, if 60 read requests wait for an average of 30 ms, the read_ticks
586// field will increase by 60*30 = 1800.
587//
588// in_flight
589// =========
590//
591// This value counts the number of I/O requests that have been issued to
592// the device driver but have not yet completed. It does not include I/O
593// requests that are in the queue but not yet issued to the device driver.
594//
595// io_ticks
596// ========
597//
598// This value counts the number of milliseconds during which the device has
599// had I/O requests queued.
600//
601// time_in_queue
602// =============
603//
604// This value counts the number of milliseconds that I/O requests have waited
605// on this block device. If there are multiple I/O requests waiting, this
606// value will increase as the product of the number of milliseconds times the
607// number of requests waiting (see "read ticks" above for an example).
608#define S_TO_MS 1000
609//
610
Mark Salyzyn326842f2015-04-30 09:49:41 -0700611static int dump_stat_from_fd(const char *title __unused, const char *path, int fd) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800612 unsigned long long fields[__STAT_NUMBER_FIELD];
Mark Salyzyn326842f2015-04-30 09:49:41 -0700613 bool z;
Yi Kong19d5c002018-07-20 13:39:55 -0700614 char *cp, *buffer = nullptr;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700615 size_t i = 0;
Josh Gao7c4258c2018-06-25 13:40:08 -0700616 FILE *fp = fdopen(dup(fd), "rb");
Mark Salyzyn326842f2015-04-30 09:49:41 -0700617 getline(&buffer, &i, fp);
618 fclose(fp);
619 if (!buffer) {
620 return -errno;
621 }
622 i = strlen(buffer);
623 while ((i > 0) && (buffer[i - 1] == '\n')) {
624 buffer[--i] = '\0';
625 }
626 if (!*buffer) {
627 free(buffer);
628 return 0;
629 }
630 z = true;
631 for (cp = buffer, i = 0; i < (sizeof(fields) / sizeof(fields[0])); ++i) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800632 fields[i] = strtoull(cp, &cp, 10);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700633 if (fields[i] != 0) {
634 z = false;
635 }
636 }
637 if (z) { /* never accessed */
638 free(buffer);
639 return 0;
640 }
641
Wei Wang509bb5d2017-06-09 14:42:12 -0700642 if (!strncmp(path, BLK_DEV_SYS_DIR, sizeof(BLK_DEV_SYS_DIR) - 1)) {
643 path += sizeof(BLK_DEV_SYS_DIR) - 1;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700644 }
Wei Wang1dc1ef52017-06-12 11:28:37 -0700645
646 printf("%-30s:%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s\n%-30s:\t%s\n", "Block-Dev",
647 "R-IOs", "R-merg", "R-sect", "R-wait", "W-IOs", "W-merg", "W-sect",
648 "W-wait", "in-fli", "activ", "T-wait", path, buffer);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700649 free(buffer);
650
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800651 if (fields[__STAT_IO_TICKS]) {
652 unsigned long read_perf = 0;
653 unsigned long read_ios = 0;
654 if (fields[__STAT_READ_TICKS]) {
655 unsigned long long divisor = fields[__STAT_READ_TICKS]
656 * fields[__STAT_IO_TICKS];
657 read_perf = ((unsigned long long)SECTOR_SIZE
658 * fields[__STAT_READ_SECTORS]
659 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
660 / divisor;
661 read_ios = ((unsigned long long)S_TO_MS * fields[__STAT_READ_IOS]
662 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
663 / divisor;
664 }
665
666 unsigned long write_perf = 0;
667 unsigned long write_ios = 0;
668 if (fields[__STAT_WRITE_TICKS]) {
669 unsigned long long divisor = fields[__STAT_WRITE_TICKS]
670 * fields[__STAT_IO_TICKS];
671 write_perf = ((unsigned long long)SECTOR_SIZE
672 * fields[__STAT_WRITE_SECTORS]
673 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
674 / divisor;
675 write_ios = ((unsigned long long)S_TO_MS * fields[__STAT_WRITE_IOS]
676 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
677 / divisor;
678 }
679
680 unsigned queue = (fields[__STAT_IN_QUEUE]
681 + (fields[__STAT_IO_TICKS] >> 1))
682 / fields[__STAT_IO_TICKS];
683
684 if (!write_perf && !write_ios) {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700685 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 -0800686 } else {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700687 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 -0800688 read_ios, write_perf, write_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800689 }
690
691 /* bugreport timeout factor adjustment */
692 if ((write_perf > 1) && (write_perf < worst_write_perf)) {
693 worst_write_perf = write_perf;
694 }
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700695 }
Mark Salyzyn326842f2015-04-30 09:49:41 -0700696 return 0;
697}
698
Yao Chenbe3bbc12018-01-17 16:31:10 -0800699static const long MINIMUM_LOGCAT_TIMEOUT_MS = 50000;
700
Tom Cherryf4472f32020-08-05 09:31:17 -0700701// Returns the actual readable size of the given buffer or -1 on error.
702static long logcat_buffer_readable_size(const std::string& buffer) {
703 std::unique_ptr<logger_list, decltype(&android_logger_list_free)> logger_list{
704 android_logger_list_alloc(0, 0, 0), &android_logger_list_free};
705 auto logger = android_logger_open(logger_list.get(), android_name_to_log_id(buffer.c_str()));
706
707 return android_logger_get_log_readable_size(logger);
708}
709
710// Returns timeout in ms to read a list of buffers.
Yao Chenbe3bbc12018-01-17 16:31:10 -0800711static unsigned long logcat_timeout(const std::vector<std::string>& buffers) {
712 unsigned long timeout_ms = 0;
713 for (const auto& buffer : buffers) {
Tom Cherryf4472f32020-08-05 09:31:17 -0700714 long readable_size = logcat_buffer_readable_size(buffer);
715 if (readable_size > 0) {
716 // Engineering margin is ten-fold our guess.
717 timeout_ms += 10 * (readable_size + worst_write_perf) / worst_write_perf;
718 }
Yao Chenbe3bbc12018-01-17 16:31:10 -0800719 }
720 return timeout_ms > MINIMUM_LOGCAT_TIMEOUT_MS ? timeout_ms : MINIMUM_LOGCAT_TIMEOUT_MS;
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700721}
722
Dieter Hsu105ad0c2020-09-29 15:23:33 +0800723// Opens a socket and returns its file descriptor.
724static int open_socket(const char* service);
725
Nandana Duttd2f5f082019-01-18 17:13:52 +0000726Dumpstate::ConsentCallback::ConsentCallback() : result_(UNAVAILABLE), start_time_(Nanotime()) {
727}
728
729android::binder::Status Dumpstate::ConsentCallback::onReportApproved() {
730 std::lock_guard<std::mutex> lock(lock_);
731 result_ = APPROVED;
732 MYLOGD("User approved consent to share bugreport\n");
Paul Chang0d2aad72020-02-13 20:04:03 +0800733
734 // Maybe copy screenshot so calling app can display the screenshot to the user as soon as
735 // consent is granted.
736 if (ds.options_->is_screenshot_copied) {
737 return android::binder::Status::ok();
738 }
739
740 if (!ds.options_->do_screenshot || ds.options_->screenshot_fd.get() == -1 ||
741 !ds.do_early_screenshot_) {
742 return android::binder::Status::ok();
743 }
744
745 bool copy_succeeded = android::os::CopyFileToFd(ds.screenshot_path_,
746 ds.options_->screenshot_fd.get());
747 ds.options_->is_screenshot_copied = copy_succeeded;
748 if (copy_succeeded) {
749 android::os::UnlinkAndLogOnError(ds.screenshot_path_);
750 }
Nandana Duttd2f5f082019-01-18 17:13:52 +0000751 return android::binder::Status::ok();
752}
753
754android::binder::Status Dumpstate::ConsentCallback::onReportDenied() {
755 std::lock_guard<std::mutex> lock(lock_);
756 result_ = DENIED;
757 MYLOGW("User denied consent to share bugreport\n");
758 return android::binder::Status::ok();
759}
760
761UserConsentResult Dumpstate::ConsentCallback::getResult() {
762 std::lock_guard<std::mutex> lock(lock_);
763 return result_;
764}
765
766uint64_t Dumpstate::ConsentCallback::getElapsedTimeMs() const {
Hunter Knepshieldf0a39052020-01-03 14:53:04 -0800767 return (Nanotime() - start_time_) / NANOS_PER_MILLI;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000768}
769
Felipe Leme2b9b06c2016-10-14 09:13:06 -0700770void Dumpstate::PrintHeader() const {
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700771 std::string build, fingerprint, radio, bootloader, network;
772 char date[80];
Colin Crossf45fa6b2012-03-26 12:38:26 -0700773
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700774 build = android::base::GetProperty("ro.build.display.id", "(unknown)");
775 fingerprint = android::base::GetProperty("ro.build.fingerprint", "(unknown)");
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700776 radio = android::base::GetProperty("gsm.version.baseband", "(unknown)");
777 bootloader = android::base::GetProperty("ro.bootloader", "(unknown)");
778 network = android::base::GetProperty("gsm.operator.alpha", "(unknown)");
Felipe Lemebbaf3c12016-10-11 14:32:25 -0700779 strftime(date, sizeof(date), "%Y-%m-%d %H:%M:%S", localtime(&now_));
Colin Crossf45fa6b2012-03-26 12:38:26 -0700780
Felipe Lemed8b94e52016-12-08 10:21:44 -0800781 printf("========================================================\n");
782 printf("== dumpstate: %s\n", date);
783 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -0700784
Felipe Lemed8b94e52016-12-08 10:21:44 -0800785 printf("\n");
786 printf("Build: %s\n", build.c_str());
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700787 // NOTE: fingerprint entry format is important for other tools.
Felipe Lemed8b94e52016-12-08 10:21:44 -0800788 printf("Build fingerprint: '%s'\n", fingerprint.c_str());
789 printf("Bootloader: %s\n", bootloader.c_str());
790 printf("Radio: %s\n", radio.c_str());
791 printf("Network: %s\n", network.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100792 int64_t module_metadata_version = android::os::GetModuleMetadataVersion();
793 if (module_metadata_version != 0) {
794 printf("Module Metadata version: %" PRId64 "\n", module_metadata_version);
795 }
Anton Hansson37c041d2021-04-14 17:49:06 +0100796 printf("SDK extension versions [r=%s s=%s]\n",
797 android::base::GetProperty("build.version.extensions.r", "-").c_str(),
798 android::base::GetProperty("build.version.extensions.s", "-").c_str());
Colin Crossf45fa6b2012-03-26 12:38:26 -0700799
Felipe Lemed8b94e52016-12-08 10:21:44 -0800800 printf("Kernel: ");
Felipe Lemef0292972016-11-22 13:57:05 -0800801 DumpFileToFd(STDOUT_FILENO, "", "/proc/version");
Felipe Lemed8b94e52016-12-08 10:21:44 -0800802 printf("Command line: %s\n", strtok(cmdline_buf, "\n"));
Felipe Leme7709f8a2017-12-05 09:30:09 -0800803 printf("Uptime: ");
804 RunCommandToFd(STDOUT_FILENO, "", {"uptime", "-p"},
805 CommandOptions::WithTimeout(1).Always().Build());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800806 printf("Bugreport format version: %s\n", version_.c_str());
Rhed Jao1c855122020-07-16 17:37:39 +0800807 printf("Dumpstate info: id=%d pid=%d dry_run=%d parallel_run=%d args=%s bugreport_mode=%s\n",
808 id_, pid_, PropertiesHelper::IsDryRun(), PropertiesHelper::IsParallelRun(),
809 options_->args.c_str(), options_->bugreport_mode.c_str());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800810 printf("\n");
Felipe Leme78f2c862015-12-21 09:55:22 -0800811}
812
Felipe Leme24b66ee2016-06-16 10:55:26 -0700813// List of file extensions that can cause a zip file attachment to be rejected by some email
814// service providers.
815static const std::set<std::string> PROBLEMATIC_FILE_EXTENSIONS = {
816 ".ade", ".adp", ".bat", ".chm", ".cmd", ".com", ".cpl", ".exe", ".hta", ".ins", ".isp",
817 ".jar", ".jse", ".lib", ".lnk", ".mde", ".msc", ".msp", ".mst", ".pif", ".scr", ".sct",
818 ".shb", ".sys", ".vb", ".vbe", ".vbs", ".vxd", ".wsc", ".wsf", ".wsh"
819};
820
Vishnu Naire97d6122018-01-18 13:58:56 -0800821status_t Dumpstate::AddZipEntryFromFd(const std::string& entry_name, int fd,
822 std::chrono::milliseconds timeout = 0ms) {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700823 if (!IsZipping()) {
824 MYLOGD("Not adding zip entry %s from fd because it's not a zipped bugreport\n",
825 entry_name.c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -0800826 return INVALID_OPERATION;
Felipe Leme111b9d02016-02-03 09:28:24 -0800827 }
Felipe Leme24b66ee2016-06-16 10:55:26 -0700828 std::string valid_name = entry_name;
829
830 // Rename extension if necessary.
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -0700831 size_t idx = entry_name.rfind('.');
Felipe Leme24b66ee2016-06-16 10:55:26 -0700832 if (idx != std::string::npos) {
833 std::string extension = entry_name.substr(idx);
834 std::transform(extension.begin(), extension.end(), extension.begin(), ::tolower);
835 if (PROBLEMATIC_FILE_EXTENSIONS.count(extension) != 0) {
836 valid_name = entry_name + ".renamed";
837 MYLOGI("Renaming entry %s to %s\n", entry_name.c_str(), valid_name.c_str());
838 }
839 }
840
Felipe Leme6fe9db62016-02-12 09:04:16 -0800841 // Logging statement below is useful to time how long each entry takes, but it's too verbose.
842 // MYLOGD("Adding zip entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700843 int32_t err = zip_writer_->StartEntryWithTime(valid_name.c_str(), ZipWriter::kCompress,
844 get_mtime(fd, ds.now_));
Felipe Leme1d486fe2016-10-14 18:06:47 -0700845 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700846 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", valid_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700847 ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800848 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800849 }
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000850 bool finished_entry = false;
851 auto finish_entry = [this, &finished_entry] {
852 if (!finished_entry) {
853 // This should only be called when we're going to return an earlier error,
854 // which would've been logged. This may imply the file is already corrupt
855 // and any further logging from FinishEntry is more likely to mislead than
856 // not.
857 this->zip_writer_->FinishEntry();
858 }
859 };
860 auto scope_guard = android::base::make_scope_guard(finish_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -0800861 auto start = std::chrono::steady_clock::now();
862 auto end = start + timeout;
863 struct pollfd pfd = {fd, POLLIN};
Felipe Lemee82a27d2016-01-05 13:35:44 -0800864
Felipe Leme770410d2016-01-26 17:07:14 -0800865 std::vector<uint8_t> buffer(65536);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800866 while (1) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800867 if (timeout.count() > 0) {
868 // lambda to recalculate the timeout.
869 auto time_left_ms = [end]() {
870 auto now = std::chrono::steady_clock::now();
871 auto diff = std::chrono::duration_cast<std::chrono::milliseconds>(end - now);
872 return std::max(diff.count(), 0LL);
873 };
874
875 int rc = TEMP_FAILURE_RETRY(poll(&pfd, 1, time_left_ms()));
876 if (rc < 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000877 MYLOGE("Error in poll while adding from fd to zip entry %s:%s\n",
878 entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800879 return -errno;
880 } else if (rc == 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000881 MYLOGE("Timed out adding from fd to zip entry %s:%s Timeout:%lldms\n",
Vishnu Naire97d6122018-01-18 13:58:56 -0800882 entry_name.c_str(), strerror(errno), timeout.count());
883 return TIMED_OUT;
884 }
885 }
886
Zach Riggle22200402016-08-18 01:01:24 -0400887 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800888 if (bytes_read == 0) {
889 break;
890 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800891 MYLOGE("read(%s): %s\n", entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800892 return -errno;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800893 }
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700894 err = zip_writer_->WriteBytes(buffer.data(), bytes_read);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800895 if (err) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700896 MYLOGE("zip_writer_->WriteBytes(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800897 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800898 }
899 }
900
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700901 err = zip_writer_->FinishEntry();
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000902 finished_entry = true;
Felipe Leme1d486fe2016-10-14 18:06:47 -0700903 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700904 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800905 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800906 }
907
Vishnu Naire97d6122018-01-18 13:58:56 -0800908 return OK;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800909}
910
Felipe Leme1d486fe2016-10-14 18:06:47 -0700911bool Dumpstate::AddZipEntry(const std::string& entry_name, const std::string& entry_path) {
912 android::base::unique_fd fd(
913 TEMP_FAILURE_RETRY(open(entry_path.c_str(), O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
Andreas Gampeaff68432016-07-18 18:01:27 -0700914 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800915 MYLOGE("open(%s): %s\n", entry_path.c_str(), strerror(errno));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800916 return false;
917 }
918
Vishnu Naire97d6122018-01-18 13:58:56 -0800919 return (AddZipEntryFromFd(entry_name, fd.get()) == OK);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800920}
921
922/* adds a file to the existing zipped bugreport */
Felipe Leme4c2d6632016-09-28 14:32:00 -0700923static int _add_file_from_fd(const char* title __attribute__((unused)), const char* path, int fd) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800924 return (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + path, fd) == OK) ? 0 : 1;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800925}
926
Felipe Leme1d486fe2016-10-14 18:06:47 -0700927void Dumpstate::AddDir(const std::string& dir, bool recursive) {
928 if (!IsZipping()) {
929 MYLOGD("Not adding dir %s because it's not a zipped bugreport\n", dir.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800930 return;
931 }
Felipe Leme678727a2016-09-21 17:22:11 -0700932 MYLOGD("Adding dir %s (recursive: %d)\n", dir.c_str(), recursive);
Felipe Leme46b85da2016-11-21 17:40:45 -0800933 DurationReporter duration_reporter(dir, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700934 dump_files("", dir.c_str(), recursive ? skip_none : is_dir, _add_file_from_fd);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800935}
936
Felipe Leme1d486fe2016-10-14 18:06:47 -0700937bool Dumpstate::AddTextZipEntry(const std::string& entry_name, const std::string& content) {
938 if (!IsZipping()) {
939 MYLOGD("Not adding text zip entry %s because it's not a zipped bugreport\n",
940 entry_name.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800941 return false;
942 }
Felipe Lemecbce55d2016-02-08 09:53:18 -0800943 MYLOGD("Adding zip text entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700944 int32_t err = zip_writer_->StartEntryWithTime(entry_name.c_str(), ZipWriter::kCompress, ds.now_);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700945 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700946 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700947 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800948 return false;
949 }
950
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700951 err = zip_writer_->WriteBytes(content.c_str(), content.length());
Felipe Leme1d486fe2016-10-14 18:06:47 -0700952 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700953 MYLOGE("zip_writer_->WriteBytes(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700954 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800955 return false;
956 }
957
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700958 err = zip_writer_->FinishEntry();
Felipe Leme1d486fe2016-10-14 18:06:47 -0700959 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700960 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800961 return false;
962 }
963
964 return true;
965}
966
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800967static void DoKmsg() {
968 struct stat st;
969 if (!stat(PSTORE_LAST_KMSG, &st)) {
970 /* Also TODO: Make console-ramoops CAP_SYSLOG protected. */
971 DumpFile("LAST KMSG", PSTORE_LAST_KMSG);
972 } else if (!stat(ALT_PSTORE_LAST_KMSG, &st)) {
973 DumpFile("LAST KMSG", ALT_PSTORE_LAST_KMSG);
974 } else {
975 /* TODO: Make last_kmsg CAP_SYSLOG protected. b/5555691 */
976 DumpFile("LAST KMSG", "/proc/last_kmsg");
977 }
978}
979
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800980static void DoKernelLogcat() {
Yao Chenbe3bbc12018-01-17 16:31:10 -0800981 unsigned long timeout_ms = logcat_timeout({"kernel"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800982 RunCommand(
983 "KERNEL LOG",
984 {"logcat", "-b", "kernel", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
985 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
986}
987
Nandana Duttdb379fa2019-10-09 16:54:41 +0100988static void DoSystemLogcat(time_t since) {
989 char since_str[80];
990 strftime(since_str, sizeof(since_str), "%Y-%m-%d %H:%M:%S.000", localtime(&since));
991
992 unsigned long timeout_ms = logcat_timeout({"main", "system", "crash"});
993 RunCommand("SYSTEM LOG",
994 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v", "-T",
995 since_str},
996 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
997}
998
Hunter Knepshield820f9bc2020-02-05 20:10:53 -0800999static void DoRadioLogcat() {
1000 unsigned long timeout_ms = logcat_timeout({"radio"});
1001 RunCommand(
1002 "RADIO LOG",
1003 {"logcat", "-b", "radio", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1004 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
1005}
1006
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001007static void DoLogcat() {
Vishnu Nair6921f802017-11-22 09:17:23 -08001008 unsigned long timeout_ms;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001009 // DumpFile("EVENT LOG TAGS", "/etc/event-log-tags");
1010 // calculate timeout
Yao Chenbe3bbc12018-01-17 16:31:10 -08001011 timeout_ms = logcat_timeout({"main", "system", "crash"});
Tony Makae737652017-03-30 17:47:09 +01001012 RunCommand("SYSTEM LOG",
Vishnu Nair6921f802017-11-22 09:17:23 -08001013 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1014 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -08001015 timeout_ms = logcat_timeout({"events"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001016 RunCommand(
1017 "EVENT LOG",
1018 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001019 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Yao Chenbe3bbc12018-01-17 16:31:10 -08001020 timeout_ms = logcat_timeout({"stats"});
1021 RunCommand(
1022 "STATS LOG",
1023 {"logcat", "-b", "stats", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001024 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001025 DoRadioLogcat();
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001026
1027 RunCommand("LOG STATISTICS", {"logcat", "-b", "all", "-S"});
1028
1029 /* kernels must set CONFIG_PSTORE_PMSG, slice up pstore with device tree */
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001030 RunCommand("LAST LOGCAT", {"logcat", "-L", "-b", "all", "-v", "threadtime", "-v", "printable",
1031 "-v", "uid", "-d", "*:v"});
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001032}
1033
Mike Ma5c267872019-08-21 11:31:34 -07001034static void DumpIncidentReport() {
1035 if (!ds.IsZipping()) {
1036 MYLOGD("Not dumping incident report because it's not a zipped bugreport\n");
1037 return;
1038 }
Mike Ma5c267872019-08-21 11:31:34 -07001039 const std::string path = ds.bugreport_internal_dir_ + "/tmp_incident_report";
1040 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1041 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1042 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1043 if (fd < 0) {
1044 MYLOGE("Could not open %s to dump incident report.\n", path.c_str());
1045 return;
1046 }
1047 RunCommandToFd(fd, "", {"incident", "-u"}, CommandOptions::WithTimeout(120).Build());
1048 bool empty = 0 == lseek(fd, 0, SEEK_END);
1049 if (!empty) {
1050 // Use a different name from "incident.proto"
1051 // /proto/incident.proto is reserved for incident service dump
1052 // i.e. metadata for debugging.
Rhed Jao4875aa62020-07-20 17:46:29 +08001053 ds.EnqueueAddZipEntryAndCleanupIfNeeded(kProtoPath + "incident_report" + kProtoExt,
1054 path);
1055 } else {
1056 unlink(path.c_str());
Mike Ma5c267872019-08-21 11:31:34 -07001057 }
Mike Ma5c267872019-08-21 11:31:34 -07001058}
1059
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001060static void MaybeAddSystemTraceToZip() {
1061 // This function copies into the .zip the system trace that was snapshotted
1062 // by the early call to MaybeSnapshotSystemTrace(), if any background
1063 // tracing was happening.
1064 if (!ds.IsZipping()) {
1065 MYLOGD("Not dumping system trace because it's not a zipped bugreport\n");
1066 return;
1067 }
1068 if (!ds.has_system_trace_) {
1069 // No background trace was happening at the time dumpstate was invoked.
1070 return;
1071 }
1072 ds.AddZipEntry(
1073 ZIP_ROOT_DIR + SYSTEM_TRACE_SNAPSHOT,
1074 SYSTEM_TRACE_SNAPSHOT);
1075 android::os::UnlinkAndLogOnError(SYSTEM_TRACE_SNAPSHOT);
1076}
1077
Sunny Goyal35949782019-11-19 15:54:36 -08001078static void DumpVisibleWindowViews() {
1079 if (!ds.IsZipping()) {
1080 MYLOGD("Not dumping visible views because it's not a zipped bugreport\n");
1081 return;
1082 }
1083 DurationReporter duration_reporter("VISIBLE WINDOW VIEWS");
1084 const std::string path = ds.bugreport_internal_dir_ + "/tmp_visible_window_views";
1085 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1086 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1087 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1088 if (fd < 0) {
1089 MYLOGE("Could not open %s to dump visible views.\n", path.c_str());
1090 return;
1091 }
1092 RunCommandToFd(fd, "", {"cmd", "window", "dump-visible-window-views"},
1093 CommandOptions::WithTimeout(120).Build());
1094 bool empty = 0 == lseek(fd, 0, SEEK_END);
1095 if (!empty) {
1096 ds.AddZipEntry("visible_windows.zip", path);
1097 } else {
1098 MYLOGW("Failed to dump visible windows\n");
1099 }
1100 unlink(path.c_str());
1101}
1102
Jayachandran Ca94c7172017-06-10 15:08:12 -07001103static void DumpIpTablesAsRoot() {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001104 RunCommand("IPTABLES", {"iptables", "-L", "-nvx"});
1105 RunCommand("IP6TABLES", {"ip6tables", "-L", "-nvx"});
Erik Kline32af8c22016-09-28 17:26:26 +09001106 RunCommand("IPTABLES NAT", {"iptables", "-t", "nat", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001107 /* no ip6 nat */
Erik Kline32af8c22016-09-28 17:26:26 +09001108 RunCommand("IPTABLES MANGLE", {"iptables", "-t", "mangle", "-L", "-nvx"});
1109 RunCommand("IP6TABLES MANGLE", {"ip6tables", "-t", "mangle", "-L", "-nvx"});
1110 RunCommand("IPTABLES RAW", {"iptables", "-t", "raw", "-L", "-nvx"});
1111 RunCommand("IP6TABLES RAW", {"ip6tables", "-t", "raw", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001112}
1113
David Andersond9ba4752018-12-11 18:26:59 -08001114static void DumpDynamicPartitionInfo() {
1115 if (!::android::base::GetBoolProperty("ro.boot.dynamic_partitions", false)) {
1116 return;
1117 }
1118
1119 RunCommand("LPDUMP", {"lpdump", "--all"});
David Anderson6650ade2019-10-02 15:18:59 -07001120 RunCommand("DEVICE-MAPPER", {"gsid", "dump-device-mapper"});
David Andersond9ba4752018-12-11 18:26:59 -08001121}
1122
Narayan Kamath8f788292017-05-25 13:20:39 +01001123static void AddAnrTraceDir(const bool add_to_zip, const std::string& anr_traces_dir) {
1124 MYLOGD("AddAnrTraceDir(): dump_traces_file=%s, anr_traces_dir=%s\n", dump_traces_path,
1125 anr_traces_dir.c_str());
1126
1127 // If we're here, dump_traces_path will always be a temporary file
1128 // (created with mkostemp or similar) that contains dumps taken earlier
1129 // on in the process.
1130 if (dump_traces_path != nullptr) {
1131 if (add_to_zip) {
1132 ds.AddZipEntry(ZIP_ROOT_DIR + anr_traces_dir + "/traces-just-now.txt", dump_traces_path);
1133 } else {
1134 MYLOGD("Dumping current ANR traces (%s) to the main bugreport entry\n",
1135 dump_traces_path);
1136 ds.DumpFile("VM TRACES JUST NOW", dump_traces_path);
1137 }
1138
1139 const int ret = unlink(dump_traces_path);
1140 if (ret == -1) {
1141 MYLOGW("Error unlinking temporary trace path %s: %s\n", dump_traces_path,
1142 strerror(errno));
Felipe Lemee184f662016-10-27 10:04:47 -07001143 }
1144 }
1145
Narayan Kamathbd863722017-06-01 18:50:12 +01001146 // Add a specific message for the first ANR Dump.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001147 if (ds.anr_data_.size() > 0) {
1148 AddDumps(ds.anr_data_.begin(), ds.anr_data_.begin() + 1,
Narayan Kamathbd863722017-06-01 18:50:12 +01001149 "VM TRACES AT LAST ANR", add_to_zip);
1150
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001151 // The "last" ANR will always be included as separate entry in the zip file. In addition,
1152 // it will be present in the body of the main entry if |add_to_zip| == false.
1153 //
1154 // Historical ANRs are always included as separate entries in the bugreport zip file.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001155 AddDumps(ds.anr_data_.begin() + ((add_to_zip) ? 1 : 0), ds.anr_data_.end(),
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001156 "HISTORICAL ANR", true /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001157 } else {
Narayan Kamath8f788292017-05-25 13:20:39 +01001158 printf("*** NO ANRs to dump in %s\n\n", ANR_DIR.c_str());
1159 }
1160}
1161
1162static void AddAnrTraceFiles() {
1163 const bool add_to_zip = ds.IsZipping() && ds.version_ == VERSION_SPLIT_ANR;
1164
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001165 std::string anr_traces_dir = "/data/anr";
Narayan Kamath8f788292017-05-25 13:20:39 +01001166
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001167 AddAnrTraceDir(add_to_zip, anr_traces_dir);
Narayan Kamath8f788292017-05-25 13:20:39 +01001168
Makoto Onuki83ec63f2019-01-31 17:08:59 -08001169 RunCommand("ANR FILES", {"ls", "-lt", ANR_DIR});
1170
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001171 // Slow traces for slow operations.
Felipe Lemee184f662016-10-27 10:04:47 -07001172 struct stat st;
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001173 int i = 0;
1174 while (true) {
1175 const std::string slow_trace_path =
1176 anr_traces_dir + android::base::StringPrintf("slow%02d.txt", i);
1177 if (stat(slow_trace_path.c_str(), &st)) {
1178 // No traces file at this index, done with the files.
1179 break;
Felipe Lemee184f662016-10-27 10:04:47 -07001180 }
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001181 ds.DumpFile("VM TRACES WHEN SLOW", slow_trace_path.c_str());
1182 i++;
Felipe Lemee184f662016-10-27 10:04:47 -07001183 }
1184}
1185
Wei Wang509bb5d2017-06-09 14:42:12 -07001186static void DumpBlockStatFiles() {
1187 DurationReporter duration_reporter("DUMP BLOCK STAT");
Wei Wang509bb5d2017-06-09 14:42:12 -07001188
Wei Wang1dc1ef52017-06-12 11:28:37 -07001189 std::unique_ptr<DIR, std::function<int(DIR*)>> dirptr(opendir(BLK_DEV_SYS_DIR), closedir);
1190
1191 if (dirptr == nullptr) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001192 MYLOGE("Failed to open %s: %s\n", BLK_DEV_SYS_DIR, strerror(errno));
1193 return;
1194 }
1195
1196 printf("------ DUMP BLOCK STAT ------\n\n");
Wei Wang1dc1ef52017-06-12 11:28:37 -07001197 while (struct dirent *d = readdir(dirptr.get())) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001198 if ((d->d_name[0] == '.')
1199 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
1200 || (d->d_name[1] == '\0'))) {
1201 continue;
1202 }
1203 const std::string new_path =
1204 android::base::StringPrintf("%s/%s", BLK_DEV_SYS_DIR, d->d_name);
1205 printf("------ BLOCK STAT (%s) ------\n", new_path.c_str());
1206 dump_files("", new_path.c_str(), skip_not_stat, dump_stat_from_fd);
1207 printf("\n");
1208 }
Wei Wang1dc1ef52017-06-12 11:28:37 -07001209 return;
Wei Wang509bb5d2017-06-09 14:42:12 -07001210}
Jayachandran Ca94c7172017-06-10 15:08:12 -07001211
1212static void DumpPacketStats() {
1213 DumpFile("NETWORK DEV INFO", "/proc/net/dev");
Jayachandran Ca94c7172017-06-10 15:08:12 -07001214}
1215
1216static void DumpIpAddrAndRules() {
1217 /* The following have a tendency to get wedged when wifi drivers/fw goes belly-up. */
1218 RunCommand("NETWORK INTERFACES", {"ip", "link"});
1219 RunCommand("IPv4 ADDRESSES", {"ip", "-4", "addr", "show"});
1220 RunCommand("IPv6 ADDRESSES", {"ip", "-6", "addr", "show"});
1221 RunCommand("IP RULES", {"ip", "rule", "show"});
1222 RunCommand("IP RULES v6", {"ip", "-6", "rule", "show"});
1223}
1224
Nandana Dutt5c390032019-03-12 10:52:56 +00001225static Dumpstate::RunStatus RunDumpsysTextByPriority(const std::string& title, int priority,
1226 std::chrono::milliseconds timeout,
1227 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001228 auto start = std::chrono::steady_clock::now();
Vishnu Naire97d6122018-01-18 13:58:56 -08001229 sp<android::IServiceManager> sm = defaultServiceManager();
1230 Dumpsys dumpsys(sm.get());
Vishnu Naire97d6122018-01-18 13:58:56 -08001231 Vector<String16> args;
1232 Dumpsys::setServiceArgs(args, /* asProto = */ false, priority);
Vishnu Naire97d6122018-01-18 13:58:56 -08001233 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ false);
1234 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001235 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001236 std::string path(title);
1237 path.append(" - ").append(String8(service).c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -08001238 size_t bytes_written = 0;
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001239 if (PropertiesHelper::IsDryRun()) {
1240 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1241 dumpsys.writeDumpFooter(STDOUT_FILENO, service, std::chrono::milliseconds(1));
1242 } else {
1243 status_t status = dumpsys.startDumpThread(Dumpsys::TYPE_DUMP, service, args);
1244 if (status == OK) {
1245 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1246 std::chrono::duration<double> elapsed_seconds;
1247 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH &&
1248 service == String16("meminfo")) {
1249 // Use a longer timeout for meminfo, since 30s is not always enough.
1250 status = dumpsys.writeDump(STDOUT_FILENO, service, 60s,
1251 /* as_proto = */ false, elapsed_seconds,
1252 bytes_written);
1253 } else {
1254 status = dumpsys.writeDump(STDOUT_FILENO, service, service_timeout,
1255 /* as_proto = */ false, elapsed_seconds,
1256 bytes_written);
1257 }
1258 dumpsys.writeDumpFooter(STDOUT_FILENO, service, elapsed_seconds);
1259 bool dump_complete = (status == OK);
1260 dumpsys.stopDumpThread(dump_complete);
Gavin Corkeryfac7e2b2021-07-08 22:39:02 +01001261 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001262 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001263
1264 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1265 std::chrono::steady_clock::now() - start);
1266 if (elapsed_duration > timeout) {
1267 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1268 elapsed_duration.count());
1269 break;
1270 }
1271 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001272 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001273}
1274
Vishnu Nair64afc022018-02-01 15:29:34 -08001275static void RunDumpsysText(const std::string& title, int priority,
1276 std::chrono::milliseconds timeout,
1277 std::chrono::milliseconds service_timeout) {
1278 DurationReporter duration_reporter(title);
1279 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1280 fsync(STDOUT_FILENO);
1281 RunDumpsysTextByPriority(title, priority, timeout, service_timeout);
1282}
1283
1284/* Dump all services registered with Normal or Default priority. */
Nandana Dutt5c390032019-03-12 10:52:56 +00001285static Dumpstate::RunStatus RunDumpsysTextNormalPriority(const std::string& title,
1286 std::chrono::milliseconds timeout,
1287 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001288 DurationReporter duration_reporter(title);
1289 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1290 fsync(STDOUT_FILENO);
1291 RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_NORMAL, timeout,
1292 service_timeout);
Nandana Dutt5c390032019-03-12 10:52:56 +00001293
1294 RETURN_IF_USER_DENIED_CONSENT();
1295
1296 return RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_DEFAULT, timeout,
1297 service_timeout);
Vishnu Nair64afc022018-02-01 15:29:34 -08001298}
1299
Nandana Dutt5c390032019-03-12 10:52:56 +00001300static Dumpstate::RunStatus RunDumpsysProto(const std::string& title, int priority,
1301 std::chrono::milliseconds timeout,
1302 std::chrono::milliseconds service_timeout) {
Luis Hector Chavez1e27b082018-03-22 15:36:42 -07001303 if (!ds.IsZipping()) {
1304 MYLOGD("Not dumping %s because it's not a zipped bugreport\n", title.c_str());
Nandana Dutt5c390032019-03-12 10:52:56 +00001305 return Dumpstate::RunStatus::OK;
Luis Hector Chavez1e27b082018-03-22 15:36:42 -07001306 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001307 sp<android::IServiceManager> sm = defaultServiceManager();
1308 Dumpsys dumpsys(sm.get());
1309 Vector<String16> args;
1310 Dumpsys::setServiceArgs(args, /* asProto = */ true, priority);
1311 DurationReporter duration_reporter(title);
1312
1313 auto start = std::chrono::steady_clock::now();
1314 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ true);
1315 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001316 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001317 std::string path(kProtoPath);
1318 path.append(String8(service).c_str());
1319 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL) {
1320 path.append("_CRITICAL");
1321 } else if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH) {
1322 path.append("_HIGH");
1323 }
1324 path.append(kProtoExt);
Steven Morelandcbd69fc2021-07-20 20:45:43 +00001325 status_t status = dumpsys.startDumpThread(Dumpsys::TYPE_DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001326 if (status == OK) {
1327 status = ds.AddZipEntryFromFd(path, dumpsys.getDumpFd(), service_timeout);
1328 bool dumpTerminated = (status == OK);
1329 dumpsys.stopDumpThread(dumpTerminated);
1330 }
1331 ZipWriter::FileEntry file_entry;
1332 ds.zip_writer_->GetLastEntry(&file_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -08001333
1334 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1335 std::chrono::steady_clock::now() - start);
1336 if (elapsed_duration > timeout) {
1337 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1338 elapsed_duration.count());
1339 break;
1340 }
1341 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001342 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001343}
1344
Nandana Dutta7db6342018-11-21 14:53:34 +00001345// Runs dumpsys on services that must dump first and will take less than 100ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001346static Dumpstate::RunStatus RunDumpsysCritical() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001347 RunDumpsysText("DUMPSYS CRITICAL", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1348 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Nandana Dutt5c390032019-03-12 10:52:56 +00001349
1350 RETURN_IF_USER_DENIED_CONSENT();
1351
1352 return RunDumpsysProto("DUMPSYS CRITICAL PROTO", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1353 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Vishnu Nair780b1282017-10-10 13:57:24 -07001354}
1355
1356// Runs dumpsys on services that must dump first but can take up to 250ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001357static Dumpstate::RunStatus RunDumpsysHigh() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001358 // TODO meminfo takes ~10s, connectivity takes ~5sec to dump. They are both
1359 // high priority. Reduce timeout once they are able to dump in a shorter time or
1360 // moved to a parallel task.
1361 RunDumpsysText("DUMPSYS HIGH", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1362 /* timeout= */ 90s, /* service_timeout= */ 30s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001363
1364 RETURN_IF_USER_DENIED_CONSENT();
1365
1366 return RunDumpsysProto("DUMPSYS HIGH PROTO", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1367 /* timeout= */ 5s, /* service_timeout= */ 1s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001368}
1369
1370// Runs dumpsys on services that must dump but can take up to 10s to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001371static Dumpstate::RunStatus RunDumpsysNormal() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001372 RunDumpsysTextNormalPriority("DUMPSYS", /* timeout= */ 90s, /* service_timeout= */ 10s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001373
1374 RETURN_IF_USER_DENIED_CONSENT();
1375
1376 return RunDumpsysProto("DUMPSYS PROTO", IServiceManager::DUMP_FLAG_PRIORITY_NORMAL,
1377 /* timeout= */ 90s, /* service_timeout= */ 10s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001378}
1379
Rhed Jao4875aa62020-07-20 17:46:29 +08001380/*
1381 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1382 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1383 * if it's not running in the parallel task.
1384 */
1385static void DumpHals(int out_fd = STDOUT_FILENO) {
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001386 if (!ds.IsZipping()) {
Yifan Hong30528a22020-08-07 18:24:06 -07001387 RunCommand("HARDWARE HALS", {"lshal", "--all", "--types=all", "--debug"},
Steven Moreland9de8a1f2020-09-23 17:26:33 +00001388 CommandOptions::WithTimeout(60).AsRootIfAvailable().Build());
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001389 return;
1390 }
Yifan Hong30528a22020-08-07 18:24:06 -07001391 RunCommand("HARDWARE HALS", {"lshal", "--all", "--types=all"},
Rhed Jao4875aa62020-07-20 17:46:29 +08001392 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build(),
1393 false, out_fd);
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001394
Steven Moreland44cd9482018-01-04 16:24:13 -08001395 using android::hidl::manager::V1_0::IServiceManager;
1396 using android::hardware::defaultServiceManager;
1397
1398 sp<IServiceManager> sm = defaultServiceManager();
1399 if (sm == nullptr) {
1400 MYLOGE("Could not retrieve hwservicemanager to dump hals.\n");
1401 return;
1402 }
1403
1404 auto ret = sm->list([&](const auto& interfaces) {
1405 for (const std::string& interface : interfaces) {
1406 std::string cleanName = interface;
1407 std::replace_if(cleanName.begin(),
1408 cleanName.end(),
1409 [](char c) {
1410 return !isalnum(c) &&
1411 std::string("@-_:.").find(c) == std::string::npos;
1412 }, '_');
Nandana Dutt979388e2018-11-30 16:48:55 +00001413 const std::string path = ds.bugreport_internal_dir_ + "/lshal_debug_" + cleanName;
Steven Moreland44cd9482018-01-04 16:24:13 -08001414
Rhed Jao4875aa62020-07-20 17:46:29 +08001415 bool empty = false;
Steven Moreland44cd9482018-01-04 16:24:13 -08001416 {
1417 auto fd = android::base::unique_fd(
1418 TEMP_FAILURE_RETRY(open(path.c_str(),
1419 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1420 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1421 if (fd < 0) {
1422 MYLOGE("Could not open %s to dump additional hal information.\n", path.c_str());
1423 continue;
1424 }
1425 RunCommandToFd(fd,
1426 "",
Steven Morelandc81cd3c2018-01-18 14:36:26 -08001427 {"lshal", "debug", "-E", interface},
Steven Moreland44cd9482018-01-04 16:24:13 -08001428 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
1429
Rhed Jao4875aa62020-07-20 17:46:29 +08001430 empty = 0 == lseek(fd, 0, SEEK_END);
Steven Moreland44cd9482018-01-04 16:24:13 -08001431 }
Rhed Jao4875aa62020-07-20 17:46:29 +08001432 if (!empty) {
1433 ds.EnqueueAddZipEntryAndCleanupIfNeeded("lshal-debug/" + cleanName + ".txt",
1434 path);
1435 } else {
1436 unlink(path.c_str());
1437 }
Steven Moreland44cd9482018-01-04 16:24:13 -08001438 }
1439 });
1440
1441 if (!ret.isOk()) {
1442 MYLOGE("Could not list hals from hwservicemanager.\n");
1443 }
1444}
1445
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001446static void DumpExternalFragmentationInfo() {
1447 struct stat st;
1448 if (stat("/proc/buddyinfo", &st) != 0) {
1449 MYLOGE("Unable to dump external fragmentation info\n");
1450 return;
1451 }
1452
1453 printf("------ EXTERNAL FRAGMENTATION INFO ------\n");
1454 std::ifstream ifs("/proc/buddyinfo");
1455 auto unusable_index_regex = std::regex{"Node\\s+([0-9]+),\\s+zone\\s+(\\S+)\\s+(.*)"};
1456 for (std::string line; std::getline(ifs, line);) {
1457 std::smatch match_results;
1458 if (std::regex_match(line, match_results, unusable_index_regex)) {
1459 std::stringstream free_pages(std::string{match_results[3]});
1460 std::vector<int> free_pages_per_order(std::istream_iterator<int>{free_pages},
1461 std::istream_iterator<int>());
1462
1463 int total_free_pages = 0;
1464 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1465 total_free_pages += (free_pages_per_order[i] * std::pow(2, i));
1466 }
1467
1468 printf("Node %s, zone %8s", match_results[1].str().c_str(),
1469 match_results[2].str().c_str());
1470
1471 int usable_free_pages = total_free_pages;
1472 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1473 auto unusable_index = (total_free_pages - usable_free_pages) /
1474 static_cast<double>(total_free_pages);
1475 printf(" %5.3f", unusable_index);
1476 usable_free_pages -= (free_pages_per_order[i] * std::pow(2, i));
1477 }
1478
1479 printf("\n");
1480 }
1481 }
1482 printf("\n");
1483}
1484
mhasankd451a472020-05-26 18:02:39 -07001485static void DumpstateLimitedOnly() {
1486 // Trimmed-down version of dumpstate to only include a whitelisted
1487 // set of logs (system log, event log, and system server / system app
1488 // crashes, and networking logs). See b/136273873 and b/138459828
1489 // for context.
1490 DurationReporter duration_reporter("DUMPSTATE");
1491 unsigned long timeout_ms;
1492 // calculate timeout
1493 timeout_ms = logcat_timeout({"main", "system", "crash"});
1494 RunCommand("SYSTEM LOG",
1495 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1496 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1497 timeout_ms = logcat_timeout({"events"});
1498 RunCommand(
1499 "EVENT LOG",
1500 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1501 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1502
1503 printf("========================================================\n");
1504 printf("== Networking Service\n");
1505 printf("========================================================\n");
1506
1507 RunDumpsys("DUMPSYS NETWORK_SERVICE_LIMITED", {"wifi", "-a"},
1508 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hugo Benichiaa162682020-10-30 23:28:56 +09001509 RunDumpsys("DUMPSYS CONNECTIVITY REQUESTS", {"connectivity", "requests"},
1510 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
mhasankd451a472020-05-26 18:02:39 -07001511
1512 printf("========================================================\n");
1513 printf("== Dropbox crashes\n");
1514 printf("========================================================\n");
1515
1516 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1517 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1518
1519 printf("========================================================\n");
1520 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1521 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1522 printf("========================================================\n");
1523 printf("== dumpstate: done (id %d)\n", ds.id_);
1524 printf("========================================================\n");
1525}
1526
Rhed Jao6b1ea2d2020-07-21 17:58:41 +08001527/*
1528 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1529 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1530 * if it's not running in the parallel task.
1531 */
1532static void DumpCheckins(int out_fd = STDOUT_FILENO) {
1533 dprintf(out_fd, "========================================================\n");
1534 dprintf(out_fd, "== Checkins\n");
1535 dprintf(out_fd, "========================================================\n");
1536
1537 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"}, out_fd);
1538 RunDumpsys("CHECKIN MEMINFO", {"meminfo", "--checkin"}, out_fd);
1539 RunDumpsys("CHECKIN NETSTATS", {"netstats", "--checkin"}, out_fd);
1540 RunDumpsys("CHECKIN PROCSTATS", {"procstats", "-c"}, out_fd);
1541 RunDumpsys("CHECKIN USAGESTATS", {"usagestats", "-c"}, out_fd);
1542 RunDumpsys("CHECKIN PACKAGE", {"package", "--checkin"}, out_fd);
1543}
1544
1545/*
1546 * Runs dumpsys on activity service to dump all application activities, services
1547 * and providers in the device.
1548 *
1549 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1550 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1551 * if it's not running in the parallel task.
1552 */
1553static void DumpAppInfos(int out_fd = STDOUT_FILENO) {
1554 dprintf(out_fd, "========================================================\n");
1555 dprintf(out_fd, "== Running Application Activities\n");
1556 dprintf(out_fd, "========================================================\n");
1557
1558 // The following dumpsys internally collects output from running apps, so it can take a long
1559 // time. So let's extend the timeout.
1560
1561 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
1562
1563 RunDumpsys("APP ACTIVITIES", {"activity", "-v", "all"}, DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1564
1565 dprintf(out_fd, "========================================================\n");
1566 dprintf(out_fd, "== Running Application Services (platform)\n");
1567 dprintf(out_fd, "========================================================\n");
1568
1569 RunDumpsys("APP SERVICES PLATFORM", {"activity", "service", "all-platform-non-critical"},
1570 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1571
1572 dprintf(out_fd, "========================================================\n");
1573 dprintf(out_fd, "== Running Application Services (non-platform)\n");
1574 dprintf(out_fd, "========================================================\n");
1575
1576 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1577 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1578
1579 dprintf(out_fd, "========================================================\n");
1580 dprintf(out_fd, "== Running Application Providers (platform)\n");
1581 dprintf(out_fd, "========================================================\n");
1582
1583 RunDumpsys("APP PROVIDERS PLATFORM", {"activity", "provider", "all-platform"},
Rhed Jaob049f182021-01-11 21:08:43 +08001584 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
Rhed Jao6b1ea2d2020-07-21 17:58:41 +08001585
1586 dprintf(out_fd, "========================================================\n");
1587 dprintf(out_fd, "== Running Application Providers (non-platform)\n");
1588 dprintf(out_fd, "========================================================\n");
1589
1590 RunDumpsys("APP PROVIDERS NON-PLATFORM", {"activity", "provider", "all-non-platform"},
1591 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1592}
1593
Nandana Dutt5c390032019-03-12 10:52:56 +00001594// Dumps various things. Returns early with status USER_CONSENT_DENIED if user denies consent
1595// via the consent they are shown. Ignores other errors that occur while running various
1596// commands. The consent checking is currently done around long running tasks, which happen to
1597// be distributed fairly evenly throughout the function.
1598static Dumpstate::RunStatus dumpstate() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001599 DurationReporter duration_reporter("DUMPSTATE");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001600
Rhed Jao4875aa62020-07-20 17:46:29 +08001601 // Enqueue slow functions into the thread pool, if the parallel run is enabled.
1602 if (ds.dump_pool_) {
1603 // Pool was shutdown in DumpstateDefaultAfterCritical method in order to
1604 // drop root user. Restarts it with two threads for the parallel run.
1605 ds.dump_pool_->start(/* thread_counts = */2);
1606
1607 ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
1608 ds.dump_pool_->enqueueTask(DUMP_INCIDENT_REPORT_TASK, &DumpIncidentReport);
1609 ds.dump_pool_->enqueueTaskWithFd(DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
Rhed Jao6b1ea2d2020-07-21 17:58:41 +08001610 ds.dump_pool_->enqueueTaskWithFd(DUMP_CHECKINS_TASK, &DumpCheckins, _1);
Rhed Jao4875aa62020-07-20 17:46:29 +08001611 }
1612
Nandana Dutt5c390032019-03-12 10:52:56 +00001613 // Dump various things. Note that anything that takes "long" (i.e. several seconds) should
1614 // check intermittently (if it's intrerruptable like a foreach on pids) and/or should be wrapped
1615 // in a consent check (via RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK).
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -07001616 dump_dev_files("TRUSTY VERSION", "/sys/bus/platform/drivers/trusty", "trusty_version");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001617 RunCommand("UPTIME", {"uptime"});
Wei Wang509bb5d2017-06-09 14:42:12 -07001618 DumpBlockStatFiles();
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001619 DumpFile("MEMORY INFO", "/proc/meminfo");
1620 RunCommand("CPU INFO", {"top", "-b", "-n", "1", "-H", "-s", "6", "-o",
Felipe Leme30dbfa12016-09-02 12:43:26 -07001621 "pid,tid,user,pr,ni,%cpu,s,virt,res,pcy,cmd,name"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001622
1623 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "PROCRANK", {"procrank"}, AS_ROOT_20);
1624
Sunny Goyal35949782019-11-19 15:54:36 -08001625 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpVisibleWindowViews);
1626
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001627 DumpFile("VIRTUAL MEMORY STATS", "/proc/vmstat");
1628 DumpFile("VMALLOC INFO", "/proc/vmallocinfo");
1629 DumpFile("SLAB INFO", "/proc/slabinfo");
1630 DumpFile("ZONEINFO", "/proc/zoneinfo");
1631 DumpFile("PAGETYPEINFO", "/proc/pagetypeinfo");
1632 DumpFile("BUDDYINFO", "/proc/buddyinfo");
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001633 DumpExternalFragmentationInfo();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001634
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001635 DumpFile("KERNEL WAKE SOURCES", "/d/wakeup_sources");
1636 DumpFile("KERNEL CPUFREQ", "/sys/devices/system/cpu/cpu0/cpufreq/stats/time_in_state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001637
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001638 RunCommand("PROCESSES AND THREADS",
Yohei Yukawa591a72d2017-10-05 21:36:35 -07001639 {"ps", "-A", "-T", "-Z", "-O", "pri,nice,rtprio,sched,pcy,time"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001640
1641 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "LIBRANK", {"librank"},
1642 CommandOptions::AS_ROOT);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001643
Rhed Jao4875aa62020-07-20 17:46:29 +08001644 if (ds.dump_pool_) {
1645 WAIT_TASK_WITH_CONSENT_CHECK(DUMP_HALS_TASK, ds.dump_pool_);
1646 } else {
1647 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_HALS_TASK, DumpHals);
1648 }
Steven Moreland81b429e2017-01-31 19:50:46 -08001649
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001650 RunCommand("PRINTENV", {"printenv"});
Elliott Hughes21b7c8d2016-10-28 08:53:02 -07001651 RunCommand("NETSTAT", {"netstat", "-nW"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001652 struct stat s;
1653 if (stat("/proc/modules", &s) != 0) {
1654 MYLOGD("Skipping 'lsmod' because /proc/modules does not exist\n");
1655 } else {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001656 RunCommand("LSMOD", {"lsmod"});
Woody Linc198f252021-05-04 16:37:11 +08001657 RunCommand("MODULES INFO",
1658 {"sh", "-c", "cat /proc/modules | cut -d' ' -f1 | "
1659 " while read MOD ; do echo modinfo:$MOD ; modinfo $MOD ; "
1660 "done"}, CommandOptions::AS_ROOT);
Felipe Lemee4eca582016-06-10 17:48:08 -07001661 }
Michal Karpinski4db754f2015-12-11 18:04:32 +00001662
Tom Cherryb87dbfa2020-07-28 11:28:53 -07001663 if (android::base::GetBoolProperty("ro.logd.kernel", false)) {
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001664 DoKernelLogcat();
1665 } else {
1666 do_dmesg();
1667 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001668
Felipe Lemef0292972016-11-22 13:57:05 -08001669 RunCommand("LIST OF OPEN FILES", {"lsof"}, CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001670
1671 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(for_each_pid, do_showmap, "SMAPS OF ALL PROCESSES");
1672
Jeff Brown1dc94e32014-09-11 14:15:27 -07001673 for_each_tid(show_wchan, "BLOCKED PROCESS WAIT-CHANNELS");
Mark Salyzyna297c322016-02-05 15:33:17 -08001674 for_each_pid(show_showtime, "PROCESS TIMES (pid cmd user system iowait+percentage)");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001675
Jack Yu5a6b2e22020-08-14 18:13:35 +08001676 /* Dump Nfc NCI logs */
1677 ds.AddDir("/data/misc/nfc/logs", true);
Ajay Panickerd886ec42016-09-14 12:26:46 -07001678
Paul Chang0d2aad72020-02-13 20:04:03 +08001679 if (ds.options_->do_screenshot && !ds.do_early_screenshot_) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001680 MYLOGI("taking late screenshot\n");
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001681 ds.TakeScreenshot();
Jeff Sharkey5a930032013-03-19 15:05:19 -07001682 }
1683
Felipe Lemee184f662016-10-27 10:04:47 -07001684 AddAnrTraceFiles();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001685
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001686 MaybeAddSystemTraceToZip();
1687
Narayan Kamath8f788292017-05-25 13:20:39 +01001688 // NOTE: tombstones are always added as separate entries in the zip archive
1689 // and are not interspersed with the main report.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001690 const bool tombstones_dumped = AddDumps(ds.tombstone_data_.begin(), ds.tombstone_data_.end(),
Narayan Kamathbd863722017-06-01 18:50:12 +01001691 "TOMBSTONE", true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001692 if (!tombstones_dumped) {
1693 printf("*** NO TOMBSTONES to dump in %s\n\n", TOMBSTONE_DIR.c_str());
Christopher Ferris7dc7f322014-07-22 16:08:19 -07001694 }
1695
Jayachandran Ca94c7172017-06-10 15:08:12 -07001696 DumpPacketStats();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001697
Chenbo Feng276a3b62018-08-07 11:44:49 -07001698 RunDumpsys("EBPF MAP STATS", {"netd", "trafficcontroller"});
1699
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001700 DoKmsg();
Mark Salyzyn2262c162014-12-16 09:09:26 -08001701
Jayachandran Ca94c7172017-06-10 15:08:12 -07001702 DumpIpAddrAndRules();
Sreeram Ramachandran2b3bba32014-07-08 15:40:55 -07001703
1704 dump_route_tables();
1705
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001706 RunCommand("ARP CACHE", {"ip", "-4", "neigh", "show"});
1707 RunCommand("IPv6 ND CACHE", {"ip", "-6", "neigh", "show"});
1708 RunCommand("MULTICAST ADDRESSES", {"ip", "maddr"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001709
Nandana Dutt5c390032019-03-12 10:52:56 +00001710 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysHigh);
Lorenzo Colitti6afc38c2015-09-09 22:59:25 +09001711
Chiachang Wang7bafd702021-05-17 17:14:20 +08001712 // The dump mechanism in connectivity is refactored due to modularization work. Connectivity can
1713 // only register with a default priority(NORMAL priority). Dumpstate has to call connectivity
1714 // dump with priority parameters to dump high priority information.
1715 RunDumpsys("SERVICE HIGH connectivity", {"connectivity", "--dump-priority", "HIGH"},
1716 CommandOptions::WithTimeout(10).Build());
1717
Elliott Hughes23ccc622017-02-28 10:14:22 -08001718 RunCommand("SYSTEM PROPERTIES", {"getprop"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001719
Jin Qianf334d662017-10-10 14:41:37 -07001720 RunCommand("STORAGED IO INFO", {"storaged", "-u", "-p"});
ynwangf649a6e2016-07-17 21:56:00 -07001721
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001722 RunCommand("FILESYSTEMS & FREE SPACE", {"df"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001723
Colin Crossf45fa6b2012-03-26 12:38:26 -07001724 /* Binder state is expensive to look at as it uses a lot of memory. */
Hridya Valsaraju920ba712020-02-09 16:27:01 -08001725 std::string binder_logs_dir = access("/dev/binderfs/binder_logs", R_OK) ?
1726 "/sys/kernel/debug/binder" : "/dev/binderfs/binder_logs";
1727
1728 DumpFile("BINDER FAILED TRANSACTION LOG", binder_logs_dir + "/failed_transaction_log");
1729 DumpFile("BINDER TRANSACTION LOG", binder_logs_dir + "/transaction_log");
1730 DumpFile("BINDER TRANSACTIONS", binder_logs_dir + "/transactions");
1731 DumpFile("BINDER STATS", binder_logs_dir + "/stats");
1732 DumpFile("BINDER STATE", binder_logs_dir + "/state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001733
Vishnu Nair36b4cdb2017-11-17 10:27:05 -08001734 /* Add window and surface trace files. */
1735 if (!PropertiesHelper::IsUserBuild()) {
1736 ds.AddDir(WMTRACE_DATA_DIR, false);
1737 }
1738
Yifan Hongcba0a4f2020-02-08 16:52:02 -08001739 ds.AddDir(SNAPSHOTCTL_LOG_DIR, false);
1740
Rhed Jao4875aa62020-07-20 17:46:29 +08001741 if (ds.dump_pool_) {
1742 WAIT_TASK_WITH_CONSENT_CHECK(DUMP_BOARD_TASK, ds.dump_pool_);
1743 } else {
1744 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
1745 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001746
Steven Moreland7440ddb2016-12-15 16:13:39 -08001747 /* Migrate the ril_dumpstate to a device specific dumpstate? */
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001748 int rilDumpstateTimeout = android::base::GetIntProperty("ril.dumpstate.timeout", 0);
1749 if (rilDumpstateTimeout > 0) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001750 // su does not exist on user builds, so try running without it.
1751 // This way any implementations of vril-dump that do not require
1752 // root can run on user builds.
1753 CommandOptions::CommandOptionsBuilder options =
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001754 CommandOptions::WithTimeout(rilDumpstateTimeout);
Felipe Lemef0292972016-11-22 13:57:05 -08001755 if (!PropertiesHelper::IsUserBuild()) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001756 options.AsRoot();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001757 }
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001758 RunCommand("DUMP VENDOR RIL LOGS", {"vril-dump"}, options.Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -07001759 }
1760
Felipe Lemed8b94e52016-12-08 10:21:44 -08001761 printf("========================================================\n");
1762 printf("== Android Framework Services\n");
1763 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001764
Nandana Dutt5c390032019-03-12 10:52:56 +00001765 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysNormal);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001766
Jack He91ff2fe2021-02-18 18:23:43 -08001767 /* Dump Bluetooth HCI logs after getting bluetooth_manager dumpsys */
1768 ds.AddDir("/data/misc/bluetooth/logs", true);
1769
Rhed Jao6b1ea2d2020-07-21 17:58:41 +08001770 if (ds.dump_pool_) {
1771 WAIT_TASK_WITH_CONSENT_CHECK(DUMP_CHECKINS_TASK, ds.dump_pool_);
1772 } else {
1773 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_CHECKINS_TASK, DumpCheckins);
1774 }
Dianne Hackborn02bea972013-06-26 18:59:09 -07001775
Rhed Jaoc5f7ec32020-12-22 22:11:08 +08001776 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpAppInfos);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001777
Adrian Roos8b397ab2017-04-04 16:35:44 -07001778 printf("========================================================\n");
1779 printf("== Dropbox crashes\n");
1780 printf("========================================================\n");
1781
1782 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1783 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1784
Felipe Lemed8b94e52016-12-08 10:21:44 -08001785 printf("========================================================\n");
1786 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1787 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1788 printf("========================================================\n");
1789 printf("== dumpstate: done (id %d)\n", ds.id_);
1790 printf("========================================================\n");
Bookatz38472142018-09-28 10:20:24 -07001791
1792 printf("========================================================\n");
1793 printf("== Obtaining statsd metadata\n");
1794 printf("========================================================\n");
1795 // This differs from the usual dumpsys stats, which is the stats report data.
1796 RunDumpsys("STATSDSTATS", {"stats", "--metadata"});
Mike Ma5c267872019-08-21 11:31:34 -07001797
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +09001798 // Add linker configuration directory
1799 ds.AddDir(LINKERCONFIG_DIR, true);
1800
Rhed Jao4875aa62020-07-20 17:46:29 +08001801 if (ds.dump_pool_) {
1802 WAIT_TASK_WITH_CONSENT_CHECK(DUMP_INCIDENT_REPORT_TASK, ds.dump_pool_);
1803 } else {
1804 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_INCIDENT_REPORT_TASK,
1805 DumpIncidentReport);
1806 }
Mike Ma5c267872019-08-21 11:31:34 -07001807
Nandana Dutt5c390032019-03-12 10:52:56 +00001808 return Dumpstate::RunStatus::OK;
Colin Crossf45fa6b2012-03-26 12:38:26 -07001809}
1810
Nandana Dutt5c390032019-03-12 10:52:56 +00001811/*
1812 * Dumps state for the default case; drops root after it's no longer necessary.
1813 *
1814 * Returns RunStatus::OK if everything went fine.
1815 * Returns RunStatus::ERROR if there was an error.
1816 * Returns RunStatus::USER_DENIED_CONSENT if user explicitly denied consent to sharing the bugreport
1817 * with the caller.
1818 */
Jichao Lie89d9c12019-11-21 19:02:51 -08001819Dumpstate::RunStatus Dumpstate::DumpstateDefaultAfterCritical() {
Nandana Duttdb379fa2019-10-09 16:54:41 +01001820 // Capture first logcat early on; useful to take a snapshot before dumpstate logs take over the
1821 // buffer.
1822 DoLogcat();
1823 // Capture timestamp after first logcat to use in next logcat
1824 time_t logcat_ts = time(nullptr);
1825
Nandana Dutt4be45d12018-09-26 15:04:23 +01001826 /* collect stack traces from Dalvik and native processes (needs root) */
Rhed Jao1c855122020-07-16 17:37:39 +08001827 if (dump_pool_) {
1828 RETURN_IF_USER_DENIED_CONSENT();
1829 // One thread is enough since we only need to enqueue DumpTraces here.
1830 dump_pool_->start(/* thread_counts = */1);
1831
1832 // DumpTraces takes long time, post it to the another thread in the
1833 // pool, if pool is available
1834 dump_pool_->enqueueTask(DUMP_TRACES_TASK, &Dumpstate::DumpTraces, &ds, &dump_traces_path);
1835 } else {
1836 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_TRACES_TASK, ds.DumpTraces,
1837 &dump_traces_path);
1838 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001839
1840 /* Run some operations that require root. */
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001841 if (!PropertiesHelper::IsDryRun()) {
1842 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX, !ds.IsZipping());
1843 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX, !ds.IsZipping());
1844 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001845
1846 ds.AddDir(RECOVERY_DIR, true);
1847 ds.AddDir(RECOVERY_DATA_DIR, true);
1848 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
1849 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1850 if (!PropertiesHelper::IsUserBuild()) {
1851 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1852 ds.AddDir(PROFILE_DATA_DIR_REF, true);
Calin Juravle78a0d842020-04-28 15:31:12 -07001853 ds.AddZipEntry(ZIP_ROOT_DIR + PACKAGE_DEX_USE_LIST, PACKAGE_DEX_USE_LIST);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001854 }
Jerry Changa1df8a92020-01-02 16:03:39 +08001855 ds.AddDir(PREREBOOT_DATA_DIR, false);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001856 add_mountinfo();
1857 DumpIpTablesAsRoot();
David Andersond9ba4752018-12-11 18:26:59 -08001858 DumpDynamicPartitionInfo();
Yifan Hong3945e1b2019-10-29 12:59:23 -07001859 ds.AddDir(OTA_METADATA_DIR, true);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001860
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001861 // Capture any IPSec policies in play. No keys are exposed here.
Nandana Dutt4be45d12018-09-26 15:04:23 +01001862 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1863
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001864 // Dump IPsec stats. No keys are exposed here.
1865 DumpFile("XFRM STATS", XFRM_STAT_PROC_FILE);
1866
Nandana Dutt4be45d12018-09-26 15:04:23 +01001867 // Run ss as root so we can see socket marks.
1868 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
1869
1870 // Run iotop as root to show top 100 IO threads
1871 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
1872
Erick Reyese68df822019-02-11 14:46:36 -08001873 // Gather shared memory buffer info if the product implements it
Hridya Valsaraju1da80c52021-01-09 22:10:11 -08001874 RunCommand("Dmabuf dump", {"dmabuf_dump"});
1875 RunCommand("Dmabuf per-buffer/per-exporter/per-device stats", {"dmabuf_dump", "-b"});
Erick Reyese68df822019-02-11 14:46:36 -08001876
Minchan Kim22c6a1e2019-09-30 15:58:10 -07001877 DumpFile("PSI cpu", "/proc/pressure/cpu");
1878 DumpFile("PSI memory", "/proc/pressure/memory");
1879 DumpFile("PSI io", "/proc/pressure/io");
1880
Rhed Jao1c855122020-07-16 17:37:39 +08001881 if (dump_pool_) {
1882 RETURN_IF_USER_DENIED_CONSENT();
1883 dump_pool_->waitForTask(DUMP_TRACES_TASK);
1884
1885 // Current running thread in the pool is the root user also. Shutdown
1886 // the pool and restart later to ensure all threads in the pool could
1887 // drop the root user.
1888 dump_pool_->shutdown();
1889 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001890 if (!DropRootUser()) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001891 return Dumpstate::RunStatus::ERROR;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001892 }
1893
Nandana Dutt5c390032019-03-12 10:52:56 +00001894 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttdb379fa2019-10-09 16:54:41 +01001895 Dumpstate::RunStatus status = dumpstate();
1896 // Capture logcat since the last time we did it.
1897 DoSystemLogcat(logcat_ts);
1898 return status;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001899}
1900
Rhed Jaoa5de5752020-08-14 17:19:17 +08001901// Common states for telephony and wifi which are needed to be collected before
1902// dumpstate drop the root user.
1903static void DumpstateRadioAsRoot() {
1904 DumpIpTablesAsRoot();
1905 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1906}
1907
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001908// This method collects common dumpsys for telephony and wifi. Typically, wifi
1909// reports are fine to include all information, but telephony reports on user
1910// builds need to strip some content (see DumpstateTelephonyOnly).
1911static void DumpstateRadioCommon(bool include_sensitive_info = true) {
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001912 // We need to be picky about some stuff for telephony reports on user builds.
1913 if (!include_sensitive_info) {
1914 // Only dump the radio log buffer (other buffers and dumps contain too much unrelated info).
1915 DoRadioLogcat();
1916 } else {
Rhed Jaoa5de5752020-08-14 17:19:17 +08001917 // DumpHals takes long time, post it to the another thread in the pool,
1918 // if pool is available.
1919 if (ds.dump_pool_) {
1920 ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
1921 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001922 // Contains various system properties and process startup info.
1923 do_dmesg();
1924 // Logs other than the radio buffer may contain package/component names and potential PII.
1925 DoLogcat();
1926 // Too broad for connectivity problems.
1927 DoKmsg();
Rhed Jaoa5de5752020-08-14 17:19:17 +08001928 // DumpHals contains unrelated hardware info (camera, NFC, biometrics, ...).
1929 if (ds.dump_pool_) {
1930 ds.dump_pool_->waitForTask(DUMP_HALS_TASK);
1931 } else {
1932 RUN_SLOW_FUNCTION_AND_LOG(DUMP_HALS_TASK, DumpHals);
1933 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001934 }
1935
Jayachandran Ca94c7172017-06-10 15:08:12 -07001936 DumpPacketStats();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001937 DumpIpAddrAndRules();
1938 dump_route_tables();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001939 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
1940 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08001941}
1942
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001943// We use "telephony" here for legacy reasons, though this now really means "connectivity" (cellular
1944// + wifi + networking). This method collects dumpsys for connectivity debugging only. General rules
1945// for what can be included on user builds: all reported information MUST directly relate to
1946// connectivity debugging or customer support and MUST NOT contain unrelated personally identifiable
1947// information. This information MUST NOT identify user-installed packages (UIDs are OK, package
1948// names are not), and MUST NOT contain logs of user application traffic.
1949// TODO(b/148168577) rename this and other related fields/methods to "connectivity" instead.
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08001950static void DumpstateTelephonyOnly(const std::string& calling_package) {
mukesh agrawal253dad42018-01-23 21:59:59 -08001951 DurationReporter duration_reporter("DUMPSTATE");
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001952
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001953 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08001954
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001955 const bool include_sensitive_info = !PropertiesHelper::IsUserBuild();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001956
Rhed Jaoa5de5752020-08-14 17:19:17 +08001957 DumpstateRadioAsRoot();
1958 if (!DropRootUser()) {
1959 return;
1960 }
1961
1962 // Starts thread pool after the root user is dropped, and two additional threads
1963 // are created for DumpHals in the DumpstateRadioCommon and DumpstateBoard.
1964 if (ds.dump_pool_) {
1965 ds.dump_pool_->start(/*thread_counts =*/2);
1966
1967 // DumpstateBoard takes long time, post it to the another thread in the pool,
1968 // if pool is available.
1969 ds.dump_pool_->enqueueTaskWithFd(DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
1970 }
1971
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001972 DumpstateRadioCommon(include_sensitive_info);
1973
1974 if (include_sensitive_info) {
1975 // Contains too much unrelated PII, and given the unstructured nature of sysprops, we can't
1976 // really cherrypick all of the connectivity-related ones. Apps generally have no business
1977 // reading these anyway, and there should be APIs to supply the info in a more app-friendly
1978 // way.
1979 RunCommand("SYSTEM PROPERTIES", {"getprop"});
1980 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07001981
1982 printf("========================================================\n");
1983 printf("== Android Framework Services\n");
1984 printf("========================================================\n");
1985
Vishnu Nair652cc802017-11-30 15:18:30 -08001986 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1987 SEC_TO_MSEC(10));
Hunter Knepshield31cbae12021-05-11 16:23:24 -07001988 RunDumpsys("DUMPSYS", {"vcn_management"}, CommandOptions::WithTimeout(90).Build(),
1989 SEC_TO_MSEC(10));
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08001990 if (include_sensitive_info) {
1991 // Carrier apps' services will be dumped below in dumpsys activity service all-non-platform.
1992 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
1993 SEC_TO_MSEC(10));
1994 } else {
1995 // If the caller is a carrier app and has a carrier service, dump it here since we aren't
1996 // running dumpsys activity service all-non-platform below. Due to the increased output, we
1997 // give a higher timeout as well.
1998 RunDumpsys("DUMPSYS", {"carrier_config", "--requesting-package", calling_package},
1999 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(30));
2000 }
2001 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002002 RunDumpsys("DUMPSYS", {"netpolicy"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
2003 RunDumpsys("DUMPSYS", {"network_management"}, CommandOptions::WithTimeout(90).Build(),
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07002004 SEC_TO_MSEC(10));
Hunter Knepshield0fe51b12020-03-05 16:58:20 -08002005 RunDumpsys("DUMPSYS", {"telephony.registry"}, CommandOptions::WithTimeout(90).Build(),
2006 SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002007 if (include_sensitive_info) {
2008 // Contains raw IP addresses, omit from reports on user builds.
2009 RunDumpsys("DUMPSYS", {"netd"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
2010 // Contains raw destination IP/MAC addresses, omit from reports on user builds.
2011 RunDumpsys("DUMPSYS", {"connmetrics"}, CommandOptions::WithTimeout(90).Build(),
2012 SEC_TO_MSEC(10));
2013 // Contains package/component names, omit from reports on user builds.
2014 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
2015 SEC_TO_MSEC(10));
2016 // Contains package names, but should be relatively simple to remove them (also contains
2017 // UIDs already), omit from reports on user builds.
2018 RunDumpsys("BATTERYSTATS", {"deviceidle"}, CommandOptions::WithTimeout(90).Build(),
2019 SEC_TO_MSEC(10));
2020 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002021
2022 printf("========================================================\n");
2023 printf("== Running Application Services\n");
2024 printf("========================================================\n");
2025
2026 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
2027
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002028 if (include_sensitive_info) {
2029 printf("========================================================\n");
2030 printf("== Running Application Services (non-platform)\n");
2031 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002032
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002033 // Contains package/component names and potential PII, omit from reports on user builds.
2034 // To get dumps of the active CarrierService(s) on user builds, we supply an argument to the
2035 // carrier_config dumpsys instead.
2036 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
2037 DUMPSYS_COMPONENTS_OPTIONS);
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002038
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002039 printf("========================================================\n");
2040 printf("== Checkins\n");
2041 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002042
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002043 // Contains package/component names, omit from reports on user builds.
2044 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
2045 }
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002046
2047 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07002048 printf("== dumpstate: done (id %d)\n", ds.id_);
2049 printf("========================================================\n");
Rhed Jaoa5de5752020-08-14 17:19:17 +08002050
2051 if (ds.dump_pool_) {
2052 ds.dump_pool_->waitForTask(DUMP_BOARD_TASK);
2053 } else {
2054 RUN_SLOW_FUNCTION_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
2055 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002056}
2057
mukesh agrawal253dad42018-01-23 21:59:59 -08002058// This method collects dumpsys for wifi debugging only
2059static void DumpstateWifiOnly() {
2060 DurationReporter duration_reporter("DUMPSTATE");
2061
Rhed Jaoa5de5752020-08-14 17:19:17 +08002062 DumpstateRadioAsRoot();
2063 if (!DropRootUser()) {
2064 return;
2065 }
2066
2067 // Starts thread pool after the root user is dropped. Only one additional
2068 // thread is needed for DumpHals in the DumpstateRadioCommon.
2069 if (ds.dump_pool_) {
2070 ds.dump_pool_->start(/*thread_counts =*/1);
2071 }
2072
mukesh agrawal253dad42018-01-23 21:59:59 -08002073 DumpstateRadioCommon();
2074
2075 printf("========================================================\n");
2076 printf("== Android Framework Services\n");
2077 printf("========================================================\n");
2078
2079 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
2080 SEC_TO_MSEC(10));
2081 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
2082 SEC_TO_MSEC(10));
2083
2084 printf("========================================================\n");
2085 printf("== dumpstate: done (id %d)\n", ds.id_);
2086 printf("========================================================\n");
2087}
2088
Nandana Duttcf419a72019-03-14 10:40:17 +00002089Dumpstate::RunStatus Dumpstate::DumpTraces(const char** path) {
Gavin Corkery789d7a52021-02-24 23:52:35 +00002090 const std::string temp_file_pattern = ds.bugreport_internal_dir_ + "/dumptrace_XXXXXX";
Nandana Duttfaafd522019-03-11 09:23:09 +00002091 const size_t buf_size = temp_file_pattern.length() + 1;
2092 std::unique_ptr<char[]> file_name_buf(new char[buf_size]);
2093 memcpy(file_name_buf.get(), temp_file_pattern.c_str(), buf_size);
2094
2095 // Create a new, empty file to receive all trace dumps.
2096 //
2097 // TODO: This can be simplified once we remove support for the old style
2098 // dumps. We can have a file descriptor passed in to dump_traces instead
2099 // of creating a file, closing it and then reopening it again.
2100 android::base::unique_fd fd(mkostemp(file_name_buf.get(), O_APPEND | O_CLOEXEC));
2101 if (fd < 0) {
2102 MYLOGE("mkostemp on pattern %s: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002103 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002104 }
2105
2106 // Nobody should have access to this temporary file except dumpstate, but we
2107 // temporarily grant 'read' to 'others' here because this file is created
2108 // when tombstoned is still running as root, but dumped after dropping. This
2109 // can go away once support for old style dumping has.
2110 const int chmod_ret = fchmod(fd, 0666);
2111 if (chmod_ret < 0) {
2112 MYLOGE("fchmod on %s failed: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002113 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002114 }
2115
2116 std::unique_ptr<DIR, decltype(&closedir)> proc(opendir("/proc"), closedir);
2117 if (proc.get() == nullptr) {
2118 MYLOGE("opendir /proc failed: %s\n", strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002119 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002120 }
2121
2122 // Number of times process dumping has timed out. If we encounter too many
2123 // failures, we'll give up.
2124 int timeout_failures = 0;
2125 bool dalvik_found = false;
2126
2127 const std::set<int> hal_pids = get_interesting_hal_pids();
2128
2129 struct dirent* d;
2130 while ((d = readdir(proc.get()))) {
Nandana Duttcf419a72019-03-14 10:40:17 +00002131 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttfaafd522019-03-11 09:23:09 +00002132 int pid = atoi(d->d_name);
2133 if (pid <= 0) {
2134 continue;
2135 }
2136
2137 const std::string link_name = android::base::StringPrintf("/proc/%d/exe", pid);
2138 std::string exe;
2139 if (!android::base::Readlink(link_name, &exe)) {
2140 continue;
2141 }
2142
2143 bool is_java_process;
2144 if (exe == "/system/bin/app_process32" || exe == "/system/bin/app_process64") {
2145 // Don't bother dumping backtraces for the zygote.
2146 if (IsZygote(pid)) {
2147 continue;
2148 }
2149
2150 dalvik_found = true;
2151 is_java_process = true;
2152 } else if (should_dump_native_traces(exe.c_str()) || hal_pids.find(pid) != hal_pids.end()) {
2153 is_java_process = false;
2154 } else {
2155 // Probably a native process we don't care about, continue.
2156 continue;
2157 }
2158
2159 // If 3 backtrace dumps fail in a row, consider debuggerd dead.
2160 if (timeout_failures == 3) {
2161 dprintf(fd, "ERROR: Too many stack dump failures, exiting.\n");
2162 break;
2163 }
2164
2165 const uint64_t start = Nanotime();
2166 const int ret = dump_backtrace_to_file_timeout(
2167 pid, is_java_process ? kDebuggerdJavaBacktrace : kDebuggerdNativeBacktrace,
2168 is_java_process ? 5 : 20, fd);
2169
2170 if (ret == -1) {
2171 // For consistency, the header and footer to this message match those
2172 // dumped by debuggerd in the success case.
2173 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
2174 dprintf(fd, "Dump failed, likely due to a timeout.\n");
2175 dprintf(fd, "---- end %d ----", pid);
2176 timeout_failures++;
2177 continue;
2178 }
2179
2180 // We've successfully dumped stack traces, reset the failure count
2181 // and write a summary of the elapsed time to the file and continue with the
2182 // next process.
2183 timeout_failures = 0;
2184
2185 dprintf(fd, "[dump %s stack %d: %.3fs elapsed]\n", is_java_process ? "dalvik" : "native",
2186 pid, (float)(Nanotime() - start) / NANOS_PER_SEC);
2187 }
2188
2189 if (!dalvik_found) {
2190 MYLOGE("Warning: no Dalvik processes found to dump stacks\n");
2191 }
2192
Nandana Duttcf419a72019-03-14 10:40:17 +00002193 *path = file_name_buf.release();
2194 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002195}
2196
Rhed Jao4875aa62020-07-20 17:46:29 +08002197void Dumpstate::DumpstateBoard(int out_fd) {
2198 dprintf(out_fd, "========================================================\n");
2199 dprintf(out_fd, "== Board\n");
2200 dprintf(out_fd, "========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08002201
Felipe Leme6f674ae2016-11-18 17:10:33 -08002202 if (!IsZipping()) {
Steven Moreland7440ddb2016-12-15 16:13:39 -08002203 MYLOGD("Not dumping board info because it's not a zipped bugreport\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08002204 return;
2205 }
2206
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002207 /*
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002208 * mount debugfs for non-user builds with ro.product.debugfs_restrictions.enabled
Hridya Valsaraju51101602021-04-02 14:32:46 -07002209 * set to true and unmount it after invoking dumpstateBoard_* methods.
2210 * This is to enable debug builds to not have debugfs mounted during runtime.
2211 * It will also ensure that debugfs is only accessed by the dumpstate HAL.
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002212 */
Hridya Valsaraju51101602021-04-02 14:32:46 -07002213 auto mount_debugfs =
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002214 android::base::GetBoolProperty("ro.product.debugfs_restrictions.enabled", false);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002215 if (mount_debugfs) {
2216 RunCommand("mount debugfs", {"mount", "-t", "debugfs", "debugfs", "/sys/kernel/debug"},
2217 AS_ROOT_20);
2218 RunCommand("chmod debugfs", {"chmod", "0755", "/sys/kernel/debug"},
2219 AS_ROOT_20);
2220 }
2221
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002222 std::vector<std::string> paths;
2223 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07002224 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002225 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
2226 kDumpstateBoardFiles[i].c_str()));
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002227 remover.emplace_back(android::base::make_scope_guard(
2228 std::bind([](std::string path) { android::os::UnlinkAndLogOnError(path); }, paths[i])));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002229 }
Jie Song9fbfad02017-06-20 16:29:42 -07002230
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002231 sp<IDumpstateDevice_1_0> dumpstate_device_1_0(IDumpstateDevice_1_0::getService());
2232 if (dumpstate_device_1_0 == nullptr) {
Wei Wang587eac92018-04-05 12:17:20 -07002233 MYLOGE("No IDumpstateDevice implementation\n");
2234 return;
2235 }
2236
2237 using ScopedNativeHandle =
2238 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
2239 ScopedNativeHandle handle(native_handle_create(static_cast<int>(paths.size()), 0),
2240 [](native_handle_t* handle) {
2241 native_handle_close(handle);
2242 native_handle_delete(handle);
2243 });
2244 if (handle == nullptr) {
2245 MYLOGE("Could not create native_handle\n");
2246 return;
2247 }
2248
Nandana Dutt5c390032019-03-12 10:52:56 +00002249 // TODO(128270426): Check for consent in between?
Wei Wang587eac92018-04-05 12:17:20 -07002250 for (size_t i = 0; i < paths.size(); i++) {
2251 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
2252
2253 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
2254 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
2255 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
2256 if (fd < 0) {
2257 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
2258 return;
2259 }
2260 handle.get()->data[i] = fd.release();
2261 }
2262
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002263 // Given that bugreport is required to diagnose failures, it's better to set an arbitrary amount
2264 // of timeout for IDumpstateDevice than to block the rest of bugreport. In the timeout case, we
2265 // will kill the HAL and grab whatever it dumped in time.
2266 constexpr size_t timeout_sec = 30;
2267 // Prefer version 1.1 if available. New devices launching with R are no longer allowed to
2268 // implement just 1.0.
2269 const char* descriptor_to_kill;
2270 using DumpstateBoardTask = std::packaged_task<bool()>;
2271 DumpstateBoardTask dumpstate_board_task;
2272 sp<IDumpstateDevice_1_1> dumpstate_device_1_1(
2273 IDumpstateDevice_1_1::castFrom(dumpstate_device_1_0));
2274 if (dumpstate_device_1_1 != nullptr) {
2275 MYLOGI("Using IDumpstateDevice v1.1");
2276 descriptor_to_kill = IDumpstateDevice_1_1::descriptor;
2277 dumpstate_board_task = DumpstateBoardTask([this, dumpstate_device_1_1, &handle]() -> bool {
2278 ::android::hardware::Return<DumpstateStatus> status =
2279 dumpstate_device_1_1->dumpstateBoard_1_1(handle.get(), options_->dumpstate_hal_mode,
2280 SEC_TO_MSEC(timeout_sec));
2281 if (!status.isOk()) {
2282 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2283 return false;
2284 } else if (status != DumpstateStatus::OK) {
2285 MYLOGE("dumpstateBoard failed with DumpstateStatus::%s\n", toString(status).c_str());
2286 return false;
2287 }
2288 return true;
2289 });
2290 } else {
2291 MYLOGI("Using IDumpstateDevice v1.0");
2292 descriptor_to_kill = IDumpstateDevice_1_0::descriptor;
2293 dumpstate_board_task = DumpstateBoardTask([dumpstate_device_1_0, &handle]() -> bool {
2294 ::android::hardware::Return<void> status =
2295 dumpstate_device_1_0->dumpstateBoard(handle.get());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002296 if (!status.isOk()) {
2297 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
Wei Wang587eac92018-04-05 12:17:20 -07002298 return false;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002299 }
Wei Wang587eac92018-04-05 12:17:20 -07002300 return true;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002301 });
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002302 }
2303 auto result = dumpstate_board_task.get_future();
2304 std::thread(std::move(dumpstate_board_task)).detach();
Wei Wang587eac92018-04-05 12:17:20 -07002305
Wei Wang587eac92018-04-05 12:17:20 -07002306 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2307 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate vendor HAL\n", timeout_sec);
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002308 if (!android::base::SetProperty(
2309 "ctl.interface_restart",
2310 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
Wei Wang587eac92018-04-05 12:17:20 -07002311 MYLOGE("Couldn't restart dumpstate HAL\n");
2312 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002313 }
Wei Wang587eac92018-04-05 12:17:20 -07002314 // 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("killing dumpstateBoard timed out after %zus, continue and "
2318 "there might be racing in content\n", killing_timeout_sec);
2319 }
2320
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002321 if (mount_debugfs) {
Hridya Valsaraju51101602021-04-02 14:32:46 -07002322 auto keep_debugfs_mounted =
2323 android::base::GetProperty("persist.dbg.keep_debugfs_mounted", "");
2324 if (keep_debugfs_mounted.empty())
2325 RunCommand("unmount debugfs", {"umount", "/sys/kernel/debug"}, AS_ROOT_20);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002326 }
2327
Wei Wang587eac92018-04-05 12:17:20 -07002328 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
2329 for (size_t i = 0; i < paths.size(); i++) {
2330 struct stat s;
2331 if (fstat(handle.get()->data[i], &s) == -1) {
2332 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(),
2333 strerror(errno));
2334 file_sizes[i] = -1;
2335 continue;
2336 }
2337 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002338 }
2339
2340 for (size_t i = 0; i < paths.size(); i++) {
2341 if (file_sizes[i] == -1) {
2342 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002343 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002344 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07002345 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002346 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002347 }
Rhed Jao4875aa62020-07-20 17:46:29 +08002348 remover[i].Disable();
2349 EnqueueAddZipEntryAndCleanupIfNeeded(kDumpstateBoardFiles[i], paths[i]);
2350 dprintf(out_fd, "*** See %s entry ***\n", kDumpstateBoardFiles[i].c_str());
Jie Song9fbfad02017-06-20 16:29:42 -07002351 }
Felipe Leme6f674ae2016-11-18 17:10:33 -08002352}
2353
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002354static void ShowUsage() {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002355 fprintf(stderr,
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002356 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-o directory] [-p] "
2357 "[-s] [-S] [-q] [-P] [-R] [-L] [-V version]\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002358 " -h: display this help message\n"
2359 " -b: play sound file instead of vibrate, at beginning of job\n"
2360 " -e: play sound file instead of vibrate, at end of job\n"
mhasank2d75c442020-06-11 15:05:25 -07002361 " -o: write to custom directory (only in limited mode)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01002362 " -p: capture screenshot to filename.png\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002363 " -s: write zipped file to control socket (for init)\n"
2364 " -S: write file location to control socket (for init)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002365 " -q: disable vibrate\n"
Abhijeet Kaure370d682019-10-01 16:49:30 +01002366 " -P: send broadcast when started and do progress updates\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002367 " -R: take bugreport in remote mode (shouldn't be used with -P)\n"
Nandana Dutt235864b2019-01-22 12:10:16 +00002368 " -w: start binder service and make it wait for a call to startBugreport\n"
mhasankd451a472020-05-26 18:02:39 -07002369 " -L: output limited information that is safe for submission in feedback reports\n"
Felipe Lemed071c682016-10-20 16:48:00 -07002370 " -v: prints the dumpstate header and exit\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002371}
2372
Wei Liuf87959e2016-08-26 14:51:42 -07002373static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07002374 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07002375}
2376
Felipe Leme1d486fe2016-10-14 18:06:47 -07002377bool Dumpstate::FinishZipFile() {
Rhed Jao4875aa62020-07-20 17:46:29 +08002378 // Runs all enqueued adding zip entry and cleanup tasks before finishing the zip file.
2379 if (zip_entry_tasks_) {
2380 zip_entry_tasks_->run(/* do_cancel = */false);
2381 }
2382
Felipe Leme9a523ae2016-10-20 15:10:33 -07002383 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07002384 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07002385 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002386 // Final timestamp
2387 char date[80];
2388 time_t the_real_now_please_stand_up = time(nullptr);
2389 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002390 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07002391 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002392
Felipe Leme9a523ae2016-10-20 15:10:33 -07002393 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002394 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08002395 return false;
2396 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07002397 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002398 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08002399 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08002400 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08002401
Felipe Leme0f3fb202016-06-10 17:10:53 -07002402 // Add log file (which contains stderr output) to zip...
2403 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07002404 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07002405 MYLOGE("Failed to add dumpstate log to .zip file\n");
2406 return false;
2407 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002408 // TODO: Should truncate the existing file.
2409 // ... and re-open it for further logging.
Nandana Dutta344cb62019-02-22 15:12:35 +00002410 if (!redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()))) {
2411 return false;
2412 }
Felipe Leme0f3fb202016-06-10 17:10:53 -07002413 fprintf(stderr, "\n");
2414
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002415 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07002416 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002417 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002418 return false;
2419 }
2420
Felipe Leme1d486fe2016-10-14 18:06:47 -07002421 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
2422 ds.zip_file.reset(nullptr);
2423
Felipe Lemee9d2c542016-11-15 11:48:26 -08002424 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002425 android::os::UnlinkAndLogOnError(tmp_path_);
Felipe Lemec4eee562016-04-21 15:42:55 -07002426
Felipe Leme1e9edc62015-12-21 16:02:13 -08002427 return true;
2428}
Felipe Leme6e01fa62015-11-11 19:35:14 -08002429
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002430static void SendBroadcast(const std::string& action, const std::vector<std::string>& args) {
2431 // clang-format off
2432 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user", "0",
2433 "--receiver-foreground", "--receiver-include-background", "-a", action};
2434 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08002435
2436 am.insert(am.end(), args.begin(), args.end());
2437
Felipe Leme8d2410e2017-02-08 09:46:08 -08002438 RunCommand("", am,
2439 CommandOptions::WithTimeout(20)
2440 .Log("Sending broadcast: '%s'\n")
2441 .Always()
2442 .DropRoot()
2443 .RedirectStderr()
2444 .Build());
2445}
2446
Felipe Leme35b8cf12017-02-10 15:47:29 -08002447static void Vibrate(int duration_ms) {
2448 // clang-format off
Chris Fries0c3de872019-09-14 15:49:41 +00002449 RunCommand("", {"cmd", "vibrator", "vibrate", "-f", std::to_string(duration_ms), "dumpstate"},
Felipe Leme35b8cf12017-02-10 15:47:29 -08002450 CommandOptions::WithTimeout(10)
2451 .Log("Vibrate: '%s'\n")
2452 .Always()
2453 .Build());
2454 // clang-format on
2455}
2456
Nandana Dutt979388e2018-11-30 16:48:55 +00002457static void MaybeResolveSymlink(std::string* path) {
2458 std::string resolved_path;
2459 if (android::base::Readlink(*path, &resolved_path)) {
2460 *path = resolved_path;
2461 }
2462}
2463
Nandana Dutt4be45d12018-09-26 15:04:23 +01002464/*
2465 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002466 * and adds the version file. Return false if zip_file could not be open to write.
Nandana Dutt4be45d12018-09-26 15:04:23 +01002467 */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002468static bool PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002469 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
2470
Nandana Dutt4be45d12018-09-26 15:04:23 +01002471 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
2472 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002473 ds.base_name_ = StringPrintf("bugreport-%s-%s", device_name.c_str(), build_id.c_str());
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002474 char date[80];
2475 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
2476 ds.name_ = date;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002477
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002478 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002479 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002480 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002481 ds.base_name_ += "-wifi";
2482 }
2483
Paul Chang0d2aad72020-02-13 20:04:03 +08002484 if (ds.options_->do_screenshot) {
Nandana Dutt9d17b942020-03-26 10:02:59 +00002485 ds.screenshot_path_ = ds.GetPath(ds.CalledByApi() ? "-png.tmp" : ".png");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002486 }
2487 ds.tmp_path_ = ds.GetPath(".tmp");
2488 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
2489
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002490 std::string destination = ds.CalledByApi()
Nandana Dutt54dbd672019-01-11 12:58:05 +00002491 ? StringPrintf("[fd:%d]", ds.options_->bugreport_fd.get())
Nandana Dutt9a76d202019-01-21 15:56:48 +00002492 : ds.bugreport_internal_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01002493 MYLOGD(
Nandana Dutt235c6672019-11-14 15:22:32 +00002494 "Bugreport dir: [%s] "
2495 "Base name: [%s] "
2496 "Suffix: [%s] "
2497 "Log path: [%s] "
2498 "Temporary path: [%s] "
2499 "Screenshot path: [%s]\n",
Nandana Dutt9a76d202019-01-21 15:56:48 +00002500 destination.c_str(), ds.base_name_.c_str(), ds.name_.c_str(), ds.log_path_.c_str(),
2501 ds.tmp_path_.c_str(), ds.screenshot_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002502
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002503 ds.path_ = ds.GetPath(ds.CalledByApi() ? "-zip.tmp" : ".zip");
2504 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
2505 create_parent_dirs(ds.path_.c_str());
2506 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
2507 if (ds.zip_file == nullptr) {
2508 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
2509 return false;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002510 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002511 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
2512 ds.AddTextZipEntry("version.txt", ds.version_);
2513 return true;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002514}
2515
2516/*
Abhijeet Kaure370d682019-10-01 16:49:30 +01002517 * Finalizes writing to the file by zipping the tmp file to the final location,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002518 * printing zipped file status, etc.
2519 */
2520static void FinalizeFile() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002521 bool do_text_file = !ds.FinishZipFile();
2522 if (do_text_file) {
2523 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002524 }
mhasank2d75c442020-06-11 15:05:25 -07002525
2526 std::string final_path = ds.path_;
2527 if (ds.options_->OutputToCustomFile()) {
mhasank3a4cfb42020-06-15 18:06:43 -07002528 final_path = ds.GetPath(ds.options_->out_dir, ".zip");
mhasank2d75c442020-06-11 15:05:25 -07002529 android::os::CopyFileToFile(ds.path_, final_path);
Nandana Dutt4be45d12018-09-26 15:04:23 +01002530 }
mhasank2d75c442020-06-11 15:05:25 -07002531
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002532 if (ds.options_->stream_to_socket) {
2533 android::os::CopyFileToFd(ds.path_, ds.control_socket_fd_);
2534 } else if (ds.options_->progress_updates_to_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002535 if (do_text_file) {
2536 dprintf(ds.control_socket_fd_,
2537 "FAIL:could not create zip file, check %s "
2538 "for more details\n",
2539 ds.log_path_.c_str());
2540 } else {
mhasank2d75c442020-06-11 15:05:25 -07002541 dprintf(ds.control_socket_fd_, "OK:%s\n", final_path.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002542 }
2543 }
2544}
2545
Nandana Dutt4be45d12018-09-26 15:04:23 +01002546
Nandana Dutt58d72e22018-11-16 10:30:48 +00002547static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2548 switch (mode) {
2549 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2550 return "BUGREPORT_FULL";
2551 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2552 return "BUGREPORT_INTERACTIVE";
2553 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2554 return "BUGREPORT_REMOTE";
2555 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2556 return "BUGREPORT_WEAR";
2557 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2558 return "BUGREPORT_TELEPHONY";
2559 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2560 return "BUGREPORT_WIFI";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002561 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2562 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002563 }
2564}
2565
Paul Changf59c2b72020-03-10 02:08:55 +08002566static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options,
2567 bool is_screenshot_requested) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002568 // Modify com.android.shell.BugreportProgressService#isDefaultScreenshotRequired as well for
2569 // default system screenshots.
Abhijeet Kaure370d682019-10-01 16:49:30 +01002570 options->bugreport_mode = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002571 switch (mode) {
2572 case Dumpstate::BugreportMode::BUGREPORT_FULL:
Paul Changf59c2b72020-03-10 02:08:55 +08002573 options->do_screenshot = is_screenshot_requested;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002574 options->dumpstate_hal_mode = DumpstateMode::FULL;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002575 break;
2576 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002577 // Currently, the dumpstate binder is only used by Shell to update progress.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002578 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002579 options->do_screenshot = is_screenshot_requested;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002580 options->dumpstate_hal_mode = DumpstateMode::INTERACTIVE;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002581 break;
2582 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002583 options->do_vibrate = false;
2584 options->is_remote_mode = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002585 options->do_screenshot = false;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002586 options->dumpstate_hal_mode = DumpstateMode::REMOTE;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002587 break;
2588 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002589 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002590 options->do_screenshot = is_screenshot_requested;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002591 options->dumpstate_hal_mode = DumpstateMode::WEAR;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002592 break;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002593 // TODO(b/148168577) rename TELEPHONY everywhere to CONNECTIVITY.
Nandana Dutt58d72e22018-11-16 10:30:48 +00002594 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002595 options->telephony_only = true;
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002596 options->do_progress_updates = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002597 options->do_screenshot = false;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002598 options->dumpstate_hal_mode = DumpstateMode::CONNECTIVITY;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002599 break;
2600 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002601 options->wifi_only = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002602 options->do_screenshot = false;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002603 options->dumpstate_hal_mode = DumpstateMode::WIFI;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002604 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002605 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2606 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002607 }
2608}
2609
Nandana Dutt58d72e22018-11-16 10:30:48 +00002610static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
Nandana Dutt235c6672019-11-14 15:22:32 +00002611 MYLOGI(
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002612 "do_vibrate: %d stream_to_socket: %d progress_updates_to_socket: %d do_screenshot: %d "
Rhed Jao6f5ddce2020-08-20 00:10:32 +08002613 "is_remote_mode: %d show_header_only: %d telephony_only: %d "
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002614 "wifi_only: %d do_progress_updates: %d fd: %d bugreport_mode: %s dumpstate_hal_mode: %s "
mhasankd451a472020-05-26 18:02:39 -07002615 "limited_only: %d args: %s\n",
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002616 options.do_vibrate, options.stream_to_socket, options.progress_updates_to_socket,
Paul Chang0d2aad72020-02-13 20:04:03 +08002617 options.do_screenshot, options.is_remote_mode, options.show_header_only,
Rhed Jao6f5ddce2020-08-20 00:10:32 +08002618 options.telephony_only, options.wifi_only,
mhasankd451a472020-05-26 18:02:39 -07002619 options.do_progress_updates, options.bugreport_fd.get(), options.bugreport_mode.c_str(),
2620 toString(options.dumpstate_hal_mode).c_str(), options.limited_only, options.args.c_str());
Nandana Dutt58d72e22018-11-16 10:30:48 +00002621}
2622
Nandana Dutt54dbd672019-01-11 12:58:05 +00002623void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode,
2624 const android::base::unique_fd& bugreport_fd_in,
Paul Changf59c2b72020-03-10 02:08:55 +08002625 const android::base::unique_fd& screenshot_fd_in,
2626 bool is_screenshot_requested) {
Nandana Dutt54dbd672019-01-11 12:58:05 +00002627 // Duplicate the fds because the passed in fds don't outlive the binder transaction.
2628 bugreport_fd.reset(dup(bugreport_fd_in.get()));
2629 screenshot_fd.reset(dup(screenshot_fd_in.get()));
Nandana Dutt58d72e22018-11-16 10:30:48 +00002630
Paul Changf59c2b72020-03-10 02:08:55 +08002631 SetOptionsFromMode(bugreport_mode, this, is_screenshot_requested);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002632}
2633
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002634Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
2635 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002636 int c;
mhasankd451a472020-05-26 18:02:39 -07002637 while ((c = getopt(argc, argv, "dho:svqzpLPBRSV:w")) != -1) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002638 switch (c) {
2639 // clang-format off
mhasank3a4cfb42020-06-15 18:06:43 -07002640 case 'o': out_dir = optarg; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002641 case 's': stream_to_socket = true; break;
2642 case 'S': progress_updates_to_socket = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002643 case 'v': show_header_only = true; break;
2644 case 'q': do_vibrate = false; break;
Paul Chang0d2aad72020-02-13 20:04:03 +08002645 case 'p': do_screenshot = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002646 case 'P': do_progress_updates = true; break;
2647 case 'R': is_remote_mode = true; break;
mhasankd451a472020-05-26 18:02:39 -07002648 case 'L': limited_only = true; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002649 case 'V':
2650 case 'd':
2651 case 'z':
2652 // compatibility no-op
2653 break;
Nandana Dutt235864b2019-01-22 12:10:16 +00002654 case 'w':
2655 // This was already processed
2656 break;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002657 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002658 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002659 break;
2660 default:
2661 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002662 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002663 break;
2664 // clang-format on
2665 }
2666 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08002667
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002668 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002669 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002670 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002671 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002672 }
2673 }
2674
2675 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
2676 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002677
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002678 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002679}
2680
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002681bool Dumpstate::DumpOptions::ValidateOptions() const {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002682 if (bugreport_fd.get() != -1 && stream_to_socket) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002683 return false;
2684 }
2685
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002686 if ((progress_updates_to_socket || do_progress_updates) && stream_to_socket) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002687 return false;
2688 }
2689
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002690 if (is_remote_mode && (do_progress_updates || stream_to_socket)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002691 return false;
2692 }
2693 return true;
2694}
2695
Nandana Dutt197661d2018-11-16 16:40:21 +00002696void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
2697 options_ = std::move(options);
2698}
2699
Abhijeet Kaura407fb82020-03-27 12:51:12 +00002700void Dumpstate::Initialize() {
2701 /* gets the sequential id */
2702 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
2703 id_ = ++last_id;
2704 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
2705}
2706
Nandana Duttd2f5f082019-01-18 17:13:52 +00002707Dumpstate::RunStatus Dumpstate::Run(int32_t calling_uid, const std::string& calling_package) {
2708 Dumpstate::RunStatus status = RunInternal(calling_uid, calling_package);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002709 if (listener_ != nullptr) {
2710 switch (status) {
2711 case Dumpstate::RunStatus::OK:
Nandana Duttcc4ead82019-01-23 08:29:23 +00002712 listener_->onFinished();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002713 break;
2714 case Dumpstate::RunStatus::HELP:
2715 break;
2716 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002717 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_INVALID_INPUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002718 break;
2719 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002720 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_RUNTIME_ERROR);
2721 break;
2722 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2723 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_DENIED_CONSENT);
2724 break;
2725 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
2726 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_CONSENT_TIMED_OUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002727 break;
2728 }
2729 }
2730 return status;
2731}
2732
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002733void Dumpstate::Cancel() {
2734 CleanupTmpFiles();
2735 android::os::UnlinkAndLogOnError(log_path_);
2736 for (int i = 0; i < NUM_OF_DUMPS; i++) {
2737 android::os::UnlinkAndLogOnError(ds.bugreport_internal_dir_ + "/" +
2738 kDumpstateBoardFiles[i]);
2739 }
2740 tombstone_data_.clear();
2741 anr_data_.clear();
Rhed Jaoe96bcd52020-08-21 14:48:20 +08002742
2743 // Instead of shutdown the pool, we delete temporary files directly since
2744 // shutdown blocking the call.
2745 if (dump_pool_) {
2746 dump_pool_->deleteTempFiles();
2747 }
2748 if (zip_entry_tasks_) {
2749 zip_entry_tasks_->run(/*do_cancel =*/ true);
2750 }
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002751}
2752
Nandana Dutt979388e2018-11-30 16:48:55 +00002753/*
2754 * Dumps relevant information to a bugreport based on the given options.
2755 *
2756 * The bugreport can be dumped to a file or streamed to a socket.
2757 *
2758 * How dumping to file works:
2759 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
2760 * stderr is redirected a log file.
2761 *
2762 * The temporary bugreport is then populated via printfs, dumping contents of files and
2763 * output of commands to stdout.
2764 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002765 * A bunch of other files and dumps are added to the zip archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00002766 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002767 * The temporary bugreport file and the log file also get added to the archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00002768 *
mhasank2d75c442020-06-11 15:05:25 -07002769 * Bugreports are first generated in a local directory and later copied to the caller's fd
2770 * or directory if supplied.
Nandana Dutt979388e2018-11-30 16:48:55 +00002771 */
Nandana Duttd2f5f082019-01-18 17:13:52 +00002772Dumpstate::RunStatus Dumpstate::RunInternal(int32_t calling_uid,
2773 const std::string& calling_package) {
Rhed Jao1c855122020-07-16 17:37:39 +08002774 DurationReporter duration_reporter("RUN INTERNAL", /* logcat_only = */true);
Nandana Dutt979388e2018-11-30 16:48:55 +00002775 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00002776 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002777 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002778 return RunStatus::INVALID_INPUT;
2779 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002780 /* set as high priority, and protect from OOM killer */
2781 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002782
Felipe Lemed071c682016-10-20 16:48:00 -07002783 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002784 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002785 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002786 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002787 } else {
2788 /* fallback to kernels <= 2.6.35 */
2789 oom_adj = fopen("/proc/self/oom_adj", "we");
2790 if (oom_adj) {
2791 fputs("-17", oom_adj);
2792 fclose(oom_adj);
2793 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002794 }
2795
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002796 if (version_ == VERSION_DEFAULT) {
2797 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00002798 }
2799
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002800 if (version_ != VERSION_CURRENT && version_ != VERSION_SPLIT_ANR) {
Vishnu Nair64afc022018-02-01 15:29:34 -08002801 MYLOGE("invalid version requested ('%s'); suppported values are: ('%s', '%s', '%s')\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002802 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str(),
Vishnu Nair64afc022018-02-01 15:29:34 -08002803 VERSION_SPLIT_ANR.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002804 return RunStatus::INVALID_INPUT;
Felipe Lemed071c682016-10-20 16:48:00 -07002805 }
2806
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002807 if (options_->show_header_only) {
2808 PrintHeader();
2809 return RunStatus::OK;
Felipe Lemed071c682016-10-20 16:48:00 -07002810 }
2811
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002812 MYLOGD("dumpstate calling_uid = %d ; calling package = %s \n",
2813 calling_uid, calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00002814
Felipe Leme7447d7c2016-11-03 18:12:22 -07002815 // TODO: temporarily set progress until it's part of the Dumpstate constructor
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002816 std::string stats_path =
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002817 android::base::StringPrintf("%s/dumpstate-stats.txt", bugreport_internal_dir_.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002818 progress_.reset(new Progress(stats_path));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002819
Sahana Raof35ed432019-07-12 10:47:52 +01002820 if (acquire_wake_lock(PARTIAL_WAKE_LOCK, WAKE_LOCK_NAME) < 0) {
2821 MYLOGE("Failed to acquire wake lock: %s\n", strerror(errno));
2822 } else {
2823 // Wake lock will be released automatically on process death
2824 MYLOGD("Wake lock acquired.\n");
2825 }
2826
Felipe Leme6ae5c4f2017-01-10 14:13:22 -08002827 register_sig_handler();
Felipe Lemed071c682016-10-20 16:48:00 -07002828
Felipe Lemef0292972016-11-22 13:57:05 -08002829 if (PropertiesHelper::IsDryRun()) {
Felipe Lemed071c682016-10-20 16:48:00 -07002830 MYLOGI("Running on dry-run mode (to disable it, call 'setprop dumpstate.dry_run false')\n");
2831 }
2832
Nandana Dutt235c6672019-11-14 15:22:32 +00002833 MYLOGI("dumpstate info: id=%d, args='%s', bugreport_mode= %s bugreport format version: %s\n",
2834 id_, options_->args.c_str(), options_->bugreport_mode.c_str(), version_.c_str());
Felipe Leme809d74e2016-02-02 12:57:00 -08002835
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002836 do_early_screenshot_ = options_->do_progress_updates;
Felipe Lemee338bf62015-12-07 14:03:50 -08002837
Christopher Ferrised9354f2014-10-01 17:35:01 -07002838 // If we are going to use a socket, do it as early as possible
2839 // to avoid timeouts from bugreport.
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002840 if (options_->stream_to_socket || options_->progress_updates_to_socket) {
Felipe Leme2628e9e2016-04-12 16:36:51 -07002841 MYLOGD("Opening control socket\n");
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002842 control_socket_fd_ = open_socket_fn_("dumpstate");
Nandana Dutta344cb62019-02-22 15:12:35 +00002843 if (control_socket_fd_ == -1) {
2844 return ERROR;
2845 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002846 if (options_->progress_updates_to_socket) {
2847 options_->do_progress_updates = 1;
2848 }
Felipe Leme2628e9e2016-04-12 16:36:51 -07002849 }
2850
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002851 if (!PrepareToWriteToFile()) {
2852 return ERROR;
2853 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08002854
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002855 // Interactive, wear & telephony modes are default to true.
2856 // and may enable from cli option or when using control socket
2857 if (options_->do_progress_updates) {
2858 // clang-format off
2859 std::vector<std::string> am_args = {
2860 "--receiver-permission", "android.permission.DUMP",
2861 };
2862 // clang-format on
2863 // Send STARTED broadcast for apps that listen to bugreport generation events
2864 SendBroadcast("com.android.internal.intent.action.BUGREPORT_STARTED", am_args);
2865 if (options_->progress_updates_to_socket) {
2866 dprintf(control_socket_fd_, "BEGIN:%s\n", path_.c_str());
Felipe Leme71bbfc52015-11-23 14:14:51 -08002867 }
2868 }
2869
Nick Kralevichf3599b32016-01-25 15:05:16 -08002870 /* read /proc/cmdline before dropping root */
2871 FILE *cmdline = fopen("/proc/cmdline", "re");
2872 if (cmdline) {
2873 fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
2874 fclose(cmdline);
2875 }
2876
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002877 if (options_->do_vibrate) {
Felipe Leme35b8cf12017-02-10 15:47:29 -08002878 Vibrate(150);
John Michelau1f794c42012-09-17 11:20:19 -05002879 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002880
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002881 if (zip_file != nullptr) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002882 if (chown(path_.c_str(), AID_SHELL, AID_SHELL)) {
2883 MYLOGE("Unable to change ownership of zip file %s: %s\n", path_.c_str(),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002884 strerror(errno));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002885 }
2886 }
2887
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002888 int dup_stdout_fd;
2889 int dup_stderr_fd;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002890 // Redirect stderr to log_path_ for debugging.
2891 TEMP_FAILURE_RETRY(dup_stderr_fd = dup(fileno(stderr)));
2892 if (!redirect_to_file(stderr, const_cast<char*>(log_path_.c_str()))) {
2893 return ERROR;
2894 }
2895 if (chown(log_path_.c_str(), AID_SHELL, AID_SHELL)) {
2896 MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n", log_path_.c_str(),
2897 strerror(errno));
2898 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002899
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002900 // Redirect stdout to tmp_path_. This is the main bugreport entry and will be
2901 // moved into zip file later, if zipping.
2902 TEMP_FAILURE_RETRY(dup_stdout_fd = dup(fileno(stdout)));
2903 // TODO: why not write to a file instead of stdout to overcome this problem?
2904 /* TODO: rather than generating a text file now and zipping it later,
2905 it would be more efficient to redirect stdout to the zip entry
2906 directly, but the libziparchive doesn't support that option yet. */
2907 if (!redirect_to_file(stdout, const_cast<char*>(tmp_path_.c_str()))) {
2908 return ERROR;
2909 }
2910 if (chown(tmp_path_.c_str(), AID_SHELL, AID_SHELL)) {
2911 MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
2912 tmp_path_.c_str(), strerror(errno));
Colin Crossf45fa6b2012-03-26 12:38:26 -07002913 }
Felipe Lemed8b94e52016-12-08 10:21:44 -08002914
2915 // Don't buffer stdout
2916 setvbuf(stdout, nullptr, _IONBF, 0);
2917
Rhed Jao1c855122020-07-16 17:37:39 +08002918 // Enable the parallel run if the client requests to output to a file.
2919 EnableParallelRunIfNeeded();
2920 // Using scope guard to make sure the dump pool can be shut down correctly.
2921 auto scope_guard_to_shutdown_pool = android::base::make_scope_guard([=]() {
2922 ShutdownDumpPool();
2923 });
2924
Felipe Leme608385d2016-02-01 10:35:38 -08002925 // NOTE: there should be no stdout output until now, otherwise it would break the header.
2926 // In particular, DurationReport objects should be created passing 'title, NULL', so their
Felipe Lemecbce55d2016-02-08 09:53:18 -08002927 // duration is logged into MYLOG instead.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002928 PrintHeader();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002929
Gavin Corkery6968f552020-11-22 18:09:05 +00002930 bool is_dumpstate_restricted = options_->telephony_only
2931 || options_->wifi_only
2932 || options_->limited_only;
2933 if (!is_dumpstate_restricted) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002934 // Invoke critical dumpsys first to preserve system state, before doing anything else.
Jichao Lie89d9c12019-11-21 19:02:51 -08002935 RunDumpsysCritical();
Gavin Corkery6968f552020-11-22 18:09:05 +00002936 }
2937 MaybeTakeEarlyScreenshot();
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00002938
2939 if (!is_dumpstate_restricted) {
2940 // Snapshot the system trace now (if running) to avoid that dumpstate's
2941 // own activity pushes out interesting data from the trace ring buffer.
2942 // The trace file is added to the zip by MaybeAddSystemTraceToZip().
2943 MaybeSnapshotSystemTrace();
Yohei Yukawa95305b32021-03-09 07:54:27 -08002944
2945 // If a winscope trace is running, snapshot it now. It will be pulled into bugreport later
2946 // from WMTRACE_DATA_DIR.
2947 MaybeSnapshotWinTrace();
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00002948 }
Gavin Corkery6968f552020-11-22 18:09:05 +00002949 onUiIntensiveBugreportDumpsFinished(calling_uid);
2950 MaybeCheckUserConsent(calling_uid, calling_package);
2951 if (options_->telephony_only) {
2952 DumpstateTelephonyOnly(calling_package);
2953 } else if (options_->wifi_only) {
2954 DumpstateWifiOnly();
2955 } else if (options_->limited_only) {
2956 DumpstateLimitedOnly();
2957 } else {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002958 // Dump state for the default case. This also drops root.
Jichao Lie89d9c12019-11-21 19:02:51 -08002959 RunStatus s = DumpstateDefaultAfterCritical();
Nandana Dutt5c390032019-03-12 10:52:56 +00002960 if (s != RunStatus::OK) {
Nandana Duttaac6f582019-07-26 14:32:47 +01002961 if (s == RunStatus::USER_CONSENT_DENIED) {
Nandana Dutt5c390032019-03-12 10:52:56 +00002962 HandleUserConsentDenied();
2963 }
2964 return s;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002965 }
Zhengyin Qian068ecc72016-08-10 16:48:14 -07002966 }
Felipe Leme71a74ac2016-03-17 15:43:25 -07002967
Felipe Leme55b42a62015-11-10 17:39:08 -08002968 /* close output if needed */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002969 TEMP_FAILURE_RETRY(dup2(dup_stdout_fd, fileno(stdout)));
Colin Crossf45fa6b2012-03-26 12:38:26 -07002970
Abhijeet Kaure370d682019-10-01 16:49:30 +01002971 // Zip the (now complete) .tmp file within the internal directory.
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002972 FinalizeFile();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002973
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002974 // Share the final file with the caller if the user has consented or Shell is the caller.
Nandana Duttd2f5f082019-01-18 17:13:52 +00002975 Dumpstate::RunStatus status = Dumpstate::RunStatus::OK;
Abhijeet Kaure370d682019-10-01 16:49:30 +01002976 if (CalledByApi()) {
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002977 status = CopyBugreportIfUserConsented(calling_uid);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002978 if (status != Dumpstate::RunStatus::OK &&
2979 status != Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2980 // Do an early return if there were errors. We make an exception for consent
2981 // timing out because it's possible the user got distracted. In this case the
2982 // bugreport is not shared but made available for manual retrieval.
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002983 MYLOGI("User denied consent. Returning\n");
Nandana Duttd2f5f082019-01-18 17:13:52 +00002984 return status;
2985 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002986 if (status == Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2987 MYLOGI(
2988 "Did not receive user consent yet."
2989 " Will not copy the bugreport artifacts to caller.\n");
Abhijeet Kaur57627412019-04-17 16:00:09 +01002990 const String16 incidentcompanion("incidentcompanion");
2991 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
2992 if (ics != nullptr) {
2993 MYLOGD("Canceling user consent request via incidentcompanion service\n");
2994 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
2995 consent_callback_.get());
2996 } else {
2997 MYLOGD("Unable to cancel user consent; incidentcompanion service unavailable\n");
2998 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002999 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003000 }
3001
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08003002 /* vibrate a few but shortly times to let user know it's finished */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003003 if (options_->do_vibrate) {
Takuya Ogawa47f644e2017-12-20 18:09:09 +09003004 for (int i = 0; i < 3; i++) {
3005 Vibrate(75);
3006 usleep((75 + 50) * 1000);
3007 }
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08003008 }
3009
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003010 MYLOGD("Final progress: %d/%d (estimated %d)\n", progress_->Get(), progress_->GetMax(),
3011 progress_->GetInitialMax());
3012 progress_->Save();
3013 MYLOGI("done (id %d)\n", id_);
Colin Crossf45fa6b2012-03-26 12:38:26 -07003014
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003015 TEMP_FAILURE_RETRY(dup2(dup_stderr_fd, fileno(stderr)));
Felipe Leme107a05f2016-03-08 15:11:15 -08003016
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003017 if (control_socket_fd_ != -1) {
Felipe Lemee844a9d2016-09-21 15:01:39 -07003018 MYLOGD("Closing control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003019 close(control_socket_fd_);
Felipe Leme2628e9e2016-04-12 16:36:51 -07003020 }
3021
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003022 tombstone_data_.clear();
3023 anr_data_.clear();
Narayan Kamath6b9516c2017-10-27 11:15:51 +01003024
Nandana Duttd2f5f082019-01-18 17:13:52 +00003025 return (consent_callback_ != nullptr &&
3026 consent_callback_->getResult() == UserConsentResult::UNAVAILABLE)
3027 ? USER_CONSENT_TIMED_OUT
3028 : RunStatus::OK;
3029}
3030
Paul Chang0d2aad72020-02-13 20:04:03 +08003031void Dumpstate::MaybeTakeEarlyScreenshot() {
3032 if (!options_->do_screenshot || !do_early_screenshot_) {
3033 return;
3034 }
3035
3036 TakeScreenshot();
3037}
3038
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003039void Dumpstate::MaybeSnapshotSystemTrace() {
3040 // If a background system trace is happening and is marked as "suitable for
3041 // bugreport" (i.e. bugreport_score > 0 in the trace config), this command
3042 // will stop it and serialize into SYSTEM_TRACE_SNAPSHOT. In the (likely)
3043 // case that no trace is ongoing, this command is a no-op.
3044 // Note: this should not be enqueued as we need to freeze the trace before
3045 // dumpstate starts. Otherwise the trace ring buffers will contain mostly
3046 // the dumpstate's own activity which is irrelevant.
3047 int res = RunCommand(
3048 "SERIALIZE PERFETTO TRACE",
3049 {"perfetto", "--save-for-bugreport"},
3050 CommandOptions::WithTimeout(10)
3051 .DropRoot()
3052 .CloseAllFileDescriptorsOnExec()
3053 .Build());
3054 has_system_trace_ = res == 0;
3055 // MaybeAddSystemTraceToZip() will take care of copying the trace in the zip
3056 // file in the later stages.
3057}
3058
Yohei Yukawa95305b32021-03-09 07:54:27 -08003059void Dumpstate::MaybeSnapshotWinTrace() {
Yohei Yukawa02b1d2c2021-03-16 09:20:30 -07003060 // Currently WindowManagerService and InputMethodManagerSerivice support WinScope protocol.
3061 for (const auto& service : {"window", "input_method"}) {
3062 RunCommand(
3063 // Empty name because it's not intended to be classified as a bugreport section.
3064 // Actual tracing files can be found in "/data/misc/wmtrace/" in the bugreport.
3065 "", {"cmd", service, "tracing", "save-for-bugreport"},
3066 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3067 }
Yohei Yukawa95305b32021-03-09 07:54:27 -08003068}
3069
Paul Chang5702b482020-05-28 22:05:47 +08003070void Dumpstate::onUiIntensiveBugreportDumpsFinished(int32_t calling_uid) {
Paul Changc490e662020-04-11 18:14:09 +08003071 if (calling_uid == AID_SHELL || !CalledByApi()) {
3072 return;
3073 }
3074 if (listener_ != nullptr) {
3075 // Let listener know ui intensive bugreport dumps are finished, then it can do event
3076 // handling if required.
Paul Chang5702b482020-05-28 22:05:47 +08003077 listener_->onUiIntensiveBugreportDumpsFinished();
Paul Changc490e662020-04-11 18:14:09 +08003078 }
3079}
3080
Jichao Lie89d9c12019-11-21 19:02:51 -08003081void Dumpstate::MaybeCheckUserConsent(int32_t calling_uid, const std::string& calling_package) {
3082 if (calling_uid == AID_SHELL || !CalledByApi()) {
3083 // No need to get consent for shell triggered dumpstates, or not through
3084 // bugreporting API (i.e. no fd to copy back).
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003085 return;
3086 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003087 consent_callback_ = new ConsentCallback();
3088 const String16 incidentcompanion("incidentcompanion");
3089 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
Jichao Lie89d9c12019-11-21 19:02:51 -08003090 android::String16 package(calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003091 if (ics != nullptr) {
3092 MYLOGD("Checking user consent via incidentcompanion service\n");
3093 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
Jichao Lie89d9c12019-11-21 19:02:51 -08003094 calling_uid, package, String16(), String16(),
Joe Onorato1c36d752019-03-17 18:26:43 -07003095 0x1 /* FLAG_CONFIRMATION_DIALOG */, consent_callback_.get());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003096 } else {
3097 MYLOGD("Unable to check user consent; incidentcompanion service unavailable\n");
3098 }
3099}
3100
Nandana Dutt5c390032019-03-12 10:52:56 +00003101bool Dumpstate::IsUserConsentDenied() const {
3102 return ds.consent_callback_ != nullptr &&
3103 ds.consent_callback_->getResult() == UserConsentResult::DENIED;
3104}
3105
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01003106bool Dumpstate::CalledByApi() const {
3107 return ds.options_->bugreport_fd.get() != -1 ? true : false;
3108}
3109
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003110void Dumpstate::CleanupTmpFiles() {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003111 android::os::UnlinkAndLogOnError(tmp_path_);
3112 android::os::UnlinkAndLogOnError(screenshot_path_);
3113 android::os::UnlinkAndLogOnError(path_);
Gavin Corkery789d7a52021-02-24 23:52:35 +00003114 if (dump_traces_path != nullptr) {
3115 android::os::UnlinkAndLogOnError(dump_traces_path);
3116 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003117}
3118
Rhed Jao1c855122020-07-16 17:37:39 +08003119void Dumpstate::EnableParallelRunIfNeeded() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003120 if (!PropertiesHelper::IsParallelRun()) {
Rhed Jao1c855122020-07-16 17:37:39 +08003121 return;
3122 }
3123 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao4875aa62020-07-20 17:46:29 +08003124 zip_entry_tasks_ = std::make_unique<TaskQueue>();
Rhed Jao1c855122020-07-16 17:37:39 +08003125}
3126
3127void Dumpstate::ShutdownDumpPool() {
3128 if (dump_pool_) {
3129 dump_pool_->shutdown();
3130 dump_pool_ = nullptr;
3131 }
Rhed Jao4875aa62020-07-20 17:46:29 +08003132 if (zip_entry_tasks_) {
3133 zip_entry_tasks_->run(/* do_cancel = */true);
3134 zip_entry_tasks_ = nullptr;
3135 }
3136}
3137
3138void Dumpstate::EnqueueAddZipEntryAndCleanupIfNeeded(const std::string& entry_name,
3139 const std::string& entry_path) {
3140 auto func_add_zip_entry_and_cleanup = [=](bool task_cancelled) {
3141 if (!task_cancelled) {
3142 AddZipEntry(entry_name, entry_path);
3143 }
3144 android::os::UnlinkAndLogOnError(entry_path);
3145 };
3146 if (zip_entry_tasks_) {
3147 // Enqueues AddZipEntryAndCleanup function if the parallel run is enabled.
3148 zip_entry_tasks_->add(func_add_zip_entry_and_cleanup, _1);
3149 } else {
3150 // Invokes AddZipEntryAndCleanup immediately
3151 std::invoke(func_add_zip_entry_and_cleanup, /* task_cancelled = */false);
3152 }
Rhed Jao1c855122020-07-16 17:37:39 +08003153}
3154
Nandana Duttd2f5f082019-01-18 17:13:52 +00003155Dumpstate::RunStatus Dumpstate::HandleUserConsentDenied() {
3156 MYLOGD("User denied consent; deleting files and returning\n");
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003157 CleanupTmpFiles();
Nandana Duttd2f5f082019-01-18 17:13:52 +00003158 return USER_CONSENT_DENIED;
3159}
3160
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003161Dumpstate::RunStatus Dumpstate::CopyBugreportIfUserConsented(int32_t calling_uid) {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003162 // If the caller has asked to copy the bugreport over to their directory, we need explicit
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003163 // user consent (unless the caller is Shell).
3164 UserConsentResult consent_result;
3165 if (calling_uid == AID_SHELL) {
3166 consent_result = UserConsentResult::APPROVED;
3167 } else {
3168 consent_result = consent_callback_->getResult();
3169 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003170 if (consent_result == UserConsentResult::UNAVAILABLE) {
3171 // User has not responded yet.
3172 uint64_t elapsed_ms = consent_callback_->getElapsedTimeMs();
Hunter Knepshield70610fa2020-01-03 15:27:33 -08003173 // Telephony is a fast report type, particularly on user builds where information may be
3174 // more aggressively limited. To give the user time to read the consent dialog, increase the
3175 // timeout.
3176 uint64_t timeout_ms = options_->telephony_only ? TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS
3177 : USER_CONSENT_TIMEOUT_MS;
3178 if (elapsed_ms < timeout_ms) {
3179 uint delay_seconds = (timeout_ms - elapsed_ms) / 1000;
Nandana Duttd2f5f082019-01-18 17:13:52 +00003180 MYLOGD("Did not receive user consent yet; going to wait for %d seconds", delay_seconds);
3181 sleep(delay_seconds);
3182 }
3183 consent_result = consent_callback_->getResult();
3184 }
3185 if (consent_result == UserConsentResult::DENIED) {
3186 // User has explicitly denied sharing with the app. To be safe delete the
3187 // internal bugreport & tmp files.
3188 return HandleUserConsentDenied();
3189 }
3190 if (consent_result == UserConsentResult::APPROVED) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00003191 bool copy_succeeded = android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
3192 if (copy_succeeded) {
3193 android::os::UnlinkAndLogOnError(path_);
Abhijeet Kaur9ce94672020-04-01 17:22:36 +01003194 if (options_->do_screenshot &&
3195 options_->screenshot_fd.get() != -1 &&
3196 !options_->is_screenshot_copied) {
3197 copy_succeeded = android::os::CopyFileToFd(screenshot_path_,
3198 options_->screenshot_fd.get());
3199 options_->is_screenshot_copied = copy_succeeded;
3200 if (copy_succeeded) {
3201 android::os::UnlinkAndLogOnError(screenshot_path_);
3202 }
3203 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003204 }
3205 return copy_succeeded ? Dumpstate::RunStatus::OK : Dumpstate::RunStatus::ERROR;
3206 } else if (consent_result == UserConsentResult::UNAVAILABLE) {
3207 // consent_result is still UNAVAILABLE. The user has likely not responded yet.
3208 // Since we do not have user consent to share the bugreport it does not get
3209 // copied over to the calling app but remains in the internal directory from
3210 // where the user can manually pull it.
3211 return Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT;
3212 }
3213 // Unknown result; must be a programming error.
3214 MYLOGE("Unknown user consent result:%d\n", consent_result);
3215 return Dumpstate::RunStatus::ERROR;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003216}
3217
Nandana Duttf02564e2019-02-15 15:24:24 +00003218Dumpstate::RunStatus Dumpstate::ParseCommandlineAndRun(int argc, char* argv[]) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003219 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
3220 Dumpstate::RunStatus status = options->Initialize(argc, argv);
3221 if (status == Dumpstate::RunStatus::OK) {
Nandana Duttf02564e2019-02-15 15:24:24 +00003222 SetOptions(std::move(options));
Nandana Duttd2f5f082019-01-18 17:13:52 +00003223 // When directly running dumpstate binary, the output is not expected to be written
3224 // to any external file descriptor.
Nandana Duttf02564e2019-02-15 15:24:24 +00003225 assert(options_->bugreport_fd.get() == -1);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003226
3227 // calling_uid and calling_package are for user consent to share the bugreport with
Abhijeet Kaura407fb82020-03-27 12:51:12 +00003228 // an app; they are irrelevant here because bugreport is triggered via command line.
3229 // Update Last ID before calling Run().
3230 Initialize();
Nandana Duttf02564e2019-02-15 15:24:24 +00003231 status = Run(-1 /* calling_uid */, "" /* calling_package */);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003232 }
Nandana Duttf02564e2019-02-15 15:24:24 +00003233 return status;
3234}
3235
3236/* Main entry point for dumpstate binary. */
3237int run_main(int argc, char* argv[]) {
3238 Dumpstate::RunStatus status = ds.ParseCommandlineAndRun(argc, argv);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003239
3240 switch (status) {
3241 case Dumpstate::RunStatus::OK:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003242 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003243 case Dumpstate::RunStatus::HELP:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003244 ShowUsage();
3245 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003246 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003247 fprintf(stderr, "Invalid combination of args\n");
3248 ShowUsage();
3249 exit(1);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003250 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00003251 FALLTHROUGH_INTENDED;
3252 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
3253 FALLTHROUGH_INTENDED;
3254 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003255 exit(2);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003256 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003257}
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003258
3259// TODO(111441001): Default DumpOptions to sensible values.
3260Dumpstate::Dumpstate(const std::string& version)
3261 : pid_(getpid()),
3262 options_(new Dumpstate::DumpOptions()),
Nandana Duttf02cd782019-06-14 14:25:13 +01003263 last_reported_percent_progress_(0),
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003264 version_(version),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003265 now_(time(nullptr)),
3266 open_socket_fn_(open_socket) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003267}
3268
3269Dumpstate& Dumpstate::GetInstance() {
3270 static Dumpstate singleton_(android::base::GetProperty("dumpstate.version", VERSION_CURRENT));
3271 return singleton_;
3272}
3273
Rhed Jao1c855122020-07-16 17:37:39 +08003274DurationReporter::DurationReporter(const std::string& title, bool logcat_only, bool verbose,
3275 int duration_fd) : title_(title), logcat_only_(logcat_only), verbose_(verbose),
3276 duration_fd_(duration_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003277 if (!title_.empty()) {
3278 started_ = Nanotime();
3279 }
3280}
3281
3282DurationReporter::~DurationReporter() {
3283 if (!title_.empty()) {
3284 float elapsed = (float)(Nanotime() - started_) / NANOS_PER_SEC;
chenqiwuaf8b2d92019-12-12 18:53:51 +08003285 if (elapsed >= .5f || verbose_) {
3286 MYLOGD("Duration of '%s': %.2fs\n", title_.c_str(), elapsed);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003287 }
chenqiwuaf8b2d92019-12-12 18:53:51 +08003288 if (!logcat_only_) {
3289 // Use "Yoda grammar" to make it easier to grep|sort sections.
Rhed Jao1c855122020-07-16 17:37:39 +08003290 dprintf(duration_fd_, "------ %.3fs was the duration of '%s' ------\n",
3291 elapsed, title_.c_str());
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003292 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003293 }
3294}
3295
3296const int32_t Progress::kDefaultMax = 5000;
3297
3298Progress::Progress(const std::string& path) : Progress(Progress::kDefaultMax, 1.1, path) {
3299}
3300
3301Progress::Progress(int32_t initial_max, int32_t progress, float growth_factor)
3302 : Progress(initial_max, growth_factor, "") {
3303 progress_ = progress;
3304}
3305
3306Progress::Progress(int32_t initial_max, float growth_factor, const std::string& path)
3307 : initial_max_(initial_max),
3308 progress_(0),
3309 max_(initial_max),
3310 growth_factor_(growth_factor),
3311 n_runs_(0),
3312 average_max_(0),
3313 path_(path) {
3314 if (!path_.empty()) {
3315 Load();
3316 }
3317}
3318
3319void Progress::Load() {
3320 MYLOGD("Loading stats from %s\n", path_.c_str());
3321 std::string content;
3322 if (!android::base::ReadFileToString(path_, &content)) {
3323 MYLOGI("Could not read stats from %s; using max of %d\n", path_.c_str(), max_);
3324 return;
3325 }
3326 if (content.empty()) {
3327 MYLOGE("No stats (empty file) on %s; using max of %d\n", path_.c_str(), max_);
3328 return;
3329 }
3330 std::vector<std::string> lines = android::base::Split(content, "\n");
3331
3332 if (lines.size() < 1) {
3333 MYLOGE("Invalid stats on file %s: not enough lines (%d). Using max of %d\n", path_.c_str(),
3334 (int)lines.size(), max_);
3335 return;
3336 }
3337 char* ptr;
3338 n_runs_ = strtol(lines[0].c_str(), &ptr, 10);
3339 average_max_ = strtol(ptr, nullptr, 10);
3340 if (n_runs_ <= 0 || average_max_ <= 0 || n_runs_ > STATS_MAX_N_RUNS ||
3341 average_max_ > STATS_MAX_AVERAGE) {
3342 MYLOGE("Invalid stats line on file %s: %s\n", path_.c_str(), lines[0].c_str());
3343 initial_max_ = Progress::kDefaultMax;
3344 } else {
3345 initial_max_ = average_max_;
3346 }
3347 max_ = initial_max_;
3348
3349 MYLOGI("Average max progress: %d in %d runs; estimated max: %d\n", average_max_, n_runs_, max_);
3350}
3351
3352void Progress::Save() {
3353 int32_t total = n_runs_ * average_max_ + progress_;
3354 int32_t runs = n_runs_ + 1;
3355 int32_t average = floor(((float)total) / runs);
3356 MYLOGI("Saving stats (total=%d, runs=%d, average=%d) on %s\n", total, runs, average,
3357 path_.c_str());
3358 if (path_.empty()) {
3359 return;
3360 }
3361
3362 std::string content = android::base::StringPrintf("%d %d\n", runs, average);
3363 if (!android::base::WriteStringToFile(content, path_)) {
3364 MYLOGE("Could not save stats on %s\n", path_.c_str());
3365 }
3366}
3367
3368int32_t Progress::Get() const {
3369 return progress_;
3370}
3371
3372bool Progress::Inc(int32_t delta_sec) {
3373 bool changed = false;
3374 if (delta_sec >= 0) {
3375 progress_ += delta_sec;
3376 if (progress_ > max_) {
3377 int32_t old_max = max_;
3378 max_ = floor((float)progress_ * growth_factor_);
3379 MYLOGD("Adjusting max progress from %d to %d\n", old_max, max_);
3380 changed = true;
3381 }
3382 }
3383 return changed;
3384}
3385
3386int32_t Progress::GetMax() const {
3387 return max_;
3388}
3389
3390int32_t Progress::GetInitialMax() const {
3391 return initial_max_;
3392}
3393
3394void Progress::Dump(int fd, const std::string& prefix) const {
3395 const char* pr = prefix.c_str();
3396 dprintf(fd, "%sprogress: %d\n", pr, progress_);
3397 dprintf(fd, "%smax: %d\n", pr, max_);
3398 dprintf(fd, "%sinitial_max: %d\n", pr, initial_max_);
3399 dprintf(fd, "%sgrowth_factor: %0.2f\n", pr, growth_factor_);
3400 dprintf(fd, "%spath: %s\n", pr, path_.c_str());
3401 dprintf(fd, "%sn_runs: %d\n", pr, n_runs_);
3402 dprintf(fd, "%saverage_max: %d\n", pr, average_max_);
3403}
3404
3405bool Dumpstate::IsZipping() const {
3406 return zip_writer_ != nullptr;
3407}
3408
3409std::string Dumpstate::GetPath(const std::string& suffix) const {
3410 return GetPath(bugreport_internal_dir_, suffix);
3411}
3412
3413std::string Dumpstate::GetPath(const std::string& directory, const std::string& suffix) const {
3414 return android::base::StringPrintf("%s/%s-%s%s", directory.c_str(), base_name_.c_str(),
3415 name_.c_str(), suffix.c_str());
3416}
3417
3418void Dumpstate::SetProgress(std::unique_ptr<Progress> progress) {
3419 progress_ = std::move(progress);
3420}
3421
3422void for_each_userid(void (*func)(int), const char *header) {
3423 std::string title = header == nullptr ? "for_each_userid" : android::base::StringPrintf(
3424 "for_each_userid(%s)", header);
3425 DurationReporter duration_reporter(title);
3426 if (PropertiesHelper::IsDryRun()) return;
3427
3428 DIR *d;
3429 struct dirent *de;
3430
3431 if (header) printf("\n------ %s ------\n", header);
3432 func(0);
3433
3434 if (!(d = opendir("/data/system/users"))) {
3435 printf("Failed to open /data/system/users (%s)\n", strerror(errno));
3436 return;
3437 }
3438
3439 while ((de = readdir(d))) {
3440 int userid;
3441 if (de->d_type != DT_DIR || !(userid = atoi(de->d_name))) {
3442 continue;
3443 }
3444 func(userid);
3445 }
3446
3447 closedir(d);
3448}
3449
3450static void __for_each_pid(void (*helper)(int, const char *, void *), const char *header, void *arg) {
3451 DIR *d;
3452 struct dirent *de;
3453
3454 if (!(d = opendir("/proc"))) {
3455 printf("Failed to open /proc (%s)\n", strerror(errno));
3456 return;
3457 }
3458
3459 if (header) printf("\n------ %s ------\n", header);
3460 while ((de = readdir(d))) {
3461 if (ds.IsUserConsentDenied()) {
3462 MYLOGE(
3463 "Returning early because user denied consent to share bugreport with calling app.");
3464 closedir(d);
3465 return;
3466 }
3467 int pid;
3468 int fd;
3469 char cmdpath[255];
3470 char cmdline[255];
3471
3472 if (!(pid = atoi(de->d_name))) {
3473 continue;
3474 }
3475
3476 memset(cmdline, 0, sizeof(cmdline));
3477
3478 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/cmdline", pid);
3479 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3480 TEMP_FAILURE_RETRY(read(fd, cmdline, sizeof(cmdline) - 2));
3481 close(fd);
3482 if (cmdline[0]) {
3483 helper(pid, cmdline, arg);
3484 continue;
3485 }
3486 }
3487
3488 // if no cmdline, a kernel thread has comm
3489 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/comm", pid);
3490 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3491 TEMP_FAILURE_RETRY(read(fd, cmdline + 1, sizeof(cmdline) - 4));
3492 close(fd);
3493 if (cmdline[1]) {
3494 cmdline[0] = '[';
3495 size_t len = strcspn(cmdline, "\f\b\r\n");
3496 cmdline[len] = ']';
3497 cmdline[len+1] = '\0';
3498 }
3499 }
3500 if (!cmdline[0]) {
3501 strcpy(cmdline, "N/A");
3502 }
3503 helper(pid, cmdline, arg);
3504 }
3505
3506 closedir(d);
3507}
3508
3509static void for_each_pid_helper(int pid, const char *cmdline, void *arg) {
3510 for_each_pid_func *func = (for_each_pid_func*) arg;
3511 func(pid, cmdline);
3512}
3513
3514void for_each_pid(for_each_pid_func func, const char *header) {
3515 std::string title = header == nullptr ? "for_each_pid"
3516 : android::base::StringPrintf("for_each_pid(%s)", header);
3517 DurationReporter duration_reporter(title);
3518 if (PropertiesHelper::IsDryRun()) return;
3519
3520 __for_each_pid(for_each_pid_helper, header, (void *) func);
3521}
3522
3523static void for_each_tid_helper(int pid, const char *cmdline, void *arg) {
3524 DIR *d;
3525 struct dirent *de;
3526 char taskpath[255];
3527 for_each_tid_func *func = (for_each_tid_func *) arg;
3528
3529 snprintf(taskpath, sizeof(taskpath), "/proc/%d/task", pid);
3530
3531 if (!(d = opendir(taskpath))) {
3532 printf("Failed to open %s (%s)\n", taskpath, strerror(errno));
3533 return;
3534 }
3535
3536 func(pid, pid, cmdline);
3537
3538 while ((de = readdir(d))) {
3539 if (ds.IsUserConsentDenied()) {
3540 MYLOGE(
3541 "Returning early because user denied consent to share bugreport with calling app.");
3542 closedir(d);
3543 return;
3544 }
3545 int tid;
3546 int fd;
3547 char commpath[255];
3548 char comm[255];
3549
3550 if (!(tid = atoi(de->d_name))) {
3551 continue;
3552 }
3553
3554 if (tid == pid)
3555 continue;
3556
3557 snprintf(commpath, sizeof(commpath), "/proc/%d/comm", tid);
3558 memset(comm, 0, sizeof(comm));
3559 if ((fd = TEMP_FAILURE_RETRY(open(commpath, O_RDONLY | O_CLOEXEC))) < 0) {
3560 strcpy(comm, "N/A");
3561 } else {
3562 char *c;
3563 TEMP_FAILURE_RETRY(read(fd, comm, sizeof(comm) - 2));
3564 close(fd);
3565
3566 c = strrchr(comm, '\n');
3567 if (c) {
3568 *c = '\0';
3569 }
3570 }
3571 func(pid, tid, comm);
3572 }
3573
3574 closedir(d);
3575}
3576
3577void for_each_tid(for_each_tid_func func, const char *header) {
3578 std::string title = header == nullptr ? "for_each_tid"
3579 : android::base::StringPrintf("for_each_tid(%s)", header);
3580 DurationReporter duration_reporter(title);
3581
3582 if (PropertiesHelper::IsDryRun()) return;
3583
3584 __for_each_pid(for_each_tid_helper, header, (void *) func);
3585}
3586
3587void show_wchan(int pid, int tid, const char *name) {
3588 if (PropertiesHelper::IsDryRun()) return;
3589
3590 char path[255];
3591 char buffer[255];
3592 int fd, ret, save_errno;
3593 char name_buffer[255];
3594
3595 memset(buffer, 0, sizeof(buffer));
3596
3597 snprintf(path, sizeof(path), "/proc/%d/wchan", tid);
3598 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3599 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3600 return;
3601 }
3602
3603 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3604 save_errno = errno;
3605 close(fd);
3606
3607 if (ret < 0) {
3608 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3609 return;
3610 }
3611
3612 snprintf(name_buffer, sizeof(name_buffer), "%*s%s",
3613 pid == tid ? 0 : 3, "", name);
3614
3615 printf("%-7d %-32s %s\n", tid, name_buffer, buffer);
3616
3617 return;
3618}
3619
3620// print time in centiseconds
3621static void snprcent(char *buffer, size_t len, size_t spc,
3622 unsigned long long time) {
3623 static long hz; // cache discovered hz
3624
3625 if (hz <= 0) {
3626 hz = sysconf(_SC_CLK_TCK);
3627 if (hz <= 0) {
3628 hz = 1000;
3629 }
3630 }
3631
3632 // convert to centiseconds
3633 time = (time * 100 + (hz / 2)) / hz;
3634
3635 char str[16];
3636
3637 snprintf(str, sizeof(str), " %llu.%02u",
3638 time / 100, (unsigned)(time % 100));
3639 size_t offset = strlen(buffer);
3640 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3641 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3642}
3643
3644// print permille as a percent
3645static void snprdec(char *buffer, size_t len, size_t spc, unsigned permille) {
3646 char str[16];
3647
3648 snprintf(str, sizeof(str), " %u.%u%%", permille / 10, permille % 10);
3649 size_t offset = strlen(buffer);
3650 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3651 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3652}
3653
3654void show_showtime(int pid, const char *name) {
3655 if (PropertiesHelper::IsDryRun()) return;
3656
3657 char path[255];
3658 char buffer[1023];
3659 int fd, ret, save_errno;
3660
3661 memset(buffer, 0, sizeof(buffer));
3662
3663 snprintf(path, sizeof(path), "/proc/%d/stat", pid);
3664 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3665 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3666 return;
3667 }
3668
3669 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3670 save_errno = errno;
3671 close(fd);
3672
3673 if (ret < 0) {
3674 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3675 return;
3676 }
3677
3678 // field 14 is utime
3679 // field 15 is stime
3680 // field 42 is iotime
3681 unsigned long long utime = 0, stime = 0, iotime = 0;
3682 if (sscanf(buffer,
3683 "%*u %*s %*s %*d %*d %*d %*d %*d %*d %*d %*d "
3684 "%*d %*d %llu %llu %*d %*d %*d %*d %*d %*d "
3685 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %*d "
3686 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %llu ",
3687 &utime, &stime, &iotime) != 3) {
3688 return;
3689 }
3690
3691 unsigned long long total = utime + stime;
3692 if (!total) {
3693 return;
3694 }
3695
3696 unsigned permille = (iotime * 1000 + (total / 2)) / total;
3697 if (permille > 1000) {
3698 permille = 1000;
3699 }
3700
3701 // try to beautify and stabilize columns at <80 characters
3702 snprintf(buffer, sizeof(buffer), "%-6d%s", pid, name);
3703 if ((name[0] != '[') || utime) {
3704 snprcent(buffer, sizeof(buffer), 57, utime);
3705 }
3706 snprcent(buffer, sizeof(buffer), 65, stime);
3707 if ((name[0] != '[') || iotime) {
3708 snprcent(buffer, sizeof(buffer), 73, iotime);
3709 }
3710 if (iotime) {
3711 snprdec(buffer, sizeof(buffer), 79, permille);
3712 }
3713 puts(buffer); // adds a trailing newline
3714
3715 return;
3716}
3717
3718void do_dmesg() {
3719 const char *title = "KERNEL LOG (dmesg)";
3720 DurationReporter duration_reporter(title);
3721 printf("------ %s ------\n", title);
3722
3723 if (PropertiesHelper::IsDryRun()) return;
3724
3725 /* Get size of kernel buffer */
3726 int size = klogctl(KLOG_SIZE_BUFFER, nullptr, 0);
3727 if (size <= 0) {
3728 printf("Unexpected klogctl return value: %d\n\n", size);
3729 return;
3730 }
3731 char *buf = (char *) malloc(size + 1);
3732 if (buf == nullptr) {
3733 printf("memory allocation failed\n\n");
3734 return;
3735 }
3736 int retval = klogctl(KLOG_READ_ALL, buf, size);
3737 if (retval < 0) {
3738 printf("klogctl failure\n\n");
3739 free(buf);
3740 return;
3741 }
3742 buf[retval] = '\0';
3743 printf("%s\n\n", buf);
3744 free(buf);
3745 return;
3746}
3747
3748void do_showmap(int pid, const char *name) {
3749 char title[255];
3750 char arg[255];
3751
3752 snprintf(title, sizeof(title), "SHOW MAP %d (%s)", pid, name);
3753 snprintf(arg, sizeof(arg), "%d", pid);
3754 RunCommand(title, {"showmap", "-q", arg}, CommandOptions::AS_ROOT);
3755}
3756
3757int Dumpstate::DumpFile(const std::string& title, const std::string& path) {
3758 DurationReporter duration_reporter(title);
3759
3760 int status = DumpFileToFd(STDOUT_FILENO, title, path);
3761
3762 UpdateProgress(WEIGHT_FILE);
3763
3764 return status;
3765}
3766
3767int read_file_as_long(const char *path, long int *output) {
3768 int fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC));
3769 if (fd < 0) {
3770 int err = errno;
3771 MYLOGE("Error opening file descriptor for %s: %s\n", path, strerror(err));
3772 return -1;
3773 }
3774 char buffer[50];
3775 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3776 if (bytes_read == -1) {
3777 MYLOGE("Error reading file %s: %s\n", path, strerror(errno));
3778 return -2;
3779 }
3780 if (bytes_read == 0) {
3781 MYLOGE("File %s is empty\n", path);
3782 return -3;
3783 }
3784 *output = atoi(buffer);
3785 return 0;
3786}
3787
3788/* calls skip to gate calling dump_from_fd recursively
3789 * in the specified directory. dump_from_fd defaults to
3790 * dump_file_from_fd above when set to NULL. skip defaults
3791 * to false when set to NULL. dump_from_fd will always be
3792 * called with title NULL.
3793 */
3794int dump_files(const std::string& title, const char* dir, bool (*skip)(const char* path),
3795 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
3796 DurationReporter duration_reporter(title);
3797 DIR *dirp;
3798 struct dirent *d;
3799 char *newpath = nullptr;
3800 const char *slash = "/";
3801 int retval = 0;
3802
3803 if (!title.empty()) {
3804 printf("------ %s (%s) ------\n", title.c_str(), dir);
3805 }
3806 if (PropertiesHelper::IsDryRun()) return 0;
3807
3808 if (dir[strlen(dir) - 1] == '/') {
3809 ++slash;
3810 }
3811 dirp = opendir(dir);
3812 if (dirp == nullptr) {
3813 retval = -errno;
3814 MYLOGE("%s: %s\n", dir, strerror(errno));
3815 return retval;
3816 }
3817
3818 if (!dump_from_fd) {
3819 dump_from_fd = dump_file_from_fd;
3820 }
3821 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
3822 if ((d->d_name[0] == '.')
3823 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
3824 || (d->d_name[1] == '\0'))) {
3825 continue;
3826 }
3827 asprintf(&newpath, "%s%s%s%s", dir, slash, d->d_name,
3828 (d->d_type == DT_DIR) ? "/" : "");
3829 if (!newpath) {
3830 retval = -errno;
3831 continue;
3832 }
3833 if (skip && (*skip)(newpath)) {
3834 continue;
3835 }
3836 if (d->d_type == DT_DIR) {
3837 int ret = dump_files("", newpath, skip, dump_from_fd);
3838 if (ret < 0) {
3839 retval = ret;
3840 }
3841 continue;
3842 }
3843 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(newpath, O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
3844 if (fd.get() < 0) {
3845 retval = -1;
3846 printf("*** %s: %s\n", newpath, strerror(errno));
3847 continue;
3848 }
3849 (*dump_from_fd)(nullptr, newpath, fd.get());
3850 }
3851 closedir(dirp);
3852 if (!title.empty()) {
3853 printf("\n");
3854 }
3855 return retval;
3856}
3857
3858/* fd must have been opened with the flag O_NONBLOCK. With this flag set,
3859 * it's possible to avoid issues where opening the file itself can get
3860 * stuck.
3861 */
3862int dump_file_from_fd(const char *title, const char *path, int fd) {
3863 if (PropertiesHelper::IsDryRun()) return 0;
3864
3865 int flags = fcntl(fd, F_GETFL);
3866 if (flags == -1) {
3867 printf("*** %s: failed to get flags on fd %d: %s\n", path, fd, strerror(errno));
3868 return -1;
3869 } else if (!(flags & O_NONBLOCK)) {
3870 printf("*** %s: fd must have O_NONBLOCK set.\n", path);
3871 return -1;
3872 }
3873 return DumpFileFromFdToFd(title, path, fd, STDOUT_FILENO, PropertiesHelper::IsDryRun());
3874}
3875
3876int Dumpstate::RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Rhed Jao4875aa62020-07-20 17:46:29 +08003877 const CommandOptions& options, bool verbose_duration, int out_fd) {
3878 DurationReporter duration_reporter(title, false /* logcat_only */,
3879 verbose_duration, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003880
Rhed Jao4875aa62020-07-20 17:46:29 +08003881 int status = RunCommandToFd(out_fd, title, full_command, options);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003882
3883 /* TODO: for now we're simplifying the progress calculation by using the
3884 * timeout as the weight. It's a good approximation for most cases, except when calling dumpsys,
3885 * where its weight should be much higher proportionally to its timeout.
3886 * Ideally, it should use a options.EstimatedDuration() instead...*/
3887 UpdateProgress(options.Timeout());
3888
3889 return status;
3890}
3891
3892void Dumpstate::RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsys_args,
Rhed Jao6b1ea2d2020-07-21 17:58:41 +08003893 const CommandOptions& options, long dumpsysTimeoutMs, int out_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003894 long timeout_ms = dumpsysTimeoutMs > 0 ? dumpsysTimeoutMs : options.TimeoutInMs();
3895 std::vector<std::string> dumpsys = {"/system/bin/dumpsys", "-T", std::to_string(timeout_ms)};
3896 dumpsys.insert(dumpsys.end(), dumpsys_args.begin(), dumpsys_args.end());
Rhed Jao6b1ea2d2020-07-21 17:58:41 +08003897 RunCommand(title, dumpsys, options, false, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003898}
3899
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003900static int open_socket(const char* service) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003901 int s = android_get_control_socket(service);
3902 if (s < 0) {
3903 MYLOGE("android_get_control_socket(%s): %s\n", service, strerror(errno));
3904 return -1;
3905 }
3906 fcntl(s, F_SETFD, FD_CLOEXEC);
3907
3908 // Set backlog to 0 to make sure that queue size will be minimum.
3909 // In Linux, because the minimum queue will be 1, connect() will be blocked
3910 // if the other clients already called connect() and the connection request was not accepted.
3911 if (listen(s, 0) < 0) {
3912 MYLOGE("listen(control socket): %s\n", strerror(errno));
3913 return -1;
3914 }
3915
3916 struct sockaddr addr;
3917 socklen_t alen = sizeof(addr);
Abhijeet Kaur2113cae2019-09-13 09:24:15 +01003918 int fd = accept4(s, &addr, &alen, SOCK_CLOEXEC);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003919
3920 // Close socket just after accept(), to make sure that connect() by client will get error
3921 // when the socket is used by the other services.
3922 // There is still a race condition possibility between accept and close, but there is no way
3923 // to close-on-accept atomically.
3924 // See detail; b/123306389#comment25
3925 close(s);
3926
3927 if (fd < 0) {
3928 MYLOGE("accept(control socket): %s\n", strerror(errno));
3929 return -1;
3930 }
3931
3932 return fd;
3933}
3934
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003935// TODO: should call is_valid_output_file and/or be merged into it.
3936void create_parent_dirs(const char *path) {
3937 char *chp = const_cast<char *> (path);
3938
3939 /* skip initial slash */
3940 if (chp[0] == '/')
3941 chp++;
3942
3943 /* create leading directories, if necessary */
3944 struct stat dir_stat;
3945 while (chp && chp[0]) {
3946 chp = strchr(chp, '/');
3947 if (chp) {
3948 *chp = 0;
3949 if (stat(path, &dir_stat) == -1 || !S_ISDIR(dir_stat.st_mode)) {
3950 MYLOGI("Creating directory %s\n", path);
3951 if (mkdir(path, 0770)) { /* drwxrwx--- */
3952 MYLOGE("Unable to create directory %s: %s\n", path, strerror(errno));
3953 } else if (chown(path, AID_SHELL, AID_SHELL)) {
3954 MYLOGE("Unable to change ownership of dir %s: %s\n", path, strerror(errno));
3955 }
3956 }
3957 *chp++ = '/';
3958 }
3959 }
3960}
3961
3962bool _redirect_to_file(FILE* redirect, char* path, int truncate_flag) {
3963 create_parent_dirs(path);
3964
3965 int fd = TEMP_FAILURE_RETRY(open(path,
3966 O_WRONLY | O_CREAT | truncate_flag | O_CLOEXEC | O_NOFOLLOW,
3967 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH));
3968 if (fd < 0) {
3969 MYLOGE("%s: %s\n", path, strerror(errno));
3970 return false;
3971 }
3972
3973 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
3974 close(fd);
3975 return true;
3976}
3977
3978bool redirect_to_file(FILE* redirect, char* path) {
3979 return _redirect_to_file(redirect, path, O_TRUNC);
3980}
3981
3982bool redirect_to_existing_file(FILE* redirect, char* path) {
3983 return _redirect_to_file(redirect, path, O_APPEND);
3984}
3985
3986void dump_route_tables() {
3987 DurationReporter duration_reporter("DUMP ROUTE TABLES");
3988 if (PropertiesHelper::IsDryRun()) return;
3989 const char* const RT_TABLES_PATH = "/data/misc/net/rt_tables";
3990 ds.DumpFile("RT_TABLES", RT_TABLES_PATH);
3991 FILE* fp = fopen(RT_TABLES_PATH, "re");
3992 if (!fp) {
3993 printf("*** %s: %s\n", RT_TABLES_PATH, strerror(errno));
3994 return;
3995 }
3996 char table[16];
3997 // Each line has an integer (the table number), a space, and a string (the table name). We only
3998 // need the table number. It's a 32-bit unsigned number, so max 10 chars. Skip the table name.
3999 // Add a fixed max limit so this doesn't go awry.
4000 for (int i = 0; i < 64 && fscanf(fp, " %10s %*s", table) == 1; ++i) {
4001 RunCommand("ROUTE TABLE IPv4", {"ip", "-4", "route", "show", "table", table});
4002 RunCommand("ROUTE TABLE IPv6", {"ip", "-6", "route", "show", "table", table});
4003 }
4004 fclose(fp);
4005}
4006
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004007void Dumpstate::UpdateProgress(int32_t delta_sec) {
4008 if (progress_ == nullptr) {
4009 MYLOGE("UpdateProgress: progress_ not set\n");
4010 return;
4011 }
Rhed Jao2cc4eec2020-07-21 15:42:55 +08004012 // This function updates progress related members of the dumpstate and reports
4013 // progress percentage to the bugreport client. Since it could be called by
4014 // different dump tasks at the same time if the parallel run is enabled, a
4015 // mutex lock is necessary here to synchronize the call.
4016 std::lock_guard<std::recursive_mutex> lock(mutex_);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004017
4018 // Always update progess so stats can be tuned...
Nandana Duttf02cd782019-06-14 14:25:13 +01004019 progress_->Inc(delta_sec);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004020
4021 // ...but only notifiy listeners when necessary.
4022 if (!options_->do_progress_updates) return;
4023
4024 int progress = progress_->Get();
4025 int max = progress_->GetMax();
Nandana Duttf02cd782019-06-14 14:25:13 +01004026 int percent = 100 * progress / max;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004027
Nandana Duttf02cd782019-06-14 14:25:13 +01004028 if (last_reported_percent_progress_ > 0 && percent <= last_reported_percent_progress_) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004029 return;
4030 }
Nandana Duttf02cd782019-06-14 14:25:13 +01004031 last_reported_percent_progress_ = percent;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004032
4033 if (control_socket_fd_ >= 0) {
4034 dprintf(control_socket_fd_, "PROGRESS:%d/%d\n", progress, max);
4035 fsync(control_socket_fd_);
4036 }
4037
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004038 if (listener_ != nullptr) {
Nandana Dutt235c6672019-11-14 15:22:32 +00004039 if (percent % 10 == 0) {
4040 // We don't want to spam logcat, so only log multiples of 10.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004041 MYLOGD("Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004042 } else {
4043 // stderr is ignored on normal invocations, but useful when calling
4044 // /system/bin/dumpstate directly for debuggging.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004045 fprintf(stderr, "Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004046 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004047
4048 listener_->onProgress(percent);
4049 }
4050}
4051
4052void Dumpstate::TakeScreenshot(const std::string& path) {
4053 const std::string& real_path = path.empty() ? screenshot_path_ : path;
4054 int status =
4055 RunCommand("", {"/system/bin/screencap", "-p", real_path},
4056 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
4057 if (status == 0) {
4058 MYLOGD("Screenshot saved on %s\n", real_path.c_str());
4059 } else {
4060 MYLOGE("Failed to take screenshot on %s\n", real_path.c_str());
4061 }
Paul Chang0d2aad72020-02-13 20:04:03 +08004062 if (listener_ != nullptr) {
4063 // Show a visual indication to indicate screenshot is taken via
4064 // IDumpstateListener.onScreenshotTaken()
4065 listener_->onScreenshotTaken(status == 0);
4066 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004067}
4068
4069bool is_dir(const char* pathname) {
4070 struct stat info;
4071 if (stat(pathname, &info) == -1) {
4072 return false;
4073 }
4074 return S_ISDIR(info.st_mode);
4075}
4076
4077time_t get_mtime(int fd, time_t default_mtime) {
4078 struct stat info;
4079 if (fstat(fd, &info) == -1) {
4080 return default_mtime;
4081 }
4082 return info.st_mtime;
4083}