blob: 95c4923ba0d2493e09c490559be48c533757315b [file] [log] [blame]
Colin Crossf45fa6b2012-03-26 12:38:26 -07001/*
2 * Copyright (C) 2008 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
Felipe Lemef0292972016-11-22 13:57:05 -080016
Mark Salyzyn6c3d90f2016-09-27 14:55:27 -070017#define LOG_TAG "dumpstate"
Colin Crossf45fa6b2012-03-26 12:38:26 -070018
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -070019#include <dirent.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070020#include <errno.h>
21#include <fcntl.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010022#include <inttypes.h>
Felipe Lemead5f6c42015-11-30 14:26:46 -080023#include <libgen.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070024#include <limits.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010025#include <math.h>
26#include <poll.h>
Mark Salyzyn8f37aa52015-06-12 12:28:24 -070027#include <stdbool.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070028#include <stdio.h>
29#include <stdlib.h>
30#include <string.h>
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -070031#include <sys/mount.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080032#include <sys/poll.h>
Christopher Ferris7dc7f322014-07-22 16:08:19 -070033#include <sys/prctl.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070034#include <sys/resource.h>
35#include <sys/stat.h>
36#include <sys/time.h>
37#include <sys/wait.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010038#include <signal.h>
39#include <stdarg.h>
40#include <string.h>
41#include <sys/capability.h>
42#include <sys/inotify.h>
43#include <sys/klog.h>
44#include <time.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070045#include <unistd.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070046
47#include <chrono>
Hridya Valsarajuac582cd2019-08-05 15:39:54 -070048#include <cmath>
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +000049#include <fstream>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070050#include <functional>
51#include <future>
Narayan Kamath8f788292017-05-25 13:20:39 +010052#include <memory>
Hridya Valsarajuac582cd2019-08-05 15:39:54 -070053#include <numeric>
Narayan Kamath8f788292017-05-25 13:20:39 +010054#include <regex>
55#include <set>
56#include <string>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070057#include <utility>
Narayan Kamath8f788292017-05-25 13:20:39 +010058#include <vector>
Colin Crossf45fa6b2012-03-26 12:38:26 -070059
Felipe Leme96c2bbb2016-09-26 09:21:21 -070060#include <android-base/file.h>
61#include <android-base/properties.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070062#include <android-base/scopeguard.h>
Elliott Hughes9dc117c2015-12-07 14:21:50 -080063#include <android-base/stringprintf.h>
Naveen Kalla058e1e82016-10-19 21:38:44 -070064#include <android-base/strings.h>
Andreas Gampeaff68432016-07-18 18:01:27 -070065#include <android-base/unique_fd.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010066#include <android/content/pm/IPackageManagerNative.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080067#include <android/hardware/dumpstate/1.0/IDumpstateDevice.h>
Hunter Knepshield8540faf2020-02-04 19:47:20 -080068#include <android/hardware/dumpstate/1.1/IDumpstateDevice.h>
69#include <android/hardware/dumpstate/1.1/types.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080070#include <android/hidl/manager/1.0/IServiceManager.h>
Nandana Duttd2f5f082019-01-18 17:13:52 +000071#include <android/os/IIncidentCompanion.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010072#include <binder/IServiceManager.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080073#include <cutils/native_handle.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070074#include <cutils/properties.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010075#include <cutils/sockets.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000076#include <debuggerd/client.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080077#include <dumpsys.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000078#include <dumputils/dump_utils.h>
Sahana Raof35ed432019-07-12 10:47:52 +010079#include <hardware_legacy/power.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080080#include <hidl/ServiceManagement.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010081#include <log/log.h>
Tom Cherryf4472f32020-08-05 09:31:17 -070082#include <log/log_read.h>
Felipe Leme75876a22016-10-27 16:31:27 -070083#include <openssl/sha.h>
Mark Salyzyn6c3d90f2016-09-27 14:55:27 -070084#include <private/android_filesystem_config.h>
85#include <private/android_logger.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080086#include <serviceutils/PriorityDumper.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070087#include <utils/StrongPointer.h>
Felipe Lemef0292972016-11-22 13:57:05 -080088#include "DumpstateInternal.h"
Felipe Leme75876a22016-10-27 16:31:27 -070089#include "DumpstateService.h"
Colin Crossf45fa6b2012-03-26 12:38:26 -070090#include "dumpstate.h"
Felipe Leme6e01fa62015-11-11 19:35:14 -080091
Hunter Knepshield8540faf2020-02-04 19:47:20 -080092using IDumpstateDevice_1_0 = ::android::hardware::dumpstate::V1_0::IDumpstateDevice;
93using IDumpstateDevice_1_1 = ::android::hardware::dumpstate::V1_1::IDumpstateDevice;
94using ::android::hardware::dumpstate::V1_1::DumpstateMode;
95using ::android::hardware::dumpstate::V1_1::DumpstateStatus;
96using ::android::hardware::dumpstate::V1_1::toString;
Vishnu Naire97d6122018-01-18 13:58:56 -080097using ::std::literals::chrono_literals::operator""ms;
98using ::std::literals::chrono_literals::operator""s;
Rhed Jao1c855122020-07-16 17:37:39 +080099using ::std::placeholders::_1;
Steven Morelandcb7ef822016-11-29 13:20:37 -0800100
Felipe Leme47e9be22016-12-21 15:37:07 -0800101// TODO: remove once moved to namespace
Vishnu Naire97d6122018-01-18 13:58:56 -0800102using android::defaultServiceManager;
103using android::Dumpsys;
104using android::INVALID_OPERATION;
105using android::IServiceManager;
106using android::OK;
107using android::sp;
108using android::status_t;
109using android::String16;
110using android::String8;
111using android::TIMED_OUT;
112using android::UNKNOWN_ERROR;
113using android::Vector;
Nandana Dutt979388e2018-11-30 16:48:55 +0000114using android::base::StringPrintf;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000115using android::os::IDumpstateListener;
Felipe Leme47e9be22016-12-21 15:37:07 -0800116using android::os::dumpstate::CommandOptions;
117using android::os::dumpstate::DumpFileToFd;
Rhed Jao1c855122020-07-16 17:37:39 +0800118using android::os::dumpstate::DumpPool;
Vishnu Naire97d6122018-01-18 13:58:56 -0800119using android::os::dumpstate::PropertiesHelper;
Rhed Jao4875aa62020-07-20 17:46:29 +0800120using android::os::dumpstate::TaskQueue;
Felipe Leme47e9be22016-12-21 15:37:07 -0800121
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100122// Keep in sync with
123// frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
124static const int TRACE_DUMP_TIMEOUT_MS = 10000; // 10 seconds
125
126/* Most simple commands have 10 as timeout, so 5 is a good estimate */
127static const int32_t WEIGHT_FILE = 5;
128
129// TODO: temporary variables and functions used during C++ refactoring
130static Dumpstate& ds = Dumpstate::GetInstance();
131static int RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Nandana Dutt8d945c02019-08-14 13:30:07 +0100132 const CommandOptions& options = CommandOptions::DEFAULT,
Rhed Jao4875aa62020-07-20 17:46:29 +0800133 bool verbose_duration = false, int out_fd = STDOUT_FILENO) {
134 return ds.RunCommand(title, full_command, options, verbose_duration, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100135}
136
137// Reasonable value for max stats.
138static const int STATS_MAX_N_RUNS = 1000;
139static const long STATS_MAX_AVERAGE = 100000;
140
141CommandOptions Dumpstate::DEFAULT_DUMPSYS = CommandOptions::WithTimeout(30).Build();
142
Nandana Duttd2f5f082019-01-18 17:13:52 +0000143typedef Dumpstate::ConsentCallback::ConsentResult UserConsentResult;
144
Colin Crossf45fa6b2012-03-26 12:38:26 -0700145/* read before root is shed */
146static char cmdline_buf[16384] = "(unknown)";
Yi Kong19d5c002018-07-20 13:39:55 -0700147static const char *dump_traces_path = nullptr;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000148static const uint64_t USER_CONSENT_TIMEOUT_MS = 30 * 1000;
Hunter Knepshield70610fa2020-01-03 15:27:33 -0800149// Because telephony reports are significantly faster to collect (< 10 seconds vs. > 2 minutes),
150// it's often the case that they time out far too quickly for consent with such a hefty dialog for
151// the user to read. For telephony reports only, we increase the default timeout to 2 minutes to
152// roughly match full reports' durations.
153static const uint64_t TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS = 2 * 60 * 1000;
Colin Crossf45fa6b2012-03-26 12:38:26 -0700154
Felipe Leme1d486fe2016-10-14 18:06:47 -0700155// TODO: variables and functions below should be part of dumpstate object
156
Felipe Leme635ca312016-01-05 14:23:02 -0800157static std::set<std::string> mount_points;
158void add_mountinfo();
Felipe Leme78f2c862015-12-21 09:55:22 -0800159
Todd Poynor2a83daa2013-11-22 15:44:22 -0800160#define PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops"
Mark Salyzyn7d0a7622016-06-24 14:06:15 -0700161#define ALT_PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops-0"
Wei Wang509bb5d2017-06-09 14:42:12 -0700162#define BLK_DEV_SYS_DIR "/sys/block"
Todd Poynor2a83daa2013-11-22 15:44:22 -0800163
Felipe Lemee82a27d2016-01-05 13:35:44 -0800164#define RECOVERY_DIR "/cache/recovery"
Mark Salyzynd6ab0112016-03-25 12:56:39 -0700165#define RECOVERY_DATA_DIR "/data/misc/recovery"
Tianjie Xu75d53362018-04-11 16:42:28 -0700166#define UPDATE_ENGINE_LOG_DIR "/data/misc/update_engine_log"
Mark Salyzyn4d42dea2016-04-01 10:03:14 -0700167#define LOGPERSIST_DATA_DIR "/data/misc/logd"
Jerry Changa1df8a92020-01-02 16:03:39 +0800168#define PREREBOOT_DATA_DIR "/data/misc/prereboot"
David Brazdild2991962016-06-03 14:40:44 +0100169#define PROFILE_DATA_DIR_CUR "/data/misc/profiles/cur"
170#define PROFILE_DATA_DIR_REF "/data/misc/profiles/ref"
Benedict Wong8f9d8a42019-01-03 16:19:38 -0800171#define XFRM_STAT_PROC_FILE "/proc/net/xfrm_stat"
Erik Kline08165202016-05-30 11:55:44 +0900172#define WLUTIL "/vendor/xbin/wlutil"
Vishnu Nair36b4cdb2017-11-17 10:27:05 -0800173#define WMTRACE_DATA_DIR "/data/misc/wmtrace"
Yifan Hong3945e1b2019-10-29 12:59:23 -0700174#define OTA_METADATA_DIR "/metadata/ota"
Yifan Hong0efa7972020-02-03 16:45:02 -0800175#define SNAPSHOTCTL_LOG_DIR "/data/misc/snapshotctl_log"
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +0900176#define LINKERCONFIG_DIR "/linkerconfig"
Calin Juravle78a0d842020-04-28 15:31:12 -0700177#define PACKAGE_DEX_USE_LIST "/data/system/package-dex-usage.list"
Primiano Tuccifaaaafb2021-01-14 12:26:29 +0000178#define SYSTEM_TRACE_SNAPSHOT "/data/misc/perfetto-traces/bugreport/systrace.pftrace"
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700179
Narayan Kamath8f788292017-05-25 13:20:39 +0100180// TODO(narayan): Since this information has to be kept in sync
181// with tombstoned, we should just put it in a common header.
182//
183// File: system/core/debuggerd/tombstoned/tombstoned.cpp
Narayan Kamathbd863722017-06-01 18:50:12 +0100184static const std::string TOMBSTONE_DIR = "/data/tombstones/";
185static const std::string TOMBSTONE_FILE_PREFIX = "tombstone_";
186static const std::string ANR_DIR = "/data/anr/";
187static const std::string ANR_FILE_PREFIX = "anr_";
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700188
Felipe Lemee844a9d2016-09-21 15:01:39 -0700189// TODO: temporary variables and functions used during C++ refactoring
Nandana Dutt979388e2018-11-30 16:48:55 +0000190
Nandana Dutt5c390032019-03-12 10:52:56 +0000191#define RETURN_IF_USER_DENIED_CONSENT() \
192 if (ds.IsUserConsentDenied()) { \
193 MYLOGE("Returning early as user denied consent to share bugreport with calling app."); \
194 return Dumpstate::RunStatus::USER_CONSENT_DENIED; \
195 }
196
197// Runs func_ptr, but checks user consent before and after running it. Returns USER_CONSENT_DENIED
198// if consent is found to be denied.
199#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(func_ptr, ...) \
200 RETURN_IF_USER_DENIED_CONSENT(); \
201 func_ptr(__VA_ARGS__); \
202 RETURN_IF_USER_DENIED_CONSENT();
203
Rhed Jao1c855122020-07-16 17:37:39 +0800204// Runs func_ptr, and logs a duration report after it's finished.
205#define RUN_SLOW_FUNCTION_AND_LOG(log_title, func_ptr, ...) \
206 { \
207 DurationReporter duration_reporter_in_macro(log_title); \
208 func_ptr(__VA_ARGS__); \
209 }
210
211// Similar with RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK, an additional duration report
212// is output after a slow function is finished.
213#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(log_title, func_ptr, ...) \
214 RETURN_IF_USER_DENIED_CONSENT(); \
215 RUN_SLOW_FUNCTION_AND_LOG(log_title, func_ptr, __VA_ARGS__); \
216 RETURN_IF_USER_DENIED_CONSENT();
217
Rhed Jao4875aa62020-07-20 17:46:29 +0800218#define WAIT_TASK_WITH_CONSENT_CHECK(task_name, pool_ptr) \
219 RETURN_IF_USER_DENIED_CONSENT(); \
220 pool_ptr->waitForTask(task_name); \
221 RETURN_IF_USER_DENIED_CONSENT();
222
Sahana Raof35ed432019-07-12 10:47:52 +0100223static const char* WAKE_LOCK_NAME = "dumpstate_wakelock";
224
Rhed Jao1c855122020-07-16 17:37:39 +0800225// Names of parallel tasks, they are used for the DumpPool to identify the dump
226// task and the log title of the duration report.
227static const std::string DUMP_TRACES_TASK = "DUMP TRACES";
Rhed Jao4875aa62020-07-20 17:46:29 +0800228static const std::string DUMP_INCIDENT_REPORT_TASK = "INCIDENT REPORT";
229static const std::string DUMP_HALS_TASK = "DUMP HALS";
230static const std::string DUMP_BOARD_TASK = "dumpstate_board()";
Rhed Jao6b1ea2d2020-07-21 17:58:41 +0800231static const std::string DUMP_CHECKINS_TASK = "DUMP CHECKINS";
Rhed Jao1c855122020-07-16 17:37:39 +0800232
Nandana Dutt979388e2018-11-30 16:48:55 +0000233namespace android {
234namespace os {
235namespace {
236
237static int Open(std::string path, int flags, mode_t mode = 0) {
238 int fd = TEMP_FAILURE_RETRY(open(path.c_str(), flags, mode));
239 if (fd == -1) {
240 MYLOGE("open(%s, %s)\n", path.c_str(), strerror(errno));
241 }
242 return fd;
243}
244
mhasank2d75c442020-06-11 15:05:25 -0700245static int OpenForWrite(std::string path) {
246 return Open(path, O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
247 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH);
248}
Nandana Dutt979388e2018-11-30 16:48:55 +0000249
250static int OpenForRead(std::string path) {
251 return Open(path, O_RDONLY | O_CLOEXEC | O_NOFOLLOW);
252}
253
254bool CopyFile(int in_fd, int out_fd) {
255 char buf[4096];
256 ssize_t byte_count;
257 while ((byte_count = TEMP_FAILURE_RETRY(read(in_fd, buf, sizeof(buf)))) > 0) {
258 if (!android::base::WriteFully(out_fd, buf, byte_count)) {
259 return false;
260 }
261 }
262 return (byte_count != -1);
263}
264
265static bool CopyFileToFd(const std::string& input_file, int out_fd) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000266 MYLOGD("Going to copy file (%s) to %d\n", input_file.c_str(), out_fd);
Nandana Dutt979388e2018-11-30 16:48:55 +0000267
268 // Obtain a handle to the source file.
269 android::base::unique_fd in_fd(OpenForRead(input_file));
270 if (out_fd != -1 && in_fd.get() != -1) {
271 if (CopyFile(in_fd.get(), out_fd)) {
272 return true;
273 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000274 MYLOGE("Failed to copy file: %s\n", strerror(errno));
Nandana Dutt979388e2018-11-30 16:48:55 +0000275 }
276 return false;
277}
278
Nandana Duttd2f5f082019-01-18 17:13:52 +0000279static bool UnlinkAndLogOnError(const std::string& file) {
Nandana Dutt8ae16e62020-03-27 10:20:22 +0000280 if (file.empty()) {
281 return false;
282 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000283 if (unlink(file.c_str())) {
284 MYLOGE("Failed to unlink file (%s): %s\n", file.c_str(), strerror(errno));
Nandana Duttd2f5f082019-01-18 17:13:52 +0000285 return false;
286 }
287 return true;
288}
Nandana Dutt979388e2018-11-30 16:48:55 +0000289
Nikita Ioffea325a572019-05-16 19:49:47 +0100290int64_t GetModuleMetadataVersion() {
291 auto binder = defaultServiceManager()->getService(android::String16("package_native"));
292 if (binder == nullptr) {
293 MYLOGE("Failed to retrieve package_native service");
294 return 0L;
295 }
296 auto package_service = android::interface_cast<content::pm::IPackageManagerNative>(binder);
297 std::string package_name;
298 auto status = package_service->getModuleMetadataPackageName(&package_name);
299 if (!status.isOk()) {
300 MYLOGE("Failed to retrieve module metadata package name: %s", status.toString8().c_str());
301 return 0L;
302 }
Nandana Duttdb379fa2019-10-09 16:54:41 +0100303 MYLOGD("Module metadata package name: %s\n", package_name.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100304 int64_t version_code;
305 status = package_service->getVersionCodeForPackage(android::String16(package_name.c_str()),
306 &version_code);
307 if (!status.isOk()) {
308 MYLOGE("Failed to retrieve module metadata version: %s", status.toString8().c_str());
309 return 0L;
310 }
311 return version_code;
312}
313
mhasank2d75c442020-06-11 15:05:25 -0700314static bool PathExists(const std::string& path) {
315 struct stat sb;
316 return stat(path.c_str(), &sb) == 0;
317}
318
319static bool CopyFileToFile(const std::string& input_file, const std::string& output_file) {
320 if (input_file == output_file) {
321 MYLOGD("Skipping copying bugreport file since the destination is the same (%s)\n",
322 output_file.c_str());
323 return false;
324 }
325 else if (PathExists(output_file)) {
326 MYLOGD("Cannot overwrite an existing file (%s)\n", output_file.c_str());
327 return false;
328 }
329
330 MYLOGD("Going to copy bugreport file (%s) to %s\n", input_file.c_str(), output_file.c_str());
331 android::base::unique_fd out_fd(OpenForWrite(output_file));
332 return CopyFileToFd(input_file, out_fd.get());
333}
334
Nandana Dutt979388e2018-11-30 16:48:55 +0000335} // namespace
336} // namespace os
337} // namespace android
338
Felipe Leme678727a2016-09-21 17:22:11 -0700339static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
Felipe Lemebda15a02016-11-16 17:48:25 -0800340 const CommandOptions& options = Dumpstate::DEFAULT_DUMPSYS,
Rhed Jao6b1ea2d2020-07-21 17:58:41 +0800341 long dumpsysTimeoutMs = 0, int out_fd = STDOUT_FILENO) {
342 return ds.RunDumpsys(title, dumpsysArgs, options, dumpsysTimeoutMs, out_fd);
343}
344static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
345 int out_fd) {
346 return ds.RunDumpsys(title, dumpsysArgs, Dumpstate::DEFAULT_DUMPSYS, 0, out_fd);
Felipe Leme678727a2016-09-21 17:22:11 -0700347}
348static int DumpFile(const std::string& title, const std::string& path) {
349 return ds.DumpFile(title, path);
350}
Felipe Lemee82a27d2016-01-05 13:35:44 -0800351
Felipe Lemee844a9d2016-09-21 15:01:39 -0700352// Relative directory (inside the zip) for all files copied as-is into the bugreport.
353static const std::string ZIP_ROOT_DIR = "FS";
354
Vishnu Naire97d6122018-01-18 13:58:56 -0800355static const std::string kProtoPath = "proto/";
356static const std::string kProtoExt = ".proto";
Jie Song9fbfad02017-06-20 16:29:42 -0700357static const std::string kDumpstateBoardFiles[] = {
358 "dumpstate_board.txt",
Felipe Leme95d6ca52017-08-01 16:35:56 -0700359 "dumpstate_board.bin"
Jie Song9fbfad02017-06-20 16:29:42 -0700360};
361static const int NUM_OF_DUMPS = arraysize(kDumpstateBoardFiles);
362
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700363static constexpr char PROPERTY_LAST_ID[] = "dumpstate.last_id";
Felipe Lemed071c682016-10-20 16:48:00 -0700364static constexpr char PROPERTY_VERSION[] = "dumpstate.version";
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700365
Felipe Lemef0292972016-11-22 13:57:05 -0800366static const CommandOptions AS_ROOT_20 = CommandOptions::WithTimeout(20).AsRoot().Build();
367
Narayan Kamath8f788292017-05-25 13:20:39 +0100368/*
Narayan Kamathbd863722017-06-01 18:50:12 +0100369 * Returns a vector of dump fds under |dir_path| with a given |file_prefix|.
Rhed Jao01dc0c62020-06-03 17:13:30 +0800370 * The returned vector is sorted by the mtimes of the dumps with descending
371 * order. If |limit_by_mtime| is set, the vector only contains files that
372 * were written in the last 30 minutes.
Narayan Kamath8f788292017-05-25 13:20:39 +0100373 */
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700374static std::vector<DumpData> GetDumpFds(const std::string& dir_path,
375 const std::string& file_prefix,
Elliott Hughesdb6d2112019-09-26 15:24:51 -0700376 bool limit_by_mtime) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100377 const time_t thirty_minutes_ago = ds.now_ - 60 * 30;
378
Narayan Kamathbd863722017-06-01 18:50:12 +0100379 std::unique_ptr<DIR, decltype(&closedir)> dump_dir(opendir(dir_path.c_str()), closedir);
Narayan Kamath8f788292017-05-25 13:20:39 +0100380
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700381 if (dump_dir == nullptr) {
382 MYLOGW("Unable to open directory %s: %s\n", dir_path.c_str(), strerror(errno));
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700383 return std::vector<DumpData>();
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700384 }
385
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700386 std::vector<DumpData> dump_data;
Narayan Kamathbd863722017-06-01 18:50:12 +0100387 struct dirent* entry = nullptr;
388 while ((entry = readdir(dump_dir.get()))) {
389 if (entry->d_type != DT_REG) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100390 continue;
391 }
392
Narayan Kamathbd863722017-06-01 18:50:12 +0100393 const std::string base_name(entry->d_name);
394 if (base_name.find(file_prefix) != 0) {
395 continue;
396 }
397
398 const std::string abs_path = dir_path + base_name;
399 android::base::unique_fd fd(
400 TEMP_FAILURE_RETRY(open(abs_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW | O_NONBLOCK)));
401 if (fd == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700402 MYLOGW("Unable to open dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamathbd863722017-06-01 18:50:12 +0100403 break;
404 }
405
406 struct stat st = {};
407 if (fstat(fd, &st) == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700408 MYLOGW("Unable to stat dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamath8f788292017-05-25 13:20:39 +0100409 continue;
410 }
411
Narayan Kamath3f31b632018-02-22 19:42:36 +0000412 if (limit_by_mtime && st.st_mtime < thirty_minutes_ago) {
Narayan Kamathbd863722017-06-01 18:50:12 +0100413 MYLOGI("Excluding stale dump file: %s\n", abs_path.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100414 continue;
415 }
416
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700417 dump_data.emplace_back(DumpData{abs_path, std::move(fd), st.st_mtime});
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700418 }
Rhed Jao01dc0c62020-06-03 17:13:30 +0800419 if (!dump_data.empty()) {
420 std::sort(dump_data.begin(), dump_data.end(),
421 [](const auto& a, const auto& b) { return a.mtime > b.mtime; });
422 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100423
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700424 return dump_data;
Narayan Kamath8f788292017-05-25 13:20:39 +0100425}
426
Narayan Kamathbd863722017-06-01 18:50:12 +0100427static bool AddDumps(const std::vector<DumpData>::const_iterator start,
428 const std::vector<DumpData>::const_iterator end,
429 const char* type_name, const bool add_to_zip) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100430 bool dumped = false;
Narayan Kamathbd863722017-06-01 18:50:12 +0100431 for (auto it = start; it != end; ++it) {
432 const std::string& name = it->name;
433 const int fd = it->fd;
Narayan Kamath8f788292017-05-25 13:20:39 +0100434 dumped = true;
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100435
436 // Seek to the beginning of the file before dumping any data. A given
437 // DumpData entry might be dumped multiple times in the report.
438 //
439 // For example, the most recent ANR entry is dumped to the body of the
440 // main entry and it also shows up as a separate entry in the bugreport
441 // ZIP file.
442 if (lseek(fd, 0, SEEK_SET) != static_cast<off_t>(0)) {
443 MYLOGE("Unable to add %s to zip file, lseek failed: %s\n", name.c_str(),
444 strerror(errno));
445 }
446
Narayan Kamath8f788292017-05-25 13:20:39 +0100447 if (ds.IsZipping() && add_to_zip) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800448 if (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + name, fd, /* timeout = */ 0ms) != OK) {
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100449 MYLOGE("Unable to add %s to zip file, addZipEntryFromFd failed\n", name.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100450 }
451 } else {
452 dump_file_from_fd(type_name, name.c_str(), fd);
453 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100454 }
455
456 return dumped;
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700457}
458
Felipe Leme635ca312016-01-05 14:23:02 -0800459// for_each_pid() callback to get mount info about a process.
Felipe Leme4c2d6632016-09-28 14:32:00 -0700460void do_mountinfo(int pid, const char* name __attribute__((unused))) {
Felipe Leme635ca312016-01-05 14:23:02 -0800461 char path[PATH_MAX];
462
463 // Gets the the content of the /proc/PID/ns/mnt link, so only unique mount points
464 // are added.
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700465 snprintf(path, sizeof(path), "/proc/%d/ns/mnt", pid);
Felipe Leme635ca312016-01-05 14:23:02 -0800466 char linkname[PATH_MAX];
467 ssize_t r = readlink(path, linkname, PATH_MAX);
468 if (r == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800469 MYLOGE("Unable to read link for %s: %s\n", path, strerror(errno));
Felipe Leme635ca312016-01-05 14:23:02 -0800470 return;
471 }
472 linkname[r] = '\0';
473
474 if (mount_points.find(linkname) == mount_points.end()) {
475 // First time this mount point was found: add it
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700476 snprintf(path, sizeof(path), "/proc/%d/mountinfo", pid);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700477 if (ds.AddZipEntry(ZIP_ROOT_DIR + path, path)) {
Felipe Leme635ca312016-01-05 14:23:02 -0800478 mount_points.insert(linkname);
479 } else {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800480 MYLOGE("Unable to add mountinfo %s to zip file\n", path);
Felipe Leme635ca312016-01-05 14:23:02 -0800481 }
482 }
483}
484
485void add_mountinfo() {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700486 if (!ds.IsZipping()) return;
Felipe Leme678727a2016-09-21 17:22:11 -0700487 std::string title = "MOUNT INFO";
Felipe Leme635ca312016-01-05 14:23:02 -0800488 mount_points.clear();
Felipe Leme46b85da2016-11-21 17:40:45 -0800489 DurationReporter duration_reporter(title, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700490 for_each_pid(do_mountinfo, nullptr);
491 MYLOGD("%s: %d entries added to zip file\n", title.c_str(), (int)mount_points.size());
Felipe Leme635ca312016-01-05 14:23:02 -0800492}
493
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700494static void dump_dev_files(const char *title, const char *driverpath, const char *filename)
495{
496 DIR *d;
497 struct dirent *de;
498 char path[PATH_MAX];
499
500 d = opendir(driverpath);
Yi Kong19d5c002018-07-20 13:39:55 -0700501 if (d == nullptr) {
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700502 return;
503 }
504
505 while ((de = readdir(d))) {
506 if (de->d_type != DT_LNK) {
507 continue;
508 }
509 snprintf(path, sizeof(path), "%s/%s/%s", driverpath, de->d_name, filename);
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700510 DumpFile(title, path);
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700511 }
512
513 closedir(d);
514}
515
Mark Salyzyn326842f2015-04-30 09:49:41 -0700516static bool skip_not_stat(const char *path) {
517 static const char stat[] = "/stat";
518 size_t len = strlen(path);
519 if (path[len - 1] == '/') { /* Directory? */
520 return false;
521 }
522 return strcmp(path + len - sizeof(stat) + 1, stat); /* .../stat? */
523}
524
Felipe Leme4c2d6632016-09-28 14:32:00 -0700525static bool skip_none(const char* path __attribute__((unused))) {
Felipe Lemee82a27d2016-01-05 13:35:44 -0800526 return false;
527}
528
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700529unsigned long worst_write_perf = 20000; /* in KB/s */
Mark Salyzyn326842f2015-04-30 09:49:41 -0700530
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800531//
532// stat offsets
533// Name units description
534// ---- ----- -----------
535// read I/Os requests number of read I/Os processed
536#define __STAT_READ_IOS 0
537// read merges requests number of read I/Os merged with in-queue I/O
538#define __STAT_READ_MERGES 1
539// read sectors sectors number of sectors read
540#define __STAT_READ_SECTORS 2
541// read ticks milliseconds total wait time for read requests
542#define __STAT_READ_TICKS 3
543// write I/Os requests number of write I/Os processed
544#define __STAT_WRITE_IOS 4
545// write merges requests number of write I/Os merged with in-queue I/O
546#define __STAT_WRITE_MERGES 5
547// write sectors sectors number of sectors written
548#define __STAT_WRITE_SECTORS 6
549// write ticks milliseconds total wait time for write requests
550#define __STAT_WRITE_TICKS 7
551// in_flight requests number of I/Os currently in flight
552#define __STAT_IN_FLIGHT 8
553// io_ticks milliseconds total time this block device has been active
554#define __STAT_IO_TICKS 9
555// time_in_queue milliseconds total wait time for all requests
556#define __STAT_IN_QUEUE 10
557#define __STAT_NUMBER_FIELD 11
558//
559// read I/Os, write I/Os
560// =====================
561//
562// These values increment when an I/O request completes.
563//
564// read merges, write merges
565// =========================
566//
567// These values increment when an I/O request is merged with an
568// already-queued I/O request.
569//
570// read sectors, write sectors
571// ===========================
572//
573// These values count the number of sectors read from or written to this
574// block device. The "sectors" in question are the standard UNIX 512-byte
575// sectors, not any device- or filesystem-specific block size. The
576// counters are incremented when the I/O completes.
577#define SECTOR_SIZE 512
578//
579// read ticks, write ticks
580// =======================
581//
582// These values count the number of milliseconds that I/O requests have
583// waited on this block device. If there are multiple I/O requests waiting,
584// these values will increase at a rate greater than 1000/second; for
585// example, if 60 read requests wait for an average of 30 ms, the read_ticks
586// field will increase by 60*30 = 1800.
587//
588// in_flight
589// =========
590//
591// This value counts the number of I/O requests that have been issued to
592// the device driver but have not yet completed. It does not include I/O
593// requests that are in the queue but not yet issued to the device driver.
594//
595// io_ticks
596// ========
597//
598// This value counts the number of milliseconds during which the device has
599// had I/O requests queued.
600//
601// time_in_queue
602// =============
603//
604// This value counts the number of milliseconds that I/O requests have waited
605// on this block device. If there are multiple I/O requests waiting, this
606// value will increase as the product of the number of milliseconds times the
607// number of requests waiting (see "read ticks" above for an example).
608#define S_TO_MS 1000
609//
610
Mark Salyzyn326842f2015-04-30 09:49:41 -0700611static int dump_stat_from_fd(const char *title __unused, const char *path, int fd) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800612 unsigned long long fields[__STAT_NUMBER_FIELD];
Mark Salyzyn326842f2015-04-30 09:49:41 -0700613 bool z;
Yi Kong19d5c002018-07-20 13:39:55 -0700614 char *cp, *buffer = nullptr;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700615 size_t i = 0;
Josh Gao7c4258c2018-06-25 13:40:08 -0700616 FILE *fp = fdopen(dup(fd), "rb");
Mark Salyzyn326842f2015-04-30 09:49:41 -0700617 getline(&buffer, &i, fp);
618 fclose(fp);
619 if (!buffer) {
620 return -errno;
621 }
622 i = strlen(buffer);
623 while ((i > 0) && (buffer[i - 1] == '\n')) {
624 buffer[--i] = '\0';
625 }
626 if (!*buffer) {
627 free(buffer);
628 return 0;
629 }
630 z = true;
631 for (cp = buffer, i = 0; i < (sizeof(fields) / sizeof(fields[0])); ++i) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800632 fields[i] = strtoull(cp, &cp, 10);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700633 if (fields[i] != 0) {
634 z = false;
635 }
636 }
637 if (z) { /* never accessed */
638 free(buffer);
639 return 0;
640 }
641
Wei Wang509bb5d2017-06-09 14:42:12 -0700642 if (!strncmp(path, BLK_DEV_SYS_DIR, sizeof(BLK_DEV_SYS_DIR) - 1)) {
643 path += sizeof(BLK_DEV_SYS_DIR) - 1;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700644 }
Wei Wang1dc1ef52017-06-12 11:28:37 -0700645
646 printf("%-30s:%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s\n%-30s:\t%s\n", "Block-Dev",
647 "R-IOs", "R-merg", "R-sect", "R-wait", "W-IOs", "W-merg", "W-sect",
648 "W-wait", "in-fli", "activ", "T-wait", path, buffer);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700649 free(buffer);
650
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800651 if (fields[__STAT_IO_TICKS]) {
652 unsigned long read_perf = 0;
653 unsigned long read_ios = 0;
654 if (fields[__STAT_READ_TICKS]) {
655 unsigned long long divisor = fields[__STAT_READ_TICKS]
656 * fields[__STAT_IO_TICKS];
657 read_perf = ((unsigned long long)SECTOR_SIZE
658 * fields[__STAT_READ_SECTORS]
659 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
660 / divisor;
661 read_ios = ((unsigned long long)S_TO_MS * fields[__STAT_READ_IOS]
662 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
663 / divisor;
664 }
665
666 unsigned long write_perf = 0;
667 unsigned long write_ios = 0;
668 if (fields[__STAT_WRITE_TICKS]) {
669 unsigned long long divisor = fields[__STAT_WRITE_TICKS]
670 * fields[__STAT_IO_TICKS];
671 write_perf = ((unsigned long long)SECTOR_SIZE
672 * fields[__STAT_WRITE_SECTORS]
673 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
674 / divisor;
675 write_ios = ((unsigned long long)S_TO_MS * fields[__STAT_WRITE_IOS]
676 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
677 / divisor;
678 }
679
680 unsigned queue = (fields[__STAT_IN_QUEUE]
681 + (fields[__STAT_IO_TICKS] >> 1))
682 / fields[__STAT_IO_TICKS];
683
684 if (!write_perf && !write_ios) {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700685 printf("%-30s: perf(ios) rd: %luKB/s(%lu/s) q: %u\n", path, read_perf, read_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800686 } else {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700687 printf("%-30s: perf(ios) rd: %luKB/s(%lu/s) wr: %luKB/s(%lu/s) q: %u\n", path, read_perf,
Felipe Lemed8b94e52016-12-08 10:21:44 -0800688 read_ios, write_perf, write_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800689 }
690
691 /* bugreport timeout factor adjustment */
692 if ((write_perf > 1) && (write_perf < worst_write_perf)) {
693 worst_write_perf = write_perf;
694 }
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700695 }
Mark Salyzyn326842f2015-04-30 09:49:41 -0700696 return 0;
697}
698
Yao Chenbe3bbc12018-01-17 16:31:10 -0800699static const long MINIMUM_LOGCAT_TIMEOUT_MS = 50000;
700
Tom Cherryf4472f32020-08-05 09:31:17 -0700701// Returns the actual readable size of the given buffer or -1 on error.
702static long logcat_buffer_readable_size(const std::string& buffer) {
703 std::unique_ptr<logger_list, decltype(&android_logger_list_free)> logger_list{
704 android_logger_list_alloc(0, 0, 0), &android_logger_list_free};
705 auto logger = android_logger_open(logger_list.get(), android_name_to_log_id(buffer.c_str()));
706
707 return android_logger_get_log_readable_size(logger);
708}
709
710// Returns timeout in ms to read a list of buffers.
Yao Chenbe3bbc12018-01-17 16:31:10 -0800711static unsigned long logcat_timeout(const std::vector<std::string>& buffers) {
712 unsigned long timeout_ms = 0;
713 for (const auto& buffer : buffers) {
Tom Cherryf4472f32020-08-05 09:31:17 -0700714 long readable_size = logcat_buffer_readable_size(buffer);
715 if (readable_size > 0) {
716 // Engineering margin is ten-fold our guess.
717 timeout_ms += 10 * (readable_size + worst_write_perf) / worst_write_perf;
718 }
Yao Chenbe3bbc12018-01-17 16:31:10 -0800719 }
720 return timeout_ms > MINIMUM_LOGCAT_TIMEOUT_MS ? timeout_ms : MINIMUM_LOGCAT_TIMEOUT_MS;
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700721}
722
Dieter Hsu105ad0c2020-09-29 15:23:33 +0800723// Opens a socket and returns its file descriptor.
724static int open_socket(const char* service);
725
Nandana Duttd2f5f082019-01-18 17:13:52 +0000726Dumpstate::ConsentCallback::ConsentCallback() : result_(UNAVAILABLE), start_time_(Nanotime()) {
727}
728
729android::binder::Status Dumpstate::ConsentCallback::onReportApproved() {
730 std::lock_guard<std::mutex> lock(lock_);
731 result_ = APPROVED;
732 MYLOGD("User approved consent to share bugreport\n");
Paul Chang0d2aad72020-02-13 20:04:03 +0800733
734 // Maybe copy screenshot so calling app can display the screenshot to the user as soon as
735 // consent is granted.
736 if (ds.options_->is_screenshot_copied) {
737 return android::binder::Status::ok();
738 }
739
740 if (!ds.options_->do_screenshot || ds.options_->screenshot_fd.get() == -1 ||
741 !ds.do_early_screenshot_) {
742 return android::binder::Status::ok();
743 }
744
745 bool copy_succeeded = android::os::CopyFileToFd(ds.screenshot_path_,
746 ds.options_->screenshot_fd.get());
747 ds.options_->is_screenshot_copied = copy_succeeded;
748 if (copy_succeeded) {
749 android::os::UnlinkAndLogOnError(ds.screenshot_path_);
750 }
Nandana Duttd2f5f082019-01-18 17:13:52 +0000751 return android::binder::Status::ok();
752}
753
754android::binder::Status Dumpstate::ConsentCallback::onReportDenied() {
755 std::lock_guard<std::mutex> lock(lock_);
756 result_ = DENIED;
757 MYLOGW("User denied consent to share bugreport\n");
758 return android::binder::Status::ok();
759}
760
761UserConsentResult Dumpstate::ConsentCallback::getResult() {
762 std::lock_guard<std::mutex> lock(lock_);
763 return result_;
764}
765
766uint64_t Dumpstate::ConsentCallback::getElapsedTimeMs() const {
Hunter Knepshieldf0a39052020-01-03 14:53:04 -0800767 return (Nanotime() - start_time_) / NANOS_PER_MILLI;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000768}
769
Felipe Leme2b9b06c2016-10-14 09:13:06 -0700770void Dumpstate::PrintHeader() const {
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700771 std::string build, fingerprint, radio, bootloader, network;
772 char date[80];
Colin Crossf45fa6b2012-03-26 12:38:26 -0700773
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700774 build = android::base::GetProperty("ro.build.display.id", "(unknown)");
775 fingerprint = android::base::GetProperty("ro.build.fingerprint", "(unknown)");
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700776 radio = android::base::GetProperty("gsm.version.baseband", "(unknown)");
777 bootloader = android::base::GetProperty("ro.bootloader", "(unknown)");
778 network = android::base::GetProperty("gsm.operator.alpha", "(unknown)");
Felipe Lemebbaf3c12016-10-11 14:32:25 -0700779 strftime(date, sizeof(date), "%Y-%m-%d %H:%M:%S", localtime(&now_));
Colin Crossf45fa6b2012-03-26 12:38:26 -0700780
Felipe Lemed8b94e52016-12-08 10:21:44 -0800781 printf("========================================================\n");
782 printf("== dumpstate: %s\n", date);
783 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -0700784
Felipe Lemed8b94e52016-12-08 10:21:44 -0800785 printf("\n");
786 printf("Build: %s\n", build.c_str());
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700787 // NOTE: fingerprint entry format is important for other tools.
Felipe Lemed8b94e52016-12-08 10:21:44 -0800788 printf("Build fingerprint: '%s'\n", fingerprint.c_str());
789 printf("Bootloader: %s\n", bootloader.c_str());
790 printf("Radio: %s\n", radio.c_str());
791 printf("Network: %s\n", network.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100792 int64_t module_metadata_version = android::os::GetModuleMetadataVersion();
793 if (module_metadata_version != 0) {
794 printf("Module Metadata version: %" PRId64 "\n", module_metadata_version);
795 }
Anton Hansson37c041d2021-04-14 17:49:06 +0100796 printf("SDK extension versions [r=%s s=%s]\n",
797 android::base::GetProperty("build.version.extensions.r", "-").c_str(),
798 android::base::GetProperty("build.version.extensions.s", "-").c_str());
Colin Crossf45fa6b2012-03-26 12:38:26 -0700799
Felipe Lemed8b94e52016-12-08 10:21:44 -0800800 printf("Kernel: ");
Felipe Lemef0292972016-11-22 13:57:05 -0800801 DumpFileToFd(STDOUT_FILENO, "", "/proc/version");
Felipe Lemed8b94e52016-12-08 10:21:44 -0800802 printf("Command line: %s\n", strtok(cmdline_buf, "\n"));
Felipe Leme7709f8a2017-12-05 09:30:09 -0800803 printf("Uptime: ");
804 RunCommandToFd(STDOUT_FILENO, "", {"uptime", "-p"},
805 CommandOptions::WithTimeout(1).Always().Build());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800806 printf("Bugreport format version: %s\n", version_.c_str());
Rhed Jao1c855122020-07-16 17:37:39 +0800807 printf("Dumpstate info: id=%d pid=%d dry_run=%d parallel_run=%d args=%s bugreport_mode=%s\n",
808 id_, pid_, PropertiesHelper::IsDryRun(), PropertiesHelper::IsParallelRun(),
809 options_->args.c_str(), options_->bugreport_mode.c_str());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800810 printf("\n");
Felipe Leme78f2c862015-12-21 09:55:22 -0800811}
812
Felipe Leme24b66ee2016-06-16 10:55:26 -0700813// List of file extensions that can cause a zip file attachment to be rejected by some email
814// service providers.
815static const std::set<std::string> PROBLEMATIC_FILE_EXTENSIONS = {
816 ".ade", ".adp", ".bat", ".chm", ".cmd", ".com", ".cpl", ".exe", ".hta", ".ins", ".isp",
817 ".jar", ".jse", ".lib", ".lnk", ".mde", ".msc", ".msp", ".mst", ".pif", ".scr", ".sct",
818 ".shb", ".sys", ".vb", ".vbe", ".vbs", ".vxd", ".wsc", ".wsf", ".wsh"
819};
820
Vishnu Naire97d6122018-01-18 13:58:56 -0800821status_t Dumpstate::AddZipEntryFromFd(const std::string& entry_name, int fd,
822 std::chrono::milliseconds timeout = 0ms) {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700823 if (!IsZipping()) {
824 MYLOGD("Not adding zip entry %s from fd because it's not a zipped bugreport\n",
825 entry_name.c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -0800826 return INVALID_OPERATION;
Felipe Leme111b9d02016-02-03 09:28:24 -0800827 }
Felipe Leme24b66ee2016-06-16 10:55:26 -0700828 std::string valid_name = entry_name;
829
830 // Rename extension if necessary.
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -0700831 size_t idx = entry_name.rfind('.');
Felipe Leme24b66ee2016-06-16 10:55:26 -0700832 if (idx != std::string::npos) {
833 std::string extension = entry_name.substr(idx);
834 std::transform(extension.begin(), extension.end(), extension.begin(), ::tolower);
835 if (PROBLEMATIC_FILE_EXTENSIONS.count(extension) != 0) {
836 valid_name = entry_name + ".renamed";
837 MYLOGI("Renaming entry %s to %s\n", entry_name.c_str(), valid_name.c_str());
838 }
839 }
840
Felipe Leme6fe9db62016-02-12 09:04:16 -0800841 // Logging statement below is useful to time how long each entry takes, but it's too verbose.
842 // MYLOGD("Adding zip entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700843 int32_t err = zip_writer_->StartEntryWithTime(valid_name.c_str(), ZipWriter::kCompress,
844 get_mtime(fd, ds.now_));
Felipe Leme1d486fe2016-10-14 18:06:47 -0700845 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700846 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", valid_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700847 ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800848 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800849 }
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000850 bool finished_entry = false;
851 auto finish_entry = [this, &finished_entry] {
852 if (!finished_entry) {
853 // This should only be called when we're going to return an earlier error,
854 // which would've been logged. This may imply the file is already corrupt
855 // and any further logging from FinishEntry is more likely to mislead than
856 // not.
857 this->zip_writer_->FinishEntry();
858 }
859 };
860 auto scope_guard = android::base::make_scope_guard(finish_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -0800861 auto start = std::chrono::steady_clock::now();
862 auto end = start + timeout;
863 struct pollfd pfd = {fd, POLLIN};
Felipe Lemee82a27d2016-01-05 13:35:44 -0800864
Felipe Leme770410d2016-01-26 17:07:14 -0800865 std::vector<uint8_t> buffer(65536);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800866 while (1) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800867 if (timeout.count() > 0) {
868 // lambda to recalculate the timeout.
869 auto time_left_ms = [end]() {
870 auto now = std::chrono::steady_clock::now();
871 auto diff = std::chrono::duration_cast<std::chrono::milliseconds>(end - now);
872 return std::max(diff.count(), 0LL);
873 };
874
875 int rc = TEMP_FAILURE_RETRY(poll(&pfd, 1, time_left_ms()));
876 if (rc < 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000877 MYLOGE("Error in poll while adding from fd to zip entry %s:%s\n",
878 entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800879 return -errno;
880 } else if (rc == 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000881 MYLOGE("Timed out adding from fd to zip entry %s:%s Timeout:%lldms\n",
Vishnu Naire97d6122018-01-18 13:58:56 -0800882 entry_name.c_str(), strerror(errno), timeout.count());
883 return TIMED_OUT;
884 }
885 }
886
Zach Riggle22200402016-08-18 01:01:24 -0400887 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800888 if (bytes_read == 0) {
889 break;
890 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800891 MYLOGE("read(%s): %s\n", entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800892 return -errno;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800893 }
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700894 err = zip_writer_->WriteBytes(buffer.data(), bytes_read);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800895 if (err) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700896 MYLOGE("zip_writer_->WriteBytes(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800897 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800898 }
899 }
900
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700901 err = zip_writer_->FinishEntry();
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000902 finished_entry = true;
Felipe Leme1d486fe2016-10-14 18:06:47 -0700903 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700904 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800905 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800906 }
907
Vishnu Naire97d6122018-01-18 13:58:56 -0800908 return OK;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800909}
910
Felipe Leme1d486fe2016-10-14 18:06:47 -0700911bool Dumpstate::AddZipEntry(const std::string& entry_name, const std::string& entry_path) {
912 android::base::unique_fd fd(
913 TEMP_FAILURE_RETRY(open(entry_path.c_str(), O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
Andreas Gampeaff68432016-07-18 18:01:27 -0700914 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800915 MYLOGE("open(%s): %s\n", entry_path.c_str(), strerror(errno));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800916 return false;
917 }
918
Vishnu Naire97d6122018-01-18 13:58:56 -0800919 return (AddZipEntryFromFd(entry_name, fd.get()) == OK);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800920}
921
922/* adds a file to the existing zipped bugreport */
Felipe Leme4c2d6632016-09-28 14:32:00 -0700923static int _add_file_from_fd(const char* title __attribute__((unused)), const char* path, int fd) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800924 return (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + path, fd) == OK) ? 0 : 1;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800925}
926
Felipe Leme1d486fe2016-10-14 18:06:47 -0700927void Dumpstate::AddDir(const std::string& dir, bool recursive) {
928 if (!IsZipping()) {
929 MYLOGD("Not adding dir %s because it's not a zipped bugreport\n", dir.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800930 return;
931 }
Felipe Leme678727a2016-09-21 17:22:11 -0700932 MYLOGD("Adding dir %s (recursive: %d)\n", dir.c_str(), recursive);
Felipe Leme46b85da2016-11-21 17:40:45 -0800933 DurationReporter duration_reporter(dir, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700934 dump_files("", dir.c_str(), recursive ? skip_none : is_dir, _add_file_from_fd);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800935}
936
Felipe Leme1d486fe2016-10-14 18:06:47 -0700937bool Dumpstate::AddTextZipEntry(const std::string& entry_name, const std::string& content) {
938 if (!IsZipping()) {
939 MYLOGD("Not adding text zip entry %s because it's not a zipped bugreport\n",
940 entry_name.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800941 return false;
942 }
Felipe Lemecbce55d2016-02-08 09:53:18 -0800943 MYLOGD("Adding zip text entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700944 int32_t err = zip_writer_->StartEntryWithTime(entry_name.c_str(), ZipWriter::kCompress, ds.now_);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700945 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700946 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700947 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800948 return false;
949 }
950
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700951 err = zip_writer_->WriteBytes(content.c_str(), content.length());
Felipe Leme1d486fe2016-10-14 18:06:47 -0700952 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700953 MYLOGE("zip_writer_->WriteBytes(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700954 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800955 return false;
956 }
957
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700958 err = zip_writer_->FinishEntry();
Felipe Leme1d486fe2016-10-14 18:06:47 -0700959 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700960 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800961 return false;
962 }
963
964 return true;
965}
966
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800967static void DoKmsg() {
968 struct stat st;
969 if (!stat(PSTORE_LAST_KMSG, &st)) {
970 /* Also TODO: Make console-ramoops CAP_SYSLOG protected. */
971 DumpFile("LAST KMSG", PSTORE_LAST_KMSG);
972 } else if (!stat(ALT_PSTORE_LAST_KMSG, &st)) {
973 DumpFile("LAST KMSG", ALT_PSTORE_LAST_KMSG);
974 } else {
975 /* TODO: Make last_kmsg CAP_SYSLOG protected. b/5555691 */
976 DumpFile("LAST KMSG", "/proc/last_kmsg");
977 }
978}
979
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800980static void DoKernelLogcat() {
Yao Chenbe3bbc12018-01-17 16:31:10 -0800981 unsigned long timeout_ms = logcat_timeout({"kernel"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800982 RunCommand(
983 "KERNEL LOG",
984 {"logcat", "-b", "kernel", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
985 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
986}
987
Nandana Duttdb379fa2019-10-09 16:54:41 +0100988static void DoSystemLogcat(time_t since) {
989 char since_str[80];
990 strftime(since_str, sizeof(since_str), "%Y-%m-%d %H:%M:%S.000", localtime(&since));
991
992 unsigned long timeout_ms = logcat_timeout({"main", "system", "crash"});
993 RunCommand("SYSTEM LOG",
994 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v", "-T",
995 since_str},
996 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
997}
998
Hunter Knepshield820f9bc2020-02-05 20:10:53 -0800999static void DoRadioLogcat() {
1000 unsigned long timeout_ms = logcat_timeout({"radio"});
1001 RunCommand(
1002 "RADIO LOG",
1003 {"logcat", "-b", "radio", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1004 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
1005}
1006
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001007static void DoLogcat() {
Vishnu Nair6921f802017-11-22 09:17:23 -08001008 unsigned long timeout_ms;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001009 // DumpFile("EVENT LOG TAGS", "/etc/event-log-tags");
1010 // calculate timeout
Yao Chenbe3bbc12018-01-17 16:31:10 -08001011 timeout_ms = logcat_timeout({"main", "system", "crash"});
Tony Makae737652017-03-30 17:47:09 +01001012 RunCommand("SYSTEM LOG",
Vishnu Nair6921f802017-11-22 09:17:23 -08001013 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1014 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -08001015 timeout_ms = logcat_timeout({"events"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001016 RunCommand(
1017 "EVENT LOG",
1018 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001019 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Yao Chenbe3bbc12018-01-17 16:31:10 -08001020 timeout_ms = logcat_timeout({"stats"});
1021 RunCommand(
1022 "STATS LOG",
1023 {"logcat", "-b", "stats", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001024 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001025 DoRadioLogcat();
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001026
1027 RunCommand("LOG STATISTICS", {"logcat", "-b", "all", "-S"});
1028
1029 /* kernels must set CONFIG_PSTORE_PMSG, slice up pstore with device tree */
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001030 RunCommand("LAST LOGCAT", {"logcat", "-L", "-b", "all", "-v", "threadtime", "-v", "printable",
1031 "-v", "uid", "-d", "*:v"});
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001032}
1033
Mike Ma5c267872019-08-21 11:31:34 -07001034static void DumpIncidentReport() {
1035 if (!ds.IsZipping()) {
1036 MYLOGD("Not dumping incident report because it's not a zipped bugreport\n");
1037 return;
1038 }
Mike Ma5c267872019-08-21 11:31:34 -07001039 const std::string path = ds.bugreport_internal_dir_ + "/tmp_incident_report";
1040 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1041 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1042 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1043 if (fd < 0) {
1044 MYLOGE("Could not open %s to dump incident report.\n", path.c_str());
1045 return;
1046 }
1047 RunCommandToFd(fd, "", {"incident", "-u"}, CommandOptions::WithTimeout(120).Build());
1048 bool empty = 0 == lseek(fd, 0, SEEK_END);
1049 if (!empty) {
1050 // Use a different name from "incident.proto"
1051 // /proto/incident.proto is reserved for incident service dump
1052 // i.e. metadata for debugging.
Rhed Jao4875aa62020-07-20 17:46:29 +08001053 ds.EnqueueAddZipEntryAndCleanupIfNeeded(kProtoPath + "incident_report" + kProtoExt,
1054 path);
1055 } else {
1056 unlink(path.c_str());
Mike Ma5c267872019-08-21 11:31:34 -07001057 }
Mike Ma5c267872019-08-21 11:31:34 -07001058}
1059
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001060static void MaybeAddSystemTraceToZip() {
1061 // This function copies into the .zip the system trace that was snapshotted
1062 // by the early call to MaybeSnapshotSystemTrace(), if any background
1063 // tracing was happening.
1064 if (!ds.IsZipping()) {
1065 MYLOGD("Not dumping system trace because it's not a zipped bugreport\n");
1066 return;
1067 }
1068 if (!ds.has_system_trace_) {
1069 // No background trace was happening at the time dumpstate was invoked.
1070 return;
1071 }
1072 ds.AddZipEntry(
1073 ZIP_ROOT_DIR + SYSTEM_TRACE_SNAPSHOT,
1074 SYSTEM_TRACE_SNAPSHOT);
1075 android::os::UnlinkAndLogOnError(SYSTEM_TRACE_SNAPSHOT);
1076}
1077
Sunny Goyal35949782019-11-19 15:54:36 -08001078static void DumpVisibleWindowViews() {
1079 if (!ds.IsZipping()) {
1080 MYLOGD("Not dumping visible views because it's not a zipped bugreport\n");
1081 return;
1082 }
1083 DurationReporter duration_reporter("VISIBLE WINDOW VIEWS");
1084 const std::string path = ds.bugreport_internal_dir_ + "/tmp_visible_window_views";
1085 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1086 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1087 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1088 if (fd < 0) {
1089 MYLOGE("Could not open %s to dump visible views.\n", path.c_str());
1090 return;
1091 }
1092 RunCommandToFd(fd, "", {"cmd", "window", "dump-visible-window-views"},
1093 CommandOptions::WithTimeout(120).Build());
1094 bool empty = 0 == lseek(fd, 0, SEEK_END);
1095 if (!empty) {
1096 ds.AddZipEntry("visible_windows.zip", path);
1097 } else {
1098 MYLOGW("Failed to dump visible windows\n");
1099 }
1100 unlink(path.c_str());
1101}
1102
Jayachandran Ca94c7172017-06-10 15:08:12 -07001103static void DumpIpTablesAsRoot() {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001104 RunCommand("IPTABLES", {"iptables", "-L", "-nvx"});
1105 RunCommand("IP6TABLES", {"ip6tables", "-L", "-nvx"});
Erik Kline32af8c22016-09-28 17:26:26 +09001106 RunCommand("IPTABLES NAT", {"iptables", "-t", "nat", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001107 /* no ip6 nat */
Erik Kline32af8c22016-09-28 17:26:26 +09001108 RunCommand("IPTABLES MANGLE", {"iptables", "-t", "mangle", "-L", "-nvx"});
1109 RunCommand("IP6TABLES MANGLE", {"ip6tables", "-t", "mangle", "-L", "-nvx"});
1110 RunCommand("IPTABLES RAW", {"iptables", "-t", "raw", "-L", "-nvx"});
1111 RunCommand("IP6TABLES RAW", {"ip6tables", "-t", "raw", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001112}
1113
David Andersond9ba4752018-12-11 18:26:59 -08001114static void DumpDynamicPartitionInfo() {
1115 if (!::android::base::GetBoolProperty("ro.boot.dynamic_partitions", false)) {
1116 return;
1117 }
1118
1119 RunCommand("LPDUMP", {"lpdump", "--all"});
David Anderson6650ade2019-10-02 15:18:59 -07001120 RunCommand("DEVICE-MAPPER", {"gsid", "dump-device-mapper"});
David Andersond9ba4752018-12-11 18:26:59 -08001121}
1122
Narayan Kamath8f788292017-05-25 13:20:39 +01001123static void AddAnrTraceDir(const bool add_to_zip, const std::string& anr_traces_dir) {
1124 MYLOGD("AddAnrTraceDir(): dump_traces_file=%s, anr_traces_dir=%s\n", dump_traces_path,
1125 anr_traces_dir.c_str());
1126
1127 // If we're here, dump_traces_path will always be a temporary file
1128 // (created with mkostemp or similar) that contains dumps taken earlier
1129 // on in the process.
1130 if (dump_traces_path != nullptr) {
1131 if (add_to_zip) {
1132 ds.AddZipEntry(ZIP_ROOT_DIR + anr_traces_dir + "/traces-just-now.txt", dump_traces_path);
1133 } else {
1134 MYLOGD("Dumping current ANR traces (%s) to the main bugreport entry\n",
1135 dump_traces_path);
1136 ds.DumpFile("VM TRACES JUST NOW", dump_traces_path);
1137 }
1138
1139 const int ret = unlink(dump_traces_path);
1140 if (ret == -1) {
1141 MYLOGW("Error unlinking temporary trace path %s: %s\n", dump_traces_path,
1142 strerror(errno));
Felipe Lemee184f662016-10-27 10:04:47 -07001143 }
1144 }
1145
Narayan Kamathbd863722017-06-01 18:50:12 +01001146 // Add a specific message for the first ANR Dump.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001147 if (ds.anr_data_.size() > 0) {
1148 AddDumps(ds.anr_data_.begin(), ds.anr_data_.begin() + 1,
Narayan Kamathbd863722017-06-01 18:50:12 +01001149 "VM TRACES AT LAST ANR", add_to_zip);
1150
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001151 // The "last" ANR will always be included as separate entry in the zip file. In addition,
1152 // it will be present in the body of the main entry if |add_to_zip| == false.
1153 //
1154 // Historical ANRs are always included as separate entries in the bugreport zip file.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001155 AddDumps(ds.anr_data_.begin() + ((add_to_zip) ? 1 : 0), ds.anr_data_.end(),
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001156 "HISTORICAL ANR", true /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001157 } else {
Narayan Kamath8f788292017-05-25 13:20:39 +01001158 printf("*** NO ANRs to dump in %s\n\n", ANR_DIR.c_str());
1159 }
1160}
1161
1162static void AddAnrTraceFiles() {
1163 const bool add_to_zip = ds.IsZipping() && ds.version_ == VERSION_SPLIT_ANR;
1164
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001165 std::string anr_traces_dir = "/data/anr";
Narayan Kamath8f788292017-05-25 13:20:39 +01001166
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001167 AddAnrTraceDir(add_to_zip, anr_traces_dir);
Narayan Kamath8f788292017-05-25 13:20:39 +01001168
Makoto Onuki83ec63f2019-01-31 17:08:59 -08001169 RunCommand("ANR FILES", {"ls", "-lt", ANR_DIR});
1170
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001171 // Slow traces for slow operations.
Felipe Lemee184f662016-10-27 10:04:47 -07001172 struct stat st;
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001173 int i = 0;
1174 while (true) {
1175 const std::string slow_trace_path =
1176 anr_traces_dir + android::base::StringPrintf("slow%02d.txt", i);
1177 if (stat(slow_trace_path.c_str(), &st)) {
1178 // No traces file at this index, done with the files.
1179 break;
Felipe Lemee184f662016-10-27 10:04:47 -07001180 }
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001181 ds.DumpFile("VM TRACES WHEN SLOW", slow_trace_path.c_str());
1182 i++;
Felipe Lemee184f662016-10-27 10:04:47 -07001183 }
1184}
1185
Wei Wang509bb5d2017-06-09 14:42:12 -07001186static void DumpBlockStatFiles() {
1187 DurationReporter duration_reporter("DUMP BLOCK STAT");
Wei Wang509bb5d2017-06-09 14:42:12 -07001188
Wei Wang1dc1ef52017-06-12 11:28:37 -07001189 std::unique_ptr<DIR, std::function<int(DIR*)>> dirptr(opendir(BLK_DEV_SYS_DIR), closedir);
1190
1191 if (dirptr == nullptr) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001192 MYLOGE("Failed to open %s: %s\n", BLK_DEV_SYS_DIR, strerror(errno));
1193 return;
1194 }
1195
1196 printf("------ DUMP BLOCK STAT ------\n\n");
Wei Wang1dc1ef52017-06-12 11:28:37 -07001197 while (struct dirent *d = readdir(dirptr.get())) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001198 if ((d->d_name[0] == '.')
1199 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
1200 || (d->d_name[1] == '\0'))) {
1201 continue;
1202 }
1203 const std::string new_path =
1204 android::base::StringPrintf("%s/%s", BLK_DEV_SYS_DIR, d->d_name);
1205 printf("------ BLOCK STAT (%s) ------\n", new_path.c_str());
1206 dump_files("", new_path.c_str(), skip_not_stat, dump_stat_from_fd);
1207 printf("\n");
1208 }
Wei Wang1dc1ef52017-06-12 11:28:37 -07001209 return;
Wei Wang509bb5d2017-06-09 14:42:12 -07001210}
Jayachandran Ca94c7172017-06-10 15:08:12 -07001211
1212static void DumpPacketStats() {
1213 DumpFile("NETWORK DEV INFO", "/proc/net/dev");
Jayachandran Ca94c7172017-06-10 15:08:12 -07001214}
1215
1216static void DumpIpAddrAndRules() {
1217 /* The following have a tendency to get wedged when wifi drivers/fw goes belly-up. */
1218 RunCommand("NETWORK INTERFACES", {"ip", "link"});
1219 RunCommand("IPv4 ADDRESSES", {"ip", "-4", "addr", "show"});
1220 RunCommand("IPv6 ADDRESSES", {"ip", "-6", "addr", "show"});
1221 RunCommand("IP RULES", {"ip", "rule", "show"});
1222 RunCommand("IP RULES v6", {"ip", "-6", "rule", "show"});
1223}
1224
Nandana Dutt5c390032019-03-12 10:52:56 +00001225static Dumpstate::RunStatus RunDumpsysTextByPriority(const std::string& title, int priority,
1226 std::chrono::milliseconds timeout,
1227 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001228 auto start = std::chrono::steady_clock::now();
Vishnu Naire97d6122018-01-18 13:58:56 -08001229 sp<android::IServiceManager> sm = defaultServiceManager();
1230 Dumpsys dumpsys(sm.get());
Vishnu Naire97d6122018-01-18 13:58:56 -08001231 Vector<String16> args;
1232 Dumpsys::setServiceArgs(args, /* asProto = */ false, priority);
Vishnu Naire97d6122018-01-18 13:58:56 -08001233 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ false);
1234 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001235 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001236 std::string path(title);
1237 path.append(" - ").append(String8(service).c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -08001238 size_t bytes_written = 0;
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 Jao4875aa62020-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 Moreland9de8a1f2020-09-23 17:26:33 +00001374 CommandOptions::WithTimeout(60).AsRootIfAvailable().Build());
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001375 return;
1376 }
Yifan Hong30528a22020-08-07 18:24:06 -07001377 RunCommand("HARDWARE HALS", {"lshal", "--all", "--types=all"},
Rhed Jao4875aa62020-07-20 17:46:29 +08001378 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build(),
1379 false, out_fd);
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001380
Steven Moreland44cd9482018-01-04 16:24:13 -08001381 using android::hidl::manager::V1_0::IServiceManager;
1382 using android::hardware::defaultServiceManager;
1383
1384 sp<IServiceManager> sm = defaultServiceManager();
1385 if (sm == nullptr) {
1386 MYLOGE("Could not retrieve hwservicemanager to dump hals.\n");
1387 return;
1388 }
1389
1390 auto ret = sm->list([&](const auto& interfaces) {
1391 for (const std::string& interface : interfaces) {
1392 std::string cleanName = interface;
1393 std::replace_if(cleanName.begin(),
1394 cleanName.end(),
1395 [](char c) {
1396 return !isalnum(c) &&
1397 std::string("@-_:.").find(c) == std::string::npos;
1398 }, '_');
Nandana Dutt979388e2018-11-30 16:48:55 +00001399 const std::string path = ds.bugreport_internal_dir_ + "/lshal_debug_" + cleanName;
Steven Moreland44cd9482018-01-04 16:24:13 -08001400
Rhed Jao4875aa62020-07-20 17:46:29 +08001401 bool empty = false;
Steven Moreland44cd9482018-01-04 16:24:13 -08001402 {
1403 auto fd = android::base::unique_fd(
1404 TEMP_FAILURE_RETRY(open(path.c_str(),
1405 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1406 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1407 if (fd < 0) {
1408 MYLOGE("Could not open %s to dump additional hal information.\n", path.c_str());
1409 continue;
1410 }
1411 RunCommandToFd(fd,
1412 "",
Steven Morelandc81cd3c2018-01-18 14:36:26 -08001413 {"lshal", "debug", "-E", interface},
Steven Moreland44cd9482018-01-04 16:24:13 -08001414 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
1415
Rhed Jao4875aa62020-07-20 17:46:29 +08001416 empty = 0 == lseek(fd, 0, SEEK_END);
Steven Moreland44cd9482018-01-04 16:24:13 -08001417 }
Rhed Jao4875aa62020-07-20 17:46:29 +08001418 if (!empty) {
1419 ds.EnqueueAddZipEntryAndCleanupIfNeeded("lshal-debug/" + cleanName + ".txt",
1420 path);
1421 } else {
1422 unlink(path.c_str());
1423 }
Steven Moreland44cd9482018-01-04 16:24:13 -08001424 }
1425 });
1426
1427 if (!ret.isOk()) {
1428 MYLOGE("Could not list hals from hwservicemanager.\n");
1429 }
1430}
1431
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001432static void DumpExternalFragmentationInfo() {
1433 struct stat st;
1434 if (stat("/proc/buddyinfo", &st) != 0) {
1435 MYLOGE("Unable to dump external fragmentation info\n");
1436 return;
1437 }
1438
1439 printf("------ EXTERNAL FRAGMENTATION INFO ------\n");
1440 std::ifstream ifs("/proc/buddyinfo");
1441 auto unusable_index_regex = std::regex{"Node\\s+([0-9]+),\\s+zone\\s+(\\S+)\\s+(.*)"};
1442 for (std::string line; std::getline(ifs, line);) {
1443 std::smatch match_results;
1444 if (std::regex_match(line, match_results, unusable_index_regex)) {
1445 std::stringstream free_pages(std::string{match_results[3]});
1446 std::vector<int> free_pages_per_order(std::istream_iterator<int>{free_pages},
1447 std::istream_iterator<int>());
1448
1449 int total_free_pages = 0;
1450 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1451 total_free_pages += (free_pages_per_order[i] * std::pow(2, i));
1452 }
1453
1454 printf("Node %s, zone %8s", match_results[1].str().c_str(),
1455 match_results[2].str().c_str());
1456
1457 int usable_free_pages = total_free_pages;
1458 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1459 auto unusable_index = (total_free_pages - usable_free_pages) /
1460 static_cast<double>(total_free_pages);
1461 printf(" %5.3f", unusable_index);
1462 usable_free_pages -= (free_pages_per_order[i] * std::pow(2, i));
1463 }
1464
1465 printf("\n");
1466 }
1467 }
1468 printf("\n");
1469}
1470
mhasankd451a472020-05-26 18:02:39 -07001471static void DumpstateLimitedOnly() {
1472 // Trimmed-down version of dumpstate to only include a whitelisted
1473 // set of logs (system log, event log, and system server / system app
1474 // crashes, and networking logs). See b/136273873 and b/138459828
1475 // for context.
1476 DurationReporter duration_reporter("DUMPSTATE");
1477 unsigned long timeout_ms;
1478 // calculate timeout
1479 timeout_ms = logcat_timeout({"main", "system", "crash"});
1480 RunCommand("SYSTEM LOG",
1481 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1482 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1483 timeout_ms = logcat_timeout({"events"});
1484 RunCommand(
1485 "EVENT LOG",
1486 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1487 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1488
1489 printf("========================================================\n");
1490 printf("== Networking Service\n");
1491 printf("========================================================\n");
1492
1493 RunDumpsys("DUMPSYS NETWORK_SERVICE_LIMITED", {"wifi", "-a"},
1494 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hugo Benichiaa162682020-10-30 23:28:56 +09001495 RunDumpsys("DUMPSYS CONNECTIVITY REQUESTS", {"connectivity", "requests"},
1496 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
mhasankd451a472020-05-26 18:02:39 -07001497
1498 printf("========================================================\n");
1499 printf("== Dropbox crashes\n");
1500 printf("========================================================\n");
1501
1502 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1503 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1504
1505 printf("========================================================\n");
1506 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1507 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1508 printf("========================================================\n");
1509 printf("== dumpstate: done (id %d)\n", ds.id_);
1510 printf("========================================================\n");
1511}
1512
Rhed Jao6b1ea2d2020-07-21 17:58:41 +08001513/*
1514 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1515 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1516 * if it's not running in the parallel task.
1517 */
1518static void DumpCheckins(int out_fd = STDOUT_FILENO) {
1519 dprintf(out_fd, "========================================================\n");
1520 dprintf(out_fd, "== Checkins\n");
1521 dprintf(out_fd, "========================================================\n");
1522
1523 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"}, out_fd);
1524 RunDumpsys("CHECKIN MEMINFO", {"meminfo", "--checkin"}, out_fd);
1525 RunDumpsys("CHECKIN NETSTATS", {"netstats", "--checkin"}, out_fd);
1526 RunDumpsys("CHECKIN PROCSTATS", {"procstats", "-c"}, out_fd);
1527 RunDumpsys("CHECKIN USAGESTATS", {"usagestats", "-c"}, out_fd);
1528 RunDumpsys("CHECKIN PACKAGE", {"package", "--checkin"}, out_fd);
1529}
1530
1531/*
1532 * Runs dumpsys on activity service to dump all application activities, services
1533 * and providers in the device.
1534 *
1535 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1536 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1537 * if it's not running in the parallel task.
1538 */
1539static void DumpAppInfos(int out_fd = STDOUT_FILENO) {
1540 dprintf(out_fd, "========================================================\n");
1541 dprintf(out_fd, "== Running Application Activities\n");
1542 dprintf(out_fd, "========================================================\n");
1543
1544 // The following dumpsys internally collects output from running apps, so it can take a long
1545 // time. So let's extend the timeout.
1546
1547 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
1548
1549 RunDumpsys("APP ACTIVITIES", {"activity", "-v", "all"}, DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1550
1551 dprintf(out_fd, "========================================================\n");
1552 dprintf(out_fd, "== Running Application Services (platform)\n");
1553 dprintf(out_fd, "========================================================\n");
1554
1555 RunDumpsys("APP SERVICES PLATFORM", {"activity", "service", "all-platform-non-critical"},
1556 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1557
1558 dprintf(out_fd, "========================================================\n");
1559 dprintf(out_fd, "== Running Application Services (non-platform)\n");
1560 dprintf(out_fd, "========================================================\n");
1561
1562 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1563 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1564
1565 dprintf(out_fd, "========================================================\n");
1566 dprintf(out_fd, "== Running Application Providers (platform)\n");
1567 dprintf(out_fd, "========================================================\n");
1568
1569 RunDumpsys("APP PROVIDERS PLATFORM", {"activity", "provider", "all-platform"},
Rhed Jaob049f182021-01-11 21:08:43 +08001570 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
Rhed Jao6b1ea2d2020-07-21 17:58:41 +08001571
1572 dprintf(out_fd, "========================================================\n");
1573 dprintf(out_fd, "== Running Application Providers (non-platform)\n");
1574 dprintf(out_fd, "========================================================\n");
1575
1576 RunDumpsys("APP PROVIDERS NON-PLATFORM", {"activity", "provider", "all-non-platform"},
1577 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1578}
1579
Nandana Dutt5c390032019-03-12 10:52:56 +00001580// Dumps various things. Returns early with status USER_CONSENT_DENIED if user denies consent
1581// via the consent they are shown. Ignores other errors that occur while running various
1582// commands. The consent checking is currently done around long running tasks, which happen to
1583// be distributed fairly evenly throughout the function.
1584static Dumpstate::RunStatus dumpstate() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001585 DurationReporter duration_reporter("DUMPSTATE");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001586
Rhed Jao4875aa62020-07-20 17:46:29 +08001587 // Enqueue slow functions into the thread pool, if the parallel run is enabled.
1588 if (ds.dump_pool_) {
1589 // Pool was shutdown in DumpstateDefaultAfterCritical method in order to
1590 // drop root user. Restarts it with two threads for the parallel run.
1591 ds.dump_pool_->start(/* thread_counts = */2);
1592
1593 ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
1594 ds.dump_pool_->enqueueTask(DUMP_INCIDENT_REPORT_TASK, &DumpIncidentReport);
1595 ds.dump_pool_->enqueueTaskWithFd(DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
Rhed Jao6b1ea2d2020-07-21 17:58:41 +08001596 ds.dump_pool_->enqueueTaskWithFd(DUMP_CHECKINS_TASK, &DumpCheckins, _1);
Rhed Jao4875aa62020-07-20 17:46:29 +08001597 }
1598
Nandana Dutt5c390032019-03-12 10:52:56 +00001599 // Dump various things. Note that anything that takes "long" (i.e. several seconds) should
1600 // check intermittently (if it's intrerruptable like a foreach on pids) and/or should be wrapped
1601 // in a consent check (via RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK).
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -07001602 dump_dev_files("TRUSTY VERSION", "/sys/bus/platform/drivers/trusty", "trusty_version");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001603 RunCommand("UPTIME", {"uptime"});
Wei Wang509bb5d2017-06-09 14:42:12 -07001604 DumpBlockStatFiles();
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001605 DumpFile("MEMORY INFO", "/proc/meminfo");
1606 RunCommand("CPU INFO", {"top", "-b", "-n", "1", "-H", "-s", "6", "-o",
Felipe Leme30dbfa12016-09-02 12:43:26 -07001607 "pid,tid,user,pr,ni,%cpu,s,virt,res,pcy,cmd,name"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001608
1609 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "PROCRANK", {"procrank"}, AS_ROOT_20);
1610
Sunny Goyal35949782019-11-19 15:54:36 -08001611 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpVisibleWindowViews);
1612
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001613 DumpFile("VIRTUAL MEMORY STATS", "/proc/vmstat");
1614 DumpFile("VMALLOC INFO", "/proc/vmallocinfo");
1615 DumpFile("SLAB INFO", "/proc/slabinfo");
1616 DumpFile("ZONEINFO", "/proc/zoneinfo");
1617 DumpFile("PAGETYPEINFO", "/proc/pagetypeinfo");
1618 DumpFile("BUDDYINFO", "/proc/buddyinfo");
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001619 DumpExternalFragmentationInfo();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001620
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001621 DumpFile("KERNEL WAKE SOURCES", "/d/wakeup_sources");
1622 DumpFile("KERNEL CPUFREQ", "/sys/devices/system/cpu/cpu0/cpufreq/stats/time_in_state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001623
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001624 RunCommand("PROCESSES AND THREADS",
Yohei Yukawa591a72d2017-10-05 21:36:35 -07001625 {"ps", "-A", "-T", "-Z", "-O", "pri,nice,rtprio,sched,pcy,time"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001626
1627 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "LIBRANK", {"librank"},
1628 CommandOptions::AS_ROOT);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001629
Rhed Jao4875aa62020-07-20 17:46:29 +08001630 if (ds.dump_pool_) {
1631 WAIT_TASK_WITH_CONSENT_CHECK(DUMP_HALS_TASK, ds.dump_pool_);
1632 } else {
1633 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_HALS_TASK, DumpHals);
1634 }
Steven Moreland81b429e2017-01-31 19:50:46 -08001635
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001636 RunCommand("PRINTENV", {"printenv"});
Elliott Hughes21b7c8d2016-10-28 08:53:02 -07001637 RunCommand("NETSTAT", {"netstat", "-nW"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001638 struct stat s;
1639 if (stat("/proc/modules", &s) != 0) {
1640 MYLOGD("Skipping 'lsmod' because /proc/modules does not exist\n");
1641 } else {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001642 RunCommand("LSMOD", {"lsmod"});
Woody Linc198f252021-05-04 16:37:11 +08001643 RunCommand("MODULES INFO",
1644 {"sh", "-c", "cat /proc/modules | cut -d' ' -f1 | "
1645 " while read MOD ; do echo modinfo:$MOD ; modinfo $MOD ; "
1646 "done"}, CommandOptions::AS_ROOT);
Felipe Lemee4eca582016-06-10 17:48:08 -07001647 }
Michal Karpinski4db754f2015-12-11 18:04:32 +00001648
Tom Cherryb87dbfa2020-07-28 11:28:53 -07001649 if (android::base::GetBoolProperty("ro.logd.kernel", false)) {
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001650 DoKernelLogcat();
1651 } else {
1652 do_dmesg();
1653 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001654
Felipe Lemef0292972016-11-22 13:57:05 -08001655 RunCommand("LIST OF OPEN FILES", {"lsof"}, CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001656
1657 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(for_each_pid, do_showmap, "SMAPS OF ALL PROCESSES");
1658
Jeff Brown1dc94e32014-09-11 14:15:27 -07001659 for_each_tid(show_wchan, "BLOCKED PROCESS WAIT-CHANNELS");
Mark Salyzyna297c322016-02-05 15:33:17 -08001660 for_each_pid(show_showtime, "PROCESS TIMES (pid cmd user system iowait+percentage)");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001661
Jack Yu5a6b2e22020-08-14 18:13:35 +08001662 /* Dump Nfc NCI logs */
1663 ds.AddDir("/data/misc/nfc/logs", true);
Ajay Panickerd886ec42016-09-14 12:26:46 -07001664
Paul Chang0d2aad72020-02-13 20:04:03 +08001665 if (ds.options_->do_screenshot && !ds.do_early_screenshot_) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001666 MYLOGI("taking late screenshot\n");
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001667 ds.TakeScreenshot();
Jeff Sharkey5a930032013-03-19 15:05:19 -07001668 }
1669
Felipe Lemee184f662016-10-27 10:04:47 -07001670 AddAnrTraceFiles();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001671
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001672 MaybeAddSystemTraceToZip();
1673
Narayan Kamath8f788292017-05-25 13:20:39 +01001674 // NOTE: tombstones are always added as separate entries in the zip archive
1675 // and are not interspersed with the main report.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001676 const bool tombstones_dumped = AddDumps(ds.tombstone_data_.begin(), ds.tombstone_data_.end(),
Narayan Kamathbd863722017-06-01 18:50:12 +01001677 "TOMBSTONE", true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001678 if (!tombstones_dumped) {
1679 printf("*** NO TOMBSTONES to dump in %s\n\n", TOMBSTONE_DIR.c_str());
Christopher Ferris7dc7f322014-07-22 16:08:19 -07001680 }
1681
Jayachandran Ca94c7172017-06-10 15:08:12 -07001682 DumpPacketStats();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001683
Chenbo Feng276a3b62018-08-07 11:44:49 -07001684 RunDumpsys("EBPF MAP STATS", {"netd", "trafficcontroller"});
1685
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001686 DoKmsg();
Mark Salyzyn2262c162014-12-16 09:09:26 -08001687
Jayachandran Ca94c7172017-06-10 15:08:12 -07001688 DumpIpAddrAndRules();
Sreeram Ramachandran2b3bba32014-07-08 15:40:55 -07001689
1690 dump_route_tables();
1691
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001692 RunCommand("ARP CACHE", {"ip", "-4", "neigh", "show"});
1693 RunCommand("IPv6 ND CACHE", {"ip", "-6", "neigh", "show"});
1694 RunCommand("MULTICAST ADDRESSES", {"ip", "maddr"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001695
Nandana Dutt5c390032019-03-12 10:52:56 +00001696 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysHigh);
Lorenzo Colitti6afc38c2015-09-09 22:59:25 +09001697
Elliott Hughes23ccc622017-02-28 10:14:22 -08001698 RunCommand("SYSTEM PROPERTIES", {"getprop"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001699
Jin Qianf334d662017-10-10 14:41:37 -07001700 RunCommand("STORAGED IO INFO", {"storaged", "-u", "-p"});
ynwangf649a6e2016-07-17 21:56:00 -07001701
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001702 RunCommand("FILESYSTEMS & FREE SPACE", {"df"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001703
Colin Crossf45fa6b2012-03-26 12:38:26 -07001704 /* Binder state is expensive to look at as it uses a lot of memory. */
Hridya Valsaraju920ba712020-02-09 16:27:01 -08001705 std::string binder_logs_dir = access("/dev/binderfs/binder_logs", R_OK) ?
1706 "/sys/kernel/debug/binder" : "/dev/binderfs/binder_logs";
1707
1708 DumpFile("BINDER FAILED TRANSACTION LOG", binder_logs_dir + "/failed_transaction_log");
1709 DumpFile("BINDER TRANSACTION LOG", binder_logs_dir + "/transaction_log");
1710 DumpFile("BINDER TRANSACTIONS", binder_logs_dir + "/transactions");
1711 DumpFile("BINDER STATS", binder_logs_dir + "/stats");
1712 DumpFile("BINDER STATE", binder_logs_dir + "/state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001713
Vishnu Nair36b4cdb2017-11-17 10:27:05 -08001714 /* Add window and surface trace files. */
1715 if (!PropertiesHelper::IsUserBuild()) {
1716 ds.AddDir(WMTRACE_DATA_DIR, false);
1717 }
1718
Yifan Hongcba0a4f2020-02-08 16:52:02 -08001719 ds.AddDir(SNAPSHOTCTL_LOG_DIR, false);
1720
Rhed Jao4875aa62020-07-20 17:46:29 +08001721 if (ds.dump_pool_) {
1722 WAIT_TASK_WITH_CONSENT_CHECK(DUMP_BOARD_TASK, ds.dump_pool_);
1723 } else {
1724 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
1725 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001726
Steven Moreland7440ddb2016-12-15 16:13:39 -08001727 /* Migrate the ril_dumpstate to a device specific dumpstate? */
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001728 int rilDumpstateTimeout = android::base::GetIntProperty("ril.dumpstate.timeout", 0);
1729 if (rilDumpstateTimeout > 0) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001730 // su does not exist on user builds, so try running without it.
1731 // This way any implementations of vril-dump that do not require
1732 // root can run on user builds.
1733 CommandOptions::CommandOptionsBuilder options =
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001734 CommandOptions::WithTimeout(rilDumpstateTimeout);
Felipe Lemef0292972016-11-22 13:57:05 -08001735 if (!PropertiesHelper::IsUserBuild()) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001736 options.AsRoot();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001737 }
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001738 RunCommand("DUMP VENDOR RIL LOGS", {"vril-dump"}, options.Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -07001739 }
1740
Felipe Lemed8b94e52016-12-08 10:21:44 -08001741 printf("========================================================\n");
1742 printf("== Android Framework Services\n");
1743 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001744
Nandana Dutt5c390032019-03-12 10:52:56 +00001745 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysNormal);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001746
Jack He91ff2fe2021-02-18 18:23:43 -08001747 /* Dump Bluetooth HCI logs after getting bluetooth_manager dumpsys */
1748 ds.AddDir("/data/misc/bluetooth/logs", true);
1749
Rhed Jao6b1ea2d2020-07-21 17:58:41 +08001750 if (ds.dump_pool_) {
1751 WAIT_TASK_WITH_CONSENT_CHECK(DUMP_CHECKINS_TASK, ds.dump_pool_);
1752 } else {
1753 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_CHECKINS_TASK, DumpCheckins);
1754 }
Dianne Hackborn02bea972013-06-26 18:59:09 -07001755
Rhed Jaoc5f7ec32020-12-22 22:11:08 +08001756 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpAppInfos);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001757
Adrian Roos8b397ab2017-04-04 16:35:44 -07001758 printf("========================================================\n");
1759 printf("== Dropbox crashes\n");
1760 printf("========================================================\n");
1761
1762 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1763 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1764
Felipe Lemed8b94e52016-12-08 10:21:44 -08001765 printf("========================================================\n");
1766 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1767 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1768 printf("========================================================\n");
1769 printf("== dumpstate: done (id %d)\n", ds.id_);
1770 printf("========================================================\n");
Bookatz38472142018-09-28 10:20:24 -07001771
1772 printf("========================================================\n");
1773 printf("== Obtaining statsd metadata\n");
1774 printf("========================================================\n");
1775 // This differs from the usual dumpsys stats, which is the stats report data.
1776 RunDumpsys("STATSDSTATS", {"stats", "--metadata"});
Mike Ma5c267872019-08-21 11:31:34 -07001777
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +09001778 // Add linker configuration directory
1779 ds.AddDir(LINKERCONFIG_DIR, true);
1780
Rhed Jao4875aa62020-07-20 17:46:29 +08001781 if (ds.dump_pool_) {
1782 WAIT_TASK_WITH_CONSENT_CHECK(DUMP_INCIDENT_REPORT_TASK, ds.dump_pool_);
1783 } else {
1784 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_INCIDENT_REPORT_TASK,
1785 DumpIncidentReport);
1786 }
Mike Ma5c267872019-08-21 11:31:34 -07001787
Nandana Dutt5c390032019-03-12 10:52:56 +00001788 return Dumpstate::RunStatus::OK;
Colin Crossf45fa6b2012-03-26 12:38:26 -07001789}
1790
Nandana Dutt5c390032019-03-12 10:52:56 +00001791/*
1792 * Dumps state for the default case; drops root after it's no longer necessary.
1793 *
1794 * Returns RunStatus::OK if everything went fine.
1795 * Returns RunStatus::ERROR if there was an error.
1796 * Returns RunStatus::USER_DENIED_CONSENT if user explicitly denied consent to sharing the bugreport
1797 * with the caller.
1798 */
Jichao Lie89d9c12019-11-21 19:02:51 -08001799Dumpstate::RunStatus Dumpstate::DumpstateDefaultAfterCritical() {
Nandana Duttdb379fa2019-10-09 16:54:41 +01001800 // Capture first logcat early on; useful to take a snapshot before dumpstate logs take over the
1801 // buffer.
1802 DoLogcat();
1803 // Capture timestamp after first logcat to use in next logcat
1804 time_t logcat_ts = time(nullptr);
1805
Nandana Dutt4be45d12018-09-26 15:04:23 +01001806 /* collect stack traces from Dalvik and native processes (needs root) */
Rhed Jao1c855122020-07-16 17:37:39 +08001807 if (dump_pool_) {
1808 RETURN_IF_USER_DENIED_CONSENT();
1809 // One thread is enough since we only need to enqueue DumpTraces here.
1810 dump_pool_->start(/* thread_counts = */1);
1811
1812 // DumpTraces takes long time, post it to the another thread in the
1813 // pool, if pool is available
1814 dump_pool_->enqueueTask(DUMP_TRACES_TASK, &Dumpstate::DumpTraces, &ds, &dump_traces_path);
1815 } else {
1816 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_TRACES_TASK, ds.DumpTraces,
1817 &dump_traces_path);
1818 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001819
1820 /* Run some operations that require root. */
1821 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX, !ds.IsZipping());
1822 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX, !ds.IsZipping());
1823
1824 ds.AddDir(RECOVERY_DIR, true);
1825 ds.AddDir(RECOVERY_DATA_DIR, true);
1826 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
1827 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1828 if (!PropertiesHelper::IsUserBuild()) {
1829 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1830 ds.AddDir(PROFILE_DATA_DIR_REF, true);
Calin Juravle78a0d842020-04-28 15:31:12 -07001831 ds.AddZipEntry(ZIP_ROOT_DIR + PACKAGE_DEX_USE_LIST, PACKAGE_DEX_USE_LIST);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001832 }
Jerry Changa1df8a92020-01-02 16:03:39 +08001833 ds.AddDir(PREREBOOT_DATA_DIR, false);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001834 add_mountinfo();
1835 DumpIpTablesAsRoot();
David Andersond9ba4752018-12-11 18:26:59 -08001836 DumpDynamicPartitionInfo();
Yifan Hong3945e1b2019-10-29 12:59:23 -07001837 ds.AddDir(OTA_METADATA_DIR, true);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001838
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001839 // Capture any IPSec policies in play. No keys are exposed here.
Nandana Dutt4be45d12018-09-26 15:04:23 +01001840 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1841
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001842 // Dump IPsec stats. No keys are exposed here.
1843 DumpFile("XFRM STATS", XFRM_STAT_PROC_FILE);
1844
Nandana Dutt4be45d12018-09-26 15:04:23 +01001845 // Run ss as root so we can see socket marks.
1846 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
1847
1848 // Run iotop as root to show top 100 IO threads
1849 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
1850
Erick Reyese68df822019-02-11 14:46:36 -08001851 // Gather shared memory buffer info if the product implements it
Hridya Valsaraju1da80c52021-01-09 22:10:11 -08001852 RunCommand("Dmabuf dump", {"dmabuf_dump"});
1853 RunCommand("Dmabuf per-buffer/per-exporter/per-device stats", {"dmabuf_dump", "-b"});
Erick Reyese68df822019-02-11 14:46:36 -08001854
Minchan Kim22c6a1e2019-09-30 15:58:10 -07001855 DumpFile("PSI cpu", "/proc/pressure/cpu");
1856 DumpFile("PSI memory", "/proc/pressure/memory");
1857 DumpFile("PSI io", "/proc/pressure/io");
1858
Rhed Jao1c855122020-07-16 17:37:39 +08001859 if (dump_pool_) {
1860 RETURN_IF_USER_DENIED_CONSENT();
1861 dump_pool_->waitForTask(DUMP_TRACES_TASK);
1862
1863 // Current running thread in the pool is the root user also. Shutdown
1864 // the pool and restart later to ensure all threads in the pool could
1865 // drop the root user.
1866 dump_pool_->shutdown();
1867 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001868 if (!DropRootUser()) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001869 return Dumpstate::RunStatus::ERROR;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001870 }
1871
Nandana Dutt5c390032019-03-12 10:52:56 +00001872 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttdb379fa2019-10-09 16:54:41 +01001873 Dumpstate::RunStatus status = dumpstate();
1874 // Capture logcat since the last time we did it.
1875 DoSystemLogcat(logcat_ts);
1876 return status;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001877}
1878
Rhed Jaoa5de5752020-08-14 17:19:17 +08001879// Common states for telephony and wifi which are needed to be collected before
1880// dumpstate drop the root user.
1881static void DumpstateRadioAsRoot() {
1882 DumpIpTablesAsRoot();
1883 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1884}
1885
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001886// This method collects common dumpsys for telephony and wifi. Typically, wifi
1887// reports are fine to include all information, but telephony reports on user
1888// builds need to strip some content (see DumpstateTelephonyOnly).
1889static void DumpstateRadioCommon(bool include_sensitive_info = true) {
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001890 // We need to be picky about some stuff for telephony reports on user builds.
1891 if (!include_sensitive_info) {
1892 // Only dump the radio log buffer (other buffers and dumps contain too much unrelated info).
1893 DoRadioLogcat();
1894 } else {
Rhed Jaoa5de5752020-08-14 17:19:17 +08001895 // DumpHals takes long time, post it to the another thread in the pool,
1896 // if pool is available.
1897 if (ds.dump_pool_) {
1898 ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
1899 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001900 // Contains various system properties and process startup info.
1901 do_dmesg();
1902 // Logs other than the radio buffer may contain package/component names and potential PII.
1903 DoLogcat();
1904 // Too broad for connectivity problems.
1905 DoKmsg();
Rhed Jaoa5de5752020-08-14 17:19:17 +08001906 // DumpHals contains unrelated hardware info (camera, NFC, biometrics, ...).
1907 if (ds.dump_pool_) {
1908 ds.dump_pool_->waitForTask(DUMP_HALS_TASK);
1909 } else {
1910 RUN_SLOW_FUNCTION_AND_LOG(DUMP_HALS_TASK, DumpHals);
1911 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001912 }
1913
Jayachandran Ca94c7172017-06-10 15:08:12 -07001914 DumpPacketStats();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001915 DumpIpAddrAndRules();
1916 dump_route_tables();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001917 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
1918 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08001919}
1920
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001921// We use "telephony" here for legacy reasons, though this now really means "connectivity" (cellular
1922// + wifi + networking). This method collects dumpsys for connectivity debugging only. General rules
1923// for what can be included on user builds: all reported information MUST directly relate to
1924// connectivity debugging or customer support and MUST NOT contain unrelated personally identifiable
1925// information. This information MUST NOT identify user-installed packages (UIDs are OK, package
1926// names are not), and MUST NOT contain logs of user application traffic.
1927// TODO(b/148168577) rename this and other related fields/methods to "connectivity" instead.
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08001928static void DumpstateTelephonyOnly(const std::string& calling_package) {
mukesh agrawal253dad42018-01-23 21:59:59 -08001929 DurationReporter duration_reporter("DUMPSTATE");
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001930
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001931 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08001932
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001933 const bool include_sensitive_info = !PropertiesHelper::IsUserBuild();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001934
Rhed Jaoa5de5752020-08-14 17:19:17 +08001935 DumpstateRadioAsRoot();
1936 if (!DropRootUser()) {
1937 return;
1938 }
1939
1940 // Starts thread pool after the root user is dropped, and two additional threads
1941 // are created for DumpHals in the DumpstateRadioCommon and DumpstateBoard.
1942 if (ds.dump_pool_) {
1943 ds.dump_pool_->start(/*thread_counts =*/2);
1944
1945 // DumpstateBoard takes long time, post it to the another thread in the pool,
1946 // if pool is available.
1947 ds.dump_pool_->enqueueTaskWithFd(DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
1948 }
1949
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001950 DumpstateRadioCommon(include_sensitive_info);
1951
1952 if (include_sensitive_info) {
1953 // Contains too much unrelated PII, and given the unstructured nature of sysprops, we can't
1954 // really cherrypick all of the connectivity-related ones. Apps generally have no business
1955 // reading these anyway, and there should be APIs to supply the info in a more app-friendly
1956 // way.
1957 RunCommand("SYSTEM PROPERTIES", {"getprop"});
1958 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07001959
1960 printf("========================================================\n");
1961 printf("== Android Framework Services\n");
1962 printf("========================================================\n");
1963
Vishnu Nair652cc802017-11-30 15:18:30 -08001964 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1965 SEC_TO_MSEC(10));
Hunter Knepshield31cbae12021-05-11 16:23:24 -07001966 RunDumpsys("DUMPSYS", {"vcn_management"}, CommandOptions::WithTimeout(90).Build(),
1967 SEC_TO_MSEC(10));
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08001968 if (include_sensitive_info) {
1969 // Carrier apps' services will be dumped below in dumpsys activity service all-non-platform.
1970 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
1971 SEC_TO_MSEC(10));
1972 } else {
1973 // If the caller is a carrier app and has a carrier service, dump it here since we aren't
1974 // running dumpsys activity service all-non-platform below. Due to the increased output, we
1975 // give a higher timeout as well.
1976 RunDumpsys("DUMPSYS", {"carrier_config", "--requesting-package", calling_package},
1977 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(30));
1978 }
1979 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001980 RunDumpsys("DUMPSYS", {"netpolicy"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
1981 RunDumpsys("DUMPSYS", {"network_management"}, CommandOptions::WithTimeout(90).Build(),
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07001982 SEC_TO_MSEC(10));
Hunter Knepshield0fe51b12020-03-05 16:58:20 -08001983 RunDumpsys("DUMPSYS", {"telephony.registry"}, CommandOptions::WithTimeout(90).Build(),
1984 SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001985 if (include_sensitive_info) {
1986 // Contains raw IP addresses, omit from reports on user builds.
1987 RunDumpsys("DUMPSYS", {"netd"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
1988 // Contains raw destination IP/MAC addresses, omit from reports on user builds.
1989 RunDumpsys("DUMPSYS", {"connmetrics"}, CommandOptions::WithTimeout(90).Build(),
1990 SEC_TO_MSEC(10));
1991 // Contains package/component names, omit from reports on user builds.
1992 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
1993 SEC_TO_MSEC(10));
1994 // Contains package names, but should be relatively simple to remove them (also contains
1995 // UIDs already), omit from reports on user builds.
1996 RunDumpsys("BATTERYSTATS", {"deviceidle"}, CommandOptions::WithTimeout(90).Build(),
1997 SEC_TO_MSEC(10));
1998 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07001999
2000 printf("========================================================\n");
2001 printf("== Running Application Services\n");
2002 printf("========================================================\n");
2003
2004 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
2005
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002006 if (include_sensitive_info) {
2007 printf("========================================================\n");
2008 printf("== Running Application Services (non-platform)\n");
2009 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002010
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002011 // Contains package/component names and potential PII, omit from reports on user builds.
2012 // To get dumps of the active CarrierService(s) on user builds, we supply an argument to the
2013 // carrier_config dumpsys instead.
2014 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
2015 DUMPSYS_COMPONENTS_OPTIONS);
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002016
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002017 printf("========================================================\n");
2018 printf("== Checkins\n");
2019 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002020
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002021 // Contains package/component names, omit from reports on user builds.
2022 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
2023 }
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002024
2025 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07002026 printf("== dumpstate: done (id %d)\n", ds.id_);
2027 printf("========================================================\n");
Rhed Jaoa5de5752020-08-14 17:19:17 +08002028
2029 if (ds.dump_pool_) {
2030 ds.dump_pool_->waitForTask(DUMP_BOARD_TASK);
2031 } else {
2032 RUN_SLOW_FUNCTION_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
2033 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002034}
2035
mukesh agrawal253dad42018-01-23 21:59:59 -08002036// This method collects dumpsys for wifi debugging only
2037static void DumpstateWifiOnly() {
2038 DurationReporter duration_reporter("DUMPSTATE");
2039
Rhed Jaoa5de5752020-08-14 17:19:17 +08002040 DumpstateRadioAsRoot();
2041 if (!DropRootUser()) {
2042 return;
2043 }
2044
2045 // Starts thread pool after the root user is dropped. Only one additional
2046 // thread is needed for DumpHals in the DumpstateRadioCommon.
2047 if (ds.dump_pool_) {
2048 ds.dump_pool_->start(/*thread_counts =*/1);
2049 }
2050
mukesh agrawal253dad42018-01-23 21:59:59 -08002051 DumpstateRadioCommon();
2052
2053 printf("========================================================\n");
2054 printf("== Android Framework Services\n");
2055 printf("========================================================\n");
2056
2057 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
2058 SEC_TO_MSEC(10));
2059 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
2060 SEC_TO_MSEC(10));
2061
2062 printf("========================================================\n");
2063 printf("== dumpstate: done (id %d)\n", ds.id_);
2064 printf("========================================================\n");
2065}
2066
Nandana Duttcf419a72019-03-14 10:40:17 +00002067Dumpstate::RunStatus Dumpstate::DumpTraces(const char** path) {
Gavin Corkery789d7a52021-02-24 23:52:35 +00002068 const std::string temp_file_pattern = ds.bugreport_internal_dir_ + "/dumptrace_XXXXXX";
Nandana Duttfaafd522019-03-11 09:23:09 +00002069 const size_t buf_size = temp_file_pattern.length() + 1;
2070 std::unique_ptr<char[]> file_name_buf(new char[buf_size]);
2071 memcpy(file_name_buf.get(), temp_file_pattern.c_str(), buf_size);
2072
2073 // Create a new, empty file to receive all trace dumps.
2074 //
2075 // TODO: This can be simplified once we remove support for the old style
2076 // dumps. We can have a file descriptor passed in to dump_traces instead
2077 // of creating a file, closing it and then reopening it again.
2078 android::base::unique_fd fd(mkostemp(file_name_buf.get(), O_APPEND | O_CLOEXEC));
2079 if (fd < 0) {
2080 MYLOGE("mkostemp on pattern %s: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002081 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002082 }
2083
2084 // Nobody should have access to this temporary file except dumpstate, but we
2085 // temporarily grant 'read' to 'others' here because this file is created
2086 // when tombstoned is still running as root, but dumped after dropping. This
2087 // can go away once support for old style dumping has.
2088 const int chmod_ret = fchmod(fd, 0666);
2089 if (chmod_ret < 0) {
2090 MYLOGE("fchmod on %s failed: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002091 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002092 }
2093
2094 std::unique_ptr<DIR, decltype(&closedir)> proc(opendir("/proc"), closedir);
2095 if (proc.get() == nullptr) {
2096 MYLOGE("opendir /proc failed: %s\n", strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002097 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002098 }
2099
2100 // Number of times process dumping has timed out. If we encounter too many
2101 // failures, we'll give up.
2102 int timeout_failures = 0;
2103 bool dalvik_found = false;
2104
2105 const std::set<int> hal_pids = get_interesting_hal_pids();
2106
2107 struct dirent* d;
2108 while ((d = readdir(proc.get()))) {
Nandana Duttcf419a72019-03-14 10:40:17 +00002109 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttfaafd522019-03-11 09:23:09 +00002110 int pid = atoi(d->d_name);
2111 if (pid <= 0) {
2112 continue;
2113 }
2114
2115 const std::string link_name = android::base::StringPrintf("/proc/%d/exe", pid);
2116 std::string exe;
2117 if (!android::base::Readlink(link_name, &exe)) {
2118 continue;
2119 }
2120
2121 bool is_java_process;
2122 if (exe == "/system/bin/app_process32" || exe == "/system/bin/app_process64") {
2123 // Don't bother dumping backtraces for the zygote.
2124 if (IsZygote(pid)) {
2125 continue;
2126 }
2127
2128 dalvik_found = true;
2129 is_java_process = true;
2130 } else if (should_dump_native_traces(exe.c_str()) || hal_pids.find(pid) != hal_pids.end()) {
2131 is_java_process = false;
2132 } else {
2133 // Probably a native process we don't care about, continue.
2134 continue;
2135 }
2136
2137 // If 3 backtrace dumps fail in a row, consider debuggerd dead.
2138 if (timeout_failures == 3) {
2139 dprintf(fd, "ERROR: Too many stack dump failures, exiting.\n");
2140 break;
2141 }
2142
2143 const uint64_t start = Nanotime();
2144 const int ret = dump_backtrace_to_file_timeout(
2145 pid, is_java_process ? kDebuggerdJavaBacktrace : kDebuggerdNativeBacktrace,
2146 is_java_process ? 5 : 20, fd);
2147
2148 if (ret == -1) {
2149 // For consistency, the header and footer to this message match those
2150 // dumped by debuggerd in the success case.
2151 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
2152 dprintf(fd, "Dump failed, likely due to a timeout.\n");
2153 dprintf(fd, "---- end %d ----", pid);
2154 timeout_failures++;
2155 continue;
2156 }
2157
2158 // We've successfully dumped stack traces, reset the failure count
2159 // and write a summary of the elapsed time to the file and continue with the
2160 // next process.
2161 timeout_failures = 0;
2162
2163 dprintf(fd, "[dump %s stack %d: %.3fs elapsed]\n", is_java_process ? "dalvik" : "native",
2164 pid, (float)(Nanotime() - start) / NANOS_PER_SEC);
2165 }
2166
2167 if (!dalvik_found) {
2168 MYLOGE("Warning: no Dalvik processes found to dump stacks\n");
2169 }
2170
Nandana Duttcf419a72019-03-14 10:40:17 +00002171 *path = file_name_buf.release();
2172 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002173}
2174
Rhed Jao4875aa62020-07-20 17:46:29 +08002175void Dumpstate::DumpstateBoard(int out_fd) {
2176 dprintf(out_fd, "========================================================\n");
2177 dprintf(out_fd, "== Board\n");
2178 dprintf(out_fd, "========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08002179
Felipe Leme6f674ae2016-11-18 17:10:33 -08002180 if (!IsZipping()) {
Steven Moreland7440ddb2016-12-15 16:13:39 -08002181 MYLOGD("Not dumping board info because it's not a zipped bugreport\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08002182 return;
2183 }
2184
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002185 /*
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002186 * mount debugfs for non-user builds with ro.product.debugfs_restrictions.enabled
Hridya Valsaraju51101602021-04-02 14:32:46 -07002187 * set to true and unmount it after invoking dumpstateBoard_* methods.
2188 * This is to enable debug builds to not have debugfs mounted during runtime.
2189 * It will also ensure that debugfs is only accessed by the dumpstate HAL.
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002190 */
Hridya Valsaraju51101602021-04-02 14:32:46 -07002191 auto mount_debugfs =
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002192 android::base::GetBoolProperty("ro.product.debugfs_restrictions.enabled", false);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002193 if (mount_debugfs) {
2194 RunCommand("mount debugfs", {"mount", "-t", "debugfs", "debugfs", "/sys/kernel/debug"},
2195 AS_ROOT_20);
2196 RunCommand("chmod debugfs", {"chmod", "0755", "/sys/kernel/debug"},
2197 AS_ROOT_20);
2198 }
2199
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002200 std::vector<std::string> paths;
2201 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07002202 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002203 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
2204 kDumpstateBoardFiles[i].c_str()));
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002205 remover.emplace_back(android::base::make_scope_guard(
2206 std::bind([](std::string path) { android::os::UnlinkAndLogOnError(path); }, paths[i])));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002207 }
Jie Song9fbfad02017-06-20 16:29:42 -07002208
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002209 sp<IDumpstateDevice_1_0> dumpstate_device_1_0(IDumpstateDevice_1_0::getService());
2210 if (dumpstate_device_1_0 == nullptr) {
Wei Wang587eac92018-04-05 12:17:20 -07002211 MYLOGE("No IDumpstateDevice implementation\n");
2212 return;
2213 }
2214
2215 using ScopedNativeHandle =
2216 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
2217 ScopedNativeHandle handle(native_handle_create(static_cast<int>(paths.size()), 0),
2218 [](native_handle_t* handle) {
2219 native_handle_close(handle);
2220 native_handle_delete(handle);
2221 });
2222 if (handle == nullptr) {
2223 MYLOGE("Could not create native_handle\n");
2224 return;
2225 }
2226
Nandana Dutt5c390032019-03-12 10:52:56 +00002227 // TODO(128270426): Check for consent in between?
Wei Wang587eac92018-04-05 12:17:20 -07002228 for (size_t i = 0; i < paths.size(); i++) {
2229 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
2230
2231 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
2232 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
2233 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
2234 if (fd < 0) {
2235 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
2236 return;
2237 }
2238 handle.get()->data[i] = fd.release();
2239 }
2240
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002241 // Given that bugreport is required to diagnose failures, it's better to set an arbitrary amount
2242 // of timeout for IDumpstateDevice than to block the rest of bugreport. In the timeout case, we
2243 // will kill the HAL and grab whatever it dumped in time.
2244 constexpr size_t timeout_sec = 30;
2245 // Prefer version 1.1 if available. New devices launching with R are no longer allowed to
2246 // implement just 1.0.
2247 const char* descriptor_to_kill;
2248 using DumpstateBoardTask = std::packaged_task<bool()>;
2249 DumpstateBoardTask dumpstate_board_task;
2250 sp<IDumpstateDevice_1_1> dumpstate_device_1_1(
2251 IDumpstateDevice_1_1::castFrom(dumpstate_device_1_0));
2252 if (dumpstate_device_1_1 != nullptr) {
2253 MYLOGI("Using IDumpstateDevice v1.1");
2254 descriptor_to_kill = IDumpstateDevice_1_1::descriptor;
2255 dumpstate_board_task = DumpstateBoardTask([this, dumpstate_device_1_1, &handle]() -> bool {
2256 ::android::hardware::Return<DumpstateStatus> status =
2257 dumpstate_device_1_1->dumpstateBoard_1_1(handle.get(), options_->dumpstate_hal_mode,
2258 SEC_TO_MSEC(timeout_sec));
2259 if (!status.isOk()) {
2260 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2261 return false;
2262 } else if (status != DumpstateStatus::OK) {
2263 MYLOGE("dumpstateBoard failed with DumpstateStatus::%s\n", toString(status).c_str());
2264 return false;
2265 }
2266 return true;
2267 });
2268 } else {
2269 MYLOGI("Using IDumpstateDevice v1.0");
2270 descriptor_to_kill = IDumpstateDevice_1_0::descriptor;
2271 dumpstate_board_task = DumpstateBoardTask([dumpstate_device_1_0, &handle]() -> bool {
2272 ::android::hardware::Return<void> status =
2273 dumpstate_device_1_0->dumpstateBoard(handle.get());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002274 if (!status.isOk()) {
2275 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
Wei Wang587eac92018-04-05 12:17:20 -07002276 return false;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002277 }
Wei Wang587eac92018-04-05 12:17:20 -07002278 return true;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002279 });
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002280 }
2281 auto result = dumpstate_board_task.get_future();
2282 std::thread(std::move(dumpstate_board_task)).detach();
Wei Wang587eac92018-04-05 12:17:20 -07002283
Wei Wang587eac92018-04-05 12:17:20 -07002284 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2285 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate vendor HAL\n", timeout_sec);
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002286 if (!android::base::SetProperty(
2287 "ctl.interface_restart",
2288 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
Wei Wang587eac92018-04-05 12:17:20 -07002289 MYLOGE("Couldn't restart dumpstate HAL\n");
2290 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002291 }
Wei Wang587eac92018-04-05 12:17:20 -07002292 // Wait some time for init to kill dumpstate vendor HAL
2293 constexpr size_t killing_timeout_sec = 10;
2294 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2295 MYLOGE("killing dumpstateBoard timed out after %zus, continue and "
2296 "there might be racing in content\n", killing_timeout_sec);
2297 }
2298
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002299 if (mount_debugfs) {
Hridya Valsaraju51101602021-04-02 14:32:46 -07002300 auto keep_debugfs_mounted =
2301 android::base::GetProperty("persist.dbg.keep_debugfs_mounted", "");
2302 if (keep_debugfs_mounted.empty())
2303 RunCommand("unmount debugfs", {"umount", "/sys/kernel/debug"}, AS_ROOT_20);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002304 }
2305
Wei Wang587eac92018-04-05 12:17:20 -07002306 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
2307 for (size_t i = 0; i < paths.size(); i++) {
2308 struct stat s;
2309 if (fstat(handle.get()->data[i], &s) == -1) {
2310 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(),
2311 strerror(errno));
2312 file_sizes[i] = -1;
2313 continue;
2314 }
2315 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002316 }
2317
2318 for (size_t i = 0; i < paths.size(); i++) {
2319 if (file_sizes[i] == -1) {
2320 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002321 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002322 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07002323 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002324 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002325 }
Rhed Jao4875aa62020-07-20 17:46:29 +08002326 remover[i].Disable();
2327 EnqueueAddZipEntryAndCleanupIfNeeded(kDumpstateBoardFiles[i], paths[i]);
2328 dprintf(out_fd, "*** See %s entry ***\n", kDumpstateBoardFiles[i].c_str());
Jie Song9fbfad02017-06-20 16:29:42 -07002329 }
Felipe Leme6f674ae2016-11-18 17:10:33 -08002330}
2331
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002332static void ShowUsage() {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002333 fprintf(stderr,
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002334 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-o directory] [-p] "
2335 "[-s] [-S] [-q] [-P] [-R] [-L] [-V version]\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002336 " -h: display this help message\n"
2337 " -b: play sound file instead of vibrate, at beginning of job\n"
2338 " -e: play sound file instead of vibrate, at end of job\n"
mhasank2d75c442020-06-11 15:05:25 -07002339 " -o: write to custom directory (only in limited mode)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01002340 " -p: capture screenshot to filename.png\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002341 " -s: write zipped file to control socket (for init)\n"
2342 " -S: write file location to control socket (for init)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002343 " -q: disable vibrate\n"
Abhijeet Kaure370d682019-10-01 16:49:30 +01002344 " -P: send broadcast when started and do progress updates\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002345 " -R: take bugreport in remote mode (shouldn't be used with -P)\n"
Nandana Dutt235864b2019-01-22 12:10:16 +00002346 " -w: start binder service and make it wait for a call to startBugreport\n"
mhasankd451a472020-05-26 18:02:39 -07002347 " -L: output limited information that is safe for submission in feedback reports\n"
Felipe Lemed071c682016-10-20 16:48:00 -07002348 " -v: prints the dumpstate header and exit\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002349}
2350
Wei Liuf87959e2016-08-26 14:51:42 -07002351static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07002352 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07002353}
2354
Felipe Leme1d486fe2016-10-14 18:06:47 -07002355bool Dumpstate::FinishZipFile() {
Rhed Jao4875aa62020-07-20 17:46:29 +08002356 // Runs all enqueued adding zip entry and cleanup tasks before finishing the zip file.
2357 if (zip_entry_tasks_) {
2358 zip_entry_tasks_->run(/* do_cancel = */false);
2359 }
2360
Felipe Leme9a523ae2016-10-20 15:10:33 -07002361 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07002362 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07002363 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002364 // Final timestamp
2365 char date[80];
2366 time_t the_real_now_please_stand_up = time(nullptr);
2367 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002368 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07002369 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002370
Felipe Leme9a523ae2016-10-20 15:10:33 -07002371 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002372 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08002373 return false;
2374 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07002375 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002376 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08002377 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08002378 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08002379
Felipe Leme0f3fb202016-06-10 17:10:53 -07002380 // Add log file (which contains stderr output) to zip...
2381 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07002382 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07002383 MYLOGE("Failed to add dumpstate log to .zip file\n");
2384 return false;
2385 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002386 // TODO: Should truncate the existing file.
2387 // ... and re-open it for further logging.
Nandana Dutta344cb62019-02-22 15:12:35 +00002388 if (!redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()))) {
2389 return false;
2390 }
Felipe Leme0f3fb202016-06-10 17:10:53 -07002391 fprintf(stderr, "\n");
2392
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002393 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07002394 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002395 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002396 return false;
2397 }
2398
Felipe Leme1d486fe2016-10-14 18:06:47 -07002399 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
2400 ds.zip_file.reset(nullptr);
2401
Felipe Lemee9d2c542016-11-15 11:48:26 -08002402 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002403 android::os::UnlinkAndLogOnError(tmp_path_);
Felipe Lemec4eee562016-04-21 15:42:55 -07002404
Felipe Leme1e9edc62015-12-21 16:02:13 -08002405 return true;
2406}
Felipe Leme6e01fa62015-11-11 19:35:14 -08002407
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002408static void SendBroadcast(const std::string& action, const std::vector<std::string>& args) {
2409 // clang-format off
2410 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user", "0",
2411 "--receiver-foreground", "--receiver-include-background", "-a", action};
2412 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08002413
2414 am.insert(am.end(), args.begin(), args.end());
2415
Felipe Leme8d2410e2017-02-08 09:46:08 -08002416 RunCommand("", am,
2417 CommandOptions::WithTimeout(20)
2418 .Log("Sending broadcast: '%s'\n")
2419 .Always()
2420 .DropRoot()
2421 .RedirectStderr()
2422 .Build());
2423}
2424
Felipe Leme35b8cf12017-02-10 15:47:29 -08002425static void Vibrate(int duration_ms) {
2426 // clang-format off
Chris Fries0c3de872019-09-14 15:49:41 +00002427 RunCommand("", {"cmd", "vibrator", "vibrate", "-f", std::to_string(duration_ms), "dumpstate"},
Felipe Leme35b8cf12017-02-10 15:47:29 -08002428 CommandOptions::WithTimeout(10)
2429 .Log("Vibrate: '%s'\n")
2430 .Always()
2431 .Build());
2432 // clang-format on
2433}
2434
Nandana Dutt979388e2018-11-30 16:48:55 +00002435static void MaybeResolveSymlink(std::string* path) {
2436 std::string resolved_path;
2437 if (android::base::Readlink(*path, &resolved_path)) {
2438 *path = resolved_path;
2439 }
2440}
2441
Nandana Dutt4be45d12018-09-26 15:04:23 +01002442/*
2443 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002444 * and adds the version file. Return false if zip_file could not be open to write.
Nandana Dutt4be45d12018-09-26 15:04:23 +01002445 */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002446static bool PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002447 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
2448
Nandana Dutt4be45d12018-09-26 15:04:23 +01002449 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
2450 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002451 ds.base_name_ = StringPrintf("bugreport-%s-%s", device_name.c_str(), build_id.c_str());
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002452 char date[80];
2453 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
2454 ds.name_ = date;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002455
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002456 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002457 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002458 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002459 ds.base_name_ += "-wifi";
2460 }
2461
Paul Chang0d2aad72020-02-13 20:04:03 +08002462 if (ds.options_->do_screenshot) {
Nandana Dutt9d17b942020-03-26 10:02:59 +00002463 ds.screenshot_path_ = ds.GetPath(ds.CalledByApi() ? "-png.tmp" : ".png");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002464 }
2465 ds.tmp_path_ = ds.GetPath(".tmp");
2466 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
2467
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002468 std::string destination = ds.CalledByApi()
Nandana Dutt54dbd672019-01-11 12:58:05 +00002469 ? StringPrintf("[fd:%d]", ds.options_->bugreport_fd.get())
Nandana Dutt9a76d202019-01-21 15:56:48 +00002470 : ds.bugreport_internal_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01002471 MYLOGD(
Nandana Dutt235c6672019-11-14 15:22:32 +00002472 "Bugreport dir: [%s] "
2473 "Base name: [%s] "
2474 "Suffix: [%s] "
2475 "Log path: [%s] "
2476 "Temporary path: [%s] "
2477 "Screenshot path: [%s]\n",
Nandana Dutt9a76d202019-01-21 15:56:48 +00002478 destination.c_str(), ds.base_name_.c_str(), ds.name_.c_str(), ds.log_path_.c_str(),
2479 ds.tmp_path_.c_str(), ds.screenshot_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002480
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002481 ds.path_ = ds.GetPath(ds.CalledByApi() ? "-zip.tmp" : ".zip");
2482 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
2483 create_parent_dirs(ds.path_.c_str());
2484 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
2485 if (ds.zip_file == nullptr) {
2486 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
2487 return false;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002488 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002489 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
2490 ds.AddTextZipEntry("version.txt", ds.version_);
2491 return true;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002492}
2493
2494/*
Abhijeet Kaure370d682019-10-01 16:49:30 +01002495 * Finalizes writing to the file by zipping the tmp file to the final location,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002496 * printing zipped file status, etc.
2497 */
2498static void FinalizeFile() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002499 bool do_text_file = !ds.FinishZipFile();
2500 if (do_text_file) {
2501 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002502 }
mhasank2d75c442020-06-11 15:05:25 -07002503
2504 std::string final_path = ds.path_;
2505 if (ds.options_->OutputToCustomFile()) {
mhasank3a4cfb42020-06-15 18:06:43 -07002506 final_path = ds.GetPath(ds.options_->out_dir, ".zip");
mhasank2d75c442020-06-11 15:05:25 -07002507 android::os::CopyFileToFile(ds.path_, final_path);
Nandana Dutt4be45d12018-09-26 15:04:23 +01002508 }
mhasank2d75c442020-06-11 15:05:25 -07002509
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002510 if (ds.options_->stream_to_socket) {
2511 android::os::CopyFileToFd(ds.path_, ds.control_socket_fd_);
2512 } else if (ds.options_->progress_updates_to_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002513 if (do_text_file) {
2514 dprintf(ds.control_socket_fd_,
2515 "FAIL:could not create zip file, check %s "
2516 "for more details\n",
2517 ds.log_path_.c_str());
2518 } else {
mhasank2d75c442020-06-11 15:05:25 -07002519 dprintf(ds.control_socket_fd_, "OK:%s\n", final_path.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002520 }
2521 }
2522}
2523
Nandana Dutt4be45d12018-09-26 15:04:23 +01002524
Nandana Dutt58d72e22018-11-16 10:30:48 +00002525static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2526 switch (mode) {
2527 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2528 return "BUGREPORT_FULL";
2529 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2530 return "BUGREPORT_INTERACTIVE";
2531 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2532 return "BUGREPORT_REMOTE";
2533 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2534 return "BUGREPORT_WEAR";
2535 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2536 return "BUGREPORT_TELEPHONY";
2537 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2538 return "BUGREPORT_WIFI";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002539 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2540 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002541 }
2542}
2543
Paul Changf59c2b72020-03-10 02:08:55 +08002544static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options,
2545 bool is_screenshot_requested) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002546 // Modify com.android.shell.BugreportProgressService#isDefaultScreenshotRequired as well for
2547 // default system screenshots.
Abhijeet Kaure370d682019-10-01 16:49:30 +01002548 options->bugreport_mode = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002549 switch (mode) {
2550 case Dumpstate::BugreportMode::BUGREPORT_FULL:
Paul Changf59c2b72020-03-10 02:08:55 +08002551 options->do_screenshot = is_screenshot_requested;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002552 options->dumpstate_hal_mode = DumpstateMode::FULL;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002553 break;
2554 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002555 // Currently, the dumpstate binder is only used by Shell to update progress.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002556 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002557 options->do_screenshot = is_screenshot_requested;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002558 options->dumpstate_hal_mode = DumpstateMode::INTERACTIVE;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002559 break;
2560 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002561 options->do_vibrate = false;
2562 options->is_remote_mode = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002563 options->do_screenshot = false;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002564 options->dumpstate_hal_mode = DumpstateMode::REMOTE;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002565 break;
2566 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002567 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002568 options->do_screenshot = is_screenshot_requested;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002569 options->dumpstate_hal_mode = DumpstateMode::WEAR;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002570 break;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002571 // TODO(b/148168577) rename TELEPHONY everywhere to CONNECTIVITY.
Nandana Dutt58d72e22018-11-16 10:30:48 +00002572 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002573 options->telephony_only = true;
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002574 options->do_progress_updates = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002575 options->do_screenshot = false;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002576 options->dumpstate_hal_mode = DumpstateMode::CONNECTIVITY;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002577 break;
2578 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002579 options->wifi_only = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002580 options->do_screenshot = false;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002581 options->dumpstate_hal_mode = DumpstateMode::WIFI;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002582 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002583 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2584 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002585 }
2586}
2587
Nandana Dutt58d72e22018-11-16 10:30:48 +00002588static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
Nandana Dutt235c6672019-11-14 15:22:32 +00002589 MYLOGI(
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002590 "do_vibrate: %d stream_to_socket: %d progress_updates_to_socket: %d do_screenshot: %d "
Rhed Jao6f5ddce2020-08-20 00:10:32 +08002591 "is_remote_mode: %d show_header_only: %d telephony_only: %d "
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002592 "wifi_only: %d do_progress_updates: %d fd: %d bugreport_mode: %s dumpstate_hal_mode: %s "
mhasankd451a472020-05-26 18:02:39 -07002593 "limited_only: %d args: %s\n",
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002594 options.do_vibrate, options.stream_to_socket, options.progress_updates_to_socket,
Paul Chang0d2aad72020-02-13 20:04:03 +08002595 options.do_screenshot, options.is_remote_mode, options.show_header_only,
Rhed Jao6f5ddce2020-08-20 00:10:32 +08002596 options.telephony_only, options.wifi_only,
mhasankd451a472020-05-26 18:02:39 -07002597 options.do_progress_updates, options.bugreport_fd.get(), options.bugreport_mode.c_str(),
2598 toString(options.dumpstate_hal_mode).c_str(), options.limited_only, options.args.c_str());
Nandana Dutt58d72e22018-11-16 10:30:48 +00002599}
2600
Nandana Dutt54dbd672019-01-11 12:58:05 +00002601void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode,
2602 const android::base::unique_fd& bugreport_fd_in,
Paul Changf59c2b72020-03-10 02:08:55 +08002603 const android::base::unique_fd& screenshot_fd_in,
2604 bool is_screenshot_requested) {
Nandana Dutt54dbd672019-01-11 12:58:05 +00002605 // Duplicate the fds because the passed in fds don't outlive the binder transaction.
2606 bugreport_fd.reset(dup(bugreport_fd_in.get()));
2607 screenshot_fd.reset(dup(screenshot_fd_in.get()));
Nandana Dutt58d72e22018-11-16 10:30:48 +00002608
Paul Changf59c2b72020-03-10 02:08:55 +08002609 SetOptionsFromMode(bugreport_mode, this, is_screenshot_requested);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002610}
2611
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002612Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
2613 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002614 int c;
mhasankd451a472020-05-26 18:02:39 -07002615 while ((c = getopt(argc, argv, "dho:svqzpLPBRSV:w")) != -1) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002616 switch (c) {
2617 // clang-format off
mhasank3a4cfb42020-06-15 18:06:43 -07002618 case 'o': out_dir = optarg; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002619 case 's': stream_to_socket = true; break;
2620 case 'S': progress_updates_to_socket = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002621 case 'v': show_header_only = true; break;
2622 case 'q': do_vibrate = false; break;
Paul Chang0d2aad72020-02-13 20:04:03 +08002623 case 'p': do_screenshot = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002624 case 'P': do_progress_updates = true; break;
2625 case 'R': is_remote_mode = true; break;
mhasankd451a472020-05-26 18:02:39 -07002626 case 'L': limited_only = true; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002627 case 'V':
2628 case 'd':
2629 case 'z':
2630 // compatibility no-op
2631 break;
Nandana Dutt235864b2019-01-22 12:10:16 +00002632 case 'w':
2633 // This was already processed
2634 break;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002635 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002636 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002637 break;
2638 default:
2639 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002640 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002641 break;
2642 // clang-format on
2643 }
2644 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08002645
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002646 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002647 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002648 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002649 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002650 }
2651 }
2652
2653 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
2654 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002655
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002656 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002657}
2658
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002659bool Dumpstate::DumpOptions::ValidateOptions() const {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002660 if (bugreport_fd.get() != -1 && stream_to_socket) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002661 return false;
2662 }
2663
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002664 if ((progress_updates_to_socket || do_progress_updates) && stream_to_socket) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002665 return false;
2666 }
2667
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002668 if (is_remote_mode && (do_progress_updates || stream_to_socket)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002669 return false;
2670 }
2671 return true;
2672}
2673
Nandana Dutt197661d2018-11-16 16:40:21 +00002674void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
2675 options_ = std::move(options);
2676}
2677
Abhijeet Kaura407fb82020-03-27 12:51:12 +00002678void Dumpstate::Initialize() {
2679 /* gets the sequential id */
2680 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
2681 id_ = ++last_id;
2682 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
2683}
2684
Nandana Duttd2f5f082019-01-18 17:13:52 +00002685Dumpstate::RunStatus Dumpstate::Run(int32_t calling_uid, const std::string& calling_package) {
2686 Dumpstate::RunStatus status = RunInternal(calling_uid, calling_package);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002687 if (listener_ != nullptr) {
2688 switch (status) {
2689 case Dumpstate::RunStatus::OK:
Nandana Duttcc4ead82019-01-23 08:29:23 +00002690 listener_->onFinished();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002691 break;
2692 case Dumpstate::RunStatus::HELP:
2693 break;
2694 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002695 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_INVALID_INPUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002696 break;
2697 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002698 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_RUNTIME_ERROR);
2699 break;
2700 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2701 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_DENIED_CONSENT);
2702 break;
2703 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
2704 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_CONSENT_TIMED_OUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002705 break;
2706 }
2707 }
2708 return status;
2709}
2710
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002711void Dumpstate::Cancel() {
2712 CleanupTmpFiles();
2713 android::os::UnlinkAndLogOnError(log_path_);
2714 for (int i = 0; i < NUM_OF_DUMPS; i++) {
2715 android::os::UnlinkAndLogOnError(ds.bugreport_internal_dir_ + "/" +
2716 kDumpstateBoardFiles[i]);
2717 }
2718 tombstone_data_.clear();
2719 anr_data_.clear();
Rhed Jaoe96bcd52020-08-21 14:48:20 +08002720
2721 // Instead of shutdown the pool, we delete temporary files directly since
2722 // shutdown blocking the call.
2723 if (dump_pool_) {
2724 dump_pool_->deleteTempFiles();
2725 }
2726 if (zip_entry_tasks_) {
2727 zip_entry_tasks_->run(/*do_cancel =*/ true);
2728 }
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002729}
2730
Nandana Dutt979388e2018-11-30 16:48:55 +00002731/*
2732 * Dumps relevant information to a bugreport based on the given options.
2733 *
2734 * The bugreport can be dumped to a file or streamed to a socket.
2735 *
2736 * How dumping to file works:
2737 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
2738 * stderr is redirected a log file.
2739 *
2740 * The temporary bugreport is then populated via printfs, dumping contents of files and
2741 * output of commands to stdout.
2742 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002743 * A bunch of other files and dumps are added to the zip archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00002744 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002745 * The temporary bugreport file and the log file also get added to the archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00002746 *
mhasank2d75c442020-06-11 15:05:25 -07002747 * Bugreports are first generated in a local directory and later copied to the caller's fd
2748 * or directory if supplied.
Nandana Dutt979388e2018-11-30 16:48:55 +00002749 */
Nandana Duttd2f5f082019-01-18 17:13:52 +00002750Dumpstate::RunStatus Dumpstate::RunInternal(int32_t calling_uid,
2751 const std::string& calling_package) {
Rhed Jao1c855122020-07-16 17:37:39 +08002752 DurationReporter duration_reporter("RUN INTERNAL", /* logcat_only = */true);
Nandana Dutt979388e2018-11-30 16:48:55 +00002753 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00002754 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002755 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002756 return RunStatus::INVALID_INPUT;
2757 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002758 /* set as high priority, and protect from OOM killer */
2759 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002760
Felipe Lemed071c682016-10-20 16:48:00 -07002761 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002762 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002763 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002764 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002765 } else {
2766 /* fallback to kernels <= 2.6.35 */
2767 oom_adj = fopen("/proc/self/oom_adj", "we");
2768 if (oom_adj) {
2769 fputs("-17", oom_adj);
2770 fclose(oom_adj);
2771 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002772 }
2773
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002774 if (version_ == VERSION_DEFAULT) {
2775 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00002776 }
2777
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002778 if (version_ != VERSION_CURRENT && version_ != VERSION_SPLIT_ANR) {
Vishnu Nair64afc022018-02-01 15:29:34 -08002779 MYLOGE("invalid version requested ('%s'); suppported values are: ('%s', '%s', '%s')\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002780 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str(),
Vishnu Nair64afc022018-02-01 15:29:34 -08002781 VERSION_SPLIT_ANR.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002782 return RunStatus::INVALID_INPUT;
Felipe Lemed071c682016-10-20 16:48:00 -07002783 }
2784
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002785 if (options_->show_header_only) {
2786 PrintHeader();
2787 return RunStatus::OK;
Felipe Lemed071c682016-10-20 16:48:00 -07002788 }
2789
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002790 MYLOGD("dumpstate calling_uid = %d ; calling package = %s \n",
2791 calling_uid, calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00002792
Felipe Leme7447d7c2016-11-03 18:12:22 -07002793 // TODO: temporarily set progress until it's part of the Dumpstate constructor
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002794 std::string stats_path =
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002795 android::base::StringPrintf("%s/dumpstate-stats.txt", bugreport_internal_dir_.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002796 progress_.reset(new Progress(stats_path));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002797
Sahana Raof35ed432019-07-12 10:47:52 +01002798 if (acquire_wake_lock(PARTIAL_WAKE_LOCK, WAKE_LOCK_NAME) < 0) {
2799 MYLOGE("Failed to acquire wake lock: %s\n", strerror(errno));
2800 } else {
2801 // Wake lock will be released automatically on process death
2802 MYLOGD("Wake lock acquired.\n");
2803 }
2804
Felipe Leme6ae5c4f2017-01-10 14:13:22 -08002805 register_sig_handler();
Felipe Lemed071c682016-10-20 16:48:00 -07002806
Felipe Lemef0292972016-11-22 13:57:05 -08002807 if (PropertiesHelper::IsDryRun()) {
Felipe Lemed071c682016-10-20 16:48:00 -07002808 MYLOGI("Running on dry-run mode (to disable it, call 'setprop dumpstate.dry_run false')\n");
2809 }
2810
Nandana Dutt235c6672019-11-14 15:22:32 +00002811 MYLOGI("dumpstate info: id=%d, args='%s', bugreport_mode= %s bugreport format version: %s\n",
2812 id_, options_->args.c_str(), options_->bugreport_mode.c_str(), version_.c_str());
Felipe Leme809d74e2016-02-02 12:57:00 -08002813
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002814 do_early_screenshot_ = options_->do_progress_updates;
Felipe Lemee338bf62015-12-07 14:03:50 -08002815
Christopher Ferrised9354f2014-10-01 17:35:01 -07002816 // If we are going to use a socket, do it as early as possible
2817 // to avoid timeouts from bugreport.
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002818 if (options_->stream_to_socket || options_->progress_updates_to_socket) {
Felipe Leme2628e9e2016-04-12 16:36:51 -07002819 MYLOGD("Opening control socket\n");
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002820 control_socket_fd_ = open_socket_fn_("dumpstate");
Nandana Dutta344cb62019-02-22 15:12:35 +00002821 if (control_socket_fd_ == -1) {
2822 return ERROR;
2823 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002824 if (options_->progress_updates_to_socket) {
2825 options_->do_progress_updates = 1;
2826 }
Felipe Leme2628e9e2016-04-12 16:36:51 -07002827 }
2828
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002829 if (!PrepareToWriteToFile()) {
2830 return ERROR;
2831 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08002832
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002833 // Interactive, wear & telephony modes are default to true.
2834 // and may enable from cli option or when using control socket
2835 if (options_->do_progress_updates) {
2836 // clang-format off
2837 std::vector<std::string> am_args = {
2838 "--receiver-permission", "android.permission.DUMP",
2839 };
2840 // clang-format on
2841 // Send STARTED broadcast for apps that listen to bugreport generation events
2842 SendBroadcast("com.android.internal.intent.action.BUGREPORT_STARTED", am_args);
2843 if (options_->progress_updates_to_socket) {
2844 dprintf(control_socket_fd_, "BEGIN:%s\n", path_.c_str());
Felipe Leme71bbfc52015-11-23 14:14:51 -08002845 }
2846 }
2847
Nick Kralevichf3599b32016-01-25 15:05:16 -08002848 /* read /proc/cmdline before dropping root */
2849 FILE *cmdline = fopen("/proc/cmdline", "re");
2850 if (cmdline) {
2851 fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
2852 fclose(cmdline);
2853 }
2854
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002855 if (options_->do_vibrate) {
Felipe Leme35b8cf12017-02-10 15:47:29 -08002856 Vibrate(150);
John Michelau1f794c42012-09-17 11:20:19 -05002857 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002858
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002859 if (zip_file != nullptr) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002860 if (chown(path_.c_str(), AID_SHELL, AID_SHELL)) {
2861 MYLOGE("Unable to change ownership of zip file %s: %s\n", path_.c_str(),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002862 strerror(errno));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002863 }
2864 }
2865
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002866 int dup_stdout_fd;
2867 int dup_stderr_fd;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002868 // Redirect stderr to log_path_ for debugging.
2869 TEMP_FAILURE_RETRY(dup_stderr_fd = dup(fileno(stderr)));
2870 if (!redirect_to_file(stderr, const_cast<char*>(log_path_.c_str()))) {
2871 return ERROR;
2872 }
2873 if (chown(log_path_.c_str(), AID_SHELL, AID_SHELL)) {
2874 MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n", log_path_.c_str(),
2875 strerror(errno));
2876 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002877
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002878 // Redirect stdout to tmp_path_. This is the main bugreport entry and will be
2879 // moved into zip file later, if zipping.
2880 TEMP_FAILURE_RETRY(dup_stdout_fd = dup(fileno(stdout)));
2881 // TODO: why not write to a file instead of stdout to overcome this problem?
2882 /* TODO: rather than generating a text file now and zipping it later,
2883 it would be more efficient to redirect stdout to the zip entry
2884 directly, but the libziparchive doesn't support that option yet. */
2885 if (!redirect_to_file(stdout, const_cast<char*>(tmp_path_.c_str()))) {
2886 return ERROR;
2887 }
2888 if (chown(tmp_path_.c_str(), AID_SHELL, AID_SHELL)) {
2889 MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
2890 tmp_path_.c_str(), strerror(errno));
Colin Crossf45fa6b2012-03-26 12:38:26 -07002891 }
Felipe Lemed8b94e52016-12-08 10:21:44 -08002892
2893 // Don't buffer stdout
2894 setvbuf(stdout, nullptr, _IONBF, 0);
2895
Rhed Jao1c855122020-07-16 17:37:39 +08002896 // Enable the parallel run if the client requests to output to a file.
2897 EnableParallelRunIfNeeded();
2898 // Using scope guard to make sure the dump pool can be shut down correctly.
2899 auto scope_guard_to_shutdown_pool = android::base::make_scope_guard([=]() {
2900 ShutdownDumpPool();
2901 });
2902
Felipe Leme608385d2016-02-01 10:35:38 -08002903 // NOTE: there should be no stdout output until now, otherwise it would break the header.
2904 // In particular, DurationReport objects should be created passing 'title, NULL', so their
Felipe Lemecbce55d2016-02-08 09:53:18 -08002905 // duration is logged into MYLOG instead.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002906 PrintHeader();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002907
Gavin Corkery6968f552020-11-22 18:09:05 +00002908 bool is_dumpstate_restricted = options_->telephony_only
2909 || options_->wifi_only
2910 || options_->limited_only;
2911 if (!is_dumpstate_restricted) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002912 // Invoke critical dumpsys first to preserve system state, before doing anything else.
Jichao Lie89d9c12019-11-21 19:02:51 -08002913 RunDumpsysCritical();
Gavin Corkery6968f552020-11-22 18:09:05 +00002914 }
2915 MaybeTakeEarlyScreenshot();
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00002916
2917 if (!is_dumpstate_restricted) {
2918 // Snapshot the system trace now (if running) to avoid that dumpstate's
2919 // own activity pushes out interesting data from the trace ring buffer.
2920 // The trace file is added to the zip by MaybeAddSystemTraceToZip().
2921 MaybeSnapshotSystemTrace();
Yohei Yukawa95305b32021-03-09 07:54:27 -08002922
2923 // If a winscope trace is running, snapshot it now. It will be pulled into bugreport later
2924 // from WMTRACE_DATA_DIR.
2925 MaybeSnapshotWinTrace();
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00002926 }
Gavin Corkery6968f552020-11-22 18:09:05 +00002927 onUiIntensiveBugreportDumpsFinished(calling_uid);
2928 MaybeCheckUserConsent(calling_uid, calling_package);
2929 if (options_->telephony_only) {
2930 DumpstateTelephonyOnly(calling_package);
2931 } else if (options_->wifi_only) {
2932 DumpstateWifiOnly();
2933 } else if (options_->limited_only) {
2934 DumpstateLimitedOnly();
2935 } else {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002936 // Dump state for the default case. This also drops root.
Jichao Lie89d9c12019-11-21 19:02:51 -08002937 RunStatus s = DumpstateDefaultAfterCritical();
Nandana Dutt5c390032019-03-12 10:52:56 +00002938 if (s != RunStatus::OK) {
Nandana Duttaac6f582019-07-26 14:32:47 +01002939 if (s == RunStatus::USER_CONSENT_DENIED) {
Nandana Dutt5c390032019-03-12 10:52:56 +00002940 HandleUserConsentDenied();
2941 }
2942 return s;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002943 }
Zhengyin Qian068ecc72016-08-10 16:48:14 -07002944 }
Felipe Leme71a74ac2016-03-17 15:43:25 -07002945
Felipe Leme55b42a62015-11-10 17:39:08 -08002946 /* close output if needed */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002947 TEMP_FAILURE_RETRY(dup2(dup_stdout_fd, fileno(stdout)));
Colin Crossf45fa6b2012-03-26 12:38:26 -07002948
Abhijeet Kaure370d682019-10-01 16:49:30 +01002949 // Zip the (now complete) .tmp file within the internal directory.
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002950 FinalizeFile();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002951
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002952 // Share the final file with the caller if the user has consented or Shell is the caller.
Nandana Duttd2f5f082019-01-18 17:13:52 +00002953 Dumpstate::RunStatus status = Dumpstate::RunStatus::OK;
Abhijeet Kaure370d682019-10-01 16:49:30 +01002954 if (CalledByApi()) {
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002955 status = CopyBugreportIfUserConsented(calling_uid);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002956 if (status != Dumpstate::RunStatus::OK &&
2957 status != Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2958 // Do an early return if there were errors. We make an exception for consent
2959 // timing out because it's possible the user got distracted. In this case the
2960 // bugreport is not shared but made available for manual retrieval.
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002961 MYLOGI("User denied consent. Returning\n");
Nandana Duttd2f5f082019-01-18 17:13:52 +00002962 return status;
2963 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002964 if (status == Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2965 MYLOGI(
2966 "Did not receive user consent yet."
2967 " Will not copy the bugreport artifacts to caller.\n");
Abhijeet Kaur57627412019-04-17 16:00:09 +01002968 const String16 incidentcompanion("incidentcompanion");
2969 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
2970 if (ics != nullptr) {
2971 MYLOGD("Canceling user consent request via incidentcompanion service\n");
2972 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
2973 consent_callback_.get());
2974 } else {
2975 MYLOGD("Unable to cancel user consent; incidentcompanion service unavailable\n");
2976 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002977 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00002978 }
2979
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002980 /* vibrate a few but shortly times to let user know it's finished */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002981 if (options_->do_vibrate) {
Takuya Ogawa47f644e2017-12-20 18:09:09 +09002982 for (int i = 0; i < 3; i++) {
2983 Vibrate(75);
2984 usleep((75 + 50) * 1000);
2985 }
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002986 }
2987
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002988 MYLOGD("Final progress: %d/%d (estimated %d)\n", progress_->Get(), progress_->GetMax(),
2989 progress_->GetInitialMax());
2990 progress_->Save();
2991 MYLOGI("done (id %d)\n", id_);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002992
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002993 TEMP_FAILURE_RETRY(dup2(dup_stderr_fd, fileno(stderr)));
Felipe Leme107a05f2016-03-08 15:11:15 -08002994
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002995 if (control_socket_fd_ != -1) {
Felipe Lemee844a9d2016-09-21 15:01:39 -07002996 MYLOGD("Closing control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002997 close(control_socket_fd_);
Felipe Leme2628e9e2016-04-12 16:36:51 -07002998 }
2999
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003000 tombstone_data_.clear();
3001 anr_data_.clear();
Narayan Kamath6b9516c2017-10-27 11:15:51 +01003002
Nandana Duttd2f5f082019-01-18 17:13:52 +00003003 return (consent_callback_ != nullptr &&
3004 consent_callback_->getResult() == UserConsentResult::UNAVAILABLE)
3005 ? USER_CONSENT_TIMED_OUT
3006 : RunStatus::OK;
3007}
3008
Paul Chang0d2aad72020-02-13 20:04:03 +08003009void Dumpstate::MaybeTakeEarlyScreenshot() {
3010 if (!options_->do_screenshot || !do_early_screenshot_) {
3011 return;
3012 }
3013
3014 TakeScreenshot();
3015}
3016
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003017void Dumpstate::MaybeSnapshotSystemTrace() {
3018 // If a background system trace is happening and is marked as "suitable for
3019 // bugreport" (i.e. bugreport_score > 0 in the trace config), this command
3020 // will stop it and serialize into SYSTEM_TRACE_SNAPSHOT. In the (likely)
3021 // case that no trace is ongoing, this command is a no-op.
3022 // Note: this should not be enqueued as we need to freeze the trace before
3023 // dumpstate starts. Otherwise the trace ring buffers will contain mostly
3024 // the dumpstate's own activity which is irrelevant.
3025 int res = RunCommand(
3026 "SERIALIZE PERFETTO TRACE",
3027 {"perfetto", "--save-for-bugreport"},
3028 CommandOptions::WithTimeout(10)
3029 .DropRoot()
3030 .CloseAllFileDescriptorsOnExec()
3031 .Build());
3032 has_system_trace_ = res == 0;
3033 // MaybeAddSystemTraceToZip() will take care of copying the trace in the zip
3034 // file in the later stages.
3035}
3036
Yohei Yukawa95305b32021-03-09 07:54:27 -08003037void Dumpstate::MaybeSnapshotWinTrace() {
Yohei Yukawa02b1d2c2021-03-16 09:20:30 -07003038 // Currently WindowManagerService and InputMethodManagerSerivice support WinScope protocol.
3039 for (const auto& service : {"window", "input_method"}) {
3040 RunCommand(
3041 // Empty name because it's not intended to be classified as a bugreport section.
3042 // Actual tracing files can be found in "/data/misc/wmtrace/" in the bugreport.
3043 "", {"cmd", service, "tracing", "save-for-bugreport"},
3044 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3045 }
Yohei Yukawa95305b32021-03-09 07:54:27 -08003046}
3047
Paul Chang5702b482020-05-28 22:05:47 +08003048void Dumpstate::onUiIntensiveBugreportDumpsFinished(int32_t calling_uid) {
Paul Changc490e662020-04-11 18:14:09 +08003049 if (calling_uid == AID_SHELL || !CalledByApi()) {
3050 return;
3051 }
3052 if (listener_ != nullptr) {
3053 // Let listener know ui intensive bugreport dumps are finished, then it can do event
3054 // handling if required.
Paul Chang5702b482020-05-28 22:05:47 +08003055 listener_->onUiIntensiveBugreportDumpsFinished();
Paul Changc490e662020-04-11 18:14:09 +08003056 }
3057}
3058
Jichao Lie89d9c12019-11-21 19:02:51 -08003059void Dumpstate::MaybeCheckUserConsent(int32_t calling_uid, const std::string& calling_package) {
3060 if (calling_uid == AID_SHELL || !CalledByApi()) {
3061 // No need to get consent for shell triggered dumpstates, or not through
3062 // bugreporting API (i.e. no fd to copy back).
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003063 return;
3064 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003065 consent_callback_ = new ConsentCallback();
3066 const String16 incidentcompanion("incidentcompanion");
3067 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
Jichao Lie89d9c12019-11-21 19:02:51 -08003068 android::String16 package(calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003069 if (ics != nullptr) {
3070 MYLOGD("Checking user consent via incidentcompanion service\n");
3071 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
Jichao Lie89d9c12019-11-21 19:02:51 -08003072 calling_uid, package, String16(), String16(),
Joe Onorato1c36d752019-03-17 18:26:43 -07003073 0x1 /* FLAG_CONFIRMATION_DIALOG */, consent_callback_.get());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003074 } else {
3075 MYLOGD("Unable to check user consent; incidentcompanion service unavailable\n");
3076 }
3077}
3078
Nandana Dutt5c390032019-03-12 10:52:56 +00003079bool Dumpstate::IsUserConsentDenied() const {
3080 return ds.consent_callback_ != nullptr &&
3081 ds.consent_callback_->getResult() == UserConsentResult::DENIED;
3082}
3083
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01003084bool Dumpstate::CalledByApi() const {
3085 return ds.options_->bugreport_fd.get() != -1 ? true : false;
3086}
3087
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003088void Dumpstate::CleanupTmpFiles() {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003089 android::os::UnlinkAndLogOnError(tmp_path_);
3090 android::os::UnlinkAndLogOnError(screenshot_path_);
3091 android::os::UnlinkAndLogOnError(path_);
Gavin Corkery789d7a52021-02-24 23:52:35 +00003092 if (dump_traces_path != nullptr) {
3093 android::os::UnlinkAndLogOnError(dump_traces_path);
3094 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003095}
3096
Rhed Jao1c855122020-07-16 17:37:39 +08003097void Dumpstate::EnableParallelRunIfNeeded() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003098 if (!PropertiesHelper::IsParallelRun()) {
Rhed Jao1c855122020-07-16 17:37:39 +08003099 return;
3100 }
3101 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao4875aa62020-07-20 17:46:29 +08003102 zip_entry_tasks_ = std::make_unique<TaskQueue>();
Rhed Jao1c855122020-07-16 17:37:39 +08003103}
3104
3105void Dumpstate::ShutdownDumpPool() {
3106 if (dump_pool_) {
3107 dump_pool_->shutdown();
3108 dump_pool_ = nullptr;
3109 }
Rhed Jao4875aa62020-07-20 17:46:29 +08003110 if (zip_entry_tasks_) {
3111 zip_entry_tasks_->run(/* do_cancel = */true);
3112 zip_entry_tasks_ = nullptr;
3113 }
3114}
3115
3116void Dumpstate::EnqueueAddZipEntryAndCleanupIfNeeded(const std::string& entry_name,
3117 const std::string& entry_path) {
3118 auto func_add_zip_entry_and_cleanup = [=](bool task_cancelled) {
3119 if (!task_cancelled) {
3120 AddZipEntry(entry_name, entry_path);
3121 }
3122 android::os::UnlinkAndLogOnError(entry_path);
3123 };
3124 if (zip_entry_tasks_) {
3125 // Enqueues AddZipEntryAndCleanup function if the parallel run is enabled.
3126 zip_entry_tasks_->add(func_add_zip_entry_and_cleanup, _1);
3127 } else {
3128 // Invokes AddZipEntryAndCleanup immediately
3129 std::invoke(func_add_zip_entry_and_cleanup, /* task_cancelled = */false);
3130 }
Rhed Jao1c855122020-07-16 17:37:39 +08003131}
3132
Nandana Duttd2f5f082019-01-18 17:13:52 +00003133Dumpstate::RunStatus Dumpstate::HandleUserConsentDenied() {
3134 MYLOGD("User denied consent; deleting files and returning\n");
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003135 CleanupTmpFiles();
Nandana Duttd2f5f082019-01-18 17:13:52 +00003136 return USER_CONSENT_DENIED;
3137}
3138
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003139Dumpstate::RunStatus Dumpstate::CopyBugreportIfUserConsented(int32_t calling_uid) {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003140 // If the caller has asked to copy the bugreport over to their directory, we need explicit
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003141 // user consent (unless the caller is Shell).
3142 UserConsentResult consent_result;
3143 if (calling_uid == AID_SHELL) {
3144 consent_result = UserConsentResult::APPROVED;
3145 } else {
3146 consent_result = consent_callback_->getResult();
3147 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003148 if (consent_result == UserConsentResult::UNAVAILABLE) {
3149 // User has not responded yet.
3150 uint64_t elapsed_ms = consent_callback_->getElapsedTimeMs();
Hunter Knepshield70610fa2020-01-03 15:27:33 -08003151 // Telephony is a fast report type, particularly on user builds where information may be
3152 // more aggressively limited. To give the user time to read the consent dialog, increase the
3153 // timeout.
3154 uint64_t timeout_ms = options_->telephony_only ? TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS
3155 : USER_CONSENT_TIMEOUT_MS;
3156 if (elapsed_ms < timeout_ms) {
3157 uint delay_seconds = (timeout_ms - elapsed_ms) / 1000;
Nandana Duttd2f5f082019-01-18 17:13:52 +00003158 MYLOGD("Did not receive user consent yet; going to wait for %d seconds", delay_seconds);
3159 sleep(delay_seconds);
3160 }
3161 consent_result = consent_callback_->getResult();
3162 }
3163 if (consent_result == UserConsentResult::DENIED) {
3164 // User has explicitly denied sharing with the app. To be safe delete the
3165 // internal bugreport & tmp files.
3166 return HandleUserConsentDenied();
3167 }
3168 if (consent_result == UserConsentResult::APPROVED) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00003169 bool copy_succeeded = android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
3170 if (copy_succeeded) {
3171 android::os::UnlinkAndLogOnError(path_);
Abhijeet Kaur9ce94672020-04-01 17:22:36 +01003172 if (options_->do_screenshot &&
3173 options_->screenshot_fd.get() != -1 &&
3174 !options_->is_screenshot_copied) {
3175 copy_succeeded = android::os::CopyFileToFd(screenshot_path_,
3176 options_->screenshot_fd.get());
3177 options_->is_screenshot_copied = copy_succeeded;
3178 if (copy_succeeded) {
3179 android::os::UnlinkAndLogOnError(screenshot_path_);
3180 }
3181 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003182 }
3183 return copy_succeeded ? Dumpstate::RunStatus::OK : Dumpstate::RunStatus::ERROR;
3184 } else if (consent_result == UserConsentResult::UNAVAILABLE) {
3185 // consent_result is still UNAVAILABLE. The user has likely not responded yet.
3186 // Since we do not have user consent to share the bugreport it does not get
3187 // copied over to the calling app but remains in the internal directory from
3188 // where the user can manually pull it.
3189 return Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT;
3190 }
3191 // Unknown result; must be a programming error.
3192 MYLOGE("Unknown user consent result:%d\n", consent_result);
3193 return Dumpstate::RunStatus::ERROR;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003194}
3195
Nandana Duttf02564e2019-02-15 15:24:24 +00003196Dumpstate::RunStatus Dumpstate::ParseCommandlineAndRun(int argc, char* argv[]) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003197 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
3198 Dumpstate::RunStatus status = options->Initialize(argc, argv);
3199 if (status == Dumpstate::RunStatus::OK) {
Nandana Duttf02564e2019-02-15 15:24:24 +00003200 SetOptions(std::move(options));
Nandana Duttd2f5f082019-01-18 17:13:52 +00003201 // When directly running dumpstate binary, the output is not expected to be written
3202 // to any external file descriptor.
Nandana Duttf02564e2019-02-15 15:24:24 +00003203 assert(options_->bugreport_fd.get() == -1);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003204
3205 // calling_uid and calling_package are for user consent to share the bugreport with
Abhijeet Kaura407fb82020-03-27 12:51:12 +00003206 // an app; they are irrelevant here because bugreport is triggered via command line.
3207 // Update Last ID before calling Run().
3208 Initialize();
Nandana Duttf02564e2019-02-15 15:24:24 +00003209 status = Run(-1 /* calling_uid */, "" /* calling_package */);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003210 }
Nandana Duttf02564e2019-02-15 15:24:24 +00003211 return status;
3212}
3213
3214/* Main entry point for dumpstate binary. */
3215int run_main(int argc, char* argv[]) {
3216 Dumpstate::RunStatus status = ds.ParseCommandlineAndRun(argc, argv);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003217
3218 switch (status) {
3219 case Dumpstate::RunStatus::OK:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003220 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003221 case Dumpstate::RunStatus::HELP:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003222 ShowUsage();
3223 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003224 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003225 fprintf(stderr, "Invalid combination of args\n");
3226 ShowUsage();
3227 exit(1);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003228 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00003229 FALLTHROUGH_INTENDED;
3230 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
3231 FALLTHROUGH_INTENDED;
3232 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003233 exit(2);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003234 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003235}
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003236
3237// TODO(111441001): Default DumpOptions to sensible values.
3238Dumpstate::Dumpstate(const std::string& version)
3239 : pid_(getpid()),
3240 options_(new Dumpstate::DumpOptions()),
Nandana Duttf02cd782019-06-14 14:25:13 +01003241 last_reported_percent_progress_(0),
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003242 version_(version),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003243 now_(time(nullptr)),
3244 open_socket_fn_(open_socket) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003245}
3246
3247Dumpstate& Dumpstate::GetInstance() {
3248 static Dumpstate singleton_(android::base::GetProperty("dumpstate.version", VERSION_CURRENT));
3249 return singleton_;
3250}
3251
Rhed Jao1c855122020-07-16 17:37:39 +08003252DurationReporter::DurationReporter(const std::string& title, bool logcat_only, bool verbose,
3253 int duration_fd) : title_(title), logcat_only_(logcat_only), verbose_(verbose),
3254 duration_fd_(duration_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003255 if (!title_.empty()) {
3256 started_ = Nanotime();
3257 }
3258}
3259
3260DurationReporter::~DurationReporter() {
3261 if (!title_.empty()) {
3262 float elapsed = (float)(Nanotime() - started_) / NANOS_PER_SEC;
chenqiwuaf8b2d92019-12-12 18:53:51 +08003263 if (elapsed >= .5f || verbose_) {
3264 MYLOGD("Duration of '%s': %.2fs\n", title_.c_str(), elapsed);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003265 }
chenqiwuaf8b2d92019-12-12 18:53:51 +08003266 if (!logcat_only_) {
3267 // Use "Yoda grammar" to make it easier to grep|sort sections.
Rhed Jao1c855122020-07-16 17:37:39 +08003268 dprintf(duration_fd_, "------ %.3fs was the duration of '%s' ------\n",
3269 elapsed, title_.c_str());
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003270 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003271 }
3272}
3273
3274const int32_t Progress::kDefaultMax = 5000;
3275
3276Progress::Progress(const std::string& path) : Progress(Progress::kDefaultMax, 1.1, path) {
3277}
3278
3279Progress::Progress(int32_t initial_max, int32_t progress, float growth_factor)
3280 : Progress(initial_max, growth_factor, "") {
3281 progress_ = progress;
3282}
3283
3284Progress::Progress(int32_t initial_max, float growth_factor, const std::string& path)
3285 : initial_max_(initial_max),
3286 progress_(0),
3287 max_(initial_max),
3288 growth_factor_(growth_factor),
3289 n_runs_(0),
3290 average_max_(0),
3291 path_(path) {
3292 if (!path_.empty()) {
3293 Load();
3294 }
3295}
3296
3297void Progress::Load() {
3298 MYLOGD("Loading stats from %s\n", path_.c_str());
3299 std::string content;
3300 if (!android::base::ReadFileToString(path_, &content)) {
3301 MYLOGI("Could not read stats from %s; using max of %d\n", path_.c_str(), max_);
3302 return;
3303 }
3304 if (content.empty()) {
3305 MYLOGE("No stats (empty file) on %s; using max of %d\n", path_.c_str(), max_);
3306 return;
3307 }
3308 std::vector<std::string> lines = android::base::Split(content, "\n");
3309
3310 if (lines.size() < 1) {
3311 MYLOGE("Invalid stats on file %s: not enough lines (%d). Using max of %d\n", path_.c_str(),
3312 (int)lines.size(), max_);
3313 return;
3314 }
3315 char* ptr;
3316 n_runs_ = strtol(lines[0].c_str(), &ptr, 10);
3317 average_max_ = strtol(ptr, nullptr, 10);
3318 if (n_runs_ <= 0 || average_max_ <= 0 || n_runs_ > STATS_MAX_N_RUNS ||
3319 average_max_ > STATS_MAX_AVERAGE) {
3320 MYLOGE("Invalid stats line on file %s: %s\n", path_.c_str(), lines[0].c_str());
3321 initial_max_ = Progress::kDefaultMax;
3322 } else {
3323 initial_max_ = average_max_;
3324 }
3325 max_ = initial_max_;
3326
3327 MYLOGI("Average max progress: %d in %d runs; estimated max: %d\n", average_max_, n_runs_, max_);
3328}
3329
3330void Progress::Save() {
3331 int32_t total = n_runs_ * average_max_ + progress_;
3332 int32_t runs = n_runs_ + 1;
3333 int32_t average = floor(((float)total) / runs);
3334 MYLOGI("Saving stats (total=%d, runs=%d, average=%d) on %s\n", total, runs, average,
3335 path_.c_str());
3336 if (path_.empty()) {
3337 return;
3338 }
3339
3340 std::string content = android::base::StringPrintf("%d %d\n", runs, average);
3341 if (!android::base::WriteStringToFile(content, path_)) {
3342 MYLOGE("Could not save stats on %s\n", path_.c_str());
3343 }
3344}
3345
3346int32_t Progress::Get() const {
3347 return progress_;
3348}
3349
3350bool Progress::Inc(int32_t delta_sec) {
3351 bool changed = false;
3352 if (delta_sec >= 0) {
3353 progress_ += delta_sec;
3354 if (progress_ > max_) {
3355 int32_t old_max = max_;
3356 max_ = floor((float)progress_ * growth_factor_);
3357 MYLOGD("Adjusting max progress from %d to %d\n", old_max, max_);
3358 changed = true;
3359 }
3360 }
3361 return changed;
3362}
3363
3364int32_t Progress::GetMax() const {
3365 return max_;
3366}
3367
3368int32_t Progress::GetInitialMax() const {
3369 return initial_max_;
3370}
3371
3372void Progress::Dump(int fd, const std::string& prefix) const {
3373 const char* pr = prefix.c_str();
3374 dprintf(fd, "%sprogress: %d\n", pr, progress_);
3375 dprintf(fd, "%smax: %d\n", pr, max_);
3376 dprintf(fd, "%sinitial_max: %d\n", pr, initial_max_);
3377 dprintf(fd, "%sgrowth_factor: %0.2f\n", pr, growth_factor_);
3378 dprintf(fd, "%spath: %s\n", pr, path_.c_str());
3379 dprintf(fd, "%sn_runs: %d\n", pr, n_runs_);
3380 dprintf(fd, "%saverage_max: %d\n", pr, average_max_);
3381}
3382
3383bool Dumpstate::IsZipping() const {
3384 return zip_writer_ != nullptr;
3385}
3386
3387std::string Dumpstate::GetPath(const std::string& suffix) const {
3388 return GetPath(bugreport_internal_dir_, suffix);
3389}
3390
3391std::string Dumpstate::GetPath(const std::string& directory, const std::string& suffix) const {
3392 return android::base::StringPrintf("%s/%s-%s%s", directory.c_str(), base_name_.c_str(),
3393 name_.c_str(), suffix.c_str());
3394}
3395
3396void Dumpstate::SetProgress(std::unique_ptr<Progress> progress) {
3397 progress_ = std::move(progress);
3398}
3399
3400void for_each_userid(void (*func)(int), const char *header) {
3401 std::string title = header == nullptr ? "for_each_userid" : android::base::StringPrintf(
3402 "for_each_userid(%s)", header);
3403 DurationReporter duration_reporter(title);
3404 if (PropertiesHelper::IsDryRun()) return;
3405
3406 DIR *d;
3407 struct dirent *de;
3408
3409 if (header) printf("\n------ %s ------\n", header);
3410 func(0);
3411
3412 if (!(d = opendir("/data/system/users"))) {
3413 printf("Failed to open /data/system/users (%s)\n", strerror(errno));
3414 return;
3415 }
3416
3417 while ((de = readdir(d))) {
3418 int userid;
3419 if (de->d_type != DT_DIR || !(userid = atoi(de->d_name))) {
3420 continue;
3421 }
3422 func(userid);
3423 }
3424
3425 closedir(d);
3426}
3427
3428static void __for_each_pid(void (*helper)(int, const char *, void *), const char *header, void *arg) {
3429 DIR *d;
3430 struct dirent *de;
3431
3432 if (!(d = opendir("/proc"))) {
3433 printf("Failed to open /proc (%s)\n", strerror(errno));
3434 return;
3435 }
3436
3437 if (header) printf("\n------ %s ------\n", header);
3438 while ((de = readdir(d))) {
3439 if (ds.IsUserConsentDenied()) {
3440 MYLOGE(
3441 "Returning early because user denied consent to share bugreport with calling app.");
3442 closedir(d);
3443 return;
3444 }
3445 int pid;
3446 int fd;
3447 char cmdpath[255];
3448 char cmdline[255];
3449
3450 if (!(pid = atoi(de->d_name))) {
3451 continue;
3452 }
3453
3454 memset(cmdline, 0, sizeof(cmdline));
3455
3456 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/cmdline", pid);
3457 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3458 TEMP_FAILURE_RETRY(read(fd, cmdline, sizeof(cmdline) - 2));
3459 close(fd);
3460 if (cmdline[0]) {
3461 helper(pid, cmdline, arg);
3462 continue;
3463 }
3464 }
3465
3466 // if no cmdline, a kernel thread has comm
3467 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/comm", pid);
3468 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3469 TEMP_FAILURE_RETRY(read(fd, cmdline + 1, sizeof(cmdline) - 4));
3470 close(fd);
3471 if (cmdline[1]) {
3472 cmdline[0] = '[';
3473 size_t len = strcspn(cmdline, "\f\b\r\n");
3474 cmdline[len] = ']';
3475 cmdline[len+1] = '\0';
3476 }
3477 }
3478 if (!cmdline[0]) {
3479 strcpy(cmdline, "N/A");
3480 }
3481 helper(pid, cmdline, arg);
3482 }
3483
3484 closedir(d);
3485}
3486
3487static void for_each_pid_helper(int pid, const char *cmdline, void *arg) {
3488 for_each_pid_func *func = (for_each_pid_func*) arg;
3489 func(pid, cmdline);
3490}
3491
3492void for_each_pid(for_each_pid_func func, const char *header) {
3493 std::string title = header == nullptr ? "for_each_pid"
3494 : android::base::StringPrintf("for_each_pid(%s)", header);
3495 DurationReporter duration_reporter(title);
3496 if (PropertiesHelper::IsDryRun()) return;
3497
3498 __for_each_pid(for_each_pid_helper, header, (void *) func);
3499}
3500
3501static void for_each_tid_helper(int pid, const char *cmdline, void *arg) {
3502 DIR *d;
3503 struct dirent *de;
3504 char taskpath[255];
3505 for_each_tid_func *func = (for_each_tid_func *) arg;
3506
3507 snprintf(taskpath, sizeof(taskpath), "/proc/%d/task", pid);
3508
3509 if (!(d = opendir(taskpath))) {
3510 printf("Failed to open %s (%s)\n", taskpath, strerror(errno));
3511 return;
3512 }
3513
3514 func(pid, pid, cmdline);
3515
3516 while ((de = readdir(d))) {
3517 if (ds.IsUserConsentDenied()) {
3518 MYLOGE(
3519 "Returning early because user denied consent to share bugreport with calling app.");
3520 closedir(d);
3521 return;
3522 }
3523 int tid;
3524 int fd;
3525 char commpath[255];
3526 char comm[255];
3527
3528 if (!(tid = atoi(de->d_name))) {
3529 continue;
3530 }
3531
3532 if (tid == pid)
3533 continue;
3534
3535 snprintf(commpath, sizeof(commpath), "/proc/%d/comm", tid);
3536 memset(comm, 0, sizeof(comm));
3537 if ((fd = TEMP_FAILURE_RETRY(open(commpath, O_RDONLY | O_CLOEXEC))) < 0) {
3538 strcpy(comm, "N/A");
3539 } else {
3540 char *c;
3541 TEMP_FAILURE_RETRY(read(fd, comm, sizeof(comm) - 2));
3542 close(fd);
3543
3544 c = strrchr(comm, '\n');
3545 if (c) {
3546 *c = '\0';
3547 }
3548 }
3549 func(pid, tid, comm);
3550 }
3551
3552 closedir(d);
3553}
3554
3555void for_each_tid(for_each_tid_func func, const char *header) {
3556 std::string title = header == nullptr ? "for_each_tid"
3557 : android::base::StringPrintf("for_each_tid(%s)", header);
3558 DurationReporter duration_reporter(title);
3559
3560 if (PropertiesHelper::IsDryRun()) return;
3561
3562 __for_each_pid(for_each_tid_helper, header, (void *) func);
3563}
3564
3565void show_wchan(int pid, int tid, const char *name) {
3566 if (PropertiesHelper::IsDryRun()) return;
3567
3568 char path[255];
3569 char buffer[255];
3570 int fd, ret, save_errno;
3571 char name_buffer[255];
3572
3573 memset(buffer, 0, sizeof(buffer));
3574
3575 snprintf(path, sizeof(path), "/proc/%d/wchan", tid);
3576 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3577 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3578 return;
3579 }
3580
3581 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3582 save_errno = errno;
3583 close(fd);
3584
3585 if (ret < 0) {
3586 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3587 return;
3588 }
3589
3590 snprintf(name_buffer, sizeof(name_buffer), "%*s%s",
3591 pid == tid ? 0 : 3, "", name);
3592
3593 printf("%-7d %-32s %s\n", tid, name_buffer, buffer);
3594
3595 return;
3596}
3597
3598// print time in centiseconds
3599static void snprcent(char *buffer, size_t len, size_t spc,
3600 unsigned long long time) {
3601 static long hz; // cache discovered hz
3602
3603 if (hz <= 0) {
3604 hz = sysconf(_SC_CLK_TCK);
3605 if (hz <= 0) {
3606 hz = 1000;
3607 }
3608 }
3609
3610 // convert to centiseconds
3611 time = (time * 100 + (hz / 2)) / hz;
3612
3613 char str[16];
3614
3615 snprintf(str, sizeof(str), " %llu.%02u",
3616 time / 100, (unsigned)(time % 100));
3617 size_t offset = strlen(buffer);
3618 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3619 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3620}
3621
3622// print permille as a percent
3623static void snprdec(char *buffer, size_t len, size_t spc, unsigned permille) {
3624 char str[16];
3625
3626 snprintf(str, sizeof(str), " %u.%u%%", permille / 10, permille % 10);
3627 size_t offset = strlen(buffer);
3628 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3629 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3630}
3631
3632void show_showtime(int pid, const char *name) {
3633 if (PropertiesHelper::IsDryRun()) return;
3634
3635 char path[255];
3636 char buffer[1023];
3637 int fd, ret, save_errno;
3638
3639 memset(buffer, 0, sizeof(buffer));
3640
3641 snprintf(path, sizeof(path), "/proc/%d/stat", pid);
3642 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3643 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3644 return;
3645 }
3646
3647 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3648 save_errno = errno;
3649 close(fd);
3650
3651 if (ret < 0) {
3652 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3653 return;
3654 }
3655
3656 // field 14 is utime
3657 // field 15 is stime
3658 // field 42 is iotime
3659 unsigned long long utime = 0, stime = 0, iotime = 0;
3660 if (sscanf(buffer,
3661 "%*u %*s %*s %*d %*d %*d %*d %*d %*d %*d %*d "
3662 "%*d %*d %llu %llu %*d %*d %*d %*d %*d %*d "
3663 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %*d "
3664 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %llu ",
3665 &utime, &stime, &iotime) != 3) {
3666 return;
3667 }
3668
3669 unsigned long long total = utime + stime;
3670 if (!total) {
3671 return;
3672 }
3673
3674 unsigned permille = (iotime * 1000 + (total / 2)) / total;
3675 if (permille > 1000) {
3676 permille = 1000;
3677 }
3678
3679 // try to beautify and stabilize columns at <80 characters
3680 snprintf(buffer, sizeof(buffer), "%-6d%s", pid, name);
3681 if ((name[0] != '[') || utime) {
3682 snprcent(buffer, sizeof(buffer), 57, utime);
3683 }
3684 snprcent(buffer, sizeof(buffer), 65, stime);
3685 if ((name[0] != '[') || iotime) {
3686 snprcent(buffer, sizeof(buffer), 73, iotime);
3687 }
3688 if (iotime) {
3689 snprdec(buffer, sizeof(buffer), 79, permille);
3690 }
3691 puts(buffer); // adds a trailing newline
3692
3693 return;
3694}
3695
3696void do_dmesg() {
3697 const char *title = "KERNEL LOG (dmesg)";
3698 DurationReporter duration_reporter(title);
3699 printf("------ %s ------\n", title);
3700
3701 if (PropertiesHelper::IsDryRun()) return;
3702
3703 /* Get size of kernel buffer */
3704 int size = klogctl(KLOG_SIZE_BUFFER, nullptr, 0);
3705 if (size <= 0) {
3706 printf("Unexpected klogctl return value: %d\n\n", size);
3707 return;
3708 }
3709 char *buf = (char *) malloc(size + 1);
3710 if (buf == nullptr) {
3711 printf("memory allocation failed\n\n");
3712 return;
3713 }
3714 int retval = klogctl(KLOG_READ_ALL, buf, size);
3715 if (retval < 0) {
3716 printf("klogctl failure\n\n");
3717 free(buf);
3718 return;
3719 }
3720 buf[retval] = '\0';
3721 printf("%s\n\n", buf);
3722 free(buf);
3723 return;
3724}
3725
3726void do_showmap(int pid, const char *name) {
3727 char title[255];
3728 char arg[255];
3729
3730 snprintf(title, sizeof(title), "SHOW MAP %d (%s)", pid, name);
3731 snprintf(arg, sizeof(arg), "%d", pid);
3732 RunCommand(title, {"showmap", "-q", arg}, CommandOptions::AS_ROOT);
3733}
3734
3735int Dumpstate::DumpFile(const std::string& title, const std::string& path) {
3736 DurationReporter duration_reporter(title);
3737
3738 int status = DumpFileToFd(STDOUT_FILENO, title, path);
3739
3740 UpdateProgress(WEIGHT_FILE);
3741
3742 return status;
3743}
3744
3745int read_file_as_long(const char *path, long int *output) {
3746 int fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC));
3747 if (fd < 0) {
3748 int err = errno;
3749 MYLOGE("Error opening file descriptor for %s: %s\n", path, strerror(err));
3750 return -1;
3751 }
3752 char buffer[50];
3753 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3754 if (bytes_read == -1) {
3755 MYLOGE("Error reading file %s: %s\n", path, strerror(errno));
3756 return -2;
3757 }
3758 if (bytes_read == 0) {
3759 MYLOGE("File %s is empty\n", path);
3760 return -3;
3761 }
3762 *output = atoi(buffer);
3763 return 0;
3764}
3765
3766/* calls skip to gate calling dump_from_fd recursively
3767 * in the specified directory. dump_from_fd defaults to
3768 * dump_file_from_fd above when set to NULL. skip defaults
3769 * to false when set to NULL. dump_from_fd will always be
3770 * called with title NULL.
3771 */
3772int dump_files(const std::string& title, const char* dir, bool (*skip)(const char* path),
3773 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
3774 DurationReporter duration_reporter(title);
3775 DIR *dirp;
3776 struct dirent *d;
3777 char *newpath = nullptr;
3778 const char *slash = "/";
3779 int retval = 0;
3780
3781 if (!title.empty()) {
3782 printf("------ %s (%s) ------\n", title.c_str(), dir);
3783 }
3784 if (PropertiesHelper::IsDryRun()) return 0;
3785
3786 if (dir[strlen(dir) - 1] == '/') {
3787 ++slash;
3788 }
3789 dirp = opendir(dir);
3790 if (dirp == nullptr) {
3791 retval = -errno;
3792 MYLOGE("%s: %s\n", dir, strerror(errno));
3793 return retval;
3794 }
3795
3796 if (!dump_from_fd) {
3797 dump_from_fd = dump_file_from_fd;
3798 }
3799 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
3800 if ((d->d_name[0] == '.')
3801 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
3802 || (d->d_name[1] == '\0'))) {
3803 continue;
3804 }
3805 asprintf(&newpath, "%s%s%s%s", dir, slash, d->d_name,
3806 (d->d_type == DT_DIR) ? "/" : "");
3807 if (!newpath) {
3808 retval = -errno;
3809 continue;
3810 }
3811 if (skip && (*skip)(newpath)) {
3812 continue;
3813 }
3814 if (d->d_type == DT_DIR) {
3815 int ret = dump_files("", newpath, skip, dump_from_fd);
3816 if (ret < 0) {
3817 retval = ret;
3818 }
3819 continue;
3820 }
3821 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(newpath, O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
3822 if (fd.get() < 0) {
3823 retval = -1;
3824 printf("*** %s: %s\n", newpath, strerror(errno));
3825 continue;
3826 }
3827 (*dump_from_fd)(nullptr, newpath, fd.get());
3828 }
3829 closedir(dirp);
3830 if (!title.empty()) {
3831 printf("\n");
3832 }
3833 return retval;
3834}
3835
3836/* fd must have been opened with the flag O_NONBLOCK. With this flag set,
3837 * it's possible to avoid issues where opening the file itself can get
3838 * stuck.
3839 */
3840int dump_file_from_fd(const char *title, const char *path, int fd) {
3841 if (PropertiesHelper::IsDryRun()) return 0;
3842
3843 int flags = fcntl(fd, F_GETFL);
3844 if (flags == -1) {
3845 printf("*** %s: failed to get flags on fd %d: %s\n", path, fd, strerror(errno));
3846 return -1;
3847 } else if (!(flags & O_NONBLOCK)) {
3848 printf("*** %s: fd must have O_NONBLOCK set.\n", path);
3849 return -1;
3850 }
3851 return DumpFileFromFdToFd(title, path, fd, STDOUT_FILENO, PropertiesHelper::IsDryRun());
3852}
3853
3854int Dumpstate::RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Rhed Jao4875aa62020-07-20 17:46:29 +08003855 const CommandOptions& options, bool verbose_duration, int out_fd) {
3856 DurationReporter duration_reporter(title, false /* logcat_only */,
3857 verbose_duration, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003858
Rhed Jao4875aa62020-07-20 17:46:29 +08003859 int status = RunCommandToFd(out_fd, title, full_command, options);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003860
3861 /* TODO: for now we're simplifying the progress calculation by using the
3862 * timeout as the weight. It's a good approximation for most cases, except when calling dumpsys,
3863 * where its weight should be much higher proportionally to its timeout.
3864 * Ideally, it should use a options.EstimatedDuration() instead...*/
3865 UpdateProgress(options.Timeout());
3866
3867 return status;
3868}
3869
3870void Dumpstate::RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsys_args,
Rhed Jao6b1ea2d2020-07-21 17:58:41 +08003871 const CommandOptions& options, long dumpsysTimeoutMs, int out_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003872 long timeout_ms = dumpsysTimeoutMs > 0 ? dumpsysTimeoutMs : options.TimeoutInMs();
3873 std::vector<std::string> dumpsys = {"/system/bin/dumpsys", "-T", std::to_string(timeout_ms)};
3874 dumpsys.insert(dumpsys.end(), dumpsys_args.begin(), dumpsys_args.end());
Rhed Jao6b1ea2d2020-07-21 17:58:41 +08003875 RunCommand(title, dumpsys, options, false, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003876}
3877
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003878static int open_socket(const char* service) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003879 int s = android_get_control_socket(service);
3880 if (s < 0) {
3881 MYLOGE("android_get_control_socket(%s): %s\n", service, strerror(errno));
3882 return -1;
3883 }
3884 fcntl(s, F_SETFD, FD_CLOEXEC);
3885
3886 // Set backlog to 0 to make sure that queue size will be minimum.
3887 // In Linux, because the minimum queue will be 1, connect() will be blocked
3888 // if the other clients already called connect() and the connection request was not accepted.
3889 if (listen(s, 0) < 0) {
3890 MYLOGE("listen(control socket): %s\n", strerror(errno));
3891 return -1;
3892 }
3893
3894 struct sockaddr addr;
3895 socklen_t alen = sizeof(addr);
Abhijeet Kaur2113cae2019-09-13 09:24:15 +01003896 int fd = accept4(s, &addr, &alen, SOCK_CLOEXEC);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003897
3898 // Close socket just after accept(), to make sure that connect() by client will get error
3899 // when the socket is used by the other services.
3900 // There is still a race condition possibility between accept and close, but there is no way
3901 // to close-on-accept atomically.
3902 // See detail; b/123306389#comment25
3903 close(s);
3904
3905 if (fd < 0) {
3906 MYLOGE("accept(control socket): %s\n", strerror(errno));
3907 return -1;
3908 }
3909
3910 return fd;
3911}
3912
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003913// TODO: should call is_valid_output_file and/or be merged into it.
3914void create_parent_dirs(const char *path) {
3915 char *chp = const_cast<char *> (path);
3916
3917 /* skip initial slash */
3918 if (chp[0] == '/')
3919 chp++;
3920
3921 /* create leading directories, if necessary */
3922 struct stat dir_stat;
3923 while (chp && chp[0]) {
3924 chp = strchr(chp, '/');
3925 if (chp) {
3926 *chp = 0;
3927 if (stat(path, &dir_stat) == -1 || !S_ISDIR(dir_stat.st_mode)) {
3928 MYLOGI("Creating directory %s\n", path);
3929 if (mkdir(path, 0770)) { /* drwxrwx--- */
3930 MYLOGE("Unable to create directory %s: %s\n", path, strerror(errno));
3931 } else if (chown(path, AID_SHELL, AID_SHELL)) {
3932 MYLOGE("Unable to change ownership of dir %s: %s\n", path, strerror(errno));
3933 }
3934 }
3935 *chp++ = '/';
3936 }
3937 }
3938}
3939
3940bool _redirect_to_file(FILE* redirect, char* path, int truncate_flag) {
3941 create_parent_dirs(path);
3942
3943 int fd = TEMP_FAILURE_RETRY(open(path,
3944 O_WRONLY | O_CREAT | truncate_flag | O_CLOEXEC | O_NOFOLLOW,
3945 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH));
3946 if (fd < 0) {
3947 MYLOGE("%s: %s\n", path, strerror(errno));
3948 return false;
3949 }
3950
3951 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
3952 close(fd);
3953 return true;
3954}
3955
3956bool redirect_to_file(FILE* redirect, char* path) {
3957 return _redirect_to_file(redirect, path, O_TRUNC);
3958}
3959
3960bool redirect_to_existing_file(FILE* redirect, char* path) {
3961 return _redirect_to_file(redirect, path, O_APPEND);
3962}
3963
3964void dump_route_tables() {
3965 DurationReporter duration_reporter("DUMP ROUTE TABLES");
3966 if (PropertiesHelper::IsDryRun()) return;
3967 const char* const RT_TABLES_PATH = "/data/misc/net/rt_tables";
3968 ds.DumpFile("RT_TABLES", RT_TABLES_PATH);
3969 FILE* fp = fopen(RT_TABLES_PATH, "re");
3970 if (!fp) {
3971 printf("*** %s: %s\n", RT_TABLES_PATH, strerror(errno));
3972 return;
3973 }
3974 char table[16];
3975 // Each line has an integer (the table number), a space, and a string (the table name). We only
3976 // need the table number. It's a 32-bit unsigned number, so max 10 chars. Skip the table name.
3977 // Add a fixed max limit so this doesn't go awry.
3978 for (int i = 0; i < 64 && fscanf(fp, " %10s %*s", table) == 1; ++i) {
3979 RunCommand("ROUTE TABLE IPv4", {"ip", "-4", "route", "show", "table", table});
3980 RunCommand("ROUTE TABLE IPv6", {"ip", "-6", "route", "show", "table", table});
3981 }
3982 fclose(fp);
3983}
3984
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003985void Dumpstate::UpdateProgress(int32_t delta_sec) {
3986 if (progress_ == nullptr) {
3987 MYLOGE("UpdateProgress: progress_ not set\n");
3988 return;
3989 }
Rhed Jao2cc4eec2020-07-21 15:42:55 +08003990 // This function updates progress related members of the dumpstate and reports
3991 // progress percentage to the bugreport client. Since it could be called by
3992 // different dump tasks at the same time if the parallel run is enabled, a
3993 // mutex lock is necessary here to synchronize the call.
3994 std::lock_guard<std::recursive_mutex> lock(mutex_);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003995
3996 // Always update progess so stats can be tuned...
Nandana Duttf02cd782019-06-14 14:25:13 +01003997 progress_->Inc(delta_sec);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003998
3999 // ...but only notifiy listeners when necessary.
4000 if (!options_->do_progress_updates) return;
4001
4002 int progress = progress_->Get();
4003 int max = progress_->GetMax();
Nandana Duttf02cd782019-06-14 14:25:13 +01004004 int percent = 100 * progress / max;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004005
Nandana Duttf02cd782019-06-14 14:25:13 +01004006 if (last_reported_percent_progress_ > 0 && percent <= last_reported_percent_progress_) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004007 return;
4008 }
Nandana Duttf02cd782019-06-14 14:25:13 +01004009 last_reported_percent_progress_ = percent;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004010
4011 if (control_socket_fd_ >= 0) {
4012 dprintf(control_socket_fd_, "PROGRESS:%d/%d\n", progress, max);
4013 fsync(control_socket_fd_);
4014 }
4015
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004016 if (listener_ != nullptr) {
Nandana Dutt235c6672019-11-14 15:22:32 +00004017 if (percent % 10 == 0) {
4018 // We don't want to spam logcat, so only log multiples of 10.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004019 MYLOGD("Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004020 } else {
4021 // stderr is ignored on normal invocations, but useful when calling
4022 // /system/bin/dumpstate directly for debuggging.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004023 fprintf(stderr, "Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004024 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004025
4026 listener_->onProgress(percent);
4027 }
4028}
4029
4030void Dumpstate::TakeScreenshot(const std::string& path) {
4031 const std::string& real_path = path.empty() ? screenshot_path_ : path;
4032 int status =
4033 RunCommand("", {"/system/bin/screencap", "-p", real_path},
4034 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
4035 if (status == 0) {
4036 MYLOGD("Screenshot saved on %s\n", real_path.c_str());
4037 } else {
4038 MYLOGE("Failed to take screenshot on %s\n", real_path.c_str());
4039 }
Paul Chang0d2aad72020-02-13 20:04:03 +08004040 if (listener_ != nullptr) {
4041 // Show a visual indication to indicate screenshot is taken via
4042 // IDumpstateListener.onScreenshotTaken()
4043 listener_->onScreenshotTaken(status == 0);
4044 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004045}
4046
4047bool is_dir(const char* pathname) {
4048 struct stat info;
4049 if (stat(pathname, &info) == -1) {
4050 return false;
4051 }
4052 return S_ISDIR(info.st_mode);
4053}
4054
4055time_t get_mtime(int fd, time_t default_mtime) {
4056 struct stat info;
4057 if (fstat(fd, &info) == -1) {
4058 return default_mtime;
4059 }
4060 return info.st_mtime;
4061}