blob: 528feca0cfa6154741f0bf558a1edfc399b87e9e [file] [log] [blame]
Colin Crossf45fa6b2012-03-26 12:38:26 -07001/*
2 * Copyright (C) 2008 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
Felipe Lemef0292972016-11-22 13:57:05 -080016
Mark Salyzyn6c3d90f2016-09-27 14:55:27 -070017#define LOG_TAG "dumpstate"
Colin Crossf45fa6b2012-03-26 12:38:26 -070018
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -070019#include <dirent.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070020#include <errno.h>
21#include <fcntl.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010022#include <inttypes.h>
Felipe Lemead5f6c42015-11-30 14:26:46 -080023#include <libgen.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070024#include <limits.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010025#include <math.h>
26#include <poll.h>
Mark Salyzyn8f37aa52015-06-12 12:28:24 -070027#include <stdbool.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070028#include <stdio.h>
29#include <stdlib.h>
30#include <string.h>
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -070031#include <sys/mount.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080032#include <sys/poll.h>
Christopher Ferris7dc7f322014-07-22 16:08:19 -070033#include <sys/prctl.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070034#include <sys/resource.h>
35#include <sys/stat.h>
36#include <sys/time.h>
37#include <sys/wait.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010038#include <signal.h>
39#include <stdarg.h>
40#include <string.h>
41#include <sys/capability.h>
42#include <sys/inotify.h>
43#include <sys/klog.h>
44#include <time.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070045#include <unistd.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070046
47#include <chrono>
Hridya Valsarajuac582cd2019-08-05 15:39:54 -070048#include <cmath>
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +000049#include <fstream>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070050#include <functional>
51#include <future>
Narayan Kamath8f788292017-05-25 13:20:39 +010052#include <memory>
Hridya Valsarajuac582cd2019-08-05 15:39:54 -070053#include <numeric>
Narayan Kamath8f788292017-05-25 13:20:39 +010054#include <regex>
55#include <set>
56#include <string>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070057#include <utility>
Narayan Kamath8f788292017-05-25 13:20:39 +010058#include <vector>
Colin Crossf45fa6b2012-03-26 12:38:26 -070059
Felipe Leme96c2bbb2016-09-26 09:21:21 -070060#include <android-base/file.h>
61#include <android-base/properties.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070062#include <android-base/scopeguard.h>
Elliott Hughes9dc117c2015-12-07 14:21:50 -080063#include <android-base/stringprintf.h>
Naveen Kalla058e1e82016-10-19 21:38:44 -070064#include <android-base/strings.h>
Andreas Gampeaff68432016-07-18 18:01:27 -070065#include <android-base/unique_fd.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010066#include <android/content/pm/IPackageManagerNative.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080067#include <android/hardware/dumpstate/1.0/IDumpstateDevice.h>
Hunter Knepshield8540faf2020-02-04 19:47:20 -080068#include <android/hardware/dumpstate/1.1/IDumpstateDevice.h>
69#include <android/hardware/dumpstate/1.1/types.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080070#include <android/hidl/manager/1.0/IServiceManager.h>
Nandana Duttd2f5f082019-01-18 17:13:52 +000071#include <android/os/IIncidentCompanion.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010072#include <binder/IServiceManager.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080073#include <cutils/native_handle.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070074#include <cutils/properties.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010075#include <cutils/sockets.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000076#include <debuggerd/client.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080077#include <dumpsys.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000078#include <dumputils/dump_utils.h>
Sahana Raof35ed432019-07-12 10:47:52 +010079#include <hardware_legacy/power.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080080#include <hidl/ServiceManagement.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010081#include <log/log.h>
Tom Cherryf4472f32020-08-05 09:31:17 -070082#include <log/log_read.h>
Felipe Leme75876a22016-10-27 16:31:27 -070083#include <openssl/sha.h>
Mark Salyzyn6c3d90f2016-09-27 14:55:27 -070084#include <private/android_filesystem_config.h>
85#include <private/android_logger.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080086#include <serviceutils/PriorityDumper.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070087#include <utils/StrongPointer.h>
Felipe Lemef0292972016-11-22 13:57:05 -080088#include "DumpstateInternal.h"
Felipe Leme75876a22016-10-27 16:31:27 -070089#include "DumpstateService.h"
Colin Crossf45fa6b2012-03-26 12:38:26 -070090#include "dumpstate.h"
Felipe Leme6e01fa62015-11-11 19:35:14 -080091
Hunter Knepshield8540faf2020-02-04 19:47:20 -080092using IDumpstateDevice_1_0 = ::android::hardware::dumpstate::V1_0::IDumpstateDevice;
93using IDumpstateDevice_1_1 = ::android::hardware::dumpstate::V1_1::IDumpstateDevice;
94using ::android::hardware::dumpstate::V1_1::DumpstateMode;
95using ::android::hardware::dumpstate::V1_1::DumpstateStatus;
96using ::android::hardware::dumpstate::V1_1::toString;
Vishnu Naire97d6122018-01-18 13:58:56 -080097using ::std::literals::chrono_literals::operator""ms;
98using ::std::literals::chrono_literals::operator""s;
Rhed Jao1c855122020-07-16 17:37:39 +080099using ::std::placeholders::_1;
Steven Morelandcb7ef822016-11-29 13:20:37 -0800100
Felipe Leme47e9be22016-12-21 15:37:07 -0800101// TODO: remove once moved to namespace
Vishnu Naire97d6122018-01-18 13:58:56 -0800102using android::defaultServiceManager;
103using android::Dumpsys;
104using android::INVALID_OPERATION;
105using android::IServiceManager;
106using android::OK;
107using android::sp;
108using android::status_t;
109using android::String16;
110using android::String8;
111using android::TIMED_OUT;
112using android::UNKNOWN_ERROR;
113using android::Vector;
Nandana Dutt979388e2018-11-30 16:48:55 +0000114using android::base::StringPrintf;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000115using android::os::IDumpstateListener;
Felipe Leme47e9be22016-12-21 15:37:07 -0800116using android::os::dumpstate::CommandOptions;
117using android::os::dumpstate::DumpFileToFd;
Rhed Jao1c855122020-07-16 17:37:39 +0800118using android::os::dumpstate::DumpPool;
Vishnu Naire97d6122018-01-18 13:58:56 -0800119using android::os::dumpstate::PropertiesHelper;
Rhed Jao4875aa62020-07-20 17:46:29 +0800120using android::os::dumpstate::TaskQueue;
Felipe Leme47e9be22016-12-21 15:37:07 -0800121
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100122// Keep in sync with
123// frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
124static const int TRACE_DUMP_TIMEOUT_MS = 10000; // 10 seconds
125
126/* Most simple commands have 10 as timeout, so 5 is a good estimate */
127static const int32_t WEIGHT_FILE = 5;
128
129// TODO: temporary variables and functions used during C++ refactoring
130static Dumpstate& ds = Dumpstate::GetInstance();
131static int RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Nandana Dutt8d945c02019-08-14 13:30:07 +0100132 const CommandOptions& options = CommandOptions::DEFAULT,
Rhed Jao4875aa62020-07-20 17:46:29 +0800133 bool verbose_duration = false, int out_fd = STDOUT_FILENO) {
134 return ds.RunCommand(title, full_command, options, verbose_duration, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100135}
136
137// Reasonable value for max stats.
138static const int STATS_MAX_N_RUNS = 1000;
139static const long STATS_MAX_AVERAGE = 100000;
140
141CommandOptions Dumpstate::DEFAULT_DUMPSYS = CommandOptions::WithTimeout(30).Build();
142
Nandana Duttd2f5f082019-01-18 17:13:52 +0000143typedef Dumpstate::ConsentCallback::ConsentResult UserConsentResult;
144
Colin Crossf45fa6b2012-03-26 12:38:26 -0700145/* read before root is shed */
146static char cmdline_buf[16384] = "(unknown)";
Yi Kong19d5c002018-07-20 13:39:55 -0700147static const char *dump_traces_path = nullptr;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000148static const uint64_t USER_CONSENT_TIMEOUT_MS = 30 * 1000;
Hunter Knepshield70610fa2020-01-03 15:27:33 -0800149// Because telephony reports are significantly faster to collect (< 10 seconds vs. > 2 minutes),
150// it's often the case that they time out far too quickly for consent with such a hefty dialog for
151// the user to read. For telephony reports only, we increase the default timeout to 2 minutes to
152// roughly match full reports' durations.
153static const uint64_t TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS = 2 * 60 * 1000;
Colin Crossf45fa6b2012-03-26 12:38:26 -0700154
Felipe Leme1d486fe2016-10-14 18:06:47 -0700155// TODO: variables and functions below should be part of dumpstate object
156
Felipe Leme635ca312016-01-05 14:23:02 -0800157static std::set<std::string> mount_points;
158void add_mountinfo();
Felipe Leme78f2c862015-12-21 09:55:22 -0800159
Todd Poynor2a83daa2013-11-22 15:44:22 -0800160#define PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops"
Mark Salyzyn7d0a7622016-06-24 14:06:15 -0700161#define ALT_PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops-0"
Wei Wang509bb5d2017-06-09 14:42:12 -0700162#define BLK_DEV_SYS_DIR "/sys/block"
Todd Poynor2a83daa2013-11-22 15:44:22 -0800163
Felipe Lemee82a27d2016-01-05 13:35:44 -0800164#define RECOVERY_DIR "/cache/recovery"
Mark Salyzynd6ab0112016-03-25 12:56:39 -0700165#define RECOVERY_DATA_DIR "/data/misc/recovery"
Tianjie Xu75d53362018-04-11 16:42:28 -0700166#define UPDATE_ENGINE_LOG_DIR "/data/misc/update_engine_log"
Mark Salyzyn4d42dea2016-04-01 10:03:14 -0700167#define LOGPERSIST_DATA_DIR "/data/misc/logd"
Jerry Changa1df8a92020-01-02 16:03:39 +0800168#define PREREBOOT_DATA_DIR "/data/misc/prereboot"
David Brazdild2991962016-06-03 14:40:44 +0100169#define PROFILE_DATA_DIR_CUR "/data/misc/profiles/cur"
170#define PROFILE_DATA_DIR_REF "/data/misc/profiles/ref"
Benedict Wong8f9d8a42019-01-03 16:19:38 -0800171#define XFRM_STAT_PROC_FILE "/proc/net/xfrm_stat"
Erik Kline08165202016-05-30 11:55:44 +0900172#define WLUTIL "/vendor/xbin/wlutil"
Vishnu Nair36b4cdb2017-11-17 10:27:05 -0800173#define WMTRACE_DATA_DIR "/data/misc/wmtrace"
Yifan Hong3945e1b2019-10-29 12:59:23 -0700174#define OTA_METADATA_DIR "/metadata/ota"
Yifan Hong0efa7972020-02-03 16:45:02 -0800175#define SNAPSHOTCTL_LOG_DIR "/data/misc/snapshotctl_log"
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +0900176#define LINKERCONFIG_DIR "/linkerconfig"
Calin Juravle78a0d842020-04-28 15:31:12 -0700177#define PACKAGE_DEX_USE_LIST "/data/system/package-dex-usage.list"
Primiano Tuccifaaaafb2021-01-14 12:26:29 +0000178#define SYSTEM_TRACE_SNAPSHOT "/data/misc/perfetto-traces/bugreport/systrace.pftrace"
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700179
Narayan Kamath8f788292017-05-25 13:20:39 +0100180// TODO(narayan): Since this information has to be kept in sync
181// with tombstoned, we should just put it in a common header.
182//
183// File: system/core/debuggerd/tombstoned/tombstoned.cpp
Narayan Kamathbd863722017-06-01 18:50:12 +0100184static const std::string TOMBSTONE_DIR = "/data/tombstones/";
185static const std::string TOMBSTONE_FILE_PREFIX = "tombstone_";
186static const std::string ANR_DIR = "/data/anr/";
187static const std::string ANR_FILE_PREFIX = "anr_";
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700188
Felipe Lemee844a9d2016-09-21 15:01:39 -0700189// TODO: temporary variables and functions used during C++ refactoring
Nandana Dutt979388e2018-11-30 16:48:55 +0000190
Nandana Dutt5c390032019-03-12 10:52:56 +0000191#define RETURN_IF_USER_DENIED_CONSENT() \
192 if (ds.IsUserConsentDenied()) { \
193 MYLOGE("Returning early as user denied consent to share bugreport with calling app."); \
194 return Dumpstate::RunStatus::USER_CONSENT_DENIED; \
195 }
196
197// Runs func_ptr, but checks user consent before and after running it. Returns USER_CONSENT_DENIED
198// if consent is found to be denied.
199#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(func_ptr, ...) \
200 RETURN_IF_USER_DENIED_CONSENT(); \
201 func_ptr(__VA_ARGS__); \
202 RETURN_IF_USER_DENIED_CONSENT();
203
Rhed Jao1c855122020-07-16 17:37:39 +0800204// Runs func_ptr, and logs a duration report after it's finished.
205#define RUN_SLOW_FUNCTION_AND_LOG(log_title, func_ptr, ...) \
206 { \
207 DurationReporter duration_reporter_in_macro(log_title); \
208 func_ptr(__VA_ARGS__); \
209 }
210
211// Similar with RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK, an additional duration report
212// is output after a slow function is finished.
213#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(log_title, func_ptr, ...) \
214 RETURN_IF_USER_DENIED_CONSENT(); \
215 RUN_SLOW_FUNCTION_AND_LOG(log_title, func_ptr, __VA_ARGS__); \
216 RETURN_IF_USER_DENIED_CONSENT();
217
Rhed Jao4875aa62020-07-20 17:46:29 +0800218#define WAIT_TASK_WITH_CONSENT_CHECK(task_name, pool_ptr) \
219 RETURN_IF_USER_DENIED_CONSENT(); \
220 pool_ptr->waitForTask(task_name); \
221 RETURN_IF_USER_DENIED_CONSENT();
222
Sahana Raof35ed432019-07-12 10:47:52 +0100223static const char* WAKE_LOCK_NAME = "dumpstate_wakelock";
224
Rhed Jao1c855122020-07-16 17:37:39 +0800225// Names of parallel tasks, they are used for the DumpPool to identify the dump
226// task and the log title of the duration report.
227static const std::string DUMP_TRACES_TASK = "DUMP TRACES";
Rhed Jao4875aa62020-07-20 17:46:29 +0800228static const std::string DUMP_INCIDENT_REPORT_TASK = "INCIDENT REPORT";
229static const std::string DUMP_HALS_TASK = "DUMP HALS";
230static const std::string DUMP_BOARD_TASK = "dumpstate_board()";
Rhed Jao6b1ea2d2020-07-21 17:58:41 +0800231static const std::string DUMP_CHECKINS_TASK = "DUMP CHECKINS";
Rhed Jao1c855122020-07-16 17:37:39 +0800232
Nandana Dutt979388e2018-11-30 16:48:55 +0000233namespace android {
234namespace os {
235namespace {
236
237static int Open(std::string path, int flags, mode_t mode = 0) {
238 int fd = TEMP_FAILURE_RETRY(open(path.c_str(), flags, mode));
239 if (fd == -1) {
240 MYLOGE("open(%s, %s)\n", path.c_str(), strerror(errno));
241 }
242 return fd;
243}
244
mhasank2d75c442020-06-11 15:05:25 -0700245static int OpenForWrite(std::string path) {
246 return Open(path, O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
247 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH);
248}
Nandana Dutt979388e2018-11-30 16:48:55 +0000249
250static int OpenForRead(std::string path) {
251 return Open(path, O_RDONLY | O_CLOEXEC | O_NOFOLLOW);
252}
253
254bool CopyFile(int in_fd, int out_fd) {
255 char buf[4096];
256 ssize_t byte_count;
257 while ((byte_count = TEMP_FAILURE_RETRY(read(in_fd, buf, sizeof(buf)))) > 0) {
258 if (!android::base::WriteFully(out_fd, buf, byte_count)) {
259 return false;
260 }
261 }
262 return (byte_count != -1);
263}
264
265static bool CopyFileToFd(const std::string& input_file, int out_fd) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000266 MYLOGD("Going to copy file (%s) to %d\n", input_file.c_str(), out_fd);
Nandana Dutt979388e2018-11-30 16:48:55 +0000267
268 // Obtain a handle to the source file.
269 android::base::unique_fd in_fd(OpenForRead(input_file));
270 if (out_fd != -1 && in_fd.get() != -1) {
271 if (CopyFile(in_fd.get(), out_fd)) {
272 return true;
273 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000274 MYLOGE("Failed to copy file: %s\n", strerror(errno));
Nandana Dutt979388e2018-11-30 16:48:55 +0000275 }
276 return false;
277}
278
Nandana Duttd2f5f082019-01-18 17:13:52 +0000279static bool UnlinkAndLogOnError(const std::string& file) {
Nandana Dutt8ae16e62020-03-27 10:20:22 +0000280 if (file.empty()) {
281 return false;
282 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000283 if (unlink(file.c_str())) {
284 MYLOGE("Failed to unlink file (%s): %s\n", file.c_str(), strerror(errno));
Nandana Duttd2f5f082019-01-18 17:13:52 +0000285 return false;
286 }
287 return true;
288}
Nandana Dutt979388e2018-11-30 16:48:55 +0000289
Nikita Ioffea325a572019-05-16 19:49:47 +0100290int64_t GetModuleMetadataVersion() {
291 auto binder = defaultServiceManager()->getService(android::String16("package_native"));
292 if (binder == nullptr) {
293 MYLOGE("Failed to retrieve package_native service");
294 return 0L;
295 }
296 auto package_service = android::interface_cast<content::pm::IPackageManagerNative>(binder);
297 std::string package_name;
298 auto status = package_service->getModuleMetadataPackageName(&package_name);
299 if (!status.isOk()) {
300 MYLOGE("Failed to retrieve module metadata package name: %s", status.toString8().c_str());
301 return 0L;
302 }
Nandana Duttdb379fa2019-10-09 16:54:41 +0100303 MYLOGD("Module metadata package name: %s\n", package_name.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100304 int64_t version_code;
305 status = package_service->getVersionCodeForPackage(android::String16(package_name.c_str()),
306 &version_code);
307 if (!status.isOk()) {
308 MYLOGE("Failed to retrieve module metadata version: %s", status.toString8().c_str());
309 return 0L;
310 }
311 return version_code;
312}
313
mhasank2d75c442020-06-11 15:05:25 -0700314static bool PathExists(const std::string& path) {
315 struct stat sb;
316 return stat(path.c_str(), &sb) == 0;
317}
318
319static bool CopyFileToFile(const std::string& input_file, const std::string& output_file) {
320 if (input_file == output_file) {
321 MYLOGD("Skipping copying bugreport file since the destination is the same (%s)\n",
322 output_file.c_str());
323 return false;
324 }
325 else if (PathExists(output_file)) {
326 MYLOGD("Cannot overwrite an existing file (%s)\n", output_file.c_str());
327 return false;
328 }
329
330 MYLOGD("Going to copy bugreport file (%s) to %s\n", input_file.c_str(), output_file.c_str());
331 android::base::unique_fd out_fd(OpenForWrite(output_file));
332 return CopyFileToFd(input_file, out_fd.get());
333}
334
Nandana Dutt979388e2018-11-30 16:48:55 +0000335} // namespace
336} // namespace os
337} // namespace android
338
Felipe Leme678727a2016-09-21 17:22:11 -0700339static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
Felipe Lemebda15a02016-11-16 17:48:25 -0800340 const CommandOptions& options = Dumpstate::DEFAULT_DUMPSYS,
Rhed Jao6b1ea2d2020-07-21 17:58:41 +0800341 long dumpsysTimeoutMs = 0, int out_fd = STDOUT_FILENO) {
342 return ds.RunDumpsys(title, dumpsysArgs, options, dumpsysTimeoutMs, out_fd);
343}
344static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
345 int out_fd) {
346 return ds.RunDumpsys(title, dumpsysArgs, Dumpstate::DEFAULT_DUMPSYS, 0, out_fd);
Felipe Leme678727a2016-09-21 17:22:11 -0700347}
348static int DumpFile(const std::string& title, const std::string& path) {
349 return ds.DumpFile(title, path);
350}
Felipe Lemee82a27d2016-01-05 13:35:44 -0800351
Felipe Lemee844a9d2016-09-21 15:01:39 -0700352// Relative directory (inside the zip) for all files copied as-is into the bugreport.
353static const std::string ZIP_ROOT_DIR = "FS";
354
Vishnu Naire97d6122018-01-18 13:58:56 -0800355static const std::string kProtoPath = "proto/";
356static const std::string kProtoExt = ".proto";
Jie Song9fbfad02017-06-20 16:29:42 -0700357static const std::string kDumpstateBoardFiles[] = {
358 "dumpstate_board.txt",
Felipe Leme95d6ca52017-08-01 16:35:56 -0700359 "dumpstate_board.bin"
Jie Song9fbfad02017-06-20 16:29:42 -0700360};
361static const int NUM_OF_DUMPS = arraysize(kDumpstateBoardFiles);
362
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700363static constexpr char PROPERTY_LAST_ID[] = "dumpstate.last_id";
Felipe Lemed071c682016-10-20 16:48:00 -0700364static constexpr char PROPERTY_VERSION[] = "dumpstate.version";
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700365
Felipe Lemef0292972016-11-22 13:57:05 -0800366static const CommandOptions AS_ROOT_20 = CommandOptions::WithTimeout(20).AsRoot().Build();
367
Narayan Kamath8f788292017-05-25 13:20:39 +0100368/*
Narayan Kamathbd863722017-06-01 18:50:12 +0100369 * Returns a vector of dump fds under |dir_path| with a given |file_prefix|.
Rhed Jao01dc0c62020-06-03 17:13:30 +0800370 * The returned vector is sorted by the mtimes of the dumps with descending
371 * order. If |limit_by_mtime| is set, the vector only contains files that
372 * were written in the last 30 minutes.
Narayan Kamath8f788292017-05-25 13:20:39 +0100373 */
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700374static std::vector<DumpData> GetDumpFds(const std::string& dir_path,
375 const std::string& file_prefix,
Elliott Hughesdb6d2112019-09-26 15:24:51 -0700376 bool limit_by_mtime) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100377 const time_t thirty_minutes_ago = ds.now_ - 60 * 30;
378
Narayan Kamathbd863722017-06-01 18:50:12 +0100379 std::unique_ptr<DIR, decltype(&closedir)> dump_dir(opendir(dir_path.c_str()), closedir);
Narayan Kamath8f788292017-05-25 13:20:39 +0100380
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700381 if (dump_dir == nullptr) {
382 MYLOGW("Unable to open directory %s: %s\n", dir_path.c_str(), strerror(errno));
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700383 return std::vector<DumpData>();
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700384 }
385
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700386 std::vector<DumpData> dump_data;
Narayan Kamathbd863722017-06-01 18:50:12 +0100387 struct dirent* entry = nullptr;
388 while ((entry = readdir(dump_dir.get()))) {
389 if (entry->d_type != DT_REG) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100390 continue;
391 }
392
Narayan Kamathbd863722017-06-01 18:50:12 +0100393 const std::string base_name(entry->d_name);
394 if (base_name.find(file_prefix) != 0) {
395 continue;
396 }
397
398 const std::string abs_path = dir_path + base_name;
399 android::base::unique_fd fd(
400 TEMP_FAILURE_RETRY(open(abs_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW | O_NONBLOCK)));
401 if (fd == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700402 MYLOGW("Unable to open dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamathbd863722017-06-01 18:50:12 +0100403 break;
404 }
405
406 struct stat st = {};
407 if (fstat(fd, &st) == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700408 MYLOGW("Unable to stat dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamath8f788292017-05-25 13:20:39 +0100409 continue;
410 }
411
Narayan Kamath3f31b632018-02-22 19:42:36 +0000412 if (limit_by_mtime && st.st_mtime < thirty_minutes_ago) {
Narayan Kamathbd863722017-06-01 18:50:12 +0100413 MYLOGI("Excluding stale dump file: %s\n", abs_path.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100414 continue;
415 }
416
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700417 dump_data.emplace_back(DumpData{abs_path, std::move(fd), st.st_mtime});
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700418 }
Rhed Jao01dc0c62020-06-03 17:13:30 +0800419 if (!dump_data.empty()) {
420 std::sort(dump_data.begin(), dump_data.end(),
421 [](const auto& a, const auto& b) { return a.mtime > b.mtime; });
422 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100423
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700424 return dump_data;
Narayan Kamath8f788292017-05-25 13:20:39 +0100425}
426
Narayan Kamathbd863722017-06-01 18:50:12 +0100427static bool AddDumps(const std::vector<DumpData>::const_iterator start,
428 const std::vector<DumpData>::const_iterator end,
429 const char* type_name, const bool add_to_zip) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100430 bool dumped = false;
Narayan Kamathbd863722017-06-01 18:50:12 +0100431 for (auto it = start; it != end; ++it) {
432 const std::string& name = it->name;
433 const int fd = it->fd;
Narayan Kamath8f788292017-05-25 13:20:39 +0100434 dumped = true;
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100435
436 // Seek to the beginning of the file before dumping any data. A given
437 // DumpData entry might be dumped multiple times in the report.
438 //
439 // For example, the most recent ANR entry is dumped to the body of the
440 // main entry and it also shows up as a separate entry in the bugreport
441 // ZIP file.
442 if (lseek(fd, 0, SEEK_SET) != static_cast<off_t>(0)) {
443 MYLOGE("Unable to add %s to zip file, lseek failed: %s\n", name.c_str(),
444 strerror(errno));
445 }
446
Narayan Kamath8f788292017-05-25 13:20:39 +0100447 if (ds.IsZipping() && add_to_zip) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800448 if (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + name, fd, /* timeout = */ 0ms) != OK) {
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100449 MYLOGE("Unable to add %s to zip file, addZipEntryFromFd failed\n", name.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100450 }
451 } else {
452 dump_file_from_fd(type_name, name.c_str(), fd);
453 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100454 }
455
456 return dumped;
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700457}
458
Felipe Leme635ca312016-01-05 14:23:02 -0800459// for_each_pid() callback to get mount info about a process.
Felipe Leme4c2d6632016-09-28 14:32:00 -0700460void do_mountinfo(int pid, const char* name __attribute__((unused))) {
Felipe Leme635ca312016-01-05 14:23:02 -0800461 char path[PATH_MAX];
462
463 // Gets the the content of the /proc/PID/ns/mnt link, so only unique mount points
464 // are added.
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700465 snprintf(path, sizeof(path), "/proc/%d/ns/mnt", pid);
Felipe Leme635ca312016-01-05 14:23:02 -0800466 char linkname[PATH_MAX];
467 ssize_t r = readlink(path, linkname, PATH_MAX);
468 if (r == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800469 MYLOGE("Unable to read link for %s: %s\n", path, strerror(errno));
Felipe Leme635ca312016-01-05 14:23:02 -0800470 return;
471 }
472 linkname[r] = '\0';
473
474 if (mount_points.find(linkname) == mount_points.end()) {
475 // First time this mount point was found: add it
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700476 snprintf(path, sizeof(path), "/proc/%d/mountinfo", pid);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700477 if (ds.AddZipEntry(ZIP_ROOT_DIR + path, path)) {
Felipe Leme635ca312016-01-05 14:23:02 -0800478 mount_points.insert(linkname);
479 } else {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800480 MYLOGE("Unable to add mountinfo %s to zip file\n", path);
Felipe Leme635ca312016-01-05 14:23:02 -0800481 }
482 }
483}
484
485void add_mountinfo() {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700486 if (!ds.IsZipping()) return;
Felipe Leme678727a2016-09-21 17:22:11 -0700487 std::string title = "MOUNT INFO";
Felipe Leme635ca312016-01-05 14:23:02 -0800488 mount_points.clear();
Felipe Leme46b85da2016-11-21 17:40:45 -0800489 DurationReporter duration_reporter(title, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700490 for_each_pid(do_mountinfo, nullptr);
491 MYLOGD("%s: %d entries added to zip file\n", title.c_str(), (int)mount_points.size());
Felipe Leme635ca312016-01-05 14:23:02 -0800492}
493
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700494static void dump_dev_files(const char *title, const char *driverpath, const char *filename)
495{
496 DIR *d;
497 struct dirent *de;
498 char path[PATH_MAX];
499
500 d = opendir(driverpath);
Yi Kong19d5c002018-07-20 13:39:55 -0700501 if (d == nullptr) {
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700502 return;
503 }
504
505 while ((de = readdir(d))) {
506 if (de->d_type != DT_LNK) {
507 continue;
508 }
509 snprintf(path, sizeof(path), "%s/%s/%s", driverpath, de->d_name, filename);
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700510 DumpFile(title, path);
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700511 }
512
513 closedir(d);
514}
515
Mark Salyzyn326842f2015-04-30 09:49:41 -0700516static bool skip_not_stat(const char *path) {
517 static const char stat[] = "/stat";
518 size_t len = strlen(path);
519 if (path[len - 1] == '/') { /* Directory? */
520 return false;
521 }
522 return strcmp(path + len - sizeof(stat) + 1, stat); /* .../stat? */
523}
524
Felipe Leme4c2d6632016-09-28 14:32:00 -0700525static bool skip_none(const char* path __attribute__((unused))) {
Felipe Lemee82a27d2016-01-05 13:35:44 -0800526 return false;
527}
528
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700529unsigned long worst_write_perf = 20000; /* in KB/s */
Mark Salyzyn326842f2015-04-30 09:49:41 -0700530
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800531//
532// stat offsets
533// Name units description
534// ---- ----- -----------
535// read I/Os requests number of read I/Os processed
536#define __STAT_READ_IOS 0
537// read merges requests number of read I/Os merged with in-queue I/O
538#define __STAT_READ_MERGES 1
539// read sectors sectors number of sectors read
540#define __STAT_READ_SECTORS 2
541// read ticks milliseconds total wait time for read requests
542#define __STAT_READ_TICKS 3
543// write I/Os requests number of write I/Os processed
544#define __STAT_WRITE_IOS 4
545// write merges requests number of write I/Os merged with in-queue I/O
546#define __STAT_WRITE_MERGES 5
547// write sectors sectors number of sectors written
548#define __STAT_WRITE_SECTORS 6
549// write ticks milliseconds total wait time for write requests
550#define __STAT_WRITE_TICKS 7
551// in_flight requests number of I/Os currently in flight
552#define __STAT_IN_FLIGHT 8
553// io_ticks milliseconds total time this block device has been active
554#define __STAT_IO_TICKS 9
555// time_in_queue milliseconds total wait time for all requests
556#define __STAT_IN_QUEUE 10
557#define __STAT_NUMBER_FIELD 11
558//
559// read I/Os, write I/Os
560// =====================
561//
562// These values increment when an I/O request completes.
563//
564// read merges, write merges
565// =========================
566//
567// These values increment when an I/O request is merged with an
568// already-queued I/O request.
569//
570// read sectors, write sectors
571// ===========================
572//
573// These values count the number of sectors read from or written to this
574// block device. The "sectors" in question are the standard UNIX 512-byte
575// sectors, not any device- or filesystem-specific block size. The
576// counters are incremented when the I/O completes.
577#define SECTOR_SIZE 512
578//
579// read ticks, write ticks
580// =======================
581//
582// These values count the number of milliseconds that I/O requests have
583// waited on this block device. If there are multiple I/O requests waiting,
584// these values will increase at a rate greater than 1000/second; for
585// example, if 60 read requests wait for an average of 30 ms, the read_ticks
586// field will increase by 60*30 = 1800.
587//
588// in_flight
589// =========
590//
591// This value counts the number of I/O requests that have been issued to
592// the device driver but have not yet completed. It does not include I/O
593// requests that are in the queue but not yet issued to the device driver.
594//
595// io_ticks
596// ========
597//
598// This value counts the number of milliseconds during which the device has
599// had I/O requests queued.
600//
601// time_in_queue
602// =============
603//
604// This value counts the number of milliseconds that I/O requests have waited
605// on this block device. If there are multiple I/O requests waiting, this
606// value will increase as the product of the number of milliseconds times the
607// number of requests waiting (see "read ticks" above for an example).
608#define S_TO_MS 1000
609//
610
Mark Salyzyn326842f2015-04-30 09:49:41 -0700611static int dump_stat_from_fd(const char *title __unused, const char *path, int fd) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800612 unsigned long long fields[__STAT_NUMBER_FIELD];
Mark Salyzyn326842f2015-04-30 09:49:41 -0700613 bool z;
Yi Kong19d5c002018-07-20 13:39:55 -0700614 char *cp, *buffer = nullptr;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700615 size_t i = 0;
Josh Gao7c4258c2018-06-25 13:40:08 -0700616 FILE *fp = fdopen(dup(fd), "rb");
Mark Salyzyn326842f2015-04-30 09:49:41 -0700617 getline(&buffer, &i, fp);
618 fclose(fp);
619 if (!buffer) {
620 return -errno;
621 }
622 i = strlen(buffer);
623 while ((i > 0) && (buffer[i - 1] == '\n')) {
624 buffer[--i] = '\0';
625 }
626 if (!*buffer) {
627 free(buffer);
628 return 0;
629 }
630 z = true;
631 for (cp = buffer, i = 0; i < (sizeof(fields) / sizeof(fields[0])); ++i) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800632 fields[i] = strtoull(cp, &cp, 10);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700633 if (fields[i] != 0) {
634 z = false;
635 }
636 }
637 if (z) { /* never accessed */
638 free(buffer);
639 return 0;
640 }
641
Wei Wang509bb5d2017-06-09 14:42:12 -0700642 if (!strncmp(path, BLK_DEV_SYS_DIR, sizeof(BLK_DEV_SYS_DIR) - 1)) {
643 path += sizeof(BLK_DEV_SYS_DIR) - 1;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700644 }
Wei Wang1dc1ef52017-06-12 11:28:37 -0700645
646 printf("%-30s:%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s\n%-30s:\t%s\n", "Block-Dev",
647 "R-IOs", "R-merg", "R-sect", "R-wait", "W-IOs", "W-merg", "W-sect",
648 "W-wait", "in-fli", "activ", "T-wait", path, buffer);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700649 free(buffer);
650
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800651 if (fields[__STAT_IO_TICKS]) {
652 unsigned long read_perf = 0;
653 unsigned long read_ios = 0;
654 if (fields[__STAT_READ_TICKS]) {
655 unsigned long long divisor = fields[__STAT_READ_TICKS]
656 * fields[__STAT_IO_TICKS];
657 read_perf = ((unsigned long long)SECTOR_SIZE
658 * fields[__STAT_READ_SECTORS]
659 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
660 / divisor;
661 read_ios = ((unsigned long long)S_TO_MS * fields[__STAT_READ_IOS]
662 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
663 / divisor;
664 }
665
666 unsigned long write_perf = 0;
667 unsigned long write_ios = 0;
668 if (fields[__STAT_WRITE_TICKS]) {
669 unsigned long long divisor = fields[__STAT_WRITE_TICKS]
670 * fields[__STAT_IO_TICKS];
671 write_perf = ((unsigned long long)SECTOR_SIZE
672 * fields[__STAT_WRITE_SECTORS]
673 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
674 / divisor;
675 write_ios = ((unsigned long long)S_TO_MS * fields[__STAT_WRITE_IOS]
676 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
677 / divisor;
678 }
679
680 unsigned queue = (fields[__STAT_IN_QUEUE]
681 + (fields[__STAT_IO_TICKS] >> 1))
682 / fields[__STAT_IO_TICKS];
683
684 if (!write_perf && !write_ios) {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700685 printf("%-30s: perf(ios) rd: %luKB/s(%lu/s) q: %u\n", path, read_perf, read_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800686 } else {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700687 printf("%-30s: perf(ios) rd: %luKB/s(%lu/s) wr: %luKB/s(%lu/s) q: %u\n", path, read_perf,
Felipe Lemed8b94e52016-12-08 10:21:44 -0800688 read_ios, write_perf, write_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800689 }
690
691 /* bugreport timeout factor adjustment */
692 if ((write_perf > 1) && (write_perf < worst_write_perf)) {
693 worst_write_perf = write_perf;
694 }
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700695 }
Mark Salyzyn326842f2015-04-30 09:49:41 -0700696 return 0;
697}
698
Yao Chenbe3bbc12018-01-17 16:31:10 -0800699static const long MINIMUM_LOGCAT_TIMEOUT_MS = 50000;
700
Tom Cherryf4472f32020-08-05 09:31:17 -0700701// Returns the actual readable size of the given buffer or -1 on error.
702static long logcat_buffer_readable_size(const std::string& buffer) {
703 std::unique_ptr<logger_list, decltype(&android_logger_list_free)> logger_list{
704 android_logger_list_alloc(0, 0, 0), &android_logger_list_free};
705 auto logger = android_logger_open(logger_list.get(), android_name_to_log_id(buffer.c_str()));
706
707 return android_logger_get_log_readable_size(logger);
708}
709
710// Returns timeout in ms to read a list of buffers.
Yao Chenbe3bbc12018-01-17 16:31:10 -0800711static unsigned long logcat_timeout(const std::vector<std::string>& buffers) {
712 unsigned long timeout_ms = 0;
713 for (const auto& buffer : buffers) {
Tom Cherryf4472f32020-08-05 09:31:17 -0700714 long readable_size = logcat_buffer_readable_size(buffer);
715 if (readable_size > 0) {
716 // Engineering margin is ten-fold our guess.
717 timeout_ms += 10 * (readable_size + worst_write_perf) / worst_write_perf;
718 }
Yao Chenbe3bbc12018-01-17 16:31:10 -0800719 }
720 return timeout_ms > MINIMUM_LOGCAT_TIMEOUT_MS ? timeout_ms : MINIMUM_LOGCAT_TIMEOUT_MS;
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700721}
722
Dieter Hsu105ad0c2020-09-29 15:23:33 +0800723// Opens a socket and returns its file descriptor.
724static int open_socket(const char* service);
725
Nandana Duttd2f5f082019-01-18 17:13:52 +0000726Dumpstate::ConsentCallback::ConsentCallback() : result_(UNAVAILABLE), start_time_(Nanotime()) {
727}
728
729android::binder::Status Dumpstate::ConsentCallback::onReportApproved() {
730 std::lock_guard<std::mutex> lock(lock_);
731 result_ = APPROVED;
732 MYLOGD("User approved consent to share bugreport\n");
Paul Chang0d2aad72020-02-13 20:04:03 +0800733
734 // Maybe copy screenshot so calling app can display the screenshot to the user as soon as
735 // consent is granted.
736 if (ds.options_->is_screenshot_copied) {
737 return android::binder::Status::ok();
738 }
739
740 if (!ds.options_->do_screenshot || ds.options_->screenshot_fd.get() == -1 ||
741 !ds.do_early_screenshot_) {
742 return android::binder::Status::ok();
743 }
744
745 bool copy_succeeded = android::os::CopyFileToFd(ds.screenshot_path_,
746 ds.options_->screenshot_fd.get());
747 ds.options_->is_screenshot_copied = copy_succeeded;
748 if (copy_succeeded) {
749 android::os::UnlinkAndLogOnError(ds.screenshot_path_);
750 }
Nandana Duttd2f5f082019-01-18 17:13:52 +0000751 return android::binder::Status::ok();
752}
753
754android::binder::Status Dumpstate::ConsentCallback::onReportDenied() {
755 std::lock_guard<std::mutex> lock(lock_);
756 result_ = DENIED;
757 MYLOGW("User denied consent to share bugreport\n");
758 return android::binder::Status::ok();
759}
760
761UserConsentResult Dumpstate::ConsentCallback::getResult() {
762 std::lock_guard<std::mutex> lock(lock_);
763 return result_;
764}
765
766uint64_t Dumpstate::ConsentCallback::getElapsedTimeMs() const {
Hunter Knepshieldf0a39052020-01-03 14:53:04 -0800767 return (Nanotime() - start_time_) / NANOS_PER_MILLI;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000768}
769
Felipe Leme2b9b06c2016-10-14 09:13:06 -0700770void Dumpstate::PrintHeader() const {
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700771 std::string build, fingerprint, radio, bootloader, network;
772 char date[80];
Colin Crossf45fa6b2012-03-26 12:38:26 -0700773
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700774 build = android::base::GetProperty("ro.build.display.id", "(unknown)");
775 fingerprint = android::base::GetProperty("ro.build.fingerprint", "(unknown)");
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700776 radio = android::base::GetProperty("gsm.version.baseband", "(unknown)");
777 bootloader = android::base::GetProperty("ro.bootloader", "(unknown)");
778 network = android::base::GetProperty("gsm.operator.alpha", "(unknown)");
Felipe Lemebbaf3c12016-10-11 14:32:25 -0700779 strftime(date, sizeof(date), "%Y-%m-%d %H:%M:%S", localtime(&now_));
Colin Crossf45fa6b2012-03-26 12:38:26 -0700780
Felipe Lemed8b94e52016-12-08 10:21:44 -0800781 printf("========================================================\n");
782 printf("== dumpstate: %s\n", date);
783 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -0700784
Felipe Lemed8b94e52016-12-08 10:21:44 -0800785 printf("\n");
786 printf("Build: %s\n", build.c_str());
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700787 // NOTE: fingerprint entry format is important for other tools.
Felipe Lemed8b94e52016-12-08 10:21:44 -0800788 printf("Build fingerprint: '%s'\n", fingerprint.c_str());
789 printf("Bootloader: %s\n", bootloader.c_str());
790 printf("Radio: %s\n", radio.c_str());
791 printf("Network: %s\n", network.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100792 int64_t module_metadata_version = android::os::GetModuleMetadataVersion();
793 if (module_metadata_version != 0) {
794 printf("Module Metadata version: %" PRId64 "\n", module_metadata_version);
795 }
Colin Crossf45fa6b2012-03-26 12:38:26 -0700796
Felipe Lemed8b94e52016-12-08 10:21:44 -0800797 printf("Kernel: ");
Felipe Lemef0292972016-11-22 13:57:05 -0800798 DumpFileToFd(STDOUT_FILENO, "", "/proc/version");
Felipe Lemed8b94e52016-12-08 10:21:44 -0800799 printf("Command line: %s\n", strtok(cmdline_buf, "\n"));
Felipe Leme7709f8a2017-12-05 09:30:09 -0800800 printf("Uptime: ");
801 RunCommandToFd(STDOUT_FILENO, "", {"uptime", "-p"},
802 CommandOptions::WithTimeout(1).Always().Build());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800803 printf("Bugreport format version: %s\n", version_.c_str());
Rhed Jao1c855122020-07-16 17:37:39 +0800804 printf("Dumpstate info: id=%d pid=%d dry_run=%d parallel_run=%d args=%s bugreport_mode=%s\n",
805 id_, pid_, PropertiesHelper::IsDryRun(), PropertiesHelper::IsParallelRun(),
806 options_->args.c_str(), options_->bugreport_mode.c_str());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800807 printf("\n");
Felipe Leme78f2c862015-12-21 09:55:22 -0800808}
809
Felipe Leme24b66ee2016-06-16 10:55:26 -0700810// List of file extensions that can cause a zip file attachment to be rejected by some email
811// service providers.
812static const std::set<std::string> PROBLEMATIC_FILE_EXTENSIONS = {
813 ".ade", ".adp", ".bat", ".chm", ".cmd", ".com", ".cpl", ".exe", ".hta", ".ins", ".isp",
814 ".jar", ".jse", ".lib", ".lnk", ".mde", ".msc", ".msp", ".mst", ".pif", ".scr", ".sct",
815 ".shb", ".sys", ".vb", ".vbe", ".vbs", ".vxd", ".wsc", ".wsf", ".wsh"
816};
817
Vishnu Naire97d6122018-01-18 13:58:56 -0800818status_t Dumpstate::AddZipEntryFromFd(const std::string& entry_name, int fd,
819 std::chrono::milliseconds timeout = 0ms) {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700820 if (!IsZipping()) {
821 MYLOGD("Not adding zip entry %s from fd because it's not a zipped bugreport\n",
822 entry_name.c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -0800823 return INVALID_OPERATION;
Felipe Leme111b9d02016-02-03 09:28:24 -0800824 }
Felipe Leme24b66ee2016-06-16 10:55:26 -0700825 std::string valid_name = entry_name;
826
827 // Rename extension if necessary.
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -0700828 size_t idx = entry_name.rfind('.');
Felipe Leme24b66ee2016-06-16 10:55:26 -0700829 if (idx != std::string::npos) {
830 std::string extension = entry_name.substr(idx);
831 std::transform(extension.begin(), extension.end(), extension.begin(), ::tolower);
832 if (PROBLEMATIC_FILE_EXTENSIONS.count(extension) != 0) {
833 valid_name = entry_name + ".renamed";
834 MYLOGI("Renaming entry %s to %s\n", entry_name.c_str(), valid_name.c_str());
835 }
836 }
837
Felipe Leme6fe9db62016-02-12 09:04:16 -0800838 // Logging statement below is useful to time how long each entry takes, but it's too verbose.
839 // MYLOGD("Adding zip entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700840 int32_t err = zip_writer_->StartEntryWithTime(valid_name.c_str(), ZipWriter::kCompress,
841 get_mtime(fd, ds.now_));
Felipe Leme1d486fe2016-10-14 18:06:47 -0700842 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700843 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", valid_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700844 ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800845 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800846 }
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000847 bool finished_entry = false;
848 auto finish_entry = [this, &finished_entry] {
849 if (!finished_entry) {
850 // This should only be called when we're going to return an earlier error,
851 // which would've been logged. This may imply the file is already corrupt
852 // and any further logging from FinishEntry is more likely to mislead than
853 // not.
854 this->zip_writer_->FinishEntry();
855 }
856 };
857 auto scope_guard = android::base::make_scope_guard(finish_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -0800858 auto start = std::chrono::steady_clock::now();
859 auto end = start + timeout;
860 struct pollfd pfd = {fd, POLLIN};
Felipe Lemee82a27d2016-01-05 13:35:44 -0800861
Felipe Leme770410d2016-01-26 17:07:14 -0800862 std::vector<uint8_t> buffer(65536);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800863 while (1) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800864 if (timeout.count() > 0) {
865 // lambda to recalculate the timeout.
866 auto time_left_ms = [end]() {
867 auto now = std::chrono::steady_clock::now();
868 auto diff = std::chrono::duration_cast<std::chrono::milliseconds>(end - now);
869 return std::max(diff.count(), 0LL);
870 };
871
872 int rc = TEMP_FAILURE_RETRY(poll(&pfd, 1, time_left_ms()));
873 if (rc < 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000874 MYLOGE("Error in poll while adding from fd to zip entry %s:%s\n",
875 entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800876 return -errno;
877 } else if (rc == 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000878 MYLOGE("Timed out adding from fd to zip entry %s:%s Timeout:%lldms\n",
Vishnu Naire97d6122018-01-18 13:58:56 -0800879 entry_name.c_str(), strerror(errno), timeout.count());
880 return TIMED_OUT;
881 }
882 }
883
Zach Riggle22200402016-08-18 01:01:24 -0400884 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800885 if (bytes_read == 0) {
886 break;
887 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800888 MYLOGE("read(%s): %s\n", entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800889 return -errno;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800890 }
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700891 err = zip_writer_->WriteBytes(buffer.data(), bytes_read);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800892 if (err) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700893 MYLOGE("zip_writer_->WriteBytes(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800894 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800895 }
896 }
897
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700898 err = zip_writer_->FinishEntry();
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000899 finished_entry = true;
Felipe Leme1d486fe2016-10-14 18:06:47 -0700900 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700901 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800902 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800903 }
904
Vishnu Naire97d6122018-01-18 13:58:56 -0800905 return OK;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800906}
907
Felipe Leme1d486fe2016-10-14 18:06:47 -0700908bool Dumpstate::AddZipEntry(const std::string& entry_name, const std::string& entry_path) {
909 android::base::unique_fd fd(
910 TEMP_FAILURE_RETRY(open(entry_path.c_str(), O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
Andreas Gampeaff68432016-07-18 18:01:27 -0700911 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800912 MYLOGE("open(%s): %s\n", entry_path.c_str(), strerror(errno));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800913 return false;
914 }
915
Vishnu Naire97d6122018-01-18 13:58:56 -0800916 return (AddZipEntryFromFd(entry_name, fd.get()) == OK);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800917}
918
919/* adds a file to the existing zipped bugreport */
Felipe Leme4c2d6632016-09-28 14:32:00 -0700920static int _add_file_from_fd(const char* title __attribute__((unused)), const char* path, int fd) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800921 return (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + path, fd) == OK) ? 0 : 1;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800922}
923
Felipe Leme1d486fe2016-10-14 18:06:47 -0700924void Dumpstate::AddDir(const std::string& dir, bool recursive) {
925 if (!IsZipping()) {
926 MYLOGD("Not adding dir %s because it's not a zipped bugreport\n", dir.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800927 return;
928 }
Felipe Leme678727a2016-09-21 17:22:11 -0700929 MYLOGD("Adding dir %s (recursive: %d)\n", dir.c_str(), recursive);
Felipe Leme46b85da2016-11-21 17:40:45 -0800930 DurationReporter duration_reporter(dir, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700931 dump_files("", dir.c_str(), recursive ? skip_none : is_dir, _add_file_from_fd);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800932}
933
Felipe Leme1d486fe2016-10-14 18:06:47 -0700934bool Dumpstate::AddTextZipEntry(const std::string& entry_name, const std::string& content) {
935 if (!IsZipping()) {
936 MYLOGD("Not adding text zip entry %s because it's not a zipped bugreport\n",
937 entry_name.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800938 return false;
939 }
Felipe Lemecbce55d2016-02-08 09:53:18 -0800940 MYLOGD("Adding zip text entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700941 int32_t err = zip_writer_->StartEntryWithTime(entry_name.c_str(), ZipWriter::kCompress, ds.now_);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700942 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700943 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700944 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800945 return false;
946 }
947
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700948 err = zip_writer_->WriteBytes(content.c_str(), content.length());
Felipe Leme1d486fe2016-10-14 18:06:47 -0700949 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700950 MYLOGE("zip_writer_->WriteBytes(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700951 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800952 return false;
953 }
954
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700955 err = zip_writer_->FinishEntry();
Felipe Leme1d486fe2016-10-14 18:06:47 -0700956 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700957 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800958 return false;
959 }
960
961 return true;
962}
963
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800964static void DoKmsg() {
965 struct stat st;
966 if (!stat(PSTORE_LAST_KMSG, &st)) {
967 /* Also TODO: Make console-ramoops CAP_SYSLOG protected. */
968 DumpFile("LAST KMSG", PSTORE_LAST_KMSG);
969 } else if (!stat(ALT_PSTORE_LAST_KMSG, &st)) {
970 DumpFile("LAST KMSG", ALT_PSTORE_LAST_KMSG);
971 } else {
972 /* TODO: Make last_kmsg CAP_SYSLOG protected. b/5555691 */
973 DumpFile("LAST KMSG", "/proc/last_kmsg");
974 }
975}
976
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800977static void DoKernelLogcat() {
Yao Chenbe3bbc12018-01-17 16:31:10 -0800978 unsigned long timeout_ms = logcat_timeout({"kernel"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800979 RunCommand(
980 "KERNEL LOG",
981 {"logcat", "-b", "kernel", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
982 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
983}
984
Nandana Duttdb379fa2019-10-09 16:54:41 +0100985static void DoSystemLogcat(time_t since) {
986 char since_str[80];
987 strftime(since_str, sizeof(since_str), "%Y-%m-%d %H:%M:%S.000", localtime(&since));
988
989 unsigned long timeout_ms = logcat_timeout({"main", "system", "crash"});
990 RunCommand("SYSTEM LOG",
991 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v", "-T",
992 since_str},
993 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
994}
995
Hunter Knepshield820f9bc2020-02-05 20:10:53 -0800996static void DoRadioLogcat() {
997 unsigned long timeout_ms = logcat_timeout({"radio"});
998 RunCommand(
999 "RADIO LOG",
1000 {"logcat", "-b", "radio", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1001 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
1002}
1003
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001004static void DoLogcat() {
Vishnu Nair6921f802017-11-22 09:17:23 -08001005 unsigned long timeout_ms;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001006 // DumpFile("EVENT LOG TAGS", "/etc/event-log-tags");
1007 // calculate timeout
Yao Chenbe3bbc12018-01-17 16:31:10 -08001008 timeout_ms = logcat_timeout({"main", "system", "crash"});
Tony Makae737652017-03-30 17:47:09 +01001009 RunCommand("SYSTEM LOG",
Vishnu Nair6921f802017-11-22 09:17:23 -08001010 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1011 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -08001012 timeout_ms = logcat_timeout({"events"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001013 RunCommand(
1014 "EVENT LOG",
1015 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001016 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Yao Chenbe3bbc12018-01-17 16:31:10 -08001017 timeout_ms = logcat_timeout({"stats"});
1018 RunCommand(
1019 "STATS LOG",
1020 {"logcat", "-b", "stats", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001021 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001022 DoRadioLogcat();
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001023
1024 RunCommand("LOG STATISTICS", {"logcat", "-b", "all", "-S"});
1025
1026 /* kernels must set CONFIG_PSTORE_PMSG, slice up pstore with device tree */
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001027 RunCommand("LAST LOGCAT", {"logcat", "-L", "-b", "all", "-v", "threadtime", "-v", "printable",
1028 "-v", "uid", "-d", "*:v"});
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001029}
1030
Mike Ma5c267872019-08-21 11:31:34 -07001031static void DumpIncidentReport() {
1032 if (!ds.IsZipping()) {
1033 MYLOGD("Not dumping incident report because it's not a zipped bugreport\n");
1034 return;
1035 }
Mike Ma5c267872019-08-21 11:31:34 -07001036 const std::string path = ds.bugreport_internal_dir_ + "/tmp_incident_report";
1037 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1038 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1039 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1040 if (fd < 0) {
1041 MYLOGE("Could not open %s to dump incident report.\n", path.c_str());
1042 return;
1043 }
1044 RunCommandToFd(fd, "", {"incident", "-u"}, CommandOptions::WithTimeout(120).Build());
1045 bool empty = 0 == lseek(fd, 0, SEEK_END);
1046 if (!empty) {
1047 // Use a different name from "incident.proto"
1048 // /proto/incident.proto is reserved for incident service dump
1049 // i.e. metadata for debugging.
Rhed Jao4875aa62020-07-20 17:46:29 +08001050 ds.EnqueueAddZipEntryAndCleanupIfNeeded(kProtoPath + "incident_report" + kProtoExt,
1051 path);
1052 } else {
1053 unlink(path.c_str());
Mike Ma5c267872019-08-21 11:31:34 -07001054 }
Mike Ma5c267872019-08-21 11:31:34 -07001055}
1056
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001057static void MaybeAddSystemTraceToZip() {
1058 // This function copies into the .zip the system trace that was snapshotted
1059 // by the early call to MaybeSnapshotSystemTrace(), if any background
1060 // tracing was happening.
1061 if (!ds.IsZipping()) {
1062 MYLOGD("Not dumping system trace because it's not a zipped bugreport\n");
1063 return;
1064 }
1065 if (!ds.has_system_trace_) {
1066 // No background trace was happening at the time dumpstate was invoked.
1067 return;
1068 }
1069 ds.AddZipEntry(
1070 ZIP_ROOT_DIR + SYSTEM_TRACE_SNAPSHOT,
1071 SYSTEM_TRACE_SNAPSHOT);
1072 android::os::UnlinkAndLogOnError(SYSTEM_TRACE_SNAPSHOT);
1073}
1074
Sunny Goyal35949782019-11-19 15:54:36 -08001075static void DumpVisibleWindowViews() {
1076 if (!ds.IsZipping()) {
1077 MYLOGD("Not dumping visible views because it's not a zipped bugreport\n");
1078 return;
1079 }
1080 DurationReporter duration_reporter("VISIBLE WINDOW VIEWS");
1081 const std::string path = ds.bugreport_internal_dir_ + "/tmp_visible_window_views";
1082 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1083 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1084 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1085 if (fd < 0) {
1086 MYLOGE("Could not open %s to dump visible views.\n", path.c_str());
1087 return;
1088 }
1089 RunCommandToFd(fd, "", {"cmd", "window", "dump-visible-window-views"},
1090 CommandOptions::WithTimeout(120).Build());
1091 bool empty = 0 == lseek(fd, 0, SEEK_END);
1092 if (!empty) {
1093 ds.AddZipEntry("visible_windows.zip", path);
1094 } else {
1095 MYLOGW("Failed to dump visible windows\n");
1096 }
1097 unlink(path.c_str());
1098}
1099
Jayachandran Ca94c7172017-06-10 15:08:12 -07001100static void DumpIpTablesAsRoot() {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001101 RunCommand("IPTABLES", {"iptables", "-L", "-nvx"});
1102 RunCommand("IP6TABLES", {"ip6tables", "-L", "-nvx"});
Erik Kline32af8c22016-09-28 17:26:26 +09001103 RunCommand("IPTABLES NAT", {"iptables", "-t", "nat", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001104 /* no ip6 nat */
Erik Kline32af8c22016-09-28 17:26:26 +09001105 RunCommand("IPTABLES MANGLE", {"iptables", "-t", "mangle", "-L", "-nvx"});
1106 RunCommand("IP6TABLES MANGLE", {"ip6tables", "-t", "mangle", "-L", "-nvx"});
1107 RunCommand("IPTABLES RAW", {"iptables", "-t", "raw", "-L", "-nvx"});
1108 RunCommand("IP6TABLES RAW", {"ip6tables", "-t", "raw", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001109}
1110
David Andersond9ba4752018-12-11 18:26:59 -08001111static void DumpDynamicPartitionInfo() {
1112 if (!::android::base::GetBoolProperty("ro.boot.dynamic_partitions", false)) {
1113 return;
1114 }
1115
1116 RunCommand("LPDUMP", {"lpdump", "--all"});
David Anderson6650ade2019-10-02 15:18:59 -07001117 RunCommand("DEVICE-MAPPER", {"gsid", "dump-device-mapper"});
David Andersond9ba4752018-12-11 18:26:59 -08001118}
1119
Narayan Kamath8f788292017-05-25 13:20:39 +01001120static void AddAnrTraceDir(const bool add_to_zip, const std::string& anr_traces_dir) {
1121 MYLOGD("AddAnrTraceDir(): dump_traces_file=%s, anr_traces_dir=%s\n", dump_traces_path,
1122 anr_traces_dir.c_str());
1123
1124 // If we're here, dump_traces_path will always be a temporary file
1125 // (created with mkostemp or similar) that contains dumps taken earlier
1126 // on in the process.
1127 if (dump_traces_path != nullptr) {
1128 if (add_to_zip) {
1129 ds.AddZipEntry(ZIP_ROOT_DIR + anr_traces_dir + "/traces-just-now.txt", dump_traces_path);
1130 } else {
1131 MYLOGD("Dumping current ANR traces (%s) to the main bugreport entry\n",
1132 dump_traces_path);
1133 ds.DumpFile("VM TRACES JUST NOW", dump_traces_path);
1134 }
1135
1136 const int ret = unlink(dump_traces_path);
1137 if (ret == -1) {
1138 MYLOGW("Error unlinking temporary trace path %s: %s\n", dump_traces_path,
1139 strerror(errno));
Felipe Lemee184f662016-10-27 10:04:47 -07001140 }
1141 }
1142
Narayan Kamathbd863722017-06-01 18:50:12 +01001143 // Add a specific message for the first ANR Dump.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001144 if (ds.anr_data_.size() > 0) {
1145 AddDumps(ds.anr_data_.begin(), ds.anr_data_.begin() + 1,
Narayan Kamathbd863722017-06-01 18:50:12 +01001146 "VM TRACES AT LAST ANR", add_to_zip);
1147
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001148 // The "last" ANR will always be included as separate entry in the zip file. In addition,
1149 // it will be present in the body of the main entry if |add_to_zip| == false.
1150 //
1151 // Historical ANRs are always included as separate entries in the bugreport zip file.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001152 AddDumps(ds.anr_data_.begin() + ((add_to_zip) ? 1 : 0), ds.anr_data_.end(),
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001153 "HISTORICAL ANR", true /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001154 } else {
Narayan Kamath8f788292017-05-25 13:20:39 +01001155 printf("*** NO ANRs to dump in %s\n\n", ANR_DIR.c_str());
1156 }
1157}
1158
1159static void AddAnrTraceFiles() {
1160 const bool add_to_zip = ds.IsZipping() && ds.version_ == VERSION_SPLIT_ANR;
1161
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001162 std::string anr_traces_dir = "/data/anr";
Narayan Kamath8f788292017-05-25 13:20:39 +01001163
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001164 AddAnrTraceDir(add_to_zip, anr_traces_dir);
Narayan Kamath8f788292017-05-25 13:20:39 +01001165
Makoto Onuki83ec63f2019-01-31 17:08:59 -08001166 RunCommand("ANR FILES", {"ls", "-lt", ANR_DIR});
1167
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001168 // Slow traces for slow operations.
Felipe Lemee184f662016-10-27 10:04:47 -07001169 struct stat st;
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001170 int i = 0;
1171 while (true) {
1172 const std::string slow_trace_path =
1173 anr_traces_dir + android::base::StringPrintf("slow%02d.txt", i);
1174 if (stat(slow_trace_path.c_str(), &st)) {
1175 // No traces file at this index, done with the files.
1176 break;
Felipe Lemee184f662016-10-27 10:04:47 -07001177 }
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001178 ds.DumpFile("VM TRACES WHEN SLOW", slow_trace_path.c_str());
1179 i++;
Felipe Lemee184f662016-10-27 10:04:47 -07001180 }
1181}
1182
Wei Wang509bb5d2017-06-09 14:42:12 -07001183static void DumpBlockStatFiles() {
1184 DurationReporter duration_reporter("DUMP BLOCK STAT");
Wei Wang509bb5d2017-06-09 14:42:12 -07001185
Wei Wang1dc1ef52017-06-12 11:28:37 -07001186 std::unique_ptr<DIR, std::function<int(DIR*)>> dirptr(opendir(BLK_DEV_SYS_DIR), closedir);
1187
1188 if (dirptr == nullptr) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001189 MYLOGE("Failed to open %s: %s\n", BLK_DEV_SYS_DIR, strerror(errno));
1190 return;
1191 }
1192
1193 printf("------ DUMP BLOCK STAT ------\n\n");
Wei Wang1dc1ef52017-06-12 11:28:37 -07001194 while (struct dirent *d = readdir(dirptr.get())) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001195 if ((d->d_name[0] == '.')
1196 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
1197 || (d->d_name[1] == '\0'))) {
1198 continue;
1199 }
1200 const std::string new_path =
1201 android::base::StringPrintf("%s/%s", BLK_DEV_SYS_DIR, d->d_name);
1202 printf("------ BLOCK STAT (%s) ------\n", new_path.c_str());
1203 dump_files("", new_path.c_str(), skip_not_stat, dump_stat_from_fd);
1204 printf("\n");
1205 }
Wei Wang1dc1ef52017-06-12 11:28:37 -07001206 return;
Wei Wang509bb5d2017-06-09 14:42:12 -07001207}
Jayachandran Ca94c7172017-06-10 15:08:12 -07001208
1209static void DumpPacketStats() {
1210 DumpFile("NETWORK DEV INFO", "/proc/net/dev");
1211 DumpFile("QTAGUID NETWORK INTERFACES INFO", "/proc/net/xt_qtaguid/iface_stat_all");
1212 DumpFile("QTAGUID NETWORK INTERFACES INFO (xt)", "/proc/net/xt_qtaguid/iface_stat_fmt");
1213 DumpFile("QTAGUID CTRL INFO", "/proc/net/xt_qtaguid/ctrl");
1214 DumpFile("QTAGUID STATS INFO", "/proc/net/xt_qtaguid/stats");
1215}
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 Jao4875aa62020-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 Moreland9de8a1f2020-09-23 17:26:33 +00001375 CommandOptions::WithTimeout(60).AsRootIfAvailable().Build());
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001376 return;
1377 }
Yifan Hong30528a22020-08-07 18:24:06 -07001378 RunCommand("HARDWARE HALS", {"lshal", "--all", "--types=all"},
Rhed Jao4875aa62020-07-20 17:46:29 +08001379 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build(),
1380 false, out_fd);
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001381
Steven Moreland44cd9482018-01-04 16:24:13 -08001382 using android::hidl::manager::V1_0::IServiceManager;
1383 using android::hardware::defaultServiceManager;
1384
1385 sp<IServiceManager> sm = defaultServiceManager();
1386 if (sm == nullptr) {
1387 MYLOGE("Could not retrieve hwservicemanager to dump hals.\n");
1388 return;
1389 }
1390
1391 auto ret = sm->list([&](const auto& interfaces) {
1392 for (const std::string& interface : interfaces) {
1393 std::string cleanName = interface;
1394 std::replace_if(cleanName.begin(),
1395 cleanName.end(),
1396 [](char c) {
1397 return !isalnum(c) &&
1398 std::string("@-_:.").find(c) == std::string::npos;
1399 }, '_');
Nandana Dutt979388e2018-11-30 16:48:55 +00001400 const std::string path = ds.bugreport_internal_dir_ + "/lshal_debug_" + cleanName;
Steven Moreland44cd9482018-01-04 16:24:13 -08001401
Rhed Jao4875aa62020-07-20 17:46:29 +08001402 bool empty = false;
Steven Moreland44cd9482018-01-04 16:24:13 -08001403 {
1404 auto fd = android::base::unique_fd(
1405 TEMP_FAILURE_RETRY(open(path.c_str(),
1406 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1407 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1408 if (fd < 0) {
1409 MYLOGE("Could not open %s to dump additional hal information.\n", path.c_str());
1410 continue;
1411 }
1412 RunCommandToFd(fd,
1413 "",
Steven Morelandc81cd3c2018-01-18 14:36:26 -08001414 {"lshal", "debug", "-E", interface},
Steven Moreland44cd9482018-01-04 16:24:13 -08001415 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
1416
Rhed Jao4875aa62020-07-20 17:46:29 +08001417 empty = 0 == lseek(fd, 0, SEEK_END);
Steven Moreland44cd9482018-01-04 16:24:13 -08001418 }
Rhed Jao4875aa62020-07-20 17:46:29 +08001419 if (!empty) {
1420 ds.EnqueueAddZipEntryAndCleanupIfNeeded("lshal-debug/" + cleanName + ".txt",
1421 path);
1422 } else {
1423 unlink(path.c_str());
1424 }
Steven Moreland44cd9482018-01-04 16:24:13 -08001425 }
1426 });
1427
1428 if (!ret.isOk()) {
1429 MYLOGE("Could not list hals from hwservicemanager.\n");
1430 }
1431}
1432
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001433static void DumpExternalFragmentationInfo() {
1434 struct stat st;
1435 if (stat("/proc/buddyinfo", &st) != 0) {
1436 MYLOGE("Unable to dump external fragmentation info\n");
1437 return;
1438 }
1439
1440 printf("------ EXTERNAL FRAGMENTATION INFO ------\n");
1441 std::ifstream ifs("/proc/buddyinfo");
1442 auto unusable_index_regex = std::regex{"Node\\s+([0-9]+),\\s+zone\\s+(\\S+)\\s+(.*)"};
1443 for (std::string line; std::getline(ifs, line);) {
1444 std::smatch match_results;
1445 if (std::regex_match(line, match_results, unusable_index_regex)) {
1446 std::stringstream free_pages(std::string{match_results[3]});
1447 std::vector<int> free_pages_per_order(std::istream_iterator<int>{free_pages},
1448 std::istream_iterator<int>());
1449
1450 int total_free_pages = 0;
1451 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1452 total_free_pages += (free_pages_per_order[i] * std::pow(2, i));
1453 }
1454
1455 printf("Node %s, zone %8s", match_results[1].str().c_str(),
1456 match_results[2].str().c_str());
1457
1458 int usable_free_pages = total_free_pages;
1459 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1460 auto unusable_index = (total_free_pages - usable_free_pages) /
1461 static_cast<double>(total_free_pages);
1462 printf(" %5.3f", unusable_index);
1463 usable_free_pages -= (free_pages_per_order[i] * std::pow(2, i));
1464 }
1465
1466 printf("\n");
1467 }
1468 }
1469 printf("\n");
1470}
1471
mhasankd451a472020-05-26 18:02:39 -07001472static void DumpstateLimitedOnly() {
1473 // Trimmed-down version of dumpstate to only include a whitelisted
1474 // set of logs (system log, event log, and system server / system app
1475 // crashes, and networking logs). See b/136273873 and b/138459828
1476 // for context.
1477 DurationReporter duration_reporter("DUMPSTATE");
1478 unsigned long timeout_ms;
1479 // calculate timeout
1480 timeout_ms = logcat_timeout({"main", "system", "crash"});
1481 RunCommand("SYSTEM LOG",
1482 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1483 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1484 timeout_ms = logcat_timeout({"events"});
1485 RunCommand(
1486 "EVENT LOG",
1487 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1488 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1489
1490 printf("========================================================\n");
1491 printf("== Networking Service\n");
1492 printf("========================================================\n");
1493
1494 RunDumpsys("DUMPSYS NETWORK_SERVICE_LIMITED", {"wifi", "-a"},
1495 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hugo Benichiaa162682020-10-30 23:28:56 +09001496 RunDumpsys("DUMPSYS CONNECTIVITY REQUESTS", {"connectivity", "requests"},
1497 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
mhasankd451a472020-05-26 18:02:39 -07001498
1499 printf("========================================================\n");
1500 printf("== Dropbox crashes\n");
1501 printf("========================================================\n");
1502
1503 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1504 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1505
1506 printf("========================================================\n");
1507 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1508 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1509 printf("========================================================\n");
1510 printf("== dumpstate: done (id %d)\n", ds.id_);
1511 printf("========================================================\n");
1512}
1513
Rhed Jao6b1ea2d2020-07-21 17:58:41 +08001514/*
1515 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1516 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1517 * if it's not running in the parallel task.
1518 */
1519static void DumpCheckins(int out_fd = STDOUT_FILENO) {
1520 dprintf(out_fd, "========================================================\n");
1521 dprintf(out_fd, "== Checkins\n");
1522 dprintf(out_fd, "========================================================\n");
1523
1524 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"}, out_fd);
1525 RunDumpsys("CHECKIN MEMINFO", {"meminfo", "--checkin"}, out_fd);
1526 RunDumpsys("CHECKIN NETSTATS", {"netstats", "--checkin"}, out_fd);
1527 RunDumpsys("CHECKIN PROCSTATS", {"procstats", "-c"}, out_fd);
1528 RunDumpsys("CHECKIN USAGESTATS", {"usagestats", "-c"}, out_fd);
1529 RunDumpsys("CHECKIN PACKAGE", {"package", "--checkin"}, out_fd);
1530}
1531
1532/*
1533 * Runs dumpsys on activity service to dump all application activities, services
1534 * and providers in the device.
1535 *
1536 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1537 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1538 * if it's not running in the parallel task.
1539 */
1540static void DumpAppInfos(int out_fd = STDOUT_FILENO) {
1541 dprintf(out_fd, "========================================================\n");
1542 dprintf(out_fd, "== Running Application Activities\n");
1543 dprintf(out_fd, "========================================================\n");
1544
1545 // The following dumpsys internally collects output from running apps, so it can take a long
1546 // time. So let's extend the timeout.
1547
1548 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
1549
1550 RunDumpsys("APP ACTIVITIES", {"activity", "-v", "all"}, DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1551
1552 dprintf(out_fd, "========================================================\n");
1553 dprintf(out_fd, "== Running Application Services (platform)\n");
1554 dprintf(out_fd, "========================================================\n");
1555
1556 RunDumpsys("APP SERVICES PLATFORM", {"activity", "service", "all-platform-non-critical"},
1557 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1558
1559 dprintf(out_fd, "========================================================\n");
1560 dprintf(out_fd, "== Running Application Services (non-platform)\n");
1561 dprintf(out_fd, "========================================================\n");
1562
1563 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1564 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1565
1566 dprintf(out_fd, "========================================================\n");
1567 dprintf(out_fd, "== Running Application Providers (platform)\n");
1568 dprintf(out_fd, "========================================================\n");
1569
1570 RunDumpsys("APP PROVIDERS PLATFORM", {"activity", "provider", "all-platform"},
Rhed Jaob049f182021-01-11 21:08:43 +08001571 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
Rhed Jao6b1ea2d2020-07-21 17:58:41 +08001572
1573 dprintf(out_fd, "========================================================\n");
1574 dprintf(out_fd, "== Running Application Providers (non-platform)\n");
1575 dprintf(out_fd, "========================================================\n");
1576
1577 RunDumpsys("APP PROVIDERS NON-PLATFORM", {"activity", "provider", "all-non-platform"},
1578 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1579}
1580
Nandana Dutt5c390032019-03-12 10:52:56 +00001581// Dumps various things. Returns early with status USER_CONSENT_DENIED if user denies consent
1582// via the consent they are shown. Ignores other errors that occur while running various
1583// commands. The consent checking is currently done around long running tasks, which happen to
1584// be distributed fairly evenly throughout the function.
1585static Dumpstate::RunStatus dumpstate() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001586 DurationReporter duration_reporter("DUMPSTATE");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001587
Rhed Jao4875aa62020-07-20 17:46:29 +08001588 // Enqueue slow functions into the thread pool, if the parallel run is enabled.
1589 if (ds.dump_pool_) {
1590 // Pool was shutdown in DumpstateDefaultAfterCritical method in order to
1591 // drop root user. Restarts it with two threads for the parallel run.
1592 ds.dump_pool_->start(/* thread_counts = */2);
1593
1594 ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
1595 ds.dump_pool_->enqueueTask(DUMP_INCIDENT_REPORT_TASK, &DumpIncidentReport);
1596 ds.dump_pool_->enqueueTaskWithFd(DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
Rhed Jao6b1ea2d2020-07-21 17:58:41 +08001597 ds.dump_pool_->enqueueTaskWithFd(DUMP_CHECKINS_TASK, &DumpCheckins, _1);
Rhed Jao4875aa62020-07-20 17:46:29 +08001598 }
1599
Nandana Dutt5c390032019-03-12 10:52:56 +00001600 // Dump various things. Note that anything that takes "long" (i.e. several seconds) should
1601 // check intermittently (if it's intrerruptable like a foreach on pids) and/or should be wrapped
1602 // in a consent check (via RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK).
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -07001603 dump_dev_files("TRUSTY VERSION", "/sys/bus/platform/drivers/trusty", "trusty_version");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001604 RunCommand("UPTIME", {"uptime"});
Wei Wang509bb5d2017-06-09 14:42:12 -07001605 DumpBlockStatFiles();
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001606 DumpFile("MEMORY INFO", "/proc/meminfo");
1607 RunCommand("CPU INFO", {"top", "-b", "-n", "1", "-H", "-s", "6", "-o",
Felipe Leme30dbfa12016-09-02 12:43:26 -07001608 "pid,tid,user,pr,ni,%cpu,s,virt,res,pcy,cmd,name"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001609
1610 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "PROCRANK", {"procrank"}, AS_ROOT_20);
1611
Sunny Goyal35949782019-11-19 15:54:36 -08001612 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpVisibleWindowViews);
1613
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001614 DumpFile("VIRTUAL MEMORY STATS", "/proc/vmstat");
1615 DumpFile("VMALLOC INFO", "/proc/vmallocinfo");
1616 DumpFile("SLAB INFO", "/proc/slabinfo");
1617 DumpFile("ZONEINFO", "/proc/zoneinfo");
1618 DumpFile("PAGETYPEINFO", "/proc/pagetypeinfo");
1619 DumpFile("BUDDYINFO", "/proc/buddyinfo");
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001620 DumpExternalFragmentationInfo();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001621
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001622 DumpFile("KERNEL WAKE SOURCES", "/d/wakeup_sources");
1623 DumpFile("KERNEL CPUFREQ", "/sys/devices/system/cpu/cpu0/cpufreq/stats/time_in_state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001624
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001625 RunCommand("PROCESSES AND THREADS",
Yohei Yukawa591a72d2017-10-05 21:36:35 -07001626 {"ps", "-A", "-T", "-Z", "-O", "pri,nice,rtprio,sched,pcy,time"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001627
1628 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "LIBRANK", {"librank"},
1629 CommandOptions::AS_ROOT);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001630
Rhed Jao4875aa62020-07-20 17:46:29 +08001631 if (ds.dump_pool_) {
1632 WAIT_TASK_WITH_CONSENT_CHECK(DUMP_HALS_TASK, ds.dump_pool_);
1633 } else {
1634 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_HALS_TASK, DumpHals);
1635 }
Steven Moreland81b429e2017-01-31 19:50:46 -08001636
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001637 RunCommand("PRINTENV", {"printenv"});
Elliott Hughes21b7c8d2016-10-28 08:53:02 -07001638 RunCommand("NETSTAT", {"netstat", "-nW"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001639 struct stat s;
1640 if (stat("/proc/modules", &s) != 0) {
1641 MYLOGD("Skipping 'lsmod' because /proc/modules does not exist\n");
1642 } else {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001643 RunCommand("LSMOD", {"lsmod"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001644 }
Michal Karpinski4db754f2015-12-11 18:04:32 +00001645
Tom Cherryb87dbfa2020-07-28 11:28:53 -07001646 if (android::base::GetBoolProperty("ro.logd.kernel", false)) {
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001647 DoKernelLogcat();
1648 } else {
1649 do_dmesg();
1650 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001651
Felipe Lemef0292972016-11-22 13:57:05 -08001652 RunCommand("LIST OF OPEN FILES", {"lsof"}, CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001653
1654 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(for_each_pid, do_showmap, "SMAPS OF ALL PROCESSES");
1655
Jeff Brown1dc94e32014-09-11 14:15:27 -07001656 for_each_tid(show_wchan, "BLOCKED PROCESS WAIT-CHANNELS");
Mark Salyzyna297c322016-02-05 15:33:17 -08001657 for_each_pid(show_showtime, "PROCESS TIMES (pid cmd user system iowait+percentage)");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001658
Jack Yu5a6b2e22020-08-14 18:13:35 +08001659 /* Dump Nfc NCI logs */
1660 ds.AddDir("/data/misc/nfc/logs", true);
Ajay Panickerd886ec42016-09-14 12:26:46 -07001661
Paul Chang0d2aad72020-02-13 20:04:03 +08001662 if (ds.options_->do_screenshot && !ds.do_early_screenshot_) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001663 MYLOGI("taking late screenshot\n");
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001664 ds.TakeScreenshot();
Jeff Sharkey5a930032013-03-19 15:05:19 -07001665 }
1666
Felipe Lemee184f662016-10-27 10:04:47 -07001667 AddAnrTraceFiles();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001668
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001669 MaybeAddSystemTraceToZip();
1670
Narayan Kamath8f788292017-05-25 13:20:39 +01001671 // NOTE: tombstones are always added as separate entries in the zip archive
1672 // and are not interspersed with the main report.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001673 const bool tombstones_dumped = AddDumps(ds.tombstone_data_.begin(), ds.tombstone_data_.end(),
Narayan Kamathbd863722017-06-01 18:50:12 +01001674 "TOMBSTONE", true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001675 if (!tombstones_dumped) {
1676 printf("*** NO TOMBSTONES to dump in %s\n\n", TOMBSTONE_DIR.c_str());
Christopher Ferris7dc7f322014-07-22 16:08:19 -07001677 }
1678
Jayachandran Ca94c7172017-06-10 15:08:12 -07001679 DumpPacketStats();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001680
Chenbo Feng276a3b62018-08-07 11:44:49 -07001681 RunDumpsys("EBPF MAP STATS", {"netd", "trafficcontroller"});
1682
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001683 DoKmsg();
Mark Salyzyn2262c162014-12-16 09:09:26 -08001684
Jayachandran Ca94c7172017-06-10 15:08:12 -07001685 DumpIpAddrAndRules();
Sreeram Ramachandran2b3bba32014-07-08 15:40:55 -07001686
1687 dump_route_tables();
1688
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001689 RunCommand("ARP CACHE", {"ip", "-4", "neigh", "show"});
1690 RunCommand("IPv6 ND CACHE", {"ip", "-6", "neigh", "show"});
1691 RunCommand("MULTICAST ADDRESSES", {"ip", "maddr"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001692
Nandana Dutt5c390032019-03-12 10:52:56 +00001693 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysHigh);
Lorenzo Colitti6afc38c2015-09-09 22:59:25 +09001694
Elliott Hughes23ccc622017-02-28 10:14:22 -08001695 RunCommand("SYSTEM PROPERTIES", {"getprop"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001696
Jin Qianf334d662017-10-10 14:41:37 -07001697 RunCommand("STORAGED IO INFO", {"storaged", "-u", "-p"});
ynwangf649a6e2016-07-17 21:56:00 -07001698
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001699 RunCommand("FILESYSTEMS & FREE SPACE", {"df"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001700
Colin Crossf45fa6b2012-03-26 12:38:26 -07001701 /* Binder state is expensive to look at as it uses a lot of memory. */
Hridya Valsaraju920ba712020-02-09 16:27:01 -08001702 std::string binder_logs_dir = access("/dev/binderfs/binder_logs", R_OK) ?
1703 "/sys/kernel/debug/binder" : "/dev/binderfs/binder_logs";
1704
1705 DumpFile("BINDER FAILED TRANSACTION LOG", binder_logs_dir + "/failed_transaction_log");
1706 DumpFile("BINDER TRANSACTION LOG", binder_logs_dir + "/transaction_log");
1707 DumpFile("BINDER TRANSACTIONS", binder_logs_dir + "/transactions");
1708 DumpFile("BINDER STATS", binder_logs_dir + "/stats");
1709 DumpFile("BINDER STATE", binder_logs_dir + "/state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001710
Vishnu Nair36b4cdb2017-11-17 10:27:05 -08001711 /* Add window and surface trace files. */
1712 if (!PropertiesHelper::IsUserBuild()) {
1713 ds.AddDir(WMTRACE_DATA_DIR, false);
1714 }
1715
Yifan Hongcba0a4f2020-02-08 16:52:02 -08001716 ds.AddDir(SNAPSHOTCTL_LOG_DIR, false);
1717
Rhed Jao4875aa62020-07-20 17:46:29 +08001718 if (ds.dump_pool_) {
1719 WAIT_TASK_WITH_CONSENT_CHECK(DUMP_BOARD_TASK, ds.dump_pool_);
1720 } else {
1721 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
1722 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001723
Steven Moreland7440ddb2016-12-15 16:13:39 -08001724 /* Migrate the ril_dumpstate to a device specific dumpstate? */
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001725 int rilDumpstateTimeout = android::base::GetIntProperty("ril.dumpstate.timeout", 0);
1726 if (rilDumpstateTimeout > 0) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001727 // su does not exist on user builds, so try running without it.
1728 // This way any implementations of vril-dump that do not require
1729 // root can run on user builds.
1730 CommandOptions::CommandOptionsBuilder options =
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001731 CommandOptions::WithTimeout(rilDumpstateTimeout);
Felipe Lemef0292972016-11-22 13:57:05 -08001732 if (!PropertiesHelper::IsUserBuild()) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001733 options.AsRoot();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001734 }
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001735 RunCommand("DUMP VENDOR RIL LOGS", {"vril-dump"}, options.Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -07001736 }
1737
Felipe Lemed8b94e52016-12-08 10:21:44 -08001738 printf("========================================================\n");
1739 printf("== Android Framework Services\n");
1740 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001741
Nandana Dutt5c390032019-03-12 10:52:56 +00001742 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysNormal);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001743
Jack He91ff2fe2021-02-18 18:23:43 -08001744 /* Dump Bluetooth HCI logs after getting bluetooth_manager dumpsys */
1745 ds.AddDir("/data/misc/bluetooth/logs", true);
1746
Rhed Jao6b1ea2d2020-07-21 17:58:41 +08001747 if (ds.dump_pool_) {
1748 WAIT_TASK_WITH_CONSENT_CHECK(DUMP_CHECKINS_TASK, ds.dump_pool_);
1749 } else {
1750 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_CHECKINS_TASK, DumpCheckins);
1751 }
Dianne Hackborn02bea972013-06-26 18:59:09 -07001752
Rhed Jaoc5f7ec32020-12-22 22:11:08 +08001753 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpAppInfos);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001754
Adrian Roos8b397ab2017-04-04 16:35:44 -07001755 printf("========================================================\n");
1756 printf("== Dropbox crashes\n");
1757 printf("========================================================\n");
1758
1759 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1760 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1761
Felipe Lemed8b94e52016-12-08 10:21:44 -08001762 printf("========================================================\n");
1763 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1764 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1765 printf("========================================================\n");
1766 printf("== dumpstate: done (id %d)\n", ds.id_);
1767 printf("========================================================\n");
Bookatz38472142018-09-28 10:20:24 -07001768
1769 printf("========================================================\n");
1770 printf("== Obtaining statsd metadata\n");
1771 printf("========================================================\n");
1772 // This differs from the usual dumpsys stats, which is the stats report data.
1773 RunDumpsys("STATSDSTATS", {"stats", "--metadata"});
Mike Ma5c267872019-08-21 11:31:34 -07001774
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +09001775 // Add linker configuration directory
1776 ds.AddDir(LINKERCONFIG_DIR, true);
1777
Rhed Jao4875aa62020-07-20 17:46:29 +08001778 if (ds.dump_pool_) {
1779 WAIT_TASK_WITH_CONSENT_CHECK(DUMP_INCIDENT_REPORT_TASK, ds.dump_pool_);
1780 } else {
1781 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_INCIDENT_REPORT_TASK,
1782 DumpIncidentReport);
1783 }
Mike Ma5c267872019-08-21 11:31:34 -07001784
Nandana Dutt5c390032019-03-12 10:52:56 +00001785 return Dumpstate::RunStatus::OK;
Colin Crossf45fa6b2012-03-26 12:38:26 -07001786}
1787
Nandana Dutt5c390032019-03-12 10:52:56 +00001788/*
1789 * Dumps state for the default case; drops root after it's no longer necessary.
1790 *
1791 * Returns RunStatus::OK if everything went fine.
1792 * Returns RunStatus::ERROR if there was an error.
1793 * Returns RunStatus::USER_DENIED_CONSENT if user explicitly denied consent to sharing the bugreport
1794 * with the caller.
1795 */
Jichao Lie89d9c12019-11-21 19:02:51 -08001796Dumpstate::RunStatus Dumpstate::DumpstateDefaultAfterCritical() {
Nandana Duttdb379fa2019-10-09 16:54:41 +01001797 // Capture first logcat early on; useful to take a snapshot before dumpstate logs take over the
1798 // buffer.
1799 DoLogcat();
1800 // Capture timestamp after first logcat to use in next logcat
1801 time_t logcat_ts = time(nullptr);
1802
Nandana Dutt4be45d12018-09-26 15:04:23 +01001803 /* collect stack traces from Dalvik and native processes (needs root) */
Rhed Jao1c855122020-07-16 17:37:39 +08001804 if (dump_pool_) {
1805 RETURN_IF_USER_DENIED_CONSENT();
1806 // One thread is enough since we only need to enqueue DumpTraces here.
1807 dump_pool_->start(/* thread_counts = */1);
1808
1809 // DumpTraces takes long time, post it to the another thread in the
1810 // pool, if pool is available
1811 dump_pool_->enqueueTask(DUMP_TRACES_TASK, &Dumpstate::DumpTraces, &ds, &dump_traces_path);
1812 } else {
1813 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_TRACES_TASK, ds.DumpTraces,
1814 &dump_traces_path);
1815 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001816
1817 /* Run some operations that require root. */
1818 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX, !ds.IsZipping());
1819 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX, !ds.IsZipping());
1820
1821 ds.AddDir(RECOVERY_DIR, true);
1822 ds.AddDir(RECOVERY_DATA_DIR, true);
1823 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
1824 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1825 if (!PropertiesHelper::IsUserBuild()) {
1826 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1827 ds.AddDir(PROFILE_DATA_DIR_REF, true);
Calin Juravle78a0d842020-04-28 15:31:12 -07001828 ds.AddZipEntry(ZIP_ROOT_DIR + PACKAGE_DEX_USE_LIST, PACKAGE_DEX_USE_LIST);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001829 }
Jerry Changa1df8a92020-01-02 16:03:39 +08001830 ds.AddDir(PREREBOOT_DATA_DIR, false);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001831 add_mountinfo();
1832 DumpIpTablesAsRoot();
David Andersond9ba4752018-12-11 18:26:59 -08001833 DumpDynamicPartitionInfo();
Yifan Hong3945e1b2019-10-29 12:59:23 -07001834 ds.AddDir(OTA_METADATA_DIR, true);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001835
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001836 // Capture any IPSec policies in play. No keys are exposed here.
Nandana Dutt4be45d12018-09-26 15:04:23 +01001837 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1838
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001839 // Dump IPsec stats. No keys are exposed here.
1840 DumpFile("XFRM STATS", XFRM_STAT_PROC_FILE);
1841
Nandana Dutt4be45d12018-09-26 15:04:23 +01001842 // Run ss as root so we can see socket marks.
1843 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
1844
1845 // Run iotop as root to show top 100 IO threads
1846 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
1847
Erick Reyese68df822019-02-11 14:46:36 -08001848 // Gather shared memory buffer info if the product implements it
Hridya Valsaraju1da80c52021-01-09 22:10:11 -08001849 RunCommand("Dmabuf dump", {"dmabuf_dump"});
1850 RunCommand("Dmabuf per-buffer/per-exporter/per-device stats", {"dmabuf_dump", "-b"});
Erick Reyese68df822019-02-11 14:46:36 -08001851
Minchan Kim22c6a1e2019-09-30 15:58:10 -07001852 DumpFile("PSI cpu", "/proc/pressure/cpu");
1853 DumpFile("PSI memory", "/proc/pressure/memory");
1854 DumpFile("PSI io", "/proc/pressure/io");
1855
Rhed Jao1c855122020-07-16 17:37:39 +08001856 if (dump_pool_) {
1857 RETURN_IF_USER_DENIED_CONSENT();
1858 dump_pool_->waitForTask(DUMP_TRACES_TASK);
1859
1860 // Current running thread in the pool is the root user also. Shutdown
1861 // the pool and restart later to ensure all threads in the pool could
1862 // drop the root user.
1863 dump_pool_->shutdown();
1864 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001865 if (!DropRootUser()) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001866 return Dumpstate::RunStatus::ERROR;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001867 }
1868
Nandana Dutt5c390032019-03-12 10:52:56 +00001869 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttdb379fa2019-10-09 16:54:41 +01001870 Dumpstate::RunStatus status = dumpstate();
1871 // Capture logcat since the last time we did it.
1872 DoSystemLogcat(logcat_ts);
1873 return status;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001874}
1875
Rhed Jaoa5de5752020-08-14 17:19:17 +08001876// Common states for telephony and wifi which are needed to be collected before
1877// dumpstate drop the root user.
1878static void DumpstateRadioAsRoot() {
1879 DumpIpTablesAsRoot();
1880 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1881}
1882
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001883// This method collects common dumpsys for telephony and wifi. Typically, wifi
1884// reports are fine to include all information, but telephony reports on user
1885// builds need to strip some content (see DumpstateTelephonyOnly).
1886static void DumpstateRadioCommon(bool include_sensitive_info = true) {
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001887 // We need to be picky about some stuff for telephony reports on user builds.
1888 if (!include_sensitive_info) {
1889 // Only dump the radio log buffer (other buffers and dumps contain too much unrelated info).
1890 DoRadioLogcat();
1891 } else {
Rhed Jaoa5de5752020-08-14 17:19:17 +08001892 // DumpHals takes long time, post it to the another thread in the pool,
1893 // if pool is available.
1894 if (ds.dump_pool_) {
1895 ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
1896 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001897 // Contains various system properties and process startup info.
1898 do_dmesg();
1899 // Logs other than the radio buffer may contain package/component names and potential PII.
1900 DoLogcat();
1901 // Too broad for connectivity problems.
1902 DoKmsg();
Rhed Jaoa5de5752020-08-14 17:19:17 +08001903 // DumpHals contains unrelated hardware info (camera, NFC, biometrics, ...).
1904 if (ds.dump_pool_) {
1905 ds.dump_pool_->waitForTask(DUMP_HALS_TASK);
1906 } else {
1907 RUN_SLOW_FUNCTION_AND_LOG(DUMP_HALS_TASK, DumpHals);
1908 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001909 }
1910
Jayachandran Ca94c7172017-06-10 15:08:12 -07001911 DumpPacketStats();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001912 DumpIpAddrAndRules();
1913 dump_route_tables();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001914 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
1915 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08001916}
1917
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001918// We use "telephony" here for legacy reasons, though this now really means "connectivity" (cellular
1919// + wifi + networking). This method collects dumpsys for connectivity debugging only. General rules
1920// for what can be included on user builds: all reported information MUST directly relate to
1921// connectivity debugging or customer support and MUST NOT contain unrelated personally identifiable
1922// information. This information MUST NOT identify user-installed packages (UIDs are OK, package
1923// names are not), and MUST NOT contain logs of user application traffic.
1924// TODO(b/148168577) rename this and other related fields/methods to "connectivity" instead.
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08001925static void DumpstateTelephonyOnly(const std::string& calling_package) {
mukesh agrawal253dad42018-01-23 21:59:59 -08001926 DurationReporter duration_reporter("DUMPSTATE");
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001927
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001928 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08001929
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001930 const bool include_sensitive_info = !PropertiesHelper::IsUserBuild();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001931
Rhed Jaoa5de5752020-08-14 17:19:17 +08001932 DumpstateRadioAsRoot();
1933 if (!DropRootUser()) {
1934 return;
1935 }
1936
1937 // Starts thread pool after the root user is dropped, and two additional threads
1938 // are created for DumpHals in the DumpstateRadioCommon and DumpstateBoard.
1939 if (ds.dump_pool_) {
1940 ds.dump_pool_->start(/*thread_counts =*/2);
1941
1942 // DumpstateBoard takes long time, post it to the another thread in the pool,
1943 // if pool is available.
1944 ds.dump_pool_->enqueueTaskWithFd(DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
1945 }
1946
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001947 DumpstateRadioCommon(include_sensitive_info);
1948
1949 if (include_sensitive_info) {
1950 // Contains too much unrelated PII, and given the unstructured nature of sysprops, we can't
1951 // really cherrypick all of the connectivity-related ones. Apps generally have no business
1952 // reading these anyway, and there should be APIs to supply the info in a more app-friendly
1953 // way.
1954 RunCommand("SYSTEM PROPERTIES", {"getprop"});
1955 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07001956
1957 printf("========================================================\n");
1958 printf("== Android Framework Services\n");
1959 printf("========================================================\n");
1960
Vishnu Nair652cc802017-11-30 15:18:30 -08001961 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1962 SEC_TO_MSEC(10));
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08001963 if (include_sensitive_info) {
1964 // Carrier apps' services will be dumped below in dumpsys activity service all-non-platform.
1965 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
1966 SEC_TO_MSEC(10));
1967 } else {
1968 // If the caller is a carrier app and has a carrier service, dump it here since we aren't
1969 // running dumpsys activity service all-non-platform below. Due to the increased output, we
1970 // give a higher timeout as well.
1971 RunDumpsys("DUMPSYS", {"carrier_config", "--requesting-package", calling_package},
1972 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(30));
1973 }
1974 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001975 RunDumpsys("DUMPSYS", {"netpolicy"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
1976 RunDumpsys("DUMPSYS", {"network_management"}, CommandOptions::WithTimeout(90).Build(),
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07001977 SEC_TO_MSEC(10));
Hunter Knepshield0fe51b12020-03-05 16:58:20 -08001978 RunDumpsys("DUMPSYS", {"telephony.registry"}, CommandOptions::WithTimeout(90).Build(),
1979 SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001980 if (include_sensitive_info) {
1981 // Contains raw IP addresses, omit from reports on user builds.
1982 RunDumpsys("DUMPSYS", {"netd"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
1983 // Contains raw destination IP/MAC addresses, omit from reports on user builds.
1984 RunDumpsys("DUMPSYS", {"connmetrics"}, CommandOptions::WithTimeout(90).Build(),
1985 SEC_TO_MSEC(10));
1986 // Contains package/component names, omit from reports on user builds.
1987 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
1988 SEC_TO_MSEC(10));
1989 // Contains package names, but should be relatively simple to remove them (also contains
1990 // UIDs already), omit from reports on user builds.
1991 RunDumpsys("BATTERYSTATS", {"deviceidle"}, CommandOptions::WithTimeout(90).Build(),
1992 SEC_TO_MSEC(10));
1993 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07001994
1995 printf("========================================================\n");
1996 printf("== Running Application Services\n");
1997 printf("========================================================\n");
1998
1999 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
2000
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002001 if (include_sensitive_info) {
2002 printf("========================================================\n");
2003 printf("== Running Application Services (non-platform)\n");
2004 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002005
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002006 // Contains package/component names and potential PII, omit from reports on user builds.
2007 // To get dumps of the active CarrierService(s) on user builds, we supply an argument to the
2008 // carrier_config dumpsys instead.
2009 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
2010 DUMPSYS_COMPONENTS_OPTIONS);
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002011
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002012 printf("========================================================\n");
2013 printf("== Checkins\n");
2014 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002015
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002016 // Contains package/component names, omit from reports on user builds.
2017 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
2018 }
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002019
2020 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07002021 printf("== dumpstate: done (id %d)\n", ds.id_);
2022 printf("========================================================\n");
Rhed Jaoa5de5752020-08-14 17:19:17 +08002023
2024 if (ds.dump_pool_) {
2025 ds.dump_pool_->waitForTask(DUMP_BOARD_TASK);
2026 } else {
2027 RUN_SLOW_FUNCTION_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
2028 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002029}
2030
mukesh agrawal253dad42018-01-23 21:59:59 -08002031// This method collects dumpsys for wifi debugging only
2032static void DumpstateWifiOnly() {
2033 DurationReporter duration_reporter("DUMPSTATE");
2034
Rhed Jaoa5de5752020-08-14 17:19:17 +08002035 DumpstateRadioAsRoot();
2036 if (!DropRootUser()) {
2037 return;
2038 }
2039
2040 // Starts thread pool after the root user is dropped. Only one additional
2041 // thread is needed for DumpHals in the DumpstateRadioCommon.
2042 if (ds.dump_pool_) {
2043 ds.dump_pool_->start(/*thread_counts =*/1);
2044 }
2045
mukesh agrawal253dad42018-01-23 21:59:59 -08002046 DumpstateRadioCommon();
2047
2048 printf("========================================================\n");
2049 printf("== Android Framework Services\n");
2050 printf("========================================================\n");
2051
2052 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
2053 SEC_TO_MSEC(10));
2054 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
2055 SEC_TO_MSEC(10));
2056
2057 printf("========================================================\n");
2058 printf("== dumpstate: done (id %d)\n", ds.id_);
2059 printf("========================================================\n");
2060}
2061
Nandana Duttcf419a72019-03-14 10:40:17 +00002062Dumpstate::RunStatus Dumpstate::DumpTraces(const char** path) {
Nandana Duttfaafd522019-03-11 09:23:09 +00002063 const std::string temp_file_pattern = "/data/anr/dumptrace_XXXXXX";
2064 const size_t buf_size = temp_file_pattern.length() + 1;
2065 std::unique_ptr<char[]> file_name_buf(new char[buf_size]);
2066 memcpy(file_name_buf.get(), temp_file_pattern.c_str(), buf_size);
2067
2068 // Create a new, empty file to receive all trace dumps.
2069 //
2070 // TODO: This can be simplified once we remove support for the old style
2071 // dumps. We can have a file descriptor passed in to dump_traces instead
2072 // of creating a file, closing it and then reopening it again.
2073 android::base::unique_fd fd(mkostemp(file_name_buf.get(), O_APPEND | O_CLOEXEC));
2074 if (fd < 0) {
2075 MYLOGE("mkostemp on pattern %s: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002076 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002077 }
2078
2079 // Nobody should have access to this temporary file except dumpstate, but we
2080 // temporarily grant 'read' to 'others' here because this file is created
2081 // when tombstoned is still running as root, but dumped after dropping. This
2082 // can go away once support for old style dumping has.
2083 const int chmod_ret = fchmod(fd, 0666);
2084 if (chmod_ret < 0) {
2085 MYLOGE("fchmod on %s failed: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002086 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002087 }
2088
2089 std::unique_ptr<DIR, decltype(&closedir)> proc(opendir("/proc"), closedir);
2090 if (proc.get() == nullptr) {
2091 MYLOGE("opendir /proc failed: %s\n", strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002092 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002093 }
2094
2095 // Number of times process dumping has timed out. If we encounter too many
2096 // failures, we'll give up.
2097 int timeout_failures = 0;
2098 bool dalvik_found = false;
2099
2100 const std::set<int> hal_pids = get_interesting_hal_pids();
2101
2102 struct dirent* d;
2103 while ((d = readdir(proc.get()))) {
Nandana Duttcf419a72019-03-14 10:40:17 +00002104 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttfaafd522019-03-11 09:23:09 +00002105 int pid = atoi(d->d_name);
2106 if (pid <= 0) {
2107 continue;
2108 }
2109
2110 const std::string link_name = android::base::StringPrintf("/proc/%d/exe", pid);
2111 std::string exe;
2112 if (!android::base::Readlink(link_name, &exe)) {
2113 continue;
2114 }
2115
2116 bool is_java_process;
2117 if (exe == "/system/bin/app_process32" || exe == "/system/bin/app_process64") {
2118 // Don't bother dumping backtraces for the zygote.
2119 if (IsZygote(pid)) {
2120 continue;
2121 }
2122
2123 dalvik_found = true;
2124 is_java_process = true;
2125 } else if (should_dump_native_traces(exe.c_str()) || hal_pids.find(pid) != hal_pids.end()) {
2126 is_java_process = false;
2127 } else {
2128 // Probably a native process we don't care about, continue.
2129 continue;
2130 }
2131
2132 // If 3 backtrace dumps fail in a row, consider debuggerd dead.
2133 if (timeout_failures == 3) {
2134 dprintf(fd, "ERROR: Too many stack dump failures, exiting.\n");
2135 break;
2136 }
2137
2138 const uint64_t start = Nanotime();
2139 const int ret = dump_backtrace_to_file_timeout(
2140 pid, is_java_process ? kDebuggerdJavaBacktrace : kDebuggerdNativeBacktrace,
2141 is_java_process ? 5 : 20, fd);
2142
2143 if (ret == -1) {
2144 // For consistency, the header and footer to this message match those
2145 // dumped by debuggerd in the success case.
2146 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
2147 dprintf(fd, "Dump failed, likely due to a timeout.\n");
2148 dprintf(fd, "---- end %d ----", pid);
2149 timeout_failures++;
2150 continue;
2151 }
2152
2153 // We've successfully dumped stack traces, reset the failure count
2154 // and write a summary of the elapsed time to the file and continue with the
2155 // next process.
2156 timeout_failures = 0;
2157
2158 dprintf(fd, "[dump %s stack %d: %.3fs elapsed]\n", is_java_process ? "dalvik" : "native",
2159 pid, (float)(Nanotime() - start) / NANOS_PER_SEC);
2160 }
2161
2162 if (!dalvik_found) {
2163 MYLOGE("Warning: no Dalvik processes found to dump stacks\n");
2164 }
2165
Nandana Duttcf419a72019-03-14 10:40:17 +00002166 *path = file_name_buf.release();
2167 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002168}
2169
Rhed Jao4875aa62020-07-20 17:46:29 +08002170void Dumpstate::DumpstateBoard(int out_fd) {
2171 dprintf(out_fd, "========================================================\n");
2172 dprintf(out_fd, "== Board\n");
2173 dprintf(out_fd, "========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08002174
Felipe Leme6f674ae2016-11-18 17:10:33 -08002175 if (!IsZipping()) {
Steven Moreland7440ddb2016-12-15 16:13:39 -08002176 MYLOGD("Not dumping board info because it's not a zipped bugreport\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08002177 return;
2178 }
2179
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002180 /*
2181 * mount debugfs for non-user builds which launch with S and unmount it
2182 * after invoking dumpstateBoard_* methods. This is to enable debug builds
2183 * to not have debugfs mounted during runtime. It will also ensure that
2184 * debugfs is only accessed by the dumpstate HAL.
2185 */
2186 auto api_level = android::base::GetIntProperty("ro.product.first_api_level", 0);
2187 bool mount_debugfs = !PropertiesHelper::IsUserBuild() && api_level >= 31;
2188
2189 if (mount_debugfs) {
2190 RunCommand("mount debugfs", {"mount", "-t", "debugfs", "debugfs", "/sys/kernel/debug"},
2191 AS_ROOT_20);
2192 RunCommand("chmod debugfs", {"chmod", "0755", "/sys/kernel/debug"},
2193 AS_ROOT_20);
2194 }
2195
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002196 std::vector<std::string> paths;
2197 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07002198 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002199 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
2200 kDumpstateBoardFiles[i].c_str()));
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002201 remover.emplace_back(android::base::make_scope_guard(
2202 std::bind([](std::string path) { android::os::UnlinkAndLogOnError(path); }, paths[i])));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002203 }
Jie Song9fbfad02017-06-20 16:29:42 -07002204
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002205 sp<IDumpstateDevice_1_0> dumpstate_device_1_0(IDumpstateDevice_1_0::getService());
2206 if (dumpstate_device_1_0 == nullptr) {
Wei Wang587eac92018-04-05 12:17:20 -07002207 MYLOGE("No IDumpstateDevice implementation\n");
2208 return;
2209 }
2210
2211 using ScopedNativeHandle =
2212 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
2213 ScopedNativeHandle handle(native_handle_create(static_cast<int>(paths.size()), 0),
2214 [](native_handle_t* handle) {
2215 native_handle_close(handle);
2216 native_handle_delete(handle);
2217 });
2218 if (handle == nullptr) {
2219 MYLOGE("Could not create native_handle\n");
2220 return;
2221 }
2222
Nandana Dutt5c390032019-03-12 10:52:56 +00002223 // TODO(128270426): Check for consent in between?
Wei Wang587eac92018-04-05 12:17:20 -07002224 for (size_t i = 0; i < paths.size(); i++) {
2225 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
2226
2227 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
2228 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
2229 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
2230 if (fd < 0) {
2231 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
2232 return;
2233 }
2234 handle.get()->data[i] = fd.release();
2235 }
2236
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002237 // Given that bugreport is required to diagnose failures, it's better to set an arbitrary amount
2238 // of timeout for IDumpstateDevice than to block the rest of bugreport. In the timeout case, we
2239 // will kill the HAL and grab whatever it dumped in time.
2240 constexpr size_t timeout_sec = 30;
2241 // Prefer version 1.1 if available. New devices launching with R are no longer allowed to
2242 // implement just 1.0.
2243 const char* descriptor_to_kill;
2244 using DumpstateBoardTask = std::packaged_task<bool()>;
2245 DumpstateBoardTask dumpstate_board_task;
2246 sp<IDumpstateDevice_1_1> dumpstate_device_1_1(
2247 IDumpstateDevice_1_1::castFrom(dumpstate_device_1_0));
2248 if (dumpstate_device_1_1 != nullptr) {
2249 MYLOGI("Using IDumpstateDevice v1.1");
2250 descriptor_to_kill = IDumpstateDevice_1_1::descriptor;
2251 dumpstate_board_task = DumpstateBoardTask([this, dumpstate_device_1_1, &handle]() -> bool {
2252 ::android::hardware::Return<DumpstateStatus> status =
2253 dumpstate_device_1_1->dumpstateBoard_1_1(handle.get(), options_->dumpstate_hal_mode,
2254 SEC_TO_MSEC(timeout_sec));
2255 if (!status.isOk()) {
2256 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2257 return false;
2258 } else if (status != DumpstateStatus::OK) {
2259 MYLOGE("dumpstateBoard failed with DumpstateStatus::%s\n", toString(status).c_str());
2260 return false;
2261 }
2262 return true;
2263 });
2264 } else {
2265 MYLOGI("Using IDumpstateDevice v1.0");
2266 descriptor_to_kill = IDumpstateDevice_1_0::descriptor;
2267 dumpstate_board_task = DumpstateBoardTask([dumpstate_device_1_0, &handle]() -> bool {
2268 ::android::hardware::Return<void> status =
2269 dumpstate_device_1_0->dumpstateBoard(handle.get());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002270 if (!status.isOk()) {
2271 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
Wei Wang587eac92018-04-05 12:17:20 -07002272 return false;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002273 }
Wei Wang587eac92018-04-05 12:17:20 -07002274 return true;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002275 });
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002276 }
2277 auto result = dumpstate_board_task.get_future();
2278 std::thread(std::move(dumpstate_board_task)).detach();
Wei Wang587eac92018-04-05 12:17:20 -07002279
Wei Wang587eac92018-04-05 12:17:20 -07002280 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2281 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate vendor HAL\n", timeout_sec);
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002282 if (!android::base::SetProperty(
2283 "ctl.interface_restart",
2284 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
Wei Wang587eac92018-04-05 12:17:20 -07002285 MYLOGE("Couldn't restart dumpstate HAL\n");
2286 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002287 }
Wei Wang587eac92018-04-05 12:17:20 -07002288 // Wait some time for init to kill dumpstate vendor HAL
2289 constexpr size_t killing_timeout_sec = 10;
2290 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2291 MYLOGE("killing dumpstateBoard timed out after %zus, continue and "
2292 "there might be racing in content\n", killing_timeout_sec);
2293 }
2294
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002295 if (mount_debugfs) {
2296 RunCommand("unmount debugfs", {"umount", "/sys/kernel/debug"}, AS_ROOT_20);
2297 }
2298
Wei Wang587eac92018-04-05 12:17:20 -07002299 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
2300 for (size_t i = 0; i < paths.size(); i++) {
2301 struct stat s;
2302 if (fstat(handle.get()->data[i], &s) == -1) {
2303 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(),
2304 strerror(errno));
2305 file_sizes[i] = -1;
2306 continue;
2307 }
2308 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002309 }
2310
2311 for (size_t i = 0; i < paths.size(); i++) {
2312 if (file_sizes[i] == -1) {
2313 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002314 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002315 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07002316 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002317 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002318 }
Rhed Jao4875aa62020-07-20 17:46:29 +08002319 remover[i].Disable();
2320 EnqueueAddZipEntryAndCleanupIfNeeded(kDumpstateBoardFiles[i], paths[i]);
2321 dprintf(out_fd, "*** See %s entry ***\n", kDumpstateBoardFiles[i].c_str());
Jie Song9fbfad02017-06-20 16:29:42 -07002322 }
Felipe Leme6f674ae2016-11-18 17:10:33 -08002323}
2324
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002325static void ShowUsage() {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002326 fprintf(stderr,
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002327 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-o directory] [-p] "
2328 "[-s] [-S] [-q] [-P] [-R] [-L] [-V version]\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002329 " -h: display this help message\n"
2330 " -b: play sound file instead of vibrate, at beginning of job\n"
2331 " -e: play sound file instead of vibrate, at end of job\n"
mhasank2d75c442020-06-11 15:05:25 -07002332 " -o: write to custom directory (only in limited mode)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01002333 " -p: capture screenshot to filename.png\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002334 " -s: write zipped file to control socket (for init)\n"
2335 " -S: write file location to control socket (for init)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002336 " -q: disable vibrate\n"
Abhijeet Kaure370d682019-10-01 16:49:30 +01002337 " -P: send broadcast when started and do progress updates\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002338 " -R: take bugreport in remote mode (shouldn't be used with -P)\n"
Nandana Dutt235864b2019-01-22 12:10:16 +00002339 " -w: start binder service and make it wait for a call to startBugreport\n"
mhasankd451a472020-05-26 18:02:39 -07002340 " -L: output limited information that is safe for submission in feedback reports\n"
Felipe Lemed071c682016-10-20 16:48:00 -07002341 " -v: prints the dumpstate header and exit\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002342}
2343
Wei Liuf87959e2016-08-26 14:51:42 -07002344static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07002345 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07002346}
2347
Felipe Leme1d486fe2016-10-14 18:06:47 -07002348bool Dumpstate::FinishZipFile() {
Rhed Jao4875aa62020-07-20 17:46:29 +08002349 // Runs all enqueued adding zip entry and cleanup tasks before finishing the zip file.
2350 if (zip_entry_tasks_) {
2351 zip_entry_tasks_->run(/* do_cancel = */false);
2352 }
2353
Felipe Leme9a523ae2016-10-20 15:10:33 -07002354 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07002355 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07002356 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002357 // Final timestamp
2358 char date[80];
2359 time_t the_real_now_please_stand_up = time(nullptr);
2360 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002361 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07002362 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002363
Felipe Leme9a523ae2016-10-20 15:10:33 -07002364 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002365 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08002366 return false;
2367 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07002368 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002369 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08002370 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08002371 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08002372
Felipe Leme0f3fb202016-06-10 17:10:53 -07002373 // Add log file (which contains stderr output) to zip...
2374 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07002375 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07002376 MYLOGE("Failed to add dumpstate log to .zip file\n");
2377 return false;
2378 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002379 // TODO: Should truncate the existing file.
2380 // ... and re-open it for further logging.
Nandana Dutta344cb62019-02-22 15:12:35 +00002381 if (!redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()))) {
2382 return false;
2383 }
Felipe Leme0f3fb202016-06-10 17:10:53 -07002384 fprintf(stderr, "\n");
2385
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002386 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07002387 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002388 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002389 return false;
2390 }
2391
Felipe Leme1d486fe2016-10-14 18:06:47 -07002392 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
2393 ds.zip_file.reset(nullptr);
2394
Felipe Lemee9d2c542016-11-15 11:48:26 -08002395 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002396 android::os::UnlinkAndLogOnError(tmp_path_);
Felipe Lemec4eee562016-04-21 15:42:55 -07002397
Felipe Leme1e9edc62015-12-21 16:02:13 -08002398 return true;
2399}
Felipe Leme6e01fa62015-11-11 19:35:14 -08002400
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002401static void SendBroadcast(const std::string& action, const std::vector<std::string>& args) {
2402 // clang-format off
2403 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user", "0",
2404 "--receiver-foreground", "--receiver-include-background", "-a", action};
2405 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08002406
2407 am.insert(am.end(), args.begin(), args.end());
2408
Felipe Leme8d2410e2017-02-08 09:46:08 -08002409 RunCommand("", am,
2410 CommandOptions::WithTimeout(20)
2411 .Log("Sending broadcast: '%s'\n")
2412 .Always()
2413 .DropRoot()
2414 .RedirectStderr()
2415 .Build());
2416}
2417
Felipe Leme35b8cf12017-02-10 15:47:29 -08002418static void Vibrate(int duration_ms) {
2419 // clang-format off
Chris Fries0c3de872019-09-14 15:49:41 +00002420 RunCommand("", {"cmd", "vibrator", "vibrate", "-f", std::to_string(duration_ms), "dumpstate"},
Felipe Leme35b8cf12017-02-10 15:47:29 -08002421 CommandOptions::WithTimeout(10)
2422 .Log("Vibrate: '%s'\n")
2423 .Always()
2424 .Build());
2425 // clang-format on
2426}
2427
Nandana Dutt979388e2018-11-30 16:48:55 +00002428static void MaybeResolveSymlink(std::string* path) {
2429 std::string resolved_path;
2430 if (android::base::Readlink(*path, &resolved_path)) {
2431 *path = resolved_path;
2432 }
2433}
2434
Nandana Dutt4be45d12018-09-26 15:04:23 +01002435/*
2436 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002437 * and adds the version file. Return false if zip_file could not be open to write.
Nandana Dutt4be45d12018-09-26 15:04:23 +01002438 */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002439static bool PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002440 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
2441
Nandana Dutt4be45d12018-09-26 15:04:23 +01002442 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
2443 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002444 ds.base_name_ = StringPrintf("bugreport-%s-%s", device_name.c_str(), build_id.c_str());
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002445 char date[80];
2446 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
2447 ds.name_ = date;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002448
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002449 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002450 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002451 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002452 ds.base_name_ += "-wifi";
2453 }
2454
Paul Chang0d2aad72020-02-13 20:04:03 +08002455 if (ds.options_->do_screenshot) {
Nandana Dutt9d17b942020-03-26 10:02:59 +00002456 ds.screenshot_path_ = ds.GetPath(ds.CalledByApi() ? "-png.tmp" : ".png");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002457 }
2458 ds.tmp_path_ = ds.GetPath(".tmp");
2459 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
2460
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002461 std::string destination = ds.CalledByApi()
Nandana Dutt54dbd672019-01-11 12:58:05 +00002462 ? StringPrintf("[fd:%d]", ds.options_->bugreport_fd.get())
Nandana Dutt9a76d202019-01-21 15:56:48 +00002463 : ds.bugreport_internal_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01002464 MYLOGD(
Nandana Dutt235c6672019-11-14 15:22:32 +00002465 "Bugreport dir: [%s] "
2466 "Base name: [%s] "
2467 "Suffix: [%s] "
2468 "Log path: [%s] "
2469 "Temporary path: [%s] "
2470 "Screenshot path: [%s]\n",
Nandana Dutt9a76d202019-01-21 15:56:48 +00002471 destination.c_str(), ds.base_name_.c_str(), ds.name_.c_str(), ds.log_path_.c_str(),
2472 ds.tmp_path_.c_str(), ds.screenshot_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002473
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002474 ds.path_ = ds.GetPath(ds.CalledByApi() ? "-zip.tmp" : ".zip");
2475 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
2476 create_parent_dirs(ds.path_.c_str());
2477 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
2478 if (ds.zip_file == nullptr) {
2479 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
2480 return false;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002481 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002482 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
2483 ds.AddTextZipEntry("version.txt", ds.version_);
2484 return true;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002485}
2486
2487/*
Abhijeet Kaure370d682019-10-01 16:49:30 +01002488 * Finalizes writing to the file by zipping the tmp file to the final location,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002489 * printing zipped file status, etc.
2490 */
2491static void FinalizeFile() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002492 bool do_text_file = !ds.FinishZipFile();
2493 if (do_text_file) {
2494 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002495 }
mhasank2d75c442020-06-11 15:05:25 -07002496
2497 std::string final_path = ds.path_;
2498 if (ds.options_->OutputToCustomFile()) {
mhasank3a4cfb42020-06-15 18:06:43 -07002499 final_path = ds.GetPath(ds.options_->out_dir, ".zip");
mhasank2d75c442020-06-11 15:05:25 -07002500 android::os::CopyFileToFile(ds.path_, final_path);
Nandana Dutt4be45d12018-09-26 15:04:23 +01002501 }
mhasank2d75c442020-06-11 15:05:25 -07002502
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002503 if (ds.options_->stream_to_socket) {
2504 android::os::CopyFileToFd(ds.path_, ds.control_socket_fd_);
2505 } else if (ds.options_->progress_updates_to_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002506 if (do_text_file) {
2507 dprintf(ds.control_socket_fd_,
2508 "FAIL:could not create zip file, check %s "
2509 "for more details\n",
2510 ds.log_path_.c_str());
2511 } else {
mhasank2d75c442020-06-11 15:05:25 -07002512 dprintf(ds.control_socket_fd_, "OK:%s\n", final_path.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002513 }
2514 }
2515}
2516
Nandana Dutt4be45d12018-09-26 15:04:23 +01002517
Nandana Dutt58d72e22018-11-16 10:30:48 +00002518static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2519 switch (mode) {
2520 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2521 return "BUGREPORT_FULL";
2522 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2523 return "BUGREPORT_INTERACTIVE";
2524 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2525 return "BUGREPORT_REMOTE";
2526 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2527 return "BUGREPORT_WEAR";
2528 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2529 return "BUGREPORT_TELEPHONY";
2530 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2531 return "BUGREPORT_WIFI";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002532 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2533 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002534 }
2535}
2536
Paul Changf59c2b72020-03-10 02:08:55 +08002537static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options,
2538 bool is_screenshot_requested) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002539 // Modify com.android.shell.BugreportProgressService#isDefaultScreenshotRequired as well for
2540 // default system screenshots.
Abhijeet Kaure370d682019-10-01 16:49:30 +01002541 options->bugreport_mode = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002542 switch (mode) {
2543 case Dumpstate::BugreportMode::BUGREPORT_FULL:
Paul Changf59c2b72020-03-10 02:08:55 +08002544 options->do_screenshot = is_screenshot_requested;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002545 options->dumpstate_hal_mode = DumpstateMode::FULL;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002546 break;
2547 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002548 // Currently, the dumpstate binder is only used by Shell to update progress.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002549 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002550 options->do_screenshot = is_screenshot_requested;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002551 options->dumpstate_hal_mode = DumpstateMode::INTERACTIVE;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002552 break;
2553 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002554 options->do_vibrate = false;
2555 options->is_remote_mode = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002556 options->do_screenshot = false;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002557 options->dumpstate_hal_mode = DumpstateMode::REMOTE;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002558 break;
2559 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002560 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002561 options->do_screenshot = is_screenshot_requested;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002562 options->dumpstate_hal_mode = DumpstateMode::WEAR;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002563 break;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002564 // TODO(b/148168577) rename TELEPHONY everywhere to CONNECTIVITY.
Nandana Dutt58d72e22018-11-16 10:30:48 +00002565 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002566 options->telephony_only = true;
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002567 options->do_progress_updates = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002568 options->do_screenshot = false;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002569 options->dumpstate_hal_mode = DumpstateMode::CONNECTIVITY;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002570 break;
2571 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002572 options->wifi_only = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002573 options->do_screenshot = false;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002574 options->dumpstate_hal_mode = DumpstateMode::WIFI;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002575 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002576 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2577 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002578 }
2579}
2580
Nandana Dutt58d72e22018-11-16 10:30:48 +00002581static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
Nandana Dutt235c6672019-11-14 15:22:32 +00002582 MYLOGI(
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002583 "do_vibrate: %d stream_to_socket: %d progress_updates_to_socket: %d do_screenshot: %d "
Rhed Jao6f5ddce2020-08-20 00:10:32 +08002584 "is_remote_mode: %d show_header_only: %d telephony_only: %d "
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002585 "wifi_only: %d do_progress_updates: %d fd: %d bugreport_mode: %s dumpstate_hal_mode: %s "
mhasankd451a472020-05-26 18:02:39 -07002586 "limited_only: %d args: %s\n",
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002587 options.do_vibrate, options.stream_to_socket, options.progress_updates_to_socket,
Paul Chang0d2aad72020-02-13 20:04:03 +08002588 options.do_screenshot, options.is_remote_mode, options.show_header_only,
Rhed Jao6f5ddce2020-08-20 00:10:32 +08002589 options.telephony_only, options.wifi_only,
mhasankd451a472020-05-26 18:02:39 -07002590 options.do_progress_updates, options.bugreport_fd.get(), options.bugreport_mode.c_str(),
2591 toString(options.dumpstate_hal_mode).c_str(), options.limited_only, options.args.c_str());
Nandana Dutt58d72e22018-11-16 10:30:48 +00002592}
2593
Nandana Dutt54dbd672019-01-11 12:58:05 +00002594void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode,
2595 const android::base::unique_fd& bugreport_fd_in,
Paul Changf59c2b72020-03-10 02:08:55 +08002596 const android::base::unique_fd& screenshot_fd_in,
2597 bool is_screenshot_requested) {
Nandana Dutt54dbd672019-01-11 12:58:05 +00002598 // Duplicate the fds because the passed in fds don't outlive the binder transaction.
2599 bugreport_fd.reset(dup(bugreport_fd_in.get()));
2600 screenshot_fd.reset(dup(screenshot_fd_in.get()));
Nandana Dutt58d72e22018-11-16 10:30:48 +00002601
Paul Changf59c2b72020-03-10 02:08:55 +08002602 SetOptionsFromMode(bugreport_mode, this, is_screenshot_requested);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002603}
2604
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002605Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
2606 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002607 int c;
mhasankd451a472020-05-26 18:02:39 -07002608 while ((c = getopt(argc, argv, "dho:svqzpLPBRSV:w")) != -1) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002609 switch (c) {
2610 // clang-format off
mhasank3a4cfb42020-06-15 18:06:43 -07002611 case 'o': out_dir = optarg; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002612 case 's': stream_to_socket = true; break;
2613 case 'S': progress_updates_to_socket = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002614 case 'v': show_header_only = true; break;
2615 case 'q': do_vibrate = false; break;
Paul Chang0d2aad72020-02-13 20:04:03 +08002616 case 'p': do_screenshot = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002617 case 'P': do_progress_updates = true; break;
2618 case 'R': is_remote_mode = true; break;
mhasankd451a472020-05-26 18:02:39 -07002619 case 'L': limited_only = true; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002620 case 'V':
2621 case 'd':
2622 case 'z':
2623 // compatibility no-op
2624 break;
Nandana Dutt235864b2019-01-22 12:10:16 +00002625 case 'w':
2626 // This was already processed
2627 break;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002628 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002629 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002630 break;
2631 default:
2632 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002633 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002634 break;
2635 // clang-format on
2636 }
2637 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08002638
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002639 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002640 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002641 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002642 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002643 }
2644 }
2645
2646 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
2647 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002648
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002649 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002650}
2651
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002652bool Dumpstate::DumpOptions::ValidateOptions() const {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002653 if (bugreport_fd.get() != -1 && stream_to_socket) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002654 return false;
2655 }
2656
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002657 if ((progress_updates_to_socket || do_progress_updates) && stream_to_socket) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002658 return false;
2659 }
2660
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002661 if (is_remote_mode && (do_progress_updates || stream_to_socket)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002662 return false;
2663 }
2664 return true;
2665}
2666
Nandana Dutt197661d2018-11-16 16:40:21 +00002667void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
2668 options_ = std::move(options);
2669}
2670
Abhijeet Kaura407fb82020-03-27 12:51:12 +00002671void Dumpstate::Initialize() {
2672 /* gets the sequential id */
2673 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
2674 id_ = ++last_id;
2675 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
2676}
2677
Nandana Duttd2f5f082019-01-18 17:13:52 +00002678Dumpstate::RunStatus Dumpstate::Run(int32_t calling_uid, const std::string& calling_package) {
2679 Dumpstate::RunStatus status = RunInternal(calling_uid, calling_package);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002680 if (listener_ != nullptr) {
2681 switch (status) {
2682 case Dumpstate::RunStatus::OK:
Nandana Duttcc4ead82019-01-23 08:29:23 +00002683 listener_->onFinished();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002684 break;
2685 case Dumpstate::RunStatus::HELP:
2686 break;
2687 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002688 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_INVALID_INPUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002689 break;
2690 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002691 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_RUNTIME_ERROR);
2692 break;
2693 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2694 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_DENIED_CONSENT);
2695 break;
2696 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
2697 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_CONSENT_TIMED_OUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002698 break;
2699 }
2700 }
2701 return status;
2702}
2703
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002704void Dumpstate::Cancel() {
2705 CleanupTmpFiles();
2706 android::os::UnlinkAndLogOnError(log_path_);
2707 for (int i = 0; i < NUM_OF_DUMPS; i++) {
2708 android::os::UnlinkAndLogOnError(ds.bugreport_internal_dir_ + "/" +
2709 kDumpstateBoardFiles[i]);
2710 }
2711 tombstone_data_.clear();
2712 anr_data_.clear();
Rhed Jaoe96bcd52020-08-21 14:48:20 +08002713
2714 // Instead of shutdown the pool, we delete temporary files directly since
2715 // shutdown blocking the call.
2716 if (dump_pool_) {
2717 dump_pool_->deleteTempFiles();
2718 }
2719 if (zip_entry_tasks_) {
2720 zip_entry_tasks_->run(/*do_cancel =*/ true);
2721 }
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002722}
2723
Nandana Dutt979388e2018-11-30 16:48:55 +00002724/*
2725 * Dumps relevant information to a bugreport based on the given options.
2726 *
2727 * The bugreport can be dumped to a file or streamed to a socket.
2728 *
2729 * How dumping to file works:
2730 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
2731 * stderr is redirected a log file.
2732 *
2733 * The temporary bugreport is then populated via printfs, dumping contents of files and
2734 * output of commands to stdout.
2735 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002736 * A bunch of other files and dumps are added to the zip archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00002737 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002738 * The temporary bugreport file and the log file also get added to the archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00002739 *
mhasank2d75c442020-06-11 15:05:25 -07002740 * Bugreports are first generated in a local directory and later copied to the caller's fd
2741 * or directory if supplied.
Nandana Dutt979388e2018-11-30 16:48:55 +00002742 */
Nandana Duttd2f5f082019-01-18 17:13:52 +00002743Dumpstate::RunStatus Dumpstate::RunInternal(int32_t calling_uid,
2744 const std::string& calling_package) {
Rhed Jao1c855122020-07-16 17:37:39 +08002745 DurationReporter duration_reporter("RUN INTERNAL", /* logcat_only = */true);
Nandana Dutt979388e2018-11-30 16:48:55 +00002746 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00002747 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002748 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002749 return RunStatus::INVALID_INPUT;
2750 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002751 /* set as high priority, and protect from OOM killer */
2752 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002753
Felipe Lemed071c682016-10-20 16:48:00 -07002754 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002755 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002756 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002757 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002758 } else {
2759 /* fallback to kernels <= 2.6.35 */
2760 oom_adj = fopen("/proc/self/oom_adj", "we");
2761 if (oom_adj) {
2762 fputs("-17", oom_adj);
2763 fclose(oom_adj);
2764 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002765 }
2766
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002767 if (version_ == VERSION_DEFAULT) {
2768 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00002769 }
2770
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002771 if (version_ != VERSION_CURRENT && version_ != VERSION_SPLIT_ANR) {
Vishnu Nair64afc022018-02-01 15:29:34 -08002772 MYLOGE("invalid version requested ('%s'); suppported values are: ('%s', '%s', '%s')\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002773 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str(),
Vishnu Nair64afc022018-02-01 15:29:34 -08002774 VERSION_SPLIT_ANR.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002775 return RunStatus::INVALID_INPUT;
Felipe Lemed071c682016-10-20 16:48:00 -07002776 }
2777
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002778 if (options_->show_header_only) {
2779 PrintHeader();
2780 return RunStatus::OK;
Felipe Lemed071c682016-10-20 16:48:00 -07002781 }
2782
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002783 MYLOGD("dumpstate calling_uid = %d ; calling package = %s \n",
2784 calling_uid, calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00002785
Felipe Leme7447d7c2016-11-03 18:12:22 -07002786 // TODO: temporarily set progress until it's part of the Dumpstate constructor
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002787 std::string stats_path =
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002788 android::base::StringPrintf("%s/dumpstate-stats.txt", bugreport_internal_dir_.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002789 progress_.reset(new Progress(stats_path));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002790
Sahana Raof35ed432019-07-12 10:47:52 +01002791 if (acquire_wake_lock(PARTIAL_WAKE_LOCK, WAKE_LOCK_NAME) < 0) {
2792 MYLOGE("Failed to acquire wake lock: %s\n", strerror(errno));
2793 } else {
2794 // Wake lock will be released automatically on process death
2795 MYLOGD("Wake lock acquired.\n");
2796 }
2797
Felipe Leme6ae5c4f2017-01-10 14:13:22 -08002798 register_sig_handler();
Felipe Lemed071c682016-10-20 16:48:00 -07002799
Felipe Lemef0292972016-11-22 13:57:05 -08002800 if (PropertiesHelper::IsDryRun()) {
Felipe Lemed071c682016-10-20 16:48:00 -07002801 MYLOGI("Running on dry-run mode (to disable it, call 'setprop dumpstate.dry_run false')\n");
2802 }
2803
Nandana Dutt235c6672019-11-14 15:22:32 +00002804 MYLOGI("dumpstate info: id=%d, args='%s', bugreport_mode= %s bugreport format version: %s\n",
2805 id_, options_->args.c_str(), options_->bugreport_mode.c_str(), version_.c_str());
Felipe Leme809d74e2016-02-02 12:57:00 -08002806
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002807 do_early_screenshot_ = options_->do_progress_updates;
Felipe Lemee338bf62015-12-07 14:03:50 -08002808
Christopher Ferrised9354f2014-10-01 17:35:01 -07002809 // If we are going to use a socket, do it as early as possible
2810 // to avoid timeouts from bugreport.
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002811 if (options_->stream_to_socket || options_->progress_updates_to_socket) {
Felipe Leme2628e9e2016-04-12 16:36:51 -07002812 MYLOGD("Opening control socket\n");
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002813 control_socket_fd_ = open_socket_fn_("dumpstate");
Nandana Dutta344cb62019-02-22 15:12:35 +00002814 if (control_socket_fd_ == -1) {
2815 return ERROR;
2816 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002817 if (options_->progress_updates_to_socket) {
2818 options_->do_progress_updates = 1;
2819 }
Felipe Leme2628e9e2016-04-12 16:36:51 -07002820 }
2821
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002822 if (!PrepareToWriteToFile()) {
2823 return ERROR;
2824 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08002825
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002826 // Interactive, wear & telephony modes are default to true.
2827 // and may enable from cli option or when using control socket
2828 if (options_->do_progress_updates) {
2829 // clang-format off
2830 std::vector<std::string> am_args = {
2831 "--receiver-permission", "android.permission.DUMP",
2832 };
2833 // clang-format on
2834 // Send STARTED broadcast for apps that listen to bugreport generation events
2835 SendBroadcast("com.android.internal.intent.action.BUGREPORT_STARTED", am_args);
2836 if (options_->progress_updates_to_socket) {
2837 dprintf(control_socket_fd_, "BEGIN:%s\n", path_.c_str());
Felipe Leme71bbfc52015-11-23 14:14:51 -08002838 }
2839 }
2840
Nick Kralevichf3599b32016-01-25 15:05:16 -08002841 /* read /proc/cmdline before dropping root */
2842 FILE *cmdline = fopen("/proc/cmdline", "re");
2843 if (cmdline) {
2844 fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
2845 fclose(cmdline);
2846 }
2847
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002848 if (options_->do_vibrate) {
Felipe Leme35b8cf12017-02-10 15:47:29 -08002849 Vibrate(150);
John Michelau1f794c42012-09-17 11:20:19 -05002850 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002851
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002852 if (zip_file != nullptr) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002853 if (chown(path_.c_str(), AID_SHELL, AID_SHELL)) {
2854 MYLOGE("Unable to change ownership of zip file %s: %s\n", path_.c_str(),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002855 strerror(errno));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002856 }
2857 }
2858
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002859 int dup_stdout_fd;
2860 int dup_stderr_fd;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002861 // Redirect stderr to log_path_ for debugging.
2862 TEMP_FAILURE_RETRY(dup_stderr_fd = dup(fileno(stderr)));
2863 if (!redirect_to_file(stderr, const_cast<char*>(log_path_.c_str()))) {
2864 return ERROR;
2865 }
2866 if (chown(log_path_.c_str(), AID_SHELL, AID_SHELL)) {
2867 MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n", log_path_.c_str(),
2868 strerror(errno));
2869 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002870
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002871 // Redirect stdout to tmp_path_. This is the main bugreport entry and will be
2872 // moved into zip file later, if zipping.
2873 TEMP_FAILURE_RETRY(dup_stdout_fd = dup(fileno(stdout)));
2874 // TODO: why not write to a file instead of stdout to overcome this problem?
2875 /* TODO: rather than generating a text file now and zipping it later,
2876 it would be more efficient to redirect stdout to the zip entry
2877 directly, but the libziparchive doesn't support that option yet. */
2878 if (!redirect_to_file(stdout, const_cast<char*>(tmp_path_.c_str()))) {
2879 return ERROR;
2880 }
2881 if (chown(tmp_path_.c_str(), AID_SHELL, AID_SHELL)) {
2882 MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
2883 tmp_path_.c_str(), strerror(errno));
Colin Crossf45fa6b2012-03-26 12:38:26 -07002884 }
Felipe Lemed8b94e52016-12-08 10:21:44 -08002885
2886 // Don't buffer stdout
2887 setvbuf(stdout, nullptr, _IONBF, 0);
2888
Rhed Jao1c855122020-07-16 17:37:39 +08002889 // Enable the parallel run if the client requests to output to a file.
2890 EnableParallelRunIfNeeded();
2891 // Using scope guard to make sure the dump pool can be shut down correctly.
2892 auto scope_guard_to_shutdown_pool = android::base::make_scope_guard([=]() {
2893 ShutdownDumpPool();
2894 });
2895
Felipe Leme608385d2016-02-01 10:35:38 -08002896 // NOTE: there should be no stdout output until now, otherwise it would break the header.
2897 // In particular, DurationReport objects should be created passing 'title, NULL', so their
Felipe Lemecbce55d2016-02-08 09:53:18 -08002898 // duration is logged into MYLOG instead.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002899 PrintHeader();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002900
Gavin Corkery6968f552020-11-22 18:09:05 +00002901 bool is_dumpstate_restricted = options_->telephony_only
2902 || options_->wifi_only
2903 || options_->limited_only;
2904 if (!is_dumpstate_restricted) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002905 // Invoke critical dumpsys first to preserve system state, before doing anything else.
Jichao Lie89d9c12019-11-21 19:02:51 -08002906 RunDumpsysCritical();
Gavin Corkery6968f552020-11-22 18:09:05 +00002907 }
2908 MaybeTakeEarlyScreenshot();
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00002909
2910 if (!is_dumpstate_restricted) {
2911 // Snapshot the system trace now (if running) to avoid that dumpstate's
2912 // own activity pushes out interesting data from the trace ring buffer.
2913 // The trace file is added to the zip by MaybeAddSystemTraceToZip().
2914 MaybeSnapshotSystemTrace();
2915 }
Gavin Corkery6968f552020-11-22 18:09:05 +00002916 onUiIntensiveBugreportDumpsFinished(calling_uid);
2917 MaybeCheckUserConsent(calling_uid, calling_package);
2918 if (options_->telephony_only) {
2919 DumpstateTelephonyOnly(calling_package);
2920 } else if (options_->wifi_only) {
2921 DumpstateWifiOnly();
2922 } else if (options_->limited_only) {
2923 DumpstateLimitedOnly();
2924 } else {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002925 // Dump state for the default case. This also drops root.
Jichao Lie89d9c12019-11-21 19:02:51 -08002926 RunStatus s = DumpstateDefaultAfterCritical();
Nandana Dutt5c390032019-03-12 10:52:56 +00002927 if (s != RunStatus::OK) {
Nandana Duttaac6f582019-07-26 14:32:47 +01002928 if (s == RunStatus::USER_CONSENT_DENIED) {
Nandana Dutt5c390032019-03-12 10:52:56 +00002929 HandleUserConsentDenied();
2930 }
2931 return s;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002932 }
Zhengyin Qian068ecc72016-08-10 16:48:14 -07002933 }
Felipe Leme71a74ac2016-03-17 15:43:25 -07002934
Felipe Leme55b42a62015-11-10 17:39:08 -08002935 /* close output if needed */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002936 TEMP_FAILURE_RETRY(dup2(dup_stdout_fd, fileno(stdout)));
Colin Crossf45fa6b2012-03-26 12:38:26 -07002937
Abhijeet Kaure370d682019-10-01 16:49:30 +01002938 // Zip the (now complete) .tmp file within the internal directory.
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002939 FinalizeFile();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002940
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002941 // Share the final file with the caller if the user has consented or Shell is the caller.
Nandana Duttd2f5f082019-01-18 17:13:52 +00002942 Dumpstate::RunStatus status = Dumpstate::RunStatus::OK;
Abhijeet Kaure370d682019-10-01 16:49:30 +01002943 if (CalledByApi()) {
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002944 status = CopyBugreportIfUserConsented(calling_uid);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002945 if (status != Dumpstate::RunStatus::OK &&
2946 status != Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2947 // Do an early return if there were errors. We make an exception for consent
2948 // timing out because it's possible the user got distracted. In this case the
2949 // bugreport is not shared but made available for manual retrieval.
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002950 MYLOGI("User denied consent. Returning\n");
Nandana Duttd2f5f082019-01-18 17:13:52 +00002951 return status;
2952 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002953 if (status == Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2954 MYLOGI(
2955 "Did not receive user consent yet."
2956 " Will not copy the bugreport artifacts to caller.\n");
Abhijeet Kaur57627412019-04-17 16:00:09 +01002957 const String16 incidentcompanion("incidentcompanion");
2958 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
2959 if (ics != nullptr) {
2960 MYLOGD("Canceling user consent request via incidentcompanion service\n");
2961 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
2962 consent_callback_.get());
2963 } else {
2964 MYLOGD("Unable to cancel user consent; incidentcompanion service unavailable\n");
2965 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002966 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00002967 }
2968
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002969 /* vibrate a few but shortly times to let user know it's finished */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002970 if (options_->do_vibrate) {
Takuya Ogawa47f644e2017-12-20 18:09:09 +09002971 for (int i = 0; i < 3; i++) {
2972 Vibrate(75);
2973 usleep((75 + 50) * 1000);
2974 }
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002975 }
2976
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002977 MYLOGD("Final progress: %d/%d (estimated %d)\n", progress_->Get(), progress_->GetMax(),
2978 progress_->GetInitialMax());
2979 progress_->Save();
2980 MYLOGI("done (id %d)\n", id_);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002981
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002982 TEMP_FAILURE_RETRY(dup2(dup_stderr_fd, fileno(stderr)));
Felipe Leme107a05f2016-03-08 15:11:15 -08002983
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002984 if (control_socket_fd_ != -1) {
Felipe Lemee844a9d2016-09-21 15:01:39 -07002985 MYLOGD("Closing control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002986 close(control_socket_fd_);
Felipe Leme2628e9e2016-04-12 16:36:51 -07002987 }
2988
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002989 tombstone_data_.clear();
2990 anr_data_.clear();
Narayan Kamath6b9516c2017-10-27 11:15:51 +01002991
Nandana Duttd2f5f082019-01-18 17:13:52 +00002992 return (consent_callback_ != nullptr &&
2993 consent_callback_->getResult() == UserConsentResult::UNAVAILABLE)
2994 ? USER_CONSENT_TIMED_OUT
2995 : RunStatus::OK;
2996}
2997
Paul Chang0d2aad72020-02-13 20:04:03 +08002998void Dumpstate::MaybeTakeEarlyScreenshot() {
2999 if (!options_->do_screenshot || !do_early_screenshot_) {
3000 return;
3001 }
3002
3003 TakeScreenshot();
3004}
3005
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003006void Dumpstate::MaybeSnapshotSystemTrace() {
3007 // If a background system trace is happening and is marked as "suitable for
3008 // bugreport" (i.e. bugreport_score > 0 in the trace config), this command
3009 // will stop it and serialize into SYSTEM_TRACE_SNAPSHOT. In the (likely)
3010 // case that no trace is ongoing, this command is a no-op.
3011 // Note: this should not be enqueued as we need to freeze the trace before
3012 // dumpstate starts. Otherwise the trace ring buffers will contain mostly
3013 // the dumpstate's own activity which is irrelevant.
3014 int res = RunCommand(
3015 "SERIALIZE PERFETTO TRACE",
3016 {"perfetto", "--save-for-bugreport"},
3017 CommandOptions::WithTimeout(10)
3018 .DropRoot()
3019 .CloseAllFileDescriptorsOnExec()
3020 .Build());
3021 has_system_trace_ = res == 0;
3022 // MaybeAddSystemTraceToZip() will take care of copying the trace in the zip
3023 // file in the later stages.
3024}
3025
Paul Chang5702b482020-05-28 22:05:47 +08003026void Dumpstate::onUiIntensiveBugreportDumpsFinished(int32_t calling_uid) {
Paul Changc490e662020-04-11 18:14:09 +08003027 if (calling_uid == AID_SHELL || !CalledByApi()) {
3028 return;
3029 }
3030 if (listener_ != nullptr) {
3031 // Let listener know ui intensive bugreport dumps are finished, then it can do event
3032 // handling if required.
Paul Chang5702b482020-05-28 22:05:47 +08003033 listener_->onUiIntensiveBugreportDumpsFinished();
Paul Changc490e662020-04-11 18:14:09 +08003034 }
3035}
3036
Jichao Lie89d9c12019-11-21 19:02:51 -08003037void Dumpstate::MaybeCheckUserConsent(int32_t calling_uid, const std::string& calling_package) {
3038 if (calling_uid == AID_SHELL || !CalledByApi()) {
3039 // No need to get consent for shell triggered dumpstates, or not through
3040 // bugreporting API (i.e. no fd to copy back).
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003041 return;
3042 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003043 consent_callback_ = new ConsentCallback();
3044 const String16 incidentcompanion("incidentcompanion");
3045 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
Jichao Lie89d9c12019-11-21 19:02:51 -08003046 android::String16 package(calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003047 if (ics != nullptr) {
3048 MYLOGD("Checking user consent via incidentcompanion service\n");
3049 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
Jichao Lie89d9c12019-11-21 19:02:51 -08003050 calling_uid, package, String16(), String16(),
Joe Onorato1c36d752019-03-17 18:26:43 -07003051 0x1 /* FLAG_CONFIRMATION_DIALOG */, consent_callback_.get());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003052 } else {
3053 MYLOGD("Unable to check user consent; incidentcompanion service unavailable\n");
3054 }
3055}
3056
Nandana Dutt5c390032019-03-12 10:52:56 +00003057bool Dumpstate::IsUserConsentDenied() const {
3058 return ds.consent_callback_ != nullptr &&
3059 ds.consent_callback_->getResult() == UserConsentResult::DENIED;
3060}
3061
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01003062bool Dumpstate::CalledByApi() const {
3063 return ds.options_->bugreport_fd.get() != -1 ? true : false;
3064}
3065
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003066void Dumpstate::CleanupTmpFiles() {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003067 android::os::UnlinkAndLogOnError(tmp_path_);
3068 android::os::UnlinkAndLogOnError(screenshot_path_);
3069 android::os::UnlinkAndLogOnError(path_);
3070}
3071
Rhed Jao1c855122020-07-16 17:37:39 +08003072void Dumpstate::EnableParallelRunIfNeeded() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003073 if (!PropertiesHelper::IsParallelRun()) {
Rhed Jao1c855122020-07-16 17:37:39 +08003074 return;
3075 }
3076 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao4875aa62020-07-20 17:46:29 +08003077 zip_entry_tasks_ = std::make_unique<TaskQueue>();
Rhed Jao1c855122020-07-16 17:37:39 +08003078}
3079
3080void Dumpstate::ShutdownDumpPool() {
3081 if (dump_pool_) {
3082 dump_pool_->shutdown();
3083 dump_pool_ = nullptr;
3084 }
Rhed Jao4875aa62020-07-20 17:46:29 +08003085 if (zip_entry_tasks_) {
3086 zip_entry_tasks_->run(/* do_cancel = */true);
3087 zip_entry_tasks_ = nullptr;
3088 }
3089}
3090
3091void Dumpstate::EnqueueAddZipEntryAndCleanupIfNeeded(const std::string& entry_name,
3092 const std::string& entry_path) {
3093 auto func_add_zip_entry_and_cleanup = [=](bool task_cancelled) {
3094 if (!task_cancelled) {
3095 AddZipEntry(entry_name, entry_path);
3096 }
3097 android::os::UnlinkAndLogOnError(entry_path);
3098 };
3099 if (zip_entry_tasks_) {
3100 // Enqueues AddZipEntryAndCleanup function if the parallel run is enabled.
3101 zip_entry_tasks_->add(func_add_zip_entry_and_cleanup, _1);
3102 } else {
3103 // Invokes AddZipEntryAndCleanup immediately
3104 std::invoke(func_add_zip_entry_and_cleanup, /* task_cancelled = */false);
3105 }
Rhed Jao1c855122020-07-16 17:37:39 +08003106}
3107
Nandana Duttd2f5f082019-01-18 17:13:52 +00003108Dumpstate::RunStatus Dumpstate::HandleUserConsentDenied() {
3109 MYLOGD("User denied consent; deleting files and returning\n");
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003110 CleanupTmpFiles();
Nandana Duttd2f5f082019-01-18 17:13:52 +00003111 return USER_CONSENT_DENIED;
3112}
3113
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003114Dumpstate::RunStatus Dumpstate::CopyBugreportIfUserConsented(int32_t calling_uid) {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003115 // If the caller has asked to copy the bugreport over to their directory, we need explicit
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003116 // user consent (unless the caller is Shell).
3117 UserConsentResult consent_result;
3118 if (calling_uid == AID_SHELL) {
3119 consent_result = UserConsentResult::APPROVED;
3120 } else {
3121 consent_result = consent_callback_->getResult();
3122 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003123 if (consent_result == UserConsentResult::UNAVAILABLE) {
3124 // User has not responded yet.
3125 uint64_t elapsed_ms = consent_callback_->getElapsedTimeMs();
Hunter Knepshield70610fa2020-01-03 15:27:33 -08003126 // Telephony is a fast report type, particularly on user builds where information may be
3127 // more aggressively limited. To give the user time to read the consent dialog, increase the
3128 // timeout.
3129 uint64_t timeout_ms = options_->telephony_only ? TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS
3130 : USER_CONSENT_TIMEOUT_MS;
3131 if (elapsed_ms < timeout_ms) {
3132 uint delay_seconds = (timeout_ms - elapsed_ms) / 1000;
Nandana Duttd2f5f082019-01-18 17:13:52 +00003133 MYLOGD("Did not receive user consent yet; going to wait for %d seconds", delay_seconds);
3134 sleep(delay_seconds);
3135 }
3136 consent_result = consent_callback_->getResult();
3137 }
3138 if (consent_result == UserConsentResult::DENIED) {
3139 // User has explicitly denied sharing with the app. To be safe delete the
3140 // internal bugreport & tmp files.
3141 return HandleUserConsentDenied();
3142 }
3143 if (consent_result == UserConsentResult::APPROVED) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00003144 bool copy_succeeded = android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
3145 if (copy_succeeded) {
3146 android::os::UnlinkAndLogOnError(path_);
Abhijeet Kaur9ce94672020-04-01 17:22:36 +01003147 if (options_->do_screenshot &&
3148 options_->screenshot_fd.get() != -1 &&
3149 !options_->is_screenshot_copied) {
3150 copy_succeeded = android::os::CopyFileToFd(screenshot_path_,
3151 options_->screenshot_fd.get());
3152 options_->is_screenshot_copied = copy_succeeded;
3153 if (copy_succeeded) {
3154 android::os::UnlinkAndLogOnError(screenshot_path_);
3155 }
3156 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003157 }
3158 return copy_succeeded ? Dumpstate::RunStatus::OK : Dumpstate::RunStatus::ERROR;
3159 } else if (consent_result == UserConsentResult::UNAVAILABLE) {
3160 // consent_result is still UNAVAILABLE. The user has likely not responded yet.
3161 // Since we do not have user consent to share the bugreport it does not get
3162 // copied over to the calling app but remains in the internal directory from
3163 // where the user can manually pull it.
3164 return Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT;
3165 }
3166 // Unknown result; must be a programming error.
3167 MYLOGE("Unknown user consent result:%d\n", consent_result);
3168 return Dumpstate::RunStatus::ERROR;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003169}
3170
Nandana Duttf02564e2019-02-15 15:24:24 +00003171Dumpstate::RunStatus Dumpstate::ParseCommandlineAndRun(int argc, char* argv[]) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003172 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
3173 Dumpstate::RunStatus status = options->Initialize(argc, argv);
3174 if (status == Dumpstate::RunStatus::OK) {
Nandana Duttf02564e2019-02-15 15:24:24 +00003175 SetOptions(std::move(options));
Nandana Duttd2f5f082019-01-18 17:13:52 +00003176 // When directly running dumpstate binary, the output is not expected to be written
3177 // to any external file descriptor.
Nandana Duttf02564e2019-02-15 15:24:24 +00003178 assert(options_->bugreport_fd.get() == -1);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003179
3180 // calling_uid and calling_package are for user consent to share the bugreport with
Abhijeet Kaura407fb82020-03-27 12:51:12 +00003181 // an app; they are irrelevant here because bugreport is triggered via command line.
3182 // Update Last ID before calling Run().
3183 Initialize();
Nandana Duttf02564e2019-02-15 15:24:24 +00003184 status = Run(-1 /* calling_uid */, "" /* calling_package */);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003185 }
Nandana Duttf02564e2019-02-15 15:24:24 +00003186 return status;
3187}
3188
3189/* Main entry point for dumpstate binary. */
3190int run_main(int argc, char* argv[]) {
3191 Dumpstate::RunStatus status = ds.ParseCommandlineAndRun(argc, argv);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003192
3193 switch (status) {
3194 case Dumpstate::RunStatus::OK:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003195 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003196 case Dumpstate::RunStatus::HELP:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003197 ShowUsage();
3198 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003199 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003200 fprintf(stderr, "Invalid combination of args\n");
3201 ShowUsage();
3202 exit(1);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003203 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00003204 FALLTHROUGH_INTENDED;
3205 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
3206 FALLTHROUGH_INTENDED;
3207 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003208 exit(2);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003209 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003210}
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003211
3212// TODO(111441001): Default DumpOptions to sensible values.
3213Dumpstate::Dumpstate(const std::string& version)
3214 : pid_(getpid()),
3215 options_(new Dumpstate::DumpOptions()),
Nandana Duttf02cd782019-06-14 14:25:13 +01003216 last_reported_percent_progress_(0),
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003217 version_(version),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003218 now_(time(nullptr)),
3219 open_socket_fn_(open_socket) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003220}
3221
3222Dumpstate& Dumpstate::GetInstance() {
3223 static Dumpstate singleton_(android::base::GetProperty("dumpstate.version", VERSION_CURRENT));
3224 return singleton_;
3225}
3226
Rhed Jao1c855122020-07-16 17:37:39 +08003227DurationReporter::DurationReporter(const std::string& title, bool logcat_only, bool verbose,
3228 int duration_fd) : title_(title), logcat_only_(logcat_only), verbose_(verbose),
3229 duration_fd_(duration_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003230 if (!title_.empty()) {
3231 started_ = Nanotime();
3232 }
3233}
3234
3235DurationReporter::~DurationReporter() {
3236 if (!title_.empty()) {
3237 float elapsed = (float)(Nanotime() - started_) / NANOS_PER_SEC;
chenqiwuaf8b2d92019-12-12 18:53:51 +08003238 if (elapsed >= .5f || verbose_) {
3239 MYLOGD("Duration of '%s': %.2fs\n", title_.c_str(), elapsed);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003240 }
chenqiwuaf8b2d92019-12-12 18:53:51 +08003241 if (!logcat_only_) {
3242 // Use "Yoda grammar" to make it easier to grep|sort sections.
Rhed Jao1c855122020-07-16 17:37:39 +08003243 dprintf(duration_fd_, "------ %.3fs was the duration of '%s' ------\n",
3244 elapsed, title_.c_str());
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003245 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003246 }
3247}
3248
3249const int32_t Progress::kDefaultMax = 5000;
3250
3251Progress::Progress(const std::string& path) : Progress(Progress::kDefaultMax, 1.1, path) {
3252}
3253
3254Progress::Progress(int32_t initial_max, int32_t progress, float growth_factor)
3255 : Progress(initial_max, growth_factor, "") {
3256 progress_ = progress;
3257}
3258
3259Progress::Progress(int32_t initial_max, float growth_factor, const std::string& path)
3260 : initial_max_(initial_max),
3261 progress_(0),
3262 max_(initial_max),
3263 growth_factor_(growth_factor),
3264 n_runs_(0),
3265 average_max_(0),
3266 path_(path) {
3267 if (!path_.empty()) {
3268 Load();
3269 }
3270}
3271
3272void Progress::Load() {
3273 MYLOGD("Loading stats from %s\n", path_.c_str());
3274 std::string content;
3275 if (!android::base::ReadFileToString(path_, &content)) {
3276 MYLOGI("Could not read stats from %s; using max of %d\n", path_.c_str(), max_);
3277 return;
3278 }
3279 if (content.empty()) {
3280 MYLOGE("No stats (empty file) on %s; using max of %d\n", path_.c_str(), max_);
3281 return;
3282 }
3283 std::vector<std::string> lines = android::base::Split(content, "\n");
3284
3285 if (lines.size() < 1) {
3286 MYLOGE("Invalid stats on file %s: not enough lines (%d). Using max of %d\n", path_.c_str(),
3287 (int)lines.size(), max_);
3288 return;
3289 }
3290 char* ptr;
3291 n_runs_ = strtol(lines[0].c_str(), &ptr, 10);
3292 average_max_ = strtol(ptr, nullptr, 10);
3293 if (n_runs_ <= 0 || average_max_ <= 0 || n_runs_ > STATS_MAX_N_RUNS ||
3294 average_max_ > STATS_MAX_AVERAGE) {
3295 MYLOGE("Invalid stats line on file %s: %s\n", path_.c_str(), lines[0].c_str());
3296 initial_max_ = Progress::kDefaultMax;
3297 } else {
3298 initial_max_ = average_max_;
3299 }
3300 max_ = initial_max_;
3301
3302 MYLOGI("Average max progress: %d in %d runs; estimated max: %d\n", average_max_, n_runs_, max_);
3303}
3304
3305void Progress::Save() {
3306 int32_t total = n_runs_ * average_max_ + progress_;
3307 int32_t runs = n_runs_ + 1;
3308 int32_t average = floor(((float)total) / runs);
3309 MYLOGI("Saving stats (total=%d, runs=%d, average=%d) on %s\n", total, runs, average,
3310 path_.c_str());
3311 if (path_.empty()) {
3312 return;
3313 }
3314
3315 std::string content = android::base::StringPrintf("%d %d\n", runs, average);
3316 if (!android::base::WriteStringToFile(content, path_)) {
3317 MYLOGE("Could not save stats on %s\n", path_.c_str());
3318 }
3319}
3320
3321int32_t Progress::Get() const {
3322 return progress_;
3323}
3324
3325bool Progress::Inc(int32_t delta_sec) {
3326 bool changed = false;
3327 if (delta_sec >= 0) {
3328 progress_ += delta_sec;
3329 if (progress_ > max_) {
3330 int32_t old_max = max_;
3331 max_ = floor((float)progress_ * growth_factor_);
3332 MYLOGD("Adjusting max progress from %d to %d\n", old_max, max_);
3333 changed = true;
3334 }
3335 }
3336 return changed;
3337}
3338
3339int32_t Progress::GetMax() const {
3340 return max_;
3341}
3342
3343int32_t Progress::GetInitialMax() const {
3344 return initial_max_;
3345}
3346
3347void Progress::Dump(int fd, const std::string& prefix) const {
3348 const char* pr = prefix.c_str();
3349 dprintf(fd, "%sprogress: %d\n", pr, progress_);
3350 dprintf(fd, "%smax: %d\n", pr, max_);
3351 dprintf(fd, "%sinitial_max: %d\n", pr, initial_max_);
3352 dprintf(fd, "%sgrowth_factor: %0.2f\n", pr, growth_factor_);
3353 dprintf(fd, "%spath: %s\n", pr, path_.c_str());
3354 dprintf(fd, "%sn_runs: %d\n", pr, n_runs_);
3355 dprintf(fd, "%saverage_max: %d\n", pr, average_max_);
3356}
3357
3358bool Dumpstate::IsZipping() const {
3359 return zip_writer_ != nullptr;
3360}
3361
3362std::string Dumpstate::GetPath(const std::string& suffix) const {
3363 return GetPath(bugreport_internal_dir_, suffix);
3364}
3365
3366std::string Dumpstate::GetPath(const std::string& directory, const std::string& suffix) const {
3367 return android::base::StringPrintf("%s/%s-%s%s", directory.c_str(), base_name_.c_str(),
3368 name_.c_str(), suffix.c_str());
3369}
3370
3371void Dumpstate::SetProgress(std::unique_ptr<Progress> progress) {
3372 progress_ = std::move(progress);
3373}
3374
3375void for_each_userid(void (*func)(int), const char *header) {
3376 std::string title = header == nullptr ? "for_each_userid" : android::base::StringPrintf(
3377 "for_each_userid(%s)", header);
3378 DurationReporter duration_reporter(title);
3379 if (PropertiesHelper::IsDryRun()) return;
3380
3381 DIR *d;
3382 struct dirent *de;
3383
3384 if (header) printf("\n------ %s ------\n", header);
3385 func(0);
3386
3387 if (!(d = opendir("/data/system/users"))) {
3388 printf("Failed to open /data/system/users (%s)\n", strerror(errno));
3389 return;
3390 }
3391
3392 while ((de = readdir(d))) {
3393 int userid;
3394 if (de->d_type != DT_DIR || !(userid = atoi(de->d_name))) {
3395 continue;
3396 }
3397 func(userid);
3398 }
3399
3400 closedir(d);
3401}
3402
3403static void __for_each_pid(void (*helper)(int, const char *, void *), const char *header, void *arg) {
3404 DIR *d;
3405 struct dirent *de;
3406
3407 if (!(d = opendir("/proc"))) {
3408 printf("Failed to open /proc (%s)\n", strerror(errno));
3409 return;
3410 }
3411
3412 if (header) printf("\n------ %s ------\n", header);
3413 while ((de = readdir(d))) {
3414 if (ds.IsUserConsentDenied()) {
3415 MYLOGE(
3416 "Returning early because user denied consent to share bugreport with calling app.");
3417 closedir(d);
3418 return;
3419 }
3420 int pid;
3421 int fd;
3422 char cmdpath[255];
3423 char cmdline[255];
3424
3425 if (!(pid = atoi(de->d_name))) {
3426 continue;
3427 }
3428
3429 memset(cmdline, 0, sizeof(cmdline));
3430
3431 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/cmdline", pid);
3432 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3433 TEMP_FAILURE_RETRY(read(fd, cmdline, sizeof(cmdline) - 2));
3434 close(fd);
3435 if (cmdline[0]) {
3436 helper(pid, cmdline, arg);
3437 continue;
3438 }
3439 }
3440
3441 // if no cmdline, a kernel thread has comm
3442 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/comm", pid);
3443 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3444 TEMP_FAILURE_RETRY(read(fd, cmdline + 1, sizeof(cmdline) - 4));
3445 close(fd);
3446 if (cmdline[1]) {
3447 cmdline[0] = '[';
3448 size_t len = strcspn(cmdline, "\f\b\r\n");
3449 cmdline[len] = ']';
3450 cmdline[len+1] = '\0';
3451 }
3452 }
3453 if (!cmdline[0]) {
3454 strcpy(cmdline, "N/A");
3455 }
3456 helper(pid, cmdline, arg);
3457 }
3458
3459 closedir(d);
3460}
3461
3462static void for_each_pid_helper(int pid, const char *cmdline, void *arg) {
3463 for_each_pid_func *func = (for_each_pid_func*) arg;
3464 func(pid, cmdline);
3465}
3466
3467void for_each_pid(for_each_pid_func func, const char *header) {
3468 std::string title = header == nullptr ? "for_each_pid"
3469 : android::base::StringPrintf("for_each_pid(%s)", header);
3470 DurationReporter duration_reporter(title);
3471 if (PropertiesHelper::IsDryRun()) return;
3472
3473 __for_each_pid(for_each_pid_helper, header, (void *) func);
3474}
3475
3476static void for_each_tid_helper(int pid, const char *cmdline, void *arg) {
3477 DIR *d;
3478 struct dirent *de;
3479 char taskpath[255];
3480 for_each_tid_func *func = (for_each_tid_func *) arg;
3481
3482 snprintf(taskpath, sizeof(taskpath), "/proc/%d/task", pid);
3483
3484 if (!(d = opendir(taskpath))) {
3485 printf("Failed to open %s (%s)\n", taskpath, strerror(errno));
3486 return;
3487 }
3488
3489 func(pid, pid, cmdline);
3490
3491 while ((de = readdir(d))) {
3492 if (ds.IsUserConsentDenied()) {
3493 MYLOGE(
3494 "Returning early because user denied consent to share bugreport with calling app.");
3495 closedir(d);
3496 return;
3497 }
3498 int tid;
3499 int fd;
3500 char commpath[255];
3501 char comm[255];
3502
3503 if (!(tid = atoi(de->d_name))) {
3504 continue;
3505 }
3506
3507 if (tid == pid)
3508 continue;
3509
3510 snprintf(commpath, sizeof(commpath), "/proc/%d/comm", tid);
3511 memset(comm, 0, sizeof(comm));
3512 if ((fd = TEMP_FAILURE_RETRY(open(commpath, O_RDONLY | O_CLOEXEC))) < 0) {
3513 strcpy(comm, "N/A");
3514 } else {
3515 char *c;
3516 TEMP_FAILURE_RETRY(read(fd, comm, sizeof(comm) - 2));
3517 close(fd);
3518
3519 c = strrchr(comm, '\n');
3520 if (c) {
3521 *c = '\0';
3522 }
3523 }
3524 func(pid, tid, comm);
3525 }
3526
3527 closedir(d);
3528}
3529
3530void for_each_tid(for_each_tid_func func, const char *header) {
3531 std::string title = header == nullptr ? "for_each_tid"
3532 : android::base::StringPrintf("for_each_tid(%s)", header);
3533 DurationReporter duration_reporter(title);
3534
3535 if (PropertiesHelper::IsDryRun()) return;
3536
3537 __for_each_pid(for_each_tid_helper, header, (void *) func);
3538}
3539
3540void show_wchan(int pid, int tid, const char *name) {
3541 if (PropertiesHelper::IsDryRun()) return;
3542
3543 char path[255];
3544 char buffer[255];
3545 int fd, ret, save_errno;
3546 char name_buffer[255];
3547
3548 memset(buffer, 0, sizeof(buffer));
3549
3550 snprintf(path, sizeof(path), "/proc/%d/wchan", tid);
3551 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3552 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3553 return;
3554 }
3555
3556 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3557 save_errno = errno;
3558 close(fd);
3559
3560 if (ret < 0) {
3561 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3562 return;
3563 }
3564
3565 snprintf(name_buffer, sizeof(name_buffer), "%*s%s",
3566 pid == tid ? 0 : 3, "", name);
3567
3568 printf("%-7d %-32s %s\n", tid, name_buffer, buffer);
3569
3570 return;
3571}
3572
3573// print time in centiseconds
3574static void snprcent(char *buffer, size_t len, size_t spc,
3575 unsigned long long time) {
3576 static long hz; // cache discovered hz
3577
3578 if (hz <= 0) {
3579 hz = sysconf(_SC_CLK_TCK);
3580 if (hz <= 0) {
3581 hz = 1000;
3582 }
3583 }
3584
3585 // convert to centiseconds
3586 time = (time * 100 + (hz / 2)) / hz;
3587
3588 char str[16];
3589
3590 snprintf(str, sizeof(str), " %llu.%02u",
3591 time / 100, (unsigned)(time % 100));
3592 size_t offset = strlen(buffer);
3593 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3594 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3595}
3596
3597// print permille as a percent
3598static void snprdec(char *buffer, size_t len, size_t spc, unsigned permille) {
3599 char str[16];
3600
3601 snprintf(str, sizeof(str), " %u.%u%%", permille / 10, permille % 10);
3602 size_t offset = strlen(buffer);
3603 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3604 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3605}
3606
3607void show_showtime(int pid, const char *name) {
3608 if (PropertiesHelper::IsDryRun()) return;
3609
3610 char path[255];
3611 char buffer[1023];
3612 int fd, ret, save_errno;
3613
3614 memset(buffer, 0, sizeof(buffer));
3615
3616 snprintf(path, sizeof(path), "/proc/%d/stat", pid);
3617 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3618 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3619 return;
3620 }
3621
3622 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3623 save_errno = errno;
3624 close(fd);
3625
3626 if (ret < 0) {
3627 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3628 return;
3629 }
3630
3631 // field 14 is utime
3632 // field 15 is stime
3633 // field 42 is iotime
3634 unsigned long long utime = 0, stime = 0, iotime = 0;
3635 if (sscanf(buffer,
3636 "%*u %*s %*s %*d %*d %*d %*d %*d %*d %*d %*d "
3637 "%*d %*d %llu %llu %*d %*d %*d %*d %*d %*d "
3638 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %*d "
3639 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %llu ",
3640 &utime, &stime, &iotime) != 3) {
3641 return;
3642 }
3643
3644 unsigned long long total = utime + stime;
3645 if (!total) {
3646 return;
3647 }
3648
3649 unsigned permille = (iotime * 1000 + (total / 2)) / total;
3650 if (permille > 1000) {
3651 permille = 1000;
3652 }
3653
3654 // try to beautify and stabilize columns at <80 characters
3655 snprintf(buffer, sizeof(buffer), "%-6d%s", pid, name);
3656 if ((name[0] != '[') || utime) {
3657 snprcent(buffer, sizeof(buffer), 57, utime);
3658 }
3659 snprcent(buffer, sizeof(buffer), 65, stime);
3660 if ((name[0] != '[') || iotime) {
3661 snprcent(buffer, sizeof(buffer), 73, iotime);
3662 }
3663 if (iotime) {
3664 snprdec(buffer, sizeof(buffer), 79, permille);
3665 }
3666 puts(buffer); // adds a trailing newline
3667
3668 return;
3669}
3670
3671void do_dmesg() {
3672 const char *title = "KERNEL LOG (dmesg)";
3673 DurationReporter duration_reporter(title);
3674 printf("------ %s ------\n", title);
3675
3676 if (PropertiesHelper::IsDryRun()) return;
3677
3678 /* Get size of kernel buffer */
3679 int size = klogctl(KLOG_SIZE_BUFFER, nullptr, 0);
3680 if (size <= 0) {
3681 printf("Unexpected klogctl return value: %d\n\n", size);
3682 return;
3683 }
3684 char *buf = (char *) malloc(size + 1);
3685 if (buf == nullptr) {
3686 printf("memory allocation failed\n\n");
3687 return;
3688 }
3689 int retval = klogctl(KLOG_READ_ALL, buf, size);
3690 if (retval < 0) {
3691 printf("klogctl failure\n\n");
3692 free(buf);
3693 return;
3694 }
3695 buf[retval] = '\0';
3696 printf("%s\n\n", buf);
3697 free(buf);
3698 return;
3699}
3700
3701void do_showmap(int pid, const char *name) {
3702 char title[255];
3703 char arg[255];
3704
3705 snprintf(title, sizeof(title), "SHOW MAP %d (%s)", pid, name);
3706 snprintf(arg, sizeof(arg), "%d", pid);
3707 RunCommand(title, {"showmap", "-q", arg}, CommandOptions::AS_ROOT);
3708}
3709
3710int Dumpstate::DumpFile(const std::string& title, const std::string& path) {
3711 DurationReporter duration_reporter(title);
3712
3713 int status = DumpFileToFd(STDOUT_FILENO, title, path);
3714
3715 UpdateProgress(WEIGHT_FILE);
3716
3717 return status;
3718}
3719
3720int read_file_as_long(const char *path, long int *output) {
3721 int fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC));
3722 if (fd < 0) {
3723 int err = errno;
3724 MYLOGE("Error opening file descriptor for %s: %s\n", path, strerror(err));
3725 return -1;
3726 }
3727 char buffer[50];
3728 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3729 if (bytes_read == -1) {
3730 MYLOGE("Error reading file %s: %s\n", path, strerror(errno));
3731 return -2;
3732 }
3733 if (bytes_read == 0) {
3734 MYLOGE("File %s is empty\n", path);
3735 return -3;
3736 }
3737 *output = atoi(buffer);
3738 return 0;
3739}
3740
3741/* calls skip to gate calling dump_from_fd recursively
3742 * in the specified directory. dump_from_fd defaults to
3743 * dump_file_from_fd above when set to NULL. skip defaults
3744 * to false when set to NULL. dump_from_fd will always be
3745 * called with title NULL.
3746 */
3747int dump_files(const std::string& title, const char* dir, bool (*skip)(const char* path),
3748 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
3749 DurationReporter duration_reporter(title);
3750 DIR *dirp;
3751 struct dirent *d;
3752 char *newpath = nullptr;
3753 const char *slash = "/";
3754 int retval = 0;
3755
3756 if (!title.empty()) {
3757 printf("------ %s (%s) ------\n", title.c_str(), dir);
3758 }
3759 if (PropertiesHelper::IsDryRun()) return 0;
3760
3761 if (dir[strlen(dir) - 1] == '/') {
3762 ++slash;
3763 }
3764 dirp = opendir(dir);
3765 if (dirp == nullptr) {
3766 retval = -errno;
3767 MYLOGE("%s: %s\n", dir, strerror(errno));
3768 return retval;
3769 }
3770
3771 if (!dump_from_fd) {
3772 dump_from_fd = dump_file_from_fd;
3773 }
3774 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
3775 if ((d->d_name[0] == '.')
3776 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
3777 || (d->d_name[1] == '\0'))) {
3778 continue;
3779 }
3780 asprintf(&newpath, "%s%s%s%s", dir, slash, d->d_name,
3781 (d->d_type == DT_DIR) ? "/" : "");
3782 if (!newpath) {
3783 retval = -errno;
3784 continue;
3785 }
3786 if (skip && (*skip)(newpath)) {
3787 continue;
3788 }
3789 if (d->d_type == DT_DIR) {
3790 int ret = dump_files("", newpath, skip, dump_from_fd);
3791 if (ret < 0) {
3792 retval = ret;
3793 }
3794 continue;
3795 }
3796 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(newpath, O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
3797 if (fd.get() < 0) {
3798 retval = -1;
3799 printf("*** %s: %s\n", newpath, strerror(errno));
3800 continue;
3801 }
3802 (*dump_from_fd)(nullptr, newpath, fd.get());
3803 }
3804 closedir(dirp);
3805 if (!title.empty()) {
3806 printf("\n");
3807 }
3808 return retval;
3809}
3810
3811/* fd must have been opened with the flag O_NONBLOCK. With this flag set,
3812 * it's possible to avoid issues where opening the file itself can get
3813 * stuck.
3814 */
3815int dump_file_from_fd(const char *title, const char *path, int fd) {
3816 if (PropertiesHelper::IsDryRun()) return 0;
3817
3818 int flags = fcntl(fd, F_GETFL);
3819 if (flags == -1) {
3820 printf("*** %s: failed to get flags on fd %d: %s\n", path, fd, strerror(errno));
3821 return -1;
3822 } else if (!(flags & O_NONBLOCK)) {
3823 printf("*** %s: fd must have O_NONBLOCK set.\n", path);
3824 return -1;
3825 }
3826 return DumpFileFromFdToFd(title, path, fd, STDOUT_FILENO, PropertiesHelper::IsDryRun());
3827}
3828
3829int Dumpstate::RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Rhed Jao4875aa62020-07-20 17:46:29 +08003830 const CommandOptions& options, bool verbose_duration, int out_fd) {
3831 DurationReporter duration_reporter(title, false /* logcat_only */,
3832 verbose_duration, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003833
Rhed Jao4875aa62020-07-20 17:46:29 +08003834 int status = RunCommandToFd(out_fd, title, full_command, options);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003835
3836 /* TODO: for now we're simplifying the progress calculation by using the
3837 * timeout as the weight. It's a good approximation for most cases, except when calling dumpsys,
3838 * where its weight should be much higher proportionally to its timeout.
3839 * Ideally, it should use a options.EstimatedDuration() instead...*/
3840 UpdateProgress(options.Timeout());
3841
3842 return status;
3843}
3844
3845void Dumpstate::RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsys_args,
Rhed Jao6b1ea2d2020-07-21 17:58:41 +08003846 const CommandOptions& options, long dumpsysTimeoutMs, int out_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003847 long timeout_ms = dumpsysTimeoutMs > 0 ? dumpsysTimeoutMs : options.TimeoutInMs();
3848 std::vector<std::string> dumpsys = {"/system/bin/dumpsys", "-T", std::to_string(timeout_ms)};
3849 dumpsys.insert(dumpsys.end(), dumpsys_args.begin(), dumpsys_args.end());
Rhed Jao6b1ea2d2020-07-21 17:58:41 +08003850 RunCommand(title, dumpsys, options, false, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003851}
3852
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003853static int open_socket(const char* service) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003854 int s = android_get_control_socket(service);
3855 if (s < 0) {
3856 MYLOGE("android_get_control_socket(%s): %s\n", service, strerror(errno));
3857 return -1;
3858 }
3859 fcntl(s, F_SETFD, FD_CLOEXEC);
3860
3861 // Set backlog to 0 to make sure that queue size will be minimum.
3862 // In Linux, because the minimum queue will be 1, connect() will be blocked
3863 // if the other clients already called connect() and the connection request was not accepted.
3864 if (listen(s, 0) < 0) {
3865 MYLOGE("listen(control socket): %s\n", strerror(errno));
3866 return -1;
3867 }
3868
3869 struct sockaddr addr;
3870 socklen_t alen = sizeof(addr);
Abhijeet Kaur2113cae2019-09-13 09:24:15 +01003871 int fd = accept4(s, &addr, &alen, SOCK_CLOEXEC);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003872
3873 // Close socket just after accept(), to make sure that connect() by client will get error
3874 // when the socket is used by the other services.
3875 // There is still a race condition possibility between accept and close, but there is no way
3876 // to close-on-accept atomically.
3877 // See detail; b/123306389#comment25
3878 close(s);
3879
3880 if (fd < 0) {
3881 MYLOGE("accept(control socket): %s\n", strerror(errno));
3882 return -1;
3883 }
3884
3885 return fd;
3886}
3887
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003888// TODO: should call is_valid_output_file and/or be merged into it.
3889void create_parent_dirs(const char *path) {
3890 char *chp = const_cast<char *> (path);
3891
3892 /* skip initial slash */
3893 if (chp[0] == '/')
3894 chp++;
3895
3896 /* create leading directories, if necessary */
3897 struct stat dir_stat;
3898 while (chp && chp[0]) {
3899 chp = strchr(chp, '/');
3900 if (chp) {
3901 *chp = 0;
3902 if (stat(path, &dir_stat) == -1 || !S_ISDIR(dir_stat.st_mode)) {
3903 MYLOGI("Creating directory %s\n", path);
3904 if (mkdir(path, 0770)) { /* drwxrwx--- */
3905 MYLOGE("Unable to create directory %s: %s\n", path, strerror(errno));
3906 } else if (chown(path, AID_SHELL, AID_SHELL)) {
3907 MYLOGE("Unable to change ownership of dir %s: %s\n", path, strerror(errno));
3908 }
3909 }
3910 *chp++ = '/';
3911 }
3912 }
3913}
3914
3915bool _redirect_to_file(FILE* redirect, char* path, int truncate_flag) {
3916 create_parent_dirs(path);
3917
3918 int fd = TEMP_FAILURE_RETRY(open(path,
3919 O_WRONLY | O_CREAT | truncate_flag | O_CLOEXEC | O_NOFOLLOW,
3920 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH));
3921 if (fd < 0) {
3922 MYLOGE("%s: %s\n", path, strerror(errno));
3923 return false;
3924 }
3925
3926 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
3927 close(fd);
3928 return true;
3929}
3930
3931bool redirect_to_file(FILE* redirect, char* path) {
3932 return _redirect_to_file(redirect, path, O_TRUNC);
3933}
3934
3935bool redirect_to_existing_file(FILE* redirect, char* path) {
3936 return _redirect_to_file(redirect, path, O_APPEND);
3937}
3938
3939void dump_route_tables() {
3940 DurationReporter duration_reporter("DUMP ROUTE TABLES");
3941 if (PropertiesHelper::IsDryRun()) return;
3942 const char* const RT_TABLES_PATH = "/data/misc/net/rt_tables";
3943 ds.DumpFile("RT_TABLES", RT_TABLES_PATH);
3944 FILE* fp = fopen(RT_TABLES_PATH, "re");
3945 if (!fp) {
3946 printf("*** %s: %s\n", RT_TABLES_PATH, strerror(errno));
3947 return;
3948 }
3949 char table[16];
3950 // Each line has an integer (the table number), a space, and a string (the table name). We only
3951 // need the table number. It's a 32-bit unsigned number, so max 10 chars. Skip the table name.
3952 // Add a fixed max limit so this doesn't go awry.
3953 for (int i = 0; i < 64 && fscanf(fp, " %10s %*s", table) == 1; ++i) {
3954 RunCommand("ROUTE TABLE IPv4", {"ip", "-4", "route", "show", "table", table});
3955 RunCommand("ROUTE TABLE IPv6", {"ip", "-6", "route", "show", "table", table});
3956 }
3957 fclose(fp);
3958}
3959
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003960void Dumpstate::UpdateProgress(int32_t delta_sec) {
3961 if (progress_ == nullptr) {
3962 MYLOGE("UpdateProgress: progress_ not set\n");
3963 return;
3964 }
Rhed Jao2cc4eec2020-07-21 15:42:55 +08003965 // This function updates progress related members of the dumpstate and reports
3966 // progress percentage to the bugreport client. Since it could be called by
3967 // different dump tasks at the same time if the parallel run is enabled, a
3968 // mutex lock is necessary here to synchronize the call.
3969 std::lock_guard<std::recursive_mutex> lock(mutex_);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003970
3971 // Always update progess so stats can be tuned...
Nandana Duttf02cd782019-06-14 14:25:13 +01003972 progress_->Inc(delta_sec);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003973
3974 // ...but only notifiy listeners when necessary.
3975 if (!options_->do_progress_updates) return;
3976
3977 int progress = progress_->Get();
3978 int max = progress_->GetMax();
Nandana Duttf02cd782019-06-14 14:25:13 +01003979 int percent = 100 * progress / max;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003980
Nandana Duttf02cd782019-06-14 14:25:13 +01003981 if (last_reported_percent_progress_ > 0 && percent <= last_reported_percent_progress_) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003982 return;
3983 }
Nandana Duttf02cd782019-06-14 14:25:13 +01003984 last_reported_percent_progress_ = percent;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003985
3986 if (control_socket_fd_ >= 0) {
3987 dprintf(control_socket_fd_, "PROGRESS:%d/%d\n", progress, max);
3988 fsync(control_socket_fd_);
3989 }
3990
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003991 if (listener_ != nullptr) {
Nandana Dutt235c6672019-11-14 15:22:32 +00003992 if (percent % 10 == 0) {
3993 // We don't want to spam logcat, so only log multiples of 10.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01003994 MYLOGD("Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003995 } else {
3996 // stderr is ignored on normal invocations, but useful when calling
3997 // /system/bin/dumpstate directly for debuggging.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01003998 fprintf(stderr, "Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003999 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004000
4001 listener_->onProgress(percent);
4002 }
4003}
4004
4005void Dumpstate::TakeScreenshot(const std::string& path) {
4006 const std::string& real_path = path.empty() ? screenshot_path_ : path;
4007 int status =
4008 RunCommand("", {"/system/bin/screencap", "-p", real_path},
4009 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
4010 if (status == 0) {
4011 MYLOGD("Screenshot saved on %s\n", real_path.c_str());
4012 } else {
4013 MYLOGE("Failed to take screenshot on %s\n", real_path.c_str());
4014 }
Paul Chang0d2aad72020-02-13 20:04:03 +08004015 if (listener_ != nullptr) {
4016 // Show a visual indication to indicate screenshot is taken via
4017 // IDumpstateListener.onScreenshotTaken()
4018 listener_->onScreenshotTaken(status == 0);
4019 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004020}
4021
4022bool is_dir(const char* pathname) {
4023 struct stat info;
4024 if (stat(pathname, &info) == -1) {
4025 return false;
4026 }
4027 return S_ISDIR(info.st_mode);
4028}
4029
4030time_t get_mtime(int fd, time_t default_mtime) {
4031 struct stat info;
4032 if (fstat(fd, &info) == -1) {
4033 return default_mtime;
4034 }
4035 return info.st_mtime;
4036}