blob: b9dfbe02dfaab8e2a99af9cf009184ed8798fb5b [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>
Vishnu Naire97d6122018-01-18 13:58:56 -080031#include <sys/poll.h>
Christopher Ferris7dc7f322014-07-22 16:08:19 -070032#include <sys/prctl.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070033#include <sys/resource.h>
34#include <sys/stat.h>
35#include <sys/time.h>
36#include <sys/wait.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010037#include <signal.h>
38#include <stdarg.h>
39#include <string.h>
40#include <sys/capability.h>
41#include <sys/inotify.h>
42#include <sys/klog.h>
43#include <time.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070044#include <unistd.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070045
46#include <chrono>
Hridya Valsarajuac582cd2019-08-05 15:39:54 -070047#include <cmath>
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +000048#include <fstream>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070049#include <functional>
50#include <future>
Narayan Kamath8f788292017-05-25 13:20:39 +010051#include <memory>
Hridya Valsarajuac582cd2019-08-05 15:39:54 -070052#include <numeric>
Narayan Kamath8f788292017-05-25 13:20:39 +010053#include <regex>
54#include <set>
55#include <string>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070056#include <utility>
Narayan Kamath8f788292017-05-25 13:20:39 +010057#include <vector>
Colin Crossf45fa6b2012-03-26 12:38:26 -070058
Felipe Leme96c2bbb2016-09-26 09:21:21 -070059#include <android-base/file.h>
60#include <android-base/properties.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070061#include <android-base/scopeguard.h>
Elliott Hughes9dc117c2015-12-07 14:21:50 -080062#include <android-base/stringprintf.h>
Naveen Kalla058e1e82016-10-19 21:38:44 -070063#include <android-base/strings.h>
Andreas Gampeaff68432016-07-18 18:01:27 -070064#include <android-base/unique_fd.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010065#include <android/content/pm/IPackageManagerNative.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080066#include <android/hardware/dumpstate/1.0/IDumpstateDevice.h>
Hunter Knepshield8540faf2020-02-04 19:47:20 -080067#include <android/hardware/dumpstate/1.1/IDumpstateDevice.h>
68#include <android/hardware/dumpstate/1.1/types.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080069#include <android/hidl/manager/1.0/IServiceManager.h>
Nandana Duttd2f5f082019-01-18 17:13:52 +000070#include <android/os/IIncidentCompanion.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010071#include <binder/IServiceManager.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080072#include <cutils/native_handle.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070073#include <cutils/properties.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010074#include <cutils/sockets.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000075#include <debuggerd/client.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080076#include <dumpsys.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000077#include <dumputils/dump_utils.h>
Sahana Raof35ed432019-07-12 10:47:52 +010078#include <hardware_legacy/power.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080079#include <hidl/ServiceManagement.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010080#include <log/log.h>
Tom Cherryf4472f32020-08-05 09:31:17 -070081#include <log/log_read.h>
Felipe Leme75876a22016-10-27 16:31:27 -070082#include <openssl/sha.h>
Mark Salyzyn6c3d90f2016-09-27 14:55:27 -070083#include <private/android_filesystem_config.h>
84#include <private/android_logger.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080085#include <serviceutils/PriorityDumper.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070086#include <utils/StrongPointer.h>
Felipe Lemef0292972016-11-22 13:57:05 -080087#include "DumpstateInternal.h"
Felipe Leme75876a22016-10-27 16:31:27 -070088#include "DumpstateService.h"
Colin Crossf45fa6b2012-03-26 12:38:26 -070089#include "dumpstate.h"
Felipe Leme6e01fa62015-11-11 19:35:14 -080090
Hunter Knepshield8540faf2020-02-04 19:47:20 -080091using IDumpstateDevice_1_0 = ::android::hardware::dumpstate::V1_0::IDumpstateDevice;
92using IDumpstateDevice_1_1 = ::android::hardware::dumpstate::V1_1::IDumpstateDevice;
93using ::android::hardware::dumpstate::V1_1::DumpstateMode;
94using ::android::hardware::dumpstate::V1_1::DumpstateStatus;
95using ::android::hardware::dumpstate::V1_1::toString;
Vishnu Naire97d6122018-01-18 13:58:56 -080096using ::std::literals::chrono_literals::operator""ms;
97using ::std::literals::chrono_literals::operator""s;
Rhed Jao1c855122020-07-16 17:37:39 +080098using ::std::placeholders::_1;
Steven Morelandcb7ef822016-11-29 13:20:37 -080099
Felipe Leme47e9be22016-12-21 15:37:07 -0800100// TODO: remove once moved to namespace
Vishnu Naire97d6122018-01-18 13:58:56 -0800101using android::defaultServiceManager;
102using android::Dumpsys;
103using android::INVALID_OPERATION;
104using android::IServiceManager;
105using android::OK;
106using android::sp;
107using android::status_t;
108using android::String16;
109using android::String8;
110using android::TIMED_OUT;
111using android::UNKNOWN_ERROR;
112using android::Vector;
Nandana Dutt979388e2018-11-30 16:48:55 +0000113using android::base::StringPrintf;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000114using android::os::IDumpstateListener;
Felipe Leme47e9be22016-12-21 15:37:07 -0800115using android::os::dumpstate::CommandOptions;
116using android::os::dumpstate::DumpFileToFd;
Rhed Jao1c855122020-07-16 17:37:39 +0800117using android::os::dumpstate::DumpPool;
Vishnu Naire97d6122018-01-18 13:58:56 -0800118using android::os::dumpstate::PropertiesHelper;
Rhed Jao4875aa62020-07-20 17:46:29 +0800119using android::os::dumpstate::TaskQueue;
Felipe Leme47e9be22016-12-21 15:37:07 -0800120
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100121// Keep in sync with
122// frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
123static const int TRACE_DUMP_TIMEOUT_MS = 10000; // 10 seconds
124
125/* Most simple commands have 10 as timeout, so 5 is a good estimate */
126static const int32_t WEIGHT_FILE = 5;
127
128// TODO: temporary variables and functions used during C++ refactoring
129static Dumpstate& ds = Dumpstate::GetInstance();
130static int RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Nandana Dutt8d945c02019-08-14 13:30:07 +0100131 const CommandOptions& options = CommandOptions::DEFAULT,
Rhed Jao4875aa62020-07-20 17:46:29 +0800132 bool verbose_duration = false, int out_fd = STDOUT_FILENO) {
133 return ds.RunCommand(title, full_command, options, verbose_duration, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100134}
135
136// Reasonable value for max stats.
137static const int STATS_MAX_N_RUNS = 1000;
138static const long STATS_MAX_AVERAGE = 100000;
139
140CommandOptions Dumpstate::DEFAULT_DUMPSYS = CommandOptions::WithTimeout(30).Build();
141
Nandana Duttd2f5f082019-01-18 17:13:52 +0000142typedef Dumpstate::ConsentCallback::ConsentResult UserConsentResult;
143
Colin Crossf45fa6b2012-03-26 12:38:26 -0700144/* read before root is shed */
145static char cmdline_buf[16384] = "(unknown)";
Yi Kong19d5c002018-07-20 13:39:55 -0700146static const char *dump_traces_path = nullptr;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000147static const uint64_t USER_CONSENT_TIMEOUT_MS = 30 * 1000;
Hunter Knepshield70610fa2020-01-03 15:27:33 -0800148// Because telephony reports are significantly faster to collect (< 10 seconds vs. > 2 minutes),
149// it's often the case that they time out far too quickly for consent with such a hefty dialog for
150// the user to read. For telephony reports only, we increase the default timeout to 2 minutes to
151// roughly match full reports' durations.
152static const uint64_t TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS = 2 * 60 * 1000;
Colin Crossf45fa6b2012-03-26 12:38:26 -0700153
Felipe Leme1d486fe2016-10-14 18:06:47 -0700154// TODO: variables and functions below should be part of dumpstate object
155
Felipe Leme635ca312016-01-05 14:23:02 -0800156static std::set<std::string> mount_points;
157void add_mountinfo();
Felipe Leme78f2c862015-12-21 09:55:22 -0800158
Todd Poynor2a83daa2013-11-22 15:44:22 -0800159#define PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops"
Mark Salyzyn7d0a7622016-06-24 14:06:15 -0700160#define ALT_PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops-0"
Wei Wang509bb5d2017-06-09 14:42:12 -0700161#define BLK_DEV_SYS_DIR "/sys/block"
Todd Poynor2a83daa2013-11-22 15:44:22 -0800162
Felipe Lemee82a27d2016-01-05 13:35:44 -0800163#define RECOVERY_DIR "/cache/recovery"
Mark Salyzynd6ab0112016-03-25 12:56:39 -0700164#define RECOVERY_DATA_DIR "/data/misc/recovery"
Tianjie Xu75d53362018-04-11 16:42:28 -0700165#define UPDATE_ENGINE_LOG_DIR "/data/misc/update_engine_log"
Mark Salyzyn4d42dea2016-04-01 10:03:14 -0700166#define LOGPERSIST_DATA_DIR "/data/misc/logd"
Jerry Changa1df8a92020-01-02 16:03:39 +0800167#define PREREBOOT_DATA_DIR "/data/misc/prereboot"
David Brazdild2991962016-06-03 14:40:44 +0100168#define PROFILE_DATA_DIR_CUR "/data/misc/profiles/cur"
169#define PROFILE_DATA_DIR_REF "/data/misc/profiles/ref"
Benedict Wong8f9d8a42019-01-03 16:19:38 -0800170#define XFRM_STAT_PROC_FILE "/proc/net/xfrm_stat"
Erik Kline08165202016-05-30 11:55:44 +0900171#define WLUTIL "/vendor/xbin/wlutil"
Vishnu Nair36b4cdb2017-11-17 10:27:05 -0800172#define WMTRACE_DATA_DIR "/data/misc/wmtrace"
Yifan Hong3945e1b2019-10-29 12:59:23 -0700173#define OTA_METADATA_DIR "/metadata/ota"
Yifan Hong0efa7972020-02-03 16:45:02 -0800174#define SNAPSHOTCTL_LOG_DIR "/data/misc/snapshotctl_log"
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +0900175#define LINKERCONFIG_DIR "/linkerconfig"
Calin Juravle78a0d842020-04-28 15:31:12 -0700176#define PACKAGE_DEX_USE_LIST "/data/system/package-dex-usage.list"
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700177
Narayan Kamath8f788292017-05-25 13:20:39 +0100178// TODO(narayan): Since this information has to be kept in sync
179// with tombstoned, we should just put it in a common header.
180//
181// File: system/core/debuggerd/tombstoned/tombstoned.cpp
Narayan Kamathbd863722017-06-01 18:50:12 +0100182static const std::string TOMBSTONE_DIR = "/data/tombstones/";
183static const std::string TOMBSTONE_FILE_PREFIX = "tombstone_";
184static const std::string ANR_DIR = "/data/anr/";
185static const std::string ANR_FILE_PREFIX = "anr_";
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700186
Felipe Lemee844a9d2016-09-21 15:01:39 -0700187// TODO: temporary variables and functions used during C++ refactoring
Nandana Dutt979388e2018-11-30 16:48:55 +0000188
Nandana Dutt5c390032019-03-12 10:52:56 +0000189#define RETURN_IF_USER_DENIED_CONSENT() \
190 if (ds.IsUserConsentDenied()) { \
191 MYLOGE("Returning early as user denied consent to share bugreport with calling app."); \
192 return Dumpstate::RunStatus::USER_CONSENT_DENIED; \
193 }
194
195// Runs func_ptr, but checks user consent before and after running it. Returns USER_CONSENT_DENIED
196// if consent is found to be denied.
197#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(func_ptr, ...) \
198 RETURN_IF_USER_DENIED_CONSENT(); \
199 func_ptr(__VA_ARGS__); \
200 RETURN_IF_USER_DENIED_CONSENT();
201
Rhed Jao1c855122020-07-16 17:37:39 +0800202// Runs func_ptr, and logs a duration report after it's finished.
203#define RUN_SLOW_FUNCTION_AND_LOG(log_title, func_ptr, ...) \
204 { \
205 DurationReporter duration_reporter_in_macro(log_title); \
206 func_ptr(__VA_ARGS__); \
207 }
208
209// Similar with RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK, an additional duration report
210// is output after a slow function is finished.
211#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(log_title, func_ptr, ...) \
212 RETURN_IF_USER_DENIED_CONSENT(); \
213 RUN_SLOW_FUNCTION_AND_LOG(log_title, func_ptr, __VA_ARGS__); \
214 RETURN_IF_USER_DENIED_CONSENT();
215
Rhed Jao4875aa62020-07-20 17:46:29 +0800216#define WAIT_TASK_WITH_CONSENT_CHECK(task_name, pool_ptr) \
217 RETURN_IF_USER_DENIED_CONSENT(); \
218 pool_ptr->waitForTask(task_name); \
219 RETURN_IF_USER_DENIED_CONSENT();
220
Sahana Raof35ed432019-07-12 10:47:52 +0100221static const char* WAKE_LOCK_NAME = "dumpstate_wakelock";
222
Rhed Jao1c855122020-07-16 17:37:39 +0800223// Names of parallel tasks, they are used for the DumpPool to identify the dump
224// task and the log title of the duration report.
225static const std::string DUMP_TRACES_TASK = "DUMP TRACES";
Rhed Jao4875aa62020-07-20 17:46:29 +0800226static const std::string DUMP_INCIDENT_REPORT_TASK = "INCIDENT REPORT";
227static const std::string DUMP_HALS_TASK = "DUMP HALS";
228static const std::string DUMP_BOARD_TASK = "dumpstate_board()";
Rhed Jao1c855122020-07-16 17:37:39 +0800229
Nandana Dutt979388e2018-11-30 16:48:55 +0000230namespace android {
231namespace os {
232namespace {
233
234static int Open(std::string path, int flags, mode_t mode = 0) {
235 int fd = TEMP_FAILURE_RETRY(open(path.c_str(), flags, mode));
236 if (fd == -1) {
237 MYLOGE("open(%s, %s)\n", path.c_str(), strerror(errno));
238 }
239 return fd;
240}
241
mhasank2d75c442020-06-11 15:05:25 -0700242static int OpenForWrite(std::string path) {
243 return Open(path, O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
244 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH);
245}
Nandana Dutt979388e2018-11-30 16:48:55 +0000246
247static int OpenForRead(std::string path) {
248 return Open(path, O_RDONLY | O_CLOEXEC | O_NOFOLLOW);
249}
250
251bool CopyFile(int in_fd, int out_fd) {
252 char buf[4096];
253 ssize_t byte_count;
254 while ((byte_count = TEMP_FAILURE_RETRY(read(in_fd, buf, sizeof(buf)))) > 0) {
255 if (!android::base::WriteFully(out_fd, buf, byte_count)) {
256 return false;
257 }
258 }
259 return (byte_count != -1);
260}
261
262static bool CopyFileToFd(const std::string& input_file, int out_fd) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000263 MYLOGD("Going to copy file (%s) to %d\n", input_file.c_str(), out_fd);
Nandana Dutt979388e2018-11-30 16:48:55 +0000264
265 // Obtain a handle to the source file.
266 android::base::unique_fd in_fd(OpenForRead(input_file));
267 if (out_fd != -1 && in_fd.get() != -1) {
268 if (CopyFile(in_fd.get(), out_fd)) {
269 return true;
270 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000271 MYLOGE("Failed to copy file: %s\n", strerror(errno));
Nandana Dutt979388e2018-11-30 16:48:55 +0000272 }
273 return false;
274}
275
Nandana Duttd2f5f082019-01-18 17:13:52 +0000276static bool UnlinkAndLogOnError(const std::string& file) {
Nandana Dutt8ae16e62020-03-27 10:20:22 +0000277 if (file.empty()) {
278 return false;
279 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000280 if (unlink(file.c_str())) {
281 MYLOGE("Failed to unlink file (%s): %s\n", file.c_str(), strerror(errno));
Nandana Duttd2f5f082019-01-18 17:13:52 +0000282 return false;
283 }
284 return true;
285}
Nandana Dutt979388e2018-11-30 16:48:55 +0000286
Nikita Ioffea325a572019-05-16 19:49:47 +0100287int64_t GetModuleMetadataVersion() {
288 auto binder = defaultServiceManager()->getService(android::String16("package_native"));
289 if (binder == nullptr) {
290 MYLOGE("Failed to retrieve package_native service");
291 return 0L;
292 }
293 auto package_service = android::interface_cast<content::pm::IPackageManagerNative>(binder);
294 std::string package_name;
295 auto status = package_service->getModuleMetadataPackageName(&package_name);
296 if (!status.isOk()) {
297 MYLOGE("Failed to retrieve module metadata package name: %s", status.toString8().c_str());
298 return 0L;
299 }
Nandana Duttdb379fa2019-10-09 16:54:41 +0100300 MYLOGD("Module metadata package name: %s\n", package_name.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100301 int64_t version_code;
302 status = package_service->getVersionCodeForPackage(android::String16(package_name.c_str()),
303 &version_code);
304 if (!status.isOk()) {
305 MYLOGE("Failed to retrieve module metadata version: %s", status.toString8().c_str());
306 return 0L;
307 }
308 return version_code;
309}
310
mhasank2d75c442020-06-11 15:05:25 -0700311static bool PathExists(const std::string& path) {
312 struct stat sb;
313 return stat(path.c_str(), &sb) == 0;
314}
315
316static bool CopyFileToFile(const std::string& input_file, const std::string& output_file) {
317 if (input_file == output_file) {
318 MYLOGD("Skipping copying bugreport file since the destination is the same (%s)\n",
319 output_file.c_str());
320 return false;
321 }
322 else if (PathExists(output_file)) {
323 MYLOGD("Cannot overwrite an existing file (%s)\n", output_file.c_str());
324 return false;
325 }
326
327 MYLOGD("Going to copy bugreport file (%s) to %s\n", input_file.c_str(), output_file.c_str());
328 android::base::unique_fd out_fd(OpenForWrite(output_file));
329 return CopyFileToFd(input_file, out_fd.get());
330}
331
Nandana Dutt979388e2018-11-30 16:48:55 +0000332} // namespace
333} // namespace os
334} // namespace android
335
Felipe Leme678727a2016-09-21 17:22:11 -0700336static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
Felipe Lemebda15a02016-11-16 17:48:25 -0800337 const CommandOptions& options = Dumpstate::DEFAULT_DUMPSYS,
Vishnu Nair6921f802017-11-22 09:17:23 -0800338 long dumpsysTimeoutMs = 0) {
339 return ds.RunDumpsys(title, dumpsysArgs, options, dumpsysTimeoutMs);
Felipe Leme678727a2016-09-21 17:22:11 -0700340}
341static int DumpFile(const std::string& title, const std::string& path) {
342 return ds.DumpFile(title, path);
343}
Felipe Lemee82a27d2016-01-05 13:35:44 -0800344
Felipe Lemee844a9d2016-09-21 15:01:39 -0700345// Relative directory (inside the zip) for all files copied as-is into the bugreport.
346static const std::string ZIP_ROOT_DIR = "FS";
347
Vishnu Naire97d6122018-01-18 13:58:56 -0800348static const std::string kProtoPath = "proto/";
349static const std::string kProtoExt = ".proto";
Jie Song9fbfad02017-06-20 16:29:42 -0700350static const std::string kDumpstateBoardFiles[] = {
351 "dumpstate_board.txt",
Felipe Leme95d6ca52017-08-01 16:35:56 -0700352 "dumpstate_board.bin"
Jie Song9fbfad02017-06-20 16:29:42 -0700353};
354static const int NUM_OF_DUMPS = arraysize(kDumpstateBoardFiles);
355
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700356static constexpr char PROPERTY_LAST_ID[] = "dumpstate.last_id";
Felipe Lemed071c682016-10-20 16:48:00 -0700357static constexpr char PROPERTY_VERSION[] = "dumpstate.version";
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700358
Felipe Lemef0292972016-11-22 13:57:05 -0800359static const CommandOptions AS_ROOT_20 = CommandOptions::WithTimeout(20).AsRoot().Build();
360
Narayan Kamath8f788292017-05-25 13:20:39 +0100361/*
Narayan Kamathbd863722017-06-01 18:50:12 +0100362 * Returns a vector of dump fds under |dir_path| with a given |file_prefix|.
Rhed Jao01dc0c62020-06-03 17:13:30 +0800363 * The returned vector is sorted by the mtimes of the dumps with descending
364 * order. If |limit_by_mtime| is set, the vector only contains files that
365 * were written in the last 30 minutes.
Narayan Kamath8f788292017-05-25 13:20:39 +0100366 */
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700367static std::vector<DumpData> GetDumpFds(const std::string& dir_path,
368 const std::string& file_prefix,
Elliott Hughesdb6d2112019-09-26 15:24:51 -0700369 bool limit_by_mtime) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100370 const time_t thirty_minutes_ago = ds.now_ - 60 * 30;
371
Narayan Kamathbd863722017-06-01 18:50:12 +0100372 std::unique_ptr<DIR, decltype(&closedir)> dump_dir(opendir(dir_path.c_str()), closedir);
Narayan Kamath8f788292017-05-25 13:20:39 +0100373
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700374 if (dump_dir == nullptr) {
375 MYLOGW("Unable to open directory %s: %s\n", dir_path.c_str(), strerror(errno));
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700376 return std::vector<DumpData>();
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700377 }
378
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700379 std::vector<DumpData> dump_data;
Narayan Kamathbd863722017-06-01 18:50:12 +0100380 struct dirent* entry = nullptr;
381 while ((entry = readdir(dump_dir.get()))) {
382 if (entry->d_type != DT_REG) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100383 continue;
384 }
385
Narayan Kamathbd863722017-06-01 18:50:12 +0100386 const std::string base_name(entry->d_name);
387 if (base_name.find(file_prefix) != 0) {
388 continue;
389 }
390
391 const std::string abs_path = dir_path + base_name;
392 android::base::unique_fd fd(
393 TEMP_FAILURE_RETRY(open(abs_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW | O_NONBLOCK)));
394 if (fd == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700395 MYLOGW("Unable to open dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamathbd863722017-06-01 18:50:12 +0100396 break;
397 }
398
399 struct stat st = {};
400 if (fstat(fd, &st) == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700401 MYLOGW("Unable to stat dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamath8f788292017-05-25 13:20:39 +0100402 continue;
403 }
404
Narayan Kamath3f31b632018-02-22 19:42:36 +0000405 if (limit_by_mtime && st.st_mtime < thirty_minutes_ago) {
Narayan Kamathbd863722017-06-01 18:50:12 +0100406 MYLOGI("Excluding stale dump file: %s\n", abs_path.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100407 continue;
408 }
409
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700410 dump_data.emplace_back(DumpData{abs_path, std::move(fd), st.st_mtime});
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700411 }
Rhed Jao01dc0c62020-06-03 17:13:30 +0800412 if (!dump_data.empty()) {
413 std::sort(dump_data.begin(), dump_data.end(),
414 [](const auto& a, const auto& b) { return a.mtime > b.mtime; });
415 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100416
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700417 return dump_data;
Narayan Kamath8f788292017-05-25 13:20:39 +0100418}
419
Narayan Kamathbd863722017-06-01 18:50:12 +0100420static bool AddDumps(const std::vector<DumpData>::const_iterator start,
421 const std::vector<DumpData>::const_iterator end,
422 const char* type_name, const bool add_to_zip) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100423 bool dumped = false;
Narayan Kamathbd863722017-06-01 18:50:12 +0100424 for (auto it = start; it != end; ++it) {
425 const std::string& name = it->name;
426 const int fd = it->fd;
Narayan Kamath8f788292017-05-25 13:20:39 +0100427 dumped = true;
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100428
429 // Seek to the beginning of the file before dumping any data. A given
430 // DumpData entry might be dumped multiple times in the report.
431 //
432 // For example, the most recent ANR entry is dumped to the body of the
433 // main entry and it also shows up as a separate entry in the bugreport
434 // ZIP file.
435 if (lseek(fd, 0, SEEK_SET) != static_cast<off_t>(0)) {
436 MYLOGE("Unable to add %s to zip file, lseek failed: %s\n", name.c_str(),
437 strerror(errno));
438 }
439
Narayan Kamath8f788292017-05-25 13:20:39 +0100440 if (ds.IsZipping() && add_to_zip) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800441 if (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + name, fd, /* timeout = */ 0ms) != OK) {
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100442 MYLOGE("Unable to add %s to zip file, addZipEntryFromFd failed\n", name.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100443 }
444 } else {
445 dump_file_from_fd(type_name, name.c_str(), fd);
446 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100447 }
448
449 return dumped;
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700450}
451
Felipe Leme635ca312016-01-05 14:23:02 -0800452// for_each_pid() callback to get mount info about a process.
Felipe Leme4c2d6632016-09-28 14:32:00 -0700453void do_mountinfo(int pid, const char* name __attribute__((unused))) {
Felipe Leme635ca312016-01-05 14:23:02 -0800454 char path[PATH_MAX];
455
456 // Gets the the content of the /proc/PID/ns/mnt link, so only unique mount points
457 // are added.
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700458 snprintf(path, sizeof(path), "/proc/%d/ns/mnt", pid);
Felipe Leme635ca312016-01-05 14:23:02 -0800459 char linkname[PATH_MAX];
460 ssize_t r = readlink(path, linkname, PATH_MAX);
461 if (r == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800462 MYLOGE("Unable to read link for %s: %s\n", path, strerror(errno));
Felipe Leme635ca312016-01-05 14:23:02 -0800463 return;
464 }
465 linkname[r] = '\0';
466
467 if (mount_points.find(linkname) == mount_points.end()) {
468 // First time this mount point was found: add it
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700469 snprintf(path, sizeof(path), "/proc/%d/mountinfo", pid);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700470 if (ds.AddZipEntry(ZIP_ROOT_DIR + path, path)) {
Felipe Leme635ca312016-01-05 14:23:02 -0800471 mount_points.insert(linkname);
472 } else {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800473 MYLOGE("Unable to add mountinfo %s to zip file\n", path);
Felipe Leme635ca312016-01-05 14:23:02 -0800474 }
475 }
476}
477
478void add_mountinfo() {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700479 if (!ds.IsZipping()) return;
Felipe Leme678727a2016-09-21 17:22:11 -0700480 std::string title = "MOUNT INFO";
Felipe Leme635ca312016-01-05 14:23:02 -0800481 mount_points.clear();
Felipe Leme46b85da2016-11-21 17:40:45 -0800482 DurationReporter duration_reporter(title, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700483 for_each_pid(do_mountinfo, nullptr);
484 MYLOGD("%s: %d entries added to zip file\n", title.c_str(), (int)mount_points.size());
Felipe Leme635ca312016-01-05 14:23:02 -0800485}
486
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700487static void dump_dev_files(const char *title, const char *driverpath, const char *filename)
488{
489 DIR *d;
490 struct dirent *de;
491 char path[PATH_MAX];
492
493 d = opendir(driverpath);
Yi Kong19d5c002018-07-20 13:39:55 -0700494 if (d == nullptr) {
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700495 return;
496 }
497
498 while ((de = readdir(d))) {
499 if (de->d_type != DT_LNK) {
500 continue;
501 }
502 snprintf(path, sizeof(path), "%s/%s/%s", driverpath, de->d_name, filename);
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700503 DumpFile(title, path);
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700504 }
505
506 closedir(d);
507}
508
Mark Salyzyn326842f2015-04-30 09:49:41 -0700509static bool skip_not_stat(const char *path) {
510 static const char stat[] = "/stat";
511 size_t len = strlen(path);
512 if (path[len - 1] == '/') { /* Directory? */
513 return false;
514 }
515 return strcmp(path + len - sizeof(stat) + 1, stat); /* .../stat? */
516}
517
Felipe Leme4c2d6632016-09-28 14:32:00 -0700518static bool skip_none(const char* path __attribute__((unused))) {
Felipe Lemee82a27d2016-01-05 13:35:44 -0800519 return false;
520}
521
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700522unsigned long worst_write_perf = 20000; /* in KB/s */
Mark Salyzyn326842f2015-04-30 09:49:41 -0700523
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800524//
525// stat offsets
526// Name units description
527// ---- ----- -----------
528// read I/Os requests number of read I/Os processed
529#define __STAT_READ_IOS 0
530// read merges requests number of read I/Os merged with in-queue I/O
531#define __STAT_READ_MERGES 1
532// read sectors sectors number of sectors read
533#define __STAT_READ_SECTORS 2
534// read ticks milliseconds total wait time for read requests
535#define __STAT_READ_TICKS 3
536// write I/Os requests number of write I/Os processed
537#define __STAT_WRITE_IOS 4
538// write merges requests number of write I/Os merged with in-queue I/O
539#define __STAT_WRITE_MERGES 5
540// write sectors sectors number of sectors written
541#define __STAT_WRITE_SECTORS 6
542// write ticks milliseconds total wait time for write requests
543#define __STAT_WRITE_TICKS 7
544// in_flight requests number of I/Os currently in flight
545#define __STAT_IN_FLIGHT 8
546// io_ticks milliseconds total time this block device has been active
547#define __STAT_IO_TICKS 9
548// time_in_queue milliseconds total wait time for all requests
549#define __STAT_IN_QUEUE 10
550#define __STAT_NUMBER_FIELD 11
551//
552// read I/Os, write I/Os
553// =====================
554//
555// These values increment when an I/O request completes.
556//
557// read merges, write merges
558// =========================
559//
560// These values increment when an I/O request is merged with an
561// already-queued I/O request.
562//
563// read sectors, write sectors
564// ===========================
565//
566// These values count the number of sectors read from or written to this
567// block device. The "sectors" in question are the standard UNIX 512-byte
568// sectors, not any device- or filesystem-specific block size. The
569// counters are incremented when the I/O completes.
570#define SECTOR_SIZE 512
571//
572// read ticks, write ticks
573// =======================
574//
575// These values count the number of milliseconds that I/O requests have
576// waited on this block device. If there are multiple I/O requests waiting,
577// these values will increase at a rate greater than 1000/second; for
578// example, if 60 read requests wait for an average of 30 ms, the read_ticks
579// field will increase by 60*30 = 1800.
580//
581// in_flight
582// =========
583//
584// This value counts the number of I/O requests that have been issued to
585// the device driver but have not yet completed. It does not include I/O
586// requests that are in the queue but not yet issued to the device driver.
587//
588// io_ticks
589// ========
590//
591// This value counts the number of milliseconds during which the device has
592// had I/O requests queued.
593//
594// time_in_queue
595// =============
596//
597// This value counts the number of milliseconds that I/O requests have waited
598// on this block device. If there are multiple I/O requests waiting, this
599// value will increase as the product of the number of milliseconds times the
600// number of requests waiting (see "read ticks" above for an example).
601#define S_TO_MS 1000
602//
603
Mark Salyzyn326842f2015-04-30 09:49:41 -0700604static int dump_stat_from_fd(const char *title __unused, const char *path, int fd) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800605 unsigned long long fields[__STAT_NUMBER_FIELD];
Mark Salyzyn326842f2015-04-30 09:49:41 -0700606 bool z;
Yi Kong19d5c002018-07-20 13:39:55 -0700607 char *cp, *buffer = nullptr;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700608 size_t i = 0;
Josh Gao7c4258c2018-06-25 13:40:08 -0700609 FILE *fp = fdopen(dup(fd), "rb");
Mark Salyzyn326842f2015-04-30 09:49:41 -0700610 getline(&buffer, &i, fp);
611 fclose(fp);
612 if (!buffer) {
613 return -errno;
614 }
615 i = strlen(buffer);
616 while ((i > 0) && (buffer[i - 1] == '\n')) {
617 buffer[--i] = '\0';
618 }
619 if (!*buffer) {
620 free(buffer);
621 return 0;
622 }
623 z = true;
624 for (cp = buffer, i = 0; i < (sizeof(fields) / sizeof(fields[0])); ++i) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800625 fields[i] = strtoull(cp, &cp, 10);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700626 if (fields[i] != 0) {
627 z = false;
628 }
629 }
630 if (z) { /* never accessed */
631 free(buffer);
632 return 0;
633 }
634
Wei Wang509bb5d2017-06-09 14:42:12 -0700635 if (!strncmp(path, BLK_DEV_SYS_DIR, sizeof(BLK_DEV_SYS_DIR) - 1)) {
636 path += sizeof(BLK_DEV_SYS_DIR) - 1;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700637 }
Wei Wang1dc1ef52017-06-12 11:28:37 -0700638
639 printf("%-30s:%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s\n%-30s:\t%s\n", "Block-Dev",
640 "R-IOs", "R-merg", "R-sect", "R-wait", "W-IOs", "W-merg", "W-sect",
641 "W-wait", "in-fli", "activ", "T-wait", path, buffer);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700642 free(buffer);
643
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800644 if (fields[__STAT_IO_TICKS]) {
645 unsigned long read_perf = 0;
646 unsigned long read_ios = 0;
647 if (fields[__STAT_READ_TICKS]) {
648 unsigned long long divisor = fields[__STAT_READ_TICKS]
649 * fields[__STAT_IO_TICKS];
650 read_perf = ((unsigned long long)SECTOR_SIZE
651 * fields[__STAT_READ_SECTORS]
652 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
653 / divisor;
654 read_ios = ((unsigned long long)S_TO_MS * fields[__STAT_READ_IOS]
655 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
656 / divisor;
657 }
658
659 unsigned long write_perf = 0;
660 unsigned long write_ios = 0;
661 if (fields[__STAT_WRITE_TICKS]) {
662 unsigned long long divisor = fields[__STAT_WRITE_TICKS]
663 * fields[__STAT_IO_TICKS];
664 write_perf = ((unsigned long long)SECTOR_SIZE
665 * fields[__STAT_WRITE_SECTORS]
666 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
667 / divisor;
668 write_ios = ((unsigned long long)S_TO_MS * fields[__STAT_WRITE_IOS]
669 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
670 / divisor;
671 }
672
673 unsigned queue = (fields[__STAT_IN_QUEUE]
674 + (fields[__STAT_IO_TICKS] >> 1))
675 / fields[__STAT_IO_TICKS];
676
677 if (!write_perf && !write_ios) {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700678 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 -0800679 } else {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700680 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 -0800681 read_ios, write_perf, write_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800682 }
683
684 /* bugreport timeout factor adjustment */
685 if ((write_perf > 1) && (write_perf < worst_write_perf)) {
686 worst_write_perf = write_perf;
687 }
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700688 }
Mark Salyzyn326842f2015-04-30 09:49:41 -0700689 return 0;
690}
691
Yao Chenbe3bbc12018-01-17 16:31:10 -0800692static const long MINIMUM_LOGCAT_TIMEOUT_MS = 50000;
693
Tom Cherryf4472f32020-08-05 09:31:17 -0700694// Returns the actual readable size of the given buffer or -1 on error.
695static long logcat_buffer_readable_size(const std::string& buffer) {
696 std::unique_ptr<logger_list, decltype(&android_logger_list_free)> logger_list{
697 android_logger_list_alloc(0, 0, 0), &android_logger_list_free};
698 auto logger = android_logger_open(logger_list.get(), android_name_to_log_id(buffer.c_str()));
699
700 return android_logger_get_log_readable_size(logger);
701}
702
703// Returns timeout in ms to read a list of buffers.
Yao Chenbe3bbc12018-01-17 16:31:10 -0800704static unsigned long logcat_timeout(const std::vector<std::string>& buffers) {
705 unsigned long timeout_ms = 0;
706 for (const auto& buffer : buffers) {
Tom Cherryf4472f32020-08-05 09:31:17 -0700707 long readable_size = logcat_buffer_readable_size(buffer);
708 if (readable_size > 0) {
709 // Engineering margin is ten-fold our guess.
710 timeout_ms += 10 * (readable_size + worst_write_perf) / worst_write_perf;
711 }
Yao Chenbe3bbc12018-01-17 16:31:10 -0800712 }
713 return timeout_ms > MINIMUM_LOGCAT_TIMEOUT_MS ? timeout_ms : MINIMUM_LOGCAT_TIMEOUT_MS;
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700714}
715
Nandana Duttd2f5f082019-01-18 17:13:52 +0000716Dumpstate::ConsentCallback::ConsentCallback() : result_(UNAVAILABLE), start_time_(Nanotime()) {
717}
718
719android::binder::Status Dumpstate::ConsentCallback::onReportApproved() {
720 std::lock_guard<std::mutex> lock(lock_);
721 result_ = APPROVED;
722 MYLOGD("User approved consent to share bugreport\n");
Paul Chang0d2aad72020-02-13 20:04:03 +0800723
724 // Maybe copy screenshot so calling app can display the screenshot to the user as soon as
725 // consent is granted.
726 if (ds.options_->is_screenshot_copied) {
727 return android::binder::Status::ok();
728 }
729
730 if (!ds.options_->do_screenshot || ds.options_->screenshot_fd.get() == -1 ||
731 !ds.do_early_screenshot_) {
732 return android::binder::Status::ok();
733 }
734
735 bool copy_succeeded = android::os::CopyFileToFd(ds.screenshot_path_,
736 ds.options_->screenshot_fd.get());
737 ds.options_->is_screenshot_copied = copy_succeeded;
738 if (copy_succeeded) {
739 android::os::UnlinkAndLogOnError(ds.screenshot_path_);
740 }
Nandana Duttd2f5f082019-01-18 17:13:52 +0000741 return android::binder::Status::ok();
742}
743
744android::binder::Status Dumpstate::ConsentCallback::onReportDenied() {
745 std::lock_guard<std::mutex> lock(lock_);
746 result_ = DENIED;
747 MYLOGW("User denied consent to share bugreport\n");
748 return android::binder::Status::ok();
749}
750
751UserConsentResult Dumpstate::ConsentCallback::getResult() {
752 std::lock_guard<std::mutex> lock(lock_);
753 return result_;
754}
755
756uint64_t Dumpstate::ConsentCallback::getElapsedTimeMs() const {
Hunter Knepshieldf0a39052020-01-03 14:53:04 -0800757 return (Nanotime() - start_time_) / NANOS_PER_MILLI;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000758}
759
Felipe Leme2b9b06c2016-10-14 09:13:06 -0700760void Dumpstate::PrintHeader() const {
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700761 std::string build, fingerprint, radio, bootloader, network;
762 char date[80];
Colin Crossf45fa6b2012-03-26 12:38:26 -0700763
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700764 build = android::base::GetProperty("ro.build.display.id", "(unknown)");
765 fingerprint = android::base::GetProperty("ro.build.fingerprint", "(unknown)");
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700766 radio = android::base::GetProperty("gsm.version.baseband", "(unknown)");
767 bootloader = android::base::GetProperty("ro.bootloader", "(unknown)");
768 network = android::base::GetProperty("gsm.operator.alpha", "(unknown)");
Felipe Lemebbaf3c12016-10-11 14:32:25 -0700769 strftime(date, sizeof(date), "%Y-%m-%d %H:%M:%S", localtime(&now_));
Colin Crossf45fa6b2012-03-26 12:38:26 -0700770
Felipe Lemed8b94e52016-12-08 10:21:44 -0800771 printf("========================================================\n");
772 printf("== dumpstate: %s\n", date);
773 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -0700774
Felipe Lemed8b94e52016-12-08 10:21:44 -0800775 printf("\n");
776 printf("Build: %s\n", build.c_str());
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700777 // NOTE: fingerprint entry format is important for other tools.
Felipe Lemed8b94e52016-12-08 10:21:44 -0800778 printf("Build fingerprint: '%s'\n", fingerprint.c_str());
779 printf("Bootloader: %s\n", bootloader.c_str());
780 printf("Radio: %s\n", radio.c_str());
781 printf("Network: %s\n", network.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100782 int64_t module_metadata_version = android::os::GetModuleMetadataVersion();
783 if (module_metadata_version != 0) {
784 printf("Module Metadata version: %" PRId64 "\n", module_metadata_version);
785 }
Colin Crossf45fa6b2012-03-26 12:38:26 -0700786
Felipe Lemed8b94e52016-12-08 10:21:44 -0800787 printf("Kernel: ");
Felipe Lemef0292972016-11-22 13:57:05 -0800788 DumpFileToFd(STDOUT_FILENO, "", "/proc/version");
Felipe Lemed8b94e52016-12-08 10:21:44 -0800789 printf("Command line: %s\n", strtok(cmdline_buf, "\n"));
Felipe Leme7709f8a2017-12-05 09:30:09 -0800790 printf("Uptime: ");
791 RunCommandToFd(STDOUT_FILENO, "", {"uptime", "-p"},
792 CommandOptions::WithTimeout(1).Always().Build());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800793 printf("Bugreport format version: %s\n", version_.c_str());
Rhed Jao1c855122020-07-16 17:37:39 +0800794 printf("Dumpstate info: id=%d pid=%d dry_run=%d parallel_run=%d args=%s bugreport_mode=%s\n",
795 id_, pid_, PropertiesHelper::IsDryRun(), PropertiesHelper::IsParallelRun(),
796 options_->args.c_str(), options_->bugreport_mode.c_str());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800797 printf("\n");
Felipe Leme78f2c862015-12-21 09:55:22 -0800798}
799
Felipe Leme24b66ee2016-06-16 10:55:26 -0700800// List of file extensions that can cause a zip file attachment to be rejected by some email
801// service providers.
802static const std::set<std::string> PROBLEMATIC_FILE_EXTENSIONS = {
803 ".ade", ".adp", ".bat", ".chm", ".cmd", ".com", ".cpl", ".exe", ".hta", ".ins", ".isp",
804 ".jar", ".jse", ".lib", ".lnk", ".mde", ".msc", ".msp", ".mst", ".pif", ".scr", ".sct",
805 ".shb", ".sys", ".vb", ".vbe", ".vbs", ".vxd", ".wsc", ".wsf", ".wsh"
806};
807
Vishnu Naire97d6122018-01-18 13:58:56 -0800808status_t Dumpstate::AddZipEntryFromFd(const std::string& entry_name, int fd,
809 std::chrono::milliseconds timeout = 0ms) {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700810 if (!IsZipping()) {
811 MYLOGD("Not adding zip entry %s from fd because it's not a zipped bugreport\n",
812 entry_name.c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -0800813 return INVALID_OPERATION;
Felipe Leme111b9d02016-02-03 09:28:24 -0800814 }
Felipe Leme24b66ee2016-06-16 10:55:26 -0700815 std::string valid_name = entry_name;
816
817 // Rename extension if necessary.
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -0700818 size_t idx = entry_name.rfind('.');
Felipe Leme24b66ee2016-06-16 10:55:26 -0700819 if (idx != std::string::npos) {
820 std::string extension = entry_name.substr(idx);
821 std::transform(extension.begin(), extension.end(), extension.begin(), ::tolower);
822 if (PROBLEMATIC_FILE_EXTENSIONS.count(extension) != 0) {
823 valid_name = entry_name + ".renamed";
824 MYLOGI("Renaming entry %s to %s\n", entry_name.c_str(), valid_name.c_str());
825 }
826 }
827
Felipe Leme6fe9db62016-02-12 09:04:16 -0800828 // Logging statement below is useful to time how long each entry takes, but it's too verbose.
829 // MYLOGD("Adding zip entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700830 int32_t err = zip_writer_->StartEntryWithTime(valid_name.c_str(), ZipWriter::kCompress,
831 get_mtime(fd, ds.now_));
Felipe Leme1d486fe2016-10-14 18:06:47 -0700832 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700833 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", valid_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700834 ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800835 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800836 }
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000837 bool finished_entry = false;
838 auto finish_entry = [this, &finished_entry] {
839 if (!finished_entry) {
840 // This should only be called when we're going to return an earlier error,
841 // which would've been logged. This may imply the file is already corrupt
842 // and any further logging from FinishEntry is more likely to mislead than
843 // not.
844 this->zip_writer_->FinishEntry();
845 }
846 };
847 auto scope_guard = android::base::make_scope_guard(finish_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -0800848 auto start = std::chrono::steady_clock::now();
849 auto end = start + timeout;
850 struct pollfd pfd = {fd, POLLIN};
Felipe Lemee82a27d2016-01-05 13:35:44 -0800851
Felipe Leme770410d2016-01-26 17:07:14 -0800852 std::vector<uint8_t> buffer(65536);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800853 while (1) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800854 if (timeout.count() > 0) {
855 // lambda to recalculate the timeout.
856 auto time_left_ms = [end]() {
857 auto now = std::chrono::steady_clock::now();
858 auto diff = std::chrono::duration_cast<std::chrono::milliseconds>(end - now);
859 return std::max(diff.count(), 0LL);
860 };
861
862 int rc = TEMP_FAILURE_RETRY(poll(&pfd, 1, time_left_ms()));
863 if (rc < 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000864 MYLOGE("Error in poll while adding from fd to zip entry %s:%s\n",
865 entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800866 return -errno;
867 } else if (rc == 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000868 MYLOGE("Timed out adding from fd to zip entry %s:%s Timeout:%lldms\n",
Vishnu Naire97d6122018-01-18 13:58:56 -0800869 entry_name.c_str(), strerror(errno), timeout.count());
870 return TIMED_OUT;
871 }
872 }
873
Zach Riggle22200402016-08-18 01:01:24 -0400874 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800875 if (bytes_read == 0) {
876 break;
877 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800878 MYLOGE("read(%s): %s\n", entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800879 return -errno;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800880 }
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700881 err = zip_writer_->WriteBytes(buffer.data(), bytes_read);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800882 if (err) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700883 MYLOGE("zip_writer_->WriteBytes(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800884 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800885 }
886 }
887
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700888 err = zip_writer_->FinishEntry();
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000889 finished_entry = true;
Felipe Leme1d486fe2016-10-14 18:06:47 -0700890 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700891 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800892 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800893 }
894
Vishnu Naire97d6122018-01-18 13:58:56 -0800895 return OK;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800896}
897
Felipe Leme1d486fe2016-10-14 18:06:47 -0700898bool Dumpstate::AddZipEntry(const std::string& entry_name, const std::string& entry_path) {
899 android::base::unique_fd fd(
900 TEMP_FAILURE_RETRY(open(entry_path.c_str(), O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
Andreas Gampeaff68432016-07-18 18:01:27 -0700901 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800902 MYLOGE("open(%s): %s\n", entry_path.c_str(), strerror(errno));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800903 return false;
904 }
905
Vishnu Naire97d6122018-01-18 13:58:56 -0800906 return (AddZipEntryFromFd(entry_name, fd.get()) == OK);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800907}
908
909/* adds a file to the existing zipped bugreport */
Felipe Leme4c2d6632016-09-28 14:32:00 -0700910static int _add_file_from_fd(const char* title __attribute__((unused)), const char* path, int fd) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800911 return (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + path, fd) == OK) ? 0 : 1;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800912}
913
Felipe Leme1d486fe2016-10-14 18:06:47 -0700914void Dumpstate::AddDir(const std::string& dir, bool recursive) {
915 if (!IsZipping()) {
916 MYLOGD("Not adding dir %s because it's not a zipped bugreport\n", dir.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800917 return;
918 }
Felipe Leme678727a2016-09-21 17:22:11 -0700919 MYLOGD("Adding dir %s (recursive: %d)\n", dir.c_str(), recursive);
Felipe Leme46b85da2016-11-21 17:40:45 -0800920 DurationReporter duration_reporter(dir, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700921 dump_files("", dir.c_str(), recursive ? skip_none : is_dir, _add_file_from_fd);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800922}
923
Felipe Leme1d486fe2016-10-14 18:06:47 -0700924bool Dumpstate::AddTextZipEntry(const std::string& entry_name, const std::string& content) {
925 if (!IsZipping()) {
926 MYLOGD("Not adding text zip entry %s because it's not a zipped bugreport\n",
927 entry_name.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800928 return false;
929 }
Felipe Lemecbce55d2016-02-08 09:53:18 -0800930 MYLOGD("Adding zip text entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700931 int32_t err = zip_writer_->StartEntryWithTime(entry_name.c_str(), ZipWriter::kCompress, ds.now_);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700932 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700933 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700934 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800935 return false;
936 }
937
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700938 err = zip_writer_->WriteBytes(content.c_str(), content.length());
Felipe Leme1d486fe2016-10-14 18:06:47 -0700939 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700940 MYLOGE("zip_writer_->WriteBytes(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700941 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800942 return false;
943 }
944
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700945 err = zip_writer_->FinishEntry();
Felipe Leme1d486fe2016-10-14 18:06:47 -0700946 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700947 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800948 return false;
949 }
950
951 return true;
952}
953
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800954static void DoKmsg() {
955 struct stat st;
956 if (!stat(PSTORE_LAST_KMSG, &st)) {
957 /* Also TODO: Make console-ramoops CAP_SYSLOG protected. */
958 DumpFile("LAST KMSG", PSTORE_LAST_KMSG);
959 } else if (!stat(ALT_PSTORE_LAST_KMSG, &st)) {
960 DumpFile("LAST KMSG", ALT_PSTORE_LAST_KMSG);
961 } else {
962 /* TODO: Make last_kmsg CAP_SYSLOG protected. b/5555691 */
963 DumpFile("LAST KMSG", "/proc/last_kmsg");
964 }
965}
966
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800967static void DoKernelLogcat() {
Yao Chenbe3bbc12018-01-17 16:31:10 -0800968 unsigned long timeout_ms = logcat_timeout({"kernel"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800969 RunCommand(
970 "KERNEL LOG",
971 {"logcat", "-b", "kernel", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
972 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
973}
974
Nandana Duttdb379fa2019-10-09 16:54:41 +0100975static void DoSystemLogcat(time_t since) {
976 char since_str[80];
977 strftime(since_str, sizeof(since_str), "%Y-%m-%d %H:%M:%S.000", localtime(&since));
978
979 unsigned long timeout_ms = logcat_timeout({"main", "system", "crash"});
980 RunCommand("SYSTEM LOG",
981 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v", "-T",
982 since_str},
983 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
984}
985
Hunter Knepshield820f9bc2020-02-05 20:10:53 -0800986static void DoRadioLogcat() {
987 unsigned long timeout_ms = logcat_timeout({"radio"});
988 RunCommand(
989 "RADIO LOG",
990 {"logcat", "-b", "radio", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
991 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
992}
993
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800994static void DoLogcat() {
Vishnu Nair6921f802017-11-22 09:17:23 -0800995 unsigned long timeout_ms;
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800996 // DumpFile("EVENT LOG TAGS", "/etc/event-log-tags");
997 // calculate timeout
Yao Chenbe3bbc12018-01-17 16:31:10 -0800998 timeout_ms = logcat_timeout({"main", "system", "crash"});
Tony Makae737652017-03-30 17:47:09 +0100999 RunCommand("SYSTEM LOG",
Vishnu Nair6921f802017-11-22 09:17:23 -08001000 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1001 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -08001002 timeout_ms = logcat_timeout({"events"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001003 RunCommand(
1004 "EVENT LOG",
1005 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001006 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Yao Chenbe3bbc12018-01-17 16:31:10 -08001007 timeout_ms = logcat_timeout({"stats"});
1008 RunCommand(
1009 "STATS LOG",
1010 {"logcat", "-b", "stats", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001011 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001012 DoRadioLogcat();
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001013
1014 RunCommand("LOG STATISTICS", {"logcat", "-b", "all", "-S"});
1015
1016 /* kernels must set CONFIG_PSTORE_PMSG, slice up pstore with device tree */
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001017 RunCommand("LAST LOGCAT", {"logcat", "-L", "-b", "all", "-v", "threadtime", "-v", "printable",
1018 "-v", "uid", "-d", "*:v"});
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001019}
1020
Mike Ma5c267872019-08-21 11:31:34 -07001021static void DumpIncidentReport() {
1022 if (!ds.IsZipping()) {
1023 MYLOGD("Not dumping incident report because it's not a zipped bugreport\n");
1024 return;
1025 }
Mike Ma5c267872019-08-21 11:31:34 -07001026 const std::string path = ds.bugreport_internal_dir_ + "/tmp_incident_report";
1027 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1028 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1029 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1030 if (fd < 0) {
1031 MYLOGE("Could not open %s to dump incident report.\n", path.c_str());
1032 return;
1033 }
1034 RunCommandToFd(fd, "", {"incident", "-u"}, CommandOptions::WithTimeout(120).Build());
1035 bool empty = 0 == lseek(fd, 0, SEEK_END);
1036 if (!empty) {
1037 // Use a different name from "incident.proto"
1038 // /proto/incident.proto is reserved for incident service dump
1039 // i.e. metadata for debugging.
Rhed Jao4875aa62020-07-20 17:46:29 +08001040 ds.EnqueueAddZipEntryAndCleanupIfNeeded(kProtoPath + "incident_report" + kProtoExt,
1041 path);
1042 } else {
1043 unlink(path.c_str());
Mike Ma5c267872019-08-21 11:31:34 -07001044 }
Mike Ma5c267872019-08-21 11:31:34 -07001045}
1046
Sunny Goyal35949782019-11-19 15:54:36 -08001047static void DumpVisibleWindowViews() {
1048 if (!ds.IsZipping()) {
1049 MYLOGD("Not dumping visible views because it's not a zipped bugreport\n");
1050 return;
1051 }
1052 DurationReporter duration_reporter("VISIBLE WINDOW VIEWS");
1053 const std::string path = ds.bugreport_internal_dir_ + "/tmp_visible_window_views";
1054 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1055 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1056 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1057 if (fd < 0) {
1058 MYLOGE("Could not open %s to dump visible views.\n", path.c_str());
1059 return;
1060 }
1061 RunCommandToFd(fd, "", {"cmd", "window", "dump-visible-window-views"},
1062 CommandOptions::WithTimeout(120).Build());
1063 bool empty = 0 == lseek(fd, 0, SEEK_END);
1064 if (!empty) {
1065 ds.AddZipEntry("visible_windows.zip", path);
1066 } else {
1067 MYLOGW("Failed to dump visible windows\n");
1068 }
1069 unlink(path.c_str());
1070}
1071
Jayachandran Ca94c7172017-06-10 15:08:12 -07001072static void DumpIpTablesAsRoot() {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001073 RunCommand("IPTABLES", {"iptables", "-L", "-nvx"});
1074 RunCommand("IP6TABLES", {"ip6tables", "-L", "-nvx"});
Erik Kline32af8c22016-09-28 17:26:26 +09001075 RunCommand("IPTABLES NAT", {"iptables", "-t", "nat", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001076 /* no ip6 nat */
Erik Kline32af8c22016-09-28 17:26:26 +09001077 RunCommand("IPTABLES MANGLE", {"iptables", "-t", "mangle", "-L", "-nvx"});
1078 RunCommand("IP6TABLES MANGLE", {"ip6tables", "-t", "mangle", "-L", "-nvx"});
1079 RunCommand("IPTABLES RAW", {"iptables", "-t", "raw", "-L", "-nvx"});
1080 RunCommand("IP6TABLES RAW", {"ip6tables", "-t", "raw", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001081}
1082
David Andersond9ba4752018-12-11 18:26:59 -08001083static void DumpDynamicPartitionInfo() {
1084 if (!::android::base::GetBoolProperty("ro.boot.dynamic_partitions", false)) {
1085 return;
1086 }
1087
1088 RunCommand("LPDUMP", {"lpdump", "--all"});
David Anderson6650ade2019-10-02 15:18:59 -07001089 RunCommand("DEVICE-MAPPER", {"gsid", "dump-device-mapper"});
David Andersond9ba4752018-12-11 18:26:59 -08001090}
1091
Narayan Kamath8f788292017-05-25 13:20:39 +01001092static void AddAnrTraceDir(const bool add_to_zip, const std::string& anr_traces_dir) {
1093 MYLOGD("AddAnrTraceDir(): dump_traces_file=%s, anr_traces_dir=%s\n", dump_traces_path,
1094 anr_traces_dir.c_str());
1095
1096 // If we're here, dump_traces_path will always be a temporary file
1097 // (created with mkostemp or similar) that contains dumps taken earlier
1098 // on in the process.
1099 if (dump_traces_path != nullptr) {
1100 if (add_to_zip) {
1101 ds.AddZipEntry(ZIP_ROOT_DIR + anr_traces_dir + "/traces-just-now.txt", dump_traces_path);
1102 } else {
1103 MYLOGD("Dumping current ANR traces (%s) to the main bugreport entry\n",
1104 dump_traces_path);
1105 ds.DumpFile("VM TRACES JUST NOW", dump_traces_path);
1106 }
1107
1108 const int ret = unlink(dump_traces_path);
1109 if (ret == -1) {
1110 MYLOGW("Error unlinking temporary trace path %s: %s\n", dump_traces_path,
1111 strerror(errno));
Felipe Lemee184f662016-10-27 10:04:47 -07001112 }
1113 }
1114
Narayan Kamathbd863722017-06-01 18:50:12 +01001115 // Add a specific message for the first ANR Dump.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001116 if (ds.anr_data_.size() > 0) {
1117 AddDumps(ds.anr_data_.begin(), ds.anr_data_.begin() + 1,
Narayan Kamathbd863722017-06-01 18:50:12 +01001118 "VM TRACES AT LAST ANR", add_to_zip);
1119
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001120 // The "last" ANR will always be included as separate entry in the zip file. In addition,
1121 // it will be present in the body of the main entry if |add_to_zip| == false.
1122 //
1123 // Historical ANRs are always included as separate entries in the bugreport zip file.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001124 AddDumps(ds.anr_data_.begin() + ((add_to_zip) ? 1 : 0), ds.anr_data_.end(),
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001125 "HISTORICAL ANR", true /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001126 } else {
Narayan Kamath8f788292017-05-25 13:20:39 +01001127 printf("*** NO ANRs to dump in %s\n\n", ANR_DIR.c_str());
1128 }
1129}
1130
1131static void AddAnrTraceFiles() {
1132 const bool add_to_zip = ds.IsZipping() && ds.version_ == VERSION_SPLIT_ANR;
1133
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001134 std::string anr_traces_dir = "/data/anr";
Narayan Kamath8f788292017-05-25 13:20:39 +01001135
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001136 AddAnrTraceDir(add_to_zip, anr_traces_dir);
Narayan Kamath8f788292017-05-25 13:20:39 +01001137
Makoto Onuki83ec63f2019-01-31 17:08:59 -08001138 RunCommand("ANR FILES", {"ls", "-lt", ANR_DIR});
1139
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001140 // Slow traces for slow operations.
Felipe Lemee184f662016-10-27 10:04:47 -07001141 struct stat st;
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001142 int i = 0;
1143 while (true) {
1144 const std::string slow_trace_path =
1145 anr_traces_dir + android::base::StringPrintf("slow%02d.txt", i);
1146 if (stat(slow_trace_path.c_str(), &st)) {
1147 // No traces file at this index, done with the files.
1148 break;
Felipe Lemee184f662016-10-27 10:04:47 -07001149 }
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001150 ds.DumpFile("VM TRACES WHEN SLOW", slow_trace_path.c_str());
1151 i++;
Felipe Lemee184f662016-10-27 10:04:47 -07001152 }
1153}
1154
Wei Wang509bb5d2017-06-09 14:42:12 -07001155static void DumpBlockStatFiles() {
1156 DurationReporter duration_reporter("DUMP BLOCK STAT");
Wei Wang509bb5d2017-06-09 14:42:12 -07001157
Wei Wang1dc1ef52017-06-12 11:28:37 -07001158 std::unique_ptr<DIR, std::function<int(DIR*)>> dirptr(opendir(BLK_DEV_SYS_DIR), closedir);
1159
1160 if (dirptr == nullptr) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001161 MYLOGE("Failed to open %s: %s\n", BLK_DEV_SYS_DIR, strerror(errno));
1162 return;
1163 }
1164
1165 printf("------ DUMP BLOCK STAT ------\n\n");
Wei Wang1dc1ef52017-06-12 11:28:37 -07001166 while (struct dirent *d = readdir(dirptr.get())) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001167 if ((d->d_name[0] == '.')
1168 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
1169 || (d->d_name[1] == '\0'))) {
1170 continue;
1171 }
1172 const std::string new_path =
1173 android::base::StringPrintf("%s/%s", BLK_DEV_SYS_DIR, d->d_name);
1174 printf("------ BLOCK STAT (%s) ------\n", new_path.c_str());
1175 dump_files("", new_path.c_str(), skip_not_stat, dump_stat_from_fd);
1176 printf("\n");
1177 }
Wei Wang1dc1ef52017-06-12 11:28:37 -07001178 return;
Wei Wang509bb5d2017-06-09 14:42:12 -07001179}
Jayachandran Ca94c7172017-06-10 15:08:12 -07001180
1181static void DumpPacketStats() {
1182 DumpFile("NETWORK DEV INFO", "/proc/net/dev");
1183 DumpFile("QTAGUID NETWORK INTERFACES INFO", "/proc/net/xt_qtaguid/iface_stat_all");
1184 DumpFile("QTAGUID NETWORK INTERFACES INFO (xt)", "/proc/net/xt_qtaguid/iface_stat_fmt");
1185 DumpFile("QTAGUID CTRL INFO", "/proc/net/xt_qtaguid/ctrl");
1186 DumpFile("QTAGUID STATS INFO", "/proc/net/xt_qtaguid/stats");
1187}
1188
1189static void DumpIpAddrAndRules() {
1190 /* The following have a tendency to get wedged when wifi drivers/fw goes belly-up. */
1191 RunCommand("NETWORK INTERFACES", {"ip", "link"});
1192 RunCommand("IPv4 ADDRESSES", {"ip", "-4", "addr", "show"});
1193 RunCommand("IPv6 ADDRESSES", {"ip", "-6", "addr", "show"});
1194 RunCommand("IP RULES", {"ip", "rule", "show"});
1195 RunCommand("IP RULES v6", {"ip", "-6", "rule", "show"});
1196}
1197
Nandana Dutt5c390032019-03-12 10:52:56 +00001198static Dumpstate::RunStatus RunDumpsysTextByPriority(const std::string& title, int priority,
1199 std::chrono::milliseconds timeout,
1200 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001201 auto start = std::chrono::steady_clock::now();
Vishnu Naire97d6122018-01-18 13:58:56 -08001202 sp<android::IServiceManager> sm = defaultServiceManager();
1203 Dumpsys dumpsys(sm.get());
Vishnu Naire97d6122018-01-18 13:58:56 -08001204 Vector<String16> args;
1205 Dumpsys::setServiceArgs(args, /* asProto = */ false, priority);
Vishnu Naire97d6122018-01-18 13:58:56 -08001206 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ false);
1207 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001208 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001209 std::string path(title);
1210 path.append(" - ").append(String8(service).c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -08001211 size_t bytes_written = 0;
Steven Moreland5a30d342019-10-08 13:53:28 -07001212 status_t status = dumpsys.startDumpThread(Dumpsys::Type::DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001213 if (status == OK) {
1214 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1215 std::chrono::duration<double> elapsed_seconds;
1216 status = dumpsys.writeDump(STDOUT_FILENO, service, service_timeout,
1217 /* as_proto = */ false, elapsed_seconds, bytes_written);
Vishnu Naire97d6122018-01-18 13:58:56 -08001218 dumpsys.writeDumpFooter(STDOUT_FILENO, service, elapsed_seconds);
1219 bool dump_complete = (status == OK);
1220 dumpsys.stopDumpThread(dump_complete);
1221 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001222
1223 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1224 std::chrono::steady_clock::now() - start);
1225 if (elapsed_duration > timeout) {
1226 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1227 elapsed_duration.count());
1228 break;
1229 }
1230 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001231 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001232}
1233
Vishnu Nair64afc022018-02-01 15:29:34 -08001234static void RunDumpsysText(const std::string& title, int priority,
1235 std::chrono::milliseconds timeout,
1236 std::chrono::milliseconds service_timeout) {
1237 DurationReporter duration_reporter(title);
1238 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1239 fsync(STDOUT_FILENO);
1240 RunDumpsysTextByPriority(title, priority, timeout, service_timeout);
1241}
1242
1243/* Dump all services registered with Normal or Default priority. */
Nandana Dutt5c390032019-03-12 10:52:56 +00001244static Dumpstate::RunStatus RunDumpsysTextNormalPriority(const std::string& title,
1245 std::chrono::milliseconds timeout,
1246 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001247 DurationReporter duration_reporter(title);
1248 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1249 fsync(STDOUT_FILENO);
1250 RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_NORMAL, timeout,
1251 service_timeout);
Nandana Dutt5c390032019-03-12 10:52:56 +00001252
1253 RETURN_IF_USER_DENIED_CONSENT();
1254
1255 return RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_DEFAULT, timeout,
1256 service_timeout);
Vishnu Nair64afc022018-02-01 15:29:34 -08001257}
1258
Nandana Dutt5c390032019-03-12 10:52:56 +00001259static Dumpstate::RunStatus RunDumpsysProto(const std::string& title, int priority,
1260 std::chrono::milliseconds timeout,
1261 std::chrono::milliseconds service_timeout) {
Luis Hector Chavez1e27b082018-03-22 15:36:42 -07001262 if (!ds.IsZipping()) {
1263 MYLOGD("Not dumping %s because it's not a zipped bugreport\n", title.c_str());
Nandana Dutt5c390032019-03-12 10:52:56 +00001264 return Dumpstate::RunStatus::OK;
Luis Hector Chavez1e27b082018-03-22 15:36:42 -07001265 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001266 sp<android::IServiceManager> sm = defaultServiceManager();
1267 Dumpsys dumpsys(sm.get());
1268 Vector<String16> args;
1269 Dumpsys::setServiceArgs(args, /* asProto = */ true, priority);
1270 DurationReporter duration_reporter(title);
1271
1272 auto start = std::chrono::steady_clock::now();
1273 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ true);
1274 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001275 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001276 std::string path(kProtoPath);
1277 path.append(String8(service).c_str());
1278 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL) {
1279 path.append("_CRITICAL");
1280 } else if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH) {
1281 path.append("_HIGH");
1282 }
1283 path.append(kProtoExt);
Steven Moreland5a30d342019-10-08 13:53:28 -07001284 status_t status = dumpsys.startDumpThread(Dumpsys::Type::DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001285 if (status == OK) {
1286 status = ds.AddZipEntryFromFd(path, dumpsys.getDumpFd(), service_timeout);
1287 bool dumpTerminated = (status == OK);
1288 dumpsys.stopDumpThread(dumpTerminated);
1289 }
1290 ZipWriter::FileEntry file_entry;
1291 ds.zip_writer_->GetLastEntry(&file_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -08001292
1293 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1294 std::chrono::steady_clock::now() - start);
1295 if (elapsed_duration > timeout) {
1296 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1297 elapsed_duration.count());
1298 break;
1299 }
1300 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001301 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001302}
1303
Nandana Dutta7db6342018-11-21 14:53:34 +00001304// Runs dumpsys on services that must dump first and will take less than 100ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001305static Dumpstate::RunStatus RunDumpsysCritical() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001306 RunDumpsysText("DUMPSYS CRITICAL", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1307 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Nandana Dutt5c390032019-03-12 10:52:56 +00001308
1309 RETURN_IF_USER_DENIED_CONSENT();
1310
1311 return RunDumpsysProto("DUMPSYS CRITICAL PROTO", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1312 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Vishnu Nair780b1282017-10-10 13:57:24 -07001313}
1314
1315// Runs dumpsys on services that must dump first but can take up to 250ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001316static Dumpstate::RunStatus RunDumpsysHigh() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001317 // TODO meminfo takes ~10s, connectivity takes ~5sec to dump. They are both
1318 // high priority. Reduce timeout once they are able to dump in a shorter time or
1319 // moved to a parallel task.
1320 RunDumpsysText("DUMPSYS HIGH", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1321 /* timeout= */ 90s, /* service_timeout= */ 30s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001322
1323 RETURN_IF_USER_DENIED_CONSENT();
1324
1325 return RunDumpsysProto("DUMPSYS HIGH PROTO", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1326 /* timeout= */ 5s, /* service_timeout= */ 1s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001327}
1328
1329// Runs dumpsys on services that must dump but can take up to 10s to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001330static Dumpstate::RunStatus RunDumpsysNormal() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001331 RunDumpsysTextNormalPriority("DUMPSYS", /* timeout= */ 90s, /* service_timeout= */ 10s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001332
1333 RETURN_IF_USER_DENIED_CONSENT();
1334
1335 return RunDumpsysProto("DUMPSYS PROTO", IServiceManager::DUMP_FLAG_PRIORITY_NORMAL,
1336 /* timeout= */ 90s, /* service_timeout= */ 10s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001337}
1338
Rhed Jao4875aa62020-07-20 17:46:29 +08001339/*
1340 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1341 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1342 * if it's not running in the parallel task.
1343 */
1344static void DumpHals(int out_fd = STDOUT_FILENO) {
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001345 if (!ds.IsZipping()) {
Yifan Hong30528a22020-08-07 18:24:06 -07001346 RunCommand("HARDWARE HALS", {"lshal", "--all", "--types=all", "--debug"},
Steven Moreland9de8a1f2020-09-23 17:26:33 +00001347 CommandOptions::WithTimeout(60).AsRootIfAvailable().Build());
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001348 return;
1349 }
Yifan Hong30528a22020-08-07 18:24:06 -07001350 RunCommand("HARDWARE HALS", {"lshal", "--all", "--types=all"},
Rhed Jao4875aa62020-07-20 17:46:29 +08001351 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build(),
1352 false, out_fd);
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001353
Steven Moreland44cd9482018-01-04 16:24:13 -08001354 using android::hidl::manager::V1_0::IServiceManager;
1355 using android::hardware::defaultServiceManager;
1356
1357 sp<IServiceManager> sm = defaultServiceManager();
1358 if (sm == nullptr) {
1359 MYLOGE("Could not retrieve hwservicemanager to dump hals.\n");
1360 return;
1361 }
1362
1363 auto ret = sm->list([&](const auto& interfaces) {
1364 for (const std::string& interface : interfaces) {
1365 std::string cleanName = interface;
1366 std::replace_if(cleanName.begin(),
1367 cleanName.end(),
1368 [](char c) {
1369 return !isalnum(c) &&
1370 std::string("@-_:.").find(c) == std::string::npos;
1371 }, '_');
Nandana Dutt979388e2018-11-30 16:48:55 +00001372 const std::string path = ds.bugreport_internal_dir_ + "/lshal_debug_" + cleanName;
Steven Moreland44cd9482018-01-04 16:24:13 -08001373
Rhed Jao4875aa62020-07-20 17:46:29 +08001374 bool empty = false;
Steven Moreland44cd9482018-01-04 16:24:13 -08001375 {
1376 auto fd = android::base::unique_fd(
1377 TEMP_FAILURE_RETRY(open(path.c_str(),
1378 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1379 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1380 if (fd < 0) {
1381 MYLOGE("Could not open %s to dump additional hal information.\n", path.c_str());
1382 continue;
1383 }
1384 RunCommandToFd(fd,
1385 "",
Steven Morelandc81cd3c2018-01-18 14:36:26 -08001386 {"lshal", "debug", "-E", interface},
Steven Moreland44cd9482018-01-04 16:24:13 -08001387 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
1388
Rhed Jao4875aa62020-07-20 17:46:29 +08001389 empty = 0 == lseek(fd, 0, SEEK_END);
Steven Moreland44cd9482018-01-04 16:24:13 -08001390 }
Rhed Jao4875aa62020-07-20 17:46:29 +08001391 if (!empty) {
1392 ds.EnqueueAddZipEntryAndCleanupIfNeeded("lshal-debug/" + cleanName + ".txt",
1393 path);
1394 } else {
1395 unlink(path.c_str());
1396 }
Steven Moreland44cd9482018-01-04 16:24:13 -08001397 }
1398 });
1399
1400 if (!ret.isOk()) {
1401 MYLOGE("Could not list hals from hwservicemanager.\n");
1402 }
1403}
1404
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001405static void DumpExternalFragmentationInfo() {
1406 struct stat st;
1407 if (stat("/proc/buddyinfo", &st) != 0) {
1408 MYLOGE("Unable to dump external fragmentation info\n");
1409 return;
1410 }
1411
1412 printf("------ EXTERNAL FRAGMENTATION INFO ------\n");
1413 std::ifstream ifs("/proc/buddyinfo");
1414 auto unusable_index_regex = std::regex{"Node\\s+([0-9]+),\\s+zone\\s+(\\S+)\\s+(.*)"};
1415 for (std::string line; std::getline(ifs, line);) {
1416 std::smatch match_results;
1417 if (std::regex_match(line, match_results, unusable_index_regex)) {
1418 std::stringstream free_pages(std::string{match_results[3]});
1419 std::vector<int> free_pages_per_order(std::istream_iterator<int>{free_pages},
1420 std::istream_iterator<int>());
1421
1422 int total_free_pages = 0;
1423 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1424 total_free_pages += (free_pages_per_order[i] * std::pow(2, i));
1425 }
1426
1427 printf("Node %s, zone %8s", match_results[1].str().c_str(),
1428 match_results[2].str().c_str());
1429
1430 int usable_free_pages = total_free_pages;
1431 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1432 auto unusable_index = (total_free_pages - usable_free_pages) /
1433 static_cast<double>(total_free_pages);
1434 printf(" %5.3f", unusable_index);
1435 usable_free_pages -= (free_pages_per_order[i] * std::pow(2, i));
1436 }
1437
1438 printf("\n");
1439 }
1440 }
1441 printf("\n");
1442}
1443
mhasankd451a472020-05-26 18:02:39 -07001444static void DumpstateLimitedOnly() {
1445 // Trimmed-down version of dumpstate to only include a whitelisted
1446 // set of logs (system log, event log, and system server / system app
1447 // crashes, and networking logs). See b/136273873 and b/138459828
1448 // for context.
1449 DurationReporter duration_reporter("DUMPSTATE");
1450 unsigned long timeout_ms;
1451 // calculate timeout
1452 timeout_ms = logcat_timeout({"main", "system", "crash"});
1453 RunCommand("SYSTEM LOG",
1454 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1455 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1456 timeout_ms = logcat_timeout({"events"});
1457 RunCommand(
1458 "EVENT LOG",
1459 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1460 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1461
1462 printf("========================================================\n");
1463 printf("== Networking Service\n");
1464 printf("========================================================\n");
1465
1466 RunDumpsys("DUMPSYS NETWORK_SERVICE_LIMITED", {"wifi", "-a"},
1467 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
1468
1469 printf("========================================================\n");
1470 printf("== Dropbox crashes\n");
1471 printf("========================================================\n");
1472
1473 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1474 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1475
1476 printf("========================================================\n");
1477 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1478 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1479 printf("========================================================\n");
1480 printf("== dumpstate: done (id %d)\n", ds.id_);
1481 printf("========================================================\n");
1482}
1483
Nandana Dutt5c390032019-03-12 10:52:56 +00001484// Dumps various things. Returns early with status USER_CONSENT_DENIED if user denies consent
1485// via the consent they are shown. Ignores other errors that occur while running various
1486// commands. The consent checking is currently done around long running tasks, which happen to
1487// be distributed fairly evenly throughout the function.
1488static Dumpstate::RunStatus dumpstate() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001489 DurationReporter duration_reporter("DUMPSTATE");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001490
Rhed Jao4875aa62020-07-20 17:46:29 +08001491 // Enqueue slow functions into the thread pool, if the parallel run is enabled.
1492 if (ds.dump_pool_) {
1493 // Pool was shutdown in DumpstateDefaultAfterCritical method in order to
1494 // drop root user. Restarts it with two threads for the parallel run.
1495 ds.dump_pool_->start(/* thread_counts = */2);
1496
1497 ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
1498 ds.dump_pool_->enqueueTask(DUMP_INCIDENT_REPORT_TASK, &DumpIncidentReport);
1499 ds.dump_pool_->enqueueTaskWithFd(DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
1500 }
1501
Nandana Dutt5c390032019-03-12 10:52:56 +00001502 // Dump various things. Note that anything that takes "long" (i.e. several seconds) should
1503 // check intermittently (if it's intrerruptable like a foreach on pids) and/or should be wrapped
1504 // in a consent check (via RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK).
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -07001505 dump_dev_files("TRUSTY VERSION", "/sys/bus/platform/drivers/trusty", "trusty_version");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001506 RunCommand("UPTIME", {"uptime"});
Wei Wang509bb5d2017-06-09 14:42:12 -07001507 DumpBlockStatFiles();
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001508 DumpFile("MEMORY INFO", "/proc/meminfo");
1509 RunCommand("CPU INFO", {"top", "-b", "-n", "1", "-H", "-s", "6", "-o",
Felipe Leme30dbfa12016-09-02 12:43:26 -07001510 "pid,tid,user,pr,ni,%cpu,s,virt,res,pcy,cmd,name"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001511
1512 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "PROCRANK", {"procrank"}, AS_ROOT_20);
1513
Sunny Goyal35949782019-11-19 15:54:36 -08001514 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpVisibleWindowViews);
1515
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001516 DumpFile("VIRTUAL MEMORY STATS", "/proc/vmstat");
1517 DumpFile("VMALLOC INFO", "/proc/vmallocinfo");
1518 DumpFile("SLAB INFO", "/proc/slabinfo");
1519 DumpFile("ZONEINFO", "/proc/zoneinfo");
1520 DumpFile("PAGETYPEINFO", "/proc/pagetypeinfo");
1521 DumpFile("BUDDYINFO", "/proc/buddyinfo");
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001522 DumpExternalFragmentationInfo();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001523
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001524 DumpFile("KERNEL WAKE SOURCES", "/d/wakeup_sources");
1525 DumpFile("KERNEL CPUFREQ", "/sys/devices/system/cpu/cpu0/cpufreq/stats/time_in_state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001526
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001527 RunCommand("PROCESSES AND THREADS",
Yohei Yukawa591a72d2017-10-05 21:36:35 -07001528 {"ps", "-A", "-T", "-Z", "-O", "pri,nice,rtprio,sched,pcy,time"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001529
1530 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "LIBRANK", {"librank"},
1531 CommandOptions::AS_ROOT);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001532
Rhed Jao4875aa62020-07-20 17:46:29 +08001533 if (ds.dump_pool_) {
1534 WAIT_TASK_WITH_CONSENT_CHECK(DUMP_HALS_TASK, ds.dump_pool_);
1535 } else {
1536 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_HALS_TASK, DumpHals);
1537 }
Steven Moreland81b429e2017-01-31 19:50:46 -08001538
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001539 RunCommand("PRINTENV", {"printenv"});
Elliott Hughes21b7c8d2016-10-28 08:53:02 -07001540 RunCommand("NETSTAT", {"netstat", "-nW"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001541 struct stat s;
1542 if (stat("/proc/modules", &s) != 0) {
1543 MYLOGD("Skipping 'lsmod' because /proc/modules does not exist\n");
1544 } else {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001545 RunCommand("LSMOD", {"lsmod"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001546 }
Michal Karpinski4db754f2015-12-11 18:04:32 +00001547
Tom Cherryb87dbfa2020-07-28 11:28:53 -07001548 if (android::base::GetBoolProperty("ro.logd.kernel", false)) {
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001549 DoKernelLogcat();
1550 } else {
1551 do_dmesg();
1552 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001553
Felipe Lemef0292972016-11-22 13:57:05 -08001554 RunCommand("LIST OF OPEN FILES", {"lsof"}, CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001555
1556 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(for_each_pid, do_showmap, "SMAPS OF ALL PROCESSES");
1557
Jeff Brown1dc94e32014-09-11 14:15:27 -07001558 for_each_tid(show_wchan, "BLOCKED PROCESS WAIT-CHANNELS");
Mark Salyzyna297c322016-02-05 15:33:17 -08001559 for_each_pid(show_showtime, "PROCESS TIMES (pid cmd user system iowait+percentage)");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001560
Ajay Panicker2ff8e872017-04-27 14:04:32 -07001561 /* Dump Bluetooth HCI logs */
1562 ds.AddDir("/data/misc/bluetooth/logs", true);
Jack Yu5a6b2e22020-08-14 18:13:35 +08001563 /* Dump Nfc NCI logs */
1564 ds.AddDir("/data/misc/nfc/logs", true);
Ajay Panickerd886ec42016-09-14 12:26:46 -07001565
Paul Chang0d2aad72020-02-13 20:04:03 +08001566 if (ds.options_->do_screenshot && !ds.do_early_screenshot_) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001567 MYLOGI("taking late screenshot\n");
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001568 ds.TakeScreenshot();
Jeff Sharkey5a930032013-03-19 15:05:19 -07001569 }
1570
Felipe Lemee184f662016-10-27 10:04:47 -07001571 AddAnrTraceFiles();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001572
Narayan Kamath8f788292017-05-25 13:20:39 +01001573 // NOTE: tombstones are always added as separate entries in the zip archive
1574 // and are not interspersed with the main report.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001575 const bool tombstones_dumped = AddDumps(ds.tombstone_data_.begin(), ds.tombstone_data_.end(),
Narayan Kamathbd863722017-06-01 18:50:12 +01001576 "TOMBSTONE", true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001577 if (!tombstones_dumped) {
1578 printf("*** NO TOMBSTONES to dump in %s\n\n", TOMBSTONE_DIR.c_str());
Christopher Ferris7dc7f322014-07-22 16:08:19 -07001579 }
1580
Jayachandran Ca94c7172017-06-10 15:08:12 -07001581 DumpPacketStats();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001582
Chenbo Feng276a3b62018-08-07 11:44:49 -07001583 RunDumpsys("EBPF MAP STATS", {"netd", "trafficcontroller"});
1584
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001585 DoKmsg();
Mark Salyzyn2262c162014-12-16 09:09:26 -08001586
Jayachandran Ca94c7172017-06-10 15:08:12 -07001587 DumpIpAddrAndRules();
Sreeram Ramachandran2b3bba32014-07-08 15:40:55 -07001588
1589 dump_route_tables();
1590
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001591 RunCommand("ARP CACHE", {"ip", "-4", "neigh", "show"});
1592 RunCommand("IPv6 ND CACHE", {"ip", "-6", "neigh", "show"});
1593 RunCommand("MULTICAST ADDRESSES", {"ip", "maddr"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001594
Nandana Dutt5c390032019-03-12 10:52:56 +00001595 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysHigh);
Lorenzo Colitti6afc38c2015-09-09 22:59:25 +09001596
Elliott Hughes23ccc622017-02-28 10:14:22 -08001597 RunCommand("SYSTEM PROPERTIES", {"getprop"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001598
Jin Qianf334d662017-10-10 14:41:37 -07001599 RunCommand("STORAGED IO INFO", {"storaged", "-u", "-p"});
ynwangf649a6e2016-07-17 21:56:00 -07001600
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001601 RunCommand("FILESYSTEMS & FREE SPACE", {"df"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001602
Colin Crossf45fa6b2012-03-26 12:38:26 -07001603 /* Binder state is expensive to look at as it uses a lot of memory. */
Hridya Valsaraju920ba712020-02-09 16:27:01 -08001604 std::string binder_logs_dir = access("/dev/binderfs/binder_logs", R_OK) ?
1605 "/sys/kernel/debug/binder" : "/dev/binderfs/binder_logs";
1606
1607 DumpFile("BINDER FAILED TRANSACTION LOG", binder_logs_dir + "/failed_transaction_log");
1608 DumpFile("BINDER TRANSACTION LOG", binder_logs_dir + "/transaction_log");
1609 DumpFile("BINDER TRANSACTIONS", binder_logs_dir + "/transactions");
1610 DumpFile("BINDER STATS", binder_logs_dir + "/stats");
1611 DumpFile("BINDER STATE", binder_logs_dir + "/state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001612
Vishnu Nair36b4cdb2017-11-17 10:27:05 -08001613 /* Add window and surface trace files. */
1614 if (!PropertiesHelper::IsUserBuild()) {
1615 ds.AddDir(WMTRACE_DATA_DIR, false);
1616 }
1617
Yifan Hongcba0a4f2020-02-08 16:52:02 -08001618 ds.AddDir(SNAPSHOTCTL_LOG_DIR, false);
1619
Rhed Jao4875aa62020-07-20 17:46:29 +08001620 if (ds.dump_pool_) {
1621 WAIT_TASK_WITH_CONSENT_CHECK(DUMP_BOARD_TASK, ds.dump_pool_);
1622 } else {
1623 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
1624 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001625
Steven Moreland7440ddb2016-12-15 16:13:39 -08001626 /* Migrate the ril_dumpstate to a device specific dumpstate? */
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001627 int rilDumpstateTimeout = android::base::GetIntProperty("ril.dumpstate.timeout", 0);
1628 if (rilDumpstateTimeout > 0) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001629 // su does not exist on user builds, so try running without it.
1630 // This way any implementations of vril-dump that do not require
1631 // root can run on user builds.
1632 CommandOptions::CommandOptionsBuilder options =
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001633 CommandOptions::WithTimeout(rilDumpstateTimeout);
Felipe Lemef0292972016-11-22 13:57:05 -08001634 if (!PropertiesHelper::IsUserBuild()) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001635 options.AsRoot();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001636 }
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001637 RunCommand("DUMP VENDOR RIL LOGS", {"vril-dump"}, options.Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -07001638 }
1639
Felipe Lemed8b94e52016-12-08 10:21:44 -08001640 printf("========================================================\n");
1641 printf("== Android Framework Services\n");
1642 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001643
Nandana Dutt5c390032019-03-12 10:52:56 +00001644 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysNormal);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001645
Felipe Lemed8b94e52016-12-08 10:21:44 -08001646 printf("========================================================\n");
1647 printf("== Checkins\n");
1648 printf("========================================================\n");
Dianne Hackborn02bea972013-06-26 18:59:09 -07001649
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001650 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001651
1652 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsys, "CHECKIN MEMINFO", {"meminfo", "--checkin"});
1653
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001654 RunDumpsys("CHECKIN NETSTATS", {"netstats", "--checkin"});
1655 RunDumpsys("CHECKIN PROCSTATS", {"procstats", "-c"});
1656 RunDumpsys("CHECKIN USAGESTATS", {"usagestats", "-c"});
1657 RunDumpsys("CHECKIN PACKAGE", {"package", "--checkin"});
Dianne Hackborn02bea972013-06-26 18:59:09 -07001658
Felipe Lemed8b94e52016-12-08 10:21:44 -08001659 printf("========================================================\n");
1660 printf("== Running Application Activities\n");
1661 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001662
Makoto Onuki60780982018-04-16 15:34:00 -07001663 // The following dumpsys internally collects output from running apps, so it can take a long
1664 // time. So let's extend the timeout.
1665
1666 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
1667
1668 RunDumpsys("APP ACTIVITIES", {"activity", "-v", "all"}, DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001669
Felipe Lemed8b94e52016-12-08 10:21:44 -08001670 printf("========================================================\n");
Makoto Onuki60780982018-04-16 15:34:00 -07001671 printf("== Running Application Services (platform)\n");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001672 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001673
Vishnu Nairc6e6ea72018-07-02 14:20:06 -07001674 RunDumpsys("APP SERVICES PLATFORM", {"activity", "service", "all-platform-non-critical"},
Makoto Onuki60780982018-04-16 15:34:00 -07001675 DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001676
Felipe Lemed8b94e52016-12-08 10:21:44 -08001677 printf("========================================================\n");
Makoto Onuki60780982018-04-16 15:34:00 -07001678 printf("== Running Application Services (non-platform)\n");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001679 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001680
Makoto Onuki60780982018-04-16 15:34:00 -07001681 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1682 DUMPSYS_COMPONENTS_OPTIONS);
1683
1684 printf("========================================================\n");
1685 printf("== Running Application Providers (platform)\n");
1686 printf("========================================================\n");
1687
1688 RunDumpsys("APP PROVIDERS PLATFORM", {"activity", "provider", "all-platform"},
1689 DUMPSYS_COMPONENTS_OPTIONS);
1690
1691 printf("========================================================\n");
1692 printf("== Running Application Providers (non-platform)\n");
1693 printf("========================================================\n");
1694
1695 RunDumpsys("APP PROVIDERS NON-PLATFORM", {"activity", "provider", "all-non-platform"},
1696 DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001697
Adrian Roos8b397ab2017-04-04 16:35:44 -07001698 printf("========================================================\n");
1699 printf("== Dropbox crashes\n");
1700 printf("========================================================\n");
1701
1702 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1703 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1704
Felipe Lemed8b94e52016-12-08 10:21:44 -08001705 printf("========================================================\n");
1706 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1707 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1708 printf("========================================================\n");
1709 printf("== dumpstate: done (id %d)\n", ds.id_);
1710 printf("========================================================\n");
Bookatz38472142018-09-28 10:20:24 -07001711
1712 printf("========================================================\n");
1713 printf("== Obtaining statsd metadata\n");
1714 printf("========================================================\n");
1715 // This differs from the usual dumpsys stats, which is the stats report data.
1716 RunDumpsys("STATSDSTATS", {"stats", "--metadata"});
Mike Ma5c267872019-08-21 11:31:34 -07001717
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +09001718 // Add linker configuration directory
1719 ds.AddDir(LINKERCONFIG_DIR, true);
1720
Rhed Jao4875aa62020-07-20 17:46:29 +08001721 if (ds.dump_pool_) {
1722 WAIT_TASK_WITH_CONSENT_CHECK(DUMP_INCIDENT_REPORT_TASK, ds.dump_pool_);
1723 } else {
1724 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_INCIDENT_REPORT_TASK,
1725 DumpIncidentReport);
1726 }
Mike Ma5c267872019-08-21 11:31:34 -07001727
Nandana Dutt5c390032019-03-12 10:52:56 +00001728 return Dumpstate::RunStatus::OK;
Colin Crossf45fa6b2012-03-26 12:38:26 -07001729}
1730
Nandana Dutt5c390032019-03-12 10:52:56 +00001731/*
1732 * Dumps state for the default case; drops root after it's no longer necessary.
1733 *
1734 * Returns RunStatus::OK if everything went fine.
1735 * Returns RunStatus::ERROR if there was an error.
1736 * Returns RunStatus::USER_DENIED_CONSENT if user explicitly denied consent to sharing the bugreport
1737 * with the caller.
1738 */
Jichao Lie89d9c12019-11-21 19:02:51 -08001739Dumpstate::RunStatus Dumpstate::DumpstateDefaultAfterCritical() {
Nandana Duttdb379fa2019-10-09 16:54:41 +01001740 // Capture first logcat early on; useful to take a snapshot before dumpstate logs take over the
1741 // buffer.
1742 DoLogcat();
1743 // Capture timestamp after first logcat to use in next logcat
1744 time_t logcat_ts = time(nullptr);
1745
Nandana Dutt4be45d12018-09-26 15:04:23 +01001746 /* collect stack traces from Dalvik and native processes (needs root) */
Rhed Jao1c855122020-07-16 17:37:39 +08001747 if (dump_pool_) {
1748 RETURN_IF_USER_DENIED_CONSENT();
1749 // One thread is enough since we only need to enqueue DumpTraces here.
1750 dump_pool_->start(/* thread_counts = */1);
1751
1752 // DumpTraces takes long time, post it to the another thread in the
1753 // pool, if pool is available
1754 dump_pool_->enqueueTask(DUMP_TRACES_TASK, &Dumpstate::DumpTraces, &ds, &dump_traces_path);
1755 } else {
1756 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_TRACES_TASK, ds.DumpTraces,
1757 &dump_traces_path);
1758 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001759
1760 /* Run some operations that require root. */
1761 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX, !ds.IsZipping());
1762 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX, !ds.IsZipping());
1763
1764 ds.AddDir(RECOVERY_DIR, true);
1765 ds.AddDir(RECOVERY_DATA_DIR, true);
1766 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
1767 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1768 if (!PropertiesHelper::IsUserBuild()) {
1769 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1770 ds.AddDir(PROFILE_DATA_DIR_REF, true);
Calin Juravle78a0d842020-04-28 15:31:12 -07001771 ds.AddZipEntry(ZIP_ROOT_DIR + PACKAGE_DEX_USE_LIST, PACKAGE_DEX_USE_LIST);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001772 }
Jerry Changa1df8a92020-01-02 16:03:39 +08001773 ds.AddDir(PREREBOOT_DATA_DIR, false);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001774 add_mountinfo();
1775 DumpIpTablesAsRoot();
David Andersond9ba4752018-12-11 18:26:59 -08001776 DumpDynamicPartitionInfo();
Yifan Hong3945e1b2019-10-29 12:59:23 -07001777 ds.AddDir(OTA_METADATA_DIR, true);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001778
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001779 // Capture any IPSec policies in play. No keys are exposed here.
Nandana Dutt4be45d12018-09-26 15:04:23 +01001780 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1781
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001782 // Dump IPsec stats. No keys are exposed here.
1783 DumpFile("XFRM STATS", XFRM_STAT_PROC_FILE);
1784
Nandana Dutt4be45d12018-09-26 15:04:23 +01001785 // Run ss as root so we can see socket marks.
1786 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
1787
1788 // Run iotop as root to show top 100 IO threads
1789 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
1790
Erick Reyese68df822019-02-11 14:46:36 -08001791 // Gather shared memory buffer info if the product implements it
1792 struct stat st;
1793 if (!stat("/product/bin/dmabuf_dump", &st)) {
1794 RunCommand("Dmabuf dump", {"/product/bin/dmabuf_dump"});
1795 }
1796
Minchan Kim22c6a1e2019-09-30 15:58:10 -07001797 DumpFile("PSI cpu", "/proc/pressure/cpu");
1798 DumpFile("PSI memory", "/proc/pressure/memory");
1799 DumpFile("PSI io", "/proc/pressure/io");
1800
Rhed Jao1c855122020-07-16 17:37:39 +08001801 if (dump_pool_) {
1802 RETURN_IF_USER_DENIED_CONSENT();
1803 dump_pool_->waitForTask(DUMP_TRACES_TASK);
1804
1805 // Current running thread in the pool is the root user also. Shutdown
1806 // the pool and restart later to ensure all threads in the pool could
1807 // drop the root user.
1808 dump_pool_->shutdown();
1809 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001810 if (!DropRootUser()) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001811 return Dumpstate::RunStatus::ERROR;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001812 }
1813
Nandana Dutt5c390032019-03-12 10:52:56 +00001814 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttdb379fa2019-10-09 16:54:41 +01001815 Dumpstate::RunStatus status = dumpstate();
1816 // Capture logcat since the last time we did it.
1817 DoSystemLogcat(logcat_ts);
1818 return status;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001819}
1820
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001821// This method collects common dumpsys for telephony and wifi. Typically, wifi
1822// reports are fine to include all information, but telephony reports on user
1823// builds need to strip some content (see DumpstateTelephonyOnly).
1824static void DumpstateRadioCommon(bool include_sensitive_info = true) {
Jayachandran Ca94c7172017-06-10 15:08:12 -07001825 DumpIpTablesAsRoot();
1826
Jayachandran C69968272019-07-08 09:46:05 -07001827 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1828
Jayachandran Ca94c7172017-06-10 15:08:12 -07001829 if (!DropRootUser()) {
1830 return;
1831 }
1832
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001833 // We need to be picky about some stuff for telephony reports on user builds.
1834 if (!include_sensitive_info) {
1835 // Only dump the radio log buffer (other buffers and dumps contain too much unrelated info).
1836 DoRadioLogcat();
1837 } else {
1838 // Contains various system properties and process startup info.
1839 do_dmesg();
1840 // Logs other than the radio buffer may contain package/component names and potential PII.
1841 DoLogcat();
1842 // Too broad for connectivity problems.
1843 DoKmsg();
1844 // Contains unrelated hardware info (camera, NFC, biometrics, ...).
Rhed Jao4875aa62020-07-20 17:46:29 +08001845 // TODO(b/136262402) Using thread pool for DumpHals
1846 RUN_SLOW_FUNCTION_AND_LOG(DUMP_HALS_TASK, DumpHals);
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001847 }
1848
Jayachandran Ca94c7172017-06-10 15:08:12 -07001849 DumpPacketStats();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001850 DumpIpAddrAndRules();
1851 dump_route_tables();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001852 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
1853 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08001854}
1855
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001856// We use "telephony" here for legacy reasons, though this now really means "connectivity" (cellular
1857// + wifi + networking). This method collects dumpsys for connectivity debugging only. General rules
1858// for what can be included on user builds: all reported information MUST directly relate to
1859// connectivity debugging or customer support and MUST NOT contain unrelated personally identifiable
1860// information. This information MUST NOT identify user-installed packages (UIDs are OK, package
1861// names are not), and MUST NOT contain logs of user application traffic.
1862// TODO(b/148168577) rename this and other related fields/methods to "connectivity" instead.
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08001863static void DumpstateTelephonyOnly(const std::string& calling_package) {
mukesh agrawal253dad42018-01-23 21:59:59 -08001864 DurationReporter duration_reporter("DUMPSTATE");
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001865
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001866 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08001867
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001868 const bool include_sensitive_info = !PropertiesHelper::IsUserBuild();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001869
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001870 DumpstateRadioCommon(include_sensitive_info);
1871
1872 if (include_sensitive_info) {
1873 // Contains too much unrelated PII, and given the unstructured nature of sysprops, we can't
1874 // really cherrypick all of the connectivity-related ones. Apps generally have no business
1875 // reading these anyway, and there should be APIs to supply the info in a more app-friendly
1876 // way.
1877 RunCommand("SYSTEM PROPERTIES", {"getprop"});
1878 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07001879
1880 printf("========================================================\n");
1881 printf("== Android Framework Services\n");
1882 printf("========================================================\n");
1883
Vishnu Nair652cc802017-11-30 15:18:30 -08001884 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1885 SEC_TO_MSEC(10));
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08001886 if (include_sensitive_info) {
1887 // Carrier apps' services will be dumped below in dumpsys activity service all-non-platform.
1888 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
1889 SEC_TO_MSEC(10));
1890 } else {
1891 // If the caller is a carrier app and has a carrier service, dump it here since we aren't
1892 // running dumpsys activity service all-non-platform below. Due to the increased output, we
1893 // give a higher timeout as well.
1894 RunDumpsys("DUMPSYS", {"carrier_config", "--requesting-package", calling_package},
1895 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(30));
1896 }
1897 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001898 RunDumpsys("DUMPSYS", {"netpolicy"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
1899 RunDumpsys("DUMPSYS", {"network_management"}, CommandOptions::WithTimeout(90).Build(),
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07001900 SEC_TO_MSEC(10));
Hunter Knepshield0fe51b12020-03-05 16:58:20 -08001901 RunDumpsys("DUMPSYS", {"telephony.registry"}, CommandOptions::WithTimeout(90).Build(),
1902 SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001903 if (include_sensitive_info) {
1904 // Contains raw IP addresses, omit from reports on user builds.
1905 RunDumpsys("DUMPSYS", {"netd"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
1906 // Contains raw destination IP/MAC addresses, omit from reports on user builds.
1907 RunDumpsys("DUMPSYS", {"connmetrics"}, CommandOptions::WithTimeout(90).Build(),
1908 SEC_TO_MSEC(10));
1909 // Contains package/component names, omit from reports on user builds.
1910 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
1911 SEC_TO_MSEC(10));
1912 // Contains package names, but should be relatively simple to remove them (also contains
1913 // UIDs already), omit from reports on user builds.
1914 RunDumpsys("BATTERYSTATS", {"deviceidle"}, CommandOptions::WithTimeout(90).Build(),
1915 SEC_TO_MSEC(10));
1916 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07001917
1918 printf("========================================================\n");
1919 printf("== Running Application Services\n");
1920 printf("========================================================\n");
1921
1922 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
1923
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001924 if (include_sensitive_info) {
1925 printf("========================================================\n");
1926 printf("== Running Application Services (non-platform)\n");
1927 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001928
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001929 // Contains package/component names and potential PII, omit from reports on user builds.
1930 // To get dumps of the active CarrierService(s) on user builds, we supply an argument to the
1931 // carrier_config dumpsys instead.
1932 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1933 DUMPSYS_COMPONENTS_OPTIONS);
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001934
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001935 printf("========================================================\n");
1936 printf("== Checkins\n");
1937 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07001938
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001939 // Contains package/component names, omit from reports on user builds.
1940 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
1941 }
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07001942
1943 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07001944 printf("== dumpstate: done (id %d)\n", ds.id_);
1945 printf("========================================================\n");
1946}
1947
mukesh agrawal253dad42018-01-23 21:59:59 -08001948// This method collects dumpsys for wifi debugging only
1949static void DumpstateWifiOnly() {
1950 DurationReporter duration_reporter("DUMPSTATE");
1951
1952 DumpstateRadioCommon();
1953
1954 printf("========================================================\n");
1955 printf("== Android Framework Services\n");
1956 printf("========================================================\n");
1957
1958 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1959 SEC_TO_MSEC(10));
1960 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
1961 SEC_TO_MSEC(10));
1962
1963 printf("========================================================\n");
1964 printf("== dumpstate: done (id %d)\n", ds.id_);
1965 printf("========================================================\n");
1966}
1967
Nandana Duttcf419a72019-03-14 10:40:17 +00001968Dumpstate::RunStatus Dumpstate::DumpTraces(const char** path) {
Nandana Duttfaafd522019-03-11 09:23:09 +00001969 const std::string temp_file_pattern = "/data/anr/dumptrace_XXXXXX";
1970 const size_t buf_size = temp_file_pattern.length() + 1;
1971 std::unique_ptr<char[]> file_name_buf(new char[buf_size]);
1972 memcpy(file_name_buf.get(), temp_file_pattern.c_str(), buf_size);
1973
1974 // Create a new, empty file to receive all trace dumps.
1975 //
1976 // TODO: This can be simplified once we remove support for the old style
1977 // dumps. We can have a file descriptor passed in to dump_traces instead
1978 // of creating a file, closing it and then reopening it again.
1979 android::base::unique_fd fd(mkostemp(file_name_buf.get(), O_APPEND | O_CLOEXEC));
1980 if (fd < 0) {
1981 MYLOGE("mkostemp on pattern %s: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001982 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001983 }
1984
1985 // Nobody should have access to this temporary file except dumpstate, but we
1986 // temporarily grant 'read' to 'others' here because this file is created
1987 // when tombstoned is still running as root, but dumped after dropping. This
1988 // can go away once support for old style dumping has.
1989 const int chmod_ret = fchmod(fd, 0666);
1990 if (chmod_ret < 0) {
1991 MYLOGE("fchmod on %s failed: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001992 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001993 }
1994
1995 std::unique_ptr<DIR, decltype(&closedir)> proc(opendir("/proc"), closedir);
1996 if (proc.get() == nullptr) {
1997 MYLOGE("opendir /proc failed: %s\n", strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001998 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001999 }
2000
2001 // Number of times process dumping has timed out. If we encounter too many
2002 // failures, we'll give up.
2003 int timeout_failures = 0;
2004 bool dalvik_found = false;
2005
2006 const std::set<int> hal_pids = get_interesting_hal_pids();
2007
2008 struct dirent* d;
2009 while ((d = readdir(proc.get()))) {
Nandana Duttcf419a72019-03-14 10:40:17 +00002010 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttfaafd522019-03-11 09:23:09 +00002011 int pid = atoi(d->d_name);
2012 if (pid <= 0) {
2013 continue;
2014 }
2015
2016 const std::string link_name = android::base::StringPrintf("/proc/%d/exe", pid);
2017 std::string exe;
2018 if (!android::base::Readlink(link_name, &exe)) {
2019 continue;
2020 }
2021
2022 bool is_java_process;
2023 if (exe == "/system/bin/app_process32" || exe == "/system/bin/app_process64") {
2024 // Don't bother dumping backtraces for the zygote.
2025 if (IsZygote(pid)) {
2026 continue;
2027 }
2028
2029 dalvik_found = true;
2030 is_java_process = true;
2031 } else if (should_dump_native_traces(exe.c_str()) || hal_pids.find(pid) != hal_pids.end()) {
2032 is_java_process = false;
2033 } else {
2034 // Probably a native process we don't care about, continue.
2035 continue;
2036 }
2037
2038 // If 3 backtrace dumps fail in a row, consider debuggerd dead.
2039 if (timeout_failures == 3) {
2040 dprintf(fd, "ERROR: Too many stack dump failures, exiting.\n");
2041 break;
2042 }
2043
2044 const uint64_t start = Nanotime();
2045 const int ret = dump_backtrace_to_file_timeout(
2046 pid, is_java_process ? kDebuggerdJavaBacktrace : kDebuggerdNativeBacktrace,
2047 is_java_process ? 5 : 20, fd);
2048
2049 if (ret == -1) {
2050 // For consistency, the header and footer to this message match those
2051 // dumped by debuggerd in the success case.
2052 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
2053 dprintf(fd, "Dump failed, likely due to a timeout.\n");
2054 dprintf(fd, "---- end %d ----", pid);
2055 timeout_failures++;
2056 continue;
2057 }
2058
2059 // We've successfully dumped stack traces, reset the failure count
2060 // and write a summary of the elapsed time to the file and continue with the
2061 // next process.
2062 timeout_failures = 0;
2063
2064 dprintf(fd, "[dump %s stack %d: %.3fs elapsed]\n", is_java_process ? "dalvik" : "native",
2065 pid, (float)(Nanotime() - start) / NANOS_PER_SEC);
2066 }
2067
2068 if (!dalvik_found) {
2069 MYLOGE("Warning: no Dalvik processes found to dump stacks\n");
2070 }
2071
Nandana Duttcf419a72019-03-14 10:40:17 +00002072 *path = file_name_buf.release();
2073 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002074}
2075
Rhed Jao4875aa62020-07-20 17:46:29 +08002076void Dumpstate::DumpstateBoard(int out_fd) {
2077 dprintf(out_fd, "========================================================\n");
2078 dprintf(out_fd, "== Board\n");
2079 dprintf(out_fd, "========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08002080
Felipe Leme6f674ae2016-11-18 17:10:33 -08002081 if (!IsZipping()) {
Steven Moreland7440ddb2016-12-15 16:13:39 -08002082 MYLOGD("Not dumping board info because it's not a zipped bugreport\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08002083 return;
2084 }
2085
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002086 std::vector<std::string> paths;
2087 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07002088 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002089 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
2090 kDumpstateBoardFiles[i].c_str()));
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002091 remover.emplace_back(android::base::make_scope_guard(
2092 std::bind([](std::string path) { android::os::UnlinkAndLogOnError(path); }, paths[i])));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002093 }
Jie Song9fbfad02017-06-20 16:29:42 -07002094
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002095 sp<IDumpstateDevice_1_0> dumpstate_device_1_0(IDumpstateDevice_1_0::getService());
2096 if (dumpstate_device_1_0 == nullptr) {
Wei Wang587eac92018-04-05 12:17:20 -07002097 MYLOGE("No IDumpstateDevice implementation\n");
2098 return;
2099 }
2100
2101 using ScopedNativeHandle =
2102 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
2103 ScopedNativeHandle handle(native_handle_create(static_cast<int>(paths.size()), 0),
2104 [](native_handle_t* handle) {
2105 native_handle_close(handle);
2106 native_handle_delete(handle);
2107 });
2108 if (handle == nullptr) {
2109 MYLOGE("Could not create native_handle\n");
2110 return;
2111 }
2112
Nandana Dutt5c390032019-03-12 10:52:56 +00002113 // TODO(128270426): Check for consent in between?
Wei Wang587eac92018-04-05 12:17:20 -07002114 for (size_t i = 0; i < paths.size(); i++) {
2115 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
2116
2117 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
2118 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
2119 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
2120 if (fd < 0) {
2121 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
2122 return;
2123 }
2124 handle.get()->data[i] = fd.release();
2125 }
2126
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002127 // Given that bugreport is required to diagnose failures, it's better to set an arbitrary amount
2128 // of timeout for IDumpstateDevice than to block the rest of bugreport. In the timeout case, we
2129 // will kill the HAL and grab whatever it dumped in time.
2130 constexpr size_t timeout_sec = 30;
2131 // Prefer version 1.1 if available. New devices launching with R are no longer allowed to
2132 // implement just 1.0.
2133 const char* descriptor_to_kill;
2134 using DumpstateBoardTask = std::packaged_task<bool()>;
2135 DumpstateBoardTask dumpstate_board_task;
2136 sp<IDumpstateDevice_1_1> dumpstate_device_1_1(
2137 IDumpstateDevice_1_1::castFrom(dumpstate_device_1_0));
2138 if (dumpstate_device_1_1 != nullptr) {
2139 MYLOGI("Using IDumpstateDevice v1.1");
2140 descriptor_to_kill = IDumpstateDevice_1_1::descriptor;
2141 dumpstate_board_task = DumpstateBoardTask([this, dumpstate_device_1_1, &handle]() -> bool {
2142 ::android::hardware::Return<DumpstateStatus> status =
2143 dumpstate_device_1_1->dumpstateBoard_1_1(handle.get(), options_->dumpstate_hal_mode,
2144 SEC_TO_MSEC(timeout_sec));
2145 if (!status.isOk()) {
2146 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2147 return false;
2148 } else if (status != DumpstateStatus::OK) {
2149 MYLOGE("dumpstateBoard failed with DumpstateStatus::%s\n", toString(status).c_str());
2150 return false;
2151 }
2152 return true;
2153 });
2154 } else {
2155 MYLOGI("Using IDumpstateDevice v1.0");
2156 descriptor_to_kill = IDumpstateDevice_1_0::descriptor;
2157 dumpstate_board_task = DumpstateBoardTask([dumpstate_device_1_0, &handle]() -> bool {
2158 ::android::hardware::Return<void> status =
2159 dumpstate_device_1_0->dumpstateBoard(handle.get());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002160 if (!status.isOk()) {
2161 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
Wei Wang587eac92018-04-05 12:17:20 -07002162 return false;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002163 }
Wei Wang587eac92018-04-05 12:17:20 -07002164 return true;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002165 });
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002166 }
2167 auto result = dumpstate_board_task.get_future();
2168 std::thread(std::move(dumpstate_board_task)).detach();
Wei Wang587eac92018-04-05 12:17:20 -07002169
Wei Wang587eac92018-04-05 12:17:20 -07002170 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2171 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate vendor HAL\n", timeout_sec);
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002172 if (!android::base::SetProperty(
2173 "ctl.interface_restart",
2174 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
Wei Wang587eac92018-04-05 12:17:20 -07002175 MYLOGE("Couldn't restart dumpstate HAL\n");
2176 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002177 }
Wei Wang587eac92018-04-05 12:17:20 -07002178 // Wait some time for init to kill dumpstate vendor HAL
2179 constexpr size_t killing_timeout_sec = 10;
2180 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2181 MYLOGE("killing dumpstateBoard timed out after %zus, continue and "
2182 "there might be racing in content\n", killing_timeout_sec);
2183 }
2184
2185 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
2186 for (size_t i = 0; i < paths.size(); i++) {
2187 struct stat s;
2188 if (fstat(handle.get()->data[i], &s) == -1) {
2189 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(),
2190 strerror(errno));
2191 file_sizes[i] = -1;
2192 continue;
2193 }
2194 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002195 }
2196
2197 for (size_t i = 0; i < paths.size(); i++) {
2198 if (file_sizes[i] == -1) {
2199 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002200 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002201 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07002202 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002203 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002204 }
Rhed Jao4875aa62020-07-20 17:46:29 +08002205 remover[i].Disable();
2206 EnqueueAddZipEntryAndCleanupIfNeeded(kDumpstateBoardFiles[i], paths[i]);
2207 dprintf(out_fd, "*** See %s entry ***\n", kDumpstateBoardFiles[i].c_str());
Jie Song9fbfad02017-06-20 16:29:42 -07002208 }
Felipe Leme6f674ae2016-11-18 17:10:33 -08002209}
2210
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002211static void ShowUsage() {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002212 fprintf(stderr,
mhasank2d75c442020-06-11 15:05:25 -07002213 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-o directory] [-d] [-p] "
mhasankd451a472020-05-26 18:02:39 -07002214 "[-z] [-s] [-S] [-q] [-P] [-R] [-L] [-V version]\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002215 " -h: display this help message\n"
2216 " -b: play sound file instead of vibrate, at beginning of job\n"
2217 " -e: play sound file instead of vibrate, at end of job\n"
mhasank2d75c442020-06-11 15:05:25 -07002218 " -o: write to custom directory (only in limited mode)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01002219 " -d: append date to filename\n"
2220 " -p: capture screenshot to filename.png\n"
2221 " -z: generate zipped file\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002222 " -s: write output to control socket (for init)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01002223 " -S: write file location to control socket (for init; requires -z)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002224 " -q: disable vibrate\n"
Abhijeet Kaure370d682019-10-01 16:49:30 +01002225 " -P: send broadcast when started and do progress updates\n"
2226 " -R: take bugreport in remote mode (requires -z and -d, shouldn't be used with -P)\n"
Nandana Dutt235864b2019-01-22 12:10:16 +00002227 " -w: start binder service and make it wait for a call to startBugreport\n"
mhasankd451a472020-05-26 18:02:39 -07002228 " -L: output limited information that is safe for submission in feedback reports\n"
Felipe Lemed071c682016-10-20 16:48:00 -07002229 " -v: prints the dumpstate header and exit\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002230}
2231
Wei Liuf87959e2016-08-26 14:51:42 -07002232static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07002233 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07002234}
2235
Felipe Leme1d486fe2016-10-14 18:06:47 -07002236bool Dumpstate::FinishZipFile() {
Rhed Jao4875aa62020-07-20 17:46:29 +08002237 // Runs all enqueued adding zip entry and cleanup tasks before finishing the zip file.
2238 if (zip_entry_tasks_) {
2239 zip_entry_tasks_->run(/* do_cancel = */false);
2240 }
2241
Felipe Leme9a523ae2016-10-20 15:10:33 -07002242 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07002243 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07002244 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002245 // Final timestamp
2246 char date[80];
2247 time_t the_real_now_please_stand_up = time(nullptr);
2248 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002249 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07002250 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002251
Felipe Leme9a523ae2016-10-20 15:10:33 -07002252 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002253 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08002254 return false;
2255 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07002256 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002257 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08002258 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08002259 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08002260
Felipe Leme0f3fb202016-06-10 17:10:53 -07002261 // Add log file (which contains stderr output) to zip...
2262 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07002263 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07002264 MYLOGE("Failed to add dumpstate log to .zip file\n");
2265 return false;
2266 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002267 // TODO: Should truncate the existing file.
2268 // ... and re-open it for further logging.
Nandana Dutta344cb62019-02-22 15:12:35 +00002269 if (!redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()))) {
2270 return false;
2271 }
Felipe Leme0f3fb202016-06-10 17:10:53 -07002272 fprintf(stderr, "\n");
2273
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002274 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07002275 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002276 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002277 return false;
2278 }
2279
Felipe Leme1d486fe2016-10-14 18:06:47 -07002280 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
2281 ds.zip_file.reset(nullptr);
2282
Felipe Lemee9d2c542016-11-15 11:48:26 -08002283 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002284 android::os::UnlinkAndLogOnError(tmp_path_);
Felipe Lemec4eee562016-04-21 15:42:55 -07002285
Felipe Leme1e9edc62015-12-21 16:02:13 -08002286 return true;
2287}
Felipe Leme6e01fa62015-11-11 19:35:14 -08002288
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002289static void SendBroadcast(const std::string& action, const std::vector<std::string>& args) {
2290 // clang-format off
2291 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user", "0",
2292 "--receiver-foreground", "--receiver-include-background", "-a", action};
2293 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08002294
2295 am.insert(am.end(), args.begin(), args.end());
2296
Felipe Leme8d2410e2017-02-08 09:46:08 -08002297 RunCommand("", am,
2298 CommandOptions::WithTimeout(20)
2299 .Log("Sending broadcast: '%s'\n")
2300 .Always()
2301 .DropRoot()
2302 .RedirectStderr()
2303 .Build());
2304}
2305
Felipe Leme35b8cf12017-02-10 15:47:29 -08002306static void Vibrate(int duration_ms) {
2307 // clang-format off
Chris Fries0c3de872019-09-14 15:49:41 +00002308 RunCommand("", {"cmd", "vibrator", "vibrate", "-f", std::to_string(duration_ms), "dumpstate"},
Felipe Leme35b8cf12017-02-10 15:47:29 -08002309 CommandOptions::WithTimeout(10)
2310 .Log("Vibrate: '%s'\n")
2311 .Always()
2312 .Build());
2313 // clang-format on
2314}
2315
Nandana Dutt979388e2018-11-30 16:48:55 +00002316static void MaybeResolveSymlink(std::string* path) {
2317 std::string resolved_path;
2318 if (android::base::Readlink(*path, &resolved_path)) {
2319 *path = resolved_path;
2320 }
2321}
2322
Nandana Dutt4be45d12018-09-26 15:04:23 +01002323/*
2324 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
2325 * if we are writing zip files and adds the version file.
2326 */
2327static void PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002328 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
2329
Nandana Dutt4be45d12018-09-26 15:04:23 +01002330 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
2331 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002332 ds.base_name_ = StringPrintf("bugreport-%s-%s", device_name.c_str(), build_id.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002333 if (ds.options_->do_add_date) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002334 char date[80];
2335 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
2336 ds.name_ = date;
2337 } else {
2338 ds.name_ = "undated";
2339 }
2340
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002341 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002342 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002343 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002344 ds.base_name_ += "-wifi";
2345 }
2346
Paul Chang0d2aad72020-02-13 20:04:03 +08002347 if (ds.options_->do_screenshot) {
Nandana Dutt9d17b942020-03-26 10:02:59 +00002348 ds.screenshot_path_ = ds.GetPath(ds.CalledByApi() ? "-png.tmp" : ".png");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002349 }
2350 ds.tmp_path_ = ds.GetPath(".tmp");
2351 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
2352
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002353 std::string destination = ds.CalledByApi()
Nandana Dutt54dbd672019-01-11 12:58:05 +00002354 ? StringPrintf("[fd:%d]", ds.options_->bugreport_fd.get())
Nandana Dutt9a76d202019-01-21 15:56:48 +00002355 : ds.bugreport_internal_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01002356 MYLOGD(
Nandana Dutt235c6672019-11-14 15:22:32 +00002357 "Bugreport dir: [%s] "
2358 "Base name: [%s] "
2359 "Suffix: [%s] "
2360 "Log path: [%s] "
2361 "Temporary path: [%s] "
2362 "Screenshot path: [%s]\n",
Nandana Dutt9a76d202019-01-21 15:56:48 +00002363 destination.c_str(), ds.base_name_.c_str(), ds.name_.c_str(), ds.log_path_.c_str(),
2364 ds.tmp_path_.c_str(), ds.screenshot_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002365
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002366 if (ds.options_->do_zip_file) {
Nandana Dutt9d17b942020-03-26 10:02:59 +00002367 ds.path_ = ds.GetPath(ds.CalledByApi() ? "-zip.tmp" : ".zip");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002368 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
2369 create_parent_dirs(ds.path_.c_str());
2370 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
2371 if (ds.zip_file == nullptr) {
2372 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
2373 } else {
2374 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
2375 }
2376 ds.AddTextZipEntry("version.txt", ds.version_);
2377 }
2378}
2379
2380/*
Abhijeet Kaure370d682019-10-01 16:49:30 +01002381 * Finalizes writing to the file by zipping the tmp file to the final location,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002382 * printing zipped file status, etc.
2383 */
2384static void FinalizeFile() {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002385 bool do_text_file = true;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002386 if (ds.options_->do_zip_file) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002387 if (!ds.FinishZipFile()) {
2388 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
2389 do_text_file = true;
2390 } else {
2391 do_text_file = false;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002392 }
2393 }
mhasank2d75c442020-06-11 15:05:25 -07002394
2395 std::string final_path = ds.path_;
2396 if (ds.options_->OutputToCustomFile()) {
mhasank3a4cfb42020-06-15 18:06:43 -07002397 final_path = ds.GetPath(ds.options_->out_dir, ".zip");
mhasank2d75c442020-06-11 15:05:25 -07002398 android::os::CopyFileToFile(ds.path_, final_path);
Nandana Dutt4be45d12018-09-26 15:04:23 +01002399 }
mhasank2d75c442020-06-11 15:05:25 -07002400
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002401 if (ds.options_->use_control_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002402 if (do_text_file) {
2403 dprintf(ds.control_socket_fd_,
2404 "FAIL:could not create zip file, check %s "
2405 "for more details\n",
2406 ds.log_path_.c_str());
2407 } else {
mhasank2d75c442020-06-11 15:05:25 -07002408 dprintf(ds.control_socket_fd_, "OK:%s\n", final_path.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002409 }
2410 }
2411}
2412
Nandana Dutt4be45d12018-09-26 15:04:23 +01002413
Nandana Dutt58d72e22018-11-16 10:30:48 +00002414static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2415 switch (mode) {
2416 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2417 return "BUGREPORT_FULL";
2418 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2419 return "BUGREPORT_INTERACTIVE";
2420 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2421 return "BUGREPORT_REMOTE";
2422 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2423 return "BUGREPORT_WEAR";
2424 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2425 return "BUGREPORT_TELEPHONY";
2426 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2427 return "BUGREPORT_WIFI";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002428 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2429 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002430 }
2431}
2432
Paul Changf59c2b72020-03-10 02:08:55 +08002433static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options,
2434 bool is_screenshot_requested) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002435 // Modify com.android.shell.BugreportProgressService#isDefaultScreenshotRequired as well for
2436 // default system screenshots.
Abhijeet Kaure370d682019-10-01 16:49:30 +01002437 options->bugreport_mode = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002438 switch (mode) {
2439 case Dumpstate::BugreportMode::BUGREPORT_FULL:
Paul Changf59c2b72020-03-10 02:08:55 +08002440 options->do_screenshot = is_screenshot_requested;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002441 options->dumpstate_hal_mode = DumpstateMode::FULL;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002442 break;
2443 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002444 // Currently, the dumpstate binder is only used by Shell to update progress.
2445 options->do_start_service = true;
2446 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002447 options->do_screenshot = is_screenshot_requested;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002448 options->dumpstate_hal_mode = DumpstateMode::INTERACTIVE;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002449 break;
2450 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002451 options->do_vibrate = false;
2452 options->is_remote_mode = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002453 options->do_screenshot = false;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002454 options->dumpstate_hal_mode = DumpstateMode::REMOTE;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002455 break;
2456 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002457 options->do_start_service = true;
2458 options->do_progress_updates = true;
2459 options->do_zip_file = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002460 options->do_screenshot = is_screenshot_requested;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002461 options->dumpstate_hal_mode = DumpstateMode::WEAR;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002462 break;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002463 // TODO(b/148168577) rename TELEPHONY everywhere to CONNECTIVITY.
Nandana Dutt58d72e22018-11-16 10:30:48 +00002464 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002465 options->telephony_only = true;
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002466 options->do_progress_updates = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002467 options->do_screenshot = false;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002468 options->dumpstate_hal_mode = DumpstateMode::CONNECTIVITY;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002469 break;
2470 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002471 options->wifi_only = true;
2472 options->do_zip_file = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002473 options->do_screenshot = false;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002474 options->dumpstate_hal_mode = DumpstateMode::WIFI;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002475 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002476 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2477 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002478 }
2479}
2480
Nandana Dutt58d72e22018-11-16 10:30:48 +00002481static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
Nandana Dutt235c6672019-11-14 15:22:32 +00002482 MYLOGI(
Paul Chang0d2aad72020-02-13 20:04:03 +08002483 "do_zip_file: %d do_vibrate: %d use_socket: %d use_control_socket: %d do_screenshot: %d "
Nandana Dutt235c6672019-11-14 15:22:32 +00002484 "is_remote_mode: %d show_header_only: %d do_start_service: %d telephony_only: %d "
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002485 "wifi_only: %d do_progress_updates: %d fd: %d bugreport_mode: %s dumpstate_hal_mode: %s "
mhasankd451a472020-05-26 18:02:39 -07002486 "limited_only: %d args: %s\n",
Nandana Dutt235c6672019-11-14 15:22:32 +00002487 options.do_zip_file, options.do_vibrate, options.use_socket, options.use_control_socket,
Paul Chang0d2aad72020-02-13 20:04:03 +08002488 options.do_screenshot, options.is_remote_mode, options.show_header_only,
mhasankd451a472020-05-26 18:02:39 -07002489 options.do_start_service, options.telephony_only, options.wifi_only,
2490 options.do_progress_updates, options.bugreport_fd.get(), options.bugreport_mode.c_str(),
2491 toString(options.dumpstate_hal_mode).c_str(), options.limited_only, options.args.c_str());
Nandana Dutt58d72e22018-11-16 10:30:48 +00002492}
2493
Nandana Dutt54dbd672019-01-11 12:58:05 +00002494void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode,
2495 const android::base::unique_fd& bugreport_fd_in,
Paul Changf59c2b72020-03-10 02:08:55 +08002496 const android::base::unique_fd& screenshot_fd_in,
2497 bool is_screenshot_requested) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002498 // In the new API world, date is always added; output is always a zip file.
2499 // TODO(111441001): remove these options once they are obsolete.
2500 do_add_date = true;
2501 do_zip_file = true;
2502
Nandana Dutt54dbd672019-01-11 12:58:05 +00002503 // Duplicate the fds because the passed in fds don't outlive the binder transaction.
2504 bugreport_fd.reset(dup(bugreport_fd_in.get()));
2505 screenshot_fd.reset(dup(screenshot_fd_in.get()));
Nandana Dutt58d72e22018-11-16 10:30:48 +00002506
Paul Changf59c2b72020-03-10 02:08:55 +08002507 SetOptionsFromMode(bugreport_mode, this, is_screenshot_requested);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002508}
2509
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002510Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
2511 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002512 int c;
mhasankd451a472020-05-26 18:02:39 -07002513 while ((c = getopt(argc, argv, "dho:svqzpLPBRSV:w")) != -1) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002514 switch (c) {
2515 // clang-format off
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002516 case 'd': do_add_date = true; break;
2517 case 'z': do_zip_file = true; break;
mhasank3a4cfb42020-06-15 18:06:43 -07002518 case 'o': out_dir = optarg; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002519 case 's': use_socket = true; break;
2520 case 'S': use_control_socket = true; break;
2521 case 'v': show_header_only = true; break;
2522 case 'q': do_vibrate = false; break;
Paul Chang0d2aad72020-02-13 20:04:03 +08002523 case 'p': do_screenshot = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002524 case 'P': do_progress_updates = true; break;
2525 case 'R': is_remote_mode = true; break;
mhasankd451a472020-05-26 18:02:39 -07002526 case 'L': limited_only = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002527 case 'V': break; // compatibility no-op
Nandana Dutt235864b2019-01-22 12:10:16 +00002528 case 'w':
2529 // This was already processed
2530 break;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002531 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002532 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002533 break;
2534 default:
2535 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002536 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002537 break;
2538 // clang-format on
2539 }
2540 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08002541
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002542 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002543 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002544 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002545 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002546 }
2547 }
2548
2549 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
2550 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002551
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002552 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002553}
2554
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002555bool Dumpstate::DumpOptions::ValidateOptions() const {
Nandana Dutt54dbd672019-01-11 12:58:05 +00002556 if (bugreport_fd.get() != -1 && !do_zip_file) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002557 return false;
2558 }
2559
Abhijeet Kaure370d682019-10-01 16:49:30 +01002560 if ((do_zip_file || do_add_date || do_progress_updates) && !OutputToFile()) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002561 return false;
2562 }
2563
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002564 if (use_control_socket && !do_zip_file) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002565 return false;
2566 }
2567
Abhijeet Kaure370d682019-10-01 16:49:30 +01002568 if (is_remote_mode && (do_progress_updates || !do_zip_file || !do_add_date)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002569 return false;
2570 }
2571 return true;
2572}
2573
Nandana Dutt197661d2018-11-16 16:40:21 +00002574void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
2575 options_ = std::move(options);
2576}
2577
Abhijeet Kaura407fb82020-03-27 12:51:12 +00002578void Dumpstate::Initialize() {
2579 /* gets the sequential id */
2580 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
2581 id_ = ++last_id;
2582 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
2583}
2584
Nandana Duttd2f5f082019-01-18 17:13:52 +00002585Dumpstate::RunStatus Dumpstate::Run(int32_t calling_uid, const std::string& calling_package) {
2586 Dumpstate::RunStatus status = RunInternal(calling_uid, calling_package);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002587 if (listener_ != nullptr) {
2588 switch (status) {
2589 case Dumpstate::RunStatus::OK:
Nandana Duttcc4ead82019-01-23 08:29:23 +00002590 listener_->onFinished();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002591 break;
2592 case Dumpstate::RunStatus::HELP:
2593 break;
2594 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002595 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_INVALID_INPUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002596 break;
2597 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002598 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_RUNTIME_ERROR);
2599 break;
2600 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2601 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_DENIED_CONSENT);
2602 break;
2603 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
2604 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_CONSENT_TIMED_OUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002605 break;
2606 }
2607 }
2608 return status;
2609}
2610
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002611void Dumpstate::Cancel() {
2612 CleanupTmpFiles();
2613 android::os::UnlinkAndLogOnError(log_path_);
2614 for (int i = 0; i < NUM_OF_DUMPS; i++) {
2615 android::os::UnlinkAndLogOnError(ds.bugreport_internal_dir_ + "/" +
2616 kDumpstateBoardFiles[i]);
2617 }
2618 tombstone_data_.clear();
2619 anr_data_.clear();
2620}
2621
Nandana Dutt979388e2018-11-30 16:48:55 +00002622/*
2623 * Dumps relevant information to a bugreport based on the given options.
2624 *
2625 * The bugreport can be dumped to a file or streamed to a socket.
2626 *
2627 * How dumping to file works:
2628 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
2629 * stderr is redirected a log file.
2630 *
2631 * The temporary bugreport is then populated via printfs, dumping contents of files and
2632 * output of commands to stdout.
2633 *
2634 * If zipping, the temporary bugreport file is added to the zip archive. Else it's renamed to final
2635 * text file.
2636 *
2637 * If zipping, a bunch of other files and dumps also get added to the zip archive. The log file also
2638 * gets added to the archive.
2639 *
mhasank2d75c442020-06-11 15:05:25 -07002640 * Bugreports are first generated in a local directory and later copied to the caller's fd
2641 * or directory if supplied.
Nandana Dutt979388e2018-11-30 16:48:55 +00002642 */
Nandana Duttd2f5f082019-01-18 17:13:52 +00002643Dumpstate::RunStatus Dumpstate::RunInternal(int32_t calling_uid,
2644 const std::string& calling_package) {
Rhed Jao1c855122020-07-16 17:37:39 +08002645 DurationReporter duration_reporter("RUN INTERNAL", /* logcat_only = */true);
Nandana Dutt979388e2018-11-30 16:48:55 +00002646 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00002647 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002648 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002649 return RunStatus::INVALID_INPUT;
2650 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002651 /* set as high priority, and protect from OOM killer */
2652 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002653
Felipe Lemed071c682016-10-20 16:48:00 -07002654 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002655 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002656 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002657 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002658 } else {
2659 /* fallback to kernels <= 2.6.35 */
2660 oom_adj = fopen("/proc/self/oom_adj", "we");
2661 if (oom_adj) {
2662 fputs("-17", oom_adj);
2663 fclose(oom_adj);
2664 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002665 }
2666
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002667 if (version_ == VERSION_DEFAULT) {
2668 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00002669 }
2670
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002671 if (version_ != VERSION_CURRENT && version_ != VERSION_SPLIT_ANR) {
Vishnu Nair64afc022018-02-01 15:29:34 -08002672 MYLOGE("invalid version requested ('%s'); suppported values are: ('%s', '%s', '%s')\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002673 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str(),
Vishnu Nair64afc022018-02-01 15:29:34 -08002674 VERSION_SPLIT_ANR.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002675 return RunStatus::INVALID_INPUT;
Felipe Lemed071c682016-10-20 16:48:00 -07002676 }
2677
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002678 if (options_->show_header_only) {
2679 PrintHeader();
2680 return RunStatus::OK;
Felipe Lemed071c682016-10-20 16:48:00 -07002681 }
2682
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002683 MYLOGD("dumpstate calling_uid = %d ; calling package = %s \n",
2684 calling_uid, calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00002685
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002686 // Redirect output if needed
Nandana Dutt9a76d202019-01-21 15:56:48 +00002687 bool is_redirecting = options_->OutputToFile();
Felipe Leme7447d7c2016-11-03 18:12:22 -07002688
2689 // TODO: temporarily set progress until it's part of the Dumpstate constructor
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002690 std::string stats_path =
Nandana Dutt979388e2018-11-30 16:48:55 +00002691 is_redirecting
2692 ? android::base::StringPrintf("%s/dumpstate-stats.txt", bugreport_internal_dir_.c_str())
2693 : "";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002694 progress_.reset(new Progress(stats_path));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002695
Sahana Raof35ed432019-07-12 10:47:52 +01002696 if (acquire_wake_lock(PARTIAL_WAKE_LOCK, WAKE_LOCK_NAME) < 0) {
2697 MYLOGE("Failed to acquire wake lock: %s\n", strerror(errno));
2698 } else {
2699 // Wake lock will be released automatically on process death
2700 MYLOGD("Wake lock acquired.\n");
2701 }
2702
Felipe Leme6ae5c4f2017-01-10 14:13:22 -08002703 register_sig_handler();
Felipe Lemed071c682016-10-20 16:48:00 -07002704
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002705 // TODO(b/111441001): maybe skip if already started?
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002706 if (options_->do_start_service) {
Felipe Leme75876a22016-10-27 16:31:27 -07002707 MYLOGI("Starting 'dumpstate' service\n");
2708 android::status_t ret;
2709 if ((ret = android::os::DumpstateService::Start()) != android::OK) {
2710 MYLOGE("Unable to start DumpstateService: %d\n", ret);
2711 }
2712 }
2713
Felipe Lemef0292972016-11-22 13:57:05 -08002714 if (PropertiesHelper::IsDryRun()) {
Felipe Lemed071c682016-10-20 16:48:00 -07002715 MYLOGI("Running on dry-run mode (to disable it, call 'setprop dumpstate.dry_run false')\n");
2716 }
2717
Nandana Dutt235c6672019-11-14 15:22:32 +00002718 MYLOGI("dumpstate info: id=%d, args='%s', bugreport_mode= %s bugreport format version: %s\n",
2719 id_, options_->args.c_str(), options_->bugreport_mode.c_str(), version_.c_str());
Felipe Leme809d74e2016-02-02 12:57:00 -08002720
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002721 do_early_screenshot_ = options_->do_progress_updates;
Felipe Lemee338bf62015-12-07 14:03:50 -08002722
Christopher Ferrised9354f2014-10-01 17:35:01 -07002723 // If we are going to use a socket, do it as early as possible
2724 // to avoid timeouts from bugreport.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002725 if (options_->use_socket) {
Nandana Dutta344cb62019-02-22 15:12:35 +00002726 if (!redirect_to_socket(stdout, "dumpstate")) {
2727 return ERROR;
2728 }
Christopher Ferrised9354f2014-10-01 17:35:01 -07002729 }
2730
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002731 if (options_->use_control_socket) {
Felipe Leme2628e9e2016-04-12 16:36:51 -07002732 MYLOGD("Opening control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002733 control_socket_fd_ = open_socket("dumpstate");
Nandana Dutta344cb62019-02-22 15:12:35 +00002734 if (control_socket_fd_ == -1) {
2735 return ERROR;
2736 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002737 options_->do_progress_updates = 1;
Felipe Leme2628e9e2016-04-12 16:36:51 -07002738 }
2739
Felipe Leme71bbfc52015-11-23 14:14:51 -08002740 if (is_redirecting) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002741 PrepareToWriteToFile();
Felipe Leme1e9edc62015-12-21 16:02:13 -08002742
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002743 if (options_->do_progress_updates) {
Abhijeet Kaure370d682019-10-01 16:49:30 +01002744 // clang-format off
2745 std::vector<std::string> am_args = {
2746 "--receiver-permission", "android.permission.DUMP",
2747 };
2748 // clang-format on
2749 // Send STARTED broadcast for apps that listen to bugreport generation events
2750 SendBroadcast("com.android.internal.intent.action.BUGREPORT_STARTED", am_args);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002751 if (options_->use_control_socket) {
2752 dprintf(control_socket_fd_, "BEGIN:%s\n", path_.c_str());
Felipe Lemeaabfcae2016-07-29 09:49:04 -07002753 }
Felipe Leme71bbfc52015-11-23 14:14:51 -08002754 }
2755 }
2756
Nick Kralevichf3599b32016-01-25 15:05:16 -08002757 /* read /proc/cmdline before dropping root */
2758 FILE *cmdline = fopen("/proc/cmdline", "re");
2759 if (cmdline) {
2760 fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
2761 fclose(cmdline);
2762 }
2763
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002764 if (options_->do_vibrate) {
Felipe Leme35b8cf12017-02-10 15:47:29 -08002765 Vibrate(150);
John Michelau1f794c42012-09-17 11:20:19 -05002766 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002767
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002768 if (options_->do_zip_file && zip_file != nullptr) {
2769 if (chown(path_.c_str(), AID_SHELL, AID_SHELL)) {
2770 MYLOGE("Unable to change ownership of zip file %s: %s\n", path_.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -07002771 strerror(errno));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002772 }
2773 }
2774
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002775 int dup_stdout_fd;
2776 int dup_stderr_fd;
Felipe Leme71bbfc52015-11-23 14:14:51 -08002777 if (is_redirecting) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002778 // Redirect stderr to log_path_ for debugging.
Vishnu Nair20cf5032018-01-05 13:15:49 -08002779 TEMP_FAILURE_RETRY(dup_stderr_fd = dup(fileno(stderr)));
Nandana Dutta344cb62019-02-22 15:12:35 +00002780 if (!redirect_to_file(stderr, const_cast<char*>(log_path_.c_str()))) {
2781 return ERROR;
2782 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002783 if (chown(log_path_.c_str(), AID_SHELL, AID_SHELL)) {
2784 MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n", log_path_.c_str(),
2785 strerror(errno));
Felipe Leme6fe9db62016-02-12 09:04:16 -08002786 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002787
2788 // Redirect stdout to tmp_path_. This is the main bugreport entry and will be
2789 // moved into zip file later, if zipping.
Vishnu Nair20cf5032018-01-05 13:15:49 -08002790 TEMP_FAILURE_RETRY(dup_stdout_fd = dup(fileno(stdout)));
Nandana Dutt979388e2018-11-30 16:48:55 +00002791 // TODO: why not write to a file instead of stdout to overcome this problem?
Felipe Leme6e01fa62015-11-11 19:35:14 -08002792 /* TODO: rather than generating a text file now and zipping it later,
2793 it would be more efficient to redirect stdout to the zip entry
2794 directly, but the libziparchive doesn't support that option yet. */
Nandana Dutta344cb62019-02-22 15:12:35 +00002795 if (!redirect_to_file(stdout, const_cast<char*>(tmp_path_.c_str()))) {
2796 return ERROR;
2797 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002798 if (chown(tmp_path_.c_str(), AID_SHELL, AID_SHELL)) {
Felipe Leme6fe9db62016-02-12 09:04:16 -08002799 MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002800 tmp_path_.c_str(), strerror(errno));
Felipe Leme6fe9db62016-02-12 09:04:16 -08002801 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002802 }
Felipe Lemed8b94e52016-12-08 10:21:44 -08002803
2804 // Don't buffer stdout
2805 setvbuf(stdout, nullptr, _IONBF, 0);
2806
Rhed Jao1c855122020-07-16 17:37:39 +08002807 // Enable the parallel run if the client requests to output to a file.
2808 EnableParallelRunIfNeeded();
2809 // Using scope guard to make sure the dump pool can be shut down correctly.
2810 auto scope_guard_to_shutdown_pool = android::base::make_scope_guard([=]() {
2811 ShutdownDumpPool();
2812 });
2813
Felipe Leme608385d2016-02-01 10:35:38 -08002814 // NOTE: there should be no stdout output until now, otherwise it would break the header.
2815 // In particular, DurationReport objects should be created passing 'title, NULL', so their
Felipe Lemecbce55d2016-02-08 09:53:18 -08002816 // duration is logged into MYLOG instead.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002817 PrintHeader();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002818
mhasankd451a472020-05-26 18:02:39 -07002819 // TODO(b/158737089) reduce code repetition in if branches
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002820 if (options_->telephony_only) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002821 MaybeTakeEarlyScreenshot();
Paul Changc490e662020-04-11 18:14:09 +08002822 onUiIntensiveBugreportDumpsFinished(calling_uid, calling_package);
Jichao Lie89d9c12019-11-21 19:02:51 -08002823 MaybeCheckUserConsent(calling_uid, calling_package);
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08002824 DumpstateTelephonyOnly(calling_package);
Rhed Jao4875aa62020-07-20 17:46:29 +08002825 // TODO(b/136262402) Using thread pool for DumpstateBoard
2826 RUN_SLOW_FUNCTION_AND_LOG(DUMP_BOARD_TASK, DumpstateBoard);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002827 } else if (options_->wifi_only) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002828 MaybeTakeEarlyScreenshot();
Paul Changc490e662020-04-11 18:14:09 +08002829 onUiIntensiveBugreportDumpsFinished(calling_uid, calling_package);
Jichao Lie89d9c12019-11-21 19:02:51 -08002830 MaybeCheckUserConsent(calling_uid, calling_package);
mukesh agrawal253dad42018-01-23 21:59:59 -08002831 DumpstateWifiOnly();
mhasankd451a472020-05-26 18:02:39 -07002832 } else if (options_->limited_only) {
2833 MaybeTakeEarlyScreenshot();
2834 onUiIntensiveBugreportDumpsFinished(calling_uid, calling_package);
2835 MaybeCheckUserConsent(calling_uid, calling_package);
2836 DumpstateLimitedOnly();
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002837 } else {
Paul Chang0d2aad72020-02-13 20:04:03 +08002838 // Invoke critical dumpsys first to preserve system state, before doing anything else.
Jichao Lie89d9c12019-11-21 19:02:51 -08002839 RunDumpsysCritical();
2840
Paul Chang0d2aad72020-02-13 20:04:03 +08002841 // Take screenshot and get consent only after critical dumpsys has finished.
2842 MaybeTakeEarlyScreenshot();
Paul Changc490e662020-04-11 18:14:09 +08002843 onUiIntensiveBugreportDumpsFinished(calling_uid, calling_package);
Jichao Lie89d9c12019-11-21 19:02:51 -08002844 MaybeCheckUserConsent(calling_uid, calling_package);
2845
Nandana Dutt4be45d12018-09-26 15:04:23 +01002846 // Dump state for the default case. This also drops root.
Jichao Lie89d9c12019-11-21 19:02:51 -08002847 RunStatus s = DumpstateDefaultAfterCritical();
Nandana Dutt5c390032019-03-12 10:52:56 +00002848 if (s != RunStatus::OK) {
Nandana Duttaac6f582019-07-26 14:32:47 +01002849 if (s == RunStatus::USER_CONSENT_DENIED) {
Nandana Dutt5c390032019-03-12 10:52:56 +00002850 HandleUserConsentDenied();
2851 }
2852 return s;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002853 }
Zhengyin Qian068ecc72016-08-10 16:48:14 -07002854 }
Felipe Leme71a74ac2016-03-17 15:43:25 -07002855
Felipe Leme55b42a62015-11-10 17:39:08 -08002856 /* close output if needed */
Felipe Leme71bbfc52015-11-23 14:14:51 -08002857 if (is_redirecting) {
Vishnu Nair20cf5032018-01-05 13:15:49 -08002858 TEMP_FAILURE_RETRY(dup2(dup_stdout_fd, fileno(stdout)));
Colin Crossf45fa6b2012-03-26 12:38:26 -07002859 }
2860
Abhijeet Kaure370d682019-10-01 16:49:30 +01002861 // Zip the (now complete) .tmp file within the internal directory.
Nandana Dutt9a76d202019-01-21 15:56:48 +00002862 if (options_->OutputToFile()) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002863 FinalizeFile();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002864 }
2865
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002866 // Share the final file with the caller if the user has consented or Shell is the caller.
Nandana Duttd2f5f082019-01-18 17:13:52 +00002867 Dumpstate::RunStatus status = Dumpstate::RunStatus::OK;
Abhijeet Kaure370d682019-10-01 16:49:30 +01002868 if (CalledByApi()) {
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002869 status = CopyBugreportIfUserConsented(calling_uid);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002870 if (status != Dumpstate::RunStatus::OK &&
2871 status != Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2872 // Do an early return if there were errors. We make an exception for consent
2873 // timing out because it's possible the user got distracted. In this case the
2874 // bugreport is not shared but made available for manual retrieval.
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002875 MYLOGI("User denied consent. Returning\n");
Nandana Duttd2f5f082019-01-18 17:13:52 +00002876 return status;
2877 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002878 if (status == Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2879 MYLOGI(
2880 "Did not receive user consent yet."
2881 " Will not copy the bugreport artifacts to caller.\n");
Abhijeet Kaur57627412019-04-17 16:00:09 +01002882 const String16 incidentcompanion("incidentcompanion");
2883 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
2884 if (ics != nullptr) {
2885 MYLOGD("Canceling user consent request via incidentcompanion service\n");
2886 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
2887 consent_callback_.get());
2888 } else {
2889 MYLOGD("Unable to cancel user consent; incidentcompanion service unavailable\n");
2890 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002891 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00002892 }
2893
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002894 /* vibrate a few but shortly times to let user know it's finished */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002895 if (options_->do_vibrate) {
Takuya Ogawa47f644e2017-12-20 18:09:09 +09002896 for (int i = 0; i < 3; i++) {
2897 Vibrate(75);
2898 usleep((75 + 50) * 1000);
2899 }
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002900 }
2901
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002902 MYLOGD("Final progress: %d/%d (estimated %d)\n", progress_->Get(), progress_->GetMax(),
2903 progress_->GetInitialMax());
2904 progress_->Save();
2905 MYLOGI("done (id %d)\n", id_);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002906
Felipe Leme107a05f2016-03-08 15:11:15 -08002907 if (is_redirecting) {
Vishnu Nair20cf5032018-01-05 13:15:49 -08002908 TEMP_FAILURE_RETRY(dup2(dup_stderr_fd, fileno(stderr)));
Felipe Leme107a05f2016-03-08 15:11:15 -08002909 }
2910
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002911 if (options_->use_control_socket && control_socket_fd_ != -1) {
Felipe Lemee844a9d2016-09-21 15:01:39 -07002912 MYLOGD("Closing control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002913 close(control_socket_fd_);
Felipe Leme2628e9e2016-04-12 16:36:51 -07002914 }
2915
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002916 tombstone_data_.clear();
2917 anr_data_.clear();
Narayan Kamath6b9516c2017-10-27 11:15:51 +01002918
Nandana Duttd2f5f082019-01-18 17:13:52 +00002919 return (consent_callback_ != nullptr &&
2920 consent_callback_->getResult() == UserConsentResult::UNAVAILABLE)
2921 ? USER_CONSENT_TIMED_OUT
2922 : RunStatus::OK;
2923}
2924
Paul Chang0d2aad72020-02-13 20:04:03 +08002925void Dumpstate::MaybeTakeEarlyScreenshot() {
2926 if (!options_->do_screenshot || !do_early_screenshot_) {
2927 return;
2928 }
2929
2930 TakeScreenshot();
2931}
2932
Paul Changc490e662020-04-11 18:14:09 +08002933void Dumpstate::onUiIntensiveBugreportDumpsFinished(int32_t calling_uid,
2934 const std::string& calling_package) {
2935 if (calling_uid == AID_SHELL || !CalledByApi()) {
2936 return;
2937 }
2938 if (listener_ != nullptr) {
2939 // Let listener know ui intensive bugreport dumps are finished, then it can do event
2940 // handling if required.
2941 android::String16 package(calling_package.c_str());
2942 listener_->onUiIntensiveBugreportDumpsFinished(package);
2943 }
2944}
2945
Jichao Lie89d9c12019-11-21 19:02:51 -08002946void Dumpstate::MaybeCheckUserConsent(int32_t calling_uid, const std::string& calling_package) {
2947 if (calling_uid == AID_SHELL || !CalledByApi()) {
2948 // No need to get consent for shell triggered dumpstates, or not through
2949 // bugreporting API (i.e. no fd to copy back).
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002950 return;
2951 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00002952 consent_callback_ = new ConsentCallback();
2953 const String16 incidentcompanion("incidentcompanion");
2954 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
Jichao Lie89d9c12019-11-21 19:02:51 -08002955 android::String16 package(calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00002956 if (ics != nullptr) {
2957 MYLOGD("Checking user consent via incidentcompanion service\n");
2958 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
Jichao Lie89d9c12019-11-21 19:02:51 -08002959 calling_uid, package, String16(), String16(),
Joe Onorato1c36d752019-03-17 18:26:43 -07002960 0x1 /* FLAG_CONFIRMATION_DIALOG */, consent_callback_.get());
Nandana Duttd2f5f082019-01-18 17:13:52 +00002961 } else {
2962 MYLOGD("Unable to check user consent; incidentcompanion service unavailable\n");
2963 }
2964}
2965
Nandana Dutt5c390032019-03-12 10:52:56 +00002966bool Dumpstate::IsUserConsentDenied() const {
2967 return ds.consent_callback_ != nullptr &&
2968 ds.consent_callback_->getResult() == UserConsentResult::DENIED;
2969}
2970
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002971bool Dumpstate::CalledByApi() const {
2972 return ds.options_->bugreport_fd.get() != -1 ? true : false;
2973}
2974
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002975void Dumpstate::CleanupTmpFiles() {
Nandana Duttd2f5f082019-01-18 17:13:52 +00002976 android::os::UnlinkAndLogOnError(tmp_path_);
2977 android::os::UnlinkAndLogOnError(screenshot_path_);
2978 android::os::UnlinkAndLogOnError(path_);
2979}
2980
Rhed Jao1c855122020-07-16 17:37:39 +08002981void Dumpstate::EnableParallelRunIfNeeded() {
2982 // The thread pool needs to create temporary files to receive dump results.
2983 // That's why we only enable it when the bugreport client chooses to output
2984 // to a file.
2985 if (!PropertiesHelper::IsParallelRun() || !options_->OutputToFile()) {
2986 return;
2987 }
2988 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao4875aa62020-07-20 17:46:29 +08002989 zip_entry_tasks_ = std::make_unique<TaskQueue>();
Rhed Jao1c855122020-07-16 17:37:39 +08002990}
2991
2992void Dumpstate::ShutdownDumpPool() {
2993 if (dump_pool_) {
2994 dump_pool_->shutdown();
2995 dump_pool_ = nullptr;
2996 }
Rhed Jao4875aa62020-07-20 17:46:29 +08002997 if (zip_entry_tasks_) {
2998 zip_entry_tasks_->run(/* do_cancel = */true);
2999 zip_entry_tasks_ = nullptr;
3000 }
3001}
3002
3003void Dumpstate::EnqueueAddZipEntryAndCleanupIfNeeded(const std::string& entry_name,
3004 const std::string& entry_path) {
3005 auto func_add_zip_entry_and_cleanup = [=](bool task_cancelled) {
3006 if (!task_cancelled) {
3007 AddZipEntry(entry_name, entry_path);
3008 }
3009 android::os::UnlinkAndLogOnError(entry_path);
3010 };
3011 if (zip_entry_tasks_) {
3012 // Enqueues AddZipEntryAndCleanup function if the parallel run is enabled.
3013 zip_entry_tasks_->add(func_add_zip_entry_and_cleanup, _1);
3014 } else {
3015 // Invokes AddZipEntryAndCleanup immediately
3016 std::invoke(func_add_zip_entry_and_cleanup, /* task_cancelled = */false);
3017 }
Rhed Jao1c855122020-07-16 17:37:39 +08003018}
3019
Nandana Duttd2f5f082019-01-18 17:13:52 +00003020Dumpstate::RunStatus Dumpstate::HandleUserConsentDenied() {
3021 MYLOGD("User denied consent; deleting files and returning\n");
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003022 CleanupTmpFiles();
Nandana Duttd2f5f082019-01-18 17:13:52 +00003023 return USER_CONSENT_DENIED;
3024}
3025
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003026Dumpstate::RunStatus Dumpstate::CopyBugreportIfUserConsented(int32_t calling_uid) {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003027 // If the caller has asked to copy the bugreport over to their directory, we need explicit
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003028 // user consent (unless the caller is Shell).
3029 UserConsentResult consent_result;
3030 if (calling_uid == AID_SHELL) {
3031 consent_result = UserConsentResult::APPROVED;
3032 } else {
3033 consent_result = consent_callback_->getResult();
3034 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003035 if (consent_result == UserConsentResult::UNAVAILABLE) {
3036 // User has not responded yet.
3037 uint64_t elapsed_ms = consent_callback_->getElapsedTimeMs();
Hunter Knepshield70610fa2020-01-03 15:27:33 -08003038 // Telephony is a fast report type, particularly on user builds where information may be
3039 // more aggressively limited. To give the user time to read the consent dialog, increase the
3040 // timeout.
3041 uint64_t timeout_ms = options_->telephony_only ? TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS
3042 : USER_CONSENT_TIMEOUT_MS;
3043 if (elapsed_ms < timeout_ms) {
3044 uint delay_seconds = (timeout_ms - elapsed_ms) / 1000;
Nandana Duttd2f5f082019-01-18 17:13:52 +00003045 MYLOGD("Did not receive user consent yet; going to wait for %d seconds", delay_seconds);
3046 sleep(delay_seconds);
3047 }
3048 consent_result = consent_callback_->getResult();
3049 }
3050 if (consent_result == UserConsentResult::DENIED) {
3051 // User has explicitly denied sharing with the app. To be safe delete the
3052 // internal bugreport & tmp files.
3053 return HandleUserConsentDenied();
3054 }
3055 if (consent_result == UserConsentResult::APPROVED) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00003056 bool copy_succeeded = android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
3057 if (copy_succeeded) {
3058 android::os::UnlinkAndLogOnError(path_);
Abhijeet Kaur9ce94672020-04-01 17:22:36 +01003059 if (options_->do_screenshot &&
3060 options_->screenshot_fd.get() != -1 &&
3061 !options_->is_screenshot_copied) {
3062 copy_succeeded = android::os::CopyFileToFd(screenshot_path_,
3063 options_->screenshot_fd.get());
3064 options_->is_screenshot_copied = copy_succeeded;
3065 if (copy_succeeded) {
3066 android::os::UnlinkAndLogOnError(screenshot_path_);
3067 }
3068 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003069 }
3070 return copy_succeeded ? Dumpstate::RunStatus::OK : Dumpstate::RunStatus::ERROR;
3071 } else if (consent_result == UserConsentResult::UNAVAILABLE) {
3072 // consent_result is still UNAVAILABLE. The user has likely not responded yet.
3073 // Since we do not have user consent to share the bugreport it does not get
3074 // copied over to the calling app but remains in the internal directory from
3075 // where the user can manually pull it.
3076 return Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT;
3077 }
3078 // Unknown result; must be a programming error.
3079 MYLOGE("Unknown user consent result:%d\n", consent_result);
3080 return Dumpstate::RunStatus::ERROR;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003081}
3082
Nandana Duttf02564e2019-02-15 15:24:24 +00003083Dumpstate::RunStatus Dumpstate::ParseCommandlineAndRun(int argc, char* argv[]) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003084 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
3085 Dumpstate::RunStatus status = options->Initialize(argc, argv);
3086 if (status == Dumpstate::RunStatus::OK) {
Nandana Duttf02564e2019-02-15 15:24:24 +00003087 SetOptions(std::move(options));
Nandana Duttd2f5f082019-01-18 17:13:52 +00003088 // When directly running dumpstate binary, the output is not expected to be written
3089 // to any external file descriptor.
Nandana Duttf02564e2019-02-15 15:24:24 +00003090 assert(options_->bugreport_fd.get() == -1);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003091
3092 // calling_uid and calling_package are for user consent to share the bugreport with
Abhijeet Kaura407fb82020-03-27 12:51:12 +00003093 // an app; they are irrelevant here because bugreport is triggered via command line.
3094 // Update Last ID before calling Run().
3095 Initialize();
Nandana Duttf02564e2019-02-15 15:24:24 +00003096 status = Run(-1 /* calling_uid */, "" /* calling_package */);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003097 }
Nandana Duttf02564e2019-02-15 15:24:24 +00003098 return status;
3099}
3100
3101/* Main entry point for dumpstate binary. */
3102int run_main(int argc, char* argv[]) {
3103 Dumpstate::RunStatus status = ds.ParseCommandlineAndRun(argc, argv);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003104
3105 switch (status) {
3106 case Dumpstate::RunStatus::OK:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003107 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003108 case Dumpstate::RunStatus::HELP:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003109 ShowUsage();
3110 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003111 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003112 fprintf(stderr, "Invalid combination of args\n");
3113 ShowUsage();
3114 exit(1);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003115 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00003116 FALLTHROUGH_INTENDED;
3117 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
3118 FALLTHROUGH_INTENDED;
3119 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003120 exit(2);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003121 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003122}
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003123
3124// TODO(111441001): Default DumpOptions to sensible values.
3125Dumpstate::Dumpstate(const std::string& version)
3126 : pid_(getpid()),
3127 options_(new Dumpstate::DumpOptions()),
Nandana Duttf02cd782019-06-14 14:25:13 +01003128 last_reported_percent_progress_(0),
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003129 version_(version),
3130 now_(time(nullptr)) {
3131}
3132
3133Dumpstate& Dumpstate::GetInstance() {
3134 static Dumpstate singleton_(android::base::GetProperty("dumpstate.version", VERSION_CURRENT));
3135 return singleton_;
3136}
3137
Rhed Jao1c855122020-07-16 17:37:39 +08003138DurationReporter::DurationReporter(const std::string& title, bool logcat_only, bool verbose,
3139 int duration_fd) : title_(title), logcat_only_(logcat_only), verbose_(verbose),
3140 duration_fd_(duration_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003141 if (!title_.empty()) {
3142 started_ = Nanotime();
3143 }
3144}
3145
3146DurationReporter::~DurationReporter() {
3147 if (!title_.empty()) {
3148 float elapsed = (float)(Nanotime() - started_) / NANOS_PER_SEC;
chenqiwuaf8b2d92019-12-12 18:53:51 +08003149 if (elapsed >= .5f || verbose_) {
3150 MYLOGD("Duration of '%s': %.2fs\n", title_.c_str(), elapsed);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003151 }
chenqiwuaf8b2d92019-12-12 18:53:51 +08003152 if (!logcat_only_) {
3153 // Use "Yoda grammar" to make it easier to grep|sort sections.
Rhed Jao1c855122020-07-16 17:37:39 +08003154 dprintf(duration_fd_, "------ %.3fs was the duration of '%s' ------\n",
3155 elapsed, title_.c_str());
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003156 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003157 }
3158}
3159
3160const int32_t Progress::kDefaultMax = 5000;
3161
3162Progress::Progress(const std::string& path) : Progress(Progress::kDefaultMax, 1.1, path) {
3163}
3164
3165Progress::Progress(int32_t initial_max, int32_t progress, float growth_factor)
3166 : Progress(initial_max, growth_factor, "") {
3167 progress_ = progress;
3168}
3169
3170Progress::Progress(int32_t initial_max, float growth_factor, const std::string& path)
3171 : initial_max_(initial_max),
3172 progress_(0),
3173 max_(initial_max),
3174 growth_factor_(growth_factor),
3175 n_runs_(0),
3176 average_max_(0),
3177 path_(path) {
3178 if (!path_.empty()) {
3179 Load();
3180 }
3181}
3182
3183void Progress::Load() {
3184 MYLOGD("Loading stats from %s\n", path_.c_str());
3185 std::string content;
3186 if (!android::base::ReadFileToString(path_, &content)) {
3187 MYLOGI("Could not read stats from %s; using max of %d\n", path_.c_str(), max_);
3188 return;
3189 }
3190 if (content.empty()) {
3191 MYLOGE("No stats (empty file) on %s; using max of %d\n", path_.c_str(), max_);
3192 return;
3193 }
3194 std::vector<std::string> lines = android::base::Split(content, "\n");
3195
3196 if (lines.size() < 1) {
3197 MYLOGE("Invalid stats on file %s: not enough lines (%d). Using max of %d\n", path_.c_str(),
3198 (int)lines.size(), max_);
3199 return;
3200 }
3201 char* ptr;
3202 n_runs_ = strtol(lines[0].c_str(), &ptr, 10);
3203 average_max_ = strtol(ptr, nullptr, 10);
3204 if (n_runs_ <= 0 || average_max_ <= 0 || n_runs_ > STATS_MAX_N_RUNS ||
3205 average_max_ > STATS_MAX_AVERAGE) {
3206 MYLOGE("Invalid stats line on file %s: %s\n", path_.c_str(), lines[0].c_str());
3207 initial_max_ = Progress::kDefaultMax;
3208 } else {
3209 initial_max_ = average_max_;
3210 }
3211 max_ = initial_max_;
3212
3213 MYLOGI("Average max progress: %d in %d runs; estimated max: %d\n", average_max_, n_runs_, max_);
3214}
3215
3216void Progress::Save() {
3217 int32_t total = n_runs_ * average_max_ + progress_;
3218 int32_t runs = n_runs_ + 1;
3219 int32_t average = floor(((float)total) / runs);
3220 MYLOGI("Saving stats (total=%d, runs=%d, average=%d) on %s\n", total, runs, average,
3221 path_.c_str());
3222 if (path_.empty()) {
3223 return;
3224 }
3225
3226 std::string content = android::base::StringPrintf("%d %d\n", runs, average);
3227 if (!android::base::WriteStringToFile(content, path_)) {
3228 MYLOGE("Could not save stats on %s\n", path_.c_str());
3229 }
3230}
3231
3232int32_t Progress::Get() const {
3233 return progress_;
3234}
3235
3236bool Progress::Inc(int32_t delta_sec) {
3237 bool changed = false;
3238 if (delta_sec >= 0) {
3239 progress_ += delta_sec;
3240 if (progress_ > max_) {
3241 int32_t old_max = max_;
3242 max_ = floor((float)progress_ * growth_factor_);
3243 MYLOGD("Adjusting max progress from %d to %d\n", old_max, max_);
3244 changed = true;
3245 }
3246 }
3247 return changed;
3248}
3249
3250int32_t Progress::GetMax() const {
3251 return max_;
3252}
3253
3254int32_t Progress::GetInitialMax() const {
3255 return initial_max_;
3256}
3257
3258void Progress::Dump(int fd, const std::string& prefix) const {
3259 const char* pr = prefix.c_str();
3260 dprintf(fd, "%sprogress: %d\n", pr, progress_);
3261 dprintf(fd, "%smax: %d\n", pr, max_);
3262 dprintf(fd, "%sinitial_max: %d\n", pr, initial_max_);
3263 dprintf(fd, "%sgrowth_factor: %0.2f\n", pr, growth_factor_);
3264 dprintf(fd, "%spath: %s\n", pr, path_.c_str());
3265 dprintf(fd, "%sn_runs: %d\n", pr, n_runs_);
3266 dprintf(fd, "%saverage_max: %d\n", pr, average_max_);
3267}
3268
3269bool Dumpstate::IsZipping() const {
3270 return zip_writer_ != nullptr;
3271}
3272
3273std::string Dumpstate::GetPath(const std::string& suffix) const {
3274 return GetPath(bugreport_internal_dir_, suffix);
3275}
3276
3277std::string Dumpstate::GetPath(const std::string& directory, const std::string& suffix) const {
3278 return android::base::StringPrintf("%s/%s-%s%s", directory.c_str(), base_name_.c_str(),
3279 name_.c_str(), suffix.c_str());
3280}
3281
3282void Dumpstate::SetProgress(std::unique_ptr<Progress> progress) {
3283 progress_ = std::move(progress);
3284}
3285
3286void for_each_userid(void (*func)(int), const char *header) {
3287 std::string title = header == nullptr ? "for_each_userid" : android::base::StringPrintf(
3288 "for_each_userid(%s)", header);
3289 DurationReporter duration_reporter(title);
3290 if (PropertiesHelper::IsDryRun()) return;
3291
3292 DIR *d;
3293 struct dirent *de;
3294
3295 if (header) printf("\n------ %s ------\n", header);
3296 func(0);
3297
3298 if (!(d = opendir("/data/system/users"))) {
3299 printf("Failed to open /data/system/users (%s)\n", strerror(errno));
3300 return;
3301 }
3302
3303 while ((de = readdir(d))) {
3304 int userid;
3305 if (de->d_type != DT_DIR || !(userid = atoi(de->d_name))) {
3306 continue;
3307 }
3308 func(userid);
3309 }
3310
3311 closedir(d);
3312}
3313
3314static void __for_each_pid(void (*helper)(int, const char *, void *), const char *header, void *arg) {
3315 DIR *d;
3316 struct dirent *de;
3317
3318 if (!(d = opendir("/proc"))) {
3319 printf("Failed to open /proc (%s)\n", strerror(errno));
3320 return;
3321 }
3322
3323 if (header) printf("\n------ %s ------\n", header);
3324 while ((de = readdir(d))) {
3325 if (ds.IsUserConsentDenied()) {
3326 MYLOGE(
3327 "Returning early because user denied consent to share bugreport with calling app.");
3328 closedir(d);
3329 return;
3330 }
3331 int pid;
3332 int fd;
3333 char cmdpath[255];
3334 char cmdline[255];
3335
3336 if (!(pid = atoi(de->d_name))) {
3337 continue;
3338 }
3339
3340 memset(cmdline, 0, sizeof(cmdline));
3341
3342 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/cmdline", pid);
3343 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3344 TEMP_FAILURE_RETRY(read(fd, cmdline, sizeof(cmdline) - 2));
3345 close(fd);
3346 if (cmdline[0]) {
3347 helper(pid, cmdline, arg);
3348 continue;
3349 }
3350 }
3351
3352 // if no cmdline, a kernel thread has comm
3353 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/comm", pid);
3354 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3355 TEMP_FAILURE_RETRY(read(fd, cmdline + 1, sizeof(cmdline) - 4));
3356 close(fd);
3357 if (cmdline[1]) {
3358 cmdline[0] = '[';
3359 size_t len = strcspn(cmdline, "\f\b\r\n");
3360 cmdline[len] = ']';
3361 cmdline[len+1] = '\0';
3362 }
3363 }
3364 if (!cmdline[0]) {
3365 strcpy(cmdline, "N/A");
3366 }
3367 helper(pid, cmdline, arg);
3368 }
3369
3370 closedir(d);
3371}
3372
3373static void for_each_pid_helper(int pid, const char *cmdline, void *arg) {
3374 for_each_pid_func *func = (for_each_pid_func*) arg;
3375 func(pid, cmdline);
3376}
3377
3378void for_each_pid(for_each_pid_func func, const char *header) {
3379 std::string title = header == nullptr ? "for_each_pid"
3380 : android::base::StringPrintf("for_each_pid(%s)", header);
3381 DurationReporter duration_reporter(title);
3382 if (PropertiesHelper::IsDryRun()) return;
3383
3384 __for_each_pid(for_each_pid_helper, header, (void *) func);
3385}
3386
3387static void for_each_tid_helper(int pid, const char *cmdline, void *arg) {
3388 DIR *d;
3389 struct dirent *de;
3390 char taskpath[255];
3391 for_each_tid_func *func = (for_each_tid_func *) arg;
3392
3393 snprintf(taskpath, sizeof(taskpath), "/proc/%d/task", pid);
3394
3395 if (!(d = opendir(taskpath))) {
3396 printf("Failed to open %s (%s)\n", taskpath, strerror(errno));
3397 return;
3398 }
3399
3400 func(pid, pid, cmdline);
3401
3402 while ((de = readdir(d))) {
3403 if (ds.IsUserConsentDenied()) {
3404 MYLOGE(
3405 "Returning early because user denied consent to share bugreport with calling app.");
3406 closedir(d);
3407 return;
3408 }
3409 int tid;
3410 int fd;
3411 char commpath[255];
3412 char comm[255];
3413
3414 if (!(tid = atoi(de->d_name))) {
3415 continue;
3416 }
3417
3418 if (tid == pid)
3419 continue;
3420
3421 snprintf(commpath, sizeof(commpath), "/proc/%d/comm", tid);
3422 memset(comm, 0, sizeof(comm));
3423 if ((fd = TEMP_FAILURE_RETRY(open(commpath, O_RDONLY | O_CLOEXEC))) < 0) {
3424 strcpy(comm, "N/A");
3425 } else {
3426 char *c;
3427 TEMP_FAILURE_RETRY(read(fd, comm, sizeof(comm) - 2));
3428 close(fd);
3429
3430 c = strrchr(comm, '\n');
3431 if (c) {
3432 *c = '\0';
3433 }
3434 }
3435 func(pid, tid, comm);
3436 }
3437
3438 closedir(d);
3439}
3440
3441void for_each_tid(for_each_tid_func func, const char *header) {
3442 std::string title = header == nullptr ? "for_each_tid"
3443 : android::base::StringPrintf("for_each_tid(%s)", header);
3444 DurationReporter duration_reporter(title);
3445
3446 if (PropertiesHelper::IsDryRun()) return;
3447
3448 __for_each_pid(for_each_tid_helper, header, (void *) func);
3449}
3450
3451void show_wchan(int pid, int tid, const char *name) {
3452 if (PropertiesHelper::IsDryRun()) return;
3453
3454 char path[255];
3455 char buffer[255];
3456 int fd, ret, save_errno;
3457 char name_buffer[255];
3458
3459 memset(buffer, 0, sizeof(buffer));
3460
3461 snprintf(path, sizeof(path), "/proc/%d/wchan", tid);
3462 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3463 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3464 return;
3465 }
3466
3467 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3468 save_errno = errno;
3469 close(fd);
3470
3471 if (ret < 0) {
3472 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3473 return;
3474 }
3475
3476 snprintf(name_buffer, sizeof(name_buffer), "%*s%s",
3477 pid == tid ? 0 : 3, "", name);
3478
3479 printf("%-7d %-32s %s\n", tid, name_buffer, buffer);
3480
3481 return;
3482}
3483
3484// print time in centiseconds
3485static void snprcent(char *buffer, size_t len, size_t spc,
3486 unsigned long long time) {
3487 static long hz; // cache discovered hz
3488
3489 if (hz <= 0) {
3490 hz = sysconf(_SC_CLK_TCK);
3491 if (hz <= 0) {
3492 hz = 1000;
3493 }
3494 }
3495
3496 // convert to centiseconds
3497 time = (time * 100 + (hz / 2)) / hz;
3498
3499 char str[16];
3500
3501 snprintf(str, sizeof(str), " %llu.%02u",
3502 time / 100, (unsigned)(time % 100));
3503 size_t offset = strlen(buffer);
3504 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3505 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3506}
3507
3508// print permille as a percent
3509static void snprdec(char *buffer, size_t len, size_t spc, unsigned permille) {
3510 char str[16];
3511
3512 snprintf(str, sizeof(str), " %u.%u%%", permille / 10, permille % 10);
3513 size_t offset = strlen(buffer);
3514 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3515 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3516}
3517
3518void show_showtime(int pid, const char *name) {
3519 if (PropertiesHelper::IsDryRun()) return;
3520
3521 char path[255];
3522 char buffer[1023];
3523 int fd, ret, save_errno;
3524
3525 memset(buffer, 0, sizeof(buffer));
3526
3527 snprintf(path, sizeof(path), "/proc/%d/stat", pid);
3528 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3529 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3530 return;
3531 }
3532
3533 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3534 save_errno = errno;
3535 close(fd);
3536
3537 if (ret < 0) {
3538 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3539 return;
3540 }
3541
3542 // field 14 is utime
3543 // field 15 is stime
3544 // field 42 is iotime
3545 unsigned long long utime = 0, stime = 0, iotime = 0;
3546 if (sscanf(buffer,
3547 "%*u %*s %*s %*d %*d %*d %*d %*d %*d %*d %*d "
3548 "%*d %*d %llu %llu %*d %*d %*d %*d %*d %*d "
3549 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %*d "
3550 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %llu ",
3551 &utime, &stime, &iotime) != 3) {
3552 return;
3553 }
3554
3555 unsigned long long total = utime + stime;
3556 if (!total) {
3557 return;
3558 }
3559
3560 unsigned permille = (iotime * 1000 + (total / 2)) / total;
3561 if (permille > 1000) {
3562 permille = 1000;
3563 }
3564
3565 // try to beautify and stabilize columns at <80 characters
3566 snprintf(buffer, sizeof(buffer), "%-6d%s", pid, name);
3567 if ((name[0] != '[') || utime) {
3568 snprcent(buffer, sizeof(buffer), 57, utime);
3569 }
3570 snprcent(buffer, sizeof(buffer), 65, stime);
3571 if ((name[0] != '[') || iotime) {
3572 snprcent(buffer, sizeof(buffer), 73, iotime);
3573 }
3574 if (iotime) {
3575 snprdec(buffer, sizeof(buffer), 79, permille);
3576 }
3577 puts(buffer); // adds a trailing newline
3578
3579 return;
3580}
3581
3582void do_dmesg() {
3583 const char *title = "KERNEL LOG (dmesg)";
3584 DurationReporter duration_reporter(title);
3585 printf("------ %s ------\n", title);
3586
3587 if (PropertiesHelper::IsDryRun()) return;
3588
3589 /* Get size of kernel buffer */
3590 int size = klogctl(KLOG_SIZE_BUFFER, nullptr, 0);
3591 if (size <= 0) {
3592 printf("Unexpected klogctl return value: %d\n\n", size);
3593 return;
3594 }
3595 char *buf = (char *) malloc(size + 1);
3596 if (buf == nullptr) {
3597 printf("memory allocation failed\n\n");
3598 return;
3599 }
3600 int retval = klogctl(KLOG_READ_ALL, buf, size);
3601 if (retval < 0) {
3602 printf("klogctl failure\n\n");
3603 free(buf);
3604 return;
3605 }
3606 buf[retval] = '\0';
3607 printf("%s\n\n", buf);
3608 free(buf);
3609 return;
3610}
3611
3612void do_showmap(int pid, const char *name) {
3613 char title[255];
3614 char arg[255];
3615
3616 snprintf(title, sizeof(title), "SHOW MAP %d (%s)", pid, name);
3617 snprintf(arg, sizeof(arg), "%d", pid);
3618 RunCommand(title, {"showmap", "-q", arg}, CommandOptions::AS_ROOT);
3619}
3620
3621int Dumpstate::DumpFile(const std::string& title, const std::string& path) {
3622 DurationReporter duration_reporter(title);
3623
3624 int status = DumpFileToFd(STDOUT_FILENO, title, path);
3625
3626 UpdateProgress(WEIGHT_FILE);
3627
3628 return status;
3629}
3630
3631int read_file_as_long(const char *path, long int *output) {
3632 int fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC));
3633 if (fd < 0) {
3634 int err = errno;
3635 MYLOGE("Error opening file descriptor for %s: %s\n", path, strerror(err));
3636 return -1;
3637 }
3638 char buffer[50];
3639 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3640 if (bytes_read == -1) {
3641 MYLOGE("Error reading file %s: %s\n", path, strerror(errno));
3642 return -2;
3643 }
3644 if (bytes_read == 0) {
3645 MYLOGE("File %s is empty\n", path);
3646 return -3;
3647 }
3648 *output = atoi(buffer);
3649 return 0;
3650}
3651
3652/* calls skip to gate calling dump_from_fd recursively
3653 * in the specified directory. dump_from_fd defaults to
3654 * dump_file_from_fd above when set to NULL. skip defaults
3655 * to false when set to NULL. dump_from_fd will always be
3656 * called with title NULL.
3657 */
3658int dump_files(const std::string& title, const char* dir, bool (*skip)(const char* path),
3659 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
3660 DurationReporter duration_reporter(title);
3661 DIR *dirp;
3662 struct dirent *d;
3663 char *newpath = nullptr;
3664 const char *slash = "/";
3665 int retval = 0;
3666
3667 if (!title.empty()) {
3668 printf("------ %s (%s) ------\n", title.c_str(), dir);
3669 }
3670 if (PropertiesHelper::IsDryRun()) return 0;
3671
3672 if (dir[strlen(dir) - 1] == '/') {
3673 ++slash;
3674 }
3675 dirp = opendir(dir);
3676 if (dirp == nullptr) {
3677 retval = -errno;
3678 MYLOGE("%s: %s\n", dir, strerror(errno));
3679 return retval;
3680 }
3681
3682 if (!dump_from_fd) {
3683 dump_from_fd = dump_file_from_fd;
3684 }
3685 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
3686 if ((d->d_name[0] == '.')
3687 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
3688 || (d->d_name[1] == '\0'))) {
3689 continue;
3690 }
3691 asprintf(&newpath, "%s%s%s%s", dir, slash, d->d_name,
3692 (d->d_type == DT_DIR) ? "/" : "");
3693 if (!newpath) {
3694 retval = -errno;
3695 continue;
3696 }
3697 if (skip && (*skip)(newpath)) {
3698 continue;
3699 }
3700 if (d->d_type == DT_DIR) {
3701 int ret = dump_files("", newpath, skip, dump_from_fd);
3702 if (ret < 0) {
3703 retval = ret;
3704 }
3705 continue;
3706 }
3707 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(newpath, O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
3708 if (fd.get() < 0) {
3709 retval = -1;
3710 printf("*** %s: %s\n", newpath, strerror(errno));
3711 continue;
3712 }
3713 (*dump_from_fd)(nullptr, newpath, fd.get());
3714 }
3715 closedir(dirp);
3716 if (!title.empty()) {
3717 printf("\n");
3718 }
3719 return retval;
3720}
3721
3722/* fd must have been opened with the flag O_NONBLOCK. With this flag set,
3723 * it's possible to avoid issues where opening the file itself can get
3724 * stuck.
3725 */
3726int dump_file_from_fd(const char *title, const char *path, int fd) {
3727 if (PropertiesHelper::IsDryRun()) return 0;
3728
3729 int flags = fcntl(fd, F_GETFL);
3730 if (flags == -1) {
3731 printf("*** %s: failed to get flags on fd %d: %s\n", path, fd, strerror(errno));
3732 return -1;
3733 } else if (!(flags & O_NONBLOCK)) {
3734 printf("*** %s: fd must have O_NONBLOCK set.\n", path);
3735 return -1;
3736 }
3737 return DumpFileFromFdToFd(title, path, fd, STDOUT_FILENO, PropertiesHelper::IsDryRun());
3738}
3739
3740int Dumpstate::RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Rhed Jao4875aa62020-07-20 17:46:29 +08003741 const CommandOptions& options, bool verbose_duration, int out_fd) {
3742 DurationReporter duration_reporter(title, false /* logcat_only */,
3743 verbose_duration, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003744
Rhed Jao4875aa62020-07-20 17:46:29 +08003745 int status = RunCommandToFd(out_fd, title, full_command, options);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003746
3747 /* TODO: for now we're simplifying the progress calculation by using the
3748 * timeout as the weight. It's a good approximation for most cases, except when calling dumpsys,
3749 * where its weight should be much higher proportionally to its timeout.
3750 * Ideally, it should use a options.EstimatedDuration() instead...*/
3751 UpdateProgress(options.Timeout());
3752
3753 return status;
3754}
3755
3756void Dumpstate::RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsys_args,
3757 const CommandOptions& options, long dumpsysTimeoutMs) {
3758 long timeout_ms = dumpsysTimeoutMs > 0 ? dumpsysTimeoutMs : options.TimeoutInMs();
3759 std::vector<std::string> dumpsys = {"/system/bin/dumpsys", "-T", std::to_string(timeout_ms)};
3760 dumpsys.insert(dumpsys.end(), dumpsys_args.begin(), dumpsys_args.end());
3761 RunCommand(title, dumpsys, options);
3762}
3763
3764int open_socket(const char *service) {
3765 int s = android_get_control_socket(service);
3766 if (s < 0) {
3767 MYLOGE("android_get_control_socket(%s): %s\n", service, strerror(errno));
3768 return -1;
3769 }
3770 fcntl(s, F_SETFD, FD_CLOEXEC);
3771
3772 // Set backlog to 0 to make sure that queue size will be minimum.
3773 // In Linux, because the minimum queue will be 1, connect() will be blocked
3774 // if the other clients already called connect() and the connection request was not accepted.
3775 if (listen(s, 0) < 0) {
3776 MYLOGE("listen(control socket): %s\n", strerror(errno));
3777 return -1;
3778 }
3779
3780 struct sockaddr addr;
3781 socklen_t alen = sizeof(addr);
Abhijeet Kaur2113cae2019-09-13 09:24:15 +01003782 int fd = accept4(s, &addr, &alen, SOCK_CLOEXEC);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003783
3784 // Close socket just after accept(), to make sure that connect() by client will get error
3785 // when the socket is used by the other services.
3786 // There is still a race condition possibility between accept and close, but there is no way
3787 // to close-on-accept atomically.
3788 // See detail; b/123306389#comment25
3789 close(s);
3790
3791 if (fd < 0) {
3792 MYLOGE("accept(control socket): %s\n", strerror(errno));
3793 return -1;
3794 }
3795
3796 return fd;
3797}
3798
3799/* redirect output to a service control socket */
3800bool redirect_to_socket(FILE* redirect, const char* service) {
3801 int fd = open_socket(service);
3802 if (fd == -1) {
3803 return false;
3804 }
3805 fflush(redirect);
3806 // TODO: handle dup2 failure
3807 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
3808 close(fd);
3809 return true;
3810}
3811
3812// TODO: should call is_valid_output_file and/or be merged into it.
3813void create_parent_dirs(const char *path) {
3814 char *chp = const_cast<char *> (path);
3815
3816 /* skip initial slash */
3817 if (chp[0] == '/')
3818 chp++;
3819
3820 /* create leading directories, if necessary */
3821 struct stat dir_stat;
3822 while (chp && chp[0]) {
3823 chp = strchr(chp, '/');
3824 if (chp) {
3825 *chp = 0;
3826 if (stat(path, &dir_stat) == -1 || !S_ISDIR(dir_stat.st_mode)) {
3827 MYLOGI("Creating directory %s\n", path);
3828 if (mkdir(path, 0770)) { /* drwxrwx--- */
3829 MYLOGE("Unable to create directory %s: %s\n", path, strerror(errno));
3830 } else if (chown(path, AID_SHELL, AID_SHELL)) {
3831 MYLOGE("Unable to change ownership of dir %s: %s\n", path, strerror(errno));
3832 }
3833 }
3834 *chp++ = '/';
3835 }
3836 }
3837}
3838
3839bool _redirect_to_file(FILE* redirect, char* path, int truncate_flag) {
3840 create_parent_dirs(path);
3841
3842 int fd = TEMP_FAILURE_RETRY(open(path,
3843 O_WRONLY | O_CREAT | truncate_flag | O_CLOEXEC | O_NOFOLLOW,
3844 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH));
3845 if (fd < 0) {
3846 MYLOGE("%s: %s\n", path, strerror(errno));
3847 return false;
3848 }
3849
3850 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
3851 close(fd);
3852 return true;
3853}
3854
3855bool redirect_to_file(FILE* redirect, char* path) {
3856 return _redirect_to_file(redirect, path, O_TRUNC);
3857}
3858
3859bool redirect_to_existing_file(FILE* redirect, char* path) {
3860 return _redirect_to_file(redirect, path, O_APPEND);
3861}
3862
3863void dump_route_tables() {
3864 DurationReporter duration_reporter("DUMP ROUTE TABLES");
3865 if (PropertiesHelper::IsDryRun()) return;
3866 const char* const RT_TABLES_PATH = "/data/misc/net/rt_tables";
3867 ds.DumpFile("RT_TABLES", RT_TABLES_PATH);
3868 FILE* fp = fopen(RT_TABLES_PATH, "re");
3869 if (!fp) {
3870 printf("*** %s: %s\n", RT_TABLES_PATH, strerror(errno));
3871 return;
3872 }
3873 char table[16];
3874 // Each line has an integer (the table number), a space, and a string (the table name). We only
3875 // need the table number. It's a 32-bit unsigned number, so max 10 chars. Skip the table name.
3876 // Add a fixed max limit so this doesn't go awry.
3877 for (int i = 0; i < 64 && fscanf(fp, " %10s %*s", table) == 1; ++i) {
3878 RunCommand("ROUTE TABLE IPv4", {"ip", "-4", "route", "show", "table", table});
3879 RunCommand("ROUTE TABLE IPv6", {"ip", "-6", "route", "show", "table", table});
3880 }
3881 fclose(fp);
3882}
3883
3884// TODO: make this function thread safe if sections are generated in parallel.
3885void Dumpstate::UpdateProgress(int32_t delta_sec) {
3886 if (progress_ == nullptr) {
3887 MYLOGE("UpdateProgress: progress_ not set\n");
3888 return;
3889 }
3890
3891 // Always update progess so stats can be tuned...
Nandana Duttf02cd782019-06-14 14:25:13 +01003892 progress_->Inc(delta_sec);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003893
3894 // ...but only notifiy listeners when necessary.
3895 if (!options_->do_progress_updates) return;
3896
3897 int progress = progress_->Get();
3898 int max = progress_->GetMax();
Nandana Duttf02cd782019-06-14 14:25:13 +01003899 int percent = 100 * progress / max;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003900
Nandana Duttf02cd782019-06-14 14:25:13 +01003901 if (last_reported_percent_progress_ > 0 && percent <= last_reported_percent_progress_) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003902 return;
3903 }
Nandana Duttf02cd782019-06-14 14:25:13 +01003904 last_reported_percent_progress_ = percent;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003905
3906 if (control_socket_fd_ >= 0) {
3907 dprintf(control_socket_fd_, "PROGRESS:%d/%d\n", progress, max);
3908 fsync(control_socket_fd_);
3909 }
3910
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003911 if (listener_ != nullptr) {
Nandana Dutt235c6672019-11-14 15:22:32 +00003912 if (percent % 10 == 0) {
3913 // We don't want to spam logcat, so only log multiples of 10.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01003914 MYLOGD("Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003915 } else {
3916 // stderr is ignored on normal invocations, but useful when calling
3917 // /system/bin/dumpstate directly for debuggging.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01003918 fprintf(stderr, "Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003919 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003920
3921 listener_->onProgress(percent);
3922 }
3923}
3924
3925void Dumpstate::TakeScreenshot(const std::string& path) {
3926 const std::string& real_path = path.empty() ? screenshot_path_ : path;
3927 int status =
3928 RunCommand("", {"/system/bin/screencap", "-p", real_path},
3929 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3930 if (status == 0) {
3931 MYLOGD("Screenshot saved on %s\n", real_path.c_str());
3932 } else {
3933 MYLOGE("Failed to take screenshot on %s\n", real_path.c_str());
3934 }
Paul Chang0d2aad72020-02-13 20:04:03 +08003935 if (listener_ != nullptr) {
3936 // Show a visual indication to indicate screenshot is taken via
3937 // IDumpstateListener.onScreenshotTaken()
3938 listener_->onScreenshotTaken(status == 0);
3939 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003940}
3941
3942bool is_dir(const char* pathname) {
3943 struct stat info;
3944 if (stat(pathname, &info) == -1) {
3945 return false;
3946 }
3947 return S_ISDIR(info.st_mode);
3948}
3949
3950time_t get_mtime(int fd, time_t default_mtime) {
3951 struct stat info;
3952 if (fstat(fd, &info) == -1) {
3953 return default_mtime;
3954 }
3955 return info.st_mtime;
3956}