blob: 4eb601dd01cd7491f99cf7a65e9e7a64dbfcb272 [file] [log] [blame]
Colin Crossf45fa6b2012-03-26 12:38:26 -07001/*
2 * Copyright (C) 2008 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
Felipe Lemef0292972016-11-22 13:57:05 -080016
Mark Salyzyn6c3d90f2016-09-27 14:55:27 -070017#define LOG_TAG "dumpstate"
Colin Crossf45fa6b2012-03-26 12:38:26 -070018
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -070019#include <dirent.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070020#include <errno.h>
21#include <fcntl.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010022#include <inttypes.h>
Felipe Lemead5f6c42015-11-30 14:26:46 -080023#include <libgen.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070024#include <limits.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010025#include <math.h>
26#include <poll.h>
Mark Salyzyn8f37aa52015-06-12 12:28:24 -070027#include <stdbool.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070028#include <stdio.h>
29#include <stdlib.h>
30#include <string.h>
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -070031#include <sys/mount.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080032#include <sys/poll.h>
Christopher Ferris7dc7f322014-07-22 16:08:19 -070033#include <sys/prctl.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070034#include <sys/resource.h>
35#include <sys/stat.h>
36#include <sys/time.h>
37#include <sys/wait.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010038#include <signal.h>
39#include <stdarg.h>
40#include <string.h>
41#include <sys/capability.h>
42#include <sys/inotify.h>
43#include <sys/klog.h>
44#include <time.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070045#include <unistd.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070046
47#include <chrono>
Hridya Valsarajuac582cd2019-08-05 15:39:54 -070048#include <cmath>
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +000049#include <fstream>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070050#include <functional>
51#include <future>
Narayan Kamath8f788292017-05-25 13:20:39 +010052#include <memory>
Hridya Valsarajuac582cd2019-08-05 15:39:54 -070053#include <numeric>
Narayan Kamath8f788292017-05-25 13:20:39 +010054#include <regex>
55#include <set>
56#include <string>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070057#include <utility>
Narayan Kamath8f788292017-05-25 13:20:39 +010058#include <vector>
Colin Crossf45fa6b2012-03-26 12:38:26 -070059
Felipe Leme96c2bbb2016-09-26 09:21:21 -070060#include <android-base/file.h>
61#include <android-base/properties.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070062#include <android-base/scopeguard.h>
Elliott Hughes9dc117c2015-12-07 14:21:50 -080063#include <android-base/stringprintf.h>
Naveen Kalla058e1e82016-10-19 21:38:44 -070064#include <android-base/strings.h>
Andreas Gampeaff68432016-07-18 18:01:27 -070065#include <android-base/unique_fd.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010066#include <android/content/pm/IPackageManagerNative.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080067#include <android/hardware/dumpstate/1.0/IDumpstateDevice.h>
Hunter Knepshield8540faf2020-02-04 19:47:20 -080068#include <android/hardware/dumpstate/1.1/IDumpstateDevice.h>
69#include <android/hardware/dumpstate/1.1/types.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080070#include <android/hidl/manager/1.0/IServiceManager.h>
Nandana Duttd2f5f082019-01-18 17:13:52 +000071#include <android/os/IIncidentCompanion.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010072#include <binder/IServiceManager.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080073#include <cutils/native_handle.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070074#include <cutils/properties.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010075#include <cutils/sockets.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000076#include <debuggerd/client.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080077#include <dumpsys.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000078#include <dumputils/dump_utils.h>
Sahana Raof35ed432019-07-12 10:47:52 +010079#include <hardware_legacy/power.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080080#include <hidl/ServiceManagement.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010081#include <log/log.h>
Tom Cherryf4472f32020-08-05 09:31:17 -070082#include <log/log_read.h>
Felipe Leme75876a22016-10-27 16:31:27 -070083#include <openssl/sha.h>
Mark Salyzyn6c3d90f2016-09-27 14:55:27 -070084#include <private/android_filesystem_config.h>
85#include <private/android_logger.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080086#include <serviceutils/PriorityDumper.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070087#include <utils/StrongPointer.h>
Felipe Lemef0292972016-11-22 13:57:05 -080088#include "DumpstateInternal.h"
Felipe Leme75876a22016-10-27 16:31:27 -070089#include "DumpstateService.h"
Colin Crossf45fa6b2012-03-26 12:38:26 -070090#include "dumpstate.h"
Felipe Leme6e01fa62015-11-11 19:35:14 -080091
Hunter Knepshield8540faf2020-02-04 19:47:20 -080092using IDumpstateDevice_1_0 = ::android::hardware::dumpstate::V1_0::IDumpstateDevice;
93using IDumpstateDevice_1_1 = ::android::hardware::dumpstate::V1_1::IDumpstateDevice;
94using ::android::hardware::dumpstate::V1_1::DumpstateMode;
95using ::android::hardware::dumpstate::V1_1::DumpstateStatus;
96using ::android::hardware::dumpstate::V1_1::toString;
Vishnu Naire97d6122018-01-18 13:58:56 -080097using ::std::literals::chrono_literals::operator""ms;
98using ::std::literals::chrono_literals::operator""s;
Rhed Jao5377d792020-07-16 17:37:39 +080099using ::std::placeholders::_1;
Steven Morelandcb7ef822016-11-29 13:20:37 -0800100
Felipe Leme47e9be22016-12-21 15:37:07 -0800101// TODO: remove once moved to namespace
Vishnu Naire97d6122018-01-18 13:58:56 -0800102using android::defaultServiceManager;
103using android::Dumpsys;
104using android::INVALID_OPERATION;
105using android::IServiceManager;
106using android::OK;
107using android::sp;
108using android::status_t;
109using android::String16;
110using android::String8;
111using android::TIMED_OUT;
112using android::UNKNOWN_ERROR;
113using android::Vector;
Nandana Dutt979388e2018-11-30 16:48:55 +0000114using android::base::StringPrintf;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000115using android::os::IDumpstateListener;
Felipe Leme47e9be22016-12-21 15:37:07 -0800116using android::os::dumpstate::CommandOptions;
117using android::os::dumpstate::DumpFileToFd;
Rhed Jao5377d792020-07-16 17:37:39 +0800118using android::os::dumpstate::DumpPool;
Vishnu Naire97d6122018-01-18 13:58:56 -0800119using android::os::dumpstate::PropertiesHelper;
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800120using android::os::dumpstate::TaskQueue;
Felipe Leme47e9be22016-12-21 15:37:07 -0800121
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100122// Keep in sync with
123// frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
124static const int TRACE_DUMP_TIMEOUT_MS = 10000; // 10 seconds
125
126/* Most simple commands have 10 as timeout, so 5 is a good estimate */
127static const int32_t WEIGHT_FILE = 5;
128
129// TODO: temporary variables and functions used during C++ refactoring
130static Dumpstate& ds = Dumpstate::GetInstance();
131static int RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Nandana Dutt8d945c02019-08-14 13:30:07 +0100132 const CommandOptions& options = CommandOptions::DEFAULT,
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800133 bool verbose_duration = false, int out_fd = STDOUT_FILENO) {
134 return ds.RunCommand(title, full_command, options, verbose_duration, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100135}
136
137// Reasonable value for max stats.
138static const int STATS_MAX_N_RUNS = 1000;
139static const long STATS_MAX_AVERAGE = 100000;
140
141CommandOptions Dumpstate::DEFAULT_DUMPSYS = CommandOptions::WithTimeout(30).Build();
142
Nandana Duttd2f5f082019-01-18 17:13:52 +0000143typedef Dumpstate::ConsentCallback::ConsentResult UserConsentResult;
144
Colin Crossf45fa6b2012-03-26 12:38:26 -0700145/* read before root is shed */
146static char cmdline_buf[16384] = "(unknown)";
Yi Kong19d5c002018-07-20 13:39:55 -0700147static const char *dump_traces_path = nullptr;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000148static const uint64_t USER_CONSENT_TIMEOUT_MS = 30 * 1000;
Hunter Knepshield70610fa2020-01-03 15:27:33 -0800149// Because telephony reports are significantly faster to collect (< 10 seconds vs. > 2 minutes),
150// it's often the case that they time out far too quickly for consent with such a hefty dialog for
151// the user to read. For telephony reports only, we increase the default timeout to 2 minutes to
152// roughly match full reports' durations.
153static const uint64_t TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS = 2 * 60 * 1000;
Colin Crossf45fa6b2012-03-26 12:38:26 -0700154
Felipe Leme1d486fe2016-10-14 18:06:47 -0700155// TODO: variables and functions below should be part of dumpstate object
156
Felipe Leme635ca312016-01-05 14:23:02 -0800157static std::set<std::string> mount_points;
158void add_mountinfo();
Felipe Leme78f2c862015-12-21 09:55:22 -0800159
Todd Poynor2a83daa2013-11-22 15:44:22 -0800160#define PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops"
Mark Salyzyn7d0a7622016-06-24 14:06:15 -0700161#define ALT_PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops-0"
Wei Wang509bb5d2017-06-09 14:42:12 -0700162#define BLK_DEV_SYS_DIR "/sys/block"
Todd Poynor2a83daa2013-11-22 15:44:22 -0800163
Felipe Lemee82a27d2016-01-05 13:35:44 -0800164#define RECOVERY_DIR "/cache/recovery"
Mark Salyzynd6ab0112016-03-25 12:56:39 -0700165#define RECOVERY_DATA_DIR "/data/misc/recovery"
Tianjie Xu75d53362018-04-11 16:42:28 -0700166#define UPDATE_ENGINE_LOG_DIR "/data/misc/update_engine_log"
Mark Salyzyn4d42dea2016-04-01 10:03:14 -0700167#define LOGPERSIST_DATA_DIR "/data/misc/logd"
Jerry Changa1df8a92020-01-02 16:03:39 +0800168#define PREREBOOT_DATA_DIR "/data/misc/prereboot"
David Brazdild2991962016-06-03 14:40:44 +0100169#define PROFILE_DATA_DIR_CUR "/data/misc/profiles/cur"
170#define PROFILE_DATA_DIR_REF "/data/misc/profiles/ref"
Benedict Wong8f9d8a42019-01-03 16:19:38 -0800171#define XFRM_STAT_PROC_FILE "/proc/net/xfrm_stat"
Erik Kline08165202016-05-30 11:55:44 +0900172#define WLUTIL "/vendor/xbin/wlutil"
Vishnu Nair36b4cdb2017-11-17 10:27:05 -0800173#define WMTRACE_DATA_DIR "/data/misc/wmtrace"
Yifan Hong3945e1b2019-10-29 12:59:23 -0700174#define OTA_METADATA_DIR "/metadata/ota"
Yifan Hong0efa7972020-02-03 16:45:02 -0800175#define SNAPSHOTCTL_LOG_DIR "/data/misc/snapshotctl_log"
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +0900176#define LINKERCONFIG_DIR "/linkerconfig"
Calin Juravlef84d3692020-04-28 15:31:12 -0700177#define PACKAGE_DEX_USE_LIST "/data/system/package-dex-usage.list"
Primiano Tuccifaaaafb2021-01-14 12:26:29 +0000178#define SYSTEM_TRACE_SNAPSHOT "/data/misc/perfetto-traces/bugreport/systrace.pftrace"
Li Li2eedd412021-06-30 15:11:53 -0700179#define CGROUPFS_DIR "/sys/fs/cgroup"
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700180
Narayan Kamath8f788292017-05-25 13:20:39 +0100181// TODO(narayan): Since this information has to be kept in sync
182// with tombstoned, we should just put it in a common header.
183//
184// File: system/core/debuggerd/tombstoned/tombstoned.cpp
Narayan Kamathbd863722017-06-01 18:50:12 +0100185static const std::string TOMBSTONE_DIR = "/data/tombstones/";
186static const std::string TOMBSTONE_FILE_PREFIX = "tombstone_";
187static const std::string ANR_DIR = "/data/anr/";
188static const std::string ANR_FILE_PREFIX = "anr_";
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700189
Felipe Lemee844a9d2016-09-21 15:01:39 -0700190// TODO: temporary variables and functions used during C++ refactoring
Nandana Dutt979388e2018-11-30 16:48:55 +0000191
Nandana Dutt5c390032019-03-12 10:52:56 +0000192#define RETURN_IF_USER_DENIED_CONSENT() \
193 if (ds.IsUserConsentDenied()) { \
194 MYLOGE("Returning early as user denied consent to share bugreport with calling app."); \
195 return Dumpstate::RunStatus::USER_CONSENT_DENIED; \
196 }
197
198// Runs func_ptr, but checks user consent before and after running it. Returns USER_CONSENT_DENIED
199// if consent is found to be denied.
200#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(func_ptr, ...) \
201 RETURN_IF_USER_DENIED_CONSENT(); \
202 func_ptr(__VA_ARGS__); \
203 RETURN_IF_USER_DENIED_CONSENT();
204
Rhed Jao5377d792020-07-16 17:37:39 +0800205// Runs func_ptr, and logs a duration report after it's finished.
206#define RUN_SLOW_FUNCTION_AND_LOG(log_title, func_ptr, ...) \
207 { \
208 DurationReporter duration_reporter_in_macro(log_title); \
209 func_ptr(__VA_ARGS__); \
210 }
211
212// Similar with RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK, an additional duration report
213// is output after a slow function is finished.
214#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(log_title, func_ptr, ...) \
215 RETURN_IF_USER_DENIED_CONSENT(); \
216 RUN_SLOW_FUNCTION_AND_LOG(log_title, func_ptr, __VA_ARGS__); \
217 RETURN_IF_USER_DENIED_CONSENT();
218
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800219#define WAIT_TASK_WITH_CONSENT_CHECK(task_name, pool_ptr) \
220 RETURN_IF_USER_DENIED_CONSENT(); \
221 pool_ptr->waitForTask(task_name); \
222 RETURN_IF_USER_DENIED_CONSENT();
223
Sahana Raof35ed432019-07-12 10:47:52 +0100224static const char* WAKE_LOCK_NAME = "dumpstate_wakelock";
225
Rhed Jao5377d792020-07-16 17:37:39 +0800226// Names of parallel tasks, they are used for the DumpPool to identify the dump
227// task and the log title of the duration report.
228static const std::string DUMP_TRACES_TASK = "DUMP TRACES";
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800229static const std::string DUMP_INCIDENT_REPORT_TASK = "INCIDENT REPORT";
230static const std::string DUMP_HALS_TASK = "DUMP HALS";
231static const std::string DUMP_BOARD_TASK = "dumpstate_board()";
Rhed Jaoe017f982020-07-21 17:58:41 +0800232static const std::string DUMP_CHECKINS_TASK = "DUMP CHECKINS";
Rhed Jao5377d792020-07-16 17:37:39 +0800233
Nandana Dutt979388e2018-11-30 16:48:55 +0000234namespace android {
235namespace os {
236namespace {
237
238static int Open(std::string path, int flags, mode_t mode = 0) {
239 int fd = TEMP_FAILURE_RETRY(open(path.c_str(), flags, mode));
240 if (fd == -1) {
241 MYLOGE("open(%s, %s)\n", path.c_str(), strerror(errno));
242 }
243 return fd;
244}
245
mhasank2d75c442020-06-11 15:05:25 -0700246static int OpenForWrite(std::string path) {
247 return Open(path, O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
248 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH);
249}
Nandana Dutt979388e2018-11-30 16:48:55 +0000250
251static int OpenForRead(std::string path) {
252 return Open(path, O_RDONLY | O_CLOEXEC | O_NOFOLLOW);
253}
254
255bool CopyFile(int in_fd, int out_fd) {
256 char buf[4096];
257 ssize_t byte_count;
258 while ((byte_count = TEMP_FAILURE_RETRY(read(in_fd, buf, sizeof(buf)))) > 0) {
259 if (!android::base::WriteFully(out_fd, buf, byte_count)) {
260 return false;
261 }
262 }
263 return (byte_count != -1);
264}
265
266static bool CopyFileToFd(const std::string& input_file, int out_fd) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000267 MYLOGD("Going to copy file (%s) to %d\n", input_file.c_str(), out_fd);
Nandana Dutt979388e2018-11-30 16:48:55 +0000268
269 // Obtain a handle to the source file.
270 android::base::unique_fd in_fd(OpenForRead(input_file));
271 if (out_fd != -1 && in_fd.get() != -1) {
272 if (CopyFile(in_fd.get(), out_fd)) {
273 return true;
274 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000275 MYLOGE("Failed to copy file: %s\n", strerror(errno));
Nandana Dutt979388e2018-11-30 16:48:55 +0000276 }
277 return false;
278}
279
Nandana Duttd2f5f082019-01-18 17:13:52 +0000280static bool UnlinkAndLogOnError(const std::string& file) {
Nandana Dutt8ae16e62020-03-27 10:20:22 +0000281 if (file.empty()) {
282 return false;
283 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000284 if (unlink(file.c_str())) {
285 MYLOGE("Failed to unlink file (%s): %s\n", file.c_str(), strerror(errno));
Nandana Duttd2f5f082019-01-18 17:13:52 +0000286 return false;
287 }
288 return true;
289}
Nandana Dutt979388e2018-11-30 16:48:55 +0000290
Nikita Ioffea325a572019-05-16 19:49:47 +0100291int64_t GetModuleMetadataVersion() {
292 auto binder = defaultServiceManager()->getService(android::String16("package_native"));
293 if (binder == nullptr) {
294 MYLOGE("Failed to retrieve package_native service");
295 return 0L;
296 }
297 auto package_service = android::interface_cast<content::pm::IPackageManagerNative>(binder);
298 std::string package_name;
299 auto status = package_service->getModuleMetadataPackageName(&package_name);
300 if (!status.isOk()) {
301 MYLOGE("Failed to retrieve module metadata package name: %s", status.toString8().c_str());
302 return 0L;
303 }
Nandana Duttdb379fa2019-10-09 16:54:41 +0100304 MYLOGD("Module metadata package name: %s\n", package_name.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100305 int64_t version_code;
306 status = package_service->getVersionCodeForPackage(android::String16(package_name.c_str()),
307 &version_code);
308 if (!status.isOk()) {
309 MYLOGE("Failed to retrieve module metadata version: %s", status.toString8().c_str());
310 return 0L;
311 }
312 return version_code;
313}
314
mhasank2d75c442020-06-11 15:05:25 -0700315static bool PathExists(const std::string& path) {
316 struct stat sb;
317 return stat(path.c_str(), &sb) == 0;
318}
319
320static bool CopyFileToFile(const std::string& input_file, const std::string& output_file) {
321 if (input_file == output_file) {
322 MYLOGD("Skipping copying bugreport file since the destination is the same (%s)\n",
323 output_file.c_str());
324 return false;
325 }
326 else if (PathExists(output_file)) {
327 MYLOGD("Cannot overwrite an existing file (%s)\n", output_file.c_str());
328 return false;
329 }
330
331 MYLOGD("Going to copy bugreport file (%s) to %s\n", input_file.c_str(), output_file.c_str());
332 android::base::unique_fd out_fd(OpenForWrite(output_file));
333 return CopyFileToFd(input_file, out_fd.get());
334}
335
Nandana Dutt979388e2018-11-30 16:48:55 +0000336} // namespace
337} // namespace os
338} // namespace android
339
Felipe Leme678727a2016-09-21 17:22:11 -0700340static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
Felipe Lemebda15a02016-11-16 17:48:25 -0800341 const CommandOptions& options = Dumpstate::DEFAULT_DUMPSYS,
Rhed Jaoe017f982020-07-21 17:58:41 +0800342 long dumpsysTimeoutMs = 0, int out_fd = STDOUT_FILENO) {
343 return ds.RunDumpsys(title, dumpsysArgs, options, dumpsysTimeoutMs, out_fd);
344}
345static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
346 int out_fd) {
347 return ds.RunDumpsys(title, dumpsysArgs, Dumpstate::DEFAULT_DUMPSYS, 0, out_fd);
Felipe Leme678727a2016-09-21 17:22:11 -0700348}
349static int DumpFile(const std::string& title, const std::string& path) {
350 return ds.DumpFile(title, path);
351}
Felipe Lemee82a27d2016-01-05 13:35:44 -0800352
Felipe Lemee844a9d2016-09-21 15:01:39 -0700353// Relative directory (inside the zip) for all files copied as-is into the bugreport.
354static const std::string ZIP_ROOT_DIR = "FS";
355
Vishnu Naire97d6122018-01-18 13:58:56 -0800356static const std::string kProtoPath = "proto/";
357static const std::string kProtoExt = ".proto";
Jie Song9fbfad02017-06-20 16:29:42 -0700358static const std::string kDumpstateBoardFiles[] = {
359 "dumpstate_board.txt",
Felipe Leme95d6ca52017-08-01 16:35:56 -0700360 "dumpstate_board.bin"
Jie Song9fbfad02017-06-20 16:29:42 -0700361};
362static const int NUM_OF_DUMPS = arraysize(kDumpstateBoardFiles);
363
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700364static constexpr char PROPERTY_LAST_ID[] = "dumpstate.last_id";
Felipe Lemed071c682016-10-20 16:48:00 -0700365static constexpr char PROPERTY_VERSION[] = "dumpstate.version";
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700366
Felipe Lemef0292972016-11-22 13:57:05 -0800367static const CommandOptions AS_ROOT_20 = CommandOptions::WithTimeout(20).AsRoot().Build();
368
Narayan Kamath8f788292017-05-25 13:20:39 +0100369/*
Narayan Kamathbd863722017-06-01 18:50:12 +0100370 * Returns a vector of dump fds under |dir_path| with a given |file_prefix|.
Rhed Jao01dc0c62020-06-03 17:13:30 +0800371 * The returned vector is sorted by the mtimes of the dumps with descending
372 * order. If |limit_by_mtime| is set, the vector only contains files that
373 * were written in the last 30 minutes.
Narayan Kamath8f788292017-05-25 13:20:39 +0100374 */
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700375static std::vector<DumpData> GetDumpFds(const std::string& dir_path,
376 const std::string& file_prefix,
Elliott Hughesdb6d2112019-09-26 15:24:51 -0700377 bool limit_by_mtime) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100378 const time_t thirty_minutes_ago = ds.now_ - 60 * 30;
379
Narayan Kamathbd863722017-06-01 18:50:12 +0100380 std::unique_ptr<DIR, decltype(&closedir)> dump_dir(opendir(dir_path.c_str()), closedir);
Narayan Kamath8f788292017-05-25 13:20:39 +0100381
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700382 if (dump_dir == nullptr) {
383 MYLOGW("Unable to open directory %s: %s\n", dir_path.c_str(), strerror(errno));
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700384 return std::vector<DumpData>();
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700385 }
386
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700387 std::vector<DumpData> dump_data;
Narayan Kamathbd863722017-06-01 18:50:12 +0100388 struct dirent* entry = nullptr;
389 while ((entry = readdir(dump_dir.get()))) {
390 if (entry->d_type != DT_REG) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100391 continue;
392 }
393
Narayan Kamathbd863722017-06-01 18:50:12 +0100394 const std::string base_name(entry->d_name);
395 if (base_name.find(file_prefix) != 0) {
396 continue;
397 }
398
399 const std::string abs_path = dir_path + base_name;
400 android::base::unique_fd fd(
401 TEMP_FAILURE_RETRY(open(abs_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW | O_NONBLOCK)));
402 if (fd == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700403 MYLOGW("Unable to open dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamathbd863722017-06-01 18:50:12 +0100404 break;
405 }
406
407 struct stat st = {};
408 if (fstat(fd, &st) == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700409 MYLOGW("Unable to stat dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamath8f788292017-05-25 13:20:39 +0100410 continue;
411 }
412
Narayan Kamath3f31b632018-02-22 19:42:36 +0000413 if (limit_by_mtime && st.st_mtime < thirty_minutes_ago) {
Narayan Kamathbd863722017-06-01 18:50:12 +0100414 MYLOGI("Excluding stale dump file: %s\n", abs_path.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100415 continue;
416 }
417
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700418 dump_data.emplace_back(DumpData{abs_path, std::move(fd), st.st_mtime});
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700419 }
Rhed Jao01dc0c62020-06-03 17:13:30 +0800420 if (!dump_data.empty()) {
421 std::sort(dump_data.begin(), dump_data.end(),
422 [](const auto& a, const auto& b) { return a.mtime > b.mtime; });
423 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100424
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700425 return dump_data;
Narayan Kamath8f788292017-05-25 13:20:39 +0100426}
427
Narayan Kamathbd863722017-06-01 18:50:12 +0100428static bool AddDumps(const std::vector<DumpData>::const_iterator start,
429 const std::vector<DumpData>::const_iterator end,
430 const char* type_name, const bool add_to_zip) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100431 bool dumped = false;
Narayan Kamathbd863722017-06-01 18:50:12 +0100432 for (auto it = start; it != end; ++it) {
433 const std::string& name = it->name;
434 const int fd = it->fd;
Narayan Kamath8f788292017-05-25 13:20:39 +0100435 dumped = true;
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100436
437 // Seek to the beginning of the file before dumping any data. A given
438 // DumpData entry might be dumped multiple times in the report.
439 //
440 // For example, the most recent ANR entry is dumped to the body of the
441 // main entry and it also shows up as a separate entry in the bugreport
442 // ZIP file.
443 if (lseek(fd, 0, SEEK_SET) != static_cast<off_t>(0)) {
444 MYLOGE("Unable to add %s to zip file, lseek failed: %s\n", name.c_str(),
445 strerror(errno));
446 }
447
Narayan Kamath8f788292017-05-25 13:20:39 +0100448 if (ds.IsZipping() && add_to_zip) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800449 if (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + name, fd, /* timeout = */ 0ms) != OK) {
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100450 MYLOGE("Unable to add %s to zip file, addZipEntryFromFd failed\n", name.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100451 }
452 } else {
453 dump_file_from_fd(type_name, name.c_str(), fd);
454 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100455 }
456
457 return dumped;
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700458}
459
Felipe Leme635ca312016-01-05 14:23:02 -0800460// for_each_pid() callback to get mount info about a process.
Felipe Leme4c2d6632016-09-28 14:32:00 -0700461void do_mountinfo(int pid, const char* name __attribute__((unused))) {
Felipe Leme635ca312016-01-05 14:23:02 -0800462 char path[PATH_MAX];
463
464 // Gets the the content of the /proc/PID/ns/mnt link, so only unique mount points
465 // are added.
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700466 snprintf(path, sizeof(path), "/proc/%d/ns/mnt", pid);
Felipe Leme635ca312016-01-05 14:23:02 -0800467 char linkname[PATH_MAX];
468 ssize_t r = readlink(path, linkname, PATH_MAX);
469 if (r == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800470 MYLOGE("Unable to read link for %s: %s\n", path, strerror(errno));
Felipe Leme635ca312016-01-05 14:23:02 -0800471 return;
472 }
473 linkname[r] = '\0';
474
475 if (mount_points.find(linkname) == mount_points.end()) {
476 // First time this mount point was found: add it
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700477 snprintf(path, sizeof(path), "/proc/%d/mountinfo", pid);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700478 if (ds.AddZipEntry(ZIP_ROOT_DIR + path, path)) {
Felipe Leme635ca312016-01-05 14:23:02 -0800479 mount_points.insert(linkname);
480 } else {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800481 MYLOGE("Unable to add mountinfo %s to zip file\n", path);
Felipe Leme635ca312016-01-05 14:23:02 -0800482 }
483 }
484}
485
486void add_mountinfo() {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700487 if (!ds.IsZipping()) return;
Felipe Leme678727a2016-09-21 17:22:11 -0700488 std::string title = "MOUNT INFO";
Felipe Leme635ca312016-01-05 14:23:02 -0800489 mount_points.clear();
Felipe Leme46b85da2016-11-21 17:40:45 -0800490 DurationReporter duration_reporter(title, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700491 for_each_pid(do_mountinfo, nullptr);
492 MYLOGD("%s: %d entries added to zip file\n", title.c_str(), (int)mount_points.size());
Felipe Leme635ca312016-01-05 14:23:02 -0800493}
494
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700495static void dump_dev_files(const char *title, const char *driverpath, const char *filename)
496{
497 DIR *d;
498 struct dirent *de;
499 char path[PATH_MAX];
500
501 d = opendir(driverpath);
Yi Kong19d5c002018-07-20 13:39:55 -0700502 if (d == nullptr) {
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700503 return;
504 }
505
506 while ((de = readdir(d))) {
507 if (de->d_type != DT_LNK) {
508 continue;
509 }
510 snprintf(path, sizeof(path), "%s/%s/%s", driverpath, de->d_name, filename);
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700511 DumpFile(title, path);
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700512 }
513
514 closedir(d);
515}
516
Mark Salyzyn326842f2015-04-30 09:49:41 -0700517static bool skip_not_stat(const char *path) {
518 static const char stat[] = "/stat";
519 size_t len = strlen(path);
520 if (path[len - 1] == '/') { /* Directory? */
521 return false;
522 }
523 return strcmp(path + len - sizeof(stat) + 1, stat); /* .../stat? */
524}
525
Felipe Leme4c2d6632016-09-28 14:32:00 -0700526static bool skip_none(const char* path __attribute__((unused))) {
Felipe Lemee82a27d2016-01-05 13:35:44 -0800527 return false;
528}
529
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700530unsigned long worst_write_perf = 20000; /* in KB/s */
Mark Salyzyn326842f2015-04-30 09:49:41 -0700531
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800532//
533// stat offsets
534// Name units description
535// ---- ----- -----------
536// read I/Os requests number of read I/Os processed
537#define __STAT_READ_IOS 0
538// read merges requests number of read I/Os merged with in-queue I/O
539#define __STAT_READ_MERGES 1
540// read sectors sectors number of sectors read
541#define __STAT_READ_SECTORS 2
542// read ticks milliseconds total wait time for read requests
543#define __STAT_READ_TICKS 3
544// write I/Os requests number of write I/Os processed
545#define __STAT_WRITE_IOS 4
546// write merges requests number of write I/Os merged with in-queue I/O
547#define __STAT_WRITE_MERGES 5
548// write sectors sectors number of sectors written
549#define __STAT_WRITE_SECTORS 6
550// write ticks milliseconds total wait time for write requests
551#define __STAT_WRITE_TICKS 7
552// in_flight requests number of I/Os currently in flight
553#define __STAT_IN_FLIGHT 8
554// io_ticks milliseconds total time this block device has been active
555#define __STAT_IO_TICKS 9
556// time_in_queue milliseconds total wait time for all requests
557#define __STAT_IN_QUEUE 10
558#define __STAT_NUMBER_FIELD 11
559//
560// read I/Os, write I/Os
561// =====================
562//
563// These values increment when an I/O request completes.
564//
565// read merges, write merges
566// =========================
567//
568// These values increment when an I/O request is merged with an
569// already-queued I/O request.
570//
571// read sectors, write sectors
572// ===========================
573//
574// These values count the number of sectors read from or written to this
575// block device. The "sectors" in question are the standard UNIX 512-byte
576// sectors, not any device- or filesystem-specific block size. The
577// counters are incremented when the I/O completes.
578#define SECTOR_SIZE 512
579//
580// read ticks, write ticks
581// =======================
582//
583// These values count the number of milliseconds that I/O requests have
584// waited on this block device. If there are multiple I/O requests waiting,
585// these values will increase at a rate greater than 1000/second; for
586// example, if 60 read requests wait for an average of 30 ms, the read_ticks
587// field will increase by 60*30 = 1800.
588//
589// in_flight
590// =========
591//
592// This value counts the number of I/O requests that have been issued to
593// the device driver but have not yet completed. It does not include I/O
594// requests that are in the queue but not yet issued to the device driver.
595//
596// io_ticks
597// ========
598//
599// This value counts the number of milliseconds during which the device has
600// had I/O requests queued.
601//
602// time_in_queue
603// =============
604//
605// This value counts the number of milliseconds that I/O requests have waited
606// on this block device. If there are multiple I/O requests waiting, this
607// value will increase as the product of the number of milliseconds times the
608// number of requests waiting (see "read ticks" above for an example).
609#define S_TO_MS 1000
610//
611
Mark Salyzyn326842f2015-04-30 09:49:41 -0700612static int dump_stat_from_fd(const char *title __unused, const char *path, int fd) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800613 unsigned long long fields[__STAT_NUMBER_FIELD];
Mark Salyzyn326842f2015-04-30 09:49:41 -0700614 bool z;
Yi Kong19d5c002018-07-20 13:39:55 -0700615 char *cp, *buffer = nullptr;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700616 size_t i = 0;
Josh Gao7c4258c2018-06-25 13:40:08 -0700617 FILE *fp = fdopen(dup(fd), "rb");
Mark Salyzyn326842f2015-04-30 09:49:41 -0700618 getline(&buffer, &i, fp);
619 fclose(fp);
620 if (!buffer) {
621 return -errno;
622 }
623 i = strlen(buffer);
624 while ((i > 0) && (buffer[i - 1] == '\n')) {
625 buffer[--i] = '\0';
626 }
627 if (!*buffer) {
628 free(buffer);
629 return 0;
630 }
631 z = true;
632 for (cp = buffer, i = 0; i < (sizeof(fields) / sizeof(fields[0])); ++i) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800633 fields[i] = strtoull(cp, &cp, 10);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700634 if (fields[i] != 0) {
635 z = false;
636 }
637 }
638 if (z) { /* never accessed */
639 free(buffer);
640 return 0;
641 }
642
Wei Wang509bb5d2017-06-09 14:42:12 -0700643 if (!strncmp(path, BLK_DEV_SYS_DIR, sizeof(BLK_DEV_SYS_DIR) - 1)) {
644 path += sizeof(BLK_DEV_SYS_DIR) - 1;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700645 }
Wei Wang1dc1ef52017-06-12 11:28:37 -0700646
647 printf("%-30s:%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s\n%-30s:\t%s\n", "Block-Dev",
648 "R-IOs", "R-merg", "R-sect", "R-wait", "W-IOs", "W-merg", "W-sect",
649 "W-wait", "in-fli", "activ", "T-wait", path, buffer);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700650 free(buffer);
651
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800652 if (fields[__STAT_IO_TICKS]) {
653 unsigned long read_perf = 0;
654 unsigned long read_ios = 0;
655 if (fields[__STAT_READ_TICKS]) {
656 unsigned long long divisor = fields[__STAT_READ_TICKS]
657 * fields[__STAT_IO_TICKS];
658 read_perf = ((unsigned long long)SECTOR_SIZE
659 * fields[__STAT_READ_SECTORS]
660 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
661 / divisor;
662 read_ios = ((unsigned long long)S_TO_MS * fields[__STAT_READ_IOS]
663 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
664 / divisor;
665 }
666
667 unsigned long write_perf = 0;
668 unsigned long write_ios = 0;
669 if (fields[__STAT_WRITE_TICKS]) {
670 unsigned long long divisor = fields[__STAT_WRITE_TICKS]
671 * fields[__STAT_IO_TICKS];
672 write_perf = ((unsigned long long)SECTOR_SIZE
673 * fields[__STAT_WRITE_SECTORS]
674 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
675 / divisor;
676 write_ios = ((unsigned long long)S_TO_MS * fields[__STAT_WRITE_IOS]
677 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
678 / divisor;
679 }
680
681 unsigned queue = (fields[__STAT_IN_QUEUE]
682 + (fields[__STAT_IO_TICKS] >> 1))
683 / fields[__STAT_IO_TICKS];
684
685 if (!write_perf && !write_ios) {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700686 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 -0800687 } else {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700688 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 -0800689 read_ios, write_perf, write_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800690 }
691
692 /* bugreport timeout factor adjustment */
693 if ((write_perf > 1) && (write_perf < worst_write_perf)) {
694 worst_write_perf = write_perf;
695 }
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700696 }
Mark Salyzyn326842f2015-04-30 09:49:41 -0700697 return 0;
698}
699
Yao Chenbe3bbc12018-01-17 16:31:10 -0800700static const long MINIMUM_LOGCAT_TIMEOUT_MS = 50000;
701
Tom Cherryf4472f32020-08-05 09:31:17 -0700702// Returns the actual readable size of the given buffer or -1 on error.
703static long logcat_buffer_readable_size(const std::string& buffer) {
704 std::unique_ptr<logger_list, decltype(&android_logger_list_free)> logger_list{
705 android_logger_list_alloc(0, 0, 0), &android_logger_list_free};
706 auto logger = android_logger_open(logger_list.get(), android_name_to_log_id(buffer.c_str()));
707
708 return android_logger_get_log_readable_size(logger);
709}
710
711// Returns timeout in ms to read a list of buffers.
Yao Chenbe3bbc12018-01-17 16:31:10 -0800712static unsigned long logcat_timeout(const std::vector<std::string>& buffers) {
713 unsigned long timeout_ms = 0;
714 for (const auto& buffer : buffers) {
Tom Cherryf4472f32020-08-05 09:31:17 -0700715 long readable_size = logcat_buffer_readable_size(buffer);
716 if (readable_size > 0) {
717 // Engineering margin is ten-fold our guess.
718 timeout_ms += 10 * (readable_size + worst_write_perf) / worst_write_perf;
719 }
Yao Chenbe3bbc12018-01-17 16:31:10 -0800720 }
721 return timeout_ms > MINIMUM_LOGCAT_TIMEOUT_MS ? timeout_ms : MINIMUM_LOGCAT_TIMEOUT_MS;
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700722}
723
Dieter Hsu105ad0c2020-09-29 15:23:33 +0800724// Opens a socket and returns its file descriptor.
725static int open_socket(const char* service);
726
Nandana Duttd2f5f082019-01-18 17:13:52 +0000727Dumpstate::ConsentCallback::ConsentCallback() : result_(UNAVAILABLE), start_time_(Nanotime()) {
728}
729
730android::binder::Status Dumpstate::ConsentCallback::onReportApproved() {
731 std::lock_guard<std::mutex> lock(lock_);
732 result_ = APPROVED;
733 MYLOGD("User approved consent to share bugreport\n");
Paul Chang0d2aad72020-02-13 20:04:03 +0800734
735 // Maybe copy screenshot so calling app can display the screenshot to the user as soon as
736 // consent is granted.
737 if (ds.options_->is_screenshot_copied) {
738 return android::binder::Status::ok();
739 }
740
741 if (!ds.options_->do_screenshot || ds.options_->screenshot_fd.get() == -1 ||
742 !ds.do_early_screenshot_) {
743 return android::binder::Status::ok();
744 }
745
746 bool copy_succeeded = android::os::CopyFileToFd(ds.screenshot_path_,
747 ds.options_->screenshot_fd.get());
748 ds.options_->is_screenshot_copied = copy_succeeded;
749 if (copy_succeeded) {
750 android::os::UnlinkAndLogOnError(ds.screenshot_path_);
751 }
Nandana Duttd2f5f082019-01-18 17:13:52 +0000752 return android::binder::Status::ok();
753}
754
755android::binder::Status Dumpstate::ConsentCallback::onReportDenied() {
756 std::lock_guard<std::mutex> lock(lock_);
757 result_ = DENIED;
758 MYLOGW("User denied consent to share bugreport\n");
759 return android::binder::Status::ok();
760}
761
762UserConsentResult Dumpstate::ConsentCallback::getResult() {
763 std::lock_guard<std::mutex> lock(lock_);
764 return result_;
765}
766
767uint64_t Dumpstate::ConsentCallback::getElapsedTimeMs() const {
Hunter Knepshieldf0a39052020-01-03 14:53:04 -0800768 return (Nanotime() - start_time_) / NANOS_PER_MILLI;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000769}
770
Felipe Leme2b9b06c2016-10-14 09:13:06 -0700771void Dumpstate::PrintHeader() const {
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700772 std::string build, fingerprint, radio, bootloader, network;
773 char date[80];
Colin Crossf45fa6b2012-03-26 12:38:26 -0700774
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700775 build = android::base::GetProperty("ro.build.display.id", "(unknown)");
776 fingerprint = android::base::GetProperty("ro.build.fingerprint", "(unknown)");
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700777 radio = android::base::GetProperty("gsm.version.baseband", "(unknown)");
778 bootloader = android::base::GetProperty("ro.bootloader", "(unknown)");
779 network = android::base::GetProperty("gsm.operator.alpha", "(unknown)");
Felipe Lemebbaf3c12016-10-11 14:32:25 -0700780 strftime(date, sizeof(date), "%Y-%m-%d %H:%M:%S", localtime(&now_));
Colin Crossf45fa6b2012-03-26 12:38:26 -0700781
Felipe Lemed8b94e52016-12-08 10:21:44 -0800782 printf("========================================================\n");
783 printf("== dumpstate: %s\n", date);
784 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -0700785
Felipe Lemed8b94e52016-12-08 10:21:44 -0800786 printf("\n");
787 printf("Build: %s\n", build.c_str());
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700788 // NOTE: fingerprint entry format is important for other tools.
Felipe Lemed8b94e52016-12-08 10:21:44 -0800789 printf("Build fingerprint: '%s'\n", fingerprint.c_str());
790 printf("Bootloader: %s\n", bootloader.c_str());
791 printf("Radio: %s\n", radio.c_str());
792 printf("Network: %s\n", network.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100793 int64_t module_metadata_version = android::os::GetModuleMetadataVersion();
794 if (module_metadata_version != 0) {
795 printf("Module Metadata version: %" PRId64 "\n", module_metadata_version);
796 }
Anton Hansson37c041d2021-04-14 17:49:06 +0100797 printf("SDK extension versions [r=%s s=%s]\n",
798 android::base::GetProperty("build.version.extensions.r", "-").c_str(),
799 android::base::GetProperty("build.version.extensions.s", "-").c_str());
Colin Crossf45fa6b2012-03-26 12:38:26 -0700800
Felipe Lemed8b94e52016-12-08 10:21:44 -0800801 printf("Kernel: ");
Felipe Lemef0292972016-11-22 13:57:05 -0800802 DumpFileToFd(STDOUT_FILENO, "", "/proc/version");
Felipe Lemed8b94e52016-12-08 10:21:44 -0800803 printf("Command line: %s\n", strtok(cmdline_buf, "\n"));
Felipe Leme7709f8a2017-12-05 09:30:09 -0800804 printf("Uptime: ");
805 RunCommandToFd(STDOUT_FILENO, "", {"uptime", "-p"},
806 CommandOptions::WithTimeout(1).Always().Build());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800807 printf("Bugreport format version: %s\n", version_.c_str());
Rhed Jao5377d792020-07-16 17:37:39 +0800808 printf("Dumpstate info: id=%d pid=%d dry_run=%d parallel_run=%d args=%s bugreport_mode=%s\n",
809 id_, pid_, PropertiesHelper::IsDryRun(), PropertiesHelper::IsParallelRun(),
810 options_->args.c_str(), options_->bugreport_mode.c_str());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800811 printf("\n");
Felipe Leme78f2c862015-12-21 09:55:22 -0800812}
813
Felipe Leme24b66ee2016-06-16 10:55:26 -0700814// List of file extensions that can cause a zip file attachment to be rejected by some email
815// service providers.
816static const std::set<std::string> PROBLEMATIC_FILE_EXTENSIONS = {
817 ".ade", ".adp", ".bat", ".chm", ".cmd", ".com", ".cpl", ".exe", ".hta", ".ins", ".isp",
818 ".jar", ".jse", ".lib", ".lnk", ".mde", ".msc", ".msp", ".mst", ".pif", ".scr", ".sct",
819 ".shb", ".sys", ".vb", ".vbe", ".vbs", ".vxd", ".wsc", ".wsf", ".wsh"
820};
821
Vishnu Naire97d6122018-01-18 13:58:56 -0800822status_t Dumpstate::AddZipEntryFromFd(const std::string& entry_name, int fd,
823 std::chrono::milliseconds timeout = 0ms) {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700824 if (!IsZipping()) {
825 MYLOGD("Not adding zip entry %s from fd because it's not a zipped bugreport\n",
826 entry_name.c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -0800827 return INVALID_OPERATION;
Felipe Leme111b9d02016-02-03 09:28:24 -0800828 }
Felipe Leme24b66ee2016-06-16 10:55:26 -0700829 std::string valid_name = entry_name;
830
831 // Rename extension if necessary.
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -0700832 size_t idx = entry_name.rfind('.');
Felipe Leme24b66ee2016-06-16 10:55:26 -0700833 if (idx != std::string::npos) {
834 std::string extension = entry_name.substr(idx);
835 std::transform(extension.begin(), extension.end(), extension.begin(), ::tolower);
836 if (PROBLEMATIC_FILE_EXTENSIONS.count(extension) != 0) {
837 valid_name = entry_name + ".renamed";
838 MYLOGI("Renaming entry %s to %s\n", entry_name.c_str(), valid_name.c_str());
839 }
840 }
841
Felipe Leme6fe9db62016-02-12 09:04:16 -0800842 // Logging statement below is useful to time how long each entry takes, but it's too verbose.
843 // MYLOGD("Adding zip entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700844 int32_t err = zip_writer_->StartEntryWithTime(valid_name.c_str(), ZipWriter::kCompress,
845 get_mtime(fd, ds.now_));
Felipe Leme1d486fe2016-10-14 18:06:47 -0700846 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700847 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", valid_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700848 ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800849 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800850 }
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000851 bool finished_entry = false;
852 auto finish_entry = [this, &finished_entry] {
853 if (!finished_entry) {
854 // This should only be called when we're going to return an earlier error,
855 // which would've been logged. This may imply the file is already corrupt
856 // and any further logging from FinishEntry is more likely to mislead than
857 // not.
858 this->zip_writer_->FinishEntry();
859 }
860 };
861 auto scope_guard = android::base::make_scope_guard(finish_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -0800862 auto start = std::chrono::steady_clock::now();
863 auto end = start + timeout;
864 struct pollfd pfd = {fd, POLLIN};
Felipe Lemee82a27d2016-01-05 13:35:44 -0800865
Felipe Leme770410d2016-01-26 17:07:14 -0800866 std::vector<uint8_t> buffer(65536);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800867 while (1) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800868 if (timeout.count() > 0) {
869 // lambda to recalculate the timeout.
870 auto time_left_ms = [end]() {
871 auto now = std::chrono::steady_clock::now();
872 auto diff = std::chrono::duration_cast<std::chrono::milliseconds>(end - now);
873 return std::max(diff.count(), 0LL);
874 };
875
876 int rc = TEMP_FAILURE_RETRY(poll(&pfd, 1, time_left_ms()));
877 if (rc < 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000878 MYLOGE("Error in poll while adding from fd to zip entry %s:%s\n",
879 entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800880 return -errno;
881 } else if (rc == 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000882 MYLOGE("Timed out adding from fd to zip entry %s:%s Timeout:%lldms\n",
Vishnu Naire97d6122018-01-18 13:58:56 -0800883 entry_name.c_str(), strerror(errno), timeout.count());
884 return TIMED_OUT;
885 }
886 }
887
Zach Riggle22200402016-08-18 01:01:24 -0400888 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800889 if (bytes_read == 0) {
890 break;
891 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800892 MYLOGE("read(%s): %s\n", entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800893 return -errno;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800894 }
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700895 err = zip_writer_->WriteBytes(buffer.data(), bytes_read);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800896 if (err) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700897 MYLOGE("zip_writer_->WriteBytes(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800898 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800899 }
900 }
901
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700902 err = zip_writer_->FinishEntry();
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000903 finished_entry = true;
Felipe Leme1d486fe2016-10-14 18:06:47 -0700904 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700905 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800906 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800907 }
908
Vishnu Naire97d6122018-01-18 13:58:56 -0800909 return OK;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800910}
911
Felipe Leme1d486fe2016-10-14 18:06:47 -0700912bool Dumpstate::AddZipEntry(const std::string& entry_name, const std::string& entry_path) {
913 android::base::unique_fd fd(
914 TEMP_FAILURE_RETRY(open(entry_path.c_str(), O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
Andreas Gampeaff68432016-07-18 18:01:27 -0700915 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800916 MYLOGE("open(%s): %s\n", entry_path.c_str(), strerror(errno));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800917 return false;
918 }
919
Vishnu Naire97d6122018-01-18 13:58:56 -0800920 return (AddZipEntryFromFd(entry_name, fd.get()) == OK);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800921}
922
923/* adds a file to the existing zipped bugreport */
Felipe Leme4c2d6632016-09-28 14:32:00 -0700924static int _add_file_from_fd(const char* title __attribute__((unused)), const char* path, int fd) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800925 return (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + path, fd) == OK) ? 0 : 1;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800926}
927
Felipe Leme1d486fe2016-10-14 18:06:47 -0700928void Dumpstate::AddDir(const std::string& dir, bool recursive) {
929 if (!IsZipping()) {
930 MYLOGD("Not adding dir %s because it's not a zipped bugreport\n", dir.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800931 return;
932 }
Felipe Leme678727a2016-09-21 17:22:11 -0700933 MYLOGD("Adding dir %s (recursive: %d)\n", dir.c_str(), recursive);
Felipe Leme46b85da2016-11-21 17:40:45 -0800934 DurationReporter duration_reporter(dir, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700935 dump_files("", dir.c_str(), recursive ? skip_none : is_dir, _add_file_from_fd);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800936}
937
Felipe Leme1d486fe2016-10-14 18:06:47 -0700938bool Dumpstate::AddTextZipEntry(const std::string& entry_name, const std::string& content) {
939 if (!IsZipping()) {
940 MYLOGD("Not adding text zip entry %s because it's not a zipped bugreport\n",
941 entry_name.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800942 return false;
943 }
Felipe Lemecbce55d2016-02-08 09:53:18 -0800944 MYLOGD("Adding zip text entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700945 int32_t err = zip_writer_->StartEntryWithTime(entry_name.c_str(), ZipWriter::kCompress, ds.now_);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700946 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700947 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700948 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800949 return false;
950 }
951
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700952 err = zip_writer_->WriteBytes(content.c_str(), content.length());
Felipe Leme1d486fe2016-10-14 18:06:47 -0700953 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700954 MYLOGE("zip_writer_->WriteBytes(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700955 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800956 return false;
957 }
958
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700959 err = zip_writer_->FinishEntry();
Felipe Leme1d486fe2016-10-14 18:06:47 -0700960 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700961 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800962 return false;
963 }
964
965 return true;
966}
967
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800968static void DoKmsg() {
969 struct stat st;
970 if (!stat(PSTORE_LAST_KMSG, &st)) {
971 /* Also TODO: Make console-ramoops CAP_SYSLOG protected. */
972 DumpFile("LAST KMSG", PSTORE_LAST_KMSG);
973 } else if (!stat(ALT_PSTORE_LAST_KMSG, &st)) {
974 DumpFile("LAST KMSG", ALT_PSTORE_LAST_KMSG);
975 } else {
976 /* TODO: Make last_kmsg CAP_SYSLOG protected. b/5555691 */
977 DumpFile("LAST KMSG", "/proc/last_kmsg");
978 }
979}
980
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800981static void DoKernelLogcat() {
Yao Chenbe3bbc12018-01-17 16:31:10 -0800982 unsigned long timeout_ms = logcat_timeout({"kernel"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800983 RunCommand(
984 "KERNEL LOG",
985 {"logcat", "-b", "kernel", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
986 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
987}
988
Nandana Duttdb379fa2019-10-09 16:54:41 +0100989static void DoSystemLogcat(time_t since) {
990 char since_str[80];
991 strftime(since_str, sizeof(since_str), "%Y-%m-%d %H:%M:%S.000", localtime(&since));
992
993 unsigned long timeout_ms = logcat_timeout({"main", "system", "crash"});
994 RunCommand("SYSTEM LOG",
995 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v", "-T",
996 since_str},
997 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
998}
999
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001000static void DoRadioLogcat() {
1001 unsigned long timeout_ms = logcat_timeout({"radio"});
1002 RunCommand(
1003 "RADIO LOG",
1004 {"logcat", "-b", "radio", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1005 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
1006}
1007
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001008static void DoLogcat() {
Vishnu Nair6921f802017-11-22 09:17:23 -08001009 unsigned long timeout_ms;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001010 // DumpFile("EVENT LOG TAGS", "/etc/event-log-tags");
1011 // calculate timeout
Yao Chenbe3bbc12018-01-17 16:31:10 -08001012 timeout_ms = logcat_timeout({"main", "system", "crash"});
Tony Makae737652017-03-30 17:47:09 +01001013 RunCommand("SYSTEM LOG",
Vishnu Nair6921f802017-11-22 09:17:23 -08001014 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1015 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -08001016 timeout_ms = logcat_timeout({"events"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001017 RunCommand(
1018 "EVENT LOG",
1019 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001020 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Yao Chenbe3bbc12018-01-17 16:31:10 -08001021 timeout_ms = logcat_timeout({"stats"});
1022 RunCommand(
1023 "STATS LOG",
1024 {"logcat", "-b", "stats", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001025 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001026 DoRadioLogcat();
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001027
1028 RunCommand("LOG STATISTICS", {"logcat", "-b", "all", "-S"});
1029
1030 /* kernels must set CONFIG_PSTORE_PMSG, slice up pstore with device tree */
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001031 RunCommand("LAST LOGCAT", {"logcat", "-L", "-b", "all", "-v", "threadtime", "-v", "printable",
1032 "-v", "uid", "-d", "*:v"});
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001033}
1034
Mike Ma5c267872019-08-21 11:31:34 -07001035static void DumpIncidentReport() {
1036 if (!ds.IsZipping()) {
1037 MYLOGD("Not dumping incident report because it's not a zipped bugreport\n");
1038 return;
1039 }
Mike Ma5c267872019-08-21 11:31:34 -07001040 const std::string path = ds.bugreport_internal_dir_ + "/tmp_incident_report";
1041 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1042 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1043 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1044 if (fd < 0) {
1045 MYLOGE("Could not open %s to dump incident report.\n", path.c_str());
1046 return;
1047 }
1048 RunCommandToFd(fd, "", {"incident", "-u"}, CommandOptions::WithTimeout(120).Build());
1049 bool empty = 0 == lseek(fd, 0, SEEK_END);
1050 if (!empty) {
1051 // Use a different name from "incident.proto"
1052 // /proto/incident.proto is reserved for incident service dump
1053 // i.e. metadata for debugging.
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001054 ds.EnqueueAddZipEntryAndCleanupIfNeeded(kProtoPath + "incident_report" + kProtoExt,
1055 path);
1056 } else {
1057 unlink(path.c_str());
Mike Ma5c267872019-08-21 11:31:34 -07001058 }
Mike Ma5c267872019-08-21 11:31:34 -07001059}
1060
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001061static void MaybeAddSystemTraceToZip() {
1062 // This function copies into the .zip the system trace that was snapshotted
1063 // by the early call to MaybeSnapshotSystemTrace(), if any background
1064 // tracing was happening.
1065 if (!ds.IsZipping()) {
1066 MYLOGD("Not dumping system trace because it's not a zipped bugreport\n");
1067 return;
1068 }
1069 if (!ds.has_system_trace_) {
1070 // No background trace was happening at the time dumpstate was invoked.
1071 return;
1072 }
1073 ds.AddZipEntry(
1074 ZIP_ROOT_DIR + SYSTEM_TRACE_SNAPSHOT,
1075 SYSTEM_TRACE_SNAPSHOT);
1076 android::os::UnlinkAndLogOnError(SYSTEM_TRACE_SNAPSHOT);
1077}
1078
Sunny Goyal35949782019-11-19 15:54:36 -08001079static void DumpVisibleWindowViews() {
1080 if (!ds.IsZipping()) {
1081 MYLOGD("Not dumping visible views because it's not a zipped bugreport\n");
1082 return;
1083 }
1084 DurationReporter duration_reporter("VISIBLE WINDOW VIEWS");
1085 const std::string path = ds.bugreport_internal_dir_ + "/tmp_visible_window_views";
1086 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1087 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1088 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1089 if (fd < 0) {
1090 MYLOGE("Could not open %s to dump visible views.\n", path.c_str());
1091 return;
1092 }
1093 RunCommandToFd(fd, "", {"cmd", "window", "dump-visible-window-views"},
1094 CommandOptions::WithTimeout(120).Build());
1095 bool empty = 0 == lseek(fd, 0, SEEK_END);
1096 if (!empty) {
1097 ds.AddZipEntry("visible_windows.zip", path);
1098 } else {
1099 MYLOGW("Failed to dump visible windows\n");
1100 }
1101 unlink(path.c_str());
1102}
1103
Jayachandran Ca94c7172017-06-10 15:08:12 -07001104static void DumpIpTablesAsRoot() {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001105 RunCommand("IPTABLES", {"iptables", "-L", "-nvx"});
1106 RunCommand("IP6TABLES", {"ip6tables", "-L", "-nvx"});
Erik Kline32af8c22016-09-28 17:26:26 +09001107 RunCommand("IPTABLES NAT", {"iptables", "-t", "nat", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001108 /* no ip6 nat */
Erik Kline32af8c22016-09-28 17:26:26 +09001109 RunCommand("IPTABLES MANGLE", {"iptables", "-t", "mangle", "-L", "-nvx"});
1110 RunCommand("IP6TABLES MANGLE", {"ip6tables", "-t", "mangle", "-L", "-nvx"});
1111 RunCommand("IPTABLES RAW", {"iptables", "-t", "raw", "-L", "-nvx"});
1112 RunCommand("IP6TABLES RAW", {"ip6tables", "-t", "raw", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001113}
1114
David Andersond9ba4752018-12-11 18:26:59 -08001115static void DumpDynamicPartitionInfo() {
1116 if (!::android::base::GetBoolProperty("ro.boot.dynamic_partitions", false)) {
1117 return;
1118 }
1119
1120 RunCommand("LPDUMP", {"lpdump", "--all"});
David Anderson6650ade2019-10-02 15:18:59 -07001121 RunCommand("DEVICE-MAPPER", {"gsid", "dump-device-mapper"});
David Andersond9ba4752018-12-11 18:26:59 -08001122}
1123
Narayan Kamath8f788292017-05-25 13:20:39 +01001124static void AddAnrTraceDir(const bool add_to_zip, const std::string& anr_traces_dir) {
1125 MYLOGD("AddAnrTraceDir(): dump_traces_file=%s, anr_traces_dir=%s\n", dump_traces_path,
1126 anr_traces_dir.c_str());
1127
1128 // If we're here, dump_traces_path will always be a temporary file
1129 // (created with mkostemp or similar) that contains dumps taken earlier
1130 // on in the process.
1131 if (dump_traces_path != nullptr) {
1132 if (add_to_zip) {
1133 ds.AddZipEntry(ZIP_ROOT_DIR + anr_traces_dir + "/traces-just-now.txt", dump_traces_path);
1134 } else {
1135 MYLOGD("Dumping current ANR traces (%s) to the main bugreport entry\n",
1136 dump_traces_path);
1137 ds.DumpFile("VM TRACES JUST NOW", dump_traces_path);
1138 }
1139
1140 const int ret = unlink(dump_traces_path);
1141 if (ret == -1) {
1142 MYLOGW("Error unlinking temporary trace path %s: %s\n", dump_traces_path,
1143 strerror(errno));
Felipe Lemee184f662016-10-27 10:04:47 -07001144 }
1145 }
1146
Narayan Kamathbd863722017-06-01 18:50:12 +01001147 // Add a specific message for the first ANR Dump.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001148 if (ds.anr_data_.size() > 0) {
1149 AddDumps(ds.anr_data_.begin(), ds.anr_data_.begin() + 1,
Narayan Kamathbd863722017-06-01 18:50:12 +01001150 "VM TRACES AT LAST ANR", add_to_zip);
1151
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001152 // The "last" ANR will always be included as separate entry in the zip file. In addition,
1153 // it will be present in the body of the main entry if |add_to_zip| == false.
1154 //
1155 // Historical ANRs are always included as separate entries in the bugreport zip file.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001156 AddDumps(ds.anr_data_.begin() + ((add_to_zip) ? 1 : 0), ds.anr_data_.end(),
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001157 "HISTORICAL ANR", true /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001158 } else {
Narayan Kamath8f788292017-05-25 13:20:39 +01001159 printf("*** NO ANRs to dump in %s\n\n", ANR_DIR.c_str());
1160 }
1161}
1162
1163static void AddAnrTraceFiles() {
1164 const bool add_to_zip = ds.IsZipping() && ds.version_ == VERSION_SPLIT_ANR;
1165
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001166 std::string anr_traces_dir = "/data/anr";
Narayan Kamath8f788292017-05-25 13:20:39 +01001167
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001168 AddAnrTraceDir(add_to_zip, anr_traces_dir);
Narayan Kamath8f788292017-05-25 13:20:39 +01001169
Makoto Onuki83ec63f2019-01-31 17:08:59 -08001170 RunCommand("ANR FILES", {"ls", "-lt", ANR_DIR});
1171
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001172 // Slow traces for slow operations.
Felipe Lemee184f662016-10-27 10:04:47 -07001173 struct stat st;
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001174 int i = 0;
1175 while (true) {
1176 const std::string slow_trace_path =
1177 anr_traces_dir + android::base::StringPrintf("slow%02d.txt", i);
1178 if (stat(slow_trace_path.c_str(), &st)) {
1179 // No traces file at this index, done with the files.
1180 break;
Felipe Lemee184f662016-10-27 10:04:47 -07001181 }
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001182 ds.DumpFile("VM TRACES WHEN SLOW", slow_trace_path.c_str());
1183 i++;
Felipe Lemee184f662016-10-27 10:04:47 -07001184 }
1185}
1186
Wei Wang509bb5d2017-06-09 14:42:12 -07001187static void DumpBlockStatFiles() {
1188 DurationReporter duration_reporter("DUMP BLOCK STAT");
Wei Wang509bb5d2017-06-09 14:42:12 -07001189
Wei Wang1dc1ef52017-06-12 11:28:37 -07001190 std::unique_ptr<DIR, std::function<int(DIR*)>> dirptr(opendir(BLK_DEV_SYS_DIR), closedir);
1191
1192 if (dirptr == nullptr) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001193 MYLOGE("Failed to open %s: %s\n", BLK_DEV_SYS_DIR, strerror(errno));
1194 return;
1195 }
1196
1197 printf("------ DUMP BLOCK STAT ------\n\n");
Wei Wang1dc1ef52017-06-12 11:28:37 -07001198 while (struct dirent *d = readdir(dirptr.get())) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001199 if ((d->d_name[0] == '.')
1200 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
1201 || (d->d_name[1] == '\0'))) {
1202 continue;
1203 }
1204 const std::string new_path =
1205 android::base::StringPrintf("%s/%s", BLK_DEV_SYS_DIR, d->d_name);
1206 printf("------ BLOCK STAT (%s) ------\n", new_path.c_str());
1207 dump_files("", new_path.c_str(), skip_not_stat, dump_stat_from_fd);
1208 printf("\n");
1209 }
Wei Wang1dc1ef52017-06-12 11:28:37 -07001210 return;
Wei Wang509bb5d2017-06-09 14:42:12 -07001211}
Jayachandran Ca94c7172017-06-10 15:08:12 -07001212
1213static void DumpPacketStats() {
1214 DumpFile("NETWORK DEV INFO", "/proc/net/dev");
Jayachandran Ca94c7172017-06-10 15:08:12 -07001215}
1216
1217static void DumpIpAddrAndRules() {
1218 /* The following have a tendency to get wedged when wifi drivers/fw goes belly-up. */
1219 RunCommand("NETWORK INTERFACES", {"ip", "link"});
1220 RunCommand("IPv4 ADDRESSES", {"ip", "-4", "addr", "show"});
1221 RunCommand("IPv6 ADDRESSES", {"ip", "-6", "addr", "show"});
1222 RunCommand("IP RULES", {"ip", "rule", "show"});
1223 RunCommand("IP RULES v6", {"ip", "-6", "rule", "show"});
1224}
1225
Nandana Dutt5c390032019-03-12 10:52:56 +00001226static Dumpstate::RunStatus RunDumpsysTextByPriority(const std::string& title, int priority,
1227 std::chrono::milliseconds timeout,
1228 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001229 auto start = std::chrono::steady_clock::now();
Vishnu Naire97d6122018-01-18 13:58:56 -08001230 sp<android::IServiceManager> sm = defaultServiceManager();
1231 Dumpsys dumpsys(sm.get());
Vishnu Naire97d6122018-01-18 13:58:56 -08001232 Vector<String16> args;
1233 Dumpsys::setServiceArgs(args, /* asProto = */ false, priority);
Vishnu Naire97d6122018-01-18 13:58:56 -08001234 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ false);
1235 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001236 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001237 std::string path(title);
1238 path.append(" - ").append(String8(service).c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -08001239 size_t bytes_written = 0;
Steven Moreland5a30d342019-10-08 13:53:28 -07001240 status_t status = dumpsys.startDumpThread(Dumpsys::Type::DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001241 if (status == OK) {
1242 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1243 std::chrono::duration<double> elapsed_seconds;
1244 status = dumpsys.writeDump(STDOUT_FILENO, service, service_timeout,
1245 /* as_proto = */ false, elapsed_seconds, bytes_written);
Vishnu Naire97d6122018-01-18 13:58:56 -08001246 dumpsys.writeDumpFooter(STDOUT_FILENO, service, elapsed_seconds);
1247 bool dump_complete = (status == OK);
1248 dumpsys.stopDumpThread(dump_complete);
1249 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001250
1251 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1252 std::chrono::steady_clock::now() - start);
1253 if (elapsed_duration > timeout) {
1254 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1255 elapsed_duration.count());
1256 break;
1257 }
1258 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001259 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001260}
1261
Vishnu Nair64afc022018-02-01 15:29:34 -08001262static void RunDumpsysText(const std::string& title, int priority,
1263 std::chrono::milliseconds timeout,
1264 std::chrono::milliseconds service_timeout) {
1265 DurationReporter duration_reporter(title);
1266 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1267 fsync(STDOUT_FILENO);
1268 RunDumpsysTextByPriority(title, priority, timeout, service_timeout);
1269}
1270
1271/* Dump all services registered with Normal or Default priority. */
Nandana Dutt5c390032019-03-12 10:52:56 +00001272static Dumpstate::RunStatus RunDumpsysTextNormalPriority(const std::string& title,
1273 std::chrono::milliseconds timeout,
1274 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001275 DurationReporter duration_reporter(title);
1276 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1277 fsync(STDOUT_FILENO);
1278 RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_NORMAL, timeout,
1279 service_timeout);
Nandana Dutt5c390032019-03-12 10:52:56 +00001280
1281 RETURN_IF_USER_DENIED_CONSENT();
1282
1283 return RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_DEFAULT, timeout,
1284 service_timeout);
Vishnu Nair64afc022018-02-01 15:29:34 -08001285}
1286
Nandana Dutt5c390032019-03-12 10:52:56 +00001287static Dumpstate::RunStatus RunDumpsysProto(const std::string& title, int priority,
1288 std::chrono::milliseconds timeout,
1289 std::chrono::milliseconds service_timeout) {
Luis Hector Chavez1e27b082018-03-22 15:36:42 -07001290 if (!ds.IsZipping()) {
1291 MYLOGD("Not dumping %s because it's not a zipped bugreport\n", title.c_str());
Nandana Dutt5c390032019-03-12 10:52:56 +00001292 return Dumpstate::RunStatus::OK;
Luis Hector Chavez1e27b082018-03-22 15:36:42 -07001293 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001294 sp<android::IServiceManager> sm = defaultServiceManager();
1295 Dumpsys dumpsys(sm.get());
1296 Vector<String16> args;
1297 Dumpsys::setServiceArgs(args, /* asProto = */ true, priority);
1298 DurationReporter duration_reporter(title);
1299
1300 auto start = std::chrono::steady_clock::now();
1301 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ true);
1302 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001303 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001304 std::string path(kProtoPath);
1305 path.append(String8(service).c_str());
1306 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL) {
1307 path.append("_CRITICAL");
1308 } else if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH) {
1309 path.append("_HIGH");
1310 }
1311 path.append(kProtoExt);
Steven Moreland5a30d342019-10-08 13:53:28 -07001312 status_t status = dumpsys.startDumpThread(Dumpsys::Type::DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001313 if (status == OK) {
1314 status = ds.AddZipEntryFromFd(path, dumpsys.getDumpFd(), service_timeout);
1315 bool dumpTerminated = (status == OK);
1316 dumpsys.stopDumpThread(dumpTerminated);
1317 }
1318 ZipWriter::FileEntry file_entry;
1319 ds.zip_writer_->GetLastEntry(&file_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -08001320
1321 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1322 std::chrono::steady_clock::now() - start);
1323 if (elapsed_duration > timeout) {
1324 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1325 elapsed_duration.count());
1326 break;
1327 }
1328 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001329 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001330}
1331
Nandana Dutta7db6342018-11-21 14:53:34 +00001332// Runs dumpsys on services that must dump first and will take less than 100ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001333static Dumpstate::RunStatus RunDumpsysCritical() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001334 RunDumpsysText("DUMPSYS CRITICAL", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1335 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Nandana Dutt5c390032019-03-12 10:52:56 +00001336
1337 RETURN_IF_USER_DENIED_CONSENT();
1338
1339 return RunDumpsysProto("DUMPSYS CRITICAL PROTO", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1340 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Vishnu Nair780b1282017-10-10 13:57:24 -07001341}
1342
1343// Runs dumpsys on services that must dump first but can take up to 250ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001344static Dumpstate::RunStatus RunDumpsysHigh() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001345 // TODO meminfo takes ~10s, connectivity takes ~5sec to dump. They are both
1346 // high priority. Reduce timeout once they are able to dump in a shorter time or
1347 // moved to a parallel task.
1348 RunDumpsysText("DUMPSYS HIGH", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1349 /* timeout= */ 90s, /* service_timeout= */ 30s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001350
1351 RETURN_IF_USER_DENIED_CONSENT();
1352
1353 return RunDumpsysProto("DUMPSYS HIGH PROTO", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1354 /* timeout= */ 5s, /* service_timeout= */ 1s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001355}
1356
1357// Runs dumpsys on services that must dump but can take up to 10s to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001358static Dumpstate::RunStatus RunDumpsysNormal() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001359 RunDumpsysTextNormalPriority("DUMPSYS", /* timeout= */ 90s, /* service_timeout= */ 10s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001360
1361 RETURN_IF_USER_DENIED_CONSENT();
1362
1363 return RunDumpsysProto("DUMPSYS PROTO", IServiceManager::DUMP_FLAG_PRIORITY_NORMAL,
1364 /* timeout= */ 90s, /* service_timeout= */ 10s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001365}
1366
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001367/*
1368 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1369 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1370 * if it's not running in the parallel task.
1371 */
1372static void DumpHals(int out_fd = STDOUT_FILENO) {
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001373 if (!ds.IsZipping()) {
Yifan Hong30528a22020-08-07 18:24:06 -07001374 RunCommand("HARDWARE HALS", {"lshal", "--all", "--types=all", "--debug"},
Steven Morelandd3646e02020-09-23 17:26:33 +00001375 CommandOptions::WithTimeout(60).AsRootIfAvailable().Build(),
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001376 false, out_fd);
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001377 return;
1378 }
Yifan Hong30528a22020-08-07 18:24:06 -07001379 RunCommand("HARDWARE HALS", {"lshal", "--all", "--types=all"},
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001380 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build(),
1381 false, out_fd);
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001382
Steven Moreland44cd9482018-01-04 16:24:13 -08001383 using android::hidl::manager::V1_0::IServiceManager;
1384 using android::hardware::defaultServiceManager;
1385
1386 sp<IServiceManager> sm = defaultServiceManager();
1387 if (sm == nullptr) {
1388 MYLOGE("Could not retrieve hwservicemanager to dump hals.\n");
1389 return;
1390 }
1391
1392 auto ret = sm->list([&](const auto& interfaces) {
1393 for (const std::string& interface : interfaces) {
1394 std::string cleanName = interface;
1395 std::replace_if(cleanName.begin(),
1396 cleanName.end(),
1397 [](char c) {
1398 return !isalnum(c) &&
1399 std::string("@-_:.").find(c) == std::string::npos;
1400 }, '_');
Nandana Dutt979388e2018-11-30 16:48:55 +00001401 const std::string path = ds.bugreport_internal_dir_ + "/lshal_debug_" + cleanName;
Steven Moreland44cd9482018-01-04 16:24:13 -08001402
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001403 bool empty = false;
Steven Moreland44cd9482018-01-04 16:24:13 -08001404 {
1405 auto fd = android::base::unique_fd(
1406 TEMP_FAILURE_RETRY(open(path.c_str(),
1407 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1408 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1409 if (fd < 0) {
1410 MYLOGE("Could not open %s to dump additional hal information.\n", path.c_str());
1411 continue;
1412 }
1413 RunCommandToFd(fd,
1414 "",
Steven Morelandc81cd3c2018-01-18 14:36:26 -08001415 {"lshal", "debug", "-E", interface},
Steven Moreland44cd9482018-01-04 16:24:13 -08001416 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
1417
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001418 empty = 0 == lseek(fd, 0, SEEK_END);
Steven Moreland44cd9482018-01-04 16:24:13 -08001419 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001420 if (!empty) {
1421 ds.EnqueueAddZipEntryAndCleanupIfNeeded("lshal-debug/" + cleanName + ".txt",
1422 path);
1423 } else {
1424 unlink(path.c_str());
1425 }
Steven Moreland44cd9482018-01-04 16:24:13 -08001426 }
1427 });
1428
1429 if (!ret.isOk()) {
1430 MYLOGE("Could not list hals from hwservicemanager.\n");
1431 }
1432}
1433
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001434static void DumpExternalFragmentationInfo() {
1435 struct stat st;
1436 if (stat("/proc/buddyinfo", &st) != 0) {
1437 MYLOGE("Unable to dump external fragmentation info\n");
1438 return;
1439 }
1440
1441 printf("------ EXTERNAL FRAGMENTATION INFO ------\n");
1442 std::ifstream ifs("/proc/buddyinfo");
1443 auto unusable_index_regex = std::regex{"Node\\s+([0-9]+),\\s+zone\\s+(\\S+)\\s+(.*)"};
1444 for (std::string line; std::getline(ifs, line);) {
1445 std::smatch match_results;
1446 if (std::regex_match(line, match_results, unusable_index_regex)) {
1447 std::stringstream free_pages(std::string{match_results[3]});
1448 std::vector<int> free_pages_per_order(std::istream_iterator<int>{free_pages},
1449 std::istream_iterator<int>());
1450
1451 int total_free_pages = 0;
1452 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1453 total_free_pages += (free_pages_per_order[i] * std::pow(2, i));
1454 }
1455
1456 printf("Node %s, zone %8s", match_results[1].str().c_str(),
1457 match_results[2].str().c_str());
1458
1459 int usable_free_pages = total_free_pages;
1460 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1461 auto unusable_index = (total_free_pages - usable_free_pages) /
1462 static_cast<double>(total_free_pages);
1463 printf(" %5.3f", unusable_index);
1464 usable_free_pages -= (free_pages_per_order[i] * std::pow(2, i));
1465 }
1466
1467 printf("\n");
1468 }
1469 }
1470 printf("\n");
1471}
1472
mhasankd451a472020-05-26 18:02:39 -07001473static void DumpstateLimitedOnly() {
1474 // Trimmed-down version of dumpstate to only include a whitelisted
1475 // set of logs (system log, event log, and system server / system app
1476 // crashes, and networking logs). See b/136273873 and b/138459828
1477 // for context.
1478 DurationReporter duration_reporter("DUMPSTATE");
1479 unsigned long timeout_ms;
1480 // calculate timeout
1481 timeout_ms = logcat_timeout({"main", "system", "crash"});
1482 RunCommand("SYSTEM LOG",
1483 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1484 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1485 timeout_ms = logcat_timeout({"events"});
1486 RunCommand(
1487 "EVENT LOG",
1488 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1489 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1490
1491 printf("========================================================\n");
1492 printf("== Networking Service\n");
1493 printf("========================================================\n");
1494
1495 RunDumpsys("DUMPSYS NETWORK_SERVICE_LIMITED", {"wifi", "-a"},
1496 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hugo Benichiaa162682020-10-30 23:28:56 +09001497 RunDumpsys("DUMPSYS CONNECTIVITY REQUESTS", {"connectivity", "requests"},
1498 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
mhasankd451a472020-05-26 18:02:39 -07001499
1500 printf("========================================================\n");
1501 printf("== Dropbox crashes\n");
1502 printf("========================================================\n");
1503
1504 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1505 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1506
1507 printf("========================================================\n");
1508 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1509 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1510 printf("========================================================\n");
1511 printf("== dumpstate: done (id %d)\n", ds.id_);
1512 printf("========================================================\n");
1513}
1514
Rhed Jaoe017f982020-07-21 17:58:41 +08001515/*
1516 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1517 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1518 * if it's not running in the parallel task.
1519 */
1520static void DumpCheckins(int out_fd = STDOUT_FILENO) {
1521 dprintf(out_fd, "========================================================\n");
1522 dprintf(out_fd, "== Checkins\n");
1523 dprintf(out_fd, "========================================================\n");
1524
1525 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"}, out_fd);
1526 RunDumpsys("CHECKIN MEMINFO", {"meminfo", "--checkin"}, out_fd);
1527 RunDumpsys("CHECKIN NETSTATS", {"netstats", "--checkin"}, out_fd);
1528 RunDumpsys("CHECKIN PROCSTATS", {"procstats", "-c"}, out_fd);
1529 RunDumpsys("CHECKIN USAGESTATS", {"usagestats", "-c"}, out_fd);
1530 RunDumpsys("CHECKIN PACKAGE", {"package", "--checkin"}, out_fd);
1531}
1532
1533/*
1534 * Runs dumpsys on activity service to dump all application activities, services
1535 * and providers in the device.
1536 *
1537 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1538 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1539 * if it's not running in the parallel task.
1540 */
1541static void DumpAppInfos(int out_fd = STDOUT_FILENO) {
1542 dprintf(out_fd, "========================================================\n");
1543 dprintf(out_fd, "== Running Application Activities\n");
1544 dprintf(out_fd, "========================================================\n");
1545
1546 // The following dumpsys internally collects output from running apps, so it can take a long
1547 // time. So let's extend the timeout.
1548
1549 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
1550
1551 RunDumpsys("APP ACTIVITIES", {"activity", "-v", "all"}, DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1552
1553 dprintf(out_fd, "========================================================\n");
1554 dprintf(out_fd, "== Running Application Services (platform)\n");
1555 dprintf(out_fd, "========================================================\n");
1556
1557 RunDumpsys("APP SERVICES PLATFORM", {"activity", "service", "all-platform-non-critical"},
1558 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1559
1560 dprintf(out_fd, "========================================================\n");
1561 dprintf(out_fd, "== Running Application Services (non-platform)\n");
1562 dprintf(out_fd, "========================================================\n");
1563
1564 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1565 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1566
1567 dprintf(out_fd, "========================================================\n");
1568 dprintf(out_fd, "== Running Application Providers (platform)\n");
1569 dprintf(out_fd, "========================================================\n");
1570
1571 RunDumpsys("APP PROVIDERS PLATFORM", {"activity", "provider", "all-platform"},
Rhed Jaob049f182021-01-11 21:08:43 +08001572 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
Rhed Jaoe017f982020-07-21 17:58:41 +08001573
1574 dprintf(out_fd, "========================================================\n");
1575 dprintf(out_fd, "== Running Application Providers (non-platform)\n");
1576 dprintf(out_fd, "========================================================\n");
1577
1578 RunDumpsys("APP PROVIDERS NON-PLATFORM", {"activity", "provider", "all-non-platform"},
1579 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1580}
1581
Nandana Dutt5c390032019-03-12 10:52:56 +00001582// Dumps various things. Returns early with status USER_CONSENT_DENIED if user denies consent
1583// via the consent they are shown. Ignores other errors that occur while running various
1584// commands. The consent checking is currently done around long running tasks, which happen to
1585// be distributed fairly evenly throughout the function.
1586static Dumpstate::RunStatus dumpstate() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001587 DurationReporter duration_reporter("DUMPSTATE");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001588
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001589 // Enqueue slow functions into the thread pool, if the parallel run is enabled.
1590 if (ds.dump_pool_) {
1591 // Pool was shutdown in DumpstateDefaultAfterCritical method in order to
1592 // drop root user. Restarts it with two threads for the parallel run.
1593 ds.dump_pool_->start(/* thread_counts = */2);
1594
1595 ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
1596 ds.dump_pool_->enqueueTask(DUMP_INCIDENT_REPORT_TASK, &DumpIncidentReport);
1597 ds.dump_pool_->enqueueTaskWithFd(DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
Rhed Jaoe017f982020-07-21 17:58:41 +08001598 ds.dump_pool_->enqueueTaskWithFd(DUMP_CHECKINS_TASK, &DumpCheckins, _1);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001599 }
1600
Nandana Dutt5c390032019-03-12 10:52:56 +00001601 // Dump various things. Note that anything that takes "long" (i.e. several seconds) should
1602 // check intermittently (if it's intrerruptable like a foreach on pids) and/or should be wrapped
1603 // in a consent check (via RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK).
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -07001604 dump_dev_files("TRUSTY VERSION", "/sys/bus/platform/drivers/trusty", "trusty_version");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001605 RunCommand("UPTIME", {"uptime"});
Wei Wang509bb5d2017-06-09 14:42:12 -07001606 DumpBlockStatFiles();
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001607 DumpFile("MEMORY INFO", "/proc/meminfo");
1608 RunCommand("CPU INFO", {"top", "-b", "-n", "1", "-H", "-s", "6", "-o",
Felipe Leme30dbfa12016-09-02 12:43:26 -07001609 "pid,tid,user,pr,ni,%cpu,s,virt,res,pcy,cmd,name"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001610
1611 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "PROCRANK", {"procrank"}, AS_ROOT_20);
1612
Sunny Goyal35949782019-11-19 15:54:36 -08001613 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpVisibleWindowViews);
1614
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001615 DumpFile("VIRTUAL MEMORY STATS", "/proc/vmstat");
1616 DumpFile("VMALLOC INFO", "/proc/vmallocinfo");
1617 DumpFile("SLAB INFO", "/proc/slabinfo");
1618 DumpFile("ZONEINFO", "/proc/zoneinfo");
1619 DumpFile("PAGETYPEINFO", "/proc/pagetypeinfo");
1620 DumpFile("BUDDYINFO", "/proc/buddyinfo");
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001621 DumpExternalFragmentationInfo();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001622
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001623 DumpFile("KERNEL WAKE SOURCES", "/d/wakeup_sources");
1624 DumpFile("KERNEL CPUFREQ", "/sys/devices/system/cpu/cpu0/cpufreq/stats/time_in_state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001625
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001626 RunCommand("PROCESSES AND THREADS",
Yohei Yukawa591a72d2017-10-05 21:36:35 -07001627 {"ps", "-A", "-T", "-Z", "-O", "pri,nice,rtprio,sched,pcy,time"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001628
1629 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "LIBRANK", {"librank"},
1630 CommandOptions::AS_ROOT);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001631
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001632 if (ds.dump_pool_) {
1633 WAIT_TASK_WITH_CONSENT_CHECK(DUMP_HALS_TASK, ds.dump_pool_);
1634 } else {
1635 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_HALS_TASK, DumpHals);
1636 }
Steven Moreland81b429e2017-01-31 19:50:46 -08001637
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001638 RunCommand("PRINTENV", {"printenv"});
Elliott Hughes21b7c8d2016-10-28 08:53:02 -07001639 RunCommand("NETSTAT", {"netstat", "-nW"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001640 struct stat s;
1641 if (stat("/proc/modules", &s) != 0) {
1642 MYLOGD("Skipping 'lsmod' because /proc/modules does not exist\n");
1643 } else {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001644 RunCommand("LSMOD", {"lsmod"});
Woody Linc198f252021-05-04 16:37:11 +08001645 RunCommand("MODULES INFO",
1646 {"sh", "-c", "cat /proc/modules | cut -d' ' -f1 | "
1647 " while read MOD ; do echo modinfo:$MOD ; modinfo $MOD ; "
1648 "done"}, CommandOptions::AS_ROOT);
Felipe Lemee4eca582016-06-10 17:48:08 -07001649 }
Michal Karpinski4db754f2015-12-11 18:04:32 +00001650
Tom Cherryb87dbfa2020-07-28 11:28:53 -07001651 if (android::base::GetBoolProperty("ro.logd.kernel", false)) {
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001652 DoKernelLogcat();
1653 } else {
1654 do_dmesg();
1655 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001656
Felipe Lemef0292972016-11-22 13:57:05 -08001657 RunCommand("LIST OF OPEN FILES", {"lsof"}, CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001658
1659 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(for_each_pid, do_showmap, "SMAPS OF ALL PROCESSES");
1660
Jeff Brown1dc94e32014-09-11 14:15:27 -07001661 for_each_tid(show_wchan, "BLOCKED PROCESS WAIT-CHANNELS");
Mark Salyzyna297c322016-02-05 15:33:17 -08001662 for_each_pid(show_showtime, "PROCESS TIMES (pid cmd user system iowait+percentage)");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001663
Jack Yu5a6b2e22020-08-14 18:13:35 +08001664 /* Dump Nfc NCI logs */
1665 ds.AddDir("/data/misc/nfc/logs", true);
Ajay Panickerd886ec42016-09-14 12:26:46 -07001666
Paul Chang0d2aad72020-02-13 20:04:03 +08001667 if (ds.options_->do_screenshot && !ds.do_early_screenshot_) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001668 MYLOGI("taking late screenshot\n");
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001669 ds.TakeScreenshot();
Jeff Sharkey5a930032013-03-19 15:05:19 -07001670 }
1671
Felipe Lemee184f662016-10-27 10:04:47 -07001672 AddAnrTraceFiles();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001673
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001674 MaybeAddSystemTraceToZip();
1675
Narayan Kamath8f788292017-05-25 13:20:39 +01001676 // NOTE: tombstones are always added as separate entries in the zip archive
1677 // and are not interspersed with the main report.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001678 const bool tombstones_dumped = AddDumps(ds.tombstone_data_.begin(), ds.tombstone_data_.end(),
Narayan Kamathbd863722017-06-01 18:50:12 +01001679 "TOMBSTONE", true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001680 if (!tombstones_dumped) {
1681 printf("*** NO TOMBSTONES to dump in %s\n\n", TOMBSTONE_DIR.c_str());
Christopher Ferris7dc7f322014-07-22 16:08:19 -07001682 }
1683
Jayachandran Ca94c7172017-06-10 15:08:12 -07001684 DumpPacketStats();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001685
Chenbo Feng276a3b62018-08-07 11:44:49 -07001686 RunDumpsys("EBPF MAP STATS", {"netd", "trafficcontroller"});
1687
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001688 DoKmsg();
Mark Salyzyn2262c162014-12-16 09:09:26 -08001689
Jayachandran Ca94c7172017-06-10 15:08:12 -07001690 DumpIpAddrAndRules();
Sreeram Ramachandran2b3bba32014-07-08 15:40:55 -07001691
1692 dump_route_tables();
1693
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001694 RunCommand("ARP CACHE", {"ip", "-4", "neigh", "show"});
1695 RunCommand("IPv6 ND CACHE", {"ip", "-6", "neigh", "show"});
1696 RunCommand("MULTICAST ADDRESSES", {"ip", "maddr"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001697
Nandana Dutt5c390032019-03-12 10:52:56 +00001698 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysHigh);
Lorenzo Colitti6afc38c2015-09-09 22:59:25 +09001699
Chiachang Wang668ede42021-05-17 17:14:20 +08001700 // The dump mechanism in connectivity is refactored due to modularization work. Connectivity can
1701 // only register with a default priority(NORMAL priority). Dumpstate has to call connectivity
1702 // dump with priority parameters to dump high priority information.
1703 RunDumpsys("SERVICE HIGH connectivity", {"connectivity", "--dump-priority", "HIGH"},
1704 CommandOptions::WithTimeout(10).Build());
1705
Elliott Hughes23ccc622017-02-28 10:14:22 -08001706 RunCommand("SYSTEM PROPERTIES", {"getprop"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001707
Jin Qianf334d662017-10-10 14:41:37 -07001708 RunCommand("STORAGED IO INFO", {"storaged", "-u", "-p"});
ynwangf649a6e2016-07-17 21:56:00 -07001709
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001710 RunCommand("FILESYSTEMS & FREE SPACE", {"df"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001711
Colin Crossf45fa6b2012-03-26 12:38:26 -07001712 /* Binder state is expensive to look at as it uses a lot of memory. */
Hridya Valsaraju920ba712020-02-09 16:27:01 -08001713 std::string binder_logs_dir = access("/dev/binderfs/binder_logs", R_OK) ?
1714 "/sys/kernel/debug/binder" : "/dev/binderfs/binder_logs";
1715
1716 DumpFile("BINDER FAILED TRANSACTION LOG", binder_logs_dir + "/failed_transaction_log");
1717 DumpFile("BINDER TRANSACTION LOG", binder_logs_dir + "/transaction_log");
1718 DumpFile("BINDER TRANSACTIONS", binder_logs_dir + "/transactions");
1719 DumpFile("BINDER STATS", binder_logs_dir + "/stats");
1720 DumpFile("BINDER STATE", binder_logs_dir + "/state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001721
Vishnu Nair36b4cdb2017-11-17 10:27:05 -08001722 /* Add window and surface trace files. */
1723 if (!PropertiesHelper::IsUserBuild()) {
1724 ds.AddDir(WMTRACE_DATA_DIR, false);
1725 }
1726
Yifan Hongd90cc652020-02-08 16:52:02 -08001727 ds.AddDir(SNAPSHOTCTL_LOG_DIR, false);
1728
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001729 if (ds.dump_pool_) {
1730 WAIT_TASK_WITH_CONSENT_CHECK(DUMP_BOARD_TASK, ds.dump_pool_);
1731 } else {
1732 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
1733 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001734
Steven Moreland7440ddb2016-12-15 16:13:39 -08001735 /* Migrate the ril_dumpstate to a device specific dumpstate? */
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001736 int rilDumpstateTimeout = android::base::GetIntProperty("ril.dumpstate.timeout", 0);
1737 if (rilDumpstateTimeout > 0) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001738 // su does not exist on user builds, so try running without it.
1739 // This way any implementations of vril-dump that do not require
1740 // root can run on user builds.
1741 CommandOptions::CommandOptionsBuilder options =
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001742 CommandOptions::WithTimeout(rilDumpstateTimeout);
Felipe Lemef0292972016-11-22 13:57:05 -08001743 if (!PropertiesHelper::IsUserBuild()) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001744 options.AsRoot();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001745 }
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001746 RunCommand("DUMP VENDOR RIL LOGS", {"vril-dump"}, options.Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -07001747 }
1748
Felipe Lemed8b94e52016-12-08 10:21:44 -08001749 printf("========================================================\n");
1750 printf("== Android Framework Services\n");
1751 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001752
Nandana Dutt5c390032019-03-12 10:52:56 +00001753 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysNormal);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001754
Jack He91ff2fe2021-02-18 18:23:43 -08001755 /* Dump Bluetooth HCI logs after getting bluetooth_manager dumpsys */
1756 ds.AddDir("/data/misc/bluetooth/logs", true);
1757
Rhed Jaoe017f982020-07-21 17:58:41 +08001758 if (ds.dump_pool_) {
1759 WAIT_TASK_WITH_CONSENT_CHECK(DUMP_CHECKINS_TASK, ds.dump_pool_);
1760 } else {
1761 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_CHECKINS_TASK, DumpCheckins);
1762 }
Dianne Hackborn02bea972013-06-26 18:59:09 -07001763
Rhed Jaoc5f7ec32020-12-22 22:11:08 +08001764 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpAppInfos);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001765
Adrian Roos8b397ab2017-04-04 16:35:44 -07001766 printf("========================================================\n");
1767 printf("== Dropbox crashes\n");
1768 printf("========================================================\n");
1769
1770 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1771 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1772
Felipe Lemed8b94e52016-12-08 10:21:44 -08001773 printf("========================================================\n");
1774 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1775 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1776 printf("========================================================\n");
1777 printf("== dumpstate: done (id %d)\n", ds.id_);
1778 printf("========================================================\n");
Bookatz38472142018-09-28 10:20:24 -07001779
1780 printf("========================================================\n");
1781 printf("== Obtaining statsd metadata\n");
1782 printf("========================================================\n");
1783 // This differs from the usual dumpsys stats, which is the stats report data.
1784 RunDumpsys("STATSDSTATS", {"stats", "--metadata"});
Mike Ma5c267872019-08-21 11:31:34 -07001785
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +09001786 // Add linker configuration directory
1787 ds.AddDir(LINKERCONFIG_DIR, true);
1788
Li Li2eedd412021-06-30 15:11:53 -07001789 /* Dump cgroupfs */
1790 ds.AddDir(CGROUPFS_DIR, true);
1791
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001792 if (ds.dump_pool_) {
1793 WAIT_TASK_WITH_CONSENT_CHECK(DUMP_INCIDENT_REPORT_TASK, ds.dump_pool_);
1794 } else {
1795 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_INCIDENT_REPORT_TASK,
1796 DumpIncidentReport);
1797 }
Mike Ma5c267872019-08-21 11:31:34 -07001798
Nandana Dutt5c390032019-03-12 10:52:56 +00001799 return Dumpstate::RunStatus::OK;
Colin Crossf45fa6b2012-03-26 12:38:26 -07001800}
1801
Nandana Dutt5c390032019-03-12 10:52:56 +00001802/*
1803 * Dumps state for the default case; drops root after it's no longer necessary.
1804 *
1805 * Returns RunStatus::OK if everything went fine.
1806 * Returns RunStatus::ERROR if there was an error.
1807 * Returns RunStatus::USER_DENIED_CONSENT if user explicitly denied consent to sharing the bugreport
1808 * with the caller.
1809 */
Jichao Lie89d9c12019-11-21 19:02:51 -08001810Dumpstate::RunStatus Dumpstate::DumpstateDefaultAfterCritical() {
Nandana Duttdb379fa2019-10-09 16:54:41 +01001811 // Capture first logcat early on; useful to take a snapshot before dumpstate logs take over the
1812 // buffer.
1813 DoLogcat();
1814 // Capture timestamp after first logcat to use in next logcat
1815 time_t logcat_ts = time(nullptr);
1816
Nandana Dutt4be45d12018-09-26 15:04:23 +01001817 /* collect stack traces from Dalvik and native processes (needs root) */
Rhed Jao5377d792020-07-16 17:37:39 +08001818 if (dump_pool_) {
1819 RETURN_IF_USER_DENIED_CONSENT();
1820 // One thread is enough since we only need to enqueue DumpTraces here.
1821 dump_pool_->start(/* thread_counts = */1);
1822
1823 // DumpTraces takes long time, post it to the another thread in the
1824 // pool, if pool is available
1825 dump_pool_->enqueueTask(DUMP_TRACES_TASK, &Dumpstate::DumpTraces, &ds, &dump_traces_path);
1826 } else {
1827 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_TRACES_TASK, ds.DumpTraces,
1828 &dump_traces_path);
1829 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001830
1831 /* Run some operations that require root. */
1832 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX, !ds.IsZipping());
1833 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX, !ds.IsZipping());
1834
1835 ds.AddDir(RECOVERY_DIR, true);
1836 ds.AddDir(RECOVERY_DATA_DIR, true);
1837 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
1838 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1839 if (!PropertiesHelper::IsUserBuild()) {
1840 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1841 ds.AddDir(PROFILE_DATA_DIR_REF, true);
Calin Juravlef84d3692020-04-28 15:31:12 -07001842 ds.AddZipEntry(ZIP_ROOT_DIR + PACKAGE_DEX_USE_LIST, PACKAGE_DEX_USE_LIST);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001843 }
Jerry Changa1df8a92020-01-02 16:03:39 +08001844 ds.AddDir(PREREBOOT_DATA_DIR, false);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001845 add_mountinfo();
1846 DumpIpTablesAsRoot();
David Andersond9ba4752018-12-11 18:26:59 -08001847 DumpDynamicPartitionInfo();
Yifan Hong3945e1b2019-10-29 12:59:23 -07001848 ds.AddDir(OTA_METADATA_DIR, true);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001849
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001850 // Capture any IPSec policies in play. No keys are exposed here.
Nandana Dutt4be45d12018-09-26 15:04:23 +01001851 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1852
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001853 // Dump IPsec stats. No keys are exposed here.
1854 DumpFile("XFRM STATS", XFRM_STAT_PROC_FILE);
1855
Nandana Dutt4be45d12018-09-26 15:04:23 +01001856 // Run ss as root so we can see socket marks.
1857 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
1858
1859 // Run iotop as root to show top 100 IO threads
1860 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
1861
Erick Reyese68df822019-02-11 14:46:36 -08001862 // Gather shared memory buffer info if the product implements it
Hridya Valsaraju1da80c52021-01-09 22:10:11 -08001863 RunCommand("Dmabuf dump", {"dmabuf_dump"});
1864 RunCommand("Dmabuf per-buffer/per-exporter/per-device stats", {"dmabuf_dump", "-b"});
Erick Reyese68df822019-02-11 14:46:36 -08001865
Minchan Kim22c6a1e2019-09-30 15:58:10 -07001866 DumpFile("PSI cpu", "/proc/pressure/cpu");
1867 DumpFile("PSI memory", "/proc/pressure/memory");
1868 DumpFile("PSI io", "/proc/pressure/io");
1869
Rhed Jao5377d792020-07-16 17:37:39 +08001870 if (dump_pool_) {
1871 RETURN_IF_USER_DENIED_CONSENT();
1872 dump_pool_->waitForTask(DUMP_TRACES_TASK);
1873
1874 // Current running thread in the pool is the root user also. Shutdown
1875 // the pool and restart later to ensure all threads in the pool could
1876 // drop the root user.
1877 dump_pool_->shutdown();
1878 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001879 if (!DropRootUser()) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001880 return Dumpstate::RunStatus::ERROR;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001881 }
1882
Nandana Dutt5c390032019-03-12 10:52:56 +00001883 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttdb379fa2019-10-09 16:54:41 +01001884 Dumpstate::RunStatus status = dumpstate();
1885 // Capture logcat since the last time we did it.
1886 DoSystemLogcat(logcat_ts);
1887 return status;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001888}
1889
Rhed Jaob5685b32020-08-14 17:19:17 +08001890// Common states for telephony and wifi which are needed to be collected before
1891// dumpstate drop the root user.
1892static void DumpstateRadioAsRoot() {
1893 DumpIpTablesAsRoot();
1894 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1895}
1896
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001897// This method collects common dumpsys for telephony and wifi. Typically, wifi
1898// reports are fine to include all information, but telephony reports on user
1899// builds need to strip some content (see DumpstateTelephonyOnly).
1900static void DumpstateRadioCommon(bool include_sensitive_info = true) {
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001901 // We need to be picky about some stuff for telephony reports on user builds.
1902 if (!include_sensitive_info) {
1903 // Only dump the radio log buffer (other buffers and dumps contain too much unrelated info).
1904 DoRadioLogcat();
1905 } else {
Rhed Jaob5685b32020-08-14 17:19:17 +08001906 // DumpHals takes long time, post it to the another thread in the pool,
1907 // if pool is available.
1908 if (ds.dump_pool_) {
1909 ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
1910 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001911 // Contains various system properties and process startup info.
1912 do_dmesg();
1913 // Logs other than the radio buffer may contain package/component names and potential PII.
1914 DoLogcat();
1915 // Too broad for connectivity problems.
1916 DoKmsg();
Rhed Jaob5685b32020-08-14 17:19:17 +08001917 // DumpHals contains unrelated hardware info (camera, NFC, biometrics, ...).
1918 if (ds.dump_pool_) {
1919 ds.dump_pool_->waitForTask(DUMP_HALS_TASK);
1920 } else {
1921 RUN_SLOW_FUNCTION_AND_LOG(DUMP_HALS_TASK, DumpHals);
1922 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001923 }
1924
Jayachandran Ca94c7172017-06-10 15:08:12 -07001925 DumpPacketStats();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001926 DumpIpAddrAndRules();
1927 dump_route_tables();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001928 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
1929 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08001930}
1931
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001932// We use "telephony" here for legacy reasons, though this now really means "connectivity" (cellular
1933// + wifi + networking). This method collects dumpsys for connectivity debugging only. General rules
1934// for what can be included on user builds: all reported information MUST directly relate to
1935// connectivity debugging or customer support and MUST NOT contain unrelated personally identifiable
1936// information. This information MUST NOT identify user-installed packages (UIDs are OK, package
1937// names are not), and MUST NOT contain logs of user application traffic.
1938// TODO(b/148168577) rename this and other related fields/methods to "connectivity" instead.
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08001939static void DumpstateTelephonyOnly(const std::string& calling_package) {
mukesh agrawal253dad42018-01-23 21:59:59 -08001940 DurationReporter duration_reporter("DUMPSTATE");
Jichao Lie89d9c12019-11-21 19:02:51 -08001941
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001942 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08001943
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001944 const bool include_sensitive_info = !PropertiesHelper::IsUserBuild();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001945
Rhed Jaob5685b32020-08-14 17:19:17 +08001946 DumpstateRadioAsRoot();
1947 if (!DropRootUser()) {
1948 return;
1949 }
1950
1951 // Starts thread pool after the root user is dropped, and two additional threads
1952 // are created for DumpHals in the DumpstateRadioCommon and DumpstateBoard.
1953 if (ds.dump_pool_) {
1954 ds.dump_pool_->start(/*thread_counts =*/2);
1955
1956 // DumpstateBoard takes long time, post it to the another thread in the pool,
1957 // if pool is available.
1958 ds.dump_pool_->enqueueTaskWithFd(DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
1959 }
1960
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001961 DumpstateRadioCommon(include_sensitive_info);
1962
1963 if (include_sensitive_info) {
1964 // Contains too much unrelated PII, and given the unstructured nature of sysprops, we can't
1965 // really cherrypick all of the connectivity-related ones. Apps generally have no business
1966 // reading these anyway, and there should be APIs to supply the info in a more app-friendly
1967 // way.
1968 RunCommand("SYSTEM PROPERTIES", {"getprop"});
1969 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07001970
1971 printf("========================================================\n");
1972 printf("== Android Framework Services\n");
1973 printf("========================================================\n");
1974
Vishnu Nair652cc802017-11-30 15:18:30 -08001975 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1976 SEC_TO_MSEC(10));
Hunter Knepshield31cbae12021-05-11 16:23:24 -07001977 RunDumpsys("DUMPSYS", {"vcn_management"}, CommandOptions::WithTimeout(90).Build(),
1978 SEC_TO_MSEC(10));
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08001979 if (include_sensitive_info) {
1980 // Carrier apps' services will be dumped below in dumpsys activity service all-non-platform.
1981 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
1982 SEC_TO_MSEC(10));
1983 } else {
1984 // If the caller is a carrier app and has a carrier service, dump it here since we aren't
1985 // running dumpsys activity service all-non-platform below. Due to the increased output, we
1986 // give a higher timeout as well.
1987 RunDumpsys("DUMPSYS", {"carrier_config", "--requesting-package", calling_package},
1988 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(30));
1989 }
1990 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001991 RunDumpsys("DUMPSYS", {"netpolicy"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
1992 RunDumpsys("DUMPSYS", {"network_management"}, CommandOptions::WithTimeout(90).Build(),
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07001993 SEC_TO_MSEC(10));
Hunter Knepshield0fe51b12020-03-05 16:58:20 -08001994 RunDumpsys("DUMPSYS", {"telephony.registry"}, CommandOptions::WithTimeout(90).Build(),
1995 SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001996 if (include_sensitive_info) {
1997 // Contains raw IP addresses, omit from reports on user builds.
1998 RunDumpsys("DUMPSYS", {"netd"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
1999 // Contains raw destination IP/MAC addresses, omit from reports on user builds.
2000 RunDumpsys("DUMPSYS", {"connmetrics"}, CommandOptions::WithTimeout(90).Build(),
2001 SEC_TO_MSEC(10));
2002 // Contains package/component names, omit from reports on user builds.
2003 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
2004 SEC_TO_MSEC(10));
2005 // Contains package names, but should be relatively simple to remove them (also contains
2006 // UIDs already), omit from reports on user builds.
2007 RunDumpsys("BATTERYSTATS", {"deviceidle"}, CommandOptions::WithTimeout(90).Build(),
2008 SEC_TO_MSEC(10));
2009 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002010
2011 printf("========================================================\n");
2012 printf("== Running Application Services\n");
2013 printf("========================================================\n");
2014
2015 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
2016
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002017 if (include_sensitive_info) {
2018 printf("========================================================\n");
2019 printf("== Running Application Services (non-platform)\n");
2020 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002021
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002022 // Contains package/component names and potential PII, omit from reports on user builds.
2023 // To get dumps of the active CarrierService(s) on user builds, we supply an argument to the
2024 // carrier_config dumpsys instead.
2025 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
2026 DUMPSYS_COMPONENTS_OPTIONS);
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002027
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002028 printf("========================================================\n");
2029 printf("== Checkins\n");
2030 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002031
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002032 // Contains package/component names, omit from reports on user builds.
2033 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
2034 }
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002035
2036 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07002037 printf("== dumpstate: done (id %d)\n", ds.id_);
2038 printf("========================================================\n");
Rhed Jaob5685b32020-08-14 17:19:17 +08002039
2040 if (ds.dump_pool_) {
2041 ds.dump_pool_->waitForTask(DUMP_BOARD_TASK);
2042 } else {
2043 RUN_SLOW_FUNCTION_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
2044 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002045}
2046
mukesh agrawal253dad42018-01-23 21:59:59 -08002047// This method collects dumpsys for wifi debugging only
2048static void DumpstateWifiOnly() {
2049 DurationReporter duration_reporter("DUMPSTATE");
2050
Rhed Jaob5685b32020-08-14 17:19:17 +08002051 DumpstateRadioAsRoot();
2052 if (!DropRootUser()) {
2053 return;
2054 }
2055
2056 // Starts thread pool after the root user is dropped. Only one additional
2057 // thread is needed for DumpHals in the DumpstateRadioCommon.
2058 if (ds.dump_pool_) {
2059 ds.dump_pool_->start(/*thread_counts =*/1);
2060 }
2061
mukesh agrawal253dad42018-01-23 21:59:59 -08002062 DumpstateRadioCommon();
2063
2064 printf("========================================================\n");
2065 printf("== Android Framework Services\n");
2066 printf("========================================================\n");
2067
2068 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
2069 SEC_TO_MSEC(10));
2070 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
2071 SEC_TO_MSEC(10));
2072
2073 printf("========================================================\n");
2074 printf("== dumpstate: done (id %d)\n", ds.id_);
2075 printf("========================================================\n");
2076}
2077
Nandana Duttcf419a72019-03-14 10:40:17 +00002078Dumpstate::RunStatus Dumpstate::DumpTraces(const char** path) {
Gavin Corkery789d7a52021-02-24 23:52:35 +00002079 const std::string temp_file_pattern = ds.bugreport_internal_dir_ + "/dumptrace_XXXXXX";
Nandana Duttfaafd522019-03-11 09:23:09 +00002080 const size_t buf_size = temp_file_pattern.length() + 1;
2081 std::unique_ptr<char[]> file_name_buf(new char[buf_size]);
2082 memcpy(file_name_buf.get(), temp_file_pattern.c_str(), buf_size);
2083
2084 // Create a new, empty file to receive all trace dumps.
2085 //
2086 // TODO: This can be simplified once we remove support for the old style
2087 // dumps. We can have a file descriptor passed in to dump_traces instead
2088 // of creating a file, closing it and then reopening it again.
2089 android::base::unique_fd fd(mkostemp(file_name_buf.get(), O_APPEND | O_CLOEXEC));
2090 if (fd < 0) {
2091 MYLOGE("mkostemp on pattern %s: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002092 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002093 }
2094
2095 // Nobody should have access to this temporary file except dumpstate, but we
2096 // temporarily grant 'read' to 'others' here because this file is created
2097 // when tombstoned is still running as root, but dumped after dropping. This
2098 // can go away once support for old style dumping has.
2099 const int chmod_ret = fchmod(fd, 0666);
2100 if (chmod_ret < 0) {
2101 MYLOGE("fchmod on %s failed: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002102 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002103 }
2104
2105 std::unique_ptr<DIR, decltype(&closedir)> proc(opendir("/proc"), closedir);
2106 if (proc.get() == nullptr) {
2107 MYLOGE("opendir /proc failed: %s\n", strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002108 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002109 }
2110
2111 // Number of times process dumping has timed out. If we encounter too many
2112 // failures, we'll give up.
2113 int timeout_failures = 0;
2114 bool dalvik_found = false;
2115
2116 const std::set<int> hal_pids = get_interesting_hal_pids();
2117
2118 struct dirent* d;
2119 while ((d = readdir(proc.get()))) {
Nandana Duttcf419a72019-03-14 10:40:17 +00002120 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttfaafd522019-03-11 09:23:09 +00002121 int pid = atoi(d->d_name);
2122 if (pid <= 0) {
2123 continue;
2124 }
2125
2126 const std::string link_name = android::base::StringPrintf("/proc/%d/exe", pid);
2127 std::string exe;
2128 if (!android::base::Readlink(link_name, &exe)) {
2129 continue;
2130 }
2131
2132 bool is_java_process;
2133 if (exe == "/system/bin/app_process32" || exe == "/system/bin/app_process64") {
2134 // Don't bother dumping backtraces for the zygote.
2135 if (IsZygote(pid)) {
2136 continue;
2137 }
2138
2139 dalvik_found = true;
2140 is_java_process = true;
2141 } else if (should_dump_native_traces(exe.c_str()) || hal_pids.find(pid) != hal_pids.end()) {
2142 is_java_process = false;
2143 } else {
2144 // Probably a native process we don't care about, continue.
2145 continue;
2146 }
2147
2148 // If 3 backtrace dumps fail in a row, consider debuggerd dead.
2149 if (timeout_failures == 3) {
2150 dprintf(fd, "ERROR: Too many stack dump failures, exiting.\n");
2151 break;
2152 }
2153
2154 const uint64_t start = Nanotime();
2155 const int ret = dump_backtrace_to_file_timeout(
2156 pid, is_java_process ? kDebuggerdJavaBacktrace : kDebuggerdNativeBacktrace,
2157 is_java_process ? 5 : 20, fd);
2158
2159 if (ret == -1) {
2160 // For consistency, the header and footer to this message match those
2161 // dumped by debuggerd in the success case.
2162 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
2163 dprintf(fd, "Dump failed, likely due to a timeout.\n");
2164 dprintf(fd, "---- end %d ----", pid);
2165 timeout_failures++;
2166 continue;
2167 }
2168
2169 // We've successfully dumped stack traces, reset the failure count
2170 // and write a summary of the elapsed time to the file and continue with the
2171 // next process.
2172 timeout_failures = 0;
2173
2174 dprintf(fd, "[dump %s stack %d: %.3fs elapsed]\n", is_java_process ? "dalvik" : "native",
2175 pid, (float)(Nanotime() - start) / NANOS_PER_SEC);
2176 }
2177
2178 if (!dalvik_found) {
2179 MYLOGE("Warning: no Dalvik processes found to dump stacks\n");
2180 }
2181
Nandana Duttcf419a72019-03-14 10:40:17 +00002182 *path = file_name_buf.release();
2183 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002184}
2185
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002186void Dumpstate::DumpstateBoard(int out_fd) {
2187 dprintf(out_fd, "========================================================\n");
2188 dprintf(out_fd, "== Board\n");
2189 dprintf(out_fd, "========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08002190
Felipe Leme6f674ae2016-11-18 17:10:33 -08002191 if (!IsZipping()) {
Steven Moreland7440ddb2016-12-15 16:13:39 -08002192 MYLOGD("Not dumping board info because it's not a zipped bugreport\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08002193 return;
2194 }
2195
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002196 /*
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002197 * mount debugfs for non-user builds with ro.product.debugfs_restrictions.enabled
Hridya Valsaraju51101602021-04-02 14:32:46 -07002198 * set to true and unmount it after invoking dumpstateBoard_* methods.
2199 * This is to enable debug builds to not have debugfs mounted during runtime.
2200 * It will also ensure that debugfs is only accessed by the dumpstate HAL.
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002201 */
Hridya Valsaraju51101602021-04-02 14:32:46 -07002202 auto mount_debugfs =
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002203 android::base::GetBoolProperty("ro.product.debugfs_restrictions.enabled", false);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002204 if (mount_debugfs) {
2205 RunCommand("mount debugfs", {"mount", "-t", "debugfs", "debugfs", "/sys/kernel/debug"},
2206 AS_ROOT_20);
2207 RunCommand("chmod debugfs", {"chmod", "0755", "/sys/kernel/debug"},
2208 AS_ROOT_20);
2209 }
2210
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002211 std::vector<std::string> paths;
2212 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07002213 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002214 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
2215 kDumpstateBoardFiles[i].c_str()));
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002216 remover.emplace_back(android::base::make_scope_guard(
2217 std::bind([](std::string path) { android::os::UnlinkAndLogOnError(path); }, paths[i])));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002218 }
Jie Song9fbfad02017-06-20 16:29:42 -07002219
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002220 sp<IDumpstateDevice_1_0> dumpstate_device_1_0(IDumpstateDevice_1_0::getService());
2221 if (dumpstate_device_1_0 == nullptr) {
Wei Wang587eac92018-04-05 12:17:20 -07002222 MYLOGE("No IDumpstateDevice implementation\n");
2223 return;
2224 }
2225
2226 using ScopedNativeHandle =
2227 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
2228 ScopedNativeHandle handle(native_handle_create(static_cast<int>(paths.size()), 0),
2229 [](native_handle_t* handle) {
2230 native_handle_close(handle);
2231 native_handle_delete(handle);
2232 });
2233 if (handle == nullptr) {
2234 MYLOGE("Could not create native_handle\n");
2235 return;
2236 }
2237
Nandana Dutt5c390032019-03-12 10:52:56 +00002238 // TODO(128270426): Check for consent in between?
Wei Wang587eac92018-04-05 12:17:20 -07002239 for (size_t i = 0; i < paths.size(); i++) {
2240 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
2241
2242 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
2243 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
2244 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
2245 if (fd < 0) {
2246 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
2247 return;
2248 }
2249 handle.get()->data[i] = fd.release();
2250 }
2251
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002252 // Given that bugreport is required to diagnose failures, it's better to set an arbitrary amount
2253 // of timeout for IDumpstateDevice than to block the rest of bugreport. In the timeout case, we
2254 // will kill the HAL and grab whatever it dumped in time.
2255 constexpr size_t timeout_sec = 30;
2256 // Prefer version 1.1 if available. New devices launching with R are no longer allowed to
2257 // implement just 1.0.
2258 const char* descriptor_to_kill;
2259 using DumpstateBoardTask = std::packaged_task<bool()>;
2260 DumpstateBoardTask dumpstate_board_task;
2261 sp<IDumpstateDevice_1_1> dumpstate_device_1_1(
2262 IDumpstateDevice_1_1::castFrom(dumpstate_device_1_0));
2263 if (dumpstate_device_1_1 != nullptr) {
2264 MYLOGI("Using IDumpstateDevice v1.1");
2265 descriptor_to_kill = IDumpstateDevice_1_1::descriptor;
2266 dumpstate_board_task = DumpstateBoardTask([this, dumpstate_device_1_1, &handle]() -> bool {
2267 ::android::hardware::Return<DumpstateStatus> status =
2268 dumpstate_device_1_1->dumpstateBoard_1_1(handle.get(), options_->dumpstate_hal_mode,
2269 SEC_TO_MSEC(timeout_sec));
2270 if (!status.isOk()) {
2271 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2272 return false;
2273 } else if (status != DumpstateStatus::OK) {
2274 MYLOGE("dumpstateBoard failed with DumpstateStatus::%s\n", toString(status).c_str());
2275 return false;
2276 }
2277 return true;
2278 });
2279 } else {
2280 MYLOGI("Using IDumpstateDevice v1.0");
2281 descriptor_to_kill = IDumpstateDevice_1_0::descriptor;
2282 dumpstate_board_task = DumpstateBoardTask([dumpstate_device_1_0, &handle]() -> bool {
2283 ::android::hardware::Return<void> status =
2284 dumpstate_device_1_0->dumpstateBoard(handle.get());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002285 if (!status.isOk()) {
2286 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
Wei Wang587eac92018-04-05 12:17:20 -07002287 return false;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002288 }
Wei Wang587eac92018-04-05 12:17:20 -07002289 return true;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002290 });
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002291 }
2292 auto result = dumpstate_board_task.get_future();
2293 std::thread(std::move(dumpstate_board_task)).detach();
Wei Wang587eac92018-04-05 12:17:20 -07002294
Wei Wang587eac92018-04-05 12:17:20 -07002295 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2296 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate vendor HAL\n", timeout_sec);
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002297 if (!android::base::SetProperty(
2298 "ctl.interface_restart",
2299 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
Wei Wang587eac92018-04-05 12:17:20 -07002300 MYLOGE("Couldn't restart dumpstate HAL\n");
2301 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002302 }
Wei Wang587eac92018-04-05 12:17:20 -07002303 // Wait some time for init to kill dumpstate vendor HAL
2304 constexpr size_t killing_timeout_sec = 10;
2305 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2306 MYLOGE("killing dumpstateBoard timed out after %zus, continue and "
2307 "there might be racing in content\n", killing_timeout_sec);
2308 }
2309
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002310 if (mount_debugfs) {
Hridya Valsaraju51101602021-04-02 14:32:46 -07002311 auto keep_debugfs_mounted =
2312 android::base::GetProperty("persist.dbg.keep_debugfs_mounted", "");
2313 if (keep_debugfs_mounted.empty())
2314 RunCommand("unmount debugfs", {"umount", "/sys/kernel/debug"}, AS_ROOT_20);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002315 }
2316
Wei Wang587eac92018-04-05 12:17:20 -07002317 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
2318 for (size_t i = 0; i < paths.size(); i++) {
2319 struct stat s;
2320 if (fstat(handle.get()->data[i], &s) == -1) {
2321 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(),
2322 strerror(errno));
2323 file_sizes[i] = -1;
2324 continue;
2325 }
2326 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002327 }
2328
2329 for (size_t i = 0; i < paths.size(); i++) {
2330 if (file_sizes[i] == -1) {
2331 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002332 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002333 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07002334 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002335 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002336 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002337 remover[i].Disable();
2338 EnqueueAddZipEntryAndCleanupIfNeeded(kDumpstateBoardFiles[i], paths[i]);
2339 dprintf(out_fd, "*** See %s entry ***\n", kDumpstateBoardFiles[i].c_str());
Jie Song9fbfad02017-06-20 16:29:42 -07002340 }
Felipe Leme6f674ae2016-11-18 17:10:33 -08002341}
2342
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002343static void ShowUsage() {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002344 fprintf(stderr,
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002345 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-o directory] [-p] "
2346 "[-s] [-S] [-q] [-P] [-R] [-L] [-V version]\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002347 " -h: display this help message\n"
2348 " -b: play sound file instead of vibrate, at beginning of job\n"
2349 " -e: play sound file instead of vibrate, at end of job\n"
mhasank2d75c442020-06-11 15:05:25 -07002350 " -o: write to custom directory (only in limited mode)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01002351 " -p: capture screenshot to filename.png\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002352 " -s: write zipped file to control socket (for init)\n"
2353 " -S: write file location to control socket (for init)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002354 " -q: disable vibrate\n"
Abhijeet Kaure370d682019-10-01 16:49:30 +01002355 " -P: send broadcast when started and do progress updates\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002356 " -R: take bugreport in remote mode (shouldn't be used with -P)\n"
Nandana Dutt235864b2019-01-22 12:10:16 +00002357 " -w: start binder service and make it wait for a call to startBugreport\n"
mhasankd451a472020-05-26 18:02:39 -07002358 " -L: output limited information that is safe for submission in feedback reports\n"
Felipe Lemed071c682016-10-20 16:48:00 -07002359 " -v: prints the dumpstate header and exit\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002360}
2361
Wei Liuf87959e2016-08-26 14:51:42 -07002362static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07002363 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07002364}
2365
Felipe Leme1d486fe2016-10-14 18:06:47 -07002366bool Dumpstate::FinishZipFile() {
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002367 // Runs all enqueued adding zip entry and cleanup tasks before finishing the zip file.
2368 if (zip_entry_tasks_) {
2369 zip_entry_tasks_->run(/* do_cancel = */false);
2370 }
2371
Felipe Leme9a523ae2016-10-20 15:10:33 -07002372 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07002373 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07002374 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002375 // Final timestamp
2376 char date[80];
2377 time_t the_real_now_please_stand_up = time(nullptr);
2378 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002379 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07002380 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002381
Felipe Leme9a523ae2016-10-20 15:10:33 -07002382 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002383 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08002384 return false;
2385 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07002386 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002387 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08002388 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08002389 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08002390
Felipe Leme0f3fb202016-06-10 17:10:53 -07002391 // Add log file (which contains stderr output) to zip...
2392 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07002393 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07002394 MYLOGE("Failed to add dumpstate log to .zip file\n");
2395 return false;
2396 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002397 // TODO: Should truncate the existing file.
2398 // ... and re-open it for further logging.
Nandana Dutta344cb62019-02-22 15:12:35 +00002399 if (!redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()))) {
2400 return false;
2401 }
Felipe Leme0f3fb202016-06-10 17:10:53 -07002402 fprintf(stderr, "\n");
2403
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002404 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07002405 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002406 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002407 return false;
2408 }
2409
Felipe Leme1d486fe2016-10-14 18:06:47 -07002410 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
2411 ds.zip_file.reset(nullptr);
2412
Felipe Lemee9d2c542016-11-15 11:48:26 -08002413 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002414 android::os::UnlinkAndLogOnError(tmp_path_);
Felipe Lemec4eee562016-04-21 15:42:55 -07002415
Felipe Leme1e9edc62015-12-21 16:02:13 -08002416 return true;
2417}
Felipe Leme6e01fa62015-11-11 19:35:14 -08002418
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002419static void SendBroadcast(const std::string& action, const std::vector<std::string>& args) {
2420 // clang-format off
2421 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user", "0",
2422 "--receiver-foreground", "--receiver-include-background", "-a", action};
2423 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08002424
2425 am.insert(am.end(), args.begin(), args.end());
2426
Felipe Leme8d2410e2017-02-08 09:46:08 -08002427 RunCommand("", am,
2428 CommandOptions::WithTimeout(20)
2429 .Log("Sending broadcast: '%s'\n")
2430 .Always()
2431 .DropRoot()
2432 .RedirectStderr()
2433 .Build());
2434}
2435
Felipe Leme35b8cf12017-02-10 15:47:29 -08002436static void Vibrate(int duration_ms) {
2437 // clang-format off
Lais Andrade51156962021-02-22 19:21:35 +00002438 std::vector<std::string> args = {"cmd", "vibrator_manager", "synced", "-f", "-d", "dumpstate",
2439 "oneshot", std::to_string(duration_ms)};
2440 RunCommand("", args,
Felipe Leme35b8cf12017-02-10 15:47:29 -08002441 CommandOptions::WithTimeout(10)
2442 .Log("Vibrate: '%s'\n")
2443 .Always()
2444 .Build());
2445 // clang-format on
2446}
2447
Nandana Dutt979388e2018-11-30 16:48:55 +00002448static void MaybeResolveSymlink(std::string* path) {
2449 std::string resolved_path;
2450 if (android::base::Readlink(*path, &resolved_path)) {
2451 *path = resolved_path;
2452 }
2453}
2454
Nandana Dutt4be45d12018-09-26 15:04:23 +01002455/*
2456 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002457 * and adds the version file. Return false if zip_file could not be open to write.
Nandana Dutt4be45d12018-09-26 15:04:23 +01002458 */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002459static bool PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002460 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
2461
Nandana Dutt4be45d12018-09-26 15:04:23 +01002462 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
2463 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002464 ds.base_name_ = StringPrintf("bugreport-%s-%s", device_name.c_str(), build_id.c_str());
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002465 char date[80];
2466 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
2467 ds.name_ = date;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002468
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002469 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002470 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002471 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002472 ds.base_name_ += "-wifi";
2473 }
2474
Paul Chang0d2aad72020-02-13 20:04:03 +08002475 if (ds.options_->do_screenshot) {
Nandana Dutt9d17b942020-03-26 10:02:59 +00002476 ds.screenshot_path_ = ds.GetPath(ds.CalledByApi() ? "-png.tmp" : ".png");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002477 }
2478 ds.tmp_path_ = ds.GetPath(".tmp");
2479 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
2480
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002481 std::string destination = ds.CalledByApi()
Nandana Dutt54dbd672019-01-11 12:58:05 +00002482 ? StringPrintf("[fd:%d]", ds.options_->bugreport_fd.get())
Nandana Dutt9a76d202019-01-21 15:56:48 +00002483 : ds.bugreport_internal_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01002484 MYLOGD(
Nandana Dutt235c6672019-11-14 15:22:32 +00002485 "Bugreport dir: [%s] "
2486 "Base name: [%s] "
2487 "Suffix: [%s] "
2488 "Log path: [%s] "
2489 "Temporary path: [%s] "
2490 "Screenshot path: [%s]\n",
Nandana Dutt9a76d202019-01-21 15:56:48 +00002491 destination.c_str(), ds.base_name_.c_str(), ds.name_.c_str(), ds.log_path_.c_str(),
2492 ds.tmp_path_.c_str(), ds.screenshot_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002493
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002494 ds.path_ = ds.GetPath(ds.CalledByApi() ? "-zip.tmp" : ".zip");
2495 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
2496 create_parent_dirs(ds.path_.c_str());
2497 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
2498 if (ds.zip_file == nullptr) {
2499 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
2500 return false;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002501 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002502 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
2503 ds.AddTextZipEntry("version.txt", ds.version_);
2504 return true;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002505}
2506
2507/*
Abhijeet Kaure370d682019-10-01 16:49:30 +01002508 * Finalizes writing to the file by zipping the tmp file to the final location,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002509 * printing zipped file status, etc.
2510 */
2511static void FinalizeFile() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002512 bool do_text_file = !ds.FinishZipFile();
2513 if (do_text_file) {
2514 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002515 }
mhasank2d75c442020-06-11 15:05:25 -07002516
2517 std::string final_path = ds.path_;
2518 if (ds.options_->OutputToCustomFile()) {
mhasank3a4cfb42020-06-15 18:06:43 -07002519 final_path = ds.GetPath(ds.options_->out_dir, ".zip");
mhasank2d75c442020-06-11 15:05:25 -07002520 android::os::CopyFileToFile(ds.path_, final_path);
2521 }
2522
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002523 if (ds.options_->stream_to_socket) {
2524 android::os::CopyFileToFd(ds.path_, ds.control_socket_fd_);
2525 } else if (ds.options_->progress_updates_to_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002526 if (do_text_file) {
2527 dprintf(ds.control_socket_fd_,
2528 "FAIL:could not create zip file, check %s "
2529 "for more details\n",
2530 ds.log_path_.c_str());
2531 } else {
mhasank2d75c442020-06-11 15:05:25 -07002532 dprintf(ds.control_socket_fd_, "OK:%s\n", final_path.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002533 }
2534 }
2535}
2536
Nandana Dutt4be45d12018-09-26 15:04:23 +01002537
Nandana Dutt58d72e22018-11-16 10:30:48 +00002538static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2539 switch (mode) {
2540 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2541 return "BUGREPORT_FULL";
2542 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2543 return "BUGREPORT_INTERACTIVE";
2544 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2545 return "BUGREPORT_REMOTE";
2546 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2547 return "BUGREPORT_WEAR";
2548 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2549 return "BUGREPORT_TELEPHONY";
2550 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2551 return "BUGREPORT_WIFI";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002552 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2553 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002554 }
2555}
2556
Paul Changf59c2b72020-03-10 02:08:55 +08002557static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options,
2558 bool is_screenshot_requested) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002559 // Modify com.android.shell.BugreportProgressService#isDefaultScreenshotRequired as well for
2560 // default system screenshots.
Abhijeet Kaure370d682019-10-01 16:49:30 +01002561 options->bugreport_mode = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002562 switch (mode) {
2563 case Dumpstate::BugreportMode::BUGREPORT_FULL:
Paul Changf59c2b72020-03-10 02:08:55 +08002564 options->do_screenshot = is_screenshot_requested;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002565 options->dumpstate_hal_mode = DumpstateMode::FULL;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002566 break;
2567 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002568 // Currently, the dumpstate binder is only used by Shell to update progress.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002569 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002570 options->do_screenshot = is_screenshot_requested;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002571 options->dumpstate_hal_mode = DumpstateMode::INTERACTIVE;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002572 break;
2573 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002574 options->do_vibrate = false;
2575 options->is_remote_mode = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002576 options->do_screenshot = false;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002577 options->dumpstate_hal_mode = DumpstateMode::REMOTE;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002578 break;
2579 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002580 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002581 options->do_screenshot = is_screenshot_requested;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002582 options->dumpstate_hal_mode = DumpstateMode::WEAR;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002583 break;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002584 // TODO(b/148168577) rename TELEPHONY everywhere to CONNECTIVITY.
Nandana Dutt58d72e22018-11-16 10:30:48 +00002585 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002586 options->telephony_only = true;
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002587 options->do_progress_updates = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002588 options->do_screenshot = false;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002589 options->dumpstate_hal_mode = DumpstateMode::CONNECTIVITY;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002590 break;
2591 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002592 options->wifi_only = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002593 options->do_screenshot = false;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002594 options->dumpstate_hal_mode = DumpstateMode::WIFI;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002595 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002596 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2597 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002598 }
2599}
2600
Nandana Dutt58d72e22018-11-16 10:30:48 +00002601static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
Nandana Dutt235c6672019-11-14 15:22:32 +00002602 MYLOGI(
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002603 "do_vibrate: %d stream_to_socket: %d progress_updates_to_socket: %d do_screenshot: %d "
Rhed Jao25f50e02020-08-20 00:10:32 +08002604 "is_remote_mode: %d show_header_only: %d telephony_only: %d "
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002605 "wifi_only: %d do_progress_updates: %d fd: %d bugreport_mode: %s dumpstate_hal_mode: %s "
mhasankd451a472020-05-26 18:02:39 -07002606 "limited_only: %d args: %s\n",
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002607 options.do_vibrate, options.stream_to_socket, options.progress_updates_to_socket,
Paul Chang0d2aad72020-02-13 20:04:03 +08002608 options.do_screenshot, options.is_remote_mode, options.show_header_only,
Rhed Jao25f50e02020-08-20 00:10:32 +08002609 options.telephony_only, options.wifi_only,
mhasankd451a472020-05-26 18:02:39 -07002610 options.do_progress_updates, options.bugreport_fd.get(), options.bugreport_mode.c_str(),
2611 toString(options.dumpstate_hal_mode).c_str(), options.limited_only, options.args.c_str());
Nandana Dutt58d72e22018-11-16 10:30:48 +00002612}
2613
Nandana Dutt54dbd672019-01-11 12:58:05 +00002614void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode,
2615 const android::base::unique_fd& bugreport_fd_in,
Paul Changf59c2b72020-03-10 02:08:55 +08002616 const android::base::unique_fd& screenshot_fd_in,
2617 bool is_screenshot_requested) {
Nandana Dutt54dbd672019-01-11 12:58:05 +00002618 // Duplicate the fds because the passed in fds don't outlive the binder transaction.
2619 bugreport_fd.reset(dup(bugreport_fd_in.get()));
2620 screenshot_fd.reset(dup(screenshot_fd_in.get()));
Nandana Dutt58d72e22018-11-16 10:30:48 +00002621
Paul Changf59c2b72020-03-10 02:08:55 +08002622 SetOptionsFromMode(bugreport_mode, this, is_screenshot_requested);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002623}
2624
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002625Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
2626 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002627 int c;
mhasankd451a472020-05-26 18:02:39 -07002628 while ((c = getopt(argc, argv, "dho:svqzpLPBRSV:w")) != -1) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002629 switch (c) {
2630 // clang-format off
mhasank3a4cfb42020-06-15 18:06:43 -07002631 case 'o': out_dir = optarg; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002632 case 's': stream_to_socket = true; break;
2633 case 'S': progress_updates_to_socket = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002634 case 'v': show_header_only = true; break;
2635 case 'q': do_vibrate = false; break;
Paul Chang0d2aad72020-02-13 20:04:03 +08002636 case 'p': do_screenshot = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002637 case 'P': do_progress_updates = true; break;
2638 case 'R': is_remote_mode = true; break;
mhasankd451a472020-05-26 18:02:39 -07002639 case 'L': limited_only = true; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002640 case 'V':
2641 case 'd':
2642 case 'z':
2643 // compatibility no-op
2644 break;
Nandana Dutt235864b2019-01-22 12:10:16 +00002645 case 'w':
2646 // This was already processed
2647 break;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002648 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002649 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002650 break;
2651 default:
2652 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002653 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002654 break;
2655 // clang-format on
2656 }
2657 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08002658
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002659 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002660 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002661 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002662 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002663 }
2664 }
2665
2666 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
2667 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002668
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002669 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002670}
2671
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002672bool Dumpstate::DumpOptions::ValidateOptions() const {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002673 if (bugreport_fd.get() != -1 && stream_to_socket) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002674 return false;
2675 }
2676
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002677 if ((progress_updates_to_socket || do_progress_updates) && stream_to_socket) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002678 return false;
2679 }
2680
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002681 if (is_remote_mode && (do_progress_updates || stream_to_socket)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002682 return false;
2683 }
2684 return true;
2685}
2686
Nandana Dutt197661d2018-11-16 16:40:21 +00002687void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
2688 options_ = std::move(options);
2689}
2690
Abhijeet Kaura407fb82020-03-27 12:51:12 +00002691void Dumpstate::Initialize() {
2692 /* gets the sequential id */
2693 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
2694 id_ = ++last_id;
2695 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
2696}
2697
Nandana Duttd2f5f082019-01-18 17:13:52 +00002698Dumpstate::RunStatus Dumpstate::Run(int32_t calling_uid, const std::string& calling_package) {
2699 Dumpstate::RunStatus status = RunInternal(calling_uid, calling_package);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002700 if (listener_ != nullptr) {
2701 switch (status) {
2702 case Dumpstate::RunStatus::OK:
Nandana Duttcc4ead82019-01-23 08:29:23 +00002703 listener_->onFinished();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002704 break;
2705 case Dumpstate::RunStatus::HELP:
2706 break;
2707 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002708 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_INVALID_INPUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002709 break;
2710 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002711 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_RUNTIME_ERROR);
2712 break;
2713 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2714 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_DENIED_CONSENT);
2715 break;
2716 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
2717 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_CONSENT_TIMED_OUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002718 break;
2719 }
2720 }
2721 return status;
2722}
2723
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002724void Dumpstate::Cancel() {
2725 CleanupTmpFiles();
2726 android::os::UnlinkAndLogOnError(log_path_);
2727 for (int i = 0; i < NUM_OF_DUMPS; i++) {
2728 android::os::UnlinkAndLogOnError(ds.bugreport_internal_dir_ + "/" +
2729 kDumpstateBoardFiles[i]);
2730 }
2731 tombstone_data_.clear();
2732 anr_data_.clear();
Rhed Jao0daac912020-08-21 14:48:20 +08002733
2734 // Instead of shutdown the pool, we delete temporary files directly since
2735 // shutdown blocking the call.
2736 if (dump_pool_) {
2737 dump_pool_->deleteTempFiles();
2738 }
2739 if (zip_entry_tasks_) {
2740 zip_entry_tasks_->run(/*do_cancel =*/ true);
2741 }
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002742}
2743
Nandana Dutt979388e2018-11-30 16:48:55 +00002744/*
2745 * Dumps relevant information to a bugreport based on the given options.
2746 *
2747 * The bugreport can be dumped to a file or streamed to a socket.
2748 *
2749 * How dumping to file works:
2750 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
2751 * stderr is redirected a log file.
2752 *
2753 * The temporary bugreport is then populated via printfs, dumping contents of files and
2754 * output of commands to stdout.
2755 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002756 * A bunch of other files and dumps are added to the zip archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00002757 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002758 * The temporary bugreport file and the log file also get added to the archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00002759 *
mhasank2d75c442020-06-11 15:05:25 -07002760 * Bugreports are first generated in a local directory and later copied to the caller's fd
2761 * or directory if supplied.
Nandana Dutt979388e2018-11-30 16:48:55 +00002762 */
Nandana Duttd2f5f082019-01-18 17:13:52 +00002763Dumpstate::RunStatus Dumpstate::RunInternal(int32_t calling_uid,
2764 const std::string& calling_package) {
Rhed Jao5377d792020-07-16 17:37:39 +08002765 DurationReporter duration_reporter("RUN INTERNAL", /* logcat_only = */true);
Nandana Dutt979388e2018-11-30 16:48:55 +00002766 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00002767 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002768 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002769 return RunStatus::INVALID_INPUT;
2770 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002771 /* set as high priority, and protect from OOM killer */
2772 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002773
Felipe Lemed071c682016-10-20 16:48:00 -07002774 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002775 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002776 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002777 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002778 } else {
2779 /* fallback to kernels <= 2.6.35 */
2780 oom_adj = fopen("/proc/self/oom_adj", "we");
2781 if (oom_adj) {
2782 fputs("-17", oom_adj);
2783 fclose(oom_adj);
2784 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002785 }
2786
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002787 if (version_ == VERSION_DEFAULT) {
2788 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00002789 }
2790
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002791 if (version_ != VERSION_CURRENT && version_ != VERSION_SPLIT_ANR) {
Vishnu Nair64afc022018-02-01 15:29:34 -08002792 MYLOGE("invalid version requested ('%s'); suppported values are: ('%s', '%s', '%s')\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002793 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str(),
Vishnu Nair64afc022018-02-01 15:29:34 -08002794 VERSION_SPLIT_ANR.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002795 return RunStatus::INVALID_INPUT;
Felipe Lemed071c682016-10-20 16:48:00 -07002796 }
2797
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002798 if (options_->show_header_only) {
2799 PrintHeader();
2800 return RunStatus::OK;
Felipe Lemed071c682016-10-20 16:48:00 -07002801 }
2802
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002803 MYLOGD("dumpstate calling_uid = %d ; calling package = %s \n",
2804 calling_uid, calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00002805
Felipe Leme7447d7c2016-11-03 18:12:22 -07002806 // TODO: temporarily set progress until it's part of the Dumpstate constructor
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002807 std::string stats_path =
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002808 android::base::StringPrintf("%s/dumpstate-stats.txt", bugreport_internal_dir_.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002809 progress_.reset(new Progress(stats_path));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002810
Sahana Raof35ed432019-07-12 10:47:52 +01002811 if (acquire_wake_lock(PARTIAL_WAKE_LOCK, WAKE_LOCK_NAME) < 0) {
2812 MYLOGE("Failed to acquire wake lock: %s\n", strerror(errno));
2813 } else {
2814 // Wake lock will be released automatically on process death
2815 MYLOGD("Wake lock acquired.\n");
2816 }
2817
Felipe Leme6ae5c4f2017-01-10 14:13:22 -08002818 register_sig_handler();
Felipe Lemed071c682016-10-20 16:48:00 -07002819
Felipe Lemef0292972016-11-22 13:57:05 -08002820 if (PropertiesHelper::IsDryRun()) {
Felipe Lemed071c682016-10-20 16:48:00 -07002821 MYLOGI("Running on dry-run mode (to disable it, call 'setprop dumpstate.dry_run false')\n");
2822 }
2823
Nandana Dutt235c6672019-11-14 15:22:32 +00002824 MYLOGI("dumpstate info: id=%d, args='%s', bugreport_mode= %s bugreport format version: %s\n",
2825 id_, options_->args.c_str(), options_->bugreport_mode.c_str(), version_.c_str());
Felipe Leme809d74e2016-02-02 12:57:00 -08002826
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002827 do_early_screenshot_ = options_->do_progress_updates;
Felipe Lemee338bf62015-12-07 14:03:50 -08002828
Christopher Ferrised9354f2014-10-01 17:35:01 -07002829 // If we are going to use a socket, do it as early as possible
2830 // to avoid timeouts from bugreport.
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002831 if (options_->stream_to_socket || options_->progress_updates_to_socket) {
Felipe Leme2628e9e2016-04-12 16:36:51 -07002832 MYLOGD("Opening control socket\n");
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002833 control_socket_fd_ = open_socket_fn_("dumpstate");
Nandana Dutta344cb62019-02-22 15:12:35 +00002834 if (control_socket_fd_ == -1) {
2835 return ERROR;
2836 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002837 if (options_->progress_updates_to_socket) {
2838 options_->do_progress_updates = 1;
2839 }
Felipe Leme2628e9e2016-04-12 16:36:51 -07002840 }
2841
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002842 if (!PrepareToWriteToFile()) {
2843 return ERROR;
2844 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08002845
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002846 // Interactive, wear & telephony modes are default to true.
2847 // and may enable from cli option or when using control socket
2848 if (options_->do_progress_updates) {
2849 // clang-format off
2850 std::vector<std::string> am_args = {
2851 "--receiver-permission", "android.permission.DUMP",
2852 };
2853 // clang-format on
2854 // Send STARTED broadcast for apps that listen to bugreport generation events
2855 SendBroadcast("com.android.internal.intent.action.BUGREPORT_STARTED", am_args);
2856 if (options_->progress_updates_to_socket) {
2857 dprintf(control_socket_fd_, "BEGIN:%s\n", path_.c_str());
Felipe Leme71bbfc52015-11-23 14:14:51 -08002858 }
2859 }
2860
Nick Kralevichf3599b32016-01-25 15:05:16 -08002861 /* read /proc/cmdline before dropping root */
2862 FILE *cmdline = fopen("/proc/cmdline", "re");
2863 if (cmdline) {
2864 fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
2865 fclose(cmdline);
2866 }
2867
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002868 if (options_->do_vibrate) {
Felipe Leme35b8cf12017-02-10 15:47:29 -08002869 Vibrate(150);
John Michelau1f794c42012-09-17 11:20:19 -05002870 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002871
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002872 if (zip_file != nullptr) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002873 if (chown(path_.c_str(), AID_SHELL, AID_SHELL)) {
2874 MYLOGE("Unable to change ownership of zip file %s: %s\n", path_.c_str(),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002875 strerror(errno));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002876 }
2877 }
2878
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002879 int dup_stdout_fd;
2880 int dup_stderr_fd;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002881 // Redirect stderr to log_path_ for debugging.
2882 TEMP_FAILURE_RETRY(dup_stderr_fd = dup(fileno(stderr)));
2883 if (!redirect_to_file(stderr, const_cast<char*>(log_path_.c_str()))) {
2884 return ERROR;
2885 }
2886 if (chown(log_path_.c_str(), AID_SHELL, AID_SHELL)) {
2887 MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n", log_path_.c_str(),
2888 strerror(errno));
2889 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002890
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002891 // Redirect stdout to tmp_path_. This is the main bugreport entry and will be
2892 // moved into zip file later, if zipping.
2893 TEMP_FAILURE_RETRY(dup_stdout_fd = dup(fileno(stdout)));
2894 // TODO: why not write to a file instead of stdout to overcome this problem?
2895 /* TODO: rather than generating a text file now and zipping it later,
2896 it would be more efficient to redirect stdout to the zip entry
2897 directly, but the libziparchive doesn't support that option yet. */
2898 if (!redirect_to_file(stdout, const_cast<char*>(tmp_path_.c_str()))) {
2899 return ERROR;
2900 }
2901 if (chown(tmp_path_.c_str(), AID_SHELL, AID_SHELL)) {
2902 MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
2903 tmp_path_.c_str(), strerror(errno));
Colin Crossf45fa6b2012-03-26 12:38:26 -07002904 }
Felipe Lemed8b94e52016-12-08 10:21:44 -08002905
2906 // Don't buffer stdout
2907 setvbuf(stdout, nullptr, _IONBF, 0);
2908
Rhed Jao5377d792020-07-16 17:37:39 +08002909 // Enable the parallel run if the client requests to output to a file.
2910 EnableParallelRunIfNeeded();
2911 // Using scope guard to make sure the dump pool can be shut down correctly.
2912 auto scope_guard_to_shutdown_pool = android::base::make_scope_guard([=]() {
2913 ShutdownDumpPool();
2914 });
2915
Felipe Leme608385d2016-02-01 10:35:38 -08002916 // NOTE: there should be no stdout output until now, otherwise it would break the header.
2917 // In particular, DurationReport objects should be created passing 'title, NULL', so their
Felipe Lemecbce55d2016-02-08 09:53:18 -08002918 // duration is logged into MYLOG instead.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002919 PrintHeader();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002920
Gavin Corkery6968f552020-11-22 18:09:05 +00002921 bool is_dumpstate_restricted = options_->telephony_only
2922 || options_->wifi_only
2923 || options_->limited_only;
2924 if (!is_dumpstate_restricted) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002925 // Invoke critical dumpsys first to preserve system state, before doing anything else.
Jichao Lie89d9c12019-11-21 19:02:51 -08002926 RunDumpsysCritical();
Gavin Corkery6968f552020-11-22 18:09:05 +00002927 }
2928 MaybeTakeEarlyScreenshot();
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00002929
2930 if (!is_dumpstate_restricted) {
2931 // Snapshot the system trace now (if running) to avoid that dumpstate's
2932 // own activity pushes out interesting data from the trace ring buffer.
2933 // The trace file is added to the zip by MaybeAddSystemTraceToZip().
2934 MaybeSnapshotSystemTrace();
Yohei Yukawa95305b32021-03-09 07:54:27 -08002935
2936 // If a winscope trace is running, snapshot it now. It will be pulled into bugreport later
2937 // from WMTRACE_DATA_DIR.
2938 MaybeSnapshotWinTrace();
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00002939 }
Gavin Corkery6968f552020-11-22 18:09:05 +00002940 onUiIntensiveBugreportDumpsFinished(calling_uid);
2941 MaybeCheckUserConsent(calling_uid, calling_package);
2942 if (options_->telephony_only) {
2943 DumpstateTelephonyOnly(calling_package);
2944 } else if (options_->wifi_only) {
2945 DumpstateWifiOnly();
2946 } else if (options_->limited_only) {
2947 DumpstateLimitedOnly();
2948 } else {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002949 // Dump state for the default case. This also drops root.
Jichao Lie89d9c12019-11-21 19:02:51 -08002950 RunStatus s = DumpstateDefaultAfterCritical();
Nandana Dutt5c390032019-03-12 10:52:56 +00002951 if (s != RunStatus::OK) {
Nandana Duttaac6f582019-07-26 14:32:47 +01002952 if (s == RunStatus::USER_CONSENT_DENIED) {
Nandana Dutt5c390032019-03-12 10:52:56 +00002953 HandleUserConsentDenied();
2954 }
2955 return s;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002956 }
Zhengyin Qian068ecc72016-08-10 16:48:14 -07002957 }
Felipe Leme71a74ac2016-03-17 15:43:25 -07002958
Felipe Leme55b42a62015-11-10 17:39:08 -08002959 /* close output if needed */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002960 TEMP_FAILURE_RETRY(dup2(dup_stdout_fd, fileno(stdout)));
Colin Crossf45fa6b2012-03-26 12:38:26 -07002961
Abhijeet Kaure370d682019-10-01 16:49:30 +01002962 // Zip the (now complete) .tmp file within the internal directory.
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002963 FinalizeFile();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002964
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002965 // Share the final file with the caller if the user has consented or Shell is the caller.
Nandana Duttd2f5f082019-01-18 17:13:52 +00002966 Dumpstate::RunStatus status = Dumpstate::RunStatus::OK;
Abhijeet Kaure370d682019-10-01 16:49:30 +01002967 if (CalledByApi()) {
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002968 status = CopyBugreportIfUserConsented(calling_uid);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002969 if (status != Dumpstate::RunStatus::OK &&
2970 status != Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2971 // Do an early return if there were errors. We make an exception for consent
2972 // timing out because it's possible the user got distracted. In this case the
2973 // bugreport is not shared but made available for manual retrieval.
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002974 MYLOGI("User denied consent. Returning\n");
Nandana Duttd2f5f082019-01-18 17:13:52 +00002975 return status;
2976 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002977 if (status == Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2978 MYLOGI(
2979 "Did not receive user consent yet."
2980 " Will not copy the bugreport artifacts to caller.\n");
Abhijeet Kaur57627412019-04-17 16:00:09 +01002981 const String16 incidentcompanion("incidentcompanion");
2982 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
2983 if (ics != nullptr) {
2984 MYLOGD("Canceling user consent request via incidentcompanion service\n");
2985 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
2986 consent_callback_.get());
2987 } else {
2988 MYLOGD("Unable to cancel user consent; incidentcompanion service unavailable\n");
2989 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002990 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00002991 }
2992
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002993 /* vibrate a few but shortly times to let user know it's finished */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002994 if (options_->do_vibrate) {
Takuya Ogawa47f644e2017-12-20 18:09:09 +09002995 for (int i = 0; i < 3; i++) {
2996 Vibrate(75);
2997 usleep((75 + 50) * 1000);
2998 }
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002999 }
3000
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003001 MYLOGD("Final progress: %d/%d (estimated %d)\n", progress_->Get(), progress_->GetMax(),
3002 progress_->GetInitialMax());
3003 progress_->Save();
3004 MYLOGI("done (id %d)\n", id_);
Colin Crossf45fa6b2012-03-26 12:38:26 -07003005
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003006 TEMP_FAILURE_RETRY(dup2(dup_stderr_fd, fileno(stderr)));
Felipe Leme107a05f2016-03-08 15:11:15 -08003007
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003008 if (control_socket_fd_ != -1) {
Felipe Lemee844a9d2016-09-21 15:01:39 -07003009 MYLOGD("Closing control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003010 close(control_socket_fd_);
Felipe Leme2628e9e2016-04-12 16:36:51 -07003011 }
3012
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003013 tombstone_data_.clear();
3014 anr_data_.clear();
Narayan Kamath6b9516c2017-10-27 11:15:51 +01003015
Nandana Duttd2f5f082019-01-18 17:13:52 +00003016 return (consent_callback_ != nullptr &&
3017 consent_callback_->getResult() == UserConsentResult::UNAVAILABLE)
3018 ? USER_CONSENT_TIMED_OUT
3019 : RunStatus::OK;
3020}
3021
Paul Chang0d2aad72020-02-13 20:04:03 +08003022void Dumpstate::MaybeTakeEarlyScreenshot() {
3023 if (!options_->do_screenshot || !do_early_screenshot_) {
3024 return;
3025 }
3026
3027 TakeScreenshot();
3028}
3029
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003030void Dumpstate::MaybeSnapshotSystemTrace() {
3031 // If a background system trace is happening and is marked as "suitable for
3032 // bugreport" (i.e. bugreport_score > 0 in the trace config), this command
3033 // will stop it and serialize into SYSTEM_TRACE_SNAPSHOT. In the (likely)
3034 // case that no trace is ongoing, this command is a no-op.
3035 // Note: this should not be enqueued as we need to freeze the trace before
3036 // dumpstate starts. Otherwise the trace ring buffers will contain mostly
3037 // the dumpstate's own activity which is irrelevant.
3038 int res = RunCommand(
3039 "SERIALIZE PERFETTO TRACE",
3040 {"perfetto", "--save-for-bugreport"},
3041 CommandOptions::WithTimeout(10)
3042 .DropRoot()
3043 .CloseAllFileDescriptorsOnExec()
3044 .Build());
3045 has_system_trace_ = res == 0;
3046 // MaybeAddSystemTraceToZip() will take care of copying the trace in the zip
3047 // file in the later stages.
3048}
3049
Yohei Yukawa95305b32021-03-09 07:54:27 -08003050void Dumpstate::MaybeSnapshotWinTrace() {
Yohei Yukawa02b1d2c2021-03-16 09:20:30 -07003051 // Currently WindowManagerService and InputMethodManagerSerivice support WinScope protocol.
3052 for (const auto& service : {"window", "input_method"}) {
3053 RunCommand(
3054 // Empty name because it's not intended to be classified as a bugreport section.
3055 // Actual tracing files can be found in "/data/misc/wmtrace/" in the bugreport.
3056 "", {"cmd", service, "tracing", "save-for-bugreport"},
3057 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3058 }
Yohei Yukawa95305b32021-03-09 07:54:27 -08003059}
3060
Paul Changeb4b4642020-05-28 22:05:47 +08003061void Dumpstate::onUiIntensiveBugreportDumpsFinished(int32_t calling_uid) {
Paul Changc490e662020-04-11 18:14:09 +08003062 if (calling_uid == AID_SHELL || !CalledByApi()) {
3063 return;
3064 }
3065 if (listener_ != nullptr) {
3066 // Let listener know ui intensive bugreport dumps are finished, then it can do event
3067 // handling if required.
Paul Changeb4b4642020-05-28 22:05:47 +08003068 listener_->onUiIntensiveBugreportDumpsFinished();
Paul Changc490e662020-04-11 18:14:09 +08003069 }
3070}
3071
Jichao Lie89d9c12019-11-21 19:02:51 -08003072void Dumpstate::MaybeCheckUserConsent(int32_t calling_uid, const std::string& calling_package) {
3073 if (calling_uid == AID_SHELL || !CalledByApi()) {
3074 // No need to get consent for shell triggered dumpstates, or not through
3075 // bugreporting API (i.e. no fd to copy back).
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003076 return;
3077 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003078 consent_callback_ = new ConsentCallback();
3079 const String16 incidentcompanion("incidentcompanion");
3080 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
Jichao Lie89d9c12019-11-21 19:02:51 -08003081 android::String16 package(calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003082 if (ics != nullptr) {
3083 MYLOGD("Checking user consent via incidentcompanion service\n");
3084 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
Jichao Lie89d9c12019-11-21 19:02:51 -08003085 calling_uid, package, String16(), String16(),
Joe Onorato1c36d752019-03-17 18:26:43 -07003086 0x1 /* FLAG_CONFIRMATION_DIALOG */, consent_callback_.get());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003087 } else {
3088 MYLOGD("Unable to check user consent; incidentcompanion service unavailable\n");
3089 }
3090}
3091
Nandana Dutt5c390032019-03-12 10:52:56 +00003092bool Dumpstate::IsUserConsentDenied() const {
3093 return ds.consent_callback_ != nullptr &&
3094 ds.consent_callback_->getResult() == UserConsentResult::DENIED;
3095}
3096
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01003097bool Dumpstate::CalledByApi() const {
3098 return ds.options_->bugreport_fd.get() != -1 ? true : false;
3099}
3100
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003101void Dumpstate::CleanupTmpFiles() {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003102 android::os::UnlinkAndLogOnError(tmp_path_);
3103 android::os::UnlinkAndLogOnError(screenshot_path_);
3104 android::os::UnlinkAndLogOnError(path_);
Gavin Corkery789d7a52021-02-24 23:52:35 +00003105 if (dump_traces_path != nullptr) {
3106 android::os::UnlinkAndLogOnError(dump_traces_path);
3107 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003108}
3109
Rhed Jao5377d792020-07-16 17:37:39 +08003110void Dumpstate::EnableParallelRunIfNeeded() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003111 if (!PropertiesHelper::IsParallelRun()) {
Rhed Jao5377d792020-07-16 17:37:39 +08003112 return;
3113 }
3114 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003115 zip_entry_tasks_ = std::make_unique<TaskQueue>();
Rhed Jao5377d792020-07-16 17:37:39 +08003116}
3117
3118void Dumpstate::ShutdownDumpPool() {
3119 if (dump_pool_) {
3120 dump_pool_->shutdown();
3121 dump_pool_ = nullptr;
3122 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003123 if (zip_entry_tasks_) {
3124 zip_entry_tasks_->run(/* do_cancel = */true);
3125 zip_entry_tasks_ = nullptr;
3126 }
3127}
3128
3129void Dumpstate::EnqueueAddZipEntryAndCleanupIfNeeded(const std::string& entry_name,
3130 const std::string& entry_path) {
3131 auto func_add_zip_entry_and_cleanup = [=](bool task_cancelled) {
3132 if (!task_cancelled) {
3133 AddZipEntry(entry_name, entry_path);
3134 }
3135 android::os::UnlinkAndLogOnError(entry_path);
3136 };
3137 if (zip_entry_tasks_) {
3138 // Enqueues AddZipEntryAndCleanup function if the parallel run is enabled.
3139 zip_entry_tasks_->add(func_add_zip_entry_and_cleanup, _1);
3140 } else {
3141 // Invokes AddZipEntryAndCleanup immediately
3142 std::invoke(func_add_zip_entry_and_cleanup, /* task_cancelled = */false);
3143 }
Rhed Jao5377d792020-07-16 17:37:39 +08003144}
3145
Nandana Duttd2f5f082019-01-18 17:13:52 +00003146Dumpstate::RunStatus Dumpstate::HandleUserConsentDenied() {
3147 MYLOGD("User denied consent; deleting files and returning\n");
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003148 CleanupTmpFiles();
Nandana Duttd2f5f082019-01-18 17:13:52 +00003149 return USER_CONSENT_DENIED;
3150}
3151
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003152Dumpstate::RunStatus Dumpstate::CopyBugreportIfUserConsented(int32_t calling_uid) {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003153 // If the caller has asked to copy the bugreport over to their directory, we need explicit
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003154 // user consent (unless the caller is Shell).
3155 UserConsentResult consent_result;
3156 if (calling_uid == AID_SHELL) {
3157 consent_result = UserConsentResult::APPROVED;
3158 } else {
3159 consent_result = consent_callback_->getResult();
3160 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003161 if (consent_result == UserConsentResult::UNAVAILABLE) {
3162 // User has not responded yet.
3163 uint64_t elapsed_ms = consent_callback_->getElapsedTimeMs();
Hunter Knepshield70610fa2020-01-03 15:27:33 -08003164 // Telephony is a fast report type, particularly on user builds where information may be
3165 // more aggressively limited. To give the user time to read the consent dialog, increase the
3166 // timeout.
3167 uint64_t timeout_ms = options_->telephony_only ? TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS
3168 : USER_CONSENT_TIMEOUT_MS;
3169 if (elapsed_ms < timeout_ms) {
3170 uint delay_seconds = (timeout_ms - elapsed_ms) / 1000;
Nandana Duttd2f5f082019-01-18 17:13:52 +00003171 MYLOGD("Did not receive user consent yet; going to wait for %d seconds", delay_seconds);
3172 sleep(delay_seconds);
3173 }
3174 consent_result = consent_callback_->getResult();
3175 }
3176 if (consent_result == UserConsentResult::DENIED) {
3177 // User has explicitly denied sharing with the app. To be safe delete the
3178 // internal bugreport & tmp files.
3179 return HandleUserConsentDenied();
3180 }
3181 if (consent_result == UserConsentResult::APPROVED) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00003182 bool copy_succeeded = android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
3183 if (copy_succeeded) {
3184 android::os::UnlinkAndLogOnError(path_);
Abhijeet Kaur9ce94672020-04-01 17:22:36 +01003185 if (options_->do_screenshot &&
3186 options_->screenshot_fd.get() != -1 &&
3187 !options_->is_screenshot_copied) {
3188 copy_succeeded = android::os::CopyFileToFd(screenshot_path_,
3189 options_->screenshot_fd.get());
3190 options_->is_screenshot_copied = copy_succeeded;
3191 if (copy_succeeded) {
3192 android::os::UnlinkAndLogOnError(screenshot_path_);
3193 }
3194 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003195 }
3196 return copy_succeeded ? Dumpstate::RunStatus::OK : Dumpstate::RunStatus::ERROR;
3197 } else if (consent_result == UserConsentResult::UNAVAILABLE) {
3198 // consent_result is still UNAVAILABLE. The user has likely not responded yet.
3199 // Since we do not have user consent to share the bugreport it does not get
3200 // copied over to the calling app but remains in the internal directory from
3201 // where the user can manually pull it.
Paul Changce644212021-05-11 16:06:45 +08003202 std::string final_path = GetPath(".zip");
3203 bool copy_succeeded = android::os::CopyFileToFile(path_, final_path);
3204 if (copy_succeeded) {
3205 android::os::UnlinkAndLogOnError(path_);
3206 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003207 return Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT;
3208 }
3209 // Unknown result; must be a programming error.
3210 MYLOGE("Unknown user consent result:%d\n", consent_result);
3211 return Dumpstate::RunStatus::ERROR;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003212}
3213
Nandana Duttf02564e2019-02-15 15:24:24 +00003214Dumpstate::RunStatus Dumpstate::ParseCommandlineAndRun(int argc, char* argv[]) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003215 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
3216 Dumpstate::RunStatus status = options->Initialize(argc, argv);
3217 if (status == Dumpstate::RunStatus::OK) {
Nandana Duttf02564e2019-02-15 15:24:24 +00003218 SetOptions(std::move(options));
Nandana Duttd2f5f082019-01-18 17:13:52 +00003219 // When directly running dumpstate binary, the output is not expected to be written
3220 // to any external file descriptor.
Nandana Duttf02564e2019-02-15 15:24:24 +00003221 assert(options_->bugreport_fd.get() == -1);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003222
3223 // calling_uid and calling_package are for user consent to share the bugreport with
Abhijeet Kaura407fb82020-03-27 12:51:12 +00003224 // an app; they are irrelevant here because bugreport is triggered via command line.
3225 // Update Last ID before calling Run().
3226 Initialize();
Nandana Duttf02564e2019-02-15 15:24:24 +00003227 status = Run(-1 /* calling_uid */, "" /* calling_package */);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003228 }
Nandana Duttf02564e2019-02-15 15:24:24 +00003229 return status;
3230}
3231
3232/* Main entry point for dumpstate binary. */
3233int run_main(int argc, char* argv[]) {
3234 Dumpstate::RunStatus status = ds.ParseCommandlineAndRun(argc, argv);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003235
3236 switch (status) {
3237 case Dumpstate::RunStatus::OK:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003238 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003239 case Dumpstate::RunStatus::HELP:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003240 ShowUsage();
3241 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003242 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003243 fprintf(stderr, "Invalid combination of args\n");
3244 ShowUsage();
3245 exit(1);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003246 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00003247 FALLTHROUGH_INTENDED;
3248 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
3249 FALLTHROUGH_INTENDED;
3250 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003251 exit(2);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003252 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003253}
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003254
3255// TODO(111441001): Default DumpOptions to sensible values.
3256Dumpstate::Dumpstate(const std::string& version)
3257 : pid_(getpid()),
3258 options_(new Dumpstate::DumpOptions()),
Nandana Dutt402a8392019-06-14 14:25:13 +01003259 last_reported_percent_progress_(0),
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003260 version_(version),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003261 now_(time(nullptr)),
3262 open_socket_fn_(open_socket) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003263}
3264
3265Dumpstate& Dumpstate::GetInstance() {
3266 static Dumpstate singleton_(android::base::GetProperty("dumpstate.version", VERSION_CURRENT));
3267 return singleton_;
3268}
3269
Rhed Jao5377d792020-07-16 17:37:39 +08003270DurationReporter::DurationReporter(const std::string& title, bool logcat_only, bool verbose,
3271 int duration_fd) : title_(title), logcat_only_(logcat_only), verbose_(verbose),
3272 duration_fd_(duration_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003273 if (!title_.empty()) {
3274 started_ = Nanotime();
3275 }
3276}
3277
3278DurationReporter::~DurationReporter() {
3279 if (!title_.empty()) {
3280 float elapsed = (float)(Nanotime() - started_) / NANOS_PER_SEC;
chenqiwuaf8b2d92019-12-12 18:53:51 +08003281 if (elapsed >= .5f || verbose_) {
3282 MYLOGD("Duration of '%s': %.2fs\n", title_.c_str(), elapsed);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003283 }
chenqiwuaf8b2d92019-12-12 18:53:51 +08003284 if (!logcat_only_) {
3285 // Use "Yoda grammar" to make it easier to grep|sort sections.
Rhed Jao5377d792020-07-16 17:37:39 +08003286 dprintf(duration_fd_, "------ %.3fs was the duration of '%s' ------\n",
3287 elapsed, title_.c_str());
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003288 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003289 }
3290}
3291
3292const int32_t Progress::kDefaultMax = 5000;
3293
3294Progress::Progress(const std::string& path) : Progress(Progress::kDefaultMax, 1.1, path) {
3295}
3296
3297Progress::Progress(int32_t initial_max, int32_t progress, float growth_factor)
3298 : Progress(initial_max, growth_factor, "") {
3299 progress_ = progress;
3300}
3301
3302Progress::Progress(int32_t initial_max, float growth_factor, const std::string& path)
3303 : initial_max_(initial_max),
3304 progress_(0),
3305 max_(initial_max),
3306 growth_factor_(growth_factor),
3307 n_runs_(0),
3308 average_max_(0),
3309 path_(path) {
3310 if (!path_.empty()) {
3311 Load();
3312 }
3313}
3314
3315void Progress::Load() {
3316 MYLOGD("Loading stats from %s\n", path_.c_str());
3317 std::string content;
3318 if (!android::base::ReadFileToString(path_, &content)) {
3319 MYLOGI("Could not read stats from %s; using max of %d\n", path_.c_str(), max_);
3320 return;
3321 }
3322 if (content.empty()) {
3323 MYLOGE("No stats (empty file) on %s; using max of %d\n", path_.c_str(), max_);
3324 return;
3325 }
3326 std::vector<std::string> lines = android::base::Split(content, "\n");
3327
3328 if (lines.size() < 1) {
3329 MYLOGE("Invalid stats on file %s: not enough lines (%d). Using max of %d\n", path_.c_str(),
3330 (int)lines.size(), max_);
3331 return;
3332 }
3333 char* ptr;
3334 n_runs_ = strtol(lines[0].c_str(), &ptr, 10);
3335 average_max_ = strtol(ptr, nullptr, 10);
3336 if (n_runs_ <= 0 || average_max_ <= 0 || n_runs_ > STATS_MAX_N_RUNS ||
3337 average_max_ > STATS_MAX_AVERAGE) {
3338 MYLOGE("Invalid stats line on file %s: %s\n", path_.c_str(), lines[0].c_str());
3339 initial_max_ = Progress::kDefaultMax;
3340 } else {
3341 initial_max_ = average_max_;
3342 }
3343 max_ = initial_max_;
3344
3345 MYLOGI("Average max progress: %d in %d runs; estimated max: %d\n", average_max_, n_runs_, max_);
3346}
3347
3348void Progress::Save() {
3349 int32_t total = n_runs_ * average_max_ + progress_;
3350 int32_t runs = n_runs_ + 1;
3351 int32_t average = floor(((float)total) / runs);
3352 MYLOGI("Saving stats (total=%d, runs=%d, average=%d) on %s\n", total, runs, average,
3353 path_.c_str());
3354 if (path_.empty()) {
3355 return;
3356 }
3357
3358 std::string content = android::base::StringPrintf("%d %d\n", runs, average);
3359 if (!android::base::WriteStringToFile(content, path_)) {
3360 MYLOGE("Could not save stats on %s\n", path_.c_str());
3361 }
3362}
3363
3364int32_t Progress::Get() const {
3365 return progress_;
3366}
3367
3368bool Progress::Inc(int32_t delta_sec) {
3369 bool changed = false;
3370 if (delta_sec >= 0) {
3371 progress_ += delta_sec;
3372 if (progress_ > max_) {
3373 int32_t old_max = max_;
3374 max_ = floor((float)progress_ * growth_factor_);
3375 MYLOGD("Adjusting max progress from %d to %d\n", old_max, max_);
3376 changed = true;
3377 }
3378 }
3379 return changed;
3380}
3381
3382int32_t Progress::GetMax() const {
3383 return max_;
3384}
3385
3386int32_t Progress::GetInitialMax() const {
3387 return initial_max_;
3388}
3389
3390void Progress::Dump(int fd, const std::string& prefix) const {
3391 const char* pr = prefix.c_str();
3392 dprintf(fd, "%sprogress: %d\n", pr, progress_);
3393 dprintf(fd, "%smax: %d\n", pr, max_);
3394 dprintf(fd, "%sinitial_max: %d\n", pr, initial_max_);
3395 dprintf(fd, "%sgrowth_factor: %0.2f\n", pr, growth_factor_);
3396 dprintf(fd, "%spath: %s\n", pr, path_.c_str());
3397 dprintf(fd, "%sn_runs: %d\n", pr, n_runs_);
3398 dprintf(fd, "%saverage_max: %d\n", pr, average_max_);
3399}
3400
3401bool Dumpstate::IsZipping() const {
3402 return zip_writer_ != nullptr;
3403}
3404
3405std::string Dumpstate::GetPath(const std::string& suffix) const {
3406 return GetPath(bugreport_internal_dir_, suffix);
3407}
3408
3409std::string Dumpstate::GetPath(const std::string& directory, const std::string& suffix) const {
3410 return android::base::StringPrintf("%s/%s-%s%s", directory.c_str(), base_name_.c_str(),
3411 name_.c_str(), suffix.c_str());
3412}
3413
3414void Dumpstate::SetProgress(std::unique_ptr<Progress> progress) {
3415 progress_ = std::move(progress);
3416}
3417
3418void for_each_userid(void (*func)(int), const char *header) {
3419 std::string title = header == nullptr ? "for_each_userid" : android::base::StringPrintf(
3420 "for_each_userid(%s)", header);
3421 DurationReporter duration_reporter(title);
3422 if (PropertiesHelper::IsDryRun()) return;
3423
3424 DIR *d;
3425 struct dirent *de;
3426
3427 if (header) printf("\n------ %s ------\n", header);
3428 func(0);
3429
3430 if (!(d = opendir("/data/system/users"))) {
3431 printf("Failed to open /data/system/users (%s)\n", strerror(errno));
3432 return;
3433 }
3434
3435 while ((de = readdir(d))) {
3436 int userid;
3437 if (de->d_type != DT_DIR || !(userid = atoi(de->d_name))) {
3438 continue;
3439 }
3440 func(userid);
3441 }
3442
3443 closedir(d);
3444}
3445
3446static void __for_each_pid(void (*helper)(int, const char *, void *), const char *header, void *arg) {
3447 DIR *d;
3448 struct dirent *de;
3449
3450 if (!(d = opendir("/proc"))) {
3451 printf("Failed to open /proc (%s)\n", strerror(errno));
3452 return;
3453 }
3454
3455 if (header) printf("\n------ %s ------\n", header);
3456 while ((de = readdir(d))) {
3457 if (ds.IsUserConsentDenied()) {
3458 MYLOGE(
3459 "Returning early because user denied consent to share bugreport with calling app.");
3460 closedir(d);
3461 return;
3462 }
3463 int pid;
3464 int fd;
3465 char cmdpath[255];
3466 char cmdline[255];
3467
3468 if (!(pid = atoi(de->d_name))) {
3469 continue;
3470 }
3471
3472 memset(cmdline, 0, sizeof(cmdline));
3473
3474 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/cmdline", pid);
3475 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3476 TEMP_FAILURE_RETRY(read(fd, cmdline, sizeof(cmdline) - 2));
3477 close(fd);
3478 if (cmdline[0]) {
3479 helper(pid, cmdline, arg);
3480 continue;
3481 }
3482 }
3483
3484 // if no cmdline, a kernel thread has comm
3485 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/comm", pid);
3486 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3487 TEMP_FAILURE_RETRY(read(fd, cmdline + 1, sizeof(cmdline) - 4));
3488 close(fd);
3489 if (cmdline[1]) {
3490 cmdline[0] = '[';
3491 size_t len = strcspn(cmdline, "\f\b\r\n");
3492 cmdline[len] = ']';
3493 cmdline[len+1] = '\0';
3494 }
3495 }
3496 if (!cmdline[0]) {
3497 strcpy(cmdline, "N/A");
3498 }
3499 helper(pid, cmdline, arg);
3500 }
3501
3502 closedir(d);
3503}
3504
3505static void for_each_pid_helper(int pid, const char *cmdline, void *arg) {
3506 for_each_pid_func *func = (for_each_pid_func*) arg;
3507 func(pid, cmdline);
3508}
3509
3510void for_each_pid(for_each_pid_func func, const char *header) {
3511 std::string title = header == nullptr ? "for_each_pid"
3512 : android::base::StringPrintf("for_each_pid(%s)", header);
3513 DurationReporter duration_reporter(title);
3514 if (PropertiesHelper::IsDryRun()) return;
3515
3516 __for_each_pid(for_each_pid_helper, header, (void *) func);
3517}
3518
3519static void for_each_tid_helper(int pid, const char *cmdline, void *arg) {
3520 DIR *d;
3521 struct dirent *de;
3522 char taskpath[255];
3523 for_each_tid_func *func = (for_each_tid_func *) arg;
3524
3525 snprintf(taskpath, sizeof(taskpath), "/proc/%d/task", pid);
3526
3527 if (!(d = opendir(taskpath))) {
3528 printf("Failed to open %s (%s)\n", taskpath, strerror(errno));
3529 return;
3530 }
3531
3532 func(pid, pid, cmdline);
3533
3534 while ((de = readdir(d))) {
3535 if (ds.IsUserConsentDenied()) {
3536 MYLOGE(
3537 "Returning early because user denied consent to share bugreport with calling app.");
3538 closedir(d);
3539 return;
3540 }
3541 int tid;
3542 int fd;
3543 char commpath[255];
3544 char comm[255];
3545
3546 if (!(tid = atoi(de->d_name))) {
3547 continue;
3548 }
3549
3550 if (tid == pid)
3551 continue;
3552
3553 snprintf(commpath, sizeof(commpath), "/proc/%d/comm", tid);
3554 memset(comm, 0, sizeof(comm));
3555 if ((fd = TEMP_FAILURE_RETRY(open(commpath, O_RDONLY | O_CLOEXEC))) < 0) {
3556 strcpy(comm, "N/A");
3557 } else {
3558 char *c;
3559 TEMP_FAILURE_RETRY(read(fd, comm, sizeof(comm) - 2));
3560 close(fd);
3561
3562 c = strrchr(comm, '\n');
3563 if (c) {
3564 *c = '\0';
3565 }
3566 }
3567 func(pid, tid, comm);
3568 }
3569
3570 closedir(d);
3571}
3572
3573void for_each_tid(for_each_tid_func func, const char *header) {
3574 std::string title = header == nullptr ? "for_each_tid"
3575 : android::base::StringPrintf("for_each_tid(%s)", header);
3576 DurationReporter duration_reporter(title);
3577
3578 if (PropertiesHelper::IsDryRun()) return;
3579
3580 __for_each_pid(for_each_tid_helper, header, (void *) func);
3581}
3582
3583void show_wchan(int pid, int tid, const char *name) {
3584 if (PropertiesHelper::IsDryRun()) return;
3585
3586 char path[255];
3587 char buffer[255];
3588 int fd, ret, save_errno;
3589 char name_buffer[255];
3590
3591 memset(buffer, 0, sizeof(buffer));
3592
3593 snprintf(path, sizeof(path), "/proc/%d/wchan", tid);
3594 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3595 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3596 return;
3597 }
3598
3599 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3600 save_errno = errno;
3601 close(fd);
3602
3603 if (ret < 0) {
3604 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3605 return;
3606 }
3607
3608 snprintf(name_buffer, sizeof(name_buffer), "%*s%s",
3609 pid == tid ? 0 : 3, "", name);
3610
3611 printf("%-7d %-32s %s\n", tid, name_buffer, buffer);
3612
3613 return;
3614}
3615
3616// print time in centiseconds
3617static void snprcent(char *buffer, size_t len, size_t spc,
3618 unsigned long long time) {
3619 static long hz; // cache discovered hz
3620
3621 if (hz <= 0) {
3622 hz = sysconf(_SC_CLK_TCK);
3623 if (hz <= 0) {
3624 hz = 1000;
3625 }
3626 }
3627
3628 // convert to centiseconds
3629 time = (time * 100 + (hz / 2)) / hz;
3630
3631 char str[16];
3632
3633 snprintf(str, sizeof(str), " %llu.%02u",
3634 time / 100, (unsigned)(time % 100));
3635 size_t offset = strlen(buffer);
3636 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3637 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3638}
3639
3640// print permille as a percent
3641static void snprdec(char *buffer, size_t len, size_t spc, unsigned permille) {
3642 char str[16];
3643
3644 snprintf(str, sizeof(str), " %u.%u%%", permille / 10, permille % 10);
3645 size_t offset = strlen(buffer);
3646 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3647 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3648}
3649
3650void show_showtime(int pid, const char *name) {
3651 if (PropertiesHelper::IsDryRun()) return;
3652
3653 char path[255];
3654 char buffer[1023];
3655 int fd, ret, save_errno;
3656
3657 memset(buffer, 0, sizeof(buffer));
3658
3659 snprintf(path, sizeof(path), "/proc/%d/stat", pid);
3660 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3661 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3662 return;
3663 }
3664
3665 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3666 save_errno = errno;
3667 close(fd);
3668
3669 if (ret < 0) {
3670 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3671 return;
3672 }
3673
3674 // field 14 is utime
3675 // field 15 is stime
3676 // field 42 is iotime
3677 unsigned long long utime = 0, stime = 0, iotime = 0;
3678 if (sscanf(buffer,
3679 "%*u %*s %*s %*d %*d %*d %*d %*d %*d %*d %*d "
3680 "%*d %*d %llu %llu %*d %*d %*d %*d %*d %*d "
3681 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %*d "
3682 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %llu ",
3683 &utime, &stime, &iotime) != 3) {
3684 return;
3685 }
3686
3687 unsigned long long total = utime + stime;
3688 if (!total) {
3689 return;
3690 }
3691
3692 unsigned permille = (iotime * 1000 + (total / 2)) / total;
3693 if (permille > 1000) {
3694 permille = 1000;
3695 }
3696
3697 // try to beautify and stabilize columns at <80 characters
3698 snprintf(buffer, sizeof(buffer), "%-6d%s", pid, name);
3699 if ((name[0] != '[') || utime) {
3700 snprcent(buffer, sizeof(buffer), 57, utime);
3701 }
3702 snprcent(buffer, sizeof(buffer), 65, stime);
3703 if ((name[0] != '[') || iotime) {
3704 snprcent(buffer, sizeof(buffer), 73, iotime);
3705 }
3706 if (iotime) {
3707 snprdec(buffer, sizeof(buffer), 79, permille);
3708 }
3709 puts(buffer); // adds a trailing newline
3710
3711 return;
3712}
3713
3714void do_dmesg() {
3715 const char *title = "KERNEL LOG (dmesg)";
3716 DurationReporter duration_reporter(title);
3717 printf("------ %s ------\n", title);
3718
3719 if (PropertiesHelper::IsDryRun()) return;
3720
3721 /* Get size of kernel buffer */
3722 int size = klogctl(KLOG_SIZE_BUFFER, nullptr, 0);
3723 if (size <= 0) {
3724 printf("Unexpected klogctl return value: %d\n\n", size);
3725 return;
3726 }
3727 char *buf = (char *) malloc(size + 1);
3728 if (buf == nullptr) {
3729 printf("memory allocation failed\n\n");
3730 return;
3731 }
3732 int retval = klogctl(KLOG_READ_ALL, buf, size);
3733 if (retval < 0) {
3734 printf("klogctl failure\n\n");
3735 free(buf);
3736 return;
3737 }
3738 buf[retval] = '\0';
3739 printf("%s\n\n", buf);
3740 free(buf);
3741 return;
3742}
3743
3744void do_showmap(int pid, const char *name) {
3745 char title[255];
3746 char arg[255];
3747
3748 snprintf(title, sizeof(title), "SHOW MAP %d (%s)", pid, name);
3749 snprintf(arg, sizeof(arg), "%d", pid);
3750 RunCommand(title, {"showmap", "-q", arg}, CommandOptions::AS_ROOT);
3751}
3752
3753int Dumpstate::DumpFile(const std::string& title, const std::string& path) {
3754 DurationReporter duration_reporter(title);
3755
3756 int status = DumpFileToFd(STDOUT_FILENO, title, path);
3757
3758 UpdateProgress(WEIGHT_FILE);
3759
3760 return status;
3761}
3762
3763int read_file_as_long(const char *path, long int *output) {
3764 int fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC));
3765 if (fd < 0) {
3766 int err = errno;
3767 MYLOGE("Error opening file descriptor for %s: %s\n", path, strerror(err));
3768 return -1;
3769 }
3770 char buffer[50];
3771 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3772 if (bytes_read == -1) {
3773 MYLOGE("Error reading file %s: %s\n", path, strerror(errno));
3774 return -2;
3775 }
3776 if (bytes_read == 0) {
3777 MYLOGE("File %s is empty\n", path);
3778 return -3;
3779 }
3780 *output = atoi(buffer);
3781 return 0;
3782}
3783
3784/* calls skip to gate calling dump_from_fd recursively
3785 * in the specified directory. dump_from_fd defaults to
3786 * dump_file_from_fd above when set to NULL. skip defaults
3787 * to false when set to NULL. dump_from_fd will always be
3788 * called with title NULL.
3789 */
3790int dump_files(const std::string& title, const char* dir, bool (*skip)(const char* path),
3791 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
3792 DurationReporter duration_reporter(title);
3793 DIR *dirp;
3794 struct dirent *d;
3795 char *newpath = nullptr;
3796 const char *slash = "/";
3797 int retval = 0;
3798
3799 if (!title.empty()) {
3800 printf("------ %s (%s) ------\n", title.c_str(), dir);
3801 }
3802 if (PropertiesHelper::IsDryRun()) return 0;
3803
3804 if (dir[strlen(dir) - 1] == '/') {
3805 ++slash;
3806 }
3807 dirp = opendir(dir);
3808 if (dirp == nullptr) {
3809 retval = -errno;
3810 MYLOGE("%s: %s\n", dir, strerror(errno));
3811 return retval;
3812 }
3813
3814 if (!dump_from_fd) {
3815 dump_from_fd = dump_file_from_fd;
3816 }
3817 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
3818 if ((d->d_name[0] == '.')
3819 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
3820 || (d->d_name[1] == '\0'))) {
3821 continue;
3822 }
3823 asprintf(&newpath, "%s%s%s%s", dir, slash, d->d_name,
3824 (d->d_type == DT_DIR) ? "/" : "");
3825 if (!newpath) {
3826 retval = -errno;
3827 continue;
3828 }
3829 if (skip && (*skip)(newpath)) {
3830 continue;
3831 }
3832 if (d->d_type == DT_DIR) {
3833 int ret = dump_files("", newpath, skip, dump_from_fd);
3834 if (ret < 0) {
3835 retval = ret;
3836 }
3837 continue;
3838 }
3839 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(newpath, O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
3840 if (fd.get() < 0) {
3841 retval = -1;
3842 printf("*** %s: %s\n", newpath, strerror(errno));
3843 continue;
3844 }
3845 (*dump_from_fd)(nullptr, newpath, fd.get());
3846 }
3847 closedir(dirp);
3848 if (!title.empty()) {
3849 printf("\n");
3850 }
3851 return retval;
3852}
3853
3854/* fd must have been opened with the flag O_NONBLOCK. With this flag set,
3855 * it's possible to avoid issues where opening the file itself can get
3856 * stuck.
3857 */
3858int dump_file_from_fd(const char *title, const char *path, int fd) {
3859 if (PropertiesHelper::IsDryRun()) return 0;
3860
3861 int flags = fcntl(fd, F_GETFL);
3862 if (flags == -1) {
3863 printf("*** %s: failed to get flags on fd %d: %s\n", path, fd, strerror(errno));
3864 return -1;
3865 } else if (!(flags & O_NONBLOCK)) {
3866 printf("*** %s: fd must have O_NONBLOCK set.\n", path);
3867 return -1;
3868 }
3869 return DumpFileFromFdToFd(title, path, fd, STDOUT_FILENO, PropertiesHelper::IsDryRun());
3870}
3871
3872int Dumpstate::RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003873 const CommandOptions& options, bool verbose_duration, int out_fd) {
3874 DurationReporter duration_reporter(title, false /* logcat_only */,
3875 verbose_duration, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003876
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003877 int status = RunCommandToFd(out_fd, title, full_command, options);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003878
3879 /* TODO: for now we're simplifying the progress calculation by using the
3880 * timeout as the weight. It's a good approximation for most cases, except when calling dumpsys,
3881 * where its weight should be much higher proportionally to its timeout.
3882 * Ideally, it should use a options.EstimatedDuration() instead...*/
3883 UpdateProgress(options.Timeout());
3884
3885 return status;
3886}
3887
3888void Dumpstate::RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsys_args,
Rhed Jaoe017f982020-07-21 17:58:41 +08003889 const CommandOptions& options, long dumpsysTimeoutMs, int out_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003890 long timeout_ms = dumpsysTimeoutMs > 0 ? dumpsysTimeoutMs : options.TimeoutInMs();
3891 std::vector<std::string> dumpsys = {"/system/bin/dumpsys", "-T", std::to_string(timeout_ms)};
3892 dumpsys.insert(dumpsys.end(), dumpsys_args.begin(), dumpsys_args.end());
Rhed Jaoe017f982020-07-21 17:58:41 +08003893 RunCommand(title, dumpsys, options, false, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003894}
3895
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003896static int open_socket(const char* service) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003897 int s = android_get_control_socket(service);
3898 if (s < 0) {
3899 MYLOGE("android_get_control_socket(%s): %s\n", service, strerror(errno));
3900 return -1;
3901 }
3902 fcntl(s, F_SETFD, FD_CLOEXEC);
3903
3904 // Set backlog to 0 to make sure that queue size will be minimum.
3905 // In Linux, because the minimum queue will be 1, connect() will be blocked
3906 // if the other clients already called connect() and the connection request was not accepted.
3907 if (listen(s, 0) < 0) {
3908 MYLOGE("listen(control socket): %s\n", strerror(errno));
3909 return -1;
3910 }
3911
3912 struct sockaddr addr;
3913 socklen_t alen = sizeof(addr);
Abhijeet Kaur2113cae2019-09-13 09:24:15 +01003914 int fd = accept4(s, &addr, &alen, SOCK_CLOEXEC);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003915
3916 // Close socket just after accept(), to make sure that connect() by client will get error
3917 // when the socket is used by the other services.
3918 // There is still a race condition possibility between accept and close, but there is no way
3919 // to close-on-accept atomically.
3920 // See detail; b/123306389#comment25
3921 close(s);
3922
3923 if (fd < 0) {
3924 MYLOGE("accept(control socket): %s\n", strerror(errno));
3925 return -1;
3926 }
3927
3928 return fd;
3929}
3930
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003931// TODO: should call is_valid_output_file and/or be merged into it.
3932void create_parent_dirs(const char *path) {
3933 char *chp = const_cast<char *> (path);
3934
3935 /* skip initial slash */
3936 if (chp[0] == '/')
3937 chp++;
3938
3939 /* create leading directories, if necessary */
3940 struct stat dir_stat;
3941 while (chp && chp[0]) {
3942 chp = strchr(chp, '/');
3943 if (chp) {
3944 *chp = 0;
3945 if (stat(path, &dir_stat) == -1 || !S_ISDIR(dir_stat.st_mode)) {
3946 MYLOGI("Creating directory %s\n", path);
3947 if (mkdir(path, 0770)) { /* drwxrwx--- */
3948 MYLOGE("Unable to create directory %s: %s\n", path, strerror(errno));
3949 } else if (chown(path, AID_SHELL, AID_SHELL)) {
3950 MYLOGE("Unable to change ownership of dir %s: %s\n", path, strerror(errno));
3951 }
3952 }
3953 *chp++ = '/';
3954 }
3955 }
3956}
3957
3958bool _redirect_to_file(FILE* redirect, char* path, int truncate_flag) {
3959 create_parent_dirs(path);
3960
3961 int fd = TEMP_FAILURE_RETRY(open(path,
3962 O_WRONLY | O_CREAT | truncate_flag | O_CLOEXEC | O_NOFOLLOW,
3963 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH));
3964 if (fd < 0) {
3965 MYLOGE("%s: %s\n", path, strerror(errno));
3966 return false;
3967 }
3968
3969 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
3970 close(fd);
3971 return true;
3972}
3973
3974bool redirect_to_file(FILE* redirect, char* path) {
3975 return _redirect_to_file(redirect, path, O_TRUNC);
3976}
3977
3978bool redirect_to_existing_file(FILE* redirect, char* path) {
3979 return _redirect_to_file(redirect, path, O_APPEND);
3980}
3981
3982void dump_route_tables() {
3983 DurationReporter duration_reporter("DUMP ROUTE TABLES");
3984 if (PropertiesHelper::IsDryRun()) return;
3985 const char* const RT_TABLES_PATH = "/data/misc/net/rt_tables";
3986 ds.DumpFile("RT_TABLES", RT_TABLES_PATH);
3987 FILE* fp = fopen(RT_TABLES_PATH, "re");
3988 if (!fp) {
3989 printf("*** %s: %s\n", RT_TABLES_PATH, strerror(errno));
3990 return;
3991 }
3992 char table[16];
3993 // Each line has an integer (the table number), a space, and a string (the table name). We only
3994 // need the table number. It's a 32-bit unsigned number, so max 10 chars. Skip the table name.
3995 // Add a fixed max limit so this doesn't go awry.
3996 for (int i = 0; i < 64 && fscanf(fp, " %10s %*s", table) == 1; ++i) {
3997 RunCommand("ROUTE TABLE IPv4", {"ip", "-4", "route", "show", "table", table});
3998 RunCommand("ROUTE TABLE IPv6", {"ip", "-6", "route", "show", "table", table});
3999 }
4000 fclose(fp);
4001}
4002
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004003void Dumpstate::UpdateProgress(int32_t delta_sec) {
4004 if (progress_ == nullptr) {
4005 MYLOGE("UpdateProgress: progress_ not set\n");
4006 return;
4007 }
Rhed Jaobf63d8a2020-07-21 15:42:55 +08004008 // This function updates progress related members of the dumpstate and reports
4009 // progress percentage to the bugreport client. Since it could be called by
4010 // different dump tasks at the same time if the parallel run is enabled, a
4011 // mutex lock is necessary here to synchronize the call.
4012 std::lock_guard<std::recursive_mutex> lock(mutex_);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004013
4014 // Always update progess so stats can be tuned...
Nandana Dutt402a8392019-06-14 14:25:13 +01004015 progress_->Inc(delta_sec);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004016
4017 // ...but only notifiy listeners when necessary.
4018 if (!options_->do_progress_updates) return;
4019
4020 int progress = progress_->Get();
4021 int max = progress_->GetMax();
Nandana Dutt402a8392019-06-14 14:25:13 +01004022 int percent = 100 * progress / max;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004023
Nandana Dutt402a8392019-06-14 14:25:13 +01004024 if (last_reported_percent_progress_ > 0 && percent <= last_reported_percent_progress_) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004025 return;
4026 }
Nandana Dutt402a8392019-06-14 14:25:13 +01004027 last_reported_percent_progress_ = percent;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004028
4029 if (control_socket_fd_ >= 0) {
4030 dprintf(control_socket_fd_, "PROGRESS:%d/%d\n", progress, max);
4031 fsync(control_socket_fd_);
4032 }
4033
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004034 if (listener_ != nullptr) {
Nandana Dutt235c6672019-11-14 15:22:32 +00004035 if (percent % 10 == 0) {
4036 // We don't want to spam logcat, so only log multiples of 10.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004037 MYLOGD("Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004038 } else {
4039 // stderr is ignored on normal invocations, but useful when calling
4040 // /system/bin/dumpstate directly for debuggging.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004041 fprintf(stderr, "Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004042 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004043
4044 listener_->onProgress(percent);
4045 }
4046}
4047
4048void Dumpstate::TakeScreenshot(const std::string& path) {
4049 const std::string& real_path = path.empty() ? screenshot_path_ : path;
4050 int status =
4051 RunCommand("", {"/system/bin/screencap", "-p", real_path},
4052 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
4053 if (status == 0) {
4054 MYLOGD("Screenshot saved on %s\n", real_path.c_str());
4055 } else {
4056 MYLOGE("Failed to take screenshot on %s\n", real_path.c_str());
4057 }
Paul Chang0d2aad72020-02-13 20:04:03 +08004058 if (listener_ != nullptr) {
4059 // Show a visual indication to indicate screenshot is taken via
4060 // IDumpstateListener.onScreenshotTaken()
4061 listener_->onScreenshotTaken(status == 0);
4062 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004063}
4064
4065bool is_dir(const char* pathname) {
4066 struct stat info;
4067 if (stat(pathname, &info) == -1) {
4068 return false;
4069 }
4070 return S_ISDIR(info.st_mode);
4071}
4072
4073time_t get_mtime(int fd, time_t default_mtime) {
4074 struct stat info;
4075 if (fstat(fd, &info) == -1) {
4076 return default_mtime;
4077 }
4078 return info.st_mtime;
4079}