blob: 25e6dc95c7f466d80fcf34c7a9a25006e0a9956a [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 Jao5377d792020-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 Jao5377d792020-07-16 17:37:39 +0800118using android::os::dumpstate::DumpPool;
Vishnu Naire97d6122018-01-18 13:58:56 -0800119using android::os::dumpstate::PropertiesHelper;
Rhed Jao3c2fdbd2020-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 Jao3c2fdbd2020-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 Juravlef84d3692020-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 Jao5377d792020-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 Jao3c2fdbd2020-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 Jao5377d792020-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 Jao3c2fdbd2020-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 Jaoe017f982020-07-21 17:58:41 +0800231static const std::string DUMP_CHECKINS_TASK = "DUMP CHECKINS";
Rhed Jao5377d792020-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 Jaoe017f982020-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 Jao5377d792020-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 Jao3c2fdbd2020-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;
Steven Moreland5a30d342019-10-08 13:53:28 -07001239 status_t status = dumpsys.startDumpThread(Dumpsys::Type::DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001240 if (status == OK) {
1241 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1242 std::chrono::duration<double> elapsed_seconds;
1243 status = dumpsys.writeDump(STDOUT_FILENO, service, service_timeout,
1244 /* as_proto = */ false, elapsed_seconds, bytes_written);
Vishnu Naire97d6122018-01-18 13:58:56 -08001245 dumpsys.writeDumpFooter(STDOUT_FILENO, service, elapsed_seconds);
1246 bool dump_complete = (status == OK);
1247 dumpsys.stopDumpThread(dump_complete);
1248 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001249
1250 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1251 std::chrono::steady_clock::now() - start);
1252 if (elapsed_duration > timeout) {
1253 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1254 elapsed_duration.count());
1255 break;
1256 }
1257 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001258 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001259}
1260
Vishnu Nair64afc022018-02-01 15:29:34 -08001261static void RunDumpsysText(const std::string& title, int priority,
1262 std::chrono::milliseconds timeout,
1263 std::chrono::milliseconds service_timeout) {
1264 DurationReporter duration_reporter(title);
1265 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1266 fsync(STDOUT_FILENO);
1267 RunDumpsysTextByPriority(title, priority, timeout, service_timeout);
1268}
1269
1270/* Dump all services registered with Normal or Default priority. */
Nandana Dutt5c390032019-03-12 10:52:56 +00001271static Dumpstate::RunStatus RunDumpsysTextNormalPriority(const std::string& title,
1272 std::chrono::milliseconds timeout,
1273 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001274 DurationReporter duration_reporter(title);
1275 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1276 fsync(STDOUT_FILENO);
1277 RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_NORMAL, timeout,
1278 service_timeout);
Nandana Dutt5c390032019-03-12 10:52:56 +00001279
1280 RETURN_IF_USER_DENIED_CONSENT();
1281
1282 return RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_DEFAULT, timeout,
1283 service_timeout);
Vishnu Nair64afc022018-02-01 15:29:34 -08001284}
1285
Nandana Dutt5c390032019-03-12 10:52:56 +00001286static Dumpstate::RunStatus RunDumpsysProto(const std::string& title, int priority,
1287 std::chrono::milliseconds timeout,
1288 std::chrono::milliseconds service_timeout) {
Luis Hector Chavez1e27b082018-03-22 15:36:42 -07001289 if (!ds.IsZipping()) {
1290 MYLOGD("Not dumping %s because it's not a zipped bugreport\n", title.c_str());
Nandana Dutt5c390032019-03-12 10:52:56 +00001291 return Dumpstate::RunStatus::OK;
Luis Hector Chavez1e27b082018-03-22 15:36:42 -07001292 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001293 sp<android::IServiceManager> sm = defaultServiceManager();
1294 Dumpsys dumpsys(sm.get());
1295 Vector<String16> args;
1296 Dumpsys::setServiceArgs(args, /* asProto = */ true, priority);
1297 DurationReporter duration_reporter(title);
1298
1299 auto start = std::chrono::steady_clock::now();
1300 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ true);
1301 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001302 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001303 std::string path(kProtoPath);
1304 path.append(String8(service).c_str());
1305 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL) {
1306 path.append("_CRITICAL");
1307 } else if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH) {
1308 path.append("_HIGH");
1309 }
1310 path.append(kProtoExt);
Steven Moreland5a30d342019-10-08 13:53:28 -07001311 status_t status = dumpsys.startDumpThread(Dumpsys::Type::DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001312 if (status == OK) {
1313 status = ds.AddZipEntryFromFd(path, dumpsys.getDumpFd(), service_timeout);
1314 bool dumpTerminated = (status == OK);
1315 dumpsys.stopDumpThread(dumpTerminated);
1316 }
1317 ZipWriter::FileEntry file_entry;
1318 ds.zip_writer_->GetLastEntry(&file_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -08001319
1320 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1321 std::chrono::steady_clock::now() - start);
1322 if (elapsed_duration > timeout) {
1323 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1324 elapsed_duration.count());
1325 break;
1326 }
1327 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001328 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001329}
1330
Nandana Dutta7db6342018-11-21 14:53:34 +00001331// Runs dumpsys on services that must dump first and will take less than 100ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001332static Dumpstate::RunStatus RunDumpsysCritical() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001333 RunDumpsysText("DUMPSYS CRITICAL", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1334 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Nandana Dutt5c390032019-03-12 10:52:56 +00001335
1336 RETURN_IF_USER_DENIED_CONSENT();
1337
1338 return RunDumpsysProto("DUMPSYS CRITICAL PROTO", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1339 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Vishnu Nair780b1282017-10-10 13:57:24 -07001340}
1341
1342// Runs dumpsys on services that must dump first but can take up to 250ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001343static Dumpstate::RunStatus RunDumpsysHigh() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001344 // TODO meminfo takes ~10s, connectivity takes ~5sec to dump. They are both
1345 // high priority. Reduce timeout once they are able to dump in a shorter time or
1346 // moved to a parallel task.
1347 RunDumpsysText("DUMPSYS HIGH", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1348 /* timeout= */ 90s, /* service_timeout= */ 30s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001349
1350 RETURN_IF_USER_DENIED_CONSENT();
1351
1352 return RunDumpsysProto("DUMPSYS HIGH PROTO", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1353 /* timeout= */ 5s, /* service_timeout= */ 1s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001354}
1355
1356// Runs dumpsys on services that must dump but can take up to 10s to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001357static Dumpstate::RunStatus RunDumpsysNormal() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001358 RunDumpsysTextNormalPriority("DUMPSYS", /* timeout= */ 90s, /* service_timeout= */ 10s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001359
1360 RETURN_IF_USER_DENIED_CONSENT();
1361
1362 return RunDumpsysProto("DUMPSYS PROTO", IServiceManager::DUMP_FLAG_PRIORITY_NORMAL,
1363 /* timeout= */ 90s, /* service_timeout= */ 10s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001364}
1365
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001366/*
1367 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1368 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1369 * if it's not running in the parallel task.
1370 */
1371static void DumpHals(int out_fd = STDOUT_FILENO) {
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001372 if (!ds.IsZipping()) {
Yifan Hong30528a22020-08-07 18:24:06 -07001373 RunCommand("HARDWARE HALS", {"lshal", "--all", "--types=all", "--debug"},
Steven Morelandd3646e02020-09-23 17:26:33 +00001374 CommandOptions::WithTimeout(60).AsRootIfAvailable().Build(),
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001375 false, out_fd);
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001376 return;
1377 }
Yifan Hong30528a22020-08-07 18:24:06 -07001378 RunCommand("HARDWARE HALS", {"lshal", "--all", "--types=all"},
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001379 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build(),
1380 false, out_fd);
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001381
Steven Moreland44cd9482018-01-04 16:24:13 -08001382 using android::hidl::manager::V1_0::IServiceManager;
1383 using android::hardware::defaultServiceManager;
1384
1385 sp<IServiceManager> sm = defaultServiceManager();
1386 if (sm == nullptr) {
1387 MYLOGE("Could not retrieve hwservicemanager to dump hals.\n");
1388 return;
1389 }
1390
1391 auto ret = sm->list([&](const auto& interfaces) {
1392 for (const std::string& interface : interfaces) {
1393 std::string cleanName = interface;
1394 std::replace_if(cleanName.begin(),
1395 cleanName.end(),
1396 [](char c) {
1397 return !isalnum(c) &&
1398 std::string("@-_:.").find(c) == std::string::npos;
1399 }, '_');
Nandana Dutt979388e2018-11-30 16:48:55 +00001400 const std::string path = ds.bugreport_internal_dir_ + "/lshal_debug_" + cleanName;
Steven Moreland44cd9482018-01-04 16:24:13 -08001401
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001402 bool empty = false;
Steven Moreland44cd9482018-01-04 16:24:13 -08001403 {
1404 auto fd = android::base::unique_fd(
1405 TEMP_FAILURE_RETRY(open(path.c_str(),
1406 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1407 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1408 if (fd < 0) {
1409 MYLOGE("Could not open %s to dump additional hal information.\n", path.c_str());
1410 continue;
1411 }
1412 RunCommandToFd(fd,
1413 "",
Steven Morelandc81cd3c2018-01-18 14:36:26 -08001414 {"lshal", "debug", "-E", interface},
Steven Moreland44cd9482018-01-04 16:24:13 -08001415 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
1416
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001417 empty = 0 == lseek(fd, 0, SEEK_END);
Steven Moreland44cd9482018-01-04 16:24:13 -08001418 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001419 if (!empty) {
1420 ds.EnqueueAddZipEntryAndCleanupIfNeeded("lshal-debug/" + cleanName + ".txt",
1421 path);
1422 } else {
1423 unlink(path.c_str());
1424 }
Steven Moreland44cd9482018-01-04 16:24:13 -08001425 }
1426 });
1427
1428 if (!ret.isOk()) {
1429 MYLOGE("Could not list hals from hwservicemanager.\n");
1430 }
1431}
1432
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001433static void DumpExternalFragmentationInfo() {
1434 struct stat st;
1435 if (stat("/proc/buddyinfo", &st) != 0) {
1436 MYLOGE("Unable to dump external fragmentation info\n");
1437 return;
1438 }
1439
1440 printf("------ EXTERNAL FRAGMENTATION INFO ------\n");
1441 std::ifstream ifs("/proc/buddyinfo");
1442 auto unusable_index_regex = std::regex{"Node\\s+([0-9]+),\\s+zone\\s+(\\S+)\\s+(.*)"};
1443 for (std::string line; std::getline(ifs, line);) {
1444 std::smatch match_results;
1445 if (std::regex_match(line, match_results, unusable_index_regex)) {
1446 std::stringstream free_pages(std::string{match_results[3]});
1447 std::vector<int> free_pages_per_order(std::istream_iterator<int>{free_pages},
1448 std::istream_iterator<int>());
1449
1450 int total_free_pages = 0;
1451 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1452 total_free_pages += (free_pages_per_order[i] * std::pow(2, i));
1453 }
1454
1455 printf("Node %s, zone %8s", match_results[1].str().c_str(),
1456 match_results[2].str().c_str());
1457
1458 int usable_free_pages = total_free_pages;
1459 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1460 auto unusable_index = (total_free_pages - usable_free_pages) /
1461 static_cast<double>(total_free_pages);
1462 printf(" %5.3f", unusable_index);
1463 usable_free_pages -= (free_pages_per_order[i] * std::pow(2, i));
1464 }
1465
1466 printf("\n");
1467 }
1468 }
1469 printf("\n");
1470}
1471
mhasankd451a472020-05-26 18:02:39 -07001472static void DumpstateLimitedOnly() {
1473 // Trimmed-down version of dumpstate to only include a whitelisted
1474 // set of logs (system log, event log, and system server / system app
1475 // crashes, and networking logs). See b/136273873 and b/138459828
1476 // for context.
1477 DurationReporter duration_reporter("DUMPSTATE");
1478 unsigned long timeout_ms;
1479 // calculate timeout
1480 timeout_ms = logcat_timeout({"main", "system", "crash"});
1481 RunCommand("SYSTEM LOG",
1482 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1483 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1484 timeout_ms = logcat_timeout({"events"});
1485 RunCommand(
1486 "EVENT LOG",
1487 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1488 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1489
1490 printf("========================================================\n");
1491 printf("== Networking Service\n");
1492 printf("========================================================\n");
1493
1494 RunDumpsys("DUMPSYS NETWORK_SERVICE_LIMITED", {"wifi", "-a"},
1495 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hugo Benichiaa162682020-10-30 23:28:56 +09001496 RunDumpsys("DUMPSYS CONNECTIVITY REQUESTS", {"connectivity", "requests"},
1497 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
mhasankd451a472020-05-26 18:02:39 -07001498
1499 printf("========================================================\n");
1500 printf("== Dropbox crashes\n");
1501 printf("========================================================\n");
1502
1503 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1504 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1505
1506 printf("========================================================\n");
1507 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1508 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1509 printf("========================================================\n");
1510 printf("== dumpstate: done (id %d)\n", ds.id_);
1511 printf("========================================================\n");
1512}
1513
Rhed Jaoe017f982020-07-21 17:58:41 +08001514/*
1515 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1516 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1517 * if it's not running in the parallel task.
1518 */
1519static void DumpCheckins(int out_fd = STDOUT_FILENO) {
1520 dprintf(out_fd, "========================================================\n");
1521 dprintf(out_fd, "== Checkins\n");
1522 dprintf(out_fd, "========================================================\n");
1523
1524 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"}, out_fd);
1525 RunDumpsys("CHECKIN MEMINFO", {"meminfo", "--checkin"}, out_fd);
1526 RunDumpsys("CHECKIN NETSTATS", {"netstats", "--checkin"}, out_fd);
1527 RunDumpsys("CHECKIN PROCSTATS", {"procstats", "-c"}, out_fd);
1528 RunDumpsys("CHECKIN USAGESTATS", {"usagestats", "-c"}, out_fd);
1529 RunDumpsys("CHECKIN PACKAGE", {"package", "--checkin"}, out_fd);
1530}
1531
1532/*
1533 * Runs dumpsys on activity service to dump all application activities, services
1534 * and providers in the device.
1535 *
1536 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1537 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1538 * if it's not running in the parallel task.
1539 */
1540static void DumpAppInfos(int out_fd = STDOUT_FILENO) {
1541 dprintf(out_fd, "========================================================\n");
1542 dprintf(out_fd, "== Running Application Activities\n");
1543 dprintf(out_fd, "========================================================\n");
1544
1545 // The following dumpsys internally collects output from running apps, so it can take a long
1546 // time. So let's extend the timeout.
1547
1548 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
1549
1550 RunDumpsys("APP ACTIVITIES", {"activity", "-v", "all"}, DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1551
1552 dprintf(out_fd, "========================================================\n");
1553 dprintf(out_fd, "== Running Application Services (platform)\n");
1554 dprintf(out_fd, "========================================================\n");
1555
1556 RunDumpsys("APP SERVICES PLATFORM", {"activity", "service", "all-platform-non-critical"},
1557 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1558
1559 dprintf(out_fd, "========================================================\n");
1560 dprintf(out_fd, "== Running Application Services (non-platform)\n");
1561 dprintf(out_fd, "========================================================\n");
1562
1563 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1564 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1565
1566 dprintf(out_fd, "========================================================\n");
1567 dprintf(out_fd, "== Running Application Providers (platform)\n");
1568 dprintf(out_fd, "========================================================\n");
1569
1570 RunDumpsys("APP PROVIDERS PLATFORM", {"activity", "provider", "all-platform"},
Rhed Jaob049f182021-01-11 21:08:43 +08001571 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
Rhed Jaoe017f982020-07-21 17:58:41 +08001572
1573 dprintf(out_fd, "========================================================\n");
1574 dprintf(out_fd, "== Running Application Providers (non-platform)\n");
1575 dprintf(out_fd, "========================================================\n");
1576
1577 RunDumpsys("APP PROVIDERS NON-PLATFORM", {"activity", "provider", "all-non-platform"},
1578 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1579}
1580
Nandana Dutt5c390032019-03-12 10:52:56 +00001581// Dumps various things. Returns early with status USER_CONSENT_DENIED if user denies consent
1582// via the consent they are shown. Ignores other errors that occur while running various
1583// commands. The consent checking is currently done around long running tasks, which happen to
1584// be distributed fairly evenly throughout the function.
1585static Dumpstate::RunStatus dumpstate() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001586 DurationReporter duration_reporter("DUMPSTATE");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001587
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001588 // Enqueue slow functions into the thread pool, if the parallel run is enabled.
1589 if (ds.dump_pool_) {
1590 // Pool was shutdown in DumpstateDefaultAfterCritical method in order to
1591 // drop root user. Restarts it with two threads for the parallel run.
1592 ds.dump_pool_->start(/* thread_counts = */2);
1593
1594 ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
1595 ds.dump_pool_->enqueueTask(DUMP_INCIDENT_REPORT_TASK, &DumpIncidentReport);
1596 ds.dump_pool_->enqueueTaskWithFd(DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
Rhed Jaoe017f982020-07-21 17:58:41 +08001597 ds.dump_pool_->enqueueTaskWithFd(DUMP_CHECKINS_TASK, &DumpCheckins, _1);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001598 }
1599
Nandana Dutt5c390032019-03-12 10:52:56 +00001600 // Dump various things. Note that anything that takes "long" (i.e. several seconds) should
1601 // check intermittently (if it's intrerruptable like a foreach on pids) and/or should be wrapped
1602 // in a consent check (via RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK).
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -07001603 dump_dev_files("TRUSTY VERSION", "/sys/bus/platform/drivers/trusty", "trusty_version");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001604 RunCommand("UPTIME", {"uptime"});
Wei Wang509bb5d2017-06-09 14:42:12 -07001605 DumpBlockStatFiles();
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001606 DumpFile("MEMORY INFO", "/proc/meminfo");
1607 RunCommand("CPU INFO", {"top", "-b", "-n", "1", "-H", "-s", "6", "-o",
Felipe Leme30dbfa12016-09-02 12:43:26 -07001608 "pid,tid,user,pr,ni,%cpu,s,virt,res,pcy,cmd,name"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001609
1610 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "PROCRANK", {"procrank"}, AS_ROOT_20);
1611
Sunny Goyal35949782019-11-19 15:54:36 -08001612 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpVisibleWindowViews);
1613
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001614 DumpFile("VIRTUAL MEMORY STATS", "/proc/vmstat");
1615 DumpFile("VMALLOC INFO", "/proc/vmallocinfo");
1616 DumpFile("SLAB INFO", "/proc/slabinfo");
1617 DumpFile("ZONEINFO", "/proc/zoneinfo");
1618 DumpFile("PAGETYPEINFO", "/proc/pagetypeinfo");
1619 DumpFile("BUDDYINFO", "/proc/buddyinfo");
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001620 DumpExternalFragmentationInfo();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001621
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001622 DumpFile("KERNEL WAKE SOURCES", "/d/wakeup_sources");
1623 DumpFile("KERNEL CPUFREQ", "/sys/devices/system/cpu/cpu0/cpufreq/stats/time_in_state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001624
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001625 RunCommand("PROCESSES AND THREADS",
Yohei Yukawa591a72d2017-10-05 21:36:35 -07001626 {"ps", "-A", "-T", "-Z", "-O", "pri,nice,rtprio,sched,pcy,time"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001627
1628 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "LIBRANK", {"librank"},
1629 CommandOptions::AS_ROOT);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001630
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001631 if (ds.dump_pool_) {
1632 WAIT_TASK_WITH_CONSENT_CHECK(DUMP_HALS_TASK, ds.dump_pool_);
1633 } else {
1634 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_HALS_TASK, DumpHals);
1635 }
Steven Moreland81b429e2017-01-31 19:50:46 -08001636
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001637 RunCommand("PRINTENV", {"printenv"});
Elliott Hughes21b7c8d2016-10-28 08:53:02 -07001638 RunCommand("NETSTAT", {"netstat", "-nW"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001639 struct stat s;
1640 if (stat("/proc/modules", &s) != 0) {
1641 MYLOGD("Skipping 'lsmod' because /proc/modules does not exist\n");
1642 } else {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001643 RunCommand("LSMOD", {"lsmod"});
Woody Linc198f252021-05-04 16:37:11 +08001644 RunCommand("MODULES INFO",
1645 {"sh", "-c", "cat /proc/modules | cut -d' ' -f1 | "
1646 " while read MOD ; do echo modinfo:$MOD ; modinfo $MOD ; "
1647 "done"}, CommandOptions::AS_ROOT);
Felipe Lemee4eca582016-06-10 17:48:08 -07001648 }
Michal Karpinski4db754f2015-12-11 18:04:32 +00001649
Tom Cherryb87dbfa2020-07-28 11:28:53 -07001650 if (android::base::GetBoolProperty("ro.logd.kernel", false)) {
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001651 DoKernelLogcat();
1652 } else {
1653 do_dmesg();
1654 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001655
Felipe Lemef0292972016-11-22 13:57:05 -08001656 RunCommand("LIST OF OPEN FILES", {"lsof"}, CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001657
1658 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(for_each_pid, do_showmap, "SMAPS OF ALL PROCESSES");
1659
Jeff Brown1dc94e32014-09-11 14:15:27 -07001660 for_each_tid(show_wchan, "BLOCKED PROCESS WAIT-CHANNELS");
Mark Salyzyna297c322016-02-05 15:33:17 -08001661 for_each_pid(show_showtime, "PROCESS TIMES (pid cmd user system iowait+percentage)");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001662
Jack Yu5a6b2e22020-08-14 18:13:35 +08001663 /* Dump Nfc NCI logs */
1664 ds.AddDir("/data/misc/nfc/logs", true);
Ajay Panickerd886ec42016-09-14 12:26:46 -07001665
Paul Chang0d2aad72020-02-13 20:04:03 +08001666 if (ds.options_->do_screenshot && !ds.do_early_screenshot_) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001667 MYLOGI("taking late screenshot\n");
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001668 ds.TakeScreenshot();
Jeff Sharkey5a930032013-03-19 15:05:19 -07001669 }
1670
Felipe Lemee184f662016-10-27 10:04:47 -07001671 AddAnrTraceFiles();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001672
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001673 MaybeAddSystemTraceToZip();
1674
Narayan Kamath8f788292017-05-25 13:20:39 +01001675 // NOTE: tombstones are always added as separate entries in the zip archive
1676 // and are not interspersed with the main report.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001677 const bool tombstones_dumped = AddDumps(ds.tombstone_data_.begin(), ds.tombstone_data_.end(),
Narayan Kamathbd863722017-06-01 18:50:12 +01001678 "TOMBSTONE", true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001679 if (!tombstones_dumped) {
1680 printf("*** NO TOMBSTONES to dump in %s\n\n", TOMBSTONE_DIR.c_str());
Christopher Ferris7dc7f322014-07-22 16:08:19 -07001681 }
1682
Jayachandran Ca94c7172017-06-10 15:08:12 -07001683 DumpPacketStats();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001684
Chenbo Feng276a3b62018-08-07 11:44:49 -07001685 RunDumpsys("EBPF MAP STATS", {"netd", "trafficcontroller"});
1686
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001687 DoKmsg();
Mark Salyzyn2262c162014-12-16 09:09:26 -08001688
Jayachandran Ca94c7172017-06-10 15:08:12 -07001689 DumpIpAddrAndRules();
Sreeram Ramachandran2b3bba32014-07-08 15:40:55 -07001690
1691 dump_route_tables();
1692
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001693 RunCommand("ARP CACHE", {"ip", "-4", "neigh", "show"});
1694 RunCommand("IPv6 ND CACHE", {"ip", "-6", "neigh", "show"});
1695 RunCommand("MULTICAST ADDRESSES", {"ip", "maddr"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001696
Nandana Dutt5c390032019-03-12 10:52:56 +00001697 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysHigh);
Lorenzo Colitti6afc38c2015-09-09 22:59:25 +09001698
Chiachang Wang668ede42021-05-17 17:14:20 +08001699 // The dump mechanism in connectivity is refactored due to modularization work. Connectivity can
1700 // only register with a default priority(NORMAL priority). Dumpstate has to call connectivity
1701 // dump with priority parameters to dump high priority information.
1702 RunDumpsys("SERVICE HIGH connectivity", {"connectivity", "--dump-priority", "HIGH"},
1703 CommandOptions::WithTimeout(10).Build());
1704
Elliott Hughes23ccc622017-02-28 10:14:22 -08001705 RunCommand("SYSTEM PROPERTIES", {"getprop"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001706
Jin Qianf334d662017-10-10 14:41:37 -07001707 RunCommand("STORAGED IO INFO", {"storaged", "-u", "-p"});
ynwangf649a6e2016-07-17 21:56:00 -07001708
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001709 RunCommand("FILESYSTEMS & FREE SPACE", {"df"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001710
Colin Crossf45fa6b2012-03-26 12:38:26 -07001711 /* Binder state is expensive to look at as it uses a lot of memory. */
Hridya Valsaraju920ba712020-02-09 16:27:01 -08001712 std::string binder_logs_dir = access("/dev/binderfs/binder_logs", R_OK) ?
1713 "/sys/kernel/debug/binder" : "/dev/binderfs/binder_logs";
1714
1715 DumpFile("BINDER FAILED TRANSACTION LOG", binder_logs_dir + "/failed_transaction_log");
1716 DumpFile("BINDER TRANSACTION LOG", binder_logs_dir + "/transaction_log");
1717 DumpFile("BINDER TRANSACTIONS", binder_logs_dir + "/transactions");
1718 DumpFile("BINDER STATS", binder_logs_dir + "/stats");
1719 DumpFile("BINDER STATE", binder_logs_dir + "/state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001720
Vishnu Nair36b4cdb2017-11-17 10:27:05 -08001721 /* Add window and surface trace files. */
1722 if (!PropertiesHelper::IsUserBuild()) {
1723 ds.AddDir(WMTRACE_DATA_DIR, false);
1724 }
1725
Yifan Hongd90cc652020-02-08 16:52:02 -08001726 ds.AddDir(SNAPSHOTCTL_LOG_DIR, false);
1727
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001728 if (ds.dump_pool_) {
1729 WAIT_TASK_WITH_CONSENT_CHECK(DUMP_BOARD_TASK, ds.dump_pool_);
1730 } else {
1731 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
1732 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001733
Steven Moreland7440ddb2016-12-15 16:13:39 -08001734 /* Migrate the ril_dumpstate to a device specific dumpstate? */
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001735 int rilDumpstateTimeout = android::base::GetIntProperty("ril.dumpstate.timeout", 0);
1736 if (rilDumpstateTimeout > 0) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001737 // su does not exist on user builds, so try running without it.
1738 // This way any implementations of vril-dump that do not require
1739 // root can run on user builds.
1740 CommandOptions::CommandOptionsBuilder options =
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001741 CommandOptions::WithTimeout(rilDumpstateTimeout);
Felipe Lemef0292972016-11-22 13:57:05 -08001742 if (!PropertiesHelper::IsUserBuild()) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001743 options.AsRoot();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001744 }
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001745 RunCommand("DUMP VENDOR RIL LOGS", {"vril-dump"}, options.Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -07001746 }
1747
Felipe Lemed8b94e52016-12-08 10:21:44 -08001748 printf("========================================================\n");
1749 printf("== Android Framework Services\n");
1750 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001751
Nandana Dutt5c390032019-03-12 10:52:56 +00001752 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysNormal);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001753
Jack He91ff2fe2021-02-18 18:23:43 -08001754 /* Dump Bluetooth HCI logs after getting bluetooth_manager dumpsys */
1755 ds.AddDir("/data/misc/bluetooth/logs", true);
1756
Rhed Jaoe017f982020-07-21 17:58:41 +08001757 if (ds.dump_pool_) {
1758 WAIT_TASK_WITH_CONSENT_CHECK(DUMP_CHECKINS_TASK, ds.dump_pool_);
1759 } else {
1760 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_CHECKINS_TASK, DumpCheckins);
1761 }
Dianne Hackborn02bea972013-06-26 18:59:09 -07001762
Rhed Jaoc5f7ec32020-12-22 22:11:08 +08001763 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpAppInfos);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001764
Adrian Roos8b397ab2017-04-04 16:35:44 -07001765 printf("========================================================\n");
1766 printf("== Dropbox crashes\n");
1767 printf("========================================================\n");
1768
1769 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1770 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1771
Felipe Lemed8b94e52016-12-08 10:21:44 -08001772 printf("========================================================\n");
1773 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1774 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1775 printf("========================================================\n");
1776 printf("== dumpstate: done (id %d)\n", ds.id_);
1777 printf("========================================================\n");
Bookatz38472142018-09-28 10:20:24 -07001778
1779 printf("========================================================\n");
1780 printf("== Obtaining statsd metadata\n");
1781 printf("========================================================\n");
1782 // This differs from the usual dumpsys stats, which is the stats report data.
1783 RunDumpsys("STATSDSTATS", {"stats", "--metadata"});
Mike Ma5c267872019-08-21 11:31:34 -07001784
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +09001785 // Add linker configuration directory
1786 ds.AddDir(LINKERCONFIG_DIR, true);
1787
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001788 if (ds.dump_pool_) {
1789 WAIT_TASK_WITH_CONSENT_CHECK(DUMP_INCIDENT_REPORT_TASK, ds.dump_pool_);
1790 } else {
1791 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_INCIDENT_REPORT_TASK,
1792 DumpIncidentReport);
1793 }
Mike Ma5c267872019-08-21 11:31:34 -07001794
Nandana Dutt5c390032019-03-12 10:52:56 +00001795 return Dumpstate::RunStatus::OK;
Colin Crossf45fa6b2012-03-26 12:38:26 -07001796}
1797
Nandana Dutt5c390032019-03-12 10:52:56 +00001798/*
1799 * Dumps state for the default case; drops root after it's no longer necessary.
1800 *
1801 * Returns RunStatus::OK if everything went fine.
1802 * Returns RunStatus::ERROR if there was an error.
1803 * Returns RunStatus::USER_DENIED_CONSENT if user explicitly denied consent to sharing the bugreport
1804 * with the caller.
1805 */
Jichao Lie89d9c12019-11-21 19:02:51 -08001806Dumpstate::RunStatus Dumpstate::DumpstateDefaultAfterCritical() {
Nandana Duttdb379fa2019-10-09 16:54:41 +01001807 // Capture first logcat early on; useful to take a snapshot before dumpstate logs take over the
1808 // buffer.
1809 DoLogcat();
1810 // Capture timestamp after first logcat to use in next logcat
1811 time_t logcat_ts = time(nullptr);
1812
Nandana Dutt4be45d12018-09-26 15:04:23 +01001813 /* collect stack traces from Dalvik and native processes (needs root) */
Rhed Jao5377d792020-07-16 17:37:39 +08001814 if (dump_pool_) {
1815 RETURN_IF_USER_DENIED_CONSENT();
1816 // One thread is enough since we only need to enqueue DumpTraces here.
1817 dump_pool_->start(/* thread_counts = */1);
1818
1819 // DumpTraces takes long time, post it to the another thread in the
1820 // pool, if pool is available
1821 dump_pool_->enqueueTask(DUMP_TRACES_TASK, &Dumpstate::DumpTraces, &ds, &dump_traces_path);
1822 } else {
1823 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_TRACES_TASK, ds.DumpTraces,
1824 &dump_traces_path);
1825 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001826
1827 /* Run some operations that require root. */
1828 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX, !ds.IsZipping());
1829 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX, !ds.IsZipping());
1830
1831 ds.AddDir(RECOVERY_DIR, true);
1832 ds.AddDir(RECOVERY_DATA_DIR, true);
1833 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
1834 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1835 if (!PropertiesHelper::IsUserBuild()) {
1836 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1837 ds.AddDir(PROFILE_DATA_DIR_REF, true);
Calin Juravlef84d3692020-04-28 15:31:12 -07001838 ds.AddZipEntry(ZIP_ROOT_DIR + PACKAGE_DEX_USE_LIST, PACKAGE_DEX_USE_LIST);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001839 }
Jerry Changa1df8a92020-01-02 16:03:39 +08001840 ds.AddDir(PREREBOOT_DATA_DIR, false);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001841 add_mountinfo();
1842 DumpIpTablesAsRoot();
David Andersond9ba4752018-12-11 18:26:59 -08001843 DumpDynamicPartitionInfo();
Yifan Hong3945e1b2019-10-29 12:59:23 -07001844 ds.AddDir(OTA_METADATA_DIR, true);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001845
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001846 // Capture any IPSec policies in play. No keys are exposed here.
Nandana Dutt4be45d12018-09-26 15:04:23 +01001847 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1848
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001849 // Dump IPsec stats. No keys are exposed here.
1850 DumpFile("XFRM STATS", XFRM_STAT_PROC_FILE);
1851
Nandana Dutt4be45d12018-09-26 15:04:23 +01001852 // Run ss as root so we can see socket marks.
1853 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
1854
1855 // Run iotop as root to show top 100 IO threads
1856 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
1857
Erick Reyese68df822019-02-11 14:46:36 -08001858 // Gather shared memory buffer info if the product implements it
Hridya Valsaraju1da80c52021-01-09 22:10:11 -08001859 RunCommand("Dmabuf dump", {"dmabuf_dump"});
1860 RunCommand("Dmabuf per-buffer/per-exporter/per-device stats", {"dmabuf_dump", "-b"});
Erick Reyese68df822019-02-11 14:46:36 -08001861
Minchan Kim22c6a1e2019-09-30 15:58:10 -07001862 DumpFile("PSI cpu", "/proc/pressure/cpu");
1863 DumpFile("PSI memory", "/proc/pressure/memory");
1864 DumpFile("PSI io", "/proc/pressure/io");
1865
Rhed Jao5377d792020-07-16 17:37:39 +08001866 if (dump_pool_) {
1867 RETURN_IF_USER_DENIED_CONSENT();
1868 dump_pool_->waitForTask(DUMP_TRACES_TASK);
1869
1870 // Current running thread in the pool is the root user also. Shutdown
1871 // the pool and restart later to ensure all threads in the pool could
1872 // drop the root user.
1873 dump_pool_->shutdown();
1874 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001875 if (!DropRootUser()) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001876 return Dumpstate::RunStatus::ERROR;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001877 }
1878
Nandana Dutt5c390032019-03-12 10:52:56 +00001879 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttdb379fa2019-10-09 16:54:41 +01001880 Dumpstate::RunStatus status = dumpstate();
1881 // Capture logcat since the last time we did it.
1882 DoSystemLogcat(logcat_ts);
1883 return status;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001884}
1885
Rhed Jaob5685b32020-08-14 17:19:17 +08001886// Common states for telephony and wifi which are needed to be collected before
1887// dumpstate drop the root user.
1888static void DumpstateRadioAsRoot() {
1889 DumpIpTablesAsRoot();
1890 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1891}
1892
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001893// This method collects common dumpsys for telephony and wifi. Typically, wifi
1894// reports are fine to include all information, but telephony reports on user
1895// builds need to strip some content (see DumpstateTelephonyOnly).
1896static void DumpstateRadioCommon(bool include_sensitive_info = true) {
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001897 // We need to be picky about some stuff for telephony reports on user builds.
1898 if (!include_sensitive_info) {
1899 // Only dump the radio log buffer (other buffers and dumps contain too much unrelated info).
1900 DoRadioLogcat();
1901 } else {
Rhed Jaob5685b32020-08-14 17:19:17 +08001902 // DumpHals takes long time, post it to the another thread in the pool,
1903 // if pool is available.
1904 if (ds.dump_pool_) {
1905 ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
1906 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001907 // Contains various system properties and process startup info.
1908 do_dmesg();
1909 // Logs other than the radio buffer may contain package/component names and potential PII.
1910 DoLogcat();
1911 // Too broad for connectivity problems.
1912 DoKmsg();
Rhed Jaob5685b32020-08-14 17:19:17 +08001913 // DumpHals contains unrelated hardware info (camera, NFC, biometrics, ...).
1914 if (ds.dump_pool_) {
1915 ds.dump_pool_->waitForTask(DUMP_HALS_TASK);
1916 } else {
1917 RUN_SLOW_FUNCTION_AND_LOG(DUMP_HALS_TASK, DumpHals);
1918 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001919 }
1920
Jayachandran Ca94c7172017-06-10 15:08:12 -07001921 DumpPacketStats();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001922 DumpIpAddrAndRules();
1923 dump_route_tables();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001924 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
1925 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08001926}
1927
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001928// We use "telephony" here for legacy reasons, though this now really means "connectivity" (cellular
1929// + wifi + networking). This method collects dumpsys for connectivity debugging only. General rules
1930// for what can be included on user builds: all reported information MUST directly relate to
1931// connectivity debugging or customer support and MUST NOT contain unrelated personally identifiable
1932// information. This information MUST NOT identify user-installed packages (UIDs are OK, package
1933// names are not), and MUST NOT contain logs of user application traffic.
1934// TODO(b/148168577) rename this and other related fields/methods to "connectivity" instead.
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08001935static void DumpstateTelephonyOnly(const std::string& calling_package) {
mukesh agrawal253dad42018-01-23 21:59:59 -08001936 DurationReporter duration_reporter("DUMPSTATE");
Jichao Lie89d9c12019-11-21 19:02:51 -08001937
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001938 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08001939
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001940 const bool include_sensitive_info = !PropertiesHelper::IsUserBuild();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001941
Rhed Jaob5685b32020-08-14 17:19:17 +08001942 DumpstateRadioAsRoot();
1943 if (!DropRootUser()) {
1944 return;
1945 }
1946
1947 // Starts thread pool after the root user is dropped, and two additional threads
1948 // are created for DumpHals in the DumpstateRadioCommon and DumpstateBoard.
1949 if (ds.dump_pool_) {
1950 ds.dump_pool_->start(/*thread_counts =*/2);
1951
1952 // DumpstateBoard takes long time, post it to the another thread in the pool,
1953 // if pool is available.
1954 ds.dump_pool_->enqueueTaskWithFd(DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
1955 }
1956
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001957 DumpstateRadioCommon(include_sensitive_info);
1958
1959 if (include_sensitive_info) {
1960 // Contains too much unrelated PII, and given the unstructured nature of sysprops, we can't
1961 // really cherrypick all of the connectivity-related ones. Apps generally have no business
1962 // reading these anyway, and there should be APIs to supply the info in a more app-friendly
1963 // way.
1964 RunCommand("SYSTEM PROPERTIES", {"getprop"});
1965 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07001966
1967 printf("========================================================\n");
1968 printf("== Android Framework Services\n");
1969 printf("========================================================\n");
1970
Vishnu Nair652cc802017-11-30 15:18:30 -08001971 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1972 SEC_TO_MSEC(10));
Hunter Knepshield31cbae12021-05-11 16:23:24 -07001973 RunDumpsys("DUMPSYS", {"vcn_management"}, CommandOptions::WithTimeout(90).Build(),
1974 SEC_TO_MSEC(10));
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08001975 if (include_sensitive_info) {
1976 // Carrier apps' services will be dumped below in dumpsys activity service all-non-platform.
1977 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
1978 SEC_TO_MSEC(10));
1979 } else {
1980 // If the caller is a carrier app and has a carrier service, dump it here since we aren't
1981 // running dumpsys activity service all-non-platform below. Due to the increased output, we
1982 // give a higher timeout as well.
1983 RunDumpsys("DUMPSYS", {"carrier_config", "--requesting-package", calling_package},
1984 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(30));
1985 }
1986 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001987 RunDumpsys("DUMPSYS", {"netpolicy"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
1988 RunDumpsys("DUMPSYS", {"network_management"}, CommandOptions::WithTimeout(90).Build(),
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07001989 SEC_TO_MSEC(10));
Hunter Knepshield0fe51b12020-03-05 16:58:20 -08001990 RunDumpsys("DUMPSYS", {"telephony.registry"}, CommandOptions::WithTimeout(90).Build(),
1991 SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001992 if (include_sensitive_info) {
1993 // Contains raw IP addresses, omit from reports on user builds.
1994 RunDumpsys("DUMPSYS", {"netd"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
1995 // Contains raw destination IP/MAC addresses, omit from reports on user builds.
1996 RunDumpsys("DUMPSYS", {"connmetrics"}, CommandOptions::WithTimeout(90).Build(),
1997 SEC_TO_MSEC(10));
1998 // Contains package/component names, omit from reports on user builds.
1999 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
2000 SEC_TO_MSEC(10));
2001 // Contains package names, but should be relatively simple to remove them (also contains
2002 // UIDs already), omit from reports on user builds.
2003 RunDumpsys("BATTERYSTATS", {"deviceidle"}, CommandOptions::WithTimeout(90).Build(),
2004 SEC_TO_MSEC(10));
2005 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002006
2007 printf("========================================================\n");
2008 printf("== Running Application Services\n");
2009 printf("========================================================\n");
2010
2011 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
2012
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002013 if (include_sensitive_info) {
2014 printf("========================================================\n");
2015 printf("== Running Application Services (non-platform)\n");
2016 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002017
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002018 // Contains package/component names and potential PII, omit from reports on user builds.
2019 // To get dumps of the active CarrierService(s) on user builds, we supply an argument to the
2020 // carrier_config dumpsys instead.
2021 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
2022 DUMPSYS_COMPONENTS_OPTIONS);
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002023
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002024 printf("========================================================\n");
2025 printf("== Checkins\n");
2026 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002027
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002028 // Contains package/component names, omit from reports on user builds.
2029 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
2030 }
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002031
2032 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07002033 printf("== dumpstate: done (id %d)\n", ds.id_);
2034 printf("========================================================\n");
Rhed Jaob5685b32020-08-14 17:19:17 +08002035
2036 if (ds.dump_pool_) {
2037 ds.dump_pool_->waitForTask(DUMP_BOARD_TASK);
2038 } else {
2039 RUN_SLOW_FUNCTION_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
2040 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002041}
2042
mukesh agrawal253dad42018-01-23 21:59:59 -08002043// This method collects dumpsys for wifi debugging only
2044static void DumpstateWifiOnly() {
2045 DurationReporter duration_reporter("DUMPSTATE");
2046
Rhed Jaob5685b32020-08-14 17:19:17 +08002047 DumpstateRadioAsRoot();
2048 if (!DropRootUser()) {
2049 return;
2050 }
2051
2052 // Starts thread pool after the root user is dropped. Only one additional
2053 // thread is needed for DumpHals in the DumpstateRadioCommon.
2054 if (ds.dump_pool_) {
2055 ds.dump_pool_->start(/*thread_counts =*/1);
2056 }
2057
mukesh agrawal253dad42018-01-23 21:59:59 -08002058 DumpstateRadioCommon();
2059
2060 printf("========================================================\n");
2061 printf("== Android Framework Services\n");
2062 printf("========================================================\n");
2063
2064 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
2065 SEC_TO_MSEC(10));
2066 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
2067 SEC_TO_MSEC(10));
2068
2069 printf("========================================================\n");
2070 printf("== dumpstate: done (id %d)\n", ds.id_);
2071 printf("========================================================\n");
2072}
2073
Nandana Duttcf419a72019-03-14 10:40:17 +00002074Dumpstate::RunStatus Dumpstate::DumpTraces(const char** path) {
Gavin Corkery789d7a52021-02-24 23:52:35 +00002075 const std::string temp_file_pattern = ds.bugreport_internal_dir_ + "/dumptrace_XXXXXX";
Nandana Duttfaafd522019-03-11 09:23:09 +00002076 const size_t buf_size = temp_file_pattern.length() + 1;
2077 std::unique_ptr<char[]> file_name_buf(new char[buf_size]);
2078 memcpy(file_name_buf.get(), temp_file_pattern.c_str(), buf_size);
2079
2080 // Create a new, empty file to receive all trace dumps.
2081 //
2082 // TODO: This can be simplified once we remove support for the old style
2083 // dumps. We can have a file descriptor passed in to dump_traces instead
2084 // of creating a file, closing it and then reopening it again.
2085 android::base::unique_fd fd(mkostemp(file_name_buf.get(), O_APPEND | O_CLOEXEC));
2086 if (fd < 0) {
2087 MYLOGE("mkostemp on pattern %s: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002088 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002089 }
2090
2091 // Nobody should have access to this temporary file except dumpstate, but we
2092 // temporarily grant 'read' to 'others' here because this file is created
2093 // when tombstoned is still running as root, but dumped after dropping. This
2094 // can go away once support for old style dumping has.
2095 const int chmod_ret = fchmod(fd, 0666);
2096 if (chmod_ret < 0) {
2097 MYLOGE("fchmod on %s failed: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002098 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002099 }
2100
2101 std::unique_ptr<DIR, decltype(&closedir)> proc(opendir("/proc"), closedir);
2102 if (proc.get() == nullptr) {
2103 MYLOGE("opendir /proc failed: %s\n", strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002104 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002105 }
2106
2107 // Number of times process dumping has timed out. If we encounter too many
2108 // failures, we'll give up.
2109 int timeout_failures = 0;
2110 bool dalvik_found = false;
2111
2112 const std::set<int> hal_pids = get_interesting_hal_pids();
2113
2114 struct dirent* d;
2115 while ((d = readdir(proc.get()))) {
Nandana Duttcf419a72019-03-14 10:40:17 +00002116 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttfaafd522019-03-11 09:23:09 +00002117 int pid = atoi(d->d_name);
2118 if (pid <= 0) {
2119 continue;
2120 }
2121
2122 const std::string link_name = android::base::StringPrintf("/proc/%d/exe", pid);
2123 std::string exe;
2124 if (!android::base::Readlink(link_name, &exe)) {
2125 continue;
2126 }
2127
2128 bool is_java_process;
2129 if (exe == "/system/bin/app_process32" || exe == "/system/bin/app_process64") {
2130 // Don't bother dumping backtraces for the zygote.
2131 if (IsZygote(pid)) {
2132 continue;
2133 }
2134
2135 dalvik_found = true;
2136 is_java_process = true;
2137 } else if (should_dump_native_traces(exe.c_str()) || hal_pids.find(pid) != hal_pids.end()) {
2138 is_java_process = false;
2139 } else {
2140 // Probably a native process we don't care about, continue.
2141 continue;
2142 }
2143
2144 // If 3 backtrace dumps fail in a row, consider debuggerd dead.
2145 if (timeout_failures == 3) {
2146 dprintf(fd, "ERROR: Too many stack dump failures, exiting.\n");
2147 break;
2148 }
2149
2150 const uint64_t start = Nanotime();
2151 const int ret = dump_backtrace_to_file_timeout(
2152 pid, is_java_process ? kDebuggerdJavaBacktrace : kDebuggerdNativeBacktrace,
2153 is_java_process ? 5 : 20, fd);
2154
2155 if (ret == -1) {
2156 // For consistency, the header and footer to this message match those
2157 // dumped by debuggerd in the success case.
2158 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
2159 dprintf(fd, "Dump failed, likely due to a timeout.\n");
2160 dprintf(fd, "---- end %d ----", pid);
2161 timeout_failures++;
2162 continue;
2163 }
2164
2165 // We've successfully dumped stack traces, reset the failure count
2166 // and write a summary of the elapsed time to the file and continue with the
2167 // next process.
2168 timeout_failures = 0;
2169
2170 dprintf(fd, "[dump %s stack %d: %.3fs elapsed]\n", is_java_process ? "dalvik" : "native",
2171 pid, (float)(Nanotime() - start) / NANOS_PER_SEC);
2172 }
2173
2174 if (!dalvik_found) {
2175 MYLOGE("Warning: no Dalvik processes found to dump stacks\n");
2176 }
2177
Nandana Duttcf419a72019-03-14 10:40:17 +00002178 *path = file_name_buf.release();
2179 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002180}
2181
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002182void Dumpstate::DumpstateBoard(int out_fd) {
2183 dprintf(out_fd, "========================================================\n");
2184 dprintf(out_fd, "== Board\n");
2185 dprintf(out_fd, "========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08002186
Felipe Leme6f674ae2016-11-18 17:10:33 -08002187 if (!IsZipping()) {
Steven Moreland7440ddb2016-12-15 16:13:39 -08002188 MYLOGD("Not dumping board info because it's not a zipped bugreport\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08002189 return;
2190 }
2191
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002192 /*
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002193 * mount debugfs for non-user builds with ro.product.debugfs_restrictions.enabled
Hridya Valsaraju51101602021-04-02 14:32:46 -07002194 * set to true and unmount it after invoking dumpstateBoard_* methods.
2195 * This is to enable debug builds to not have debugfs mounted during runtime.
2196 * It will also ensure that debugfs is only accessed by the dumpstate HAL.
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002197 */
Hridya Valsaraju51101602021-04-02 14:32:46 -07002198 auto mount_debugfs =
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002199 android::base::GetBoolProperty("ro.product.debugfs_restrictions.enabled", false);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002200 if (mount_debugfs) {
2201 RunCommand("mount debugfs", {"mount", "-t", "debugfs", "debugfs", "/sys/kernel/debug"},
2202 AS_ROOT_20);
2203 RunCommand("chmod debugfs", {"chmod", "0755", "/sys/kernel/debug"},
2204 AS_ROOT_20);
2205 }
2206
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002207 std::vector<std::string> paths;
2208 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07002209 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002210 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
2211 kDumpstateBoardFiles[i].c_str()));
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002212 remover.emplace_back(android::base::make_scope_guard(
2213 std::bind([](std::string path) { android::os::UnlinkAndLogOnError(path); }, paths[i])));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002214 }
Jie Song9fbfad02017-06-20 16:29:42 -07002215
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002216 sp<IDumpstateDevice_1_0> dumpstate_device_1_0(IDumpstateDevice_1_0::getService());
2217 if (dumpstate_device_1_0 == nullptr) {
Wei Wang587eac92018-04-05 12:17:20 -07002218 MYLOGE("No IDumpstateDevice implementation\n");
2219 return;
2220 }
2221
2222 using ScopedNativeHandle =
2223 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
2224 ScopedNativeHandle handle(native_handle_create(static_cast<int>(paths.size()), 0),
2225 [](native_handle_t* handle) {
2226 native_handle_close(handle);
2227 native_handle_delete(handle);
2228 });
2229 if (handle == nullptr) {
2230 MYLOGE("Could not create native_handle\n");
2231 return;
2232 }
2233
Nandana Dutt5c390032019-03-12 10:52:56 +00002234 // TODO(128270426): Check for consent in between?
Wei Wang587eac92018-04-05 12:17:20 -07002235 for (size_t i = 0; i < paths.size(); i++) {
2236 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
2237
2238 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
2239 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
2240 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
2241 if (fd < 0) {
2242 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
2243 return;
2244 }
2245 handle.get()->data[i] = fd.release();
2246 }
2247
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002248 // Given that bugreport is required to diagnose failures, it's better to set an arbitrary amount
2249 // of timeout for IDumpstateDevice than to block the rest of bugreport. In the timeout case, we
2250 // will kill the HAL and grab whatever it dumped in time.
2251 constexpr size_t timeout_sec = 30;
2252 // Prefer version 1.1 if available. New devices launching with R are no longer allowed to
2253 // implement just 1.0.
2254 const char* descriptor_to_kill;
2255 using DumpstateBoardTask = std::packaged_task<bool()>;
2256 DumpstateBoardTask dumpstate_board_task;
2257 sp<IDumpstateDevice_1_1> dumpstate_device_1_1(
2258 IDumpstateDevice_1_1::castFrom(dumpstate_device_1_0));
2259 if (dumpstate_device_1_1 != nullptr) {
2260 MYLOGI("Using IDumpstateDevice v1.1");
2261 descriptor_to_kill = IDumpstateDevice_1_1::descriptor;
2262 dumpstate_board_task = DumpstateBoardTask([this, dumpstate_device_1_1, &handle]() -> bool {
2263 ::android::hardware::Return<DumpstateStatus> status =
2264 dumpstate_device_1_1->dumpstateBoard_1_1(handle.get(), options_->dumpstate_hal_mode,
2265 SEC_TO_MSEC(timeout_sec));
2266 if (!status.isOk()) {
2267 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2268 return false;
2269 } else if (status != DumpstateStatus::OK) {
2270 MYLOGE("dumpstateBoard failed with DumpstateStatus::%s\n", toString(status).c_str());
2271 return false;
2272 }
2273 return true;
2274 });
2275 } else {
2276 MYLOGI("Using IDumpstateDevice v1.0");
2277 descriptor_to_kill = IDumpstateDevice_1_0::descriptor;
2278 dumpstate_board_task = DumpstateBoardTask([dumpstate_device_1_0, &handle]() -> bool {
2279 ::android::hardware::Return<void> status =
2280 dumpstate_device_1_0->dumpstateBoard(handle.get());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002281 if (!status.isOk()) {
2282 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
Wei Wang587eac92018-04-05 12:17:20 -07002283 return false;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002284 }
Wei Wang587eac92018-04-05 12:17:20 -07002285 return true;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002286 });
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002287 }
2288 auto result = dumpstate_board_task.get_future();
2289 std::thread(std::move(dumpstate_board_task)).detach();
Wei Wang587eac92018-04-05 12:17:20 -07002290
Wei Wang587eac92018-04-05 12:17:20 -07002291 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2292 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate vendor HAL\n", timeout_sec);
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002293 if (!android::base::SetProperty(
2294 "ctl.interface_restart",
2295 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
Wei Wang587eac92018-04-05 12:17:20 -07002296 MYLOGE("Couldn't restart dumpstate HAL\n");
2297 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002298 }
Wei Wang587eac92018-04-05 12:17:20 -07002299 // Wait some time for init to kill dumpstate vendor HAL
2300 constexpr size_t killing_timeout_sec = 10;
2301 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2302 MYLOGE("killing dumpstateBoard timed out after %zus, continue and "
2303 "there might be racing in content\n", killing_timeout_sec);
2304 }
2305
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002306 if (mount_debugfs) {
Hridya Valsaraju51101602021-04-02 14:32:46 -07002307 auto keep_debugfs_mounted =
2308 android::base::GetProperty("persist.dbg.keep_debugfs_mounted", "");
2309 if (keep_debugfs_mounted.empty())
2310 RunCommand("unmount debugfs", {"umount", "/sys/kernel/debug"}, AS_ROOT_20);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002311 }
2312
Wei Wang587eac92018-04-05 12:17:20 -07002313 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
2314 for (size_t i = 0; i < paths.size(); i++) {
2315 struct stat s;
2316 if (fstat(handle.get()->data[i], &s) == -1) {
2317 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(),
2318 strerror(errno));
2319 file_sizes[i] = -1;
2320 continue;
2321 }
2322 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002323 }
2324
2325 for (size_t i = 0; i < paths.size(); i++) {
2326 if (file_sizes[i] == -1) {
2327 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002328 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002329 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07002330 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002331 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002332 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002333 remover[i].Disable();
2334 EnqueueAddZipEntryAndCleanupIfNeeded(kDumpstateBoardFiles[i], paths[i]);
2335 dprintf(out_fd, "*** See %s entry ***\n", kDumpstateBoardFiles[i].c_str());
Jie Song9fbfad02017-06-20 16:29:42 -07002336 }
Felipe Leme6f674ae2016-11-18 17:10:33 -08002337}
2338
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002339static void ShowUsage() {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002340 fprintf(stderr,
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002341 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-o directory] [-p] "
2342 "[-s] [-S] [-q] [-P] [-R] [-L] [-V version]\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002343 " -h: display this help message\n"
2344 " -b: play sound file instead of vibrate, at beginning of job\n"
2345 " -e: play sound file instead of vibrate, at end of job\n"
mhasank2d75c442020-06-11 15:05:25 -07002346 " -o: write to custom directory (only in limited mode)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01002347 " -p: capture screenshot to filename.png\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002348 " -s: write zipped file to control socket (for init)\n"
2349 " -S: write file location to control socket (for init)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002350 " -q: disable vibrate\n"
Abhijeet Kaure370d682019-10-01 16:49:30 +01002351 " -P: send broadcast when started and do progress updates\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002352 " -R: take bugreport in remote mode (shouldn't be used with -P)\n"
Nandana Dutt235864b2019-01-22 12:10:16 +00002353 " -w: start binder service and make it wait for a call to startBugreport\n"
mhasankd451a472020-05-26 18:02:39 -07002354 " -L: output limited information that is safe for submission in feedback reports\n"
Felipe Lemed071c682016-10-20 16:48:00 -07002355 " -v: prints the dumpstate header and exit\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002356}
2357
Wei Liuf87959e2016-08-26 14:51:42 -07002358static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07002359 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07002360}
2361
Felipe Leme1d486fe2016-10-14 18:06:47 -07002362bool Dumpstate::FinishZipFile() {
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002363 // Runs all enqueued adding zip entry and cleanup tasks before finishing the zip file.
2364 if (zip_entry_tasks_) {
2365 zip_entry_tasks_->run(/* do_cancel = */false);
2366 }
2367
Felipe Leme9a523ae2016-10-20 15:10:33 -07002368 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07002369 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07002370 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002371 // Final timestamp
2372 char date[80];
2373 time_t the_real_now_please_stand_up = time(nullptr);
2374 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002375 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07002376 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002377
Felipe Leme9a523ae2016-10-20 15:10:33 -07002378 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002379 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08002380 return false;
2381 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07002382 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002383 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08002384 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08002385 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08002386
Felipe Leme0f3fb202016-06-10 17:10:53 -07002387 // Add log file (which contains stderr output) to zip...
2388 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07002389 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07002390 MYLOGE("Failed to add dumpstate log to .zip file\n");
2391 return false;
2392 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002393 // TODO: Should truncate the existing file.
2394 // ... and re-open it for further logging.
Nandana Dutta344cb62019-02-22 15:12:35 +00002395 if (!redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()))) {
2396 return false;
2397 }
Felipe Leme0f3fb202016-06-10 17:10:53 -07002398 fprintf(stderr, "\n");
2399
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002400 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07002401 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002402 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002403 return false;
2404 }
2405
Felipe Leme1d486fe2016-10-14 18:06:47 -07002406 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
2407 ds.zip_file.reset(nullptr);
2408
Felipe Lemee9d2c542016-11-15 11:48:26 -08002409 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002410 android::os::UnlinkAndLogOnError(tmp_path_);
Felipe Lemec4eee562016-04-21 15:42:55 -07002411
Felipe Leme1e9edc62015-12-21 16:02:13 -08002412 return true;
2413}
Felipe Leme6e01fa62015-11-11 19:35:14 -08002414
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002415static void SendBroadcast(const std::string& action, const std::vector<std::string>& args) {
2416 // clang-format off
2417 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user", "0",
2418 "--receiver-foreground", "--receiver-include-background", "-a", action};
2419 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08002420
2421 am.insert(am.end(), args.begin(), args.end());
2422
Felipe Leme8d2410e2017-02-08 09:46:08 -08002423 RunCommand("", am,
2424 CommandOptions::WithTimeout(20)
2425 .Log("Sending broadcast: '%s'\n")
2426 .Always()
2427 .DropRoot()
2428 .RedirectStderr()
2429 .Build());
2430}
2431
Felipe Leme35b8cf12017-02-10 15:47:29 -08002432static void Vibrate(int duration_ms) {
2433 // clang-format off
Lais Andrade51156962021-02-22 19:21:35 +00002434 std::vector<std::string> args = {"cmd", "vibrator_manager", "synced", "-f", "-d", "dumpstate",
2435 "oneshot", std::to_string(duration_ms)};
2436 RunCommand("", args,
Felipe Leme35b8cf12017-02-10 15:47:29 -08002437 CommandOptions::WithTimeout(10)
2438 .Log("Vibrate: '%s'\n")
2439 .Always()
2440 .Build());
2441 // clang-format on
2442}
2443
Nandana Dutt979388e2018-11-30 16:48:55 +00002444static void MaybeResolveSymlink(std::string* path) {
2445 std::string resolved_path;
2446 if (android::base::Readlink(*path, &resolved_path)) {
2447 *path = resolved_path;
2448 }
2449}
2450
Nandana Dutt4be45d12018-09-26 15:04:23 +01002451/*
2452 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002453 * and adds the version file. Return false if zip_file could not be open to write.
Nandana Dutt4be45d12018-09-26 15:04:23 +01002454 */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002455static bool PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002456 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
2457
Nandana Dutt4be45d12018-09-26 15:04:23 +01002458 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
2459 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002460 ds.base_name_ = StringPrintf("bugreport-%s-%s", device_name.c_str(), build_id.c_str());
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002461 char date[80];
2462 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
2463 ds.name_ = date;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002464
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002465 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002466 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002467 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002468 ds.base_name_ += "-wifi";
2469 }
2470
Paul Chang0d2aad72020-02-13 20:04:03 +08002471 if (ds.options_->do_screenshot) {
Nandana Dutt9d17b942020-03-26 10:02:59 +00002472 ds.screenshot_path_ = ds.GetPath(ds.CalledByApi() ? "-png.tmp" : ".png");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002473 }
2474 ds.tmp_path_ = ds.GetPath(".tmp");
2475 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
2476
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002477 std::string destination = ds.CalledByApi()
Nandana Dutt54dbd672019-01-11 12:58:05 +00002478 ? StringPrintf("[fd:%d]", ds.options_->bugreport_fd.get())
Nandana Dutt9a76d202019-01-21 15:56:48 +00002479 : ds.bugreport_internal_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01002480 MYLOGD(
Nandana Dutt235c6672019-11-14 15:22:32 +00002481 "Bugreport dir: [%s] "
2482 "Base name: [%s] "
2483 "Suffix: [%s] "
2484 "Log path: [%s] "
2485 "Temporary path: [%s] "
2486 "Screenshot path: [%s]\n",
Nandana Dutt9a76d202019-01-21 15:56:48 +00002487 destination.c_str(), ds.base_name_.c_str(), ds.name_.c_str(), ds.log_path_.c_str(),
2488 ds.tmp_path_.c_str(), ds.screenshot_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002489
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002490 ds.path_ = ds.GetPath(ds.CalledByApi() ? "-zip.tmp" : ".zip");
2491 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
2492 create_parent_dirs(ds.path_.c_str());
2493 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
2494 if (ds.zip_file == nullptr) {
2495 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
2496 return false;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002497 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002498 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
2499 ds.AddTextZipEntry("version.txt", ds.version_);
2500 return true;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002501}
2502
2503/*
Abhijeet Kaure370d682019-10-01 16:49:30 +01002504 * Finalizes writing to the file by zipping the tmp file to the final location,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002505 * printing zipped file status, etc.
2506 */
2507static void FinalizeFile() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002508 bool do_text_file = !ds.FinishZipFile();
2509 if (do_text_file) {
2510 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002511 }
mhasank2d75c442020-06-11 15:05:25 -07002512
2513 std::string final_path = ds.path_;
2514 if (ds.options_->OutputToCustomFile()) {
mhasank3a4cfb42020-06-15 18:06:43 -07002515 final_path = ds.GetPath(ds.options_->out_dir, ".zip");
mhasank2d75c442020-06-11 15:05:25 -07002516 android::os::CopyFileToFile(ds.path_, final_path);
2517 }
2518
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002519 if (ds.options_->stream_to_socket) {
2520 android::os::CopyFileToFd(ds.path_, ds.control_socket_fd_);
2521 } else if (ds.options_->progress_updates_to_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002522 if (do_text_file) {
2523 dprintf(ds.control_socket_fd_,
2524 "FAIL:could not create zip file, check %s "
2525 "for more details\n",
2526 ds.log_path_.c_str());
2527 } else {
mhasank2d75c442020-06-11 15:05:25 -07002528 dprintf(ds.control_socket_fd_, "OK:%s\n", final_path.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002529 }
2530 }
2531}
2532
Nandana Dutt4be45d12018-09-26 15:04:23 +01002533
Nandana Dutt58d72e22018-11-16 10:30:48 +00002534static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2535 switch (mode) {
2536 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2537 return "BUGREPORT_FULL";
2538 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2539 return "BUGREPORT_INTERACTIVE";
2540 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2541 return "BUGREPORT_REMOTE";
2542 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2543 return "BUGREPORT_WEAR";
2544 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2545 return "BUGREPORT_TELEPHONY";
2546 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2547 return "BUGREPORT_WIFI";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002548 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2549 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002550 }
2551}
2552
Paul Changf59c2b72020-03-10 02:08:55 +08002553static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options,
2554 bool is_screenshot_requested) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002555 // Modify com.android.shell.BugreportProgressService#isDefaultScreenshotRequired as well for
2556 // default system screenshots.
Abhijeet Kaure370d682019-10-01 16:49:30 +01002557 options->bugreport_mode = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002558 switch (mode) {
2559 case Dumpstate::BugreportMode::BUGREPORT_FULL:
Paul Changf59c2b72020-03-10 02:08:55 +08002560 options->do_screenshot = is_screenshot_requested;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002561 options->dumpstate_hal_mode = DumpstateMode::FULL;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002562 break;
2563 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002564 // Currently, the dumpstate binder is only used by Shell to update progress.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002565 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002566 options->do_screenshot = is_screenshot_requested;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002567 options->dumpstate_hal_mode = DumpstateMode::INTERACTIVE;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002568 break;
2569 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002570 options->do_vibrate = false;
2571 options->is_remote_mode = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002572 options->do_screenshot = false;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002573 options->dumpstate_hal_mode = DumpstateMode::REMOTE;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002574 break;
2575 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002576 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002577 options->do_screenshot = is_screenshot_requested;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002578 options->dumpstate_hal_mode = DumpstateMode::WEAR;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002579 break;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002580 // TODO(b/148168577) rename TELEPHONY everywhere to CONNECTIVITY.
Nandana Dutt58d72e22018-11-16 10:30:48 +00002581 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002582 options->telephony_only = true;
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002583 options->do_progress_updates = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002584 options->do_screenshot = false;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002585 options->dumpstate_hal_mode = DumpstateMode::CONNECTIVITY;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002586 break;
2587 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002588 options->wifi_only = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002589 options->do_screenshot = false;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002590 options->dumpstate_hal_mode = DumpstateMode::WIFI;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002591 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002592 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2593 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002594 }
2595}
2596
Nandana Dutt58d72e22018-11-16 10:30:48 +00002597static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
Nandana Dutt235c6672019-11-14 15:22:32 +00002598 MYLOGI(
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002599 "do_vibrate: %d stream_to_socket: %d progress_updates_to_socket: %d do_screenshot: %d "
Rhed Jao25f50e02020-08-20 00:10:32 +08002600 "is_remote_mode: %d show_header_only: %d telephony_only: %d "
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002601 "wifi_only: %d do_progress_updates: %d fd: %d bugreport_mode: %s dumpstate_hal_mode: %s "
mhasankd451a472020-05-26 18:02:39 -07002602 "limited_only: %d args: %s\n",
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002603 options.do_vibrate, options.stream_to_socket, options.progress_updates_to_socket,
Paul Chang0d2aad72020-02-13 20:04:03 +08002604 options.do_screenshot, options.is_remote_mode, options.show_header_only,
Rhed Jao25f50e02020-08-20 00:10:32 +08002605 options.telephony_only, options.wifi_only,
mhasankd451a472020-05-26 18:02:39 -07002606 options.do_progress_updates, options.bugreport_fd.get(), options.bugreport_mode.c_str(),
2607 toString(options.dumpstate_hal_mode).c_str(), options.limited_only, options.args.c_str());
Nandana Dutt58d72e22018-11-16 10:30:48 +00002608}
2609
Nandana Dutt54dbd672019-01-11 12:58:05 +00002610void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode,
2611 const android::base::unique_fd& bugreport_fd_in,
Paul Changf59c2b72020-03-10 02:08:55 +08002612 const android::base::unique_fd& screenshot_fd_in,
2613 bool is_screenshot_requested) {
Nandana Dutt54dbd672019-01-11 12:58:05 +00002614 // Duplicate the fds because the passed in fds don't outlive the binder transaction.
2615 bugreport_fd.reset(dup(bugreport_fd_in.get()));
2616 screenshot_fd.reset(dup(screenshot_fd_in.get()));
Nandana Dutt58d72e22018-11-16 10:30:48 +00002617
Paul Changf59c2b72020-03-10 02:08:55 +08002618 SetOptionsFromMode(bugreport_mode, this, is_screenshot_requested);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002619}
2620
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002621Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
2622 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002623 int c;
mhasankd451a472020-05-26 18:02:39 -07002624 while ((c = getopt(argc, argv, "dho:svqzpLPBRSV:w")) != -1) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002625 switch (c) {
2626 // clang-format off
mhasank3a4cfb42020-06-15 18:06:43 -07002627 case 'o': out_dir = optarg; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002628 case 's': stream_to_socket = true; break;
2629 case 'S': progress_updates_to_socket = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002630 case 'v': show_header_only = true; break;
2631 case 'q': do_vibrate = false; break;
Paul Chang0d2aad72020-02-13 20:04:03 +08002632 case 'p': do_screenshot = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002633 case 'P': do_progress_updates = true; break;
2634 case 'R': is_remote_mode = true; break;
mhasankd451a472020-05-26 18:02:39 -07002635 case 'L': limited_only = true; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002636 case 'V':
2637 case 'd':
2638 case 'z':
2639 // compatibility no-op
2640 break;
Nandana Dutt235864b2019-01-22 12:10:16 +00002641 case 'w':
2642 // This was already processed
2643 break;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002644 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002645 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002646 break;
2647 default:
2648 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002649 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002650 break;
2651 // clang-format on
2652 }
2653 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08002654
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002655 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002656 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002657 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002658 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002659 }
2660 }
2661
2662 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
2663 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002664
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002665 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002666}
2667
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002668bool Dumpstate::DumpOptions::ValidateOptions() const {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002669 if (bugreport_fd.get() != -1 && stream_to_socket) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002670 return false;
2671 }
2672
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002673 if ((progress_updates_to_socket || do_progress_updates) && stream_to_socket) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002674 return false;
2675 }
2676
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002677 if (is_remote_mode && (do_progress_updates || stream_to_socket)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002678 return false;
2679 }
2680 return true;
2681}
2682
Nandana Dutt197661d2018-11-16 16:40:21 +00002683void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
2684 options_ = std::move(options);
2685}
2686
Abhijeet Kaura407fb82020-03-27 12:51:12 +00002687void Dumpstate::Initialize() {
2688 /* gets the sequential id */
2689 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
2690 id_ = ++last_id;
2691 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
2692}
2693
Nandana Duttd2f5f082019-01-18 17:13:52 +00002694Dumpstate::RunStatus Dumpstate::Run(int32_t calling_uid, const std::string& calling_package) {
2695 Dumpstate::RunStatus status = RunInternal(calling_uid, calling_package);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002696 if (listener_ != nullptr) {
2697 switch (status) {
2698 case Dumpstate::RunStatus::OK:
Nandana Duttcc4ead82019-01-23 08:29:23 +00002699 listener_->onFinished();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002700 break;
2701 case Dumpstate::RunStatus::HELP:
2702 break;
2703 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002704 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_INVALID_INPUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002705 break;
2706 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002707 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_RUNTIME_ERROR);
2708 break;
2709 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2710 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_DENIED_CONSENT);
2711 break;
2712 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
2713 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_CONSENT_TIMED_OUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002714 break;
2715 }
2716 }
2717 return status;
2718}
2719
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002720void Dumpstate::Cancel() {
2721 CleanupTmpFiles();
2722 android::os::UnlinkAndLogOnError(log_path_);
2723 for (int i = 0; i < NUM_OF_DUMPS; i++) {
2724 android::os::UnlinkAndLogOnError(ds.bugreport_internal_dir_ + "/" +
2725 kDumpstateBoardFiles[i]);
2726 }
2727 tombstone_data_.clear();
2728 anr_data_.clear();
Rhed Jao0daac912020-08-21 14:48:20 +08002729
2730 // Instead of shutdown the pool, we delete temporary files directly since
2731 // shutdown blocking the call.
2732 if (dump_pool_) {
2733 dump_pool_->deleteTempFiles();
2734 }
2735 if (zip_entry_tasks_) {
2736 zip_entry_tasks_->run(/*do_cancel =*/ true);
2737 }
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002738}
2739
Nandana Dutt979388e2018-11-30 16:48:55 +00002740/*
2741 * Dumps relevant information to a bugreport based on the given options.
2742 *
2743 * The bugreport can be dumped to a file or streamed to a socket.
2744 *
2745 * How dumping to file works:
2746 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
2747 * stderr is redirected a log file.
2748 *
2749 * The temporary bugreport is then populated via printfs, dumping contents of files and
2750 * output of commands to stdout.
2751 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002752 * A bunch of other files and dumps are added to the zip archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00002753 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002754 * The temporary bugreport file and the log file also get added to the archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00002755 *
mhasank2d75c442020-06-11 15:05:25 -07002756 * Bugreports are first generated in a local directory and later copied to the caller's fd
2757 * or directory if supplied.
Nandana Dutt979388e2018-11-30 16:48:55 +00002758 */
Nandana Duttd2f5f082019-01-18 17:13:52 +00002759Dumpstate::RunStatus Dumpstate::RunInternal(int32_t calling_uid,
2760 const std::string& calling_package) {
Rhed Jao5377d792020-07-16 17:37:39 +08002761 DurationReporter duration_reporter("RUN INTERNAL", /* logcat_only = */true);
Nandana Dutt979388e2018-11-30 16:48:55 +00002762 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00002763 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002764 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002765 return RunStatus::INVALID_INPUT;
2766 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002767 /* set as high priority, and protect from OOM killer */
2768 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002769
Felipe Lemed071c682016-10-20 16:48:00 -07002770 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002771 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002772 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002773 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002774 } else {
2775 /* fallback to kernels <= 2.6.35 */
2776 oom_adj = fopen("/proc/self/oom_adj", "we");
2777 if (oom_adj) {
2778 fputs("-17", oom_adj);
2779 fclose(oom_adj);
2780 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002781 }
2782
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002783 if (version_ == VERSION_DEFAULT) {
2784 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00002785 }
2786
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002787 if (version_ != VERSION_CURRENT && version_ != VERSION_SPLIT_ANR) {
Vishnu Nair64afc022018-02-01 15:29:34 -08002788 MYLOGE("invalid version requested ('%s'); suppported values are: ('%s', '%s', '%s')\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002789 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str(),
Vishnu Nair64afc022018-02-01 15:29:34 -08002790 VERSION_SPLIT_ANR.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002791 return RunStatus::INVALID_INPUT;
Felipe Lemed071c682016-10-20 16:48:00 -07002792 }
2793
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002794 if (options_->show_header_only) {
2795 PrintHeader();
2796 return RunStatus::OK;
Felipe Lemed071c682016-10-20 16:48:00 -07002797 }
2798
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002799 MYLOGD("dumpstate calling_uid = %d ; calling package = %s \n",
2800 calling_uid, calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00002801
Felipe Leme7447d7c2016-11-03 18:12:22 -07002802 // TODO: temporarily set progress until it's part of the Dumpstate constructor
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002803 std::string stats_path =
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002804 android::base::StringPrintf("%s/dumpstate-stats.txt", bugreport_internal_dir_.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002805 progress_.reset(new Progress(stats_path));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002806
Sahana Raof35ed432019-07-12 10:47:52 +01002807 if (acquire_wake_lock(PARTIAL_WAKE_LOCK, WAKE_LOCK_NAME) < 0) {
2808 MYLOGE("Failed to acquire wake lock: %s\n", strerror(errno));
2809 } else {
2810 // Wake lock will be released automatically on process death
2811 MYLOGD("Wake lock acquired.\n");
2812 }
2813
Felipe Leme6ae5c4f2017-01-10 14:13:22 -08002814 register_sig_handler();
Felipe Lemed071c682016-10-20 16:48:00 -07002815
Felipe Lemef0292972016-11-22 13:57:05 -08002816 if (PropertiesHelper::IsDryRun()) {
Felipe Lemed071c682016-10-20 16:48:00 -07002817 MYLOGI("Running on dry-run mode (to disable it, call 'setprop dumpstate.dry_run false')\n");
2818 }
2819
Nandana Dutt235c6672019-11-14 15:22:32 +00002820 MYLOGI("dumpstate info: id=%d, args='%s', bugreport_mode= %s bugreport format version: %s\n",
2821 id_, options_->args.c_str(), options_->bugreport_mode.c_str(), version_.c_str());
Felipe Leme809d74e2016-02-02 12:57:00 -08002822
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002823 do_early_screenshot_ = options_->do_progress_updates;
Felipe Lemee338bf62015-12-07 14:03:50 -08002824
Christopher Ferrised9354f2014-10-01 17:35:01 -07002825 // If we are going to use a socket, do it as early as possible
2826 // to avoid timeouts from bugreport.
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002827 if (options_->stream_to_socket || options_->progress_updates_to_socket) {
Felipe Leme2628e9e2016-04-12 16:36:51 -07002828 MYLOGD("Opening control socket\n");
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002829 control_socket_fd_ = open_socket_fn_("dumpstate");
Nandana Dutta344cb62019-02-22 15:12:35 +00002830 if (control_socket_fd_ == -1) {
2831 return ERROR;
2832 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002833 if (options_->progress_updates_to_socket) {
2834 options_->do_progress_updates = 1;
2835 }
Felipe Leme2628e9e2016-04-12 16:36:51 -07002836 }
2837
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002838 if (!PrepareToWriteToFile()) {
2839 return ERROR;
2840 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08002841
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002842 // Interactive, wear & telephony modes are default to true.
2843 // and may enable from cli option or when using control socket
2844 if (options_->do_progress_updates) {
2845 // clang-format off
2846 std::vector<std::string> am_args = {
2847 "--receiver-permission", "android.permission.DUMP",
2848 };
2849 // clang-format on
2850 // Send STARTED broadcast for apps that listen to bugreport generation events
2851 SendBroadcast("com.android.internal.intent.action.BUGREPORT_STARTED", am_args);
2852 if (options_->progress_updates_to_socket) {
2853 dprintf(control_socket_fd_, "BEGIN:%s\n", path_.c_str());
Felipe Leme71bbfc52015-11-23 14:14:51 -08002854 }
2855 }
2856
Nick Kralevichf3599b32016-01-25 15:05:16 -08002857 /* read /proc/cmdline before dropping root */
2858 FILE *cmdline = fopen("/proc/cmdline", "re");
2859 if (cmdline) {
2860 fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
2861 fclose(cmdline);
2862 }
2863
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002864 if (options_->do_vibrate) {
Felipe Leme35b8cf12017-02-10 15:47:29 -08002865 Vibrate(150);
John Michelau1f794c42012-09-17 11:20:19 -05002866 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002867
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002868 if (zip_file != nullptr) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002869 if (chown(path_.c_str(), AID_SHELL, AID_SHELL)) {
2870 MYLOGE("Unable to change ownership of zip file %s: %s\n", path_.c_str(),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002871 strerror(errno));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002872 }
2873 }
2874
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002875 int dup_stdout_fd;
2876 int dup_stderr_fd;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002877 // Redirect stderr to log_path_ for debugging.
2878 TEMP_FAILURE_RETRY(dup_stderr_fd = dup(fileno(stderr)));
2879 if (!redirect_to_file(stderr, const_cast<char*>(log_path_.c_str()))) {
2880 return ERROR;
2881 }
2882 if (chown(log_path_.c_str(), AID_SHELL, AID_SHELL)) {
2883 MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n", log_path_.c_str(),
2884 strerror(errno));
2885 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002886
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002887 // Redirect stdout to tmp_path_. This is the main bugreport entry and will be
2888 // moved into zip file later, if zipping.
2889 TEMP_FAILURE_RETRY(dup_stdout_fd = dup(fileno(stdout)));
2890 // TODO: why not write to a file instead of stdout to overcome this problem?
2891 /* TODO: rather than generating a text file now and zipping it later,
2892 it would be more efficient to redirect stdout to the zip entry
2893 directly, but the libziparchive doesn't support that option yet. */
2894 if (!redirect_to_file(stdout, const_cast<char*>(tmp_path_.c_str()))) {
2895 return ERROR;
2896 }
2897 if (chown(tmp_path_.c_str(), AID_SHELL, AID_SHELL)) {
2898 MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
2899 tmp_path_.c_str(), strerror(errno));
Colin Crossf45fa6b2012-03-26 12:38:26 -07002900 }
Felipe Lemed8b94e52016-12-08 10:21:44 -08002901
2902 // Don't buffer stdout
2903 setvbuf(stdout, nullptr, _IONBF, 0);
2904
Rhed Jao5377d792020-07-16 17:37:39 +08002905 // Enable the parallel run if the client requests to output to a file.
2906 EnableParallelRunIfNeeded();
2907 // Using scope guard to make sure the dump pool can be shut down correctly.
2908 auto scope_guard_to_shutdown_pool = android::base::make_scope_guard([=]() {
2909 ShutdownDumpPool();
2910 });
2911
Felipe Leme608385d2016-02-01 10:35:38 -08002912 // NOTE: there should be no stdout output until now, otherwise it would break the header.
2913 // In particular, DurationReport objects should be created passing 'title, NULL', so their
Felipe Lemecbce55d2016-02-08 09:53:18 -08002914 // duration is logged into MYLOG instead.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002915 PrintHeader();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002916
Gavin Corkery6968f552020-11-22 18:09:05 +00002917 bool is_dumpstate_restricted = options_->telephony_only
2918 || options_->wifi_only
2919 || options_->limited_only;
2920 if (!is_dumpstate_restricted) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002921 // Invoke critical dumpsys first to preserve system state, before doing anything else.
Jichao Lie89d9c12019-11-21 19:02:51 -08002922 RunDumpsysCritical();
Gavin Corkery6968f552020-11-22 18:09:05 +00002923 }
2924 MaybeTakeEarlyScreenshot();
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00002925
2926 if (!is_dumpstate_restricted) {
2927 // Snapshot the system trace now (if running) to avoid that dumpstate's
2928 // own activity pushes out interesting data from the trace ring buffer.
2929 // The trace file is added to the zip by MaybeAddSystemTraceToZip().
2930 MaybeSnapshotSystemTrace();
Yohei Yukawa95305b32021-03-09 07:54:27 -08002931
2932 // If a winscope trace is running, snapshot it now. It will be pulled into bugreport later
2933 // from WMTRACE_DATA_DIR.
2934 MaybeSnapshotWinTrace();
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00002935 }
Gavin Corkery6968f552020-11-22 18:09:05 +00002936 onUiIntensiveBugreportDumpsFinished(calling_uid);
2937 MaybeCheckUserConsent(calling_uid, calling_package);
2938 if (options_->telephony_only) {
2939 DumpstateTelephonyOnly(calling_package);
2940 } else if (options_->wifi_only) {
2941 DumpstateWifiOnly();
2942 } else if (options_->limited_only) {
2943 DumpstateLimitedOnly();
2944 } else {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002945 // Dump state for the default case. This also drops root.
Jichao Lie89d9c12019-11-21 19:02:51 -08002946 RunStatus s = DumpstateDefaultAfterCritical();
Nandana Dutt5c390032019-03-12 10:52:56 +00002947 if (s != RunStatus::OK) {
Nandana Duttaac6f582019-07-26 14:32:47 +01002948 if (s == RunStatus::USER_CONSENT_DENIED) {
Nandana Dutt5c390032019-03-12 10:52:56 +00002949 HandleUserConsentDenied();
2950 }
2951 return s;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002952 }
Zhengyin Qian068ecc72016-08-10 16:48:14 -07002953 }
Felipe Leme71a74ac2016-03-17 15:43:25 -07002954
Felipe Leme55b42a62015-11-10 17:39:08 -08002955 /* close output if needed */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002956 TEMP_FAILURE_RETRY(dup2(dup_stdout_fd, fileno(stdout)));
Colin Crossf45fa6b2012-03-26 12:38:26 -07002957
Abhijeet Kaure370d682019-10-01 16:49:30 +01002958 // Zip the (now complete) .tmp file within the internal directory.
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002959 FinalizeFile();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002960
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002961 // Share the final file with the caller if the user has consented or Shell is the caller.
Nandana Duttd2f5f082019-01-18 17:13:52 +00002962 Dumpstate::RunStatus status = Dumpstate::RunStatus::OK;
Abhijeet Kaure370d682019-10-01 16:49:30 +01002963 if (CalledByApi()) {
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002964 status = CopyBugreportIfUserConsented(calling_uid);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002965 if (status != Dumpstate::RunStatus::OK &&
2966 status != Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2967 // Do an early return if there were errors. We make an exception for consent
2968 // timing out because it's possible the user got distracted. In this case the
2969 // bugreport is not shared but made available for manual retrieval.
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002970 MYLOGI("User denied consent. Returning\n");
Nandana Duttd2f5f082019-01-18 17:13:52 +00002971 return status;
2972 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002973 if (status == Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2974 MYLOGI(
2975 "Did not receive user consent yet."
2976 " Will not copy the bugreport artifacts to caller.\n");
Abhijeet Kaur57627412019-04-17 16:00:09 +01002977 const String16 incidentcompanion("incidentcompanion");
2978 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
2979 if (ics != nullptr) {
2980 MYLOGD("Canceling user consent request via incidentcompanion service\n");
2981 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
2982 consent_callback_.get());
2983 } else {
2984 MYLOGD("Unable to cancel user consent; incidentcompanion service unavailable\n");
2985 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002986 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00002987 }
2988
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002989 /* vibrate a few but shortly times to let user know it's finished */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002990 if (options_->do_vibrate) {
Takuya Ogawa47f644e2017-12-20 18:09:09 +09002991 for (int i = 0; i < 3; i++) {
2992 Vibrate(75);
2993 usleep((75 + 50) * 1000);
2994 }
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002995 }
2996
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002997 MYLOGD("Final progress: %d/%d (estimated %d)\n", progress_->Get(), progress_->GetMax(),
2998 progress_->GetInitialMax());
2999 progress_->Save();
3000 MYLOGI("done (id %d)\n", id_);
Colin Crossf45fa6b2012-03-26 12:38:26 -07003001
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003002 TEMP_FAILURE_RETRY(dup2(dup_stderr_fd, fileno(stderr)));
Felipe Leme107a05f2016-03-08 15:11:15 -08003003
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003004 if (control_socket_fd_ != -1) {
Felipe Lemee844a9d2016-09-21 15:01:39 -07003005 MYLOGD("Closing control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003006 close(control_socket_fd_);
Felipe Leme2628e9e2016-04-12 16:36:51 -07003007 }
3008
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003009 tombstone_data_.clear();
3010 anr_data_.clear();
Narayan Kamath6b9516c2017-10-27 11:15:51 +01003011
Nandana Duttd2f5f082019-01-18 17:13:52 +00003012 return (consent_callback_ != nullptr &&
3013 consent_callback_->getResult() == UserConsentResult::UNAVAILABLE)
3014 ? USER_CONSENT_TIMED_OUT
3015 : RunStatus::OK;
3016}
3017
Paul Chang0d2aad72020-02-13 20:04:03 +08003018void Dumpstate::MaybeTakeEarlyScreenshot() {
3019 if (!options_->do_screenshot || !do_early_screenshot_) {
3020 return;
3021 }
3022
3023 TakeScreenshot();
3024}
3025
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003026void Dumpstate::MaybeSnapshotSystemTrace() {
3027 // If a background system trace is happening and is marked as "suitable for
3028 // bugreport" (i.e. bugreport_score > 0 in the trace config), this command
3029 // will stop it and serialize into SYSTEM_TRACE_SNAPSHOT. In the (likely)
3030 // case that no trace is ongoing, this command is a no-op.
3031 // Note: this should not be enqueued as we need to freeze the trace before
3032 // dumpstate starts. Otherwise the trace ring buffers will contain mostly
3033 // the dumpstate's own activity which is irrelevant.
3034 int res = RunCommand(
3035 "SERIALIZE PERFETTO TRACE",
3036 {"perfetto", "--save-for-bugreport"},
3037 CommandOptions::WithTimeout(10)
3038 .DropRoot()
3039 .CloseAllFileDescriptorsOnExec()
3040 .Build());
3041 has_system_trace_ = res == 0;
3042 // MaybeAddSystemTraceToZip() will take care of copying the trace in the zip
3043 // file in the later stages.
3044}
3045
Yohei Yukawa95305b32021-03-09 07:54:27 -08003046void Dumpstate::MaybeSnapshotWinTrace() {
Yohei Yukawa02b1d2c2021-03-16 09:20:30 -07003047 // Currently WindowManagerService and InputMethodManagerSerivice support WinScope protocol.
3048 for (const auto& service : {"window", "input_method"}) {
3049 RunCommand(
3050 // Empty name because it's not intended to be classified as a bugreport section.
3051 // Actual tracing files can be found in "/data/misc/wmtrace/" in the bugreport.
3052 "", {"cmd", service, "tracing", "save-for-bugreport"},
3053 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3054 }
Yohei Yukawa95305b32021-03-09 07:54:27 -08003055}
3056
Paul Changeb4b4642020-05-28 22:05:47 +08003057void Dumpstate::onUiIntensiveBugreportDumpsFinished(int32_t calling_uid) {
Paul Changc490e662020-04-11 18:14:09 +08003058 if (calling_uid == AID_SHELL || !CalledByApi()) {
3059 return;
3060 }
3061 if (listener_ != nullptr) {
3062 // Let listener know ui intensive bugreport dumps are finished, then it can do event
3063 // handling if required.
Paul Changeb4b4642020-05-28 22:05:47 +08003064 listener_->onUiIntensiveBugreportDumpsFinished();
Paul Changc490e662020-04-11 18:14:09 +08003065 }
3066}
3067
Jichao Lie89d9c12019-11-21 19:02:51 -08003068void Dumpstate::MaybeCheckUserConsent(int32_t calling_uid, const std::string& calling_package) {
3069 if (calling_uid == AID_SHELL || !CalledByApi()) {
3070 // No need to get consent for shell triggered dumpstates, or not through
3071 // bugreporting API (i.e. no fd to copy back).
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003072 return;
3073 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003074 consent_callback_ = new ConsentCallback();
3075 const String16 incidentcompanion("incidentcompanion");
3076 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
Jichao Lie89d9c12019-11-21 19:02:51 -08003077 android::String16 package(calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003078 if (ics != nullptr) {
3079 MYLOGD("Checking user consent via incidentcompanion service\n");
3080 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
Jichao Lie89d9c12019-11-21 19:02:51 -08003081 calling_uid, package, String16(), String16(),
Joe Onorato1c36d752019-03-17 18:26:43 -07003082 0x1 /* FLAG_CONFIRMATION_DIALOG */, consent_callback_.get());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003083 } else {
3084 MYLOGD("Unable to check user consent; incidentcompanion service unavailable\n");
3085 }
3086}
3087
Nandana Dutt5c390032019-03-12 10:52:56 +00003088bool Dumpstate::IsUserConsentDenied() const {
3089 return ds.consent_callback_ != nullptr &&
3090 ds.consent_callback_->getResult() == UserConsentResult::DENIED;
3091}
3092
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01003093bool Dumpstate::CalledByApi() const {
3094 return ds.options_->bugreport_fd.get() != -1 ? true : false;
3095}
3096
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003097void Dumpstate::CleanupTmpFiles() {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003098 android::os::UnlinkAndLogOnError(tmp_path_);
3099 android::os::UnlinkAndLogOnError(screenshot_path_);
3100 android::os::UnlinkAndLogOnError(path_);
Gavin Corkery789d7a52021-02-24 23:52:35 +00003101 if (dump_traces_path != nullptr) {
3102 android::os::UnlinkAndLogOnError(dump_traces_path);
3103 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003104}
3105
Rhed Jao5377d792020-07-16 17:37:39 +08003106void Dumpstate::EnableParallelRunIfNeeded() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003107 if (!PropertiesHelper::IsParallelRun()) {
Rhed Jao5377d792020-07-16 17:37:39 +08003108 return;
3109 }
3110 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003111 zip_entry_tasks_ = std::make_unique<TaskQueue>();
Rhed Jao5377d792020-07-16 17:37:39 +08003112}
3113
3114void Dumpstate::ShutdownDumpPool() {
3115 if (dump_pool_) {
3116 dump_pool_->shutdown();
3117 dump_pool_ = nullptr;
3118 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003119 if (zip_entry_tasks_) {
3120 zip_entry_tasks_->run(/* do_cancel = */true);
3121 zip_entry_tasks_ = nullptr;
3122 }
3123}
3124
3125void Dumpstate::EnqueueAddZipEntryAndCleanupIfNeeded(const std::string& entry_name,
3126 const std::string& entry_path) {
3127 auto func_add_zip_entry_and_cleanup = [=](bool task_cancelled) {
3128 if (!task_cancelled) {
3129 AddZipEntry(entry_name, entry_path);
3130 }
3131 android::os::UnlinkAndLogOnError(entry_path);
3132 };
3133 if (zip_entry_tasks_) {
3134 // Enqueues AddZipEntryAndCleanup function if the parallel run is enabled.
3135 zip_entry_tasks_->add(func_add_zip_entry_and_cleanup, _1);
3136 } else {
3137 // Invokes AddZipEntryAndCleanup immediately
3138 std::invoke(func_add_zip_entry_and_cleanup, /* task_cancelled = */false);
3139 }
Rhed Jao5377d792020-07-16 17:37:39 +08003140}
3141
Nandana Duttd2f5f082019-01-18 17:13:52 +00003142Dumpstate::RunStatus Dumpstate::HandleUserConsentDenied() {
3143 MYLOGD("User denied consent; deleting files and returning\n");
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003144 CleanupTmpFiles();
Nandana Duttd2f5f082019-01-18 17:13:52 +00003145 return USER_CONSENT_DENIED;
3146}
3147
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003148Dumpstate::RunStatus Dumpstate::CopyBugreportIfUserConsented(int32_t calling_uid) {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003149 // If the caller has asked to copy the bugreport over to their directory, we need explicit
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003150 // user consent (unless the caller is Shell).
3151 UserConsentResult consent_result;
3152 if (calling_uid == AID_SHELL) {
3153 consent_result = UserConsentResult::APPROVED;
3154 } else {
3155 consent_result = consent_callback_->getResult();
3156 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003157 if (consent_result == UserConsentResult::UNAVAILABLE) {
3158 // User has not responded yet.
3159 uint64_t elapsed_ms = consent_callback_->getElapsedTimeMs();
Hunter Knepshield70610fa2020-01-03 15:27:33 -08003160 // Telephony is a fast report type, particularly on user builds where information may be
3161 // more aggressively limited. To give the user time to read the consent dialog, increase the
3162 // timeout.
3163 uint64_t timeout_ms = options_->telephony_only ? TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS
3164 : USER_CONSENT_TIMEOUT_MS;
3165 if (elapsed_ms < timeout_ms) {
3166 uint delay_seconds = (timeout_ms - elapsed_ms) / 1000;
Nandana Duttd2f5f082019-01-18 17:13:52 +00003167 MYLOGD("Did not receive user consent yet; going to wait for %d seconds", delay_seconds);
3168 sleep(delay_seconds);
3169 }
3170 consent_result = consent_callback_->getResult();
3171 }
3172 if (consent_result == UserConsentResult::DENIED) {
3173 // User has explicitly denied sharing with the app. To be safe delete the
3174 // internal bugreport & tmp files.
3175 return HandleUserConsentDenied();
3176 }
3177 if (consent_result == UserConsentResult::APPROVED) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00003178 bool copy_succeeded = android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
3179 if (copy_succeeded) {
3180 android::os::UnlinkAndLogOnError(path_);
Abhijeet Kaur9ce94672020-04-01 17:22:36 +01003181 if (options_->do_screenshot &&
3182 options_->screenshot_fd.get() != -1 &&
3183 !options_->is_screenshot_copied) {
3184 copy_succeeded = android::os::CopyFileToFd(screenshot_path_,
3185 options_->screenshot_fd.get());
3186 options_->is_screenshot_copied = copy_succeeded;
3187 if (copy_succeeded) {
3188 android::os::UnlinkAndLogOnError(screenshot_path_);
3189 }
3190 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003191 }
3192 return copy_succeeded ? Dumpstate::RunStatus::OK : Dumpstate::RunStatus::ERROR;
3193 } else if (consent_result == UserConsentResult::UNAVAILABLE) {
3194 // consent_result is still UNAVAILABLE. The user has likely not responded yet.
3195 // Since we do not have user consent to share the bugreport it does not get
3196 // copied over to the calling app but remains in the internal directory from
3197 // where the user can manually pull it.
Paul Changce644212021-05-11 16:06:45 +08003198 std::string final_path = GetPath(".zip");
3199 bool copy_succeeded = android::os::CopyFileToFile(path_, final_path);
3200 if (copy_succeeded) {
3201 android::os::UnlinkAndLogOnError(path_);
3202 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003203 return Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT;
3204 }
3205 // Unknown result; must be a programming error.
3206 MYLOGE("Unknown user consent result:%d\n", consent_result);
3207 return Dumpstate::RunStatus::ERROR;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003208}
3209
Nandana Duttf02564e2019-02-15 15:24:24 +00003210Dumpstate::RunStatus Dumpstate::ParseCommandlineAndRun(int argc, char* argv[]) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003211 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
3212 Dumpstate::RunStatus status = options->Initialize(argc, argv);
3213 if (status == Dumpstate::RunStatus::OK) {
Nandana Duttf02564e2019-02-15 15:24:24 +00003214 SetOptions(std::move(options));
Nandana Duttd2f5f082019-01-18 17:13:52 +00003215 // When directly running dumpstate binary, the output is not expected to be written
3216 // to any external file descriptor.
Nandana Duttf02564e2019-02-15 15:24:24 +00003217 assert(options_->bugreport_fd.get() == -1);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003218
3219 // calling_uid and calling_package are for user consent to share the bugreport with
Abhijeet Kaura407fb82020-03-27 12:51:12 +00003220 // an app; they are irrelevant here because bugreport is triggered via command line.
3221 // Update Last ID before calling Run().
3222 Initialize();
Nandana Duttf02564e2019-02-15 15:24:24 +00003223 status = Run(-1 /* calling_uid */, "" /* calling_package */);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003224 }
Nandana Duttf02564e2019-02-15 15:24:24 +00003225 return status;
3226}
3227
3228/* Main entry point for dumpstate binary. */
3229int run_main(int argc, char* argv[]) {
3230 Dumpstate::RunStatus status = ds.ParseCommandlineAndRun(argc, argv);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003231
3232 switch (status) {
3233 case Dumpstate::RunStatus::OK:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003234 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003235 case Dumpstate::RunStatus::HELP:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003236 ShowUsage();
3237 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003238 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003239 fprintf(stderr, "Invalid combination of args\n");
3240 ShowUsage();
3241 exit(1);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003242 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00003243 FALLTHROUGH_INTENDED;
3244 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
3245 FALLTHROUGH_INTENDED;
3246 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003247 exit(2);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003248 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003249}
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003250
3251// TODO(111441001): Default DumpOptions to sensible values.
3252Dumpstate::Dumpstate(const std::string& version)
3253 : pid_(getpid()),
3254 options_(new Dumpstate::DumpOptions()),
Nandana Dutt402a8392019-06-14 14:25:13 +01003255 last_reported_percent_progress_(0),
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003256 version_(version),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003257 now_(time(nullptr)),
3258 open_socket_fn_(open_socket) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003259}
3260
3261Dumpstate& Dumpstate::GetInstance() {
3262 static Dumpstate singleton_(android::base::GetProperty("dumpstate.version", VERSION_CURRENT));
3263 return singleton_;
3264}
3265
Rhed Jao5377d792020-07-16 17:37:39 +08003266DurationReporter::DurationReporter(const std::string& title, bool logcat_only, bool verbose,
3267 int duration_fd) : title_(title), logcat_only_(logcat_only), verbose_(verbose),
3268 duration_fd_(duration_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003269 if (!title_.empty()) {
3270 started_ = Nanotime();
3271 }
3272}
3273
3274DurationReporter::~DurationReporter() {
3275 if (!title_.empty()) {
3276 float elapsed = (float)(Nanotime() - started_) / NANOS_PER_SEC;
chenqiwuaf8b2d92019-12-12 18:53:51 +08003277 if (elapsed >= .5f || verbose_) {
3278 MYLOGD("Duration of '%s': %.2fs\n", title_.c_str(), elapsed);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003279 }
chenqiwuaf8b2d92019-12-12 18:53:51 +08003280 if (!logcat_only_) {
3281 // Use "Yoda grammar" to make it easier to grep|sort sections.
Rhed Jao5377d792020-07-16 17:37:39 +08003282 dprintf(duration_fd_, "------ %.3fs was the duration of '%s' ------\n",
3283 elapsed, title_.c_str());
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003284 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003285 }
3286}
3287
3288const int32_t Progress::kDefaultMax = 5000;
3289
3290Progress::Progress(const std::string& path) : Progress(Progress::kDefaultMax, 1.1, path) {
3291}
3292
3293Progress::Progress(int32_t initial_max, int32_t progress, float growth_factor)
3294 : Progress(initial_max, growth_factor, "") {
3295 progress_ = progress;
3296}
3297
3298Progress::Progress(int32_t initial_max, float growth_factor, const std::string& path)
3299 : initial_max_(initial_max),
3300 progress_(0),
3301 max_(initial_max),
3302 growth_factor_(growth_factor),
3303 n_runs_(0),
3304 average_max_(0),
3305 path_(path) {
3306 if (!path_.empty()) {
3307 Load();
3308 }
3309}
3310
3311void Progress::Load() {
3312 MYLOGD("Loading stats from %s\n", path_.c_str());
3313 std::string content;
3314 if (!android::base::ReadFileToString(path_, &content)) {
3315 MYLOGI("Could not read stats from %s; using max of %d\n", path_.c_str(), max_);
3316 return;
3317 }
3318 if (content.empty()) {
3319 MYLOGE("No stats (empty file) on %s; using max of %d\n", path_.c_str(), max_);
3320 return;
3321 }
3322 std::vector<std::string> lines = android::base::Split(content, "\n");
3323
3324 if (lines.size() < 1) {
3325 MYLOGE("Invalid stats on file %s: not enough lines (%d). Using max of %d\n", path_.c_str(),
3326 (int)lines.size(), max_);
3327 return;
3328 }
3329 char* ptr;
3330 n_runs_ = strtol(lines[0].c_str(), &ptr, 10);
3331 average_max_ = strtol(ptr, nullptr, 10);
3332 if (n_runs_ <= 0 || average_max_ <= 0 || n_runs_ > STATS_MAX_N_RUNS ||
3333 average_max_ > STATS_MAX_AVERAGE) {
3334 MYLOGE("Invalid stats line on file %s: %s\n", path_.c_str(), lines[0].c_str());
3335 initial_max_ = Progress::kDefaultMax;
3336 } else {
3337 initial_max_ = average_max_;
3338 }
3339 max_ = initial_max_;
3340
3341 MYLOGI("Average max progress: %d in %d runs; estimated max: %d\n", average_max_, n_runs_, max_);
3342}
3343
3344void Progress::Save() {
3345 int32_t total = n_runs_ * average_max_ + progress_;
3346 int32_t runs = n_runs_ + 1;
3347 int32_t average = floor(((float)total) / runs);
3348 MYLOGI("Saving stats (total=%d, runs=%d, average=%d) on %s\n", total, runs, average,
3349 path_.c_str());
3350 if (path_.empty()) {
3351 return;
3352 }
3353
3354 std::string content = android::base::StringPrintf("%d %d\n", runs, average);
3355 if (!android::base::WriteStringToFile(content, path_)) {
3356 MYLOGE("Could not save stats on %s\n", path_.c_str());
3357 }
3358}
3359
3360int32_t Progress::Get() const {
3361 return progress_;
3362}
3363
3364bool Progress::Inc(int32_t delta_sec) {
3365 bool changed = false;
3366 if (delta_sec >= 0) {
3367 progress_ += delta_sec;
3368 if (progress_ > max_) {
3369 int32_t old_max = max_;
3370 max_ = floor((float)progress_ * growth_factor_);
3371 MYLOGD("Adjusting max progress from %d to %d\n", old_max, max_);
3372 changed = true;
3373 }
3374 }
3375 return changed;
3376}
3377
3378int32_t Progress::GetMax() const {
3379 return max_;
3380}
3381
3382int32_t Progress::GetInitialMax() const {
3383 return initial_max_;
3384}
3385
3386void Progress::Dump(int fd, const std::string& prefix) const {
3387 const char* pr = prefix.c_str();
3388 dprintf(fd, "%sprogress: %d\n", pr, progress_);
3389 dprintf(fd, "%smax: %d\n", pr, max_);
3390 dprintf(fd, "%sinitial_max: %d\n", pr, initial_max_);
3391 dprintf(fd, "%sgrowth_factor: %0.2f\n", pr, growth_factor_);
3392 dprintf(fd, "%spath: %s\n", pr, path_.c_str());
3393 dprintf(fd, "%sn_runs: %d\n", pr, n_runs_);
3394 dprintf(fd, "%saverage_max: %d\n", pr, average_max_);
3395}
3396
3397bool Dumpstate::IsZipping() const {
3398 return zip_writer_ != nullptr;
3399}
3400
3401std::string Dumpstate::GetPath(const std::string& suffix) const {
3402 return GetPath(bugreport_internal_dir_, suffix);
3403}
3404
3405std::string Dumpstate::GetPath(const std::string& directory, const std::string& suffix) const {
3406 return android::base::StringPrintf("%s/%s-%s%s", directory.c_str(), base_name_.c_str(),
3407 name_.c_str(), suffix.c_str());
3408}
3409
3410void Dumpstate::SetProgress(std::unique_ptr<Progress> progress) {
3411 progress_ = std::move(progress);
3412}
3413
3414void for_each_userid(void (*func)(int), const char *header) {
3415 std::string title = header == nullptr ? "for_each_userid" : android::base::StringPrintf(
3416 "for_each_userid(%s)", header);
3417 DurationReporter duration_reporter(title);
3418 if (PropertiesHelper::IsDryRun()) return;
3419
3420 DIR *d;
3421 struct dirent *de;
3422
3423 if (header) printf("\n------ %s ------\n", header);
3424 func(0);
3425
3426 if (!(d = opendir("/data/system/users"))) {
3427 printf("Failed to open /data/system/users (%s)\n", strerror(errno));
3428 return;
3429 }
3430
3431 while ((de = readdir(d))) {
3432 int userid;
3433 if (de->d_type != DT_DIR || !(userid = atoi(de->d_name))) {
3434 continue;
3435 }
3436 func(userid);
3437 }
3438
3439 closedir(d);
3440}
3441
3442static void __for_each_pid(void (*helper)(int, const char *, void *), const char *header, void *arg) {
3443 DIR *d;
3444 struct dirent *de;
3445
3446 if (!(d = opendir("/proc"))) {
3447 printf("Failed to open /proc (%s)\n", strerror(errno));
3448 return;
3449 }
3450
3451 if (header) printf("\n------ %s ------\n", header);
3452 while ((de = readdir(d))) {
3453 if (ds.IsUserConsentDenied()) {
3454 MYLOGE(
3455 "Returning early because user denied consent to share bugreport with calling app.");
3456 closedir(d);
3457 return;
3458 }
3459 int pid;
3460 int fd;
3461 char cmdpath[255];
3462 char cmdline[255];
3463
3464 if (!(pid = atoi(de->d_name))) {
3465 continue;
3466 }
3467
3468 memset(cmdline, 0, sizeof(cmdline));
3469
3470 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/cmdline", pid);
3471 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3472 TEMP_FAILURE_RETRY(read(fd, cmdline, sizeof(cmdline) - 2));
3473 close(fd);
3474 if (cmdline[0]) {
3475 helper(pid, cmdline, arg);
3476 continue;
3477 }
3478 }
3479
3480 // if no cmdline, a kernel thread has comm
3481 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/comm", pid);
3482 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3483 TEMP_FAILURE_RETRY(read(fd, cmdline + 1, sizeof(cmdline) - 4));
3484 close(fd);
3485 if (cmdline[1]) {
3486 cmdline[0] = '[';
3487 size_t len = strcspn(cmdline, "\f\b\r\n");
3488 cmdline[len] = ']';
3489 cmdline[len+1] = '\0';
3490 }
3491 }
3492 if (!cmdline[0]) {
3493 strcpy(cmdline, "N/A");
3494 }
3495 helper(pid, cmdline, arg);
3496 }
3497
3498 closedir(d);
3499}
3500
3501static void for_each_pid_helper(int pid, const char *cmdline, void *arg) {
3502 for_each_pid_func *func = (for_each_pid_func*) arg;
3503 func(pid, cmdline);
3504}
3505
3506void for_each_pid(for_each_pid_func func, const char *header) {
3507 std::string title = header == nullptr ? "for_each_pid"
3508 : android::base::StringPrintf("for_each_pid(%s)", header);
3509 DurationReporter duration_reporter(title);
3510 if (PropertiesHelper::IsDryRun()) return;
3511
3512 __for_each_pid(for_each_pid_helper, header, (void *) func);
3513}
3514
3515static void for_each_tid_helper(int pid, const char *cmdline, void *arg) {
3516 DIR *d;
3517 struct dirent *de;
3518 char taskpath[255];
3519 for_each_tid_func *func = (for_each_tid_func *) arg;
3520
3521 snprintf(taskpath, sizeof(taskpath), "/proc/%d/task", pid);
3522
3523 if (!(d = opendir(taskpath))) {
3524 printf("Failed to open %s (%s)\n", taskpath, strerror(errno));
3525 return;
3526 }
3527
3528 func(pid, pid, cmdline);
3529
3530 while ((de = readdir(d))) {
3531 if (ds.IsUserConsentDenied()) {
3532 MYLOGE(
3533 "Returning early because user denied consent to share bugreport with calling app.");
3534 closedir(d);
3535 return;
3536 }
3537 int tid;
3538 int fd;
3539 char commpath[255];
3540 char comm[255];
3541
3542 if (!(tid = atoi(de->d_name))) {
3543 continue;
3544 }
3545
3546 if (tid == pid)
3547 continue;
3548
3549 snprintf(commpath, sizeof(commpath), "/proc/%d/comm", tid);
3550 memset(comm, 0, sizeof(comm));
3551 if ((fd = TEMP_FAILURE_RETRY(open(commpath, O_RDONLY | O_CLOEXEC))) < 0) {
3552 strcpy(comm, "N/A");
3553 } else {
3554 char *c;
3555 TEMP_FAILURE_RETRY(read(fd, comm, sizeof(comm) - 2));
3556 close(fd);
3557
3558 c = strrchr(comm, '\n');
3559 if (c) {
3560 *c = '\0';
3561 }
3562 }
3563 func(pid, tid, comm);
3564 }
3565
3566 closedir(d);
3567}
3568
3569void for_each_tid(for_each_tid_func func, const char *header) {
3570 std::string title = header == nullptr ? "for_each_tid"
3571 : android::base::StringPrintf("for_each_tid(%s)", header);
3572 DurationReporter duration_reporter(title);
3573
3574 if (PropertiesHelper::IsDryRun()) return;
3575
3576 __for_each_pid(for_each_tid_helper, header, (void *) func);
3577}
3578
3579void show_wchan(int pid, int tid, const char *name) {
3580 if (PropertiesHelper::IsDryRun()) return;
3581
3582 char path[255];
3583 char buffer[255];
3584 int fd, ret, save_errno;
3585 char name_buffer[255];
3586
3587 memset(buffer, 0, sizeof(buffer));
3588
3589 snprintf(path, sizeof(path), "/proc/%d/wchan", tid);
3590 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3591 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3592 return;
3593 }
3594
3595 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3596 save_errno = errno;
3597 close(fd);
3598
3599 if (ret < 0) {
3600 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3601 return;
3602 }
3603
3604 snprintf(name_buffer, sizeof(name_buffer), "%*s%s",
3605 pid == tid ? 0 : 3, "", name);
3606
3607 printf("%-7d %-32s %s\n", tid, name_buffer, buffer);
3608
3609 return;
3610}
3611
3612// print time in centiseconds
3613static void snprcent(char *buffer, size_t len, size_t spc,
3614 unsigned long long time) {
3615 static long hz; // cache discovered hz
3616
3617 if (hz <= 0) {
3618 hz = sysconf(_SC_CLK_TCK);
3619 if (hz <= 0) {
3620 hz = 1000;
3621 }
3622 }
3623
3624 // convert to centiseconds
3625 time = (time * 100 + (hz / 2)) / hz;
3626
3627 char str[16];
3628
3629 snprintf(str, sizeof(str), " %llu.%02u",
3630 time / 100, (unsigned)(time % 100));
3631 size_t offset = strlen(buffer);
3632 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3633 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3634}
3635
3636// print permille as a percent
3637static void snprdec(char *buffer, size_t len, size_t spc, unsigned permille) {
3638 char str[16];
3639
3640 snprintf(str, sizeof(str), " %u.%u%%", permille / 10, permille % 10);
3641 size_t offset = strlen(buffer);
3642 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3643 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3644}
3645
3646void show_showtime(int pid, const char *name) {
3647 if (PropertiesHelper::IsDryRun()) return;
3648
3649 char path[255];
3650 char buffer[1023];
3651 int fd, ret, save_errno;
3652
3653 memset(buffer, 0, sizeof(buffer));
3654
3655 snprintf(path, sizeof(path), "/proc/%d/stat", pid);
3656 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3657 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3658 return;
3659 }
3660
3661 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3662 save_errno = errno;
3663 close(fd);
3664
3665 if (ret < 0) {
3666 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3667 return;
3668 }
3669
3670 // field 14 is utime
3671 // field 15 is stime
3672 // field 42 is iotime
3673 unsigned long long utime = 0, stime = 0, iotime = 0;
3674 if (sscanf(buffer,
3675 "%*u %*s %*s %*d %*d %*d %*d %*d %*d %*d %*d "
3676 "%*d %*d %llu %llu %*d %*d %*d %*d %*d %*d "
3677 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %*d "
3678 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %llu ",
3679 &utime, &stime, &iotime) != 3) {
3680 return;
3681 }
3682
3683 unsigned long long total = utime + stime;
3684 if (!total) {
3685 return;
3686 }
3687
3688 unsigned permille = (iotime * 1000 + (total / 2)) / total;
3689 if (permille > 1000) {
3690 permille = 1000;
3691 }
3692
3693 // try to beautify and stabilize columns at <80 characters
3694 snprintf(buffer, sizeof(buffer), "%-6d%s", pid, name);
3695 if ((name[0] != '[') || utime) {
3696 snprcent(buffer, sizeof(buffer), 57, utime);
3697 }
3698 snprcent(buffer, sizeof(buffer), 65, stime);
3699 if ((name[0] != '[') || iotime) {
3700 snprcent(buffer, sizeof(buffer), 73, iotime);
3701 }
3702 if (iotime) {
3703 snprdec(buffer, sizeof(buffer), 79, permille);
3704 }
3705 puts(buffer); // adds a trailing newline
3706
3707 return;
3708}
3709
3710void do_dmesg() {
3711 const char *title = "KERNEL LOG (dmesg)";
3712 DurationReporter duration_reporter(title);
3713 printf("------ %s ------\n", title);
3714
3715 if (PropertiesHelper::IsDryRun()) return;
3716
3717 /* Get size of kernel buffer */
3718 int size = klogctl(KLOG_SIZE_BUFFER, nullptr, 0);
3719 if (size <= 0) {
3720 printf("Unexpected klogctl return value: %d\n\n", size);
3721 return;
3722 }
3723 char *buf = (char *) malloc(size + 1);
3724 if (buf == nullptr) {
3725 printf("memory allocation failed\n\n");
3726 return;
3727 }
3728 int retval = klogctl(KLOG_READ_ALL, buf, size);
3729 if (retval < 0) {
3730 printf("klogctl failure\n\n");
3731 free(buf);
3732 return;
3733 }
3734 buf[retval] = '\0';
3735 printf("%s\n\n", buf);
3736 free(buf);
3737 return;
3738}
3739
3740void do_showmap(int pid, const char *name) {
3741 char title[255];
3742 char arg[255];
3743
3744 snprintf(title, sizeof(title), "SHOW MAP %d (%s)", pid, name);
3745 snprintf(arg, sizeof(arg), "%d", pid);
3746 RunCommand(title, {"showmap", "-q", arg}, CommandOptions::AS_ROOT);
3747}
3748
3749int Dumpstate::DumpFile(const std::string& title, const std::string& path) {
3750 DurationReporter duration_reporter(title);
3751
3752 int status = DumpFileToFd(STDOUT_FILENO, title, path);
3753
3754 UpdateProgress(WEIGHT_FILE);
3755
3756 return status;
3757}
3758
3759int read_file_as_long(const char *path, long int *output) {
3760 int fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC));
3761 if (fd < 0) {
3762 int err = errno;
3763 MYLOGE("Error opening file descriptor for %s: %s\n", path, strerror(err));
3764 return -1;
3765 }
3766 char buffer[50];
3767 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3768 if (bytes_read == -1) {
3769 MYLOGE("Error reading file %s: %s\n", path, strerror(errno));
3770 return -2;
3771 }
3772 if (bytes_read == 0) {
3773 MYLOGE("File %s is empty\n", path);
3774 return -3;
3775 }
3776 *output = atoi(buffer);
3777 return 0;
3778}
3779
3780/* calls skip to gate calling dump_from_fd recursively
3781 * in the specified directory. dump_from_fd defaults to
3782 * dump_file_from_fd above when set to NULL. skip defaults
3783 * to false when set to NULL. dump_from_fd will always be
3784 * called with title NULL.
3785 */
3786int dump_files(const std::string& title, const char* dir, bool (*skip)(const char* path),
3787 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
3788 DurationReporter duration_reporter(title);
3789 DIR *dirp;
3790 struct dirent *d;
3791 char *newpath = nullptr;
3792 const char *slash = "/";
3793 int retval = 0;
3794
3795 if (!title.empty()) {
3796 printf("------ %s (%s) ------\n", title.c_str(), dir);
3797 }
3798 if (PropertiesHelper::IsDryRun()) return 0;
3799
3800 if (dir[strlen(dir) - 1] == '/') {
3801 ++slash;
3802 }
3803 dirp = opendir(dir);
3804 if (dirp == nullptr) {
3805 retval = -errno;
3806 MYLOGE("%s: %s\n", dir, strerror(errno));
3807 return retval;
3808 }
3809
3810 if (!dump_from_fd) {
3811 dump_from_fd = dump_file_from_fd;
3812 }
3813 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
3814 if ((d->d_name[0] == '.')
3815 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
3816 || (d->d_name[1] == '\0'))) {
3817 continue;
3818 }
3819 asprintf(&newpath, "%s%s%s%s", dir, slash, d->d_name,
3820 (d->d_type == DT_DIR) ? "/" : "");
3821 if (!newpath) {
3822 retval = -errno;
3823 continue;
3824 }
3825 if (skip && (*skip)(newpath)) {
3826 continue;
3827 }
3828 if (d->d_type == DT_DIR) {
3829 int ret = dump_files("", newpath, skip, dump_from_fd);
3830 if (ret < 0) {
3831 retval = ret;
3832 }
3833 continue;
3834 }
3835 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(newpath, O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
3836 if (fd.get() < 0) {
3837 retval = -1;
3838 printf("*** %s: %s\n", newpath, strerror(errno));
3839 continue;
3840 }
3841 (*dump_from_fd)(nullptr, newpath, fd.get());
3842 }
3843 closedir(dirp);
3844 if (!title.empty()) {
3845 printf("\n");
3846 }
3847 return retval;
3848}
3849
3850/* fd must have been opened with the flag O_NONBLOCK. With this flag set,
3851 * it's possible to avoid issues where opening the file itself can get
3852 * stuck.
3853 */
3854int dump_file_from_fd(const char *title, const char *path, int fd) {
3855 if (PropertiesHelper::IsDryRun()) return 0;
3856
3857 int flags = fcntl(fd, F_GETFL);
3858 if (flags == -1) {
3859 printf("*** %s: failed to get flags on fd %d: %s\n", path, fd, strerror(errno));
3860 return -1;
3861 } else if (!(flags & O_NONBLOCK)) {
3862 printf("*** %s: fd must have O_NONBLOCK set.\n", path);
3863 return -1;
3864 }
3865 return DumpFileFromFdToFd(title, path, fd, STDOUT_FILENO, PropertiesHelper::IsDryRun());
3866}
3867
3868int Dumpstate::RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003869 const CommandOptions& options, bool verbose_duration, int out_fd) {
3870 DurationReporter duration_reporter(title, false /* logcat_only */,
3871 verbose_duration, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003872
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003873 int status = RunCommandToFd(out_fd, title, full_command, options);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003874
3875 /* TODO: for now we're simplifying the progress calculation by using the
3876 * timeout as the weight. It's a good approximation for most cases, except when calling dumpsys,
3877 * where its weight should be much higher proportionally to its timeout.
3878 * Ideally, it should use a options.EstimatedDuration() instead...*/
3879 UpdateProgress(options.Timeout());
3880
3881 return status;
3882}
3883
3884void Dumpstate::RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsys_args,
Rhed Jaoe017f982020-07-21 17:58:41 +08003885 const CommandOptions& options, long dumpsysTimeoutMs, int out_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003886 long timeout_ms = dumpsysTimeoutMs > 0 ? dumpsysTimeoutMs : options.TimeoutInMs();
3887 std::vector<std::string> dumpsys = {"/system/bin/dumpsys", "-T", std::to_string(timeout_ms)};
3888 dumpsys.insert(dumpsys.end(), dumpsys_args.begin(), dumpsys_args.end());
Rhed Jaoe017f982020-07-21 17:58:41 +08003889 RunCommand(title, dumpsys, options, false, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003890}
3891
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003892static int open_socket(const char* service) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003893 int s = android_get_control_socket(service);
3894 if (s < 0) {
3895 MYLOGE("android_get_control_socket(%s): %s\n", service, strerror(errno));
3896 return -1;
3897 }
3898 fcntl(s, F_SETFD, FD_CLOEXEC);
3899
3900 // Set backlog to 0 to make sure that queue size will be minimum.
3901 // In Linux, because the minimum queue will be 1, connect() will be blocked
3902 // if the other clients already called connect() and the connection request was not accepted.
3903 if (listen(s, 0) < 0) {
3904 MYLOGE("listen(control socket): %s\n", strerror(errno));
3905 return -1;
3906 }
3907
3908 struct sockaddr addr;
3909 socklen_t alen = sizeof(addr);
Abhijeet Kaur2113cae2019-09-13 09:24:15 +01003910 int fd = accept4(s, &addr, &alen, SOCK_CLOEXEC);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003911
3912 // Close socket just after accept(), to make sure that connect() by client will get error
3913 // when the socket is used by the other services.
3914 // There is still a race condition possibility between accept and close, but there is no way
3915 // to close-on-accept atomically.
3916 // See detail; b/123306389#comment25
3917 close(s);
3918
3919 if (fd < 0) {
3920 MYLOGE("accept(control socket): %s\n", strerror(errno));
3921 return -1;
3922 }
3923
3924 return fd;
3925}
3926
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003927// TODO: should call is_valid_output_file and/or be merged into it.
3928void create_parent_dirs(const char *path) {
3929 char *chp = const_cast<char *> (path);
3930
3931 /* skip initial slash */
3932 if (chp[0] == '/')
3933 chp++;
3934
3935 /* create leading directories, if necessary */
3936 struct stat dir_stat;
3937 while (chp && chp[0]) {
3938 chp = strchr(chp, '/');
3939 if (chp) {
3940 *chp = 0;
3941 if (stat(path, &dir_stat) == -1 || !S_ISDIR(dir_stat.st_mode)) {
3942 MYLOGI("Creating directory %s\n", path);
3943 if (mkdir(path, 0770)) { /* drwxrwx--- */
3944 MYLOGE("Unable to create directory %s: %s\n", path, strerror(errno));
3945 } else if (chown(path, AID_SHELL, AID_SHELL)) {
3946 MYLOGE("Unable to change ownership of dir %s: %s\n", path, strerror(errno));
3947 }
3948 }
3949 *chp++ = '/';
3950 }
3951 }
3952}
3953
3954bool _redirect_to_file(FILE* redirect, char* path, int truncate_flag) {
3955 create_parent_dirs(path);
3956
3957 int fd = TEMP_FAILURE_RETRY(open(path,
3958 O_WRONLY | O_CREAT | truncate_flag | O_CLOEXEC | O_NOFOLLOW,
3959 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH));
3960 if (fd < 0) {
3961 MYLOGE("%s: %s\n", path, strerror(errno));
3962 return false;
3963 }
3964
3965 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
3966 close(fd);
3967 return true;
3968}
3969
3970bool redirect_to_file(FILE* redirect, char* path) {
3971 return _redirect_to_file(redirect, path, O_TRUNC);
3972}
3973
3974bool redirect_to_existing_file(FILE* redirect, char* path) {
3975 return _redirect_to_file(redirect, path, O_APPEND);
3976}
3977
3978void dump_route_tables() {
3979 DurationReporter duration_reporter("DUMP ROUTE TABLES");
3980 if (PropertiesHelper::IsDryRun()) return;
3981 const char* const RT_TABLES_PATH = "/data/misc/net/rt_tables";
3982 ds.DumpFile("RT_TABLES", RT_TABLES_PATH);
3983 FILE* fp = fopen(RT_TABLES_PATH, "re");
3984 if (!fp) {
3985 printf("*** %s: %s\n", RT_TABLES_PATH, strerror(errno));
3986 return;
3987 }
3988 char table[16];
3989 // Each line has an integer (the table number), a space, and a string (the table name). We only
3990 // need the table number. It's a 32-bit unsigned number, so max 10 chars. Skip the table name.
3991 // Add a fixed max limit so this doesn't go awry.
3992 for (int i = 0; i < 64 && fscanf(fp, " %10s %*s", table) == 1; ++i) {
3993 RunCommand("ROUTE TABLE IPv4", {"ip", "-4", "route", "show", "table", table});
3994 RunCommand("ROUTE TABLE IPv6", {"ip", "-6", "route", "show", "table", table});
3995 }
3996 fclose(fp);
3997}
3998
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003999void Dumpstate::UpdateProgress(int32_t delta_sec) {
4000 if (progress_ == nullptr) {
4001 MYLOGE("UpdateProgress: progress_ not set\n");
4002 return;
4003 }
Rhed Jaobf63d8a2020-07-21 15:42:55 +08004004 // This function updates progress related members of the dumpstate and reports
4005 // progress percentage to the bugreport client. Since it could be called by
4006 // different dump tasks at the same time if the parallel run is enabled, a
4007 // mutex lock is necessary here to synchronize the call.
4008 std::lock_guard<std::recursive_mutex> lock(mutex_);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004009
4010 // Always update progess so stats can be tuned...
Nandana Dutt402a8392019-06-14 14:25:13 +01004011 progress_->Inc(delta_sec);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004012
4013 // ...but only notifiy listeners when necessary.
4014 if (!options_->do_progress_updates) return;
4015
4016 int progress = progress_->Get();
4017 int max = progress_->GetMax();
Nandana Dutt402a8392019-06-14 14:25:13 +01004018 int percent = 100 * progress / max;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004019
Nandana Dutt402a8392019-06-14 14:25:13 +01004020 if (last_reported_percent_progress_ > 0 && percent <= last_reported_percent_progress_) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004021 return;
4022 }
Nandana Dutt402a8392019-06-14 14:25:13 +01004023 last_reported_percent_progress_ = percent;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004024
4025 if (control_socket_fd_ >= 0) {
4026 dprintf(control_socket_fd_, "PROGRESS:%d/%d\n", progress, max);
4027 fsync(control_socket_fd_);
4028 }
4029
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004030 if (listener_ != nullptr) {
Nandana Dutt235c6672019-11-14 15:22:32 +00004031 if (percent % 10 == 0) {
4032 // We don't want to spam logcat, so only log multiples of 10.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004033 MYLOGD("Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004034 } else {
4035 // stderr is ignored on normal invocations, but useful when calling
4036 // /system/bin/dumpstate directly for debuggging.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004037 fprintf(stderr, "Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004038 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004039
4040 listener_->onProgress(percent);
4041 }
4042}
4043
4044void Dumpstate::TakeScreenshot(const std::string& path) {
4045 const std::string& real_path = path.empty() ? screenshot_path_ : path;
4046 int status =
4047 RunCommand("", {"/system/bin/screencap", "-p", real_path},
4048 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
4049 if (status == 0) {
4050 MYLOGD("Screenshot saved on %s\n", real_path.c_str());
4051 } else {
4052 MYLOGE("Failed to take screenshot on %s\n", real_path.c_str());
4053 }
Paul Chang0d2aad72020-02-13 20:04:03 +08004054 if (listener_ != nullptr) {
4055 // Show a visual indication to indicate screenshot is taken via
4056 // IDumpstateListener.onScreenshotTaken()
4057 listener_->onScreenshotTaken(status == 0);
4058 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004059}
4060
4061bool is_dir(const char* pathname) {
4062 struct stat info;
4063 if (stat(pathname, &info) == -1) {
4064 return false;
4065 }
4066 return S_ISDIR(info.st_mode);
4067}
4068
4069time_t get_mtime(int fd, time_t default_mtime) {
4070 struct stat info;
4071 if (fstat(fd, &info) == -1) {
4072 return default_mtime;
4073 }
4074 return info.st_mtime;
4075}