blob: 59a7d8cd2d28deea1a6439e9bc5a46b0003017cd [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"
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700178
Narayan Kamath8f788292017-05-25 13:20:39 +0100179// TODO(narayan): Since this information has to be kept in sync
180// with tombstoned, we should just put it in a common header.
181//
182// File: system/core/debuggerd/tombstoned/tombstoned.cpp
Narayan Kamathbd863722017-06-01 18:50:12 +0100183static const std::string TOMBSTONE_DIR = "/data/tombstones/";
184static const std::string TOMBSTONE_FILE_PREFIX = "tombstone_";
185static const std::string ANR_DIR = "/data/anr/";
186static const std::string ANR_FILE_PREFIX = "anr_";
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700187
Felipe Lemee844a9d2016-09-21 15:01:39 -0700188// TODO: temporary variables and functions used during C++ refactoring
Nandana Dutt979388e2018-11-30 16:48:55 +0000189
Nandana Dutt5c390032019-03-12 10:52:56 +0000190#define RETURN_IF_USER_DENIED_CONSENT() \
191 if (ds.IsUserConsentDenied()) { \
192 MYLOGE("Returning early as user denied consent to share bugreport with calling app."); \
193 return Dumpstate::RunStatus::USER_CONSENT_DENIED; \
194 }
195
196// Runs func_ptr, but checks user consent before and after running it. Returns USER_CONSENT_DENIED
197// if consent is found to be denied.
198#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(func_ptr, ...) \
199 RETURN_IF_USER_DENIED_CONSENT(); \
200 func_ptr(__VA_ARGS__); \
201 RETURN_IF_USER_DENIED_CONSENT();
202
Rhed Jao1c855122020-07-16 17:37:39 +0800203// Runs func_ptr, and logs a duration report after it's finished.
204#define RUN_SLOW_FUNCTION_AND_LOG(log_title, func_ptr, ...) \
205 { \
206 DurationReporter duration_reporter_in_macro(log_title); \
207 func_ptr(__VA_ARGS__); \
208 }
209
210// Similar with RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK, an additional duration report
211// is output after a slow function is finished.
212#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(log_title, func_ptr, ...) \
213 RETURN_IF_USER_DENIED_CONSENT(); \
214 RUN_SLOW_FUNCTION_AND_LOG(log_title, func_ptr, __VA_ARGS__); \
215 RETURN_IF_USER_DENIED_CONSENT();
216
Rhed Jao4875aa62020-07-20 17:46:29 +0800217#define WAIT_TASK_WITH_CONSENT_CHECK(task_name, pool_ptr) \
218 RETURN_IF_USER_DENIED_CONSENT(); \
219 pool_ptr->waitForTask(task_name); \
220 RETURN_IF_USER_DENIED_CONSENT();
221
Sahana Raof35ed432019-07-12 10:47:52 +0100222static const char* WAKE_LOCK_NAME = "dumpstate_wakelock";
223
Rhed Jao1c855122020-07-16 17:37:39 +0800224// Names of parallel tasks, they are used for the DumpPool to identify the dump
225// task and the log title of the duration report.
226static const std::string DUMP_TRACES_TASK = "DUMP TRACES";
Rhed Jao4875aa62020-07-20 17:46:29 +0800227static const std::string DUMP_INCIDENT_REPORT_TASK = "INCIDENT REPORT";
228static const std::string DUMP_HALS_TASK = "DUMP HALS";
229static const std::string DUMP_BOARD_TASK = "dumpstate_board()";
Rhed Jao6b1ea2d2020-07-21 17:58:41 +0800230static const std::string DUMP_CHECKINS_TASK = "DUMP CHECKINS";
Rhed Jao1c855122020-07-16 17:37:39 +0800231
Nandana Dutt979388e2018-11-30 16:48:55 +0000232namespace android {
233namespace os {
234namespace {
235
236static int Open(std::string path, int flags, mode_t mode = 0) {
237 int fd = TEMP_FAILURE_RETRY(open(path.c_str(), flags, mode));
238 if (fd == -1) {
239 MYLOGE("open(%s, %s)\n", path.c_str(), strerror(errno));
240 }
241 return fd;
242}
243
mhasank2d75c442020-06-11 15:05:25 -0700244static int OpenForWrite(std::string path) {
245 return Open(path, O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
246 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH);
247}
Nandana Dutt979388e2018-11-30 16:48:55 +0000248
249static int OpenForRead(std::string path) {
250 return Open(path, O_RDONLY | O_CLOEXEC | O_NOFOLLOW);
251}
252
253bool CopyFile(int in_fd, int out_fd) {
254 char buf[4096];
255 ssize_t byte_count;
256 while ((byte_count = TEMP_FAILURE_RETRY(read(in_fd, buf, sizeof(buf)))) > 0) {
257 if (!android::base::WriteFully(out_fd, buf, byte_count)) {
258 return false;
259 }
260 }
261 return (byte_count != -1);
262}
263
264static bool CopyFileToFd(const std::string& input_file, int out_fd) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000265 MYLOGD("Going to copy file (%s) to %d\n", input_file.c_str(), out_fd);
Nandana Dutt979388e2018-11-30 16:48:55 +0000266
267 // Obtain a handle to the source file.
268 android::base::unique_fd in_fd(OpenForRead(input_file));
269 if (out_fd != -1 && in_fd.get() != -1) {
270 if (CopyFile(in_fd.get(), out_fd)) {
271 return true;
272 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000273 MYLOGE("Failed to copy file: %s\n", strerror(errno));
Nandana Dutt979388e2018-11-30 16:48:55 +0000274 }
275 return false;
276}
277
Nandana Duttd2f5f082019-01-18 17:13:52 +0000278static bool UnlinkAndLogOnError(const std::string& file) {
Nandana Dutt8ae16e62020-03-27 10:20:22 +0000279 if (file.empty()) {
280 return false;
281 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000282 if (unlink(file.c_str())) {
283 MYLOGE("Failed to unlink file (%s): %s\n", file.c_str(), strerror(errno));
Nandana Duttd2f5f082019-01-18 17:13:52 +0000284 return false;
285 }
286 return true;
287}
Nandana Dutt979388e2018-11-30 16:48:55 +0000288
Nikita Ioffea325a572019-05-16 19:49:47 +0100289int64_t GetModuleMetadataVersion() {
290 auto binder = defaultServiceManager()->getService(android::String16("package_native"));
291 if (binder == nullptr) {
292 MYLOGE("Failed to retrieve package_native service");
293 return 0L;
294 }
295 auto package_service = android::interface_cast<content::pm::IPackageManagerNative>(binder);
296 std::string package_name;
297 auto status = package_service->getModuleMetadataPackageName(&package_name);
298 if (!status.isOk()) {
299 MYLOGE("Failed to retrieve module metadata package name: %s", status.toString8().c_str());
300 return 0L;
301 }
Nandana Duttdb379fa2019-10-09 16:54:41 +0100302 MYLOGD("Module metadata package name: %s\n", package_name.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100303 int64_t version_code;
304 status = package_service->getVersionCodeForPackage(android::String16(package_name.c_str()),
305 &version_code);
306 if (!status.isOk()) {
307 MYLOGE("Failed to retrieve module metadata version: %s", status.toString8().c_str());
308 return 0L;
309 }
310 return version_code;
311}
312
mhasank2d75c442020-06-11 15:05:25 -0700313static bool PathExists(const std::string& path) {
314 struct stat sb;
315 return stat(path.c_str(), &sb) == 0;
316}
317
318static bool CopyFileToFile(const std::string& input_file, const std::string& output_file) {
319 if (input_file == output_file) {
320 MYLOGD("Skipping copying bugreport file since the destination is the same (%s)\n",
321 output_file.c_str());
322 return false;
323 }
324 else if (PathExists(output_file)) {
325 MYLOGD("Cannot overwrite an existing file (%s)\n", output_file.c_str());
326 return false;
327 }
328
329 MYLOGD("Going to copy bugreport file (%s) to %s\n", input_file.c_str(), output_file.c_str());
330 android::base::unique_fd out_fd(OpenForWrite(output_file));
331 return CopyFileToFd(input_file, out_fd.get());
332}
333
Nandana Dutt979388e2018-11-30 16:48:55 +0000334} // namespace
335} // namespace os
336} // namespace android
337
Felipe Leme678727a2016-09-21 17:22:11 -0700338static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
Felipe Lemebda15a02016-11-16 17:48:25 -0800339 const CommandOptions& options = Dumpstate::DEFAULT_DUMPSYS,
Rhed Jao6b1ea2d2020-07-21 17:58:41 +0800340 long dumpsysTimeoutMs = 0, int out_fd = STDOUT_FILENO) {
341 return ds.RunDumpsys(title, dumpsysArgs, options, dumpsysTimeoutMs, out_fd);
342}
343static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
344 int out_fd) {
345 return ds.RunDumpsys(title, dumpsysArgs, Dumpstate::DEFAULT_DUMPSYS, 0, out_fd);
Felipe Leme678727a2016-09-21 17:22:11 -0700346}
347static int DumpFile(const std::string& title, const std::string& path) {
348 return ds.DumpFile(title, path);
349}
Felipe Lemee82a27d2016-01-05 13:35:44 -0800350
Felipe Lemee844a9d2016-09-21 15:01:39 -0700351// Relative directory (inside the zip) for all files copied as-is into the bugreport.
352static const std::string ZIP_ROOT_DIR = "FS";
353
Vishnu Naire97d6122018-01-18 13:58:56 -0800354static const std::string kProtoPath = "proto/";
355static const std::string kProtoExt = ".proto";
Jie Song9fbfad02017-06-20 16:29:42 -0700356static const std::string kDumpstateBoardFiles[] = {
357 "dumpstate_board.txt",
Felipe Leme95d6ca52017-08-01 16:35:56 -0700358 "dumpstate_board.bin"
Jie Song9fbfad02017-06-20 16:29:42 -0700359};
360static const int NUM_OF_DUMPS = arraysize(kDumpstateBoardFiles);
361
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700362static constexpr char PROPERTY_LAST_ID[] = "dumpstate.last_id";
Felipe Lemed071c682016-10-20 16:48:00 -0700363static constexpr char PROPERTY_VERSION[] = "dumpstate.version";
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700364
Felipe Lemef0292972016-11-22 13:57:05 -0800365static const CommandOptions AS_ROOT_20 = CommandOptions::WithTimeout(20).AsRoot().Build();
366
Narayan Kamath8f788292017-05-25 13:20:39 +0100367/*
Narayan Kamathbd863722017-06-01 18:50:12 +0100368 * Returns a vector of dump fds under |dir_path| with a given |file_prefix|.
Rhed Jao01dc0c62020-06-03 17:13:30 +0800369 * The returned vector is sorted by the mtimes of the dumps with descending
370 * order. If |limit_by_mtime| is set, the vector only contains files that
371 * were written in the last 30 minutes.
Narayan Kamath8f788292017-05-25 13:20:39 +0100372 */
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700373static std::vector<DumpData> GetDumpFds(const std::string& dir_path,
374 const std::string& file_prefix,
Elliott Hughesdb6d2112019-09-26 15:24:51 -0700375 bool limit_by_mtime) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100376 const time_t thirty_minutes_ago = ds.now_ - 60 * 30;
377
Narayan Kamathbd863722017-06-01 18:50:12 +0100378 std::unique_ptr<DIR, decltype(&closedir)> dump_dir(opendir(dir_path.c_str()), closedir);
Narayan Kamath8f788292017-05-25 13:20:39 +0100379
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700380 if (dump_dir == nullptr) {
381 MYLOGW("Unable to open directory %s: %s\n", dir_path.c_str(), strerror(errno));
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700382 return std::vector<DumpData>();
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700383 }
384
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700385 std::vector<DumpData> dump_data;
Narayan Kamathbd863722017-06-01 18:50:12 +0100386 struct dirent* entry = nullptr;
387 while ((entry = readdir(dump_dir.get()))) {
388 if (entry->d_type != DT_REG) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100389 continue;
390 }
391
Narayan Kamathbd863722017-06-01 18:50:12 +0100392 const std::string base_name(entry->d_name);
393 if (base_name.find(file_prefix) != 0) {
394 continue;
395 }
396
397 const std::string abs_path = dir_path + base_name;
398 android::base::unique_fd fd(
399 TEMP_FAILURE_RETRY(open(abs_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW | O_NONBLOCK)));
400 if (fd == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700401 MYLOGW("Unable to open dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamathbd863722017-06-01 18:50:12 +0100402 break;
403 }
404
405 struct stat st = {};
406 if (fstat(fd, &st) == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700407 MYLOGW("Unable to stat dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamath8f788292017-05-25 13:20:39 +0100408 continue;
409 }
410
Narayan Kamath3f31b632018-02-22 19:42:36 +0000411 if (limit_by_mtime && st.st_mtime < thirty_minutes_ago) {
Narayan Kamathbd863722017-06-01 18:50:12 +0100412 MYLOGI("Excluding stale dump file: %s\n", abs_path.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100413 continue;
414 }
415
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700416 dump_data.emplace_back(DumpData{abs_path, std::move(fd), st.st_mtime});
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700417 }
Rhed Jao01dc0c62020-06-03 17:13:30 +0800418 if (!dump_data.empty()) {
419 std::sort(dump_data.begin(), dump_data.end(),
420 [](const auto& a, const auto& b) { return a.mtime > b.mtime; });
421 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100422
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700423 return dump_data;
Narayan Kamath8f788292017-05-25 13:20:39 +0100424}
425
Narayan Kamathbd863722017-06-01 18:50:12 +0100426static bool AddDumps(const std::vector<DumpData>::const_iterator start,
427 const std::vector<DumpData>::const_iterator end,
428 const char* type_name, const bool add_to_zip) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100429 bool dumped = false;
Narayan Kamathbd863722017-06-01 18:50:12 +0100430 for (auto it = start; it != end; ++it) {
431 const std::string& name = it->name;
432 const int fd = it->fd;
Narayan Kamath8f788292017-05-25 13:20:39 +0100433 dumped = true;
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100434
435 // Seek to the beginning of the file before dumping any data. A given
436 // DumpData entry might be dumped multiple times in the report.
437 //
438 // For example, the most recent ANR entry is dumped to the body of the
439 // main entry and it also shows up as a separate entry in the bugreport
440 // ZIP file.
441 if (lseek(fd, 0, SEEK_SET) != static_cast<off_t>(0)) {
442 MYLOGE("Unable to add %s to zip file, lseek failed: %s\n", name.c_str(),
443 strerror(errno));
444 }
445
Narayan Kamath8f788292017-05-25 13:20:39 +0100446 if (ds.IsZipping() && add_to_zip) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800447 if (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + name, fd, /* timeout = */ 0ms) != OK) {
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100448 MYLOGE("Unable to add %s to zip file, addZipEntryFromFd failed\n", name.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100449 }
450 } else {
451 dump_file_from_fd(type_name, name.c_str(), fd);
452 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100453 }
454
455 return dumped;
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700456}
457
Felipe Leme635ca312016-01-05 14:23:02 -0800458// for_each_pid() callback to get mount info about a process.
Felipe Leme4c2d6632016-09-28 14:32:00 -0700459void do_mountinfo(int pid, const char* name __attribute__((unused))) {
Felipe Leme635ca312016-01-05 14:23:02 -0800460 char path[PATH_MAX];
461
462 // Gets the the content of the /proc/PID/ns/mnt link, so only unique mount points
463 // are added.
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700464 snprintf(path, sizeof(path), "/proc/%d/ns/mnt", pid);
Felipe Leme635ca312016-01-05 14:23:02 -0800465 char linkname[PATH_MAX];
466 ssize_t r = readlink(path, linkname, PATH_MAX);
467 if (r == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800468 MYLOGE("Unable to read link for %s: %s\n", path, strerror(errno));
Felipe Leme635ca312016-01-05 14:23:02 -0800469 return;
470 }
471 linkname[r] = '\0';
472
473 if (mount_points.find(linkname) == mount_points.end()) {
474 // First time this mount point was found: add it
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700475 snprintf(path, sizeof(path), "/proc/%d/mountinfo", pid);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700476 if (ds.AddZipEntry(ZIP_ROOT_DIR + path, path)) {
Felipe Leme635ca312016-01-05 14:23:02 -0800477 mount_points.insert(linkname);
478 } else {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800479 MYLOGE("Unable to add mountinfo %s to zip file\n", path);
Felipe Leme635ca312016-01-05 14:23:02 -0800480 }
481 }
482}
483
484void add_mountinfo() {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700485 if (!ds.IsZipping()) return;
Felipe Leme678727a2016-09-21 17:22:11 -0700486 std::string title = "MOUNT INFO";
Felipe Leme635ca312016-01-05 14:23:02 -0800487 mount_points.clear();
Felipe Leme46b85da2016-11-21 17:40:45 -0800488 DurationReporter duration_reporter(title, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700489 for_each_pid(do_mountinfo, nullptr);
490 MYLOGD("%s: %d entries added to zip file\n", title.c_str(), (int)mount_points.size());
Felipe Leme635ca312016-01-05 14:23:02 -0800491}
492
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700493static void dump_dev_files(const char *title, const char *driverpath, const char *filename)
494{
495 DIR *d;
496 struct dirent *de;
497 char path[PATH_MAX];
498
499 d = opendir(driverpath);
Yi Kong19d5c002018-07-20 13:39:55 -0700500 if (d == nullptr) {
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700501 return;
502 }
503
504 while ((de = readdir(d))) {
505 if (de->d_type != DT_LNK) {
506 continue;
507 }
508 snprintf(path, sizeof(path), "%s/%s/%s", driverpath, de->d_name, filename);
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700509 DumpFile(title, path);
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700510 }
511
512 closedir(d);
513}
514
Mark Salyzyn326842f2015-04-30 09:49:41 -0700515static bool skip_not_stat(const char *path) {
516 static const char stat[] = "/stat";
517 size_t len = strlen(path);
518 if (path[len - 1] == '/') { /* Directory? */
519 return false;
520 }
521 return strcmp(path + len - sizeof(stat) + 1, stat); /* .../stat? */
522}
523
Felipe Leme4c2d6632016-09-28 14:32:00 -0700524static bool skip_none(const char* path __attribute__((unused))) {
Felipe Lemee82a27d2016-01-05 13:35:44 -0800525 return false;
526}
527
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700528unsigned long worst_write_perf = 20000; /* in KB/s */
Mark Salyzyn326842f2015-04-30 09:49:41 -0700529
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800530//
531// stat offsets
532// Name units description
533// ---- ----- -----------
534// read I/Os requests number of read I/Os processed
535#define __STAT_READ_IOS 0
536// read merges requests number of read I/Os merged with in-queue I/O
537#define __STAT_READ_MERGES 1
538// read sectors sectors number of sectors read
539#define __STAT_READ_SECTORS 2
540// read ticks milliseconds total wait time for read requests
541#define __STAT_READ_TICKS 3
542// write I/Os requests number of write I/Os processed
543#define __STAT_WRITE_IOS 4
544// write merges requests number of write I/Os merged with in-queue I/O
545#define __STAT_WRITE_MERGES 5
546// write sectors sectors number of sectors written
547#define __STAT_WRITE_SECTORS 6
548// write ticks milliseconds total wait time for write requests
549#define __STAT_WRITE_TICKS 7
550// in_flight requests number of I/Os currently in flight
551#define __STAT_IN_FLIGHT 8
552// io_ticks milliseconds total time this block device has been active
553#define __STAT_IO_TICKS 9
554// time_in_queue milliseconds total wait time for all requests
555#define __STAT_IN_QUEUE 10
556#define __STAT_NUMBER_FIELD 11
557//
558// read I/Os, write I/Os
559// =====================
560//
561// These values increment when an I/O request completes.
562//
563// read merges, write merges
564// =========================
565//
566// These values increment when an I/O request is merged with an
567// already-queued I/O request.
568//
569// read sectors, write sectors
570// ===========================
571//
572// These values count the number of sectors read from or written to this
573// block device. The "sectors" in question are the standard UNIX 512-byte
574// sectors, not any device- or filesystem-specific block size. The
575// counters are incremented when the I/O completes.
576#define SECTOR_SIZE 512
577//
578// read ticks, write ticks
579// =======================
580//
581// These values count the number of milliseconds that I/O requests have
582// waited on this block device. If there are multiple I/O requests waiting,
583// these values will increase at a rate greater than 1000/second; for
584// example, if 60 read requests wait for an average of 30 ms, the read_ticks
585// field will increase by 60*30 = 1800.
586//
587// in_flight
588// =========
589//
590// This value counts the number of I/O requests that have been issued to
591// the device driver but have not yet completed. It does not include I/O
592// requests that are in the queue but not yet issued to the device driver.
593//
594// io_ticks
595// ========
596//
597// This value counts the number of milliseconds during which the device has
598// had I/O requests queued.
599//
600// time_in_queue
601// =============
602//
603// This value counts the number of milliseconds that I/O requests have waited
604// on this block device. If there are multiple I/O requests waiting, this
605// value will increase as the product of the number of milliseconds times the
606// number of requests waiting (see "read ticks" above for an example).
607#define S_TO_MS 1000
608//
609
Mark Salyzyn326842f2015-04-30 09:49:41 -0700610static int dump_stat_from_fd(const char *title __unused, const char *path, int fd) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800611 unsigned long long fields[__STAT_NUMBER_FIELD];
Mark Salyzyn326842f2015-04-30 09:49:41 -0700612 bool z;
Yi Kong19d5c002018-07-20 13:39:55 -0700613 char *cp, *buffer = nullptr;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700614 size_t i = 0;
Josh Gao7c4258c2018-06-25 13:40:08 -0700615 FILE *fp = fdopen(dup(fd), "rb");
Mark Salyzyn326842f2015-04-30 09:49:41 -0700616 getline(&buffer, &i, fp);
617 fclose(fp);
618 if (!buffer) {
619 return -errno;
620 }
621 i = strlen(buffer);
622 while ((i > 0) && (buffer[i - 1] == '\n')) {
623 buffer[--i] = '\0';
624 }
625 if (!*buffer) {
626 free(buffer);
627 return 0;
628 }
629 z = true;
630 for (cp = buffer, i = 0; i < (sizeof(fields) / sizeof(fields[0])); ++i) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800631 fields[i] = strtoull(cp, &cp, 10);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700632 if (fields[i] != 0) {
633 z = false;
634 }
635 }
636 if (z) { /* never accessed */
637 free(buffer);
638 return 0;
639 }
640
Wei Wang509bb5d2017-06-09 14:42:12 -0700641 if (!strncmp(path, BLK_DEV_SYS_DIR, sizeof(BLK_DEV_SYS_DIR) - 1)) {
642 path += sizeof(BLK_DEV_SYS_DIR) - 1;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700643 }
Wei Wang1dc1ef52017-06-12 11:28:37 -0700644
645 printf("%-30s:%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s\n%-30s:\t%s\n", "Block-Dev",
646 "R-IOs", "R-merg", "R-sect", "R-wait", "W-IOs", "W-merg", "W-sect",
647 "W-wait", "in-fli", "activ", "T-wait", path, buffer);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700648 free(buffer);
649
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800650 if (fields[__STAT_IO_TICKS]) {
651 unsigned long read_perf = 0;
652 unsigned long read_ios = 0;
653 if (fields[__STAT_READ_TICKS]) {
654 unsigned long long divisor = fields[__STAT_READ_TICKS]
655 * fields[__STAT_IO_TICKS];
656 read_perf = ((unsigned long long)SECTOR_SIZE
657 * fields[__STAT_READ_SECTORS]
658 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
659 / divisor;
660 read_ios = ((unsigned long long)S_TO_MS * fields[__STAT_READ_IOS]
661 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
662 / divisor;
663 }
664
665 unsigned long write_perf = 0;
666 unsigned long write_ios = 0;
667 if (fields[__STAT_WRITE_TICKS]) {
668 unsigned long long divisor = fields[__STAT_WRITE_TICKS]
669 * fields[__STAT_IO_TICKS];
670 write_perf = ((unsigned long long)SECTOR_SIZE
671 * fields[__STAT_WRITE_SECTORS]
672 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
673 / divisor;
674 write_ios = ((unsigned long long)S_TO_MS * fields[__STAT_WRITE_IOS]
675 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
676 / divisor;
677 }
678
679 unsigned queue = (fields[__STAT_IN_QUEUE]
680 + (fields[__STAT_IO_TICKS] >> 1))
681 / fields[__STAT_IO_TICKS];
682
683 if (!write_perf && !write_ios) {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700684 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 -0800685 } else {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700686 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 -0800687 read_ios, write_perf, write_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800688 }
689
690 /* bugreport timeout factor adjustment */
691 if ((write_perf > 1) && (write_perf < worst_write_perf)) {
692 worst_write_perf = write_perf;
693 }
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700694 }
Mark Salyzyn326842f2015-04-30 09:49:41 -0700695 return 0;
696}
697
Yao Chenbe3bbc12018-01-17 16:31:10 -0800698static const long MINIMUM_LOGCAT_TIMEOUT_MS = 50000;
699
Tom Cherryf4472f32020-08-05 09:31:17 -0700700// Returns the actual readable size of the given buffer or -1 on error.
701static long logcat_buffer_readable_size(const std::string& buffer) {
702 std::unique_ptr<logger_list, decltype(&android_logger_list_free)> logger_list{
703 android_logger_list_alloc(0, 0, 0), &android_logger_list_free};
704 auto logger = android_logger_open(logger_list.get(), android_name_to_log_id(buffer.c_str()));
705
706 return android_logger_get_log_readable_size(logger);
707}
708
709// Returns timeout in ms to read a list of buffers.
Yao Chenbe3bbc12018-01-17 16:31:10 -0800710static unsigned long logcat_timeout(const std::vector<std::string>& buffers) {
711 unsigned long timeout_ms = 0;
712 for (const auto& buffer : buffers) {
Tom Cherryf4472f32020-08-05 09:31:17 -0700713 long readable_size = logcat_buffer_readable_size(buffer);
714 if (readable_size > 0) {
715 // Engineering margin is ten-fold our guess.
716 timeout_ms += 10 * (readable_size + worst_write_perf) / worst_write_perf;
717 }
Yao Chenbe3bbc12018-01-17 16:31:10 -0800718 }
719 return timeout_ms > MINIMUM_LOGCAT_TIMEOUT_MS ? timeout_ms : MINIMUM_LOGCAT_TIMEOUT_MS;
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700720}
721
Dieter Hsu105ad0c2020-09-29 15:23:33 +0800722// Opens a socket and returns its file descriptor.
723static int open_socket(const char* service);
724
Nandana Duttd2f5f082019-01-18 17:13:52 +0000725Dumpstate::ConsentCallback::ConsentCallback() : result_(UNAVAILABLE), start_time_(Nanotime()) {
726}
727
728android::binder::Status Dumpstate::ConsentCallback::onReportApproved() {
729 std::lock_guard<std::mutex> lock(lock_);
730 result_ = APPROVED;
731 MYLOGD("User approved consent to share bugreport\n");
Paul Chang0d2aad72020-02-13 20:04:03 +0800732
733 // Maybe copy screenshot so calling app can display the screenshot to the user as soon as
734 // consent is granted.
735 if (ds.options_->is_screenshot_copied) {
736 return android::binder::Status::ok();
737 }
738
739 if (!ds.options_->do_screenshot || ds.options_->screenshot_fd.get() == -1 ||
740 !ds.do_early_screenshot_) {
741 return android::binder::Status::ok();
742 }
743
744 bool copy_succeeded = android::os::CopyFileToFd(ds.screenshot_path_,
745 ds.options_->screenshot_fd.get());
746 ds.options_->is_screenshot_copied = copy_succeeded;
747 if (copy_succeeded) {
748 android::os::UnlinkAndLogOnError(ds.screenshot_path_);
749 }
Nandana Duttd2f5f082019-01-18 17:13:52 +0000750 return android::binder::Status::ok();
751}
752
753android::binder::Status Dumpstate::ConsentCallback::onReportDenied() {
754 std::lock_guard<std::mutex> lock(lock_);
755 result_ = DENIED;
756 MYLOGW("User denied consent to share bugreport\n");
757 return android::binder::Status::ok();
758}
759
760UserConsentResult Dumpstate::ConsentCallback::getResult() {
761 std::lock_guard<std::mutex> lock(lock_);
762 return result_;
763}
764
765uint64_t Dumpstate::ConsentCallback::getElapsedTimeMs() const {
Hunter Knepshieldf0a39052020-01-03 14:53:04 -0800766 return (Nanotime() - start_time_) / NANOS_PER_MILLI;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000767}
768
Felipe Leme2b9b06c2016-10-14 09:13:06 -0700769void Dumpstate::PrintHeader() const {
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700770 std::string build, fingerprint, radio, bootloader, network;
771 char date[80];
Colin Crossf45fa6b2012-03-26 12:38:26 -0700772
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700773 build = android::base::GetProperty("ro.build.display.id", "(unknown)");
774 fingerprint = android::base::GetProperty("ro.build.fingerprint", "(unknown)");
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700775 radio = android::base::GetProperty("gsm.version.baseband", "(unknown)");
776 bootloader = android::base::GetProperty("ro.bootloader", "(unknown)");
777 network = android::base::GetProperty("gsm.operator.alpha", "(unknown)");
Felipe Lemebbaf3c12016-10-11 14:32:25 -0700778 strftime(date, sizeof(date), "%Y-%m-%d %H:%M:%S", localtime(&now_));
Colin Crossf45fa6b2012-03-26 12:38:26 -0700779
Felipe Lemed8b94e52016-12-08 10:21:44 -0800780 printf("========================================================\n");
781 printf("== dumpstate: %s\n", date);
782 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -0700783
Felipe Lemed8b94e52016-12-08 10:21:44 -0800784 printf("\n");
785 printf("Build: %s\n", build.c_str());
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700786 // NOTE: fingerprint entry format is important for other tools.
Felipe Lemed8b94e52016-12-08 10:21:44 -0800787 printf("Build fingerprint: '%s'\n", fingerprint.c_str());
788 printf("Bootloader: %s\n", bootloader.c_str());
789 printf("Radio: %s\n", radio.c_str());
790 printf("Network: %s\n", network.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100791 int64_t module_metadata_version = android::os::GetModuleMetadataVersion();
792 if (module_metadata_version != 0) {
793 printf("Module Metadata version: %" PRId64 "\n", module_metadata_version);
794 }
Colin Crossf45fa6b2012-03-26 12:38:26 -0700795
Felipe Lemed8b94e52016-12-08 10:21:44 -0800796 printf("Kernel: ");
Felipe Lemef0292972016-11-22 13:57:05 -0800797 DumpFileToFd(STDOUT_FILENO, "", "/proc/version");
Felipe Lemed8b94e52016-12-08 10:21:44 -0800798 printf("Command line: %s\n", strtok(cmdline_buf, "\n"));
Felipe Leme7709f8a2017-12-05 09:30:09 -0800799 printf("Uptime: ");
800 RunCommandToFd(STDOUT_FILENO, "", {"uptime", "-p"},
801 CommandOptions::WithTimeout(1).Always().Build());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800802 printf("Bugreport format version: %s\n", version_.c_str());
Rhed Jao1c855122020-07-16 17:37:39 +0800803 printf("Dumpstate info: id=%d pid=%d dry_run=%d parallel_run=%d args=%s bugreport_mode=%s\n",
804 id_, pid_, PropertiesHelper::IsDryRun(), PropertiesHelper::IsParallelRun(),
805 options_->args.c_str(), options_->bugreport_mode.c_str());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800806 printf("\n");
Felipe Leme78f2c862015-12-21 09:55:22 -0800807}
808
Felipe Leme24b66ee2016-06-16 10:55:26 -0700809// List of file extensions that can cause a zip file attachment to be rejected by some email
810// service providers.
811static const std::set<std::string> PROBLEMATIC_FILE_EXTENSIONS = {
812 ".ade", ".adp", ".bat", ".chm", ".cmd", ".com", ".cpl", ".exe", ".hta", ".ins", ".isp",
813 ".jar", ".jse", ".lib", ".lnk", ".mde", ".msc", ".msp", ".mst", ".pif", ".scr", ".sct",
814 ".shb", ".sys", ".vb", ".vbe", ".vbs", ".vxd", ".wsc", ".wsf", ".wsh"
815};
816
Vishnu Naire97d6122018-01-18 13:58:56 -0800817status_t Dumpstate::AddZipEntryFromFd(const std::string& entry_name, int fd,
818 std::chrono::milliseconds timeout = 0ms) {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700819 if (!IsZipping()) {
820 MYLOGD("Not adding zip entry %s from fd because it's not a zipped bugreport\n",
821 entry_name.c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -0800822 return INVALID_OPERATION;
Felipe Leme111b9d02016-02-03 09:28:24 -0800823 }
Felipe Leme24b66ee2016-06-16 10:55:26 -0700824 std::string valid_name = entry_name;
825
826 // Rename extension if necessary.
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -0700827 size_t idx = entry_name.rfind('.');
Felipe Leme24b66ee2016-06-16 10:55:26 -0700828 if (idx != std::string::npos) {
829 std::string extension = entry_name.substr(idx);
830 std::transform(extension.begin(), extension.end(), extension.begin(), ::tolower);
831 if (PROBLEMATIC_FILE_EXTENSIONS.count(extension) != 0) {
832 valid_name = entry_name + ".renamed";
833 MYLOGI("Renaming entry %s to %s\n", entry_name.c_str(), valid_name.c_str());
834 }
835 }
836
Felipe Leme6fe9db62016-02-12 09:04:16 -0800837 // Logging statement below is useful to time how long each entry takes, but it's too verbose.
838 // MYLOGD("Adding zip entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700839 int32_t err = zip_writer_->StartEntryWithTime(valid_name.c_str(), ZipWriter::kCompress,
840 get_mtime(fd, ds.now_));
Felipe Leme1d486fe2016-10-14 18:06:47 -0700841 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700842 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", valid_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700843 ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800844 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800845 }
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000846 bool finished_entry = false;
847 auto finish_entry = [this, &finished_entry] {
848 if (!finished_entry) {
849 // This should only be called when we're going to return an earlier error,
850 // which would've been logged. This may imply the file is already corrupt
851 // and any further logging from FinishEntry is more likely to mislead than
852 // not.
853 this->zip_writer_->FinishEntry();
854 }
855 };
856 auto scope_guard = android::base::make_scope_guard(finish_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -0800857 auto start = std::chrono::steady_clock::now();
858 auto end = start + timeout;
859 struct pollfd pfd = {fd, POLLIN};
Felipe Lemee82a27d2016-01-05 13:35:44 -0800860
Felipe Leme770410d2016-01-26 17:07:14 -0800861 std::vector<uint8_t> buffer(65536);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800862 while (1) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800863 if (timeout.count() > 0) {
864 // lambda to recalculate the timeout.
865 auto time_left_ms = [end]() {
866 auto now = std::chrono::steady_clock::now();
867 auto diff = std::chrono::duration_cast<std::chrono::milliseconds>(end - now);
868 return std::max(diff.count(), 0LL);
869 };
870
871 int rc = TEMP_FAILURE_RETRY(poll(&pfd, 1, time_left_ms()));
872 if (rc < 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000873 MYLOGE("Error in poll while adding from fd to zip entry %s:%s\n",
874 entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800875 return -errno;
876 } else if (rc == 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000877 MYLOGE("Timed out adding from fd to zip entry %s:%s Timeout:%lldms\n",
Vishnu Naire97d6122018-01-18 13:58:56 -0800878 entry_name.c_str(), strerror(errno), timeout.count());
879 return TIMED_OUT;
880 }
881 }
882
Zach Riggle22200402016-08-18 01:01:24 -0400883 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800884 if (bytes_read == 0) {
885 break;
886 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800887 MYLOGE("read(%s): %s\n", entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800888 return -errno;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800889 }
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700890 err = zip_writer_->WriteBytes(buffer.data(), bytes_read);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800891 if (err) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700892 MYLOGE("zip_writer_->WriteBytes(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800893 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800894 }
895 }
896
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700897 err = zip_writer_->FinishEntry();
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000898 finished_entry = true;
Felipe Leme1d486fe2016-10-14 18:06:47 -0700899 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700900 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800901 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800902 }
903
Vishnu Naire97d6122018-01-18 13:58:56 -0800904 return OK;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800905}
906
Felipe Leme1d486fe2016-10-14 18:06:47 -0700907bool Dumpstate::AddZipEntry(const std::string& entry_name, const std::string& entry_path) {
908 android::base::unique_fd fd(
909 TEMP_FAILURE_RETRY(open(entry_path.c_str(), O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
Andreas Gampeaff68432016-07-18 18:01:27 -0700910 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800911 MYLOGE("open(%s): %s\n", entry_path.c_str(), strerror(errno));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800912 return false;
913 }
914
Vishnu Naire97d6122018-01-18 13:58:56 -0800915 return (AddZipEntryFromFd(entry_name, fd.get()) == OK);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800916}
917
918/* adds a file to the existing zipped bugreport */
Felipe Leme4c2d6632016-09-28 14:32:00 -0700919static int _add_file_from_fd(const char* title __attribute__((unused)), const char* path, int fd) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800920 return (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + path, fd) == OK) ? 0 : 1;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800921}
922
Felipe Leme1d486fe2016-10-14 18:06:47 -0700923void Dumpstate::AddDir(const std::string& dir, bool recursive) {
924 if (!IsZipping()) {
925 MYLOGD("Not adding dir %s because it's not a zipped bugreport\n", dir.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800926 return;
927 }
Felipe Leme678727a2016-09-21 17:22:11 -0700928 MYLOGD("Adding dir %s (recursive: %d)\n", dir.c_str(), recursive);
Felipe Leme46b85da2016-11-21 17:40:45 -0800929 DurationReporter duration_reporter(dir, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700930 dump_files("", dir.c_str(), recursive ? skip_none : is_dir, _add_file_from_fd);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800931}
932
Felipe Leme1d486fe2016-10-14 18:06:47 -0700933bool Dumpstate::AddTextZipEntry(const std::string& entry_name, const std::string& content) {
934 if (!IsZipping()) {
935 MYLOGD("Not adding text zip entry %s because it's not a zipped bugreport\n",
936 entry_name.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800937 return false;
938 }
Felipe Lemecbce55d2016-02-08 09:53:18 -0800939 MYLOGD("Adding zip text entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700940 int32_t err = zip_writer_->StartEntryWithTime(entry_name.c_str(), ZipWriter::kCompress, ds.now_);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700941 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700942 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700943 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800944 return false;
945 }
946
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700947 err = zip_writer_->WriteBytes(content.c_str(), content.length());
Felipe Leme1d486fe2016-10-14 18:06:47 -0700948 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700949 MYLOGE("zip_writer_->WriteBytes(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700950 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800951 return false;
952 }
953
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700954 err = zip_writer_->FinishEntry();
Felipe Leme1d486fe2016-10-14 18:06:47 -0700955 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700956 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800957 return false;
958 }
959
960 return true;
961}
962
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800963static void DoKmsg() {
964 struct stat st;
965 if (!stat(PSTORE_LAST_KMSG, &st)) {
966 /* Also TODO: Make console-ramoops CAP_SYSLOG protected. */
967 DumpFile("LAST KMSG", PSTORE_LAST_KMSG);
968 } else if (!stat(ALT_PSTORE_LAST_KMSG, &st)) {
969 DumpFile("LAST KMSG", ALT_PSTORE_LAST_KMSG);
970 } else {
971 /* TODO: Make last_kmsg CAP_SYSLOG protected. b/5555691 */
972 DumpFile("LAST KMSG", "/proc/last_kmsg");
973 }
974}
975
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800976static void DoKernelLogcat() {
Yao Chenbe3bbc12018-01-17 16:31:10 -0800977 unsigned long timeout_ms = logcat_timeout({"kernel"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800978 RunCommand(
979 "KERNEL LOG",
980 {"logcat", "-b", "kernel", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
981 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
982}
983
Nandana Duttdb379fa2019-10-09 16:54:41 +0100984static void DoSystemLogcat(time_t since) {
985 char since_str[80];
986 strftime(since_str, sizeof(since_str), "%Y-%m-%d %H:%M:%S.000", localtime(&since));
987
988 unsigned long timeout_ms = logcat_timeout({"main", "system", "crash"});
989 RunCommand("SYSTEM LOG",
990 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v", "-T",
991 since_str},
992 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
993}
994
Hunter Knepshield820f9bc2020-02-05 20:10:53 -0800995static void DoRadioLogcat() {
996 unsigned long timeout_ms = logcat_timeout({"radio"});
997 RunCommand(
998 "RADIO LOG",
999 {"logcat", "-b", "radio", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1000 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
1001}
1002
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001003static void DoLogcat() {
Vishnu Nair6921f802017-11-22 09:17:23 -08001004 unsigned long timeout_ms;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001005 // DumpFile("EVENT LOG TAGS", "/etc/event-log-tags");
1006 // calculate timeout
Yao Chenbe3bbc12018-01-17 16:31:10 -08001007 timeout_ms = logcat_timeout({"main", "system", "crash"});
Tony Makae737652017-03-30 17:47:09 +01001008 RunCommand("SYSTEM LOG",
Vishnu Nair6921f802017-11-22 09:17:23 -08001009 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1010 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -08001011 timeout_ms = logcat_timeout({"events"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001012 RunCommand(
1013 "EVENT LOG",
1014 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001015 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Yao Chenbe3bbc12018-01-17 16:31:10 -08001016 timeout_ms = logcat_timeout({"stats"});
1017 RunCommand(
1018 "STATS LOG",
1019 {"logcat", "-b", "stats", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001020 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001021 DoRadioLogcat();
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001022
1023 RunCommand("LOG STATISTICS", {"logcat", "-b", "all", "-S"});
1024
1025 /* kernels must set CONFIG_PSTORE_PMSG, slice up pstore with device tree */
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001026 RunCommand("LAST LOGCAT", {"logcat", "-L", "-b", "all", "-v", "threadtime", "-v", "printable",
1027 "-v", "uid", "-d", "*:v"});
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001028}
1029
Mike Ma5c267872019-08-21 11:31:34 -07001030static void DumpIncidentReport() {
1031 if (!ds.IsZipping()) {
1032 MYLOGD("Not dumping incident report because it's not a zipped bugreport\n");
1033 return;
1034 }
Mike Ma5c267872019-08-21 11:31:34 -07001035 const std::string path = ds.bugreport_internal_dir_ + "/tmp_incident_report";
1036 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1037 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1038 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1039 if (fd < 0) {
1040 MYLOGE("Could not open %s to dump incident report.\n", path.c_str());
1041 return;
1042 }
1043 RunCommandToFd(fd, "", {"incident", "-u"}, CommandOptions::WithTimeout(120).Build());
1044 bool empty = 0 == lseek(fd, 0, SEEK_END);
1045 if (!empty) {
1046 // Use a different name from "incident.proto"
1047 // /proto/incident.proto is reserved for incident service dump
1048 // i.e. metadata for debugging.
Rhed Jao4875aa62020-07-20 17:46:29 +08001049 ds.EnqueueAddZipEntryAndCleanupIfNeeded(kProtoPath + "incident_report" + kProtoExt,
1050 path);
1051 } else {
1052 unlink(path.c_str());
Mike Ma5c267872019-08-21 11:31:34 -07001053 }
Mike Ma5c267872019-08-21 11:31:34 -07001054}
1055
Sunny Goyal35949782019-11-19 15:54:36 -08001056static void DumpVisibleWindowViews() {
1057 if (!ds.IsZipping()) {
1058 MYLOGD("Not dumping visible views because it's not a zipped bugreport\n");
1059 return;
1060 }
1061 DurationReporter duration_reporter("VISIBLE WINDOW VIEWS");
1062 const std::string path = ds.bugreport_internal_dir_ + "/tmp_visible_window_views";
1063 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1064 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1065 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1066 if (fd < 0) {
1067 MYLOGE("Could not open %s to dump visible views.\n", path.c_str());
1068 return;
1069 }
1070 RunCommandToFd(fd, "", {"cmd", "window", "dump-visible-window-views"},
1071 CommandOptions::WithTimeout(120).Build());
1072 bool empty = 0 == lseek(fd, 0, SEEK_END);
1073 if (!empty) {
1074 ds.AddZipEntry("visible_windows.zip", path);
1075 } else {
1076 MYLOGW("Failed to dump visible windows\n");
1077 }
1078 unlink(path.c_str());
1079}
1080
Jayachandran Ca94c7172017-06-10 15:08:12 -07001081static void DumpIpTablesAsRoot() {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001082 RunCommand("IPTABLES", {"iptables", "-L", "-nvx"});
1083 RunCommand("IP6TABLES", {"ip6tables", "-L", "-nvx"});
Erik Kline32af8c22016-09-28 17:26:26 +09001084 RunCommand("IPTABLES NAT", {"iptables", "-t", "nat", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001085 /* no ip6 nat */
Erik Kline32af8c22016-09-28 17:26:26 +09001086 RunCommand("IPTABLES MANGLE", {"iptables", "-t", "mangle", "-L", "-nvx"});
1087 RunCommand("IP6TABLES MANGLE", {"ip6tables", "-t", "mangle", "-L", "-nvx"});
1088 RunCommand("IPTABLES RAW", {"iptables", "-t", "raw", "-L", "-nvx"});
1089 RunCommand("IP6TABLES RAW", {"ip6tables", "-t", "raw", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001090}
1091
David Andersond9ba4752018-12-11 18:26:59 -08001092static void DumpDynamicPartitionInfo() {
1093 if (!::android::base::GetBoolProperty("ro.boot.dynamic_partitions", false)) {
1094 return;
1095 }
1096
1097 RunCommand("LPDUMP", {"lpdump", "--all"});
David Anderson6650ade2019-10-02 15:18:59 -07001098 RunCommand("DEVICE-MAPPER", {"gsid", "dump-device-mapper"});
David Andersond9ba4752018-12-11 18:26:59 -08001099}
1100
Narayan Kamath8f788292017-05-25 13:20:39 +01001101static void AddAnrTraceDir(const bool add_to_zip, const std::string& anr_traces_dir) {
1102 MYLOGD("AddAnrTraceDir(): dump_traces_file=%s, anr_traces_dir=%s\n", dump_traces_path,
1103 anr_traces_dir.c_str());
1104
1105 // If we're here, dump_traces_path will always be a temporary file
1106 // (created with mkostemp or similar) that contains dumps taken earlier
1107 // on in the process.
1108 if (dump_traces_path != nullptr) {
1109 if (add_to_zip) {
1110 ds.AddZipEntry(ZIP_ROOT_DIR + anr_traces_dir + "/traces-just-now.txt", dump_traces_path);
1111 } else {
1112 MYLOGD("Dumping current ANR traces (%s) to the main bugreport entry\n",
1113 dump_traces_path);
1114 ds.DumpFile("VM TRACES JUST NOW", dump_traces_path);
1115 }
1116
1117 const int ret = unlink(dump_traces_path);
1118 if (ret == -1) {
1119 MYLOGW("Error unlinking temporary trace path %s: %s\n", dump_traces_path,
1120 strerror(errno));
Felipe Lemee184f662016-10-27 10:04:47 -07001121 }
1122 }
1123
Narayan Kamathbd863722017-06-01 18:50:12 +01001124 // Add a specific message for the first ANR Dump.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001125 if (ds.anr_data_.size() > 0) {
1126 AddDumps(ds.anr_data_.begin(), ds.anr_data_.begin() + 1,
Narayan Kamathbd863722017-06-01 18:50:12 +01001127 "VM TRACES AT LAST ANR", add_to_zip);
1128
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001129 // The "last" ANR will always be included as separate entry in the zip file. In addition,
1130 // it will be present in the body of the main entry if |add_to_zip| == false.
1131 //
1132 // Historical ANRs are always included as separate entries in the bugreport zip file.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001133 AddDumps(ds.anr_data_.begin() + ((add_to_zip) ? 1 : 0), ds.anr_data_.end(),
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001134 "HISTORICAL ANR", true /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001135 } else {
Narayan Kamath8f788292017-05-25 13:20:39 +01001136 printf("*** NO ANRs to dump in %s\n\n", ANR_DIR.c_str());
1137 }
1138}
1139
1140static void AddAnrTraceFiles() {
1141 const bool add_to_zip = ds.IsZipping() && ds.version_ == VERSION_SPLIT_ANR;
1142
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001143 std::string anr_traces_dir = "/data/anr";
Narayan Kamath8f788292017-05-25 13:20:39 +01001144
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001145 AddAnrTraceDir(add_to_zip, anr_traces_dir);
Narayan Kamath8f788292017-05-25 13:20:39 +01001146
Makoto Onuki83ec63f2019-01-31 17:08:59 -08001147 RunCommand("ANR FILES", {"ls", "-lt", ANR_DIR});
1148
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001149 // Slow traces for slow operations.
Felipe Lemee184f662016-10-27 10:04:47 -07001150 struct stat st;
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001151 int i = 0;
1152 while (true) {
1153 const std::string slow_trace_path =
1154 anr_traces_dir + android::base::StringPrintf("slow%02d.txt", i);
1155 if (stat(slow_trace_path.c_str(), &st)) {
1156 // No traces file at this index, done with the files.
1157 break;
Felipe Lemee184f662016-10-27 10:04:47 -07001158 }
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001159 ds.DumpFile("VM TRACES WHEN SLOW", slow_trace_path.c_str());
1160 i++;
Felipe Lemee184f662016-10-27 10:04:47 -07001161 }
1162}
1163
Wei Wang509bb5d2017-06-09 14:42:12 -07001164static void DumpBlockStatFiles() {
1165 DurationReporter duration_reporter("DUMP BLOCK STAT");
Wei Wang509bb5d2017-06-09 14:42:12 -07001166
Wei Wang1dc1ef52017-06-12 11:28:37 -07001167 std::unique_ptr<DIR, std::function<int(DIR*)>> dirptr(opendir(BLK_DEV_SYS_DIR), closedir);
1168
1169 if (dirptr == nullptr) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001170 MYLOGE("Failed to open %s: %s\n", BLK_DEV_SYS_DIR, strerror(errno));
1171 return;
1172 }
1173
1174 printf("------ DUMP BLOCK STAT ------\n\n");
Wei Wang1dc1ef52017-06-12 11:28:37 -07001175 while (struct dirent *d = readdir(dirptr.get())) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001176 if ((d->d_name[0] == '.')
1177 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
1178 || (d->d_name[1] == '\0'))) {
1179 continue;
1180 }
1181 const std::string new_path =
1182 android::base::StringPrintf("%s/%s", BLK_DEV_SYS_DIR, d->d_name);
1183 printf("------ BLOCK STAT (%s) ------\n", new_path.c_str());
1184 dump_files("", new_path.c_str(), skip_not_stat, dump_stat_from_fd);
1185 printf("\n");
1186 }
Wei Wang1dc1ef52017-06-12 11:28:37 -07001187 return;
Wei Wang509bb5d2017-06-09 14:42:12 -07001188}
Jayachandran Ca94c7172017-06-10 15:08:12 -07001189
1190static void DumpPacketStats() {
1191 DumpFile("NETWORK DEV INFO", "/proc/net/dev");
1192 DumpFile("QTAGUID NETWORK INTERFACES INFO", "/proc/net/xt_qtaguid/iface_stat_all");
1193 DumpFile("QTAGUID NETWORK INTERFACES INFO (xt)", "/proc/net/xt_qtaguid/iface_stat_fmt");
1194 DumpFile("QTAGUID CTRL INFO", "/proc/net/xt_qtaguid/ctrl");
1195 DumpFile("QTAGUID STATS INFO", "/proc/net/xt_qtaguid/stats");
1196}
1197
1198static void DumpIpAddrAndRules() {
1199 /* The following have a tendency to get wedged when wifi drivers/fw goes belly-up. */
1200 RunCommand("NETWORK INTERFACES", {"ip", "link"});
1201 RunCommand("IPv4 ADDRESSES", {"ip", "-4", "addr", "show"});
1202 RunCommand("IPv6 ADDRESSES", {"ip", "-6", "addr", "show"});
1203 RunCommand("IP RULES", {"ip", "rule", "show"});
1204 RunCommand("IP RULES v6", {"ip", "-6", "rule", "show"});
1205}
1206
Nandana Dutt5c390032019-03-12 10:52:56 +00001207static Dumpstate::RunStatus RunDumpsysTextByPriority(const std::string& title, int priority,
1208 std::chrono::milliseconds timeout,
1209 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001210 auto start = std::chrono::steady_clock::now();
Vishnu Naire97d6122018-01-18 13:58:56 -08001211 sp<android::IServiceManager> sm = defaultServiceManager();
1212 Dumpsys dumpsys(sm.get());
Vishnu Naire97d6122018-01-18 13:58:56 -08001213 Vector<String16> args;
1214 Dumpsys::setServiceArgs(args, /* asProto = */ false, priority);
Vishnu Naire97d6122018-01-18 13:58:56 -08001215 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ false);
1216 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001217 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001218 std::string path(title);
1219 path.append(" - ").append(String8(service).c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -08001220 size_t bytes_written = 0;
Steven Moreland5a30d342019-10-08 13:53:28 -07001221 status_t status = dumpsys.startDumpThread(Dumpsys::Type::DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001222 if (status == OK) {
1223 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1224 std::chrono::duration<double> elapsed_seconds;
1225 status = dumpsys.writeDump(STDOUT_FILENO, service, service_timeout,
1226 /* as_proto = */ false, elapsed_seconds, bytes_written);
Vishnu Naire97d6122018-01-18 13:58:56 -08001227 dumpsys.writeDumpFooter(STDOUT_FILENO, service, elapsed_seconds);
1228 bool dump_complete = (status == OK);
1229 dumpsys.stopDumpThread(dump_complete);
1230 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001231
1232 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1233 std::chrono::steady_clock::now() - start);
1234 if (elapsed_duration > timeout) {
1235 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1236 elapsed_duration.count());
1237 break;
1238 }
1239 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001240 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001241}
1242
Vishnu Nair64afc022018-02-01 15:29:34 -08001243static void RunDumpsysText(const std::string& title, int priority,
1244 std::chrono::milliseconds timeout,
1245 std::chrono::milliseconds service_timeout) {
1246 DurationReporter duration_reporter(title);
1247 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1248 fsync(STDOUT_FILENO);
1249 RunDumpsysTextByPriority(title, priority, timeout, service_timeout);
1250}
1251
1252/* Dump all services registered with Normal or Default priority. */
Nandana Dutt5c390032019-03-12 10:52:56 +00001253static Dumpstate::RunStatus RunDumpsysTextNormalPriority(const std::string& title,
1254 std::chrono::milliseconds timeout,
1255 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001256 DurationReporter duration_reporter(title);
1257 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1258 fsync(STDOUT_FILENO);
1259 RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_NORMAL, timeout,
1260 service_timeout);
Nandana Dutt5c390032019-03-12 10:52:56 +00001261
1262 RETURN_IF_USER_DENIED_CONSENT();
1263
1264 return RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_DEFAULT, timeout,
1265 service_timeout);
Vishnu Nair64afc022018-02-01 15:29:34 -08001266}
1267
Nandana Dutt5c390032019-03-12 10:52:56 +00001268static Dumpstate::RunStatus RunDumpsysProto(const std::string& title, int priority,
1269 std::chrono::milliseconds timeout,
1270 std::chrono::milliseconds service_timeout) {
Luis Hector Chavez1e27b082018-03-22 15:36:42 -07001271 if (!ds.IsZipping()) {
1272 MYLOGD("Not dumping %s because it's not a zipped bugreport\n", title.c_str());
Nandana Dutt5c390032019-03-12 10:52:56 +00001273 return Dumpstate::RunStatus::OK;
Luis Hector Chavez1e27b082018-03-22 15:36:42 -07001274 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001275 sp<android::IServiceManager> sm = defaultServiceManager();
1276 Dumpsys dumpsys(sm.get());
1277 Vector<String16> args;
1278 Dumpsys::setServiceArgs(args, /* asProto = */ true, priority);
1279 DurationReporter duration_reporter(title);
1280
1281 auto start = std::chrono::steady_clock::now();
1282 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ true);
1283 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001284 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001285 std::string path(kProtoPath);
1286 path.append(String8(service).c_str());
1287 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL) {
1288 path.append("_CRITICAL");
1289 } else if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH) {
1290 path.append("_HIGH");
1291 }
1292 path.append(kProtoExt);
Steven Moreland5a30d342019-10-08 13:53:28 -07001293 status_t status = dumpsys.startDumpThread(Dumpsys::Type::DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001294 if (status == OK) {
1295 status = ds.AddZipEntryFromFd(path, dumpsys.getDumpFd(), service_timeout);
1296 bool dumpTerminated = (status == OK);
1297 dumpsys.stopDumpThread(dumpTerminated);
1298 }
1299 ZipWriter::FileEntry file_entry;
1300 ds.zip_writer_->GetLastEntry(&file_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -08001301
1302 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1303 std::chrono::steady_clock::now() - start);
1304 if (elapsed_duration > timeout) {
1305 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1306 elapsed_duration.count());
1307 break;
1308 }
1309 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001310 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001311}
1312
Nandana Dutta7db6342018-11-21 14:53:34 +00001313// Runs dumpsys on services that must dump first and will take less than 100ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001314static Dumpstate::RunStatus RunDumpsysCritical() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001315 RunDumpsysText("DUMPSYS CRITICAL", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1316 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Nandana Dutt5c390032019-03-12 10:52:56 +00001317
1318 RETURN_IF_USER_DENIED_CONSENT();
1319
1320 return RunDumpsysProto("DUMPSYS CRITICAL PROTO", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1321 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Vishnu Nair780b1282017-10-10 13:57:24 -07001322}
1323
1324// Runs dumpsys on services that must dump first but can take up to 250ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001325static Dumpstate::RunStatus RunDumpsysHigh() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001326 // TODO meminfo takes ~10s, connectivity takes ~5sec to dump. They are both
1327 // high priority. Reduce timeout once they are able to dump in a shorter time or
1328 // moved to a parallel task.
1329 RunDumpsysText("DUMPSYS HIGH", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1330 /* timeout= */ 90s, /* service_timeout= */ 30s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001331
1332 RETURN_IF_USER_DENIED_CONSENT();
1333
1334 return RunDumpsysProto("DUMPSYS HIGH PROTO", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1335 /* timeout= */ 5s, /* service_timeout= */ 1s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001336}
1337
1338// Runs dumpsys on services that must dump but can take up to 10s to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001339static Dumpstate::RunStatus RunDumpsysNormal() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001340 RunDumpsysTextNormalPriority("DUMPSYS", /* timeout= */ 90s, /* service_timeout= */ 10s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001341
1342 RETURN_IF_USER_DENIED_CONSENT();
1343
1344 return RunDumpsysProto("DUMPSYS PROTO", IServiceManager::DUMP_FLAG_PRIORITY_NORMAL,
1345 /* timeout= */ 90s, /* service_timeout= */ 10s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001346}
1347
Rhed Jao4875aa62020-07-20 17:46:29 +08001348/*
1349 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1350 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1351 * if it's not running in the parallel task.
1352 */
1353static void DumpHals(int out_fd = STDOUT_FILENO) {
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001354 if (!ds.IsZipping()) {
Yifan Hong30528a22020-08-07 18:24:06 -07001355 RunCommand("HARDWARE HALS", {"lshal", "--all", "--types=all", "--debug"},
Steven Moreland9de8a1f2020-09-23 17:26:33 +00001356 CommandOptions::WithTimeout(60).AsRootIfAvailable().Build());
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001357 return;
1358 }
Yifan Hong30528a22020-08-07 18:24:06 -07001359 RunCommand("HARDWARE HALS", {"lshal", "--all", "--types=all"},
Rhed Jao4875aa62020-07-20 17:46:29 +08001360 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build(),
1361 false, out_fd);
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001362
Steven Moreland44cd9482018-01-04 16:24:13 -08001363 using android::hidl::manager::V1_0::IServiceManager;
1364 using android::hardware::defaultServiceManager;
1365
1366 sp<IServiceManager> sm = defaultServiceManager();
1367 if (sm == nullptr) {
1368 MYLOGE("Could not retrieve hwservicemanager to dump hals.\n");
1369 return;
1370 }
1371
1372 auto ret = sm->list([&](const auto& interfaces) {
1373 for (const std::string& interface : interfaces) {
1374 std::string cleanName = interface;
1375 std::replace_if(cleanName.begin(),
1376 cleanName.end(),
1377 [](char c) {
1378 return !isalnum(c) &&
1379 std::string("@-_:.").find(c) == std::string::npos;
1380 }, '_');
Nandana Dutt979388e2018-11-30 16:48:55 +00001381 const std::string path = ds.bugreport_internal_dir_ + "/lshal_debug_" + cleanName;
Steven Moreland44cd9482018-01-04 16:24:13 -08001382
Rhed Jao4875aa62020-07-20 17:46:29 +08001383 bool empty = false;
Steven Moreland44cd9482018-01-04 16:24:13 -08001384 {
1385 auto fd = android::base::unique_fd(
1386 TEMP_FAILURE_RETRY(open(path.c_str(),
1387 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1388 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1389 if (fd < 0) {
1390 MYLOGE("Could not open %s to dump additional hal information.\n", path.c_str());
1391 continue;
1392 }
1393 RunCommandToFd(fd,
1394 "",
Steven Morelandc81cd3c2018-01-18 14:36:26 -08001395 {"lshal", "debug", "-E", interface},
Steven Moreland44cd9482018-01-04 16:24:13 -08001396 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
1397
Rhed Jao4875aa62020-07-20 17:46:29 +08001398 empty = 0 == lseek(fd, 0, SEEK_END);
Steven Moreland44cd9482018-01-04 16:24:13 -08001399 }
Rhed Jao4875aa62020-07-20 17:46:29 +08001400 if (!empty) {
1401 ds.EnqueueAddZipEntryAndCleanupIfNeeded("lshal-debug/" + cleanName + ".txt",
1402 path);
1403 } else {
1404 unlink(path.c_str());
1405 }
Steven Moreland44cd9482018-01-04 16:24:13 -08001406 }
1407 });
1408
1409 if (!ret.isOk()) {
1410 MYLOGE("Could not list hals from hwservicemanager.\n");
1411 }
1412}
1413
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001414static void DumpExternalFragmentationInfo() {
1415 struct stat st;
1416 if (stat("/proc/buddyinfo", &st) != 0) {
1417 MYLOGE("Unable to dump external fragmentation info\n");
1418 return;
1419 }
1420
1421 printf("------ EXTERNAL FRAGMENTATION INFO ------\n");
1422 std::ifstream ifs("/proc/buddyinfo");
1423 auto unusable_index_regex = std::regex{"Node\\s+([0-9]+),\\s+zone\\s+(\\S+)\\s+(.*)"};
1424 for (std::string line; std::getline(ifs, line);) {
1425 std::smatch match_results;
1426 if (std::regex_match(line, match_results, unusable_index_regex)) {
1427 std::stringstream free_pages(std::string{match_results[3]});
1428 std::vector<int> free_pages_per_order(std::istream_iterator<int>{free_pages},
1429 std::istream_iterator<int>());
1430
1431 int total_free_pages = 0;
1432 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1433 total_free_pages += (free_pages_per_order[i] * std::pow(2, i));
1434 }
1435
1436 printf("Node %s, zone %8s", match_results[1].str().c_str(),
1437 match_results[2].str().c_str());
1438
1439 int usable_free_pages = total_free_pages;
1440 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1441 auto unusable_index = (total_free_pages - usable_free_pages) /
1442 static_cast<double>(total_free_pages);
1443 printf(" %5.3f", unusable_index);
1444 usable_free_pages -= (free_pages_per_order[i] * std::pow(2, i));
1445 }
1446
1447 printf("\n");
1448 }
1449 }
1450 printf("\n");
1451}
1452
mhasankd451a472020-05-26 18:02:39 -07001453static void DumpstateLimitedOnly() {
1454 // Trimmed-down version of dumpstate to only include a whitelisted
1455 // set of logs (system log, event log, and system server / system app
1456 // crashes, and networking logs). See b/136273873 and b/138459828
1457 // for context.
1458 DurationReporter duration_reporter("DUMPSTATE");
1459 unsigned long timeout_ms;
1460 // calculate timeout
1461 timeout_ms = logcat_timeout({"main", "system", "crash"});
1462 RunCommand("SYSTEM LOG",
1463 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1464 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1465 timeout_ms = logcat_timeout({"events"});
1466 RunCommand(
1467 "EVENT LOG",
1468 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1469 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1470
1471 printf("========================================================\n");
1472 printf("== Networking Service\n");
1473 printf("========================================================\n");
1474
1475 RunDumpsys("DUMPSYS NETWORK_SERVICE_LIMITED", {"wifi", "-a"},
1476 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hugo Benichiaa162682020-10-30 23:28:56 +09001477 RunDumpsys("DUMPSYS CONNECTIVITY REQUESTS", {"connectivity", "requests"},
1478 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
mhasankd451a472020-05-26 18:02:39 -07001479
1480 printf("========================================================\n");
1481 printf("== Dropbox crashes\n");
1482 printf("========================================================\n");
1483
1484 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1485 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1486
1487 printf("========================================================\n");
1488 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1489 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1490 printf("========================================================\n");
1491 printf("== dumpstate: done (id %d)\n", ds.id_);
1492 printf("========================================================\n");
1493}
1494
Rhed Jao6b1ea2d2020-07-21 17:58:41 +08001495/*
1496 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1497 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1498 * if it's not running in the parallel task.
1499 */
1500static void DumpCheckins(int out_fd = STDOUT_FILENO) {
1501 dprintf(out_fd, "========================================================\n");
1502 dprintf(out_fd, "== Checkins\n");
1503 dprintf(out_fd, "========================================================\n");
1504
1505 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"}, out_fd);
1506 RunDumpsys("CHECKIN MEMINFO", {"meminfo", "--checkin"}, out_fd);
1507 RunDumpsys("CHECKIN NETSTATS", {"netstats", "--checkin"}, out_fd);
1508 RunDumpsys("CHECKIN PROCSTATS", {"procstats", "-c"}, out_fd);
1509 RunDumpsys("CHECKIN USAGESTATS", {"usagestats", "-c"}, out_fd);
1510 RunDumpsys("CHECKIN PACKAGE", {"package", "--checkin"}, out_fd);
1511}
1512
1513/*
1514 * Runs dumpsys on activity service to dump all application activities, services
1515 * and providers in the device.
1516 *
1517 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1518 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1519 * if it's not running in the parallel task.
1520 */
1521static void DumpAppInfos(int out_fd = STDOUT_FILENO) {
1522 dprintf(out_fd, "========================================================\n");
1523 dprintf(out_fd, "== Running Application Activities\n");
1524 dprintf(out_fd, "========================================================\n");
1525
1526 // The following dumpsys internally collects output from running apps, so it can take a long
1527 // time. So let's extend the timeout.
1528
1529 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
1530
1531 RunDumpsys("APP ACTIVITIES", {"activity", "-v", "all"}, DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1532
1533 dprintf(out_fd, "========================================================\n");
1534 dprintf(out_fd, "== Running Application Services (platform)\n");
1535 dprintf(out_fd, "========================================================\n");
1536
1537 RunDumpsys("APP SERVICES PLATFORM", {"activity", "service", "all-platform-non-critical"},
1538 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1539
1540 dprintf(out_fd, "========================================================\n");
1541 dprintf(out_fd, "== Running Application Services (non-platform)\n");
1542 dprintf(out_fd, "========================================================\n");
1543
1544 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1545 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1546
1547 dprintf(out_fd, "========================================================\n");
1548 dprintf(out_fd, "== Running Application Providers (platform)\n");
1549 dprintf(out_fd, "========================================================\n");
1550
1551 RunDumpsys("APP PROVIDERS PLATFORM", {"activity", "provider", "all-platform"},
1552 DUMPSYS_COMPONENTS_OPTIONS, out_fd);
1553
1554 dprintf(out_fd, "========================================================\n");
1555 dprintf(out_fd, "== Running Application Providers (non-platform)\n");
1556 dprintf(out_fd, "========================================================\n");
1557
1558 RunDumpsys("APP PROVIDERS NON-PLATFORM", {"activity", "provider", "all-non-platform"},
1559 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1560}
1561
Nandana Dutt5c390032019-03-12 10:52:56 +00001562// Dumps various things. Returns early with status USER_CONSENT_DENIED if user denies consent
1563// via the consent they are shown. Ignores other errors that occur while running various
1564// commands. The consent checking is currently done around long running tasks, which happen to
1565// be distributed fairly evenly throughout the function.
1566static Dumpstate::RunStatus dumpstate() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001567 DurationReporter duration_reporter("DUMPSTATE");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001568
Rhed Jao4875aa62020-07-20 17:46:29 +08001569 // Enqueue slow functions into the thread pool, if the parallel run is enabled.
1570 if (ds.dump_pool_) {
1571 // Pool was shutdown in DumpstateDefaultAfterCritical method in order to
1572 // drop root user. Restarts it with two threads for the parallel run.
1573 ds.dump_pool_->start(/* thread_counts = */2);
1574
1575 ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
1576 ds.dump_pool_->enqueueTask(DUMP_INCIDENT_REPORT_TASK, &DumpIncidentReport);
1577 ds.dump_pool_->enqueueTaskWithFd(DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
Rhed Jao6b1ea2d2020-07-21 17:58:41 +08001578 ds.dump_pool_->enqueueTaskWithFd(DUMP_CHECKINS_TASK, &DumpCheckins, _1);
Rhed Jao4875aa62020-07-20 17:46:29 +08001579 }
1580
Nandana Dutt5c390032019-03-12 10:52:56 +00001581 // Dump various things. Note that anything that takes "long" (i.e. several seconds) should
1582 // check intermittently (if it's intrerruptable like a foreach on pids) and/or should be wrapped
1583 // in a consent check (via RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK).
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -07001584 dump_dev_files("TRUSTY VERSION", "/sys/bus/platform/drivers/trusty", "trusty_version");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001585 RunCommand("UPTIME", {"uptime"});
Wei Wang509bb5d2017-06-09 14:42:12 -07001586 DumpBlockStatFiles();
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001587 DumpFile("MEMORY INFO", "/proc/meminfo");
1588 RunCommand("CPU INFO", {"top", "-b", "-n", "1", "-H", "-s", "6", "-o",
Felipe Leme30dbfa12016-09-02 12:43:26 -07001589 "pid,tid,user,pr,ni,%cpu,s,virt,res,pcy,cmd,name"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001590
1591 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "PROCRANK", {"procrank"}, AS_ROOT_20);
1592
Sunny Goyal35949782019-11-19 15:54:36 -08001593 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpVisibleWindowViews);
1594
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001595 DumpFile("VIRTUAL MEMORY STATS", "/proc/vmstat");
1596 DumpFile("VMALLOC INFO", "/proc/vmallocinfo");
1597 DumpFile("SLAB INFO", "/proc/slabinfo");
1598 DumpFile("ZONEINFO", "/proc/zoneinfo");
1599 DumpFile("PAGETYPEINFO", "/proc/pagetypeinfo");
1600 DumpFile("BUDDYINFO", "/proc/buddyinfo");
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001601 DumpExternalFragmentationInfo();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001602
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001603 DumpFile("KERNEL WAKE SOURCES", "/d/wakeup_sources");
1604 DumpFile("KERNEL CPUFREQ", "/sys/devices/system/cpu/cpu0/cpufreq/stats/time_in_state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001605
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001606 RunCommand("PROCESSES AND THREADS",
Yohei Yukawa591a72d2017-10-05 21:36:35 -07001607 {"ps", "-A", "-T", "-Z", "-O", "pri,nice,rtprio,sched,pcy,time"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001608
1609 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "LIBRANK", {"librank"},
1610 CommandOptions::AS_ROOT);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001611
Rhed Jao4875aa62020-07-20 17:46:29 +08001612 if (ds.dump_pool_) {
1613 WAIT_TASK_WITH_CONSENT_CHECK(DUMP_HALS_TASK, ds.dump_pool_);
1614 } else {
1615 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_HALS_TASK, DumpHals);
1616 }
Steven Moreland81b429e2017-01-31 19:50:46 -08001617
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001618 RunCommand("PRINTENV", {"printenv"});
Elliott Hughes21b7c8d2016-10-28 08:53:02 -07001619 RunCommand("NETSTAT", {"netstat", "-nW"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001620 struct stat s;
1621 if (stat("/proc/modules", &s) != 0) {
1622 MYLOGD("Skipping 'lsmod' because /proc/modules does not exist\n");
1623 } else {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001624 RunCommand("LSMOD", {"lsmod"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001625 }
Michal Karpinski4db754f2015-12-11 18:04:32 +00001626
Tom Cherryb87dbfa2020-07-28 11:28:53 -07001627 if (android::base::GetBoolProperty("ro.logd.kernel", false)) {
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001628 DoKernelLogcat();
1629 } else {
1630 do_dmesg();
1631 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001632
Felipe Lemef0292972016-11-22 13:57:05 -08001633 RunCommand("LIST OF OPEN FILES", {"lsof"}, CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001634
1635 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(for_each_pid, do_showmap, "SMAPS OF ALL PROCESSES");
1636
Jeff Brown1dc94e32014-09-11 14:15:27 -07001637 for_each_tid(show_wchan, "BLOCKED PROCESS WAIT-CHANNELS");
Mark Salyzyna297c322016-02-05 15:33:17 -08001638 for_each_pid(show_showtime, "PROCESS TIMES (pid cmd user system iowait+percentage)");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001639
Ajay Panicker2ff8e872017-04-27 14:04:32 -07001640 /* Dump Bluetooth HCI logs */
1641 ds.AddDir("/data/misc/bluetooth/logs", true);
Jack Yu5a6b2e22020-08-14 18:13:35 +08001642 /* Dump Nfc NCI logs */
1643 ds.AddDir("/data/misc/nfc/logs", true);
Ajay Panickerd886ec42016-09-14 12:26:46 -07001644
Paul Chang0d2aad72020-02-13 20:04:03 +08001645 if (ds.options_->do_screenshot && !ds.do_early_screenshot_) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001646 MYLOGI("taking late screenshot\n");
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001647 ds.TakeScreenshot();
Jeff Sharkey5a930032013-03-19 15:05:19 -07001648 }
1649
Felipe Lemee184f662016-10-27 10:04:47 -07001650 AddAnrTraceFiles();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001651
Narayan Kamath8f788292017-05-25 13:20:39 +01001652 // NOTE: tombstones are always added as separate entries in the zip archive
1653 // and are not interspersed with the main report.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001654 const bool tombstones_dumped = AddDumps(ds.tombstone_data_.begin(), ds.tombstone_data_.end(),
Narayan Kamathbd863722017-06-01 18:50:12 +01001655 "TOMBSTONE", true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001656 if (!tombstones_dumped) {
1657 printf("*** NO TOMBSTONES to dump in %s\n\n", TOMBSTONE_DIR.c_str());
Christopher Ferris7dc7f322014-07-22 16:08:19 -07001658 }
1659
Jayachandran Ca94c7172017-06-10 15:08:12 -07001660 DumpPacketStats();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001661
Chenbo Feng276a3b62018-08-07 11:44:49 -07001662 RunDumpsys("EBPF MAP STATS", {"netd", "trafficcontroller"});
1663
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001664 DoKmsg();
Mark Salyzyn2262c162014-12-16 09:09:26 -08001665
Jayachandran Ca94c7172017-06-10 15:08:12 -07001666 DumpIpAddrAndRules();
Sreeram Ramachandran2b3bba32014-07-08 15:40:55 -07001667
1668 dump_route_tables();
1669
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001670 RunCommand("ARP CACHE", {"ip", "-4", "neigh", "show"});
1671 RunCommand("IPv6 ND CACHE", {"ip", "-6", "neigh", "show"});
1672 RunCommand("MULTICAST ADDRESSES", {"ip", "maddr"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001673
Nandana Dutt5c390032019-03-12 10:52:56 +00001674 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysHigh);
Lorenzo Colitti6afc38c2015-09-09 22:59:25 +09001675
Elliott Hughes23ccc622017-02-28 10:14:22 -08001676 RunCommand("SYSTEM PROPERTIES", {"getprop"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001677
Jin Qianf334d662017-10-10 14:41:37 -07001678 RunCommand("STORAGED IO INFO", {"storaged", "-u", "-p"});
ynwangf649a6e2016-07-17 21:56:00 -07001679
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001680 RunCommand("FILESYSTEMS & FREE SPACE", {"df"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001681
Colin Crossf45fa6b2012-03-26 12:38:26 -07001682 /* Binder state is expensive to look at as it uses a lot of memory. */
Hridya Valsaraju920ba712020-02-09 16:27:01 -08001683 std::string binder_logs_dir = access("/dev/binderfs/binder_logs", R_OK) ?
1684 "/sys/kernel/debug/binder" : "/dev/binderfs/binder_logs";
1685
1686 DumpFile("BINDER FAILED TRANSACTION LOG", binder_logs_dir + "/failed_transaction_log");
1687 DumpFile("BINDER TRANSACTION LOG", binder_logs_dir + "/transaction_log");
1688 DumpFile("BINDER TRANSACTIONS", binder_logs_dir + "/transactions");
1689 DumpFile("BINDER STATS", binder_logs_dir + "/stats");
1690 DumpFile("BINDER STATE", binder_logs_dir + "/state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001691
Vishnu Nair36b4cdb2017-11-17 10:27:05 -08001692 /* Add window and surface trace files. */
1693 if (!PropertiesHelper::IsUserBuild()) {
1694 ds.AddDir(WMTRACE_DATA_DIR, false);
1695 }
1696
Yifan Hongcba0a4f2020-02-08 16:52:02 -08001697 ds.AddDir(SNAPSHOTCTL_LOG_DIR, false);
1698
Rhed Jao4875aa62020-07-20 17:46:29 +08001699 if (ds.dump_pool_) {
1700 WAIT_TASK_WITH_CONSENT_CHECK(DUMP_BOARD_TASK, ds.dump_pool_);
1701 } else {
1702 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
1703 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001704
Steven Moreland7440ddb2016-12-15 16:13:39 -08001705 /* Migrate the ril_dumpstate to a device specific dumpstate? */
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001706 int rilDumpstateTimeout = android::base::GetIntProperty("ril.dumpstate.timeout", 0);
1707 if (rilDumpstateTimeout > 0) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001708 // su does not exist on user builds, so try running without it.
1709 // This way any implementations of vril-dump that do not require
1710 // root can run on user builds.
1711 CommandOptions::CommandOptionsBuilder options =
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001712 CommandOptions::WithTimeout(rilDumpstateTimeout);
Felipe Lemef0292972016-11-22 13:57:05 -08001713 if (!PropertiesHelper::IsUserBuild()) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001714 options.AsRoot();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001715 }
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001716 RunCommand("DUMP VENDOR RIL LOGS", {"vril-dump"}, options.Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -07001717 }
1718
Felipe Lemed8b94e52016-12-08 10:21:44 -08001719 printf("========================================================\n");
1720 printf("== Android Framework Services\n");
1721 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001722
Nandana Dutt5c390032019-03-12 10:52:56 +00001723 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysNormal);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001724
Rhed Jao6b1ea2d2020-07-21 17:58:41 +08001725 if (ds.dump_pool_) {
1726 WAIT_TASK_WITH_CONSENT_CHECK(DUMP_CHECKINS_TASK, ds.dump_pool_);
1727 } else {
1728 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_CHECKINS_TASK, DumpCheckins);
1729 }
Dianne Hackborn02bea972013-06-26 18:59:09 -07001730
Rhed Jaoc5f7ec32020-12-22 22:11:08 +08001731 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpAppInfos);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001732
Adrian Roos8b397ab2017-04-04 16:35:44 -07001733 printf("========================================================\n");
1734 printf("== Dropbox crashes\n");
1735 printf("========================================================\n");
1736
1737 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1738 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1739
Felipe Lemed8b94e52016-12-08 10:21:44 -08001740 printf("========================================================\n");
1741 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1742 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1743 printf("========================================================\n");
1744 printf("== dumpstate: done (id %d)\n", ds.id_);
1745 printf("========================================================\n");
Bookatz38472142018-09-28 10:20:24 -07001746
1747 printf("========================================================\n");
1748 printf("== Obtaining statsd metadata\n");
1749 printf("========================================================\n");
1750 // This differs from the usual dumpsys stats, which is the stats report data.
1751 RunDumpsys("STATSDSTATS", {"stats", "--metadata"});
Mike Ma5c267872019-08-21 11:31:34 -07001752
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +09001753 // Add linker configuration directory
1754 ds.AddDir(LINKERCONFIG_DIR, true);
1755
Rhed Jao4875aa62020-07-20 17:46:29 +08001756 if (ds.dump_pool_) {
1757 WAIT_TASK_WITH_CONSENT_CHECK(DUMP_INCIDENT_REPORT_TASK, ds.dump_pool_);
1758 } else {
1759 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_INCIDENT_REPORT_TASK,
1760 DumpIncidentReport);
1761 }
Mike Ma5c267872019-08-21 11:31:34 -07001762
Nandana Dutt5c390032019-03-12 10:52:56 +00001763 return Dumpstate::RunStatus::OK;
Colin Crossf45fa6b2012-03-26 12:38:26 -07001764}
1765
Nandana Dutt5c390032019-03-12 10:52:56 +00001766/*
1767 * Dumps state for the default case; drops root after it's no longer necessary.
1768 *
1769 * Returns RunStatus::OK if everything went fine.
1770 * Returns RunStatus::ERROR if there was an error.
1771 * Returns RunStatus::USER_DENIED_CONSENT if user explicitly denied consent to sharing the bugreport
1772 * with the caller.
1773 */
Jichao Lie89d9c12019-11-21 19:02:51 -08001774Dumpstate::RunStatus Dumpstate::DumpstateDefaultAfterCritical() {
Nandana Duttdb379fa2019-10-09 16:54:41 +01001775 // Capture first logcat early on; useful to take a snapshot before dumpstate logs take over the
1776 // buffer.
1777 DoLogcat();
1778 // Capture timestamp after first logcat to use in next logcat
1779 time_t logcat_ts = time(nullptr);
1780
Nandana Dutt4be45d12018-09-26 15:04:23 +01001781 /* collect stack traces from Dalvik and native processes (needs root) */
Rhed Jao1c855122020-07-16 17:37:39 +08001782 if (dump_pool_) {
1783 RETURN_IF_USER_DENIED_CONSENT();
1784 // One thread is enough since we only need to enqueue DumpTraces here.
1785 dump_pool_->start(/* thread_counts = */1);
1786
1787 // DumpTraces takes long time, post it to the another thread in the
1788 // pool, if pool is available
1789 dump_pool_->enqueueTask(DUMP_TRACES_TASK, &Dumpstate::DumpTraces, &ds, &dump_traces_path);
1790 } else {
1791 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_TRACES_TASK, ds.DumpTraces,
1792 &dump_traces_path);
1793 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001794
1795 /* Run some operations that require root. */
1796 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX, !ds.IsZipping());
1797 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX, !ds.IsZipping());
1798
1799 ds.AddDir(RECOVERY_DIR, true);
1800 ds.AddDir(RECOVERY_DATA_DIR, true);
1801 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
1802 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1803 if (!PropertiesHelper::IsUserBuild()) {
1804 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1805 ds.AddDir(PROFILE_DATA_DIR_REF, true);
Calin Juravle78a0d842020-04-28 15:31:12 -07001806 ds.AddZipEntry(ZIP_ROOT_DIR + PACKAGE_DEX_USE_LIST, PACKAGE_DEX_USE_LIST);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001807 }
Jerry Changa1df8a92020-01-02 16:03:39 +08001808 ds.AddDir(PREREBOOT_DATA_DIR, false);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001809 add_mountinfo();
1810 DumpIpTablesAsRoot();
David Andersond9ba4752018-12-11 18:26:59 -08001811 DumpDynamicPartitionInfo();
Yifan Hong3945e1b2019-10-29 12:59:23 -07001812 ds.AddDir(OTA_METADATA_DIR, true);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001813
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001814 // Capture any IPSec policies in play. No keys are exposed here.
Nandana Dutt4be45d12018-09-26 15:04:23 +01001815 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1816
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001817 // Dump IPsec stats. No keys are exposed here.
1818 DumpFile("XFRM STATS", XFRM_STAT_PROC_FILE);
1819
Nandana Dutt4be45d12018-09-26 15:04:23 +01001820 // Run ss as root so we can see socket marks.
1821 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
1822
1823 // Run iotop as root to show top 100 IO threads
1824 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
1825
Erick Reyese68df822019-02-11 14:46:36 -08001826 // Gather shared memory buffer info if the product implements it
1827 struct stat st;
1828 if (!stat("/product/bin/dmabuf_dump", &st)) {
1829 RunCommand("Dmabuf dump", {"/product/bin/dmabuf_dump"});
1830 }
1831
Minchan Kim22c6a1e2019-09-30 15:58:10 -07001832 DumpFile("PSI cpu", "/proc/pressure/cpu");
1833 DumpFile("PSI memory", "/proc/pressure/memory");
1834 DumpFile("PSI io", "/proc/pressure/io");
1835
Rhed Jao1c855122020-07-16 17:37:39 +08001836 if (dump_pool_) {
1837 RETURN_IF_USER_DENIED_CONSENT();
1838 dump_pool_->waitForTask(DUMP_TRACES_TASK);
1839
1840 // Current running thread in the pool is the root user also. Shutdown
1841 // the pool and restart later to ensure all threads in the pool could
1842 // drop the root user.
1843 dump_pool_->shutdown();
1844 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001845 if (!DropRootUser()) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001846 return Dumpstate::RunStatus::ERROR;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001847 }
1848
Nandana Dutt5c390032019-03-12 10:52:56 +00001849 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttdb379fa2019-10-09 16:54:41 +01001850 Dumpstate::RunStatus status = dumpstate();
1851 // Capture logcat since the last time we did it.
1852 DoSystemLogcat(logcat_ts);
1853 return status;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001854}
1855
Rhed Jaoa5de5752020-08-14 17:19:17 +08001856// Common states for telephony and wifi which are needed to be collected before
1857// dumpstate drop the root user.
1858static void DumpstateRadioAsRoot() {
1859 DumpIpTablesAsRoot();
1860 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1861}
1862
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001863// This method collects common dumpsys for telephony and wifi. Typically, wifi
1864// reports are fine to include all information, but telephony reports on user
1865// builds need to strip some content (see DumpstateTelephonyOnly).
1866static void DumpstateRadioCommon(bool include_sensitive_info = true) {
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001867 // We need to be picky about some stuff for telephony reports on user builds.
1868 if (!include_sensitive_info) {
1869 // Only dump the radio log buffer (other buffers and dumps contain too much unrelated info).
1870 DoRadioLogcat();
1871 } else {
Rhed Jaoa5de5752020-08-14 17:19:17 +08001872 // DumpHals takes long time, post it to the another thread in the pool,
1873 // if pool is available.
1874 if (ds.dump_pool_) {
1875 ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
1876 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001877 // Contains various system properties and process startup info.
1878 do_dmesg();
1879 // Logs other than the radio buffer may contain package/component names and potential PII.
1880 DoLogcat();
1881 // Too broad for connectivity problems.
1882 DoKmsg();
Rhed Jaoa5de5752020-08-14 17:19:17 +08001883 // DumpHals contains unrelated hardware info (camera, NFC, biometrics, ...).
1884 if (ds.dump_pool_) {
1885 ds.dump_pool_->waitForTask(DUMP_HALS_TASK);
1886 } else {
1887 RUN_SLOW_FUNCTION_AND_LOG(DUMP_HALS_TASK, DumpHals);
1888 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001889 }
1890
Jayachandran Ca94c7172017-06-10 15:08:12 -07001891 DumpPacketStats();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001892 DumpIpAddrAndRules();
1893 dump_route_tables();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001894 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
1895 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08001896}
1897
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001898// We use "telephony" here for legacy reasons, though this now really means "connectivity" (cellular
1899// + wifi + networking). This method collects dumpsys for connectivity debugging only. General rules
1900// for what can be included on user builds: all reported information MUST directly relate to
1901// connectivity debugging or customer support and MUST NOT contain unrelated personally identifiable
1902// information. This information MUST NOT identify user-installed packages (UIDs are OK, package
1903// names are not), and MUST NOT contain logs of user application traffic.
1904// TODO(b/148168577) rename this and other related fields/methods to "connectivity" instead.
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08001905static void DumpstateTelephonyOnly(const std::string& calling_package) {
mukesh agrawal253dad42018-01-23 21:59:59 -08001906 DurationReporter duration_reporter("DUMPSTATE");
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001907
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001908 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08001909
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001910 const bool include_sensitive_info = !PropertiesHelper::IsUserBuild();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001911
Rhed Jaoa5de5752020-08-14 17:19:17 +08001912 DumpstateRadioAsRoot();
1913 if (!DropRootUser()) {
1914 return;
1915 }
1916
1917 // Starts thread pool after the root user is dropped, and two additional threads
1918 // are created for DumpHals in the DumpstateRadioCommon and DumpstateBoard.
1919 if (ds.dump_pool_) {
1920 ds.dump_pool_->start(/*thread_counts =*/2);
1921
1922 // DumpstateBoard takes long time, post it to the another thread in the pool,
1923 // if pool is available.
1924 ds.dump_pool_->enqueueTaskWithFd(DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
1925 }
1926
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001927 DumpstateRadioCommon(include_sensitive_info);
1928
1929 if (include_sensitive_info) {
1930 // Contains too much unrelated PII, and given the unstructured nature of sysprops, we can't
1931 // really cherrypick all of the connectivity-related ones. Apps generally have no business
1932 // reading these anyway, and there should be APIs to supply the info in a more app-friendly
1933 // way.
1934 RunCommand("SYSTEM PROPERTIES", {"getprop"});
1935 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07001936
1937 printf("========================================================\n");
1938 printf("== Android Framework Services\n");
1939 printf("========================================================\n");
1940
Vishnu Nair652cc802017-11-30 15:18:30 -08001941 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1942 SEC_TO_MSEC(10));
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08001943 if (include_sensitive_info) {
1944 // Carrier apps' services will be dumped below in dumpsys activity service all-non-platform.
1945 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
1946 SEC_TO_MSEC(10));
1947 } else {
1948 // If the caller is a carrier app and has a carrier service, dump it here since we aren't
1949 // running dumpsys activity service all-non-platform below. Due to the increased output, we
1950 // give a higher timeout as well.
1951 RunDumpsys("DUMPSYS", {"carrier_config", "--requesting-package", calling_package},
1952 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(30));
1953 }
1954 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001955 RunDumpsys("DUMPSYS", {"netpolicy"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
1956 RunDumpsys("DUMPSYS", {"network_management"}, CommandOptions::WithTimeout(90).Build(),
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07001957 SEC_TO_MSEC(10));
Hunter Knepshield0fe51b12020-03-05 16:58:20 -08001958 RunDumpsys("DUMPSYS", {"telephony.registry"}, CommandOptions::WithTimeout(90).Build(),
1959 SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001960 if (include_sensitive_info) {
1961 // Contains raw IP addresses, omit from reports on user builds.
1962 RunDumpsys("DUMPSYS", {"netd"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
1963 // Contains raw destination IP/MAC addresses, omit from reports on user builds.
1964 RunDumpsys("DUMPSYS", {"connmetrics"}, CommandOptions::WithTimeout(90).Build(),
1965 SEC_TO_MSEC(10));
1966 // Contains package/component names, omit from reports on user builds.
1967 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
1968 SEC_TO_MSEC(10));
1969 // Contains package names, but should be relatively simple to remove them (also contains
1970 // UIDs already), omit from reports on user builds.
1971 RunDumpsys("BATTERYSTATS", {"deviceidle"}, CommandOptions::WithTimeout(90).Build(),
1972 SEC_TO_MSEC(10));
1973 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07001974
1975 printf("========================================================\n");
1976 printf("== Running Application Services\n");
1977 printf("========================================================\n");
1978
1979 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
1980
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001981 if (include_sensitive_info) {
1982 printf("========================================================\n");
1983 printf("== Running Application Services (non-platform)\n");
1984 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001985
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001986 // Contains package/component names and potential PII, omit from reports on user builds.
1987 // To get dumps of the active CarrierService(s) on user builds, we supply an argument to the
1988 // carrier_config dumpsys instead.
1989 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1990 DUMPSYS_COMPONENTS_OPTIONS);
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001991
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001992 printf("========================================================\n");
1993 printf("== Checkins\n");
1994 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07001995
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001996 // Contains package/component names, omit from reports on user builds.
1997 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
1998 }
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07001999
2000 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07002001 printf("== dumpstate: done (id %d)\n", ds.id_);
2002 printf("========================================================\n");
Rhed Jaoa5de5752020-08-14 17:19:17 +08002003
2004 if (ds.dump_pool_) {
2005 ds.dump_pool_->waitForTask(DUMP_BOARD_TASK);
2006 } else {
2007 RUN_SLOW_FUNCTION_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
2008 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002009}
2010
mukesh agrawal253dad42018-01-23 21:59:59 -08002011// This method collects dumpsys for wifi debugging only
2012static void DumpstateWifiOnly() {
2013 DurationReporter duration_reporter("DUMPSTATE");
2014
Rhed Jaoa5de5752020-08-14 17:19:17 +08002015 DumpstateRadioAsRoot();
2016 if (!DropRootUser()) {
2017 return;
2018 }
2019
2020 // Starts thread pool after the root user is dropped. Only one additional
2021 // thread is needed for DumpHals in the DumpstateRadioCommon.
2022 if (ds.dump_pool_) {
2023 ds.dump_pool_->start(/*thread_counts =*/1);
2024 }
2025
mukesh agrawal253dad42018-01-23 21:59:59 -08002026 DumpstateRadioCommon();
2027
2028 printf("========================================================\n");
2029 printf("== Android Framework Services\n");
2030 printf("========================================================\n");
2031
2032 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
2033 SEC_TO_MSEC(10));
2034 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
2035 SEC_TO_MSEC(10));
2036
2037 printf("========================================================\n");
2038 printf("== dumpstate: done (id %d)\n", ds.id_);
2039 printf("========================================================\n");
2040}
2041
Nandana Duttcf419a72019-03-14 10:40:17 +00002042Dumpstate::RunStatus Dumpstate::DumpTraces(const char** path) {
Nandana Duttfaafd522019-03-11 09:23:09 +00002043 const std::string temp_file_pattern = "/data/anr/dumptrace_XXXXXX";
2044 const size_t buf_size = temp_file_pattern.length() + 1;
2045 std::unique_ptr<char[]> file_name_buf(new char[buf_size]);
2046 memcpy(file_name_buf.get(), temp_file_pattern.c_str(), buf_size);
2047
2048 // Create a new, empty file to receive all trace dumps.
2049 //
2050 // TODO: This can be simplified once we remove support for the old style
2051 // dumps. We can have a file descriptor passed in to dump_traces instead
2052 // of creating a file, closing it and then reopening it again.
2053 android::base::unique_fd fd(mkostemp(file_name_buf.get(), O_APPEND | O_CLOEXEC));
2054 if (fd < 0) {
2055 MYLOGE("mkostemp on pattern %s: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002056 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002057 }
2058
2059 // Nobody should have access to this temporary file except dumpstate, but we
2060 // temporarily grant 'read' to 'others' here because this file is created
2061 // when tombstoned is still running as root, but dumped after dropping. This
2062 // can go away once support for old style dumping has.
2063 const int chmod_ret = fchmod(fd, 0666);
2064 if (chmod_ret < 0) {
2065 MYLOGE("fchmod on %s failed: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002066 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002067 }
2068
2069 std::unique_ptr<DIR, decltype(&closedir)> proc(opendir("/proc"), closedir);
2070 if (proc.get() == nullptr) {
2071 MYLOGE("opendir /proc failed: %s\n", strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002072 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002073 }
2074
2075 // Number of times process dumping has timed out. If we encounter too many
2076 // failures, we'll give up.
2077 int timeout_failures = 0;
2078 bool dalvik_found = false;
2079
2080 const std::set<int> hal_pids = get_interesting_hal_pids();
2081
2082 struct dirent* d;
2083 while ((d = readdir(proc.get()))) {
Nandana Duttcf419a72019-03-14 10:40:17 +00002084 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttfaafd522019-03-11 09:23:09 +00002085 int pid = atoi(d->d_name);
2086 if (pid <= 0) {
2087 continue;
2088 }
2089
2090 const std::string link_name = android::base::StringPrintf("/proc/%d/exe", pid);
2091 std::string exe;
2092 if (!android::base::Readlink(link_name, &exe)) {
2093 continue;
2094 }
2095
2096 bool is_java_process;
2097 if (exe == "/system/bin/app_process32" || exe == "/system/bin/app_process64") {
2098 // Don't bother dumping backtraces for the zygote.
2099 if (IsZygote(pid)) {
2100 continue;
2101 }
2102
2103 dalvik_found = true;
2104 is_java_process = true;
2105 } else if (should_dump_native_traces(exe.c_str()) || hal_pids.find(pid) != hal_pids.end()) {
2106 is_java_process = false;
2107 } else {
2108 // Probably a native process we don't care about, continue.
2109 continue;
2110 }
2111
2112 // If 3 backtrace dumps fail in a row, consider debuggerd dead.
2113 if (timeout_failures == 3) {
2114 dprintf(fd, "ERROR: Too many stack dump failures, exiting.\n");
2115 break;
2116 }
2117
2118 const uint64_t start = Nanotime();
2119 const int ret = dump_backtrace_to_file_timeout(
2120 pid, is_java_process ? kDebuggerdJavaBacktrace : kDebuggerdNativeBacktrace,
2121 is_java_process ? 5 : 20, fd);
2122
2123 if (ret == -1) {
2124 // For consistency, the header and footer to this message match those
2125 // dumped by debuggerd in the success case.
2126 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
2127 dprintf(fd, "Dump failed, likely due to a timeout.\n");
2128 dprintf(fd, "---- end %d ----", pid);
2129 timeout_failures++;
2130 continue;
2131 }
2132
2133 // We've successfully dumped stack traces, reset the failure count
2134 // and write a summary of the elapsed time to the file and continue with the
2135 // next process.
2136 timeout_failures = 0;
2137
2138 dprintf(fd, "[dump %s stack %d: %.3fs elapsed]\n", is_java_process ? "dalvik" : "native",
2139 pid, (float)(Nanotime() - start) / NANOS_PER_SEC);
2140 }
2141
2142 if (!dalvik_found) {
2143 MYLOGE("Warning: no Dalvik processes found to dump stacks\n");
2144 }
2145
Nandana Duttcf419a72019-03-14 10:40:17 +00002146 *path = file_name_buf.release();
2147 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002148}
2149
Rhed Jao4875aa62020-07-20 17:46:29 +08002150void Dumpstate::DumpstateBoard(int out_fd) {
2151 dprintf(out_fd, "========================================================\n");
2152 dprintf(out_fd, "== Board\n");
2153 dprintf(out_fd, "========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08002154
Felipe Leme6f674ae2016-11-18 17:10:33 -08002155 if (!IsZipping()) {
Steven Moreland7440ddb2016-12-15 16:13:39 -08002156 MYLOGD("Not dumping board info because it's not a zipped bugreport\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08002157 return;
2158 }
2159
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002160 /*
2161 * mount debugfs for non-user builds which launch with S and unmount it
2162 * after invoking dumpstateBoard_* methods. This is to enable debug builds
2163 * to not have debugfs mounted during runtime. It will also ensure that
2164 * debugfs is only accessed by the dumpstate HAL.
2165 */
2166 auto api_level = android::base::GetIntProperty("ro.product.first_api_level", 0);
2167 bool mount_debugfs = !PropertiesHelper::IsUserBuild() && api_level >= 31;
2168
2169 if (mount_debugfs) {
2170 RunCommand("mount debugfs", {"mount", "-t", "debugfs", "debugfs", "/sys/kernel/debug"},
2171 AS_ROOT_20);
2172 RunCommand("chmod debugfs", {"chmod", "0755", "/sys/kernel/debug"},
2173 AS_ROOT_20);
2174 }
2175
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002176 std::vector<std::string> paths;
2177 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07002178 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002179 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
2180 kDumpstateBoardFiles[i].c_str()));
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002181 remover.emplace_back(android::base::make_scope_guard(
2182 std::bind([](std::string path) { android::os::UnlinkAndLogOnError(path); }, paths[i])));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002183 }
Jie Song9fbfad02017-06-20 16:29:42 -07002184
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002185 sp<IDumpstateDevice_1_0> dumpstate_device_1_0(IDumpstateDevice_1_0::getService());
2186 if (dumpstate_device_1_0 == nullptr) {
Wei Wang587eac92018-04-05 12:17:20 -07002187 MYLOGE("No IDumpstateDevice implementation\n");
2188 return;
2189 }
2190
2191 using ScopedNativeHandle =
2192 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
2193 ScopedNativeHandle handle(native_handle_create(static_cast<int>(paths.size()), 0),
2194 [](native_handle_t* handle) {
2195 native_handle_close(handle);
2196 native_handle_delete(handle);
2197 });
2198 if (handle == nullptr) {
2199 MYLOGE("Could not create native_handle\n");
2200 return;
2201 }
2202
Nandana Dutt5c390032019-03-12 10:52:56 +00002203 // TODO(128270426): Check for consent in between?
Wei Wang587eac92018-04-05 12:17:20 -07002204 for (size_t i = 0; i < paths.size(); i++) {
2205 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
2206
2207 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
2208 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
2209 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
2210 if (fd < 0) {
2211 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
2212 return;
2213 }
2214 handle.get()->data[i] = fd.release();
2215 }
2216
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002217 // Given that bugreport is required to diagnose failures, it's better to set an arbitrary amount
2218 // of timeout for IDumpstateDevice than to block the rest of bugreport. In the timeout case, we
2219 // will kill the HAL and grab whatever it dumped in time.
2220 constexpr size_t timeout_sec = 30;
2221 // Prefer version 1.1 if available. New devices launching with R are no longer allowed to
2222 // implement just 1.0.
2223 const char* descriptor_to_kill;
2224 using DumpstateBoardTask = std::packaged_task<bool()>;
2225 DumpstateBoardTask dumpstate_board_task;
2226 sp<IDumpstateDevice_1_1> dumpstate_device_1_1(
2227 IDumpstateDevice_1_1::castFrom(dumpstate_device_1_0));
2228 if (dumpstate_device_1_1 != nullptr) {
2229 MYLOGI("Using IDumpstateDevice v1.1");
2230 descriptor_to_kill = IDumpstateDevice_1_1::descriptor;
2231 dumpstate_board_task = DumpstateBoardTask([this, dumpstate_device_1_1, &handle]() -> bool {
2232 ::android::hardware::Return<DumpstateStatus> status =
2233 dumpstate_device_1_1->dumpstateBoard_1_1(handle.get(), options_->dumpstate_hal_mode,
2234 SEC_TO_MSEC(timeout_sec));
2235 if (!status.isOk()) {
2236 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2237 return false;
2238 } else if (status != DumpstateStatus::OK) {
2239 MYLOGE("dumpstateBoard failed with DumpstateStatus::%s\n", toString(status).c_str());
2240 return false;
2241 }
2242 return true;
2243 });
2244 } else {
2245 MYLOGI("Using IDumpstateDevice v1.0");
2246 descriptor_to_kill = IDumpstateDevice_1_0::descriptor;
2247 dumpstate_board_task = DumpstateBoardTask([dumpstate_device_1_0, &handle]() -> bool {
2248 ::android::hardware::Return<void> status =
2249 dumpstate_device_1_0->dumpstateBoard(handle.get());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002250 if (!status.isOk()) {
2251 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
Wei Wang587eac92018-04-05 12:17:20 -07002252 return false;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002253 }
Wei Wang587eac92018-04-05 12:17:20 -07002254 return true;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002255 });
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002256 }
2257 auto result = dumpstate_board_task.get_future();
2258 std::thread(std::move(dumpstate_board_task)).detach();
Wei Wang587eac92018-04-05 12:17:20 -07002259
Wei Wang587eac92018-04-05 12:17:20 -07002260 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2261 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate vendor HAL\n", timeout_sec);
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002262 if (!android::base::SetProperty(
2263 "ctl.interface_restart",
2264 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
Wei Wang587eac92018-04-05 12:17:20 -07002265 MYLOGE("Couldn't restart dumpstate HAL\n");
2266 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002267 }
Wei Wang587eac92018-04-05 12:17:20 -07002268 // Wait some time for init to kill dumpstate vendor HAL
2269 constexpr size_t killing_timeout_sec = 10;
2270 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2271 MYLOGE("killing dumpstateBoard timed out after %zus, continue and "
2272 "there might be racing in content\n", killing_timeout_sec);
2273 }
2274
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002275 if (mount_debugfs) {
2276 RunCommand("unmount debugfs", {"umount", "/sys/kernel/debug"}, AS_ROOT_20);
2277 }
2278
Wei Wang587eac92018-04-05 12:17:20 -07002279 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
2280 for (size_t i = 0; i < paths.size(); i++) {
2281 struct stat s;
2282 if (fstat(handle.get()->data[i], &s) == -1) {
2283 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(),
2284 strerror(errno));
2285 file_sizes[i] = -1;
2286 continue;
2287 }
2288 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002289 }
2290
2291 for (size_t i = 0; i < paths.size(); i++) {
2292 if (file_sizes[i] == -1) {
2293 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002294 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002295 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07002296 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002297 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002298 }
Rhed Jao4875aa62020-07-20 17:46:29 +08002299 remover[i].Disable();
2300 EnqueueAddZipEntryAndCleanupIfNeeded(kDumpstateBoardFiles[i], paths[i]);
2301 dprintf(out_fd, "*** See %s entry ***\n", kDumpstateBoardFiles[i].c_str());
Jie Song9fbfad02017-06-20 16:29:42 -07002302 }
Felipe Leme6f674ae2016-11-18 17:10:33 -08002303}
2304
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002305static void ShowUsage() {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002306 fprintf(stderr,
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002307 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-o directory] [-p] "
2308 "[-s] [-S] [-q] [-P] [-R] [-L] [-V version]\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002309 " -h: display this help message\n"
2310 " -b: play sound file instead of vibrate, at beginning of job\n"
2311 " -e: play sound file instead of vibrate, at end of job\n"
mhasank2d75c442020-06-11 15:05:25 -07002312 " -o: write to custom directory (only in limited mode)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01002313 " -p: capture screenshot to filename.png\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002314 " -s: write zipped file to control socket (for init)\n"
2315 " -S: write file location to control socket (for init)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002316 " -q: disable vibrate\n"
Abhijeet Kaure370d682019-10-01 16:49:30 +01002317 " -P: send broadcast when started and do progress updates\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002318 " -R: take bugreport in remote mode (shouldn't be used with -P)\n"
Nandana Dutt235864b2019-01-22 12:10:16 +00002319 " -w: start binder service and make it wait for a call to startBugreport\n"
mhasankd451a472020-05-26 18:02:39 -07002320 " -L: output limited information that is safe for submission in feedback reports\n"
Felipe Lemed071c682016-10-20 16:48:00 -07002321 " -v: prints the dumpstate header and exit\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002322}
2323
Wei Liuf87959e2016-08-26 14:51:42 -07002324static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07002325 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07002326}
2327
Felipe Leme1d486fe2016-10-14 18:06:47 -07002328bool Dumpstate::FinishZipFile() {
Rhed Jao4875aa62020-07-20 17:46:29 +08002329 // Runs all enqueued adding zip entry and cleanup tasks before finishing the zip file.
2330 if (zip_entry_tasks_) {
2331 zip_entry_tasks_->run(/* do_cancel = */false);
2332 }
2333
Felipe Leme9a523ae2016-10-20 15:10:33 -07002334 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07002335 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07002336 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002337 // Final timestamp
2338 char date[80];
2339 time_t the_real_now_please_stand_up = time(nullptr);
2340 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002341 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07002342 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002343
Felipe Leme9a523ae2016-10-20 15:10:33 -07002344 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002345 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08002346 return false;
2347 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07002348 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002349 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08002350 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08002351 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08002352
Felipe Leme0f3fb202016-06-10 17:10:53 -07002353 // Add log file (which contains stderr output) to zip...
2354 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07002355 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07002356 MYLOGE("Failed to add dumpstate log to .zip file\n");
2357 return false;
2358 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002359 // TODO: Should truncate the existing file.
2360 // ... and re-open it for further logging.
Nandana Dutta344cb62019-02-22 15:12:35 +00002361 if (!redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()))) {
2362 return false;
2363 }
Felipe Leme0f3fb202016-06-10 17:10:53 -07002364 fprintf(stderr, "\n");
2365
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002366 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07002367 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002368 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002369 return false;
2370 }
2371
Felipe Leme1d486fe2016-10-14 18:06:47 -07002372 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
2373 ds.zip_file.reset(nullptr);
2374
Felipe Lemee9d2c542016-11-15 11:48:26 -08002375 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002376 android::os::UnlinkAndLogOnError(tmp_path_);
Felipe Lemec4eee562016-04-21 15:42:55 -07002377
Felipe Leme1e9edc62015-12-21 16:02:13 -08002378 return true;
2379}
Felipe Leme6e01fa62015-11-11 19:35:14 -08002380
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002381static void SendBroadcast(const std::string& action, const std::vector<std::string>& args) {
2382 // clang-format off
2383 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user", "0",
2384 "--receiver-foreground", "--receiver-include-background", "-a", action};
2385 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08002386
2387 am.insert(am.end(), args.begin(), args.end());
2388
Felipe Leme8d2410e2017-02-08 09:46:08 -08002389 RunCommand("", am,
2390 CommandOptions::WithTimeout(20)
2391 .Log("Sending broadcast: '%s'\n")
2392 .Always()
2393 .DropRoot()
2394 .RedirectStderr()
2395 .Build());
2396}
2397
Felipe Leme35b8cf12017-02-10 15:47:29 -08002398static void Vibrate(int duration_ms) {
2399 // clang-format off
Chris Fries0c3de872019-09-14 15:49:41 +00002400 RunCommand("", {"cmd", "vibrator", "vibrate", "-f", std::to_string(duration_ms), "dumpstate"},
Felipe Leme35b8cf12017-02-10 15:47:29 -08002401 CommandOptions::WithTimeout(10)
2402 .Log("Vibrate: '%s'\n")
2403 .Always()
2404 .Build());
2405 // clang-format on
2406}
2407
Nandana Dutt979388e2018-11-30 16:48:55 +00002408static void MaybeResolveSymlink(std::string* path) {
2409 std::string resolved_path;
2410 if (android::base::Readlink(*path, &resolved_path)) {
2411 *path = resolved_path;
2412 }
2413}
2414
Nandana Dutt4be45d12018-09-26 15:04:23 +01002415/*
2416 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002417 * and adds the version file. Return false if zip_file could not be open to write.
Nandana Dutt4be45d12018-09-26 15:04:23 +01002418 */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002419static bool PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002420 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
2421
Nandana Dutt4be45d12018-09-26 15:04:23 +01002422 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
2423 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002424 ds.base_name_ = StringPrintf("bugreport-%s-%s", device_name.c_str(), build_id.c_str());
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002425 char date[80];
2426 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
2427 ds.name_ = date;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002428
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002429 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002430 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002431 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002432 ds.base_name_ += "-wifi";
2433 }
2434
Paul Chang0d2aad72020-02-13 20:04:03 +08002435 if (ds.options_->do_screenshot) {
Nandana Dutt9d17b942020-03-26 10:02:59 +00002436 ds.screenshot_path_ = ds.GetPath(ds.CalledByApi() ? "-png.tmp" : ".png");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002437 }
2438 ds.tmp_path_ = ds.GetPath(".tmp");
2439 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
2440
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002441 std::string destination = ds.CalledByApi()
Nandana Dutt54dbd672019-01-11 12:58:05 +00002442 ? StringPrintf("[fd:%d]", ds.options_->bugreport_fd.get())
Nandana Dutt9a76d202019-01-21 15:56:48 +00002443 : ds.bugreport_internal_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01002444 MYLOGD(
Nandana Dutt235c6672019-11-14 15:22:32 +00002445 "Bugreport dir: [%s] "
2446 "Base name: [%s] "
2447 "Suffix: [%s] "
2448 "Log path: [%s] "
2449 "Temporary path: [%s] "
2450 "Screenshot path: [%s]\n",
Nandana Dutt9a76d202019-01-21 15:56:48 +00002451 destination.c_str(), ds.base_name_.c_str(), ds.name_.c_str(), ds.log_path_.c_str(),
2452 ds.tmp_path_.c_str(), ds.screenshot_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002453
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002454 ds.path_ = ds.GetPath(ds.CalledByApi() ? "-zip.tmp" : ".zip");
2455 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
2456 create_parent_dirs(ds.path_.c_str());
2457 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
2458 if (ds.zip_file == nullptr) {
2459 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
2460 return false;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002461 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002462 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
2463 ds.AddTextZipEntry("version.txt", ds.version_);
2464 return true;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002465}
2466
2467/*
Abhijeet Kaure370d682019-10-01 16:49:30 +01002468 * Finalizes writing to the file by zipping the tmp file to the final location,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002469 * printing zipped file status, etc.
2470 */
2471static void FinalizeFile() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002472 bool do_text_file = !ds.FinishZipFile();
2473 if (do_text_file) {
2474 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002475 }
mhasank2d75c442020-06-11 15:05:25 -07002476
2477 std::string final_path = ds.path_;
2478 if (ds.options_->OutputToCustomFile()) {
mhasank3a4cfb42020-06-15 18:06:43 -07002479 final_path = ds.GetPath(ds.options_->out_dir, ".zip");
mhasank2d75c442020-06-11 15:05:25 -07002480 android::os::CopyFileToFile(ds.path_, final_path);
Nandana Dutt4be45d12018-09-26 15:04:23 +01002481 }
mhasank2d75c442020-06-11 15:05:25 -07002482
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002483 if (ds.options_->stream_to_socket) {
2484 android::os::CopyFileToFd(ds.path_, ds.control_socket_fd_);
2485 } else if (ds.options_->progress_updates_to_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002486 if (do_text_file) {
2487 dprintf(ds.control_socket_fd_,
2488 "FAIL:could not create zip file, check %s "
2489 "for more details\n",
2490 ds.log_path_.c_str());
2491 } else {
mhasank2d75c442020-06-11 15:05:25 -07002492 dprintf(ds.control_socket_fd_, "OK:%s\n", final_path.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002493 }
2494 }
2495}
2496
Nandana Dutt4be45d12018-09-26 15:04:23 +01002497
Nandana Dutt58d72e22018-11-16 10:30:48 +00002498static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2499 switch (mode) {
2500 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2501 return "BUGREPORT_FULL";
2502 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2503 return "BUGREPORT_INTERACTIVE";
2504 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2505 return "BUGREPORT_REMOTE";
2506 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2507 return "BUGREPORT_WEAR";
2508 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2509 return "BUGREPORT_TELEPHONY";
2510 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2511 return "BUGREPORT_WIFI";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002512 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2513 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002514 }
2515}
2516
Paul Changf59c2b72020-03-10 02:08:55 +08002517static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options,
2518 bool is_screenshot_requested) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002519 // Modify com.android.shell.BugreportProgressService#isDefaultScreenshotRequired as well for
2520 // default system screenshots.
Abhijeet Kaure370d682019-10-01 16:49:30 +01002521 options->bugreport_mode = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002522 switch (mode) {
2523 case Dumpstate::BugreportMode::BUGREPORT_FULL:
Paul Changf59c2b72020-03-10 02:08:55 +08002524 options->do_screenshot = is_screenshot_requested;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002525 options->dumpstate_hal_mode = DumpstateMode::FULL;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002526 break;
2527 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002528 // Currently, the dumpstate binder is only used by Shell to update progress.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002529 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002530 options->do_screenshot = is_screenshot_requested;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002531 options->dumpstate_hal_mode = DumpstateMode::INTERACTIVE;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002532 break;
2533 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002534 options->do_vibrate = false;
2535 options->is_remote_mode = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002536 options->do_screenshot = false;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002537 options->dumpstate_hal_mode = DumpstateMode::REMOTE;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002538 break;
2539 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002540 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002541 options->do_screenshot = is_screenshot_requested;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002542 options->dumpstate_hal_mode = DumpstateMode::WEAR;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002543 break;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002544 // TODO(b/148168577) rename TELEPHONY everywhere to CONNECTIVITY.
Nandana Dutt58d72e22018-11-16 10:30:48 +00002545 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002546 options->telephony_only = true;
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002547 options->do_progress_updates = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002548 options->do_screenshot = false;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002549 options->dumpstate_hal_mode = DumpstateMode::CONNECTIVITY;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002550 break;
2551 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002552 options->wifi_only = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002553 options->do_screenshot = false;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002554 options->dumpstate_hal_mode = DumpstateMode::WIFI;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002555 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002556 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2557 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002558 }
2559}
2560
Nandana Dutt58d72e22018-11-16 10:30:48 +00002561static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
Nandana Dutt235c6672019-11-14 15:22:32 +00002562 MYLOGI(
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002563 "do_vibrate: %d stream_to_socket: %d progress_updates_to_socket: %d do_screenshot: %d "
Rhed Jao6f5ddce2020-08-20 00:10:32 +08002564 "is_remote_mode: %d show_header_only: %d telephony_only: %d "
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002565 "wifi_only: %d do_progress_updates: %d fd: %d bugreport_mode: %s dumpstate_hal_mode: %s "
mhasankd451a472020-05-26 18:02:39 -07002566 "limited_only: %d args: %s\n",
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002567 options.do_vibrate, options.stream_to_socket, options.progress_updates_to_socket,
Paul Chang0d2aad72020-02-13 20:04:03 +08002568 options.do_screenshot, options.is_remote_mode, options.show_header_only,
Rhed Jao6f5ddce2020-08-20 00:10:32 +08002569 options.telephony_only, options.wifi_only,
mhasankd451a472020-05-26 18:02:39 -07002570 options.do_progress_updates, options.bugreport_fd.get(), options.bugreport_mode.c_str(),
2571 toString(options.dumpstate_hal_mode).c_str(), options.limited_only, options.args.c_str());
Nandana Dutt58d72e22018-11-16 10:30:48 +00002572}
2573
Nandana Dutt54dbd672019-01-11 12:58:05 +00002574void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode,
2575 const android::base::unique_fd& bugreport_fd_in,
Paul Changf59c2b72020-03-10 02:08:55 +08002576 const android::base::unique_fd& screenshot_fd_in,
2577 bool is_screenshot_requested) {
Nandana Dutt54dbd672019-01-11 12:58:05 +00002578 // Duplicate the fds because the passed in fds don't outlive the binder transaction.
2579 bugreport_fd.reset(dup(bugreport_fd_in.get()));
2580 screenshot_fd.reset(dup(screenshot_fd_in.get()));
Nandana Dutt58d72e22018-11-16 10:30:48 +00002581
Paul Changf59c2b72020-03-10 02:08:55 +08002582 SetOptionsFromMode(bugreport_mode, this, is_screenshot_requested);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002583}
2584
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002585Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
2586 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002587 int c;
mhasankd451a472020-05-26 18:02:39 -07002588 while ((c = getopt(argc, argv, "dho:svqzpLPBRSV:w")) != -1) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002589 switch (c) {
2590 // clang-format off
mhasank3a4cfb42020-06-15 18:06:43 -07002591 case 'o': out_dir = optarg; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002592 case 's': stream_to_socket = true; break;
2593 case 'S': progress_updates_to_socket = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002594 case 'v': show_header_only = true; break;
2595 case 'q': do_vibrate = false; break;
Paul Chang0d2aad72020-02-13 20:04:03 +08002596 case 'p': do_screenshot = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002597 case 'P': do_progress_updates = true; break;
2598 case 'R': is_remote_mode = true; break;
mhasankd451a472020-05-26 18:02:39 -07002599 case 'L': limited_only = true; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002600 case 'V':
2601 case 'd':
2602 case 'z':
2603 // compatibility no-op
2604 break;
Nandana Dutt235864b2019-01-22 12:10:16 +00002605 case 'w':
2606 // This was already processed
2607 break;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002608 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002609 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002610 break;
2611 default:
2612 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002613 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002614 break;
2615 // clang-format on
2616 }
2617 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08002618
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002619 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002620 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002621 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002622 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002623 }
2624 }
2625
2626 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
2627 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002628
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002629 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002630}
2631
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002632bool Dumpstate::DumpOptions::ValidateOptions() const {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002633 if (bugreport_fd.get() != -1 && stream_to_socket) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002634 return false;
2635 }
2636
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002637 if ((progress_updates_to_socket || do_progress_updates) && stream_to_socket) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002638 return false;
2639 }
2640
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002641 if (is_remote_mode && (do_progress_updates || stream_to_socket)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002642 return false;
2643 }
2644 return true;
2645}
2646
Nandana Dutt197661d2018-11-16 16:40:21 +00002647void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
2648 options_ = std::move(options);
2649}
2650
Abhijeet Kaura407fb82020-03-27 12:51:12 +00002651void Dumpstate::Initialize() {
2652 /* gets the sequential id */
2653 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
2654 id_ = ++last_id;
2655 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
2656}
2657
Nandana Duttd2f5f082019-01-18 17:13:52 +00002658Dumpstate::RunStatus Dumpstate::Run(int32_t calling_uid, const std::string& calling_package) {
2659 Dumpstate::RunStatus status = RunInternal(calling_uid, calling_package);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002660 if (listener_ != nullptr) {
2661 switch (status) {
2662 case Dumpstate::RunStatus::OK:
Nandana Duttcc4ead82019-01-23 08:29:23 +00002663 listener_->onFinished();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002664 break;
2665 case Dumpstate::RunStatus::HELP:
2666 break;
2667 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002668 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_INVALID_INPUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002669 break;
2670 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002671 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_RUNTIME_ERROR);
2672 break;
2673 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2674 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_DENIED_CONSENT);
2675 break;
2676 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
2677 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_CONSENT_TIMED_OUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002678 break;
2679 }
2680 }
2681 return status;
2682}
2683
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002684void Dumpstate::Cancel() {
2685 CleanupTmpFiles();
2686 android::os::UnlinkAndLogOnError(log_path_);
2687 for (int i = 0; i < NUM_OF_DUMPS; i++) {
2688 android::os::UnlinkAndLogOnError(ds.bugreport_internal_dir_ + "/" +
2689 kDumpstateBoardFiles[i]);
2690 }
2691 tombstone_data_.clear();
2692 anr_data_.clear();
Rhed Jaoe96bcd52020-08-21 14:48:20 +08002693
2694 // Instead of shutdown the pool, we delete temporary files directly since
2695 // shutdown blocking the call.
2696 if (dump_pool_) {
2697 dump_pool_->deleteTempFiles();
2698 }
2699 if (zip_entry_tasks_) {
2700 zip_entry_tasks_->run(/*do_cancel =*/ true);
2701 }
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002702}
2703
Nandana Dutt979388e2018-11-30 16:48:55 +00002704/*
2705 * Dumps relevant information to a bugreport based on the given options.
2706 *
2707 * The bugreport can be dumped to a file or streamed to a socket.
2708 *
2709 * How dumping to file works:
2710 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
2711 * stderr is redirected a log file.
2712 *
2713 * The temporary bugreport is then populated via printfs, dumping contents of files and
2714 * output of commands to stdout.
2715 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002716 * A bunch of other files and dumps are added to the zip archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00002717 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002718 * The temporary bugreport file and the log file also get added to the archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00002719 *
mhasank2d75c442020-06-11 15:05:25 -07002720 * Bugreports are first generated in a local directory and later copied to the caller's fd
2721 * or directory if supplied.
Nandana Dutt979388e2018-11-30 16:48:55 +00002722 */
Nandana Duttd2f5f082019-01-18 17:13:52 +00002723Dumpstate::RunStatus Dumpstate::RunInternal(int32_t calling_uid,
2724 const std::string& calling_package) {
Rhed Jao1c855122020-07-16 17:37:39 +08002725 DurationReporter duration_reporter("RUN INTERNAL", /* logcat_only = */true);
Nandana Dutt979388e2018-11-30 16:48:55 +00002726 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00002727 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002728 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002729 return RunStatus::INVALID_INPUT;
2730 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002731 /* set as high priority, and protect from OOM killer */
2732 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002733
Felipe Lemed071c682016-10-20 16:48:00 -07002734 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002735 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002736 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002737 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002738 } else {
2739 /* fallback to kernels <= 2.6.35 */
2740 oom_adj = fopen("/proc/self/oom_adj", "we");
2741 if (oom_adj) {
2742 fputs("-17", oom_adj);
2743 fclose(oom_adj);
2744 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002745 }
2746
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002747 if (version_ == VERSION_DEFAULT) {
2748 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00002749 }
2750
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002751 if (version_ != VERSION_CURRENT && version_ != VERSION_SPLIT_ANR) {
Vishnu Nair64afc022018-02-01 15:29:34 -08002752 MYLOGE("invalid version requested ('%s'); suppported values are: ('%s', '%s', '%s')\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002753 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str(),
Vishnu Nair64afc022018-02-01 15:29:34 -08002754 VERSION_SPLIT_ANR.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002755 return RunStatus::INVALID_INPUT;
Felipe Lemed071c682016-10-20 16:48:00 -07002756 }
2757
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002758 if (options_->show_header_only) {
2759 PrintHeader();
2760 return RunStatus::OK;
Felipe Lemed071c682016-10-20 16:48:00 -07002761 }
2762
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002763 MYLOGD("dumpstate calling_uid = %d ; calling package = %s \n",
2764 calling_uid, calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00002765
Felipe Leme7447d7c2016-11-03 18:12:22 -07002766 // TODO: temporarily set progress until it's part of the Dumpstate constructor
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002767 std::string stats_path =
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002768 android::base::StringPrintf("%s/dumpstate-stats.txt", bugreport_internal_dir_.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002769 progress_.reset(new Progress(stats_path));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002770
Sahana Raof35ed432019-07-12 10:47:52 +01002771 if (acquire_wake_lock(PARTIAL_WAKE_LOCK, WAKE_LOCK_NAME) < 0) {
2772 MYLOGE("Failed to acquire wake lock: %s\n", strerror(errno));
2773 } else {
2774 // Wake lock will be released automatically on process death
2775 MYLOGD("Wake lock acquired.\n");
2776 }
2777
Felipe Leme6ae5c4f2017-01-10 14:13:22 -08002778 register_sig_handler();
Felipe Lemed071c682016-10-20 16:48:00 -07002779
Felipe Lemef0292972016-11-22 13:57:05 -08002780 if (PropertiesHelper::IsDryRun()) {
Felipe Lemed071c682016-10-20 16:48:00 -07002781 MYLOGI("Running on dry-run mode (to disable it, call 'setprop dumpstate.dry_run false')\n");
2782 }
2783
Nandana Dutt235c6672019-11-14 15:22:32 +00002784 MYLOGI("dumpstate info: id=%d, args='%s', bugreport_mode= %s bugreport format version: %s\n",
2785 id_, options_->args.c_str(), options_->bugreport_mode.c_str(), version_.c_str());
Felipe Leme809d74e2016-02-02 12:57:00 -08002786
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002787 do_early_screenshot_ = options_->do_progress_updates;
Felipe Lemee338bf62015-12-07 14:03:50 -08002788
Christopher Ferrised9354f2014-10-01 17:35:01 -07002789 // If we are going to use a socket, do it as early as possible
2790 // to avoid timeouts from bugreport.
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002791 if (options_->stream_to_socket || options_->progress_updates_to_socket) {
Felipe Leme2628e9e2016-04-12 16:36:51 -07002792 MYLOGD("Opening control socket\n");
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002793 control_socket_fd_ = open_socket_fn_("dumpstate");
Nandana Dutta344cb62019-02-22 15:12:35 +00002794 if (control_socket_fd_ == -1) {
2795 return ERROR;
2796 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002797 if (options_->progress_updates_to_socket) {
2798 options_->do_progress_updates = 1;
2799 }
Felipe Leme2628e9e2016-04-12 16:36:51 -07002800 }
2801
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002802 if (!PrepareToWriteToFile()) {
2803 return ERROR;
2804 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08002805
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002806 // Interactive, wear & telephony modes are default to true.
2807 // and may enable from cli option or when using control socket
2808 if (options_->do_progress_updates) {
2809 // clang-format off
2810 std::vector<std::string> am_args = {
2811 "--receiver-permission", "android.permission.DUMP",
2812 };
2813 // clang-format on
2814 // Send STARTED broadcast for apps that listen to bugreport generation events
2815 SendBroadcast("com.android.internal.intent.action.BUGREPORT_STARTED", am_args);
2816 if (options_->progress_updates_to_socket) {
2817 dprintf(control_socket_fd_, "BEGIN:%s\n", path_.c_str());
Felipe Leme71bbfc52015-11-23 14:14:51 -08002818 }
2819 }
2820
Nick Kralevichf3599b32016-01-25 15:05:16 -08002821 /* read /proc/cmdline before dropping root */
2822 FILE *cmdline = fopen("/proc/cmdline", "re");
2823 if (cmdline) {
2824 fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
2825 fclose(cmdline);
2826 }
2827
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002828 if (options_->do_vibrate) {
Felipe Leme35b8cf12017-02-10 15:47:29 -08002829 Vibrate(150);
John Michelau1f794c42012-09-17 11:20:19 -05002830 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002831
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002832 if (zip_file != nullptr) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002833 if (chown(path_.c_str(), AID_SHELL, AID_SHELL)) {
2834 MYLOGE("Unable to change ownership of zip file %s: %s\n", path_.c_str(),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002835 strerror(errno));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002836 }
2837 }
2838
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002839 int dup_stdout_fd;
2840 int dup_stderr_fd;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002841 // Redirect stderr to log_path_ for debugging.
2842 TEMP_FAILURE_RETRY(dup_stderr_fd = dup(fileno(stderr)));
2843 if (!redirect_to_file(stderr, const_cast<char*>(log_path_.c_str()))) {
2844 return ERROR;
2845 }
2846 if (chown(log_path_.c_str(), AID_SHELL, AID_SHELL)) {
2847 MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n", log_path_.c_str(),
2848 strerror(errno));
2849 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002850
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002851 // Redirect stdout to tmp_path_. This is the main bugreport entry and will be
2852 // moved into zip file later, if zipping.
2853 TEMP_FAILURE_RETRY(dup_stdout_fd = dup(fileno(stdout)));
2854 // TODO: why not write to a file instead of stdout to overcome this problem?
2855 /* TODO: rather than generating a text file now and zipping it later,
2856 it would be more efficient to redirect stdout to the zip entry
2857 directly, but the libziparchive doesn't support that option yet. */
2858 if (!redirect_to_file(stdout, const_cast<char*>(tmp_path_.c_str()))) {
2859 return ERROR;
2860 }
2861 if (chown(tmp_path_.c_str(), AID_SHELL, AID_SHELL)) {
2862 MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
2863 tmp_path_.c_str(), strerror(errno));
Colin Crossf45fa6b2012-03-26 12:38:26 -07002864 }
Felipe Lemed8b94e52016-12-08 10:21:44 -08002865
2866 // Don't buffer stdout
2867 setvbuf(stdout, nullptr, _IONBF, 0);
2868
Rhed Jao1c855122020-07-16 17:37:39 +08002869 // Enable the parallel run if the client requests to output to a file.
2870 EnableParallelRunIfNeeded();
2871 // Using scope guard to make sure the dump pool can be shut down correctly.
2872 auto scope_guard_to_shutdown_pool = android::base::make_scope_guard([=]() {
2873 ShutdownDumpPool();
2874 });
2875
Felipe Leme608385d2016-02-01 10:35:38 -08002876 // NOTE: there should be no stdout output until now, otherwise it would break the header.
2877 // In particular, DurationReport objects should be created passing 'title, NULL', so their
Felipe Lemecbce55d2016-02-08 09:53:18 -08002878 // duration is logged into MYLOG instead.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002879 PrintHeader();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002880
Gavin Corkery6968f552020-11-22 18:09:05 +00002881 bool is_dumpstate_restricted = options_->telephony_only
2882 || options_->wifi_only
2883 || options_->limited_only;
2884 if (!is_dumpstate_restricted) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002885 // Invoke critical dumpsys first to preserve system state, before doing anything else.
Jichao Lie89d9c12019-11-21 19:02:51 -08002886 RunDumpsysCritical();
Gavin Corkery6968f552020-11-22 18:09:05 +00002887 }
2888 MaybeTakeEarlyScreenshot();
2889 onUiIntensiveBugreportDumpsFinished(calling_uid);
2890 MaybeCheckUserConsent(calling_uid, calling_package);
2891 if (options_->telephony_only) {
2892 DumpstateTelephonyOnly(calling_package);
2893 } else if (options_->wifi_only) {
2894 DumpstateWifiOnly();
2895 } else if (options_->limited_only) {
2896 DumpstateLimitedOnly();
2897 } else {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002898 // Dump state for the default case. This also drops root.
Jichao Lie89d9c12019-11-21 19:02:51 -08002899 RunStatus s = DumpstateDefaultAfterCritical();
Nandana Dutt5c390032019-03-12 10:52:56 +00002900 if (s != RunStatus::OK) {
Nandana Duttaac6f582019-07-26 14:32:47 +01002901 if (s == RunStatus::USER_CONSENT_DENIED) {
Nandana Dutt5c390032019-03-12 10:52:56 +00002902 HandleUserConsentDenied();
2903 }
2904 return s;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002905 }
Zhengyin Qian068ecc72016-08-10 16:48:14 -07002906 }
Felipe Leme71a74ac2016-03-17 15:43:25 -07002907
Felipe Leme55b42a62015-11-10 17:39:08 -08002908 /* close output if needed */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002909 TEMP_FAILURE_RETRY(dup2(dup_stdout_fd, fileno(stdout)));
Colin Crossf45fa6b2012-03-26 12:38:26 -07002910
Abhijeet Kaure370d682019-10-01 16:49:30 +01002911 // Zip the (now complete) .tmp file within the internal directory.
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002912 FinalizeFile();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002913
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002914 // Share the final file with the caller if the user has consented or Shell is the caller.
Nandana Duttd2f5f082019-01-18 17:13:52 +00002915 Dumpstate::RunStatus status = Dumpstate::RunStatus::OK;
Abhijeet Kaure370d682019-10-01 16:49:30 +01002916 if (CalledByApi()) {
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002917 status = CopyBugreportIfUserConsented(calling_uid);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002918 if (status != Dumpstate::RunStatus::OK &&
2919 status != Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2920 // Do an early return if there were errors. We make an exception for consent
2921 // timing out because it's possible the user got distracted. In this case the
2922 // bugreport is not shared but made available for manual retrieval.
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002923 MYLOGI("User denied consent. Returning\n");
Nandana Duttd2f5f082019-01-18 17:13:52 +00002924 return status;
2925 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002926 if (status == Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2927 MYLOGI(
2928 "Did not receive user consent yet."
2929 " Will not copy the bugreport artifacts to caller.\n");
Abhijeet Kaur57627412019-04-17 16:00:09 +01002930 const String16 incidentcompanion("incidentcompanion");
2931 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
2932 if (ics != nullptr) {
2933 MYLOGD("Canceling user consent request via incidentcompanion service\n");
2934 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
2935 consent_callback_.get());
2936 } else {
2937 MYLOGD("Unable to cancel user consent; incidentcompanion service unavailable\n");
2938 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002939 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00002940 }
2941
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002942 /* vibrate a few but shortly times to let user know it's finished */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002943 if (options_->do_vibrate) {
Takuya Ogawa47f644e2017-12-20 18:09:09 +09002944 for (int i = 0; i < 3; i++) {
2945 Vibrate(75);
2946 usleep((75 + 50) * 1000);
2947 }
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002948 }
2949
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002950 MYLOGD("Final progress: %d/%d (estimated %d)\n", progress_->Get(), progress_->GetMax(),
2951 progress_->GetInitialMax());
2952 progress_->Save();
2953 MYLOGI("done (id %d)\n", id_);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002954
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002955 TEMP_FAILURE_RETRY(dup2(dup_stderr_fd, fileno(stderr)));
Felipe Leme107a05f2016-03-08 15:11:15 -08002956
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002957 if (control_socket_fd_ != -1) {
Felipe Lemee844a9d2016-09-21 15:01:39 -07002958 MYLOGD("Closing control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002959 close(control_socket_fd_);
Felipe Leme2628e9e2016-04-12 16:36:51 -07002960 }
2961
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002962 tombstone_data_.clear();
2963 anr_data_.clear();
Narayan Kamath6b9516c2017-10-27 11:15:51 +01002964
Nandana Duttd2f5f082019-01-18 17:13:52 +00002965 return (consent_callback_ != nullptr &&
2966 consent_callback_->getResult() == UserConsentResult::UNAVAILABLE)
2967 ? USER_CONSENT_TIMED_OUT
2968 : RunStatus::OK;
2969}
2970
Paul Chang0d2aad72020-02-13 20:04:03 +08002971void Dumpstate::MaybeTakeEarlyScreenshot() {
2972 if (!options_->do_screenshot || !do_early_screenshot_) {
2973 return;
2974 }
2975
2976 TakeScreenshot();
2977}
2978
Paul Chang5702b482020-05-28 22:05:47 +08002979void Dumpstate::onUiIntensiveBugreportDumpsFinished(int32_t calling_uid) {
Paul Changc490e662020-04-11 18:14:09 +08002980 if (calling_uid == AID_SHELL || !CalledByApi()) {
2981 return;
2982 }
2983 if (listener_ != nullptr) {
2984 // Let listener know ui intensive bugreport dumps are finished, then it can do event
2985 // handling if required.
Paul Chang5702b482020-05-28 22:05:47 +08002986 listener_->onUiIntensiveBugreportDumpsFinished();
Paul Changc490e662020-04-11 18:14:09 +08002987 }
2988}
2989
Jichao Lie89d9c12019-11-21 19:02:51 -08002990void Dumpstate::MaybeCheckUserConsent(int32_t calling_uid, const std::string& calling_package) {
2991 if (calling_uid == AID_SHELL || !CalledByApi()) {
2992 // No need to get consent for shell triggered dumpstates, or not through
2993 // bugreporting API (i.e. no fd to copy back).
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002994 return;
2995 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00002996 consent_callback_ = new ConsentCallback();
2997 const String16 incidentcompanion("incidentcompanion");
2998 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
Jichao Lie89d9c12019-11-21 19:02:51 -08002999 android::String16 package(calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003000 if (ics != nullptr) {
3001 MYLOGD("Checking user consent via incidentcompanion service\n");
3002 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
Jichao Lie89d9c12019-11-21 19:02:51 -08003003 calling_uid, package, String16(), String16(),
Joe Onorato1c36d752019-03-17 18:26:43 -07003004 0x1 /* FLAG_CONFIRMATION_DIALOG */, consent_callback_.get());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003005 } else {
3006 MYLOGD("Unable to check user consent; incidentcompanion service unavailable\n");
3007 }
3008}
3009
Nandana Dutt5c390032019-03-12 10:52:56 +00003010bool Dumpstate::IsUserConsentDenied() const {
3011 return ds.consent_callback_ != nullptr &&
3012 ds.consent_callback_->getResult() == UserConsentResult::DENIED;
3013}
3014
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01003015bool Dumpstate::CalledByApi() const {
3016 return ds.options_->bugreport_fd.get() != -1 ? true : false;
3017}
3018
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003019void Dumpstate::CleanupTmpFiles() {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003020 android::os::UnlinkAndLogOnError(tmp_path_);
3021 android::os::UnlinkAndLogOnError(screenshot_path_);
3022 android::os::UnlinkAndLogOnError(path_);
3023}
3024
Rhed Jao1c855122020-07-16 17:37:39 +08003025void Dumpstate::EnableParallelRunIfNeeded() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003026 if (!PropertiesHelper::IsParallelRun()) {
Rhed Jao1c855122020-07-16 17:37:39 +08003027 return;
3028 }
3029 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao4875aa62020-07-20 17:46:29 +08003030 zip_entry_tasks_ = std::make_unique<TaskQueue>();
Rhed Jao1c855122020-07-16 17:37:39 +08003031}
3032
3033void Dumpstate::ShutdownDumpPool() {
3034 if (dump_pool_) {
3035 dump_pool_->shutdown();
3036 dump_pool_ = nullptr;
3037 }
Rhed Jao4875aa62020-07-20 17:46:29 +08003038 if (zip_entry_tasks_) {
3039 zip_entry_tasks_->run(/* do_cancel = */true);
3040 zip_entry_tasks_ = nullptr;
3041 }
3042}
3043
3044void Dumpstate::EnqueueAddZipEntryAndCleanupIfNeeded(const std::string& entry_name,
3045 const std::string& entry_path) {
3046 auto func_add_zip_entry_and_cleanup = [=](bool task_cancelled) {
3047 if (!task_cancelled) {
3048 AddZipEntry(entry_name, entry_path);
3049 }
3050 android::os::UnlinkAndLogOnError(entry_path);
3051 };
3052 if (zip_entry_tasks_) {
3053 // Enqueues AddZipEntryAndCleanup function if the parallel run is enabled.
3054 zip_entry_tasks_->add(func_add_zip_entry_and_cleanup, _1);
3055 } else {
3056 // Invokes AddZipEntryAndCleanup immediately
3057 std::invoke(func_add_zip_entry_and_cleanup, /* task_cancelled = */false);
3058 }
Rhed Jao1c855122020-07-16 17:37:39 +08003059}
3060
Nandana Duttd2f5f082019-01-18 17:13:52 +00003061Dumpstate::RunStatus Dumpstate::HandleUserConsentDenied() {
3062 MYLOGD("User denied consent; deleting files and returning\n");
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003063 CleanupTmpFiles();
Nandana Duttd2f5f082019-01-18 17:13:52 +00003064 return USER_CONSENT_DENIED;
3065}
3066
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003067Dumpstate::RunStatus Dumpstate::CopyBugreportIfUserConsented(int32_t calling_uid) {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003068 // If the caller has asked to copy the bugreport over to their directory, we need explicit
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003069 // user consent (unless the caller is Shell).
3070 UserConsentResult consent_result;
3071 if (calling_uid == AID_SHELL) {
3072 consent_result = UserConsentResult::APPROVED;
3073 } else {
3074 consent_result = consent_callback_->getResult();
3075 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003076 if (consent_result == UserConsentResult::UNAVAILABLE) {
3077 // User has not responded yet.
3078 uint64_t elapsed_ms = consent_callback_->getElapsedTimeMs();
Hunter Knepshield70610fa2020-01-03 15:27:33 -08003079 // Telephony is a fast report type, particularly on user builds where information may be
3080 // more aggressively limited. To give the user time to read the consent dialog, increase the
3081 // timeout.
3082 uint64_t timeout_ms = options_->telephony_only ? TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS
3083 : USER_CONSENT_TIMEOUT_MS;
3084 if (elapsed_ms < timeout_ms) {
3085 uint delay_seconds = (timeout_ms - elapsed_ms) / 1000;
Nandana Duttd2f5f082019-01-18 17:13:52 +00003086 MYLOGD("Did not receive user consent yet; going to wait for %d seconds", delay_seconds);
3087 sleep(delay_seconds);
3088 }
3089 consent_result = consent_callback_->getResult();
3090 }
3091 if (consent_result == UserConsentResult::DENIED) {
3092 // User has explicitly denied sharing with the app. To be safe delete the
3093 // internal bugreport & tmp files.
3094 return HandleUserConsentDenied();
3095 }
3096 if (consent_result == UserConsentResult::APPROVED) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00003097 bool copy_succeeded = android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
3098 if (copy_succeeded) {
3099 android::os::UnlinkAndLogOnError(path_);
Abhijeet Kaur9ce94672020-04-01 17:22:36 +01003100 if (options_->do_screenshot &&
3101 options_->screenshot_fd.get() != -1 &&
3102 !options_->is_screenshot_copied) {
3103 copy_succeeded = android::os::CopyFileToFd(screenshot_path_,
3104 options_->screenshot_fd.get());
3105 options_->is_screenshot_copied = copy_succeeded;
3106 if (copy_succeeded) {
3107 android::os::UnlinkAndLogOnError(screenshot_path_);
3108 }
3109 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003110 }
3111 return copy_succeeded ? Dumpstate::RunStatus::OK : Dumpstate::RunStatus::ERROR;
3112 } else if (consent_result == UserConsentResult::UNAVAILABLE) {
3113 // consent_result is still UNAVAILABLE. The user has likely not responded yet.
3114 // Since we do not have user consent to share the bugreport it does not get
3115 // copied over to the calling app but remains in the internal directory from
3116 // where the user can manually pull it.
3117 return Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT;
3118 }
3119 // Unknown result; must be a programming error.
3120 MYLOGE("Unknown user consent result:%d\n", consent_result);
3121 return Dumpstate::RunStatus::ERROR;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003122}
3123
Nandana Duttf02564e2019-02-15 15:24:24 +00003124Dumpstate::RunStatus Dumpstate::ParseCommandlineAndRun(int argc, char* argv[]) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003125 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
3126 Dumpstate::RunStatus status = options->Initialize(argc, argv);
3127 if (status == Dumpstate::RunStatus::OK) {
Nandana Duttf02564e2019-02-15 15:24:24 +00003128 SetOptions(std::move(options));
Nandana Duttd2f5f082019-01-18 17:13:52 +00003129 // When directly running dumpstate binary, the output is not expected to be written
3130 // to any external file descriptor.
Nandana Duttf02564e2019-02-15 15:24:24 +00003131 assert(options_->bugreport_fd.get() == -1);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003132
3133 // calling_uid and calling_package are for user consent to share the bugreport with
Abhijeet Kaura407fb82020-03-27 12:51:12 +00003134 // an app; they are irrelevant here because bugreport is triggered via command line.
3135 // Update Last ID before calling Run().
3136 Initialize();
Nandana Duttf02564e2019-02-15 15:24:24 +00003137 status = Run(-1 /* calling_uid */, "" /* calling_package */);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003138 }
Nandana Duttf02564e2019-02-15 15:24:24 +00003139 return status;
3140}
3141
3142/* Main entry point for dumpstate binary. */
3143int run_main(int argc, char* argv[]) {
3144 Dumpstate::RunStatus status = ds.ParseCommandlineAndRun(argc, argv);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003145
3146 switch (status) {
3147 case Dumpstate::RunStatus::OK:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003148 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003149 case Dumpstate::RunStatus::HELP:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003150 ShowUsage();
3151 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003152 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003153 fprintf(stderr, "Invalid combination of args\n");
3154 ShowUsage();
3155 exit(1);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003156 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00003157 FALLTHROUGH_INTENDED;
3158 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
3159 FALLTHROUGH_INTENDED;
3160 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003161 exit(2);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003162 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003163}
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003164
3165// TODO(111441001): Default DumpOptions to sensible values.
3166Dumpstate::Dumpstate(const std::string& version)
3167 : pid_(getpid()),
3168 options_(new Dumpstate::DumpOptions()),
Nandana Duttf02cd782019-06-14 14:25:13 +01003169 last_reported_percent_progress_(0),
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003170 version_(version),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003171 now_(time(nullptr)),
3172 open_socket_fn_(open_socket) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003173}
3174
3175Dumpstate& Dumpstate::GetInstance() {
3176 static Dumpstate singleton_(android::base::GetProperty("dumpstate.version", VERSION_CURRENT));
3177 return singleton_;
3178}
3179
Rhed Jao1c855122020-07-16 17:37:39 +08003180DurationReporter::DurationReporter(const std::string& title, bool logcat_only, bool verbose,
3181 int duration_fd) : title_(title), logcat_only_(logcat_only), verbose_(verbose),
3182 duration_fd_(duration_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003183 if (!title_.empty()) {
3184 started_ = Nanotime();
3185 }
3186}
3187
3188DurationReporter::~DurationReporter() {
3189 if (!title_.empty()) {
3190 float elapsed = (float)(Nanotime() - started_) / NANOS_PER_SEC;
chenqiwuaf8b2d92019-12-12 18:53:51 +08003191 if (elapsed >= .5f || verbose_) {
3192 MYLOGD("Duration of '%s': %.2fs\n", title_.c_str(), elapsed);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003193 }
chenqiwuaf8b2d92019-12-12 18:53:51 +08003194 if (!logcat_only_) {
3195 // Use "Yoda grammar" to make it easier to grep|sort sections.
Rhed Jao1c855122020-07-16 17:37:39 +08003196 dprintf(duration_fd_, "------ %.3fs was the duration of '%s' ------\n",
3197 elapsed, title_.c_str());
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003198 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003199 }
3200}
3201
3202const int32_t Progress::kDefaultMax = 5000;
3203
3204Progress::Progress(const std::string& path) : Progress(Progress::kDefaultMax, 1.1, path) {
3205}
3206
3207Progress::Progress(int32_t initial_max, int32_t progress, float growth_factor)
3208 : Progress(initial_max, growth_factor, "") {
3209 progress_ = progress;
3210}
3211
3212Progress::Progress(int32_t initial_max, float growth_factor, const std::string& path)
3213 : initial_max_(initial_max),
3214 progress_(0),
3215 max_(initial_max),
3216 growth_factor_(growth_factor),
3217 n_runs_(0),
3218 average_max_(0),
3219 path_(path) {
3220 if (!path_.empty()) {
3221 Load();
3222 }
3223}
3224
3225void Progress::Load() {
3226 MYLOGD("Loading stats from %s\n", path_.c_str());
3227 std::string content;
3228 if (!android::base::ReadFileToString(path_, &content)) {
3229 MYLOGI("Could not read stats from %s; using max of %d\n", path_.c_str(), max_);
3230 return;
3231 }
3232 if (content.empty()) {
3233 MYLOGE("No stats (empty file) on %s; using max of %d\n", path_.c_str(), max_);
3234 return;
3235 }
3236 std::vector<std::string> lines = android::base::Split(content, "\n");
3237
3238 if (lines.size() < 1) {
3239 MYLOGE("Invalid stats on file %s: not enough lines (%d). Using max of %d\n", path_.c_str(),
3240 (int)lines.size(), max_);
3241 return;
3242 }
3243 char* ptr;
3244 n_runs_ = strtol(lines[0].c_str(), &ptr, 10);
3245 average_max_ = strtol(ptr, nullptr, 10);
3246 if (n_runs_ <= 0 || average_max_ <= 0 || n_runs_ > STATS_MAX_N_RUNS ||
3247 average_max_ > STATS_MAX_AVERAGE) {
3248 MYLOGE("Invalid stats line on file %s: %s\n", path_.c_str(), lines[0].c_str());
3249 initial_max_ = Progress::kDefaultMax;
3250 } else {
3251 initial_max_ = average_max_;
3252 }
3253 max_ = initial_max_;
3254
3255 MYLOGI("Average max progress: %d in %d runs; estimated max: %d\n", average_max_, n_runs_, max_);
3256}
3257
3258void Progress::Save() {
3259 int32_t total = n_runs_ * average_max_ + progress_;
3260 int32_t runs = n_runs_ + 1;
3261 int32_t average = floor(((float)total) / runs);
3262 MYLOGI("Saving stats (total=%d, runs=%d, average=%d) on %s\n", total, runs, average,
3263 path_.c_str());
3264 if (path_.empty()) {
3265 return;
3266 }
3267
3268 std::string content = android::base::StringPrintf("%d %d\n", runs, average);
3269 if (!android::base::WriteStringToFile(content, path_)) {
3270 MYLOGE("Could not save stats on %s\n", path_.c_str());
3271 }
3272}
3273
3274int32_t Progress::Get() const {
3275 return progress_;
3276}
3277
3278bool Progress::Inc(int32_t delta_sec) {
3279 bool changed = false;
3280 if (delta_sec >= 0) {
3281 progress_ += delta_sec;
3282 if (progress_ > max_) {
3283 int32_t old_max = max_;
3284 max_ = floor((float)progress_ * growth_factor_);
3285 MYLOGD("Adjusting max progress from %d to %d\n", old_max, max_);
3286 changed = true;
3287 }
3288 }
3289 return changed;
3290}
3291
3292int32_t Progress::GetMax() const {
3293 return max_;
3294}
3295
3296int32_t Progress::GetInitialMax() const {
3297 return initial_max_;
3298}
3299
3300void Progress::Dump(int fd, const std::string& prefix) const {
3301 const char* pr = prefix.c_str();
3302 dprintf(fd, "%sprogress: %d\n", pr, progress_);
3303 dprintf(fd, "%smax: %d\n", pr, max_);
3304 dprintf(fd, "%sinitial_max: %d\n", pr, initial_max_);
3305 dprintf(fd, "%sgrowth_factor: %0.2f\n", pr, growth_factor_);
3306 dprintf(fd, "%spath: %s\n", pr, path_.c_str());
3307 dprintf(fd, "%sn_runs: %d\n", pr, n_runs_);
3308 dprintf(fd, "%saverage_max: %d\n", pr, average_max_);
3309}
3310
3311bool Dumpstate::IsZipping() const {
3312 return zip_writer_ != nullptr;
3313}
3314
3315std::string Dumpstate::GetPath(const std::string& suffix) const {
3316 return GetPath(bugreport_internal_dir_, suffix);
3317}
3318
3319std::string Dumpstate::GetPath(const std::string& directory, const std::string& suffix) const {
3320 return android::base::StringPrintf("%s/%s-%s%s", directory.c_str(), base_name_.c_str(),
3321 name_.c_str(), suffix.c_str());
3322}
3323
3324void Dumpstate::SetProgress(std::unique_ptr<Progress> progress) {
3325 progress_ = std::move(progress);
3326}
3327
3328void for_each_userid(void (*func)(int), const char *header) {
3329 std::string title = header == nullptr ? "for_each_userid" : android::base::StringPrintf(
3330 "for_each_userid(%s)", header);
3331 DurationReporter duration_reporter(title);
3332 if (PropertiesHelper::IsDryRun()) return;
3333
3334 DIR *d;
3335 struct dirent *de;
3336
3337 if (header) printf("\n------ %s ------\n", header);
3338 func(0);
3339
3340 if (!(d = opendir("/data/system/users"))) {
3341 printf("Failed to open /data/system/users (%s)\n", strerror(errno));
3342 return;
3343 }
3344
3345 while ((de = readdir(d))) {
3346 int userid;
3347 if (de->d_type != DT_DIR || !(userid = atoi(de->d_name))) {
3348 continue;
3349 }
3350 func(userid);
3351 }
3352
3353 closedir(d);
3354}
3355
3356static void __for_each_pid(void (*helper)(int, const char *, void *), const char *header, void *arg) {
3357 DIR *d;
3358 struct dirent *de;
3359
3360 if (!(d = opendir("/proc"))) {
3361 printf("Failed to open /proc (%s)\n", strerror(errno));
3362 return;
3363 }
3364
3365 if (header) printf("\n------ %s ------\n", header);
3366 while ((de = readdir(d))) {
3367 if (ds.IsUserConsentDenied()) {
3368 MYLOGE(
3369 "Returning early because user denied consent to share bugreport with calling app.");
3370 closedir(d);
3371 return;
3372 }
3373 int pid;
3374 int fd;
3375 char cmdpath[255];
3376 char cmdline[255];
3377
3378 if (!(pid = atoi(de->d_name))) {
3379 continue;
3380 }
3381
3382 memset(cmdline, 0, sizeof(cmdline));
3383
3384 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/cmdline", pid);
3385 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3386 TEMP_FAILURE_RETRY(read(fd, cmdline, sizeof(cmdline) - 2));
3387 close(fd);
3388 if (cmdline[0]) {
3389 helper(pid, cmdline, arg);
3390 continue;
3391 }
3392 }
3393
3394 // if no cmdline, a kernel thread has comm
3395 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/comm", pid);
3396 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3397 TEMP_FAILURE_RETRY(read(fd, cmdline + 1, sizeof(cmdline) - 4));
3398 close(fd);
3399 if (cmdline[1]) {
3400 cmdline[0] = '[';
3401 size_t len = strcspn(cmdline, "\f\b\r\n");
3402 cmdline[len] = ']';
3403 cmdline[len+1] = '\0';
3404 }
3405 }
3406 if (!cmdline[0]) {
3407 strcpy(cmdline, "N/A");
3408 }
3409 helper(pid, cmdline, arg);
3410 }
3411
3412 closedir(d);
3413}
3414
3415static void for_each_pid_helper(int pid, const char *cmdline, void *arg) {
3416 for_each_pid_func *func = (for_each_pid_func*) arg;
3417 func(pid, cmdline);
3418}
3419
3420void for_each_pid(for_each_pid_func func, const char *header) {
3421 std::string title = header == nullptr ? "for_each_pid"
3422 : android::base::StringPrintf("for_each_pid(%s)", header);
3423 DurationReporter duration_reporter(title);
3424 if (PropertiesHelper::IsDryRun()) return;
3425
3426 __for_each_pid(for_each_pid_helper, header, (void *) func);
3427}
3428
3429static void for_each_tid_helper(int pid, const char *cmdline, void *arg) {
3430 DIR *d;
3431 struct dirent *de;
3432 char taskpath[255];
3433 for_each_tid_func *func = (for_each_tid_func *) arg;
3434
3435 snprintf(taskpath, sizeof(taskpath), "/proc/%d/task", pid);
3436
3437 if (!(d = opendir(taskpath))) {
3438 printf("Failed to open %s (%s)\n", taskpath, strerror(errno));
3439 return;
3440 }
3441
3442 func(pid, pid, cmdline);
3443
3444 while ((de = readdir(d))) {
3445 if (ds.IsUserConsentDenied()) {
3446 MYLOGE(
3447 "Returning early because user denied consent to share bugreport with calling app.");
3448 closedir(d);
3449 return;
3450 }
3451 int tid;
3452 int fd;
3453 char commpath[255];
3454 char comm[255];
3455
3456 if (!(tid = atoi(de->d_name))) {
3457 continue;
3458 }
3459
3460 if (tid == pid)
3461 continue;
3462
3463 snprintf(commpath, sizeof(commpath), "/proc/%d/comm", tid);
3464 memset(comm, 0, sizeof(comm));
3465 if ((fd = TEMP_FAILURE_RETRY(open(commpath, O_RDONLY | O_CLOEXEC))) < 0) {
3466 strcpy(comm, "N/A");
3467 } else {
3468 char *c;
3469 TEMP_FAILURE_RETRY(read(fd, comm, sizeof(comm) - 2));
3470 close(fd);
3471
3472 c = strrchr(comm, '\n');
3473 if (c) {
3474 *c = '\0';
3475 }
3476 }
3477 func(pid, tid, comm);
3478 }
3479
3480 closedir(d);
3481}
3482
3483void for_each_tid(for_each_tid_func func, const char *header) {
3484 std::string title = header == nullptr ? "for_each_tid"
3485 : android::base::StringPrintf("for_each_tid(%s)", header);
3486 DurationReporter duration_reporter(title);
3487
3488 if (PropertiesHelper::IsDryRun()) return;
3489
3490 __for_each_pid(for_each_tid_helper, header, (void *) func);
3491}
3492
3493void show_wchan(int pid, int tid, const char *name) {
3494 if (PropertiesHelper::IsDryRun()) return;
3495
3496 char path[255];
3497 char buffer[255];
3498 int fd, ret, save_errno;
3499 char name_buffer[255];
3500
3501 memset(buffer, 0, sizeof(buffer));
3502
3503 snprintf(path, sizeof(path), "/proc/%d/wchan", tid);
3504 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3505 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3506 return;
3507 }
3508
3509 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3510 save_errno = errno;
3511 close(fd);
3512
3513 if (ret < 0) {
3514 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3515 return;
3516 }
3517
3518 snprintf(name_buffer, sizeof(name_buffer), "%*s%s",
3519 pid == tid ? 0 : 3, "", name);
3520
3521 printf("%-7d %-32s %s\n", tid, name_buffer, buffer);
3522
3523 return;
3524}
3525
3526// print time in centiseconds
3527static void snprcent(char *buffer, size_t len, size_t spc,
3528 unsigned long long time) {
3529 static long hz; // cache discovered hz
3530
3531 if (hz <= 0) {
3532 hz = sysconf(_SC_CLK_TCK);
3533 if (hz <= 0) {
3534 hz = 1000;
3535 }
3536 }
3537
3538 // convert to centiseconds
3539 time = (time * 100 + (hz / 2)) / hz;
3540
3541 char str[16];
3542
3543 snprintf(str, sizeof(str), " %llu.%02u",
3544 time / 100, (unsigned)(time % 100));
3545 size_t offset = strlen(buffer);
3546 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3547 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3548}
3549
3550// print permille as a percent
3551static void snprdec(char *buffer, size_t len, size_t spc, unsigned permille) {
3552 char str[16];
3553
3554 snprintf(str, sizeof(str), " %u.%u%%", permille / 10, permille % 10);
3555 size_t offset = strlen(buffer);
3556 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3557 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3558}
3559
3560void show_showtime(int pid, const char *name) {
3561 if (PropertiesHelper::IsDryRun()) return;
3562
3563 char path[255];
3564 char buffer[1023];
3565 int fd, ret, save_errno;
3566
3567 memset(buffer, 0, sizeof(buffer));
3568
3569 snprintf(path, sizeof(path), "/proc/%d/stat", pid);
3570 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3571 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3572 return;
3573 }
3574
3575 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3576 save_errno = errno;
3577 close(fd);
3578
3579 if (ret < 0) {
3580 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3581 return;
3582 }
3583
3584 // field 14 is utime
3585 // field 15 is stime
3586 // field 42 is iotime
3587 unsigned long long utime = 0, stime = 0, iotime = 0;
3588 if (sscanf(buffer,
3589 "%*u %*s %*s %*d %*d %*d %*d %*d %*d %*d %*d "
3590 "%*d %*d %llu %llu %*d %*d %*d %*d %*d %*d "
3591 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %*d "
3592 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %llu ",
3593 &utime, &stime, &iotime) != 3) {
3594 return;
3595 }
3596
3597 unsigned long long total = utime + stime;
3598 if (!total) {
3599 return;
3600 }
3601
3602 unsigned permille = (iotime * 1000 + (total / 2)) / total;
3603 if (permille > 1000) {
3604 permille = 1000;
3605 }
3606
3607 // try to beautify and stabilize columns at <80 characters
3608 snprintf(buffer, sizeof(buffer), "%-6d%s", pid, name);
3609 if ((name[0] != '[') || utime) {
3610 snprcent(buffer, sizeof(buffer), 57, utime);
3611 }
3612 snprcent(buffer, sizeof(buffer), 65, stime);
3613 if ((name[0] != '[') || iotime) {
3614 snprcent(buffer, sizeof(buffer), 73, iotime);
3615 }
3616 if (iotime) {
3617 snprdec(buffer, sizeof(buffer), 79, permille);
3618 }
3619 puts(buffer); // adds a trailing newline
3620
3621 return;
3622}
3623
3624void do_dmesg() {
3625 const char *title = "KERNEL LOG (dmesg)";
3626 DurationReporter duration_reporter(title);
3627 printf("------ %s ------\n", title);
3628
3629 if (PropertiesHelper::IsDryRun()) return;
3630
3631 /* Get size of kernel buffer */
3632 int size = klogctl(KLOG_SIZE_BUFFER, nullptr, 0);
3633 if (size <= 0) {
3634 printf("Unexpected klogctl return value: %d\n\n", size);
3635 return;
3636 }
3637 char *buf = (char *) malloc(size + 1);
3638 if (buf == nullptr) {
3639 printf("memory allocation failed\n\n");
3640 return;
3641 }
3642 int retval = klogctl(KLOG_READ_ALL, buf, size);
3643 if (retval < 0) {
3644 printf("klogctl failure\n\n");
3645 free(buf);
3646 return;
3647 }
3648 buf[retval] = '\0';
3649 printf("%s\n\n", buf);
3650 free(buf);
3651 return;
3652}
3653
3654void do_showmap(int pid, const char *name) {
3655 char title[255];
3656 char arg[255];
3657
3658 snprintf(title, sizeof(title), "SHOW MAP %d (%s)", pid, name);
3659 snprintf(arg, sizeof(arg), "%d", pid);
3660 RunCommand(title, {"showmap", "-q", arg}, CommandOptions::AS_ROOT);
3661}
3662
3663int Dumpstate::DumpFile(const std::string& title, const std::string& path) {
3664 DurationReporter duration_reporter(title);
3665
3666 int status = DumpFileToFd(STDOUT_FILENO, title, path);
3667
3668 UpdateProgress(WEIGHT_FILE);
3669
3670 return status;
3671}
3672
3673int read_file_as_long(const char *path, long int *output) {
3674 int fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC));
3675 if (fd < 0) {
3676 int err = errno;
3677 MYLOGE("Error opening file descriptor for %s: %s\n", path, strerror(err));
3678 return -1;
3679 }
3680 char buffer[50];
3681 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3682 if (bytes_read == -1) {
3683 MYLOGE("Error reading file %s: %s\n", path, strerror(errno));
3684 return -2;
3685 }
3686 if (bytes_read == 0) {
3687 MYLOGE("File %s is empty\n", path);
3688 return -3;
3689 }
3690 *output = atoi(buffer);
3691 return 0;
3692}
3693
3694/* calls skip to gate calling dump_from_fd recursively
3695 * in the specified directory. dump_from_fd defaults to
3696 * dump_file_from_fd above when set to NULL. skip defaults
3697 * to false when set to NULL. dump_from_fd will always be
3698 * called with title NULL.
3699 */
3700int dump_files(const std::string& title, const char* dir, bool (*skip)(const char* path),
3701 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
3702 DurationReporter duration_reporter(title);
3703 DIR *dirp;
3704 struct dirent *d;
3705 char *newpath = nullptr;
3706 const char *slash = "/";
3707 int retval = 0;
3708
3709 if (!title.empty()) {
3710 printf("------ %s (%s) ------\n", title.c_str(), dir);
3711 }
3712 if (PropertiesHelper::IsDryRun()) return 0;
3713
3714 if (dir[strlen(dir) - 1] == '/') {
3715 ++slash;
3716 }
3717 dirp = opendir(dir);
3718 if (dirp == nullptr) {
3719 retval = -errno;
3720 MYLOGE("%s: %s\n", dir, strerror(errno));
3721 return retval;
3722 }
3723
3724 if (!dump_from_fd) {
3725 dump_from_fd = dump_file_from_fd;
3726 }
3727 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
3728 if ((d->d_name[0] == '.')
3729 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
3730 || (d->d_name[1] == '\0'))) {
3731 continue;
3732 }
3733 asprintf(&newpath, "%s%s%s%s", dir, slash, d->d_name,
3734 (d->d_type == DT_DIR) ? "/" : "");
3735 if (!newpath) {
3736 retval = -errno;
3737 continue;
3738 }
3739 if (skip && (*skip)(newpath)) {
3740 continue;
3741 }
3742 if (d->d_type == DT_DIR) {
3743 int ret = dump_files("", newpath, skip, dump_from_fd);
3744 if (ret < 0) {
3745 retval = ret;
3746 }
3747 continue;
3748 }
3749 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(newpath, O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
3750 if (fd.get() < 0) {
3751 retval = -1;
3752 printf("*** %s: %s\n", newpath, strerror(errno));
3753 continue;
3754 }
3755 (*dump_from_fd)(nullptr, newpath, fd.get());
3756 }
3757 closedir(dirp);
3758 if (!title.empty()) {
3759 printf("\n");
3760 }
3761 return retval;
3762}
3763
3764/* fd must have been opened with the flag O_NONBLOCK. With this flag set,
3765 * it's possible to avoid issues where opening the file itself can get
3766 * stuck.
3767 */
3768int dump_file_from_fd(const char *title, const char *path, int fd) {
3769 if (PropertiesHelper::IsDryRun()) return 0;
3770
3771 int flags = fcntl(fd, F_GETFL);
3772 if (flags == -1) {
3773 printf("*** %s: failed to get flags on fd %d: %s\n", path, fd, strerror(errno));
3774 return -1;
3775 } else if (!(flags & O_NONBLOCK)) {
3776 printf("*** %s: fd must have O_NONBLOCK set.\n", path);
3777 return -1;
3778 }
3779 return DumpFileFromFdToFd(title, path, fd, STDOUT_FILENO, PropertiesHelper::IsDryRun());
3780}
3781
3782int Dumpstate::RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Rhed Jao4875aa62020-07-20 17:46:29 +08003783 const CommandOptions& options, bool verbose_duration, int out_fd) {
3784 DurationReporter duration_reporter(title, false /* logcat_only */,
3785 verbose_duration, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003786
Rhed Jao4875aa62020-07-20 17:46:29 +08003787 int status = RunCommandToFd(out_fd, title, full_command, options);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003788
3789 /* TODO: for now we're simplifying the progress calculation by using the
3790 * timeout as the weight. It's a good approximation for most cases, except when calling dumpsys,
3791 * where its weight should be much higher proportionally to its timeout.
3792 * Ideally, it should use a options.EstimatedDuration() instead...*/
3793 UpdateProgress(options.Timeout());
3794
3795 return status;
3796}
3797
3798void Dumpstate::RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsys_args,
Rhed Jao6b1ea2d2020-07-21 17:58:41 +08003799 const CommandOptions& options, long dumpsysTimeoutMs, int out_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003800 long timeout_ms = dumpsysTimeoutMs > 0 ? dumpsysTimeoutMs : options.TimeoutInMs();
3801 std::vector<std::string> dumpsys = {"/system/bin/dumpsys", "-T", std::to_string(timeout_ms)};
3802 dumpsys.insert(dumpsys.end(), dumpsys_args.begin(), dumpsys_args.end());
Rhed Jao6b1ea2d2020-07-21 17:58:41 +08003803 RunCommand(title, dumpsys, options, false, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003804}
3805
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003806static int open_socket(const char* service) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003807 int s = android_get_control_socket(service);
3808 if (s < 0) {
3809 MYLOGE("android_get_control_socket(%s): %s\n", service, strerror(errno));
3810 return -1;
3811 }
3812 fcntl(s, F_SETFD, FD_CLOEXEC);
3813
3814 // Set backlog to 0 to make sure that queue size will be minimum.
3815 // In Linux, because the minimum queue will be 1, connect() will be blocked
3816 // if the other clients already called connect() and the connection request was not accepted.
3817 if (listen(s, 0) < 0) {
3818 MYLOGE("listen(control socket): %s\n", strerror(errno));
3819 return -1;
3820 }
3821
3822 struct sockaddr addr;
3823 socklen_t alen = sizeof(addr);
Abhijeet Kaur2113cae2019-09-13 09:24:15 +01003824 int fd = accept4(s, &addr, &alen, SOCK_CLOEXEC);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003825
3826 // Close socket just after accept(), to make sure that connect() by client will get error
3827 // when the socket is used by the other services.
3828 // There is still a race condition possibility between accept and close, but there is no way
3829 // to close-on-accept atomically.
3830 // See detail; b/123306389#comment25
3831 close(s);
3832
3833 if (fd < 0) {
3834 MYLOGE("accept(control socket): %s\n", strerror(errno));
3835 return -1;
3836 }
3837
3838 return fd;
3839}
3840
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003841// TODO: should call is_valid_output_file and/or be merged into it.
3842void create_parent_dirs(const char *path) {
3843 char *chp = const_cast<char *> (path);
3844
3845 /* skip initial slash */
3846 if (chp[0] == '/')
3847 chp++;
3848
3849 /* create leading directories, if necessary */
3850 struct stat dir_stat;
3851 while (chp && chp[0]) {
3852 chp = strchr(chp, '/');
3853 if (chp) {
3854 *chp = 0;
3855 if (stat(path, &dir_stat) == -1 || !S_ISDIR(dir_stat.st_mode)) {
3856 MYLOGI("Creating directory %s\n", path);
3857 if (mkdir(path, 0770)) { /* drwxrwx--- */
3858 MYLOGE("Unable to create directory %s: %s\n", path, strerror(errno));
3859 } else if (chown(path, AID_SHELL, AID_SHELL)) {
3860 MYLOGE("Unable to change ownership of dir %s: %s\n", path, strerror(errno));
3861 }
3862 }
3863 *chp++ = '/';
3864 }
3865 }
3866}
3867
3868bool _redirect_to_file(FILE* redirect, char* path, int truncate_flag) {
3869 create_parent_dirs(path);
3870
3871 int fd = TEMP_FAILURE_RETRY(open(path,
3872 O_WRONLY | O_CREAT | truncate_flag | O_CLOEXEC | O_NOFOLLOW,
3873 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH));
3874 if (fd < 0) {
3875 MYLOGE("%s: %s\n", path, strerror(errno));
3876 return false;
3877 }
3878
3879 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
3880 close(fd);
3881 return true;
3882}
3883
3884bool redirect_to_file(FILE* redirect, char* path) {
3885 return _redirect_to_file(redirect, path, O_TRUNC);
3886}
3887
3888bool redirect_to_existing_file(FILE* redirect, char* path) {
3889 return _redirect_to_file(redirect, path, O_APPEND);
3890}
3891
3892void dump_route_tables() {
3893 DurationReporter duration_reporter("DUMP ROUTE TABLES");
3894 if (PropertiesHelper::IsDryRun()) return;
3895 const char* const RT_TABLES_PATH = "/data/misc/net/rt_tables";
3896 ds.DumpFile("RT_TABLES", RT_TABLES_PATH);
3897 FILE* fp = fopen(RT_TABLES_PATH, "re");
3898 if (!fp) {
3899 printf("*** %s: %s\n", RT_TABLES_PATH, strerror(errno));
3900 return;
3901 }
3902 char table[16];
3903 // Each line has an integer (the table number), a space, and a string (the table name). We only
3904 // need the table number. It's a 32-bit unsigned number, so max 10 chars. Skip the table name.
3905 // Add a fixed max limit so this doesn't go awry.
3906 for (int i = 0; i < 64 && fscanf(fp, " %10s %*s", table) == 1; ++i) {
3907 RunCommand("ROUTE TABLE IPv4", {"ip", "-4", "route", "show", "table", table});
3908 RunCommand("ROUTE TABLE IPv6", {"ip", "-6", "route", "show", "table", table});
3909 }
3910 fclose(fp);
3911}
3912
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003913void Dumpstate::UpdateProgress(int32_t delta_sec) {
3914 if (progress_ == nullptr) {
3915 MYLOGE("UpdateProgress: progress_ not set\n");
3916 return;
3917 }
Rhed Jao2cc4eec2020-07-21 15:42:55 +08003918 // This function updates progress related members of the dumpstate and reports
3919 // progress percentage to the bugreport client. Since it could be called by
3920 // different dump tasks at the same time if the parallel run is enabled, a
3921 // mutex lock is necessary here to synchronize the call.
3922 std::lock_guard<std::recursive_mutex> lock(mutex_);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003923
3924 // Always update progess so stats can be tuned...
Nandana Duttf02cd782019-06-14 14:25:13 +01003925 progress_->Inc(delta_sec);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003926
3927 // ...but only notifiy listeners when necessary.
3928 if (!options_->do_progress_updates) return;
3929
3930 int progress = progress_->Get();
3931 int max = progress_->GetMax();
Nandana Duttf02cd782019-06-14 14:25:13 +01003932 int percent = 100 * progress / max;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003933
Nandana Duttf02cd782019-06-14 14:25:13 +01003934 if (last_reported_percent_progress_ > 0 && percent <= last_reported_percent_progress_) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003935 return;
3936 }
Nandana Duttf02cd782019-06-14 14:25:13 +01003937 last_reported_percent_progress_ = percent;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003938
3939 if (control_socket_fd_ >= 0) {
3940 dprintf(control_socket_fd_, "PROGRESS:%d/%d\n", progress, max);
3941 fsync(control_socket_fd_);
3942 }
3943
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003944 if (listener_ != nullptr) {
Nandana Dutt235c6672019-11-14 15:22:32 +00003945 if (percent % 10 == 0) {
3946 // We don't want to spam logcat, so only log multiples of 10.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01003947 MYLOGD("Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003948 } else {
3949 // stderr is ignored on normal invocations, but useful when calling
3950 // /system/bin/dumpstate directly for debuggging.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01003951 fprintf(stderr, "Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003952 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003953
3954 listener_->onProgress(percent);
3955 }
3956}
3957
3958void Dumpstate::TakeScreenshot(const std::string& path) {
3959 const std::string& real_path = path.empty() ? screenshot_path_ : path;
3960 int status =
3961 RunCommand("", {"/system/bin/screencap", "-p", real_path},
3962 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3963 if (status == 0) {
3964 MYLOGD("Screenshot saved on %s\n", real_path.c_str());
3965 } else {
3966 MYLOGE("Failed to take screenshot on %s\n", real_path.c_str());
3967 }
Paul Chang0d2aad72020-02-13 20:04:03 +08003968 if (listener_ != nullptr) {
3969 // Show a visual indication to indicate screenshot is taken via
3970 // IDumpstateListener.onScreenshotTaken()
3971 listener_->onScreenshotTaken(status == 0);
3972 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003973}
3974
3975bool is_dir(const char* pathname) {
3976 struct stat info;
3977 if (stat(pathname, &info) == -1) {
3978 return false;
3979 }
3980 return S_ISDIR(info.st_mode);
3981}
3982
3983time_t get_mtime(int fd, time_t default_mtime) {
3984 struct stat info;
3985 if (fstat(fd, &info) == -1) {
3986 return default_mtime;
3987 }
3988 return info.st_mtime;
3989}