blob: c8277feb5ba31e10617eacb7838eaf706db3e0fd [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 Jao5377d792020-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 Jao5377d792020-07-16 17:37:39 +0800117using android::os::dumpstate::DumpPool;
Vishnu Naire97d6122018-01-18 13:58:56 -0800118using android::os::dumpstate::PropertiesHelper;
Rhed Jao3c2fdbd2020-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 Jao3c2fdbd2020-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 Juravlef84d3692020-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 Jao5377d792020-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 Jao3c2fdbd2020-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 Jao5377d792020-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 Jao3c2fdbd2020-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 Jaoe017f982020-07-21 17:58:41 +0800229static const std::string DUMP_CHECKINS_TASK = "DUMP CHECKINS";
230static const std::string DUMP_APP_INFOS_TASK = "DUMP APP INFOS";
Rhed Jao5377d792020-07-16 17:37:39 +0800231
Nandana Dutt979388e2018-11-30 16:48:55 +0000232namespace android {
233namespace os {
234namespace {
235
236static int Open(std::string path, int flags, mode_t mode = 0) {
237 int fd = TEMP_FAILURE_RETRY(open(path.c_str(), flags, mode));
238 if (fd == -1) {
239 MYLOGE("open(%s, %s)\n", path.c_str(), strerror(errno));
240 }
241 return fd;
242}
243
mhasank2d75c442020-06-11 15:05:25 -0700244static int OpenForWrite(std::string path) {
245 return Open(path, O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
246 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH);
247}
Nandana Dutt979388e2018-11-30 16:48:55 +0000248
249static int OpenForRead(std::string path) {
250 return Open(path, O_RDONLY | O_CLOEXEC | O_NOFOLLOW);
251}
252
253bool CopyFile(int in_fd, int out_fd) {
254 char buf[4096];
255 ssize_t byte_count;
256 while ((byte_count = TEMP_FAILURE_RETRY(read(in_fd, buf, sizeof(buf)))) > 0) {
257 if (!android::base::WriteFully(out_fd, buf, byte_count)) {
258 return false;
259 }
260 }
261 return (byte_count != -1);
262}
263
264static bool CopyFileToFd(const std::string& input_file, int out_fd) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000265 MYLOGD("Going to copy file (%s) to %d\n", input_file.c_str(), out_fd);
Nandana Dutt979388e2018-11-30 16:48:55 +0000266
267 // Obtain a handle to the source file.
268 android::base::unique_fd in_fd(OpenForRead(input_file));
269 if (out_fd != -1 && in_fd.get() != -1) {
270 if (CopyFile(in_fd.get(), out_fd)) {
271 return true;
272 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000273 MYLOGE("Failed to copy file: %s\n", strerror(errno));
Nandana Dutt979388e2018-11-30 16:48:55 +0000274 }
275 return false;
276}
277
Nandana Duttd2f5f082019-01-18 17:13:52 +0000278static bool UnlinkAndLogOnError(const std::string& file) {
Nandana Dutt8ae16e62020-03-27 10:20:22 +0000279 if (file.empty()) {
280 return false;
281 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000282 if (unlink(file.c_str())) {
283 MYLOGE("Failed to unlink file (%s): %s\n", file.c_str(), strerror(errno));
Nandana Duttd2f5f082019-01-18 17:13:52 +0000284 return false;
285 }
286 return true;
287}
Nandana Dutt979388e2018-11-30 16:48:55 +0000288
Nikita Ioffea325a572019-05-16 19:49:47 +0100289int64_t GetModuleMetadataVersion() {
290 auto binder = defaultServiceManager()->getService(android::String16("package_native"));
291 if (binder == nullptr) {
292 MYLOGE("Failed to retrieve package_native service");
293 return 0L;
294 }
295 auto package_service = android::interface_cast<content::pm::IPackageManagerNative>(binder);
296 std::string package_name;
297 auto status = package_service->getModuleMetadataPackageName(&package_name);
298 if (!status.isOk()) {
299 MYLOGE("Failed to retrieve module metadata package name: %s", status.toString8().c_str());
300 return 0L;
301 }
Nandana Duttdb379fa2019-10-09 16:54:41 +0100302 MYLOGD("Module metadata package name: %s\n", package_name.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100303 int64_t version_code;
304 status = package_service->getVersionCodeForPackage(android::String16(package_name.c_str()),
305 &version_code);
306 if (!status.isOk()) {
307 MYLOGE("Failed to retrieve module metadata version: %s", status.toString8().c_str());
308 return 0L;
309 }
310 return version_code;
311}
312
mhasank2d75c442020-06-11 15:05:25 -0700313static bool PathExists(const std::string& path) {
314 struct stat sb;
315 return stat(path.c_str(), &sb) == 0;
316}
317
318static bool CopyFileToFile(const std::string& input_file, const std::string& output_file) {
319 if (input_file == output_file) {
320 MYLOGD("Skipping copying bugreport file since the destination is the same (%s)\n",
321 output_file.c_str());
322 return false;
323 }
324 else if (PathExists(output_file)) {
325 MYLOGD("Cannot overwrite an existing file (%s)\n", output_file.c_str());
326 return false;
327 }
328
329 MYLOGD("Going to copy bugreport file (%s) to %s\n", input_file.c_str(), output_file.c_str());
330 android::base::unique_fd out_fd(OpenForWrite(output_file));
331 return CopyFileToFd(input_file, out_fd.get());
332}
333
Nandana Dutt979388e2018-11-30 16:48:55 +0000334} // namespace
335} // namespace os
336} // namespace android
337
Felipe Leme678727a2016-09-21 17:22:11 -0700338static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
Felipe Lemebda15a02016-11-16 17:48:25 -0800339 const CommandOptions& options = Dumpstate::DEFAULT_DUMPSYS,
Rhed Jaoe017f982020-07-21 17:58:41 +0800340 long dumpsysTimeoutMs = 0, int out_fd = STDOUT_FILENO) {
341 return ds.RunDumpsys(title, dumpsysArgs, options, dumpsysTimeoutMs, out_fd);
342}
343static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
344 int out_fd) {
345 return ds.RunDumpsys(title, dumpsysArgs, Dumpstate::DEFAULT_DUMPSYS, 0, out_fd);
Felipe Leme678727a2016-09-21 17:22:11 -0700346}
347static int DumpFile(const std::string& title, const std::string& path) {
348 return ds.DumpFile(title, path);
349}
Felipe Lemee82a27d2016-01-05 13:35:44 -0800350
Felipe Lemee844a9d2016-09-21 15:01:39 -0700351// Relative directory (inside the zip) for all files copied as-is into the bugreport.
352static const std::string ZIP_ROOT_DIR = "FS";
353
Vishnu Naire97d6122018-01-18 13:58:56 -0800354static const std::string kProtoPath = "proto/";
355static const std::string kProtoExt = ".proto";
Jie Song9fbfad02017-06-20 16:29:42 -0700356static const std::string kDumpstateBoardFiles[] = {
357 "dumpstate_board.txt",
Felipe Leme95d6ca52017-08-01 16:35:56 -0700358 "dumpstate_board.bin"
Jie Song9fbfad02017-06-20 16:29:42 -0700359};
360static const int NUM_OF_DUMPS = arraysize(kDumpstateBoardFiles);
361
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700362static constexpr char PROPERTY_LAST_ID[] = "dumpstate.last_id";
Felipe Lemed071c682016-10-20 16:48:00 -0700363static constexpr char PROPERTY_VERSION[] = "dumpstate.version";
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700364
Felipe Lemef0292972016-11-22 13:57:05 -0800365static const CommandOptions AS_ROOT_20 = CommandOptions::WithTimeout(20).AsRoot().Build();
366
Narayan Kamath8f788292017-05-25 13:20:39 +0100367/*
Narayan Kamathbd863722017-06-01 18:50:12 +0100368 * Returns a vector of dump fds under |dir_path| with a given |file_prefix|.
Rhed Jao01dc0c62020-06-03 17:13:30 +0800369 * The returned vector is sorted by the mtimes of the dumps with descending
370 * order. If |limit_by_mtime| is set, the vector only contains files that
371 * were written in the last 30 minutes.
Narayan Kamath8f788292017-05-25 13:20:39 +0100372 */
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700373static std::vector<DumpData> GetDumpFds(const std::string& dir_path,
374 const std::string& file_prefix,
Elliott Hughesdb6d2112019-09-26 15:24:51 -0700375 bool limit_by_mtime) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100376 const time_t thirty_minutes_ago = ds.now_ - 60 * 30;
377
Narayan Kamathbd863722017-06-01 18:50:12 +0100378 std::unique_ptr<DIR, decltype(&closedir)> dump_dir(opendir(dir_path.c_str()), closedir);
Narayan Kamath8f788292017-05-25 13:20:39 +0100379
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700380 if (dump_dir == nullptr) {
381 MYLOGW("Unable to open directory %s: %s\n", dir_path.c_str(), strerror(errno));
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700382 return std::vector<DumpData>();
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700383 }
384
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700385 std::vector<DumpData> dump_data;
Narayan Kamathbd863722017-06-01 18:50:12 +0100386 struct dirent* entry = nullptr;
387 while ((entry = readdir(dump_dir.get()))) {
388 if (entry->d_type != DT_REG) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100389 continue;
390 }
391
Narayan Kamathbd863722017-06-01 18:50:12 +0100392 const std::string base_name(entry->d_name);
393 if (base_name.find(file_prefix) != 0) {
394 continue;
395 }
396
397 const std::string abs_path = dir_path + base_name;
398 android::base::unique_fd fd(
399 TEMP_FAILURE_RETRY(open(abs_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW | O_NONBLOCK)));
400 if (fd == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700401 MYLOGW("Unable to open dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamathbd863722017-06-01 18:50:12 +0100402 break;
403 }
404
405 struct stat st = {};
406 if (fstat(fd, &st) == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700407 MYLOGW("Unable to stat dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamath8f788292017-05-25 13:20:39 +0100408 continue;
409 }
410
Narayan Kamath3f31b632018-02-22 19:42:36 +0000411 if (limit_by_mtime && st.st_mtime < thirty_minutes_ago) {
Narayan Kamathbd863722017-06-01 18:50:12 +0100412 MYLOGI("Excluding stale dump file: %s\n", abs_path.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100413 continue;
414 }
415
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700416 dump_data.emplace_back(DumpData{abs_path, std::move(fd), st.st_mtime});
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700417 }
Rhed Jao01dc0c62020-06-03 17:13:30 +0800418 if (!dump_data.empty()) {
419 std::sort(dump_data.begin(), dump_data.end(),
420 [](const auto& a, const auto& b) { return a.mtime > b.mtime; });
421 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100422
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700423 return dump_data;
Narayan Kamath8f788292017-05-25 13:20:39 +0100424}
425
Narayan Kamathbd863722017-06-01 18:50:12 +0100426static bool AddDumps(const std::vector<DumpData>::const_iterator start,
427 const std::vector<DumpData>::const_iterator end,
428 const char* type_name, const bool add_to_zip) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100429 bool dumped = false;
Narayan Kamathbd863722017-06-01 18:50:12 +0100430 for (auto it = start; it != end; ++it) {
431 const std::string& name = it->name;
432 const int fd = it->fd;
Narayan Kamath8f788292017-05-25 13:20:39 +0100433 dumped = true;
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100434
435 // Seek to the beginning of the file before dumping any data. A given
436 // DumpData entry might be dumped multiple times in the report.
437 //
438 // For example, the most recent ANR entry is dumped to the body of the
439 // main entry and it also shows up as a separate entry in the bugreport
440 // ZIP file.
441 if (lseek(fd, 0, SEEK_SET) != static_cast<off_t>(0)) {
442 MYLOGE("Unable to add %s to zip file, lseek failed: %s\n", name.c_str(),
443 strerror(errno));
444 }
445
Narayan Kamath8f788292017-05-25 13:20:39 +0100446 if (ds.IsZipping() && add_to_zip) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800447 if (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + name, fd, /* timeout = */ 0ms) != OK) {
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100448 MYLOGE("Unable to add %s to zip file, addZipEntryFromFd failed\n", name.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100449 }
450 } else {
451 dump_file_from_fd(type_name, name.c_str(), fd);
452 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100453 }
454
455 return dumped;
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700456}
457
Felipe Leme635ca312016-01-05 14:23:02 -0800458// for_each_pid() callback to get mount info about a process.
Felipe Leme4c2d6632016-09-28 14:32:00 -0700459void do_mountinfo(int pid, const char* name __attribute__((unused))) {
Felipe Leme635ca312016-01-05 14:23:02 -0800460 char path[PATH_MAX];
461
462 // Gets the the content of the /proc/PID/ns/mnt link, so only unique mount points
463 // are added.
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700464 snprintf(path, sizeof(path), "/proc/%d/ns/mnt", pid);
Felipe Leme635ca312016-01-05 14:23:02 -0800465 char linkname[PATH_MAX];
466 ssize_t r = readlink(path, linkname, PATH_MAX);
467 if (r == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800468 MYLOGE("Unable to read link for %s: %s\n", path, strerror(errno));
Felipe Leme635ca312016-01-05 14:23:02 -0800469 return;
470 }
471 linkname[r] = '\0';
472
473 if (mount_points.find(linkname) == mount_points.end()) {
474 // First time this mount point was found: add it
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700475 snprintf(path, sizeof(path), "/proc/%d/mountinfo", pid);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700476 if (ds.AddZipEntry(ZIP_ROOT_DIR + path, path)) {
Felipe Leme635ca312016-01-05 14:23:02 -0800477 mount_points.insert(linkname);
478 } else {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800479 MYLOGE("Unable to add mountinfo %s to zip file\n", path);
Felipe Leme635ca312016-01-05 14:23:02 -0800480 }
481 }
482}
483
484void add_mountinfo() {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700485 if (!ds.IsZipping()) return;
Felipe Leme678727a2016-09-21 17:22:11 -0700486 std::string title = "MOUNT INFO";
Felipe Leme635ca312016-01-05 14:23:02 -0800487 mount_points.clear();
Felipe Leme46b85da2016-11-21 17:40:45 -0800488 DurationReporter duration_reporter(title, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700489 for_each_pid(do_mountinfo, nullptr);
490 MYLOGD("%s: %d entries added to zip file\n", title.c_str(), (int)mount_points.size());
Felipe Leme635ca312016-01-05 14:23:02 -0800491}
492
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700493static void dump_dev_files(const char *title, const char *driverpath, const char *filename)
494{
495 DIR *d;
496 struct dirent *de;
497 char path[PATH_MAX];
498
499 d = opendir(driverpath);
Yi Kong19d5c002018-07-20 13:39:55 -0700500 if (d == nullptr) {
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700501 return;
502 }
503
504 while ((de = readdir(d))) {
505 if (de->d_type != DT_LNK) {
506 continue;
507 }
508 snprintf(path, sizeof(path), "%s/%s/%s", driverpath, de->d_name, filename);
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700509 DumpFile(title, path);
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700510 }
511
512 closedir(d);
513}
514
Mark Salyzyn326842f2015-04-30 09:49:41 -0700515static bool skip_not_stat(const char *path) {
516 static const char stat[] = "/stat";
517 size_t len = strlen(path);
518 if (path[len - 1] == '/') { /* Directory? */
519 return false;
520 }
521 return strcmp(path + len - sizeof(stat) + 1, stat); /* .../stat? */
522}
523
Felipe Leme4c2d6632016-09-28 14:32:00 -0700524static bool skip_none(const char* path __attribute__((unused))) {
Felipe Lemee82a27d2016-01-05 13:35:44 -0800525 return false;
526}
527
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700528unsigned long worst_write_perf = 20000; /* in KB/s */
Mark Salyzyn326842f2015-04-30 09:49:41 -0700529
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800530//
531// stat offsets
532// Name units description
533// ---- ----- -----------
534// read I/Os requests number of read I/Os processed
535#define __STAT_READ_IOS 0
536// read merges requests number of read I/Os merged with in-queue I/O
537#define __STAT_READ_MERGES 1
538// read sectors sectors number of sectors read
539#define __STAT_READ_SECTORS 2
540// read ticks milliseconds total wait time for read requests
541#define __STAT_READ_TICKS 3
542// write I/Os requests number of write I/Os processed
543#define __STAT_WRITE_IOS 4
544// write merges requests number of write I/Os merged with in-queue I/O
545#define __STAT_WRITE_MERGES 5
546// write sectors sectors number of sectors written
547#define __STAT_WRITE_SECTORS 6
548// write ticks milliseconds total wait time for write requests
549#define __STAT_WRITE_TICKS 7
550// in_flight requests number of I/Os currently in flight
551#define __STAT_IN_FLIGHT 8
552// io_ticks milliseconds total time this block device has been active
553#define __STAT_IO_TICKS 9
554// time_in_queue milliseconds total wait time for all requests
555#define __STAT_IN_QUEUE 10
556#define __STAT_NUMBER_FIELD 11
557//
558// read I/Os, write I/Os
559// =====================
560//
561// These values increment when an I/O request completes.
562//
563// read merges, write merges
564// =========================
565//
566// These values increment when an I/O request is merged with an
567// already-queued I/O request.
568//
569// read sectors, write sectors
570// ===========================
571//
572// These values count the number of sectors read from or written to this
573// block device. The "sectors" in question are the standard UNIX 512-byte
574// sectors, not any device- or filesystem-specific block size. The
575// counters are incremented when the I/O completes.
576#define SECTOR_SIZE 512
577//
578// read ticks, write ticks
579// =======================
580//
581// These values count the number of milliseconds that I/O requests have
582// waited on this block device. If there are multiple I/O requests waiting,
583// these values will increase at a rate greater than 1000/second; for
584// example, if 60 read requests wait for an average of 30 ms, the read_ticks
585// field will increase by 60*30 = 1800.
586//
587// in_flight
588// =========
589//
590// This value counts the number of I/O requests that have been issued to
591// the device driver but have not yet completed. It does not include I/O
592// requests that are in the queue but not yet issued to the device driver.
593//
594// io_ticks
595// ========
596//
597// This value counts the number of milliseconds during which the device has
598// had I/O requests queued.
599//
600// time_in_queue
601// =============
602//
603// This value counts the number of milliseconds that I/O requests have waited
604// on this block device. If there are multiple I/O requests waiting, this
605// value will increase as the product of the number of milliseconds times the
606// number of requests waiting (see "read ticks" above for an example).
607#define S_TO_MS 1000
608//
609
Mark Salyzyn326842f2015-04-30 09:49:41 -0700610static int dump_stat_from_fd(const char *title __unused, const char *path, int fd) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800611 unsigned long long fields[__STAT_NUMBER_FIELD];
Mark Salyzyn326842f2015-04-30 09:49:41 -0700612 bool z;
Yi Kong19d5c002018-07-20 13:39:55 -0700613 char *cp, *buffer = nullptr;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700614 size_t i = 0;
Josh Gao7c4258c2018-06-25 13:40:08 -0700615 FILE *fp = fdopen(dup(fd), "rb");
Mark Salyzyn326842f2015-04-30 09:49:41 -0700616 getline(&buffer, &i, fp);
617 fclose(fp);
618 if (!buffer) {
619 return -errno;
620 }
621 i = strlen(buffer);
622 while ((i > 0) && (buffer[i - 1] == '\n')) {
623 buffer[--i] = '\0';
624 }
625 if (!*buffer) {
626 free(buffer);
627 return 0;
628 }
629 z = true;
630 for (cp = buffer, i = 0; i < (sizeof(fields) / sizeof(fields[0])); ++i) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800631 fields[i] = strtoull(cp, &cp, 10);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700632 if (fields[i] != 0) {
633 z = false;
634 }
635 }
636 if (z) { /* never accessed */
637 free(buffer);
638 return 0;
639 }
640
Wei Wang509bb5d2017-06-09 14:42:12 -0700641 if (!strncmp(path, BLK_DEV_SYS_DIR, sizeof(BLK_DEV_SYS_DIR) - 1)) {
642 path += sizeof(BLK_DEV_SYS_DIR) - 1;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700643 }
Wei Wang1dc1ef52017-06-12 11:28:37 -0700644
645 printf("%-30s:%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s\n%-30s:\t%s\n", "Block-Dev",
646 "R-IOs", "R-merg", "R-sect", "R-wait", "W-IOs", "W-merg", "W-sect",
647 "W-wait", "in-fli", "activ", "T-wait", path, buffer);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700648 free(buffer);
649
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800650 if (fields[__STAT_IO_TICKS]) {
651 unsigned long read_perf = 0;
652 unsigned long read_ios = 0;
653 if (fields[__STAT_READ_TICKS]) {
654 unsigned long long divisor = fields[__STAT_READ_TICKS]
655 * fields[__STAT_IO_TICKS];
656 read_perf = ((unsigned long long)SECTOR_SIZE
657 * fields[__STAT_READ_SECTORS]
658 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
659 / divisor;
660 read_ios = ((unsigned long long)S_TO_MS * fields[__STAT_READ_IOS]
661 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
662 / divisor;
663 }
664
665 unsigned long write_perf = 0;
666 unsigned long write_ios = 0;
667 if (fields[__STAT_WRITE_TICKS]) {
668 unsigned long long divisor = fields[__STAT_WRITE_TICKS]
669 * fields[__STAT_IO_TICKS];
670 write_perf = ((unsigned long long)SECTOR_SIZE
671 * fields[__STAT_WRITE_SECTORS]
672 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
673 / divisor;
674 write_ios = ((unsigned long long)S_TO_MS * fields[__STAT_WRITE_IOS]
675 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
676 / divisor;
677 }
678
679 unsigned queue = (fields[__STAT_IN_QUEUE]
680 + (fields[__STAT_IO_TICKS] >> 1))
681 / fields[__STAT_IO_TICKS];
682
683 if (!write_perf && !write_ios) {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700684 printf("%-30s: perf(ios) rd: %luKB/s(%lu/s) q: %u\n", path, read_perf, read_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800685 } else {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700686 printf("%-30s: perf(ios) rd: %luKB/s(%lu/s) wr: %luKB/s(%lu/s) q: %u\n", path, read_perf,
Felipe Lemed8b94e52016-12-08 10:21:44 -0800687 read_ios, write_perf, write_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800688 }
689
690 /* bugreport timeout factor adjustment */
691 if ((write_perf > 1) && (write_perf < worst_write_perf)) {
692 worst_write_perf = write_perf;
693 }
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700694 }
Mark Salyzyn326842f2015-04-30 09:49:41 -0700695 return 0;
696}
697
Yao Chenbe3bbc12018-01-17 16:31:10 -0800698static const long MINIMUM_LOGCAT_TIMEOUT_MS = 50000;
699
Tom Cherryf4472f32020-08-05 09:31:17 -0700700// Returns the actual readable size of the given buffer or -1 on error.
701static long logcat_buffer_readable_size(const std::string& buffer) {
702 std::unique_ptr<logger_list, decltype(&android_logger_list_free)> logger_list{
703 android_logger_list_alloc(0, 0, 0), &android_logger_list_free};
704 auto logger = android_logger_open(logger_list.get(), android_name_to_log_id(buffer.c_str()));
705
706 return android_logger_get_log_readable_size(logger);
707}
708
709// Returns timeout in ms to read a list of buffers.
Yao Chenbe3bbc12018-01-17 16:31:10 -0800710static unsigned long logcat_timeout(const std::vector<std::string>& buffers) {
711 unsigned long timeout_ms = 0;
712 for (const auto& buffer : buffers) {
Tom Cherryf4472f32020-08-05 09:31:17 -0700713 long readable_size = logcat_buffer_readable_size(buffer);
714 if (readable_size > 0) {
715 // Engineering margin is ten-fold our guess.
716 timeout_ms += 10 * (readable_size + worst_write_perf) / worst_write_perf;
717 }
Yao Chenbe3bbc12018-01-17 16:31:10 -0800718 }
719 return timeout_ms > MINIMUM_LOGCAT_TIMEOUT_MS ? timeout_ms : MINIMUM_LOGCAT_TIMEOUT_MS;
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700720}
721
Nandana Duttd2f5f082019-01-18 17:13:52 +0000722Dumpstate::ConsentCallback::ConsentCallback() : result_(UNAVAILABLE), start_time_(Nanotime()) {
723}
724
725android::binder::Status Dumpstate::ConsentCallback::onReportApproved() {
726 std::lock_guard<std::mutex> lock(lock_);
727 result_ = APPROVED;
728 MYLOGD("User approved consent to share bugreport\n");
Paul Chang0d2aad72020-02-13 20:04:03 +0800729
730 // Maybe copy screenshot so calling app can display the screenshot to the user as soon as
731 // consent is granted.
732 if (ds.options_->is_screenshot_copied) {
733 return android::binder::Status::ok();
734 }
735
736 if (!ds.options_->do_screenshot || ds.options_->screenshot_fd.get() == -1 ||
737 !ds.do_early_screenshot_) {
738 return android::binder::Status::ok();
739 }
740
741 bool copy_succeeded = android::os::CopyFileToFd(ds.screenshot_path_,
742 ds.options_->screenshot_fd.get());
743 ds.options_->is_screenshot_copied = copy_succeeded;
744 if (copy_succeeded) {
745 android::os::UnlinkAndLogOnError(ds.screenshot_path_);
746 }
Nandana Duttd2f5f082019-01-18 17:13:52 +0000747 return android::binder::Status::ok();
748}
749
750android::binder::Status Dumpstate::ConsentCallback::onReportDenied() {
751 std::lock_guard<std::mutex> lock(lock_);
752 result_ = DENIED;
753 MYLOGW("User denied consent to share bugreport\n");
754 return android::binder::Status::ok();
755}
756
757UserConsentResult Dumpstate::ConsentCallback::getResult() {
758 std::lock_guard<std::mutex> lock(lock_);
759 return result_;
760}
761
762uint64_t Dumpstate::ConsentCallback::getElapsedTimeMs() const {
Hunter Knepshieldf0a39052020-01-03 14:53:04 -0800763 return (Nanotime() - start_time_) / NANOS_PER_MILLI;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000764}
765
Felipe Leme2b9b06c2016-10-14 09:13:06 -0700766void Dumpstate::PrintHeader() const {
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700767 std::string build, fingerprint, radio, bootloader, network;
768 char date[80];
Colin Crossf45fa6b2012-03-26 12:38:26 -0700769
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700770 build = android::base::GetProperty("ro.build.display.id", "(unknown)");
771 fingerprint = android::base::GetProperty("ro.build.fingerprint", "(unknown)");
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700772 radio = android::base::GetProperty("gsm.version.baseband", "(unknown)");
773 bootloader = android::base::GetProperty("ro.bootloader", "(unknown)");
774 network = android::base::GetProperty("gsm.operator.alpha", "(unknown)");
Felipe Lemebbaf3c12016-10-11 14:32:25 -0700775 strftime(date, sizeof(date), "%Y-%m-%d %H:%M:%S", localtime(&now_));
Colin Crossf45fa6b2012-03-26 12:38:26 -0700776
Felipe Lemed8b94e52016-12-08 10:21:44 -0800777 printf("========================================================\n");
778 printf("== dumpstate: %s\n", date);
779 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -0700780
Felipe Lemed8b94e52016-12-08 10:21:44 -0800781 printf("\n");
782 printf("Build: %s\n", build.c_str());
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700783 // NOTE: fingerprint entry format is important for other tools.
Felipe Lemed8b94e52016-12-08 10:21:44 -0800784 printf("Build fingerprint: '%s'\n", fingerprint.c_str());
785 printf("Bootloader: %s\n", bootloader.c_str());
786 printf("Radio: %s\n", radio.c_str());
787 printf("Network: %s\n", network.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100788 int64_t module_metadata_version = android::os::GetModuleMetadataVersion();
789 if (module_metadata_version != 0) {
790 printf("Module Metadata version: %" PRId64 "\n", module_metadata_version);
791 }
Colin Crossf45fa6b2012-03-26 12:38:26 -0700792
Felipe Lemed8b94e52016-12-08 10:21:44 -0800793 printf("Kernel: ");
Felipe Lemef0292972016-11-22 13:57:05 -0800794 DumpFileToFd(STDOUT_FILENO, "", "/proc/version");
Felipe Lemed8b94e52016-12-08 10:21:44 -0800795 printf("Command line: %s\n", strtok(cmdline_buf, "\n"));
Felipe Leme7709f8a2017-12-05 09:30:09 -0800796 printf("Uptime: ");
797 RunCommandToFd(STDOUT_FILENO, "", {"uptime", "-p"},
798 CommandOptions::WithTimeout(1).Always().Build());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800799 printf("Bugreport format version: %s\n", version_.c_str());
Rhed Jao5377d792020-07-16 17:37:39 +0800800 printf("Dumpstate info: id=%d pid=%d dry_run=%d parallel_run=%d args=%s bugreport_mode=%s\n",
801 id_, pid_, PropertiesHelper::IsDryRun(), PropertiesHelper::IsParallelRun(),
802 options_->args.c_str(), options_->bugreport_mode.c_str());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800803 printf("\n");
Felipe Leme78f2c862015-12-21 09:55:22 -0800804}
805
Felipe Leme24b66ee2016-06-16 10:55:26 -0700806// List of file extensions that can cause a zip file attachment to be rejected by some email
807// service providers.
808static const std::set<std::string> PROBLEMATIC_FILE_EXTENSIONS = {
809 ".ade", ".adp", ".bat", ".chm", ".cmd", ".com", ".cpl", ".exe", ".hta", ".ins", ".isp",
810 ".jar", ".jse", ".lib", ".lnk", ".mde", ".msc", ".msp", ".mst", ".pif", ".scr", ".sct",
811 ".shb", ".sys", ".vb", ".vbe", ".vbs", ".vxd", ".wsc", ".wsf", ".wsh"
812};
813
Vishnu Naire97d6122018-01-18 13:58:56 -0800814status_t Dumpstate::AddZipEntryFromFd(const std::string& entry_name, int fd,
815 std::chrono::milliseconds timeout = 0ms) {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700816 if (!IsZipping()) {
817 MYLOGD("Not adding zip entry %s from fd because it's not a zipped bugreport\n",
818 entry_name.c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -0800819 return INVALID_OPERATION;
Felipe Leme111b9d02016-02-03 09:28:24 -0800820 }
Felipe Leme24b66ee2016-06-16 10:55:26 -0700821 std::string valid_name = entry_name;
822
823 // Rename extension if necessary.
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -0700824 size_t idx = entry_name.rfind('.');
Felipe Leme24b66ee2016-06-16 10:55:26 -0700825 if (idx != std::string::npos) {
826 std::string extension = entry_name.substr(idx);
827 std::transform(extension.begin(), extension.end(), extension.begin(), ::tolower);
828 if (PROBLEMATIC_FILE_EXTENSIONS.count(extension) != 0) {
829 valid_name = entry_name + ".renamed";
830 MYLOGI("Renaming entry %s to %s\n", entry_name.c_str(), valid_name.c_str());
831 }
832 }
833
Felipe Leme6fe9db62016-02-12 09:04:16 -0800834 // Logging statement below is useful to time how long each entry takes, but it's too verbose.
835 // MYLOGD("Adding zip entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700836 int32_t err = zip_writer_->StartEntryWithTime(valid_name.c_str(), ZipWriter::kCompress,
837 get_mtime(fd, ds.now_));
Felipe Leme1d486fe2016-10-14 18:06:47 -0700838 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700839 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", valid_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700840 ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800841 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800842 }
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000843 bool finished_entry = false;
844 auto finish_entry = [this, &finished_entry] {
845 if (!finished_entry) {
846 // This should only be called when we're going to return an earlier error,
847 // which would've been logged. This may imply the file is already corrupt
848 // and any further logging from FinishEntry is more likely to mislead than
849 // not.
850 this->zip_writer_->FinishEntry();
851 }
852 };
853 auto scope_guard = android::base::make_scope_guard(finish_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -0800854 auto start = std::chrono::steady_clock::now();
855 auto end = start + timeout;
856 struct pollfd pfd = {fd, POLLIN};
Felipe Lemee82a27d2016-01-05 13:35:44 -0800857
Felipe Leme770410d2016-01-26 17:07:14 -0800858 std::vector<uint8_t> buffer(65536);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800859 while (1) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800860 if (timeout.count() > 0) {
861 // lambda to recalculate the timeout.
862 auto time_left_ms = [end]() {
863 auto now = std::chrono::steady_clock::now();
864 auto diff = std::chrono::duration_cast<std::chrono::milliseconds>(end - now);
865 return std::max(diff.count(), 0LL);
866 };
867
868 int rc = TEMP_FAILURE_RETRY(poll(&pfd, 1, time_left_ms()));
869 if (rc < 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000870 MYLOGE("Error in poll while adding from fd to zip entry %s:%s\n",
871 entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800872 return -errno;
873 } else if (rc == 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000874 MYLOGE("Timed out adding from fd to zip entry %s:%s Timeout:%lldms\n",
Vishnu Naire97d6122018-01-18 13:58:56 -0800875 entry_name.c_str(), strerror(errno), timeout.count());
876 return TIMED_OUT;
877 }
878 }
879
Zach Riggle22200402016-08-18 01:01:24 -0400880 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800881 if (bytes_read == 0) {
882 break;
883 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800884 MYLOGE("read(%s): %s\n", entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800885 return -errno;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800886 }
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700887 err = zip_writer_->WriteBytes(buffer.data(), bytes_read);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800888 if (err) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700889 MYLOGE("zip_writer_->WriteBytes(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800890 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800891 }
892 }
893
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700894 err = zip_writer_->FinishEntry();
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000895 finished_entry = true;
Felipe Leme1d486fe2016-10-14 18:06:47 -0700896 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700897 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800898 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800899 }
900
Vishnu Naire97d6122018-01-18 13:58:56 -0800901 return OK;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800902}
903
Felipe Leme1d486fe2016-10-14 18:06:47 -0700904bool Dumpstate::AddZipEntry(const std::string& entry_name, const std::string& entry_path) {
905 android::base::unique_fd fd(
906 TEMP_FAILURE_RETRY(open(entry_path.c_str(), O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
Andreas Gampeaff68432016-07-18 18:01:27 -0700907 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800908 MYLOGE("open(%s): %s\n", entry_path.c_str(), strerror(errno));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800909 return false;
910 }
911
Vishnu Naire97d6122018-01-18 13:58:56 -0800912 return (AddZipEntryFromFd(entry_name, fd.get()) == OK);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800913}
914
915/* adds a file to the existing zipped bugreport */
Felipe Leme4c2d6632016-09-28 14:32:00 -0700916static int _add_file_from_fd(const char* title __attribute__((unused)), const char* path, int fd) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800917 return (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + path, fd) == OK) ? 0 : 1;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800918}
919
Felipe Leme1d486fe2016-10-14 18:06:47 -0700920void Dumpstate::AddDir(const std::string& dir, bool recursive) {
921 if (!IsZipping()) {
922 MYLOGD("Not adding dir %s because it's not a zipped bugreport\n", dir.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800923 return;
924 }
Felipe Leme678727a2016-09-21 17:22:11 -0700925 MYLOGD("Adding dir %s (recursive: %d)\n", dir.c_str(), recursive);
Felipe Leme46b85da2016-11-21 17:40:45 -0800926 DurationReporter duration_reporter(dir, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700927 dump_files("", dir.c_str(), recursive ? skip_none : is_dir, _add_file_from_fd);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800928}
929
Felipe Leme1d486fe2016-10-14 18:06:47 -0700930bool Dumpstate::AddTextZipEntry(const std::string& entry_name, const std::string& content) {
931 if (!IsZipping()) {
932 MYLOGD("Not adding text zip entry %s because it's not a zipped bugreport\n",
933 entry_name.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800934 return false;
935 }
Felipe Lemecbce55d2016-02-08 09:53:18 -0800936 MYLOGD("Adding zip text entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700937 int32_t err = zip_writer_->StartEntryWithTime(entry_name.c_str(), ZipWriter::kCompress, ds.now_);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700938 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700939 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700940 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800941 return false;
942 }
943
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700944 err = zip_writer_->WriteBytes(content.c_str(), content.length());
Felipe Leme1d486fe2016-10-14 18:06:47 -0700945 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700946 MYLOGE("zip_writer_->WriteBytes(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700947 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800948 return false;
949 }
950
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700951 err = zip_writer_->FinishEntry();
Felipe Leme1d486fe2016-10-14 18:06:47 -0700952 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700953 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800954 return false;
955 }
956
957 return true;
958}
959
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800960static void DoKmsg() {
961 struct stat st;
962 if (!stat(PSTORE_LAST_KMSG, &st)) {
963 /* Also TODO: Make console-ramoops CAP_SYSLOG protected. */
964 DumpFile("LAST KMSG", PSTORE_LAST_KMSG);
965 } else if (!stat(ALT_PSTORE_LAST_KMSG, &st)) {
966 DumpFile("LAST KMSG", ALT_PSTORE_LAST_KMSG);
967 } else {
968 /* TODO: Make last_kmsg CAP_SYSLOG protected. b/5555691 */
969 DumpFile("LAST KMSG", "/proc/last_kmsg");
970 }
971}
972
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800973static void DoKernelLogcat() {
Yao Chenbe3bbc12018-01-17 16:31:10 -0800974 unsigned long timeout_ms = logcat_timeout({"kernel"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800975 RunCommand(
976 "KERNEL LOG",
977 {"logcat", "-b", "kernel", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
978 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
979}
980
Nandana Duttdb379fa2019-10-09 16:54:41 +0100981static void DoSystemLogcat(time_t since) {
982 char since_str[80];
983 strftime(since_str, sizeof(since_str), "%Y-%m-%d %H:%M:%S.000", localtime(&since));
984
985 unsigned long timeout_ms = logcat_timeout({"main", "system", "crash"});
986 RunCommand("SYSTEM LOG",
987 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v", "-T",
988 since_str},
989 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
990}
991
Hunter Knepshield820f9bc2020-02-05 20:10:53 -0800992static void DoRadioLogcat() {
993 unsigned long timeout_ms = logcat_timeout({"radio"});
994 RunCommand(
995 "RADIO LOG",
996 {"logcat", "-b", "radio", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
997 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
998}
999
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001000static void DoLogcat() {
Vishnu Nair6921f802017-11-22 09:17:23 -08001001 unsigned long timeout_ms;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001002 // DumpFile("EVENT LOG TAGS", "/etc/event-log-tags");
1003 // calculate timeout
Yao Chenbe3bbc12018-01-17 16:31:10 -08001004 timeout_ms = logcat_timeout({"main", "system", "crash"});
Tony Makae737652017-03-30 17:47:09 +01001005 RunCommand("SYSTEM LOG",
Vishnu Nair6921f802017-11-22 09:17:23 -08001006 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1007 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -08001008 timeout_ms = logcat_timeout({"events"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001009 RunCommand(
1010 "EVENT LOG",
1011 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001012 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Yao Chenbe3bbc12018-01-17 16:31:10 -08001013 timeout_ms = logcat_timeout({"stats"});
1014 RunCommand(
1015 "STATS LOG",
1016 {"logcat", "-b", "stats", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001017 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001018 DoRadioLogcat();
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001019
1020 RunCommand("LOG STATISTICS", {"logcat", "-b", "all", "-S"});
1021
1022 /* kernels must set CONFIG_PSTORE_PMSG, slice up pstore with device tree */
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001023 RunCommand("LAST LOGCAT", {"logcat", "-L", "-b", "all", "-v", "threadtime", "-v", "printable",
1024 "-v", "uid", "-d", "*:v"});
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001025}
1026
Mike Ma5c267872019-08-21 11:31:34 -07001027static void DumpIncidentReport() {
1028 if (!ds.IsZipping()) {
1029 MYLOGD("Not dumping incident report because it's not a zipped bugreport\n");
1030 return;
1031 }
Mike Ma5c267872019-08-21 11:31:34 -07001032 const std::string path = ds.bugreport_internal_dir_ + "/tmp_incident_report";
1033 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1034 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1035 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1036 if (fd < 0) {
1037 MYLOGE("Could not open %s to dump incident report.\n", path.c_str());
1038 return;
1039 }
1040 RunCommandToFd(fd, "", {"incident", "-u"}, CommandOptions::WithTimeout(120).Build());
1041 bool empty = 0 == lseek(fd, 0, SEEK_END);
1042 if (!empty) {
1043 // Use a different name from "incident.proto"
1044 // /proto/incident.proto is reserved for incident service dump
1045 // i.e. metadata for debugging.
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001046 ds.EnqueueAddZipEntryAndCleanupIfNeeded(kProtoPath + "incident_report" + kProtoExt,
1047 path);
1048 } else {
1049 unlink(path.c_str());
Mike Ma5c267872019-08-21 11:31:34 -07001050 }
Mike Ma5c267872019-08-21 11:31:34 -07001051}
1052
Sunny Goyal35949782019-11-19 15:54:36 -08001053static void DumpVisibleWindowViews() {
1054 if (!ds.IsZipping()) {
1055 MYLOGD("Not dumping visible views because it's not a zipped bugreport\n");
1056 return;
1057 }
1058 DurationReporter duration_reporter("VISIBLE WINDOW VIEWS");
1059 const std::string path = ds.bugreport_internal_dir_ + "/tmp_visible_window_views";
1060 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1061 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1062 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1063 if (fd < 0) {
1064 MYLOGE("Could not open %s to dump visible views.\n", path.c_str());
1065 return;
1066 }
1067 RunCommandToFd(fd, "", {"cmd", "window", "dump-visible-window-views"},
1068 CommandOptions::WithTimeout(120).Build());
1069 bool empty = 0 == lseek(fd, 0, SEEK_END);
1070 if (!empty) {
1071 ds.AddZipEntry("visible_windows.zip", path);
1072 } else {
1073 MYLOGW("Failed to dump visible windows\n");
1074 }
1075 unlink(path.c_str());
1076}
1077
Jayachandran Ca94c7172017-06-10 15:08:12 -07001078static void DumpIpTablesAsRoot() {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001079 RunCommand("IPTABLES", {"iptables", "-L", "-nvx"});
1080 RunCommand("IP6TABLES", {"ip6tables", "-L", "-nvx"});
Erik Kline32af8c22016-09-28 17:26:26 +09001081 RunCommand("IPTABLES NAT", {"iptables", "-t", "nat", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001082 /* no ip6 nat */
Erik Kline32af8c22016-09-28 17:26:26 +09001083 RunCommand("IPTABLES MANGLE", {"iptables", "-t", "mangle", "-L", "-nvx"});
1084 RunCommand("IP6TABLES MANGLE", {"ip6tables", "-t", "mangle", "-L", "-nvx"});
1085 RunCommand("IPTABLES RAW", {"iptables", "-t", "raw", "-L", "-nvx"});
1086 RunCommand("IP6TABLES RAW", {"ip6tables", "-t", "raw", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001087}
1088
David Andersond9ba4752018-12-11 18:26:59 -08001089static void DumpDynamicPartitionInfo() {
1090 if (!::android::base::GetBoolProperty("ro.boot.dynamic_partitions", false)) {
1091 return;
1092 }
1093
1094 RunCommand("LPDUMP", {"lpdump", "--all"});
David Anderson6650ade2019-10-02 15:18:59 -07001095 RunCommand("DEVICE-MAPPER", {"gsid", "dump-device-mapper"});
David Andersond9ba4752018-12-11 18:26:59 -08001096}
1097
Narayan Kamath8f788292017-05-25 13:20:39 +01001098static void AddAnrTraceDir(const bool add_to_zip, const std::string& anr_traces_dir) {
1099 MYLOGD("AddAnrTraceDir(): dump_traces_file=%s, anr_traces_dir=%s\n", dump_traces_path,
1100 anr_traces_dir.c_str());
1101
1102 // If we're here, dump_traces_path will always be a temporary file
1103 // (created with mkostemp or similar) that contains dumps taken earlier
1104 // on in the process.
1105 if (dump_traces_path != nullptr) {
1106 if (add_to_zip) {
1107 ds.AddZipEntry(ZIP_ROOT_DIR + anr_traces_dir + "/traces-just-now.txt", dump_traces_path);
1108 } else {
1109 MYLOGD("Dumping current ANR traces (%s) to the main bugreport entry\n",
1110 dump_traces_path);
1111 ds.DumpFile("VM TRACES JUST NOW", dump_traces_path);
1112 }
1113
1114 const int ret = unlink(dump_traces_path);
1115 if (ret == -1) {
1116 MYLOGW("Error unlinking temporary trace path %s: %s\n", dump_traces_path,
1117 strerror(errno));
Felipe Lemee184f662016-10-27 10:04:47 -07001118 }
1119 }
1120
Narayan Kamathbd863722017-06-01 18:50:12 +01001121 // Add a specific message for the first ANR Dump.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001122 if (ds.anr_data_.size() > 0) {
1123 AddDumps(ds.anr_data_.begin(), ds.anr_data_.begin() + 1,
Narayan Kamathbd863722017-06-01 18:50:12 +01001124 "VM TRACES AT LAST ANR", add_to_zip);
1125
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001126 // The "last" ANR will always be included as separate entry in the zip file. In addition,
1127 // it will be present in the body of the main entry if |add_to_zip| == false.
1128 //
1129 // Historical ANRs are always included as separate entries in the bugreport zip file.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001130 AddDumps(ds.anr_data_.begin() + ((add_to_zip) ? 1 : 0), ds.anr_data_.end(),
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001131 "HISTORICAL ANR", true /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001132 } else {
Narayan Kamath8f788292017-05-25 13:20:39 +01001133 printf("*** NO ANRs to dump in %s\n\n", ANR_DIR.c_str());
1134 }
1135}
1136
1137static void AddAnrTraceFiles() {
1138 const bool add_to_zip = ds.IsZipping() && ds.version_ == VERSION_SPLIT_ANR;
1139
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001140 std::string anr_traces_dir = "/data/anr";
Narayan Kamath8f788292017-05-25 13:20:39 +01001141
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001142 AddAnrTraceDir(add_to_zip, anr_traces_dir);
Narayan Kamath8f788292017-05-25 13:20:39 +01001143
Makoto Onuki83ec63f2019-01-31 17:08:59 -08001144 RunCommand("ANR FILES", {"ls", "-lt", ANR_DIR});
1145
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001146 // Slow traces for slow operations.
Felipe Lemee184f662016-10-27 10:04:47 -07001147 struct stat st;
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001148 int i = 0;
1149 while (true) {
1150 const std::string slow_trace_path =
1151 anr_traces_dir + android::base::StringPrintf("slow%02d.txt", i);
1152 if (stat(slow_trace_path.c_str(), &st)) {
1153 // No traces file at this index, done with the files.
1154 break;
Felipe Lemee184f662016-10-27 10:04:47 -07001155 }
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001156 ds.DumpFile("VM TRACES WHEN SLOW", slow_trace_path.c_str());
1157 i++;
Felipe Lemee184f662016-10-27 10:04:47 -07001158 }
1159}
1160
Wei Wang509bb5d2017-06-09 14:42:12 -07001161static void DumpBlockStatFiles() {
1162 DurationReporter duration_reporter("DUMP BLOCK STAT");
Wei Wang509bb5d2017-06-09 14:42:12 -07001163
Wei Wang1dc1ef52017-06-12 11:28:37 -07001164 std::unique_ptr<DIR, std::function<int(DIR*)>> dirptr(opendir(BLK_DEV_SYS_DIR), closedir);
1165
1166 if (dirptr == nullptr) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001167 MYLOGE("Failed to open %s: %s\n", BLK_DEV_SYS_DIR, strerror(errno));
1168 return;
1169 }
1170
1171 printf("------ DUMP BLOCK STAT ------\n\n");
Wei Wang1dc1ef52017-06-12 11:28:37 -07001172 while (struct dirent *d = readdir(dirptr.get())) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001173 if ((d->d_name[0] == '.')
1174 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
1175 || (d->d_name[1] == '\0'))) {
1176 continue;
1177 }
1178 const std::string new_path =
1179 android::base::StringPrintf("%s/%s", BLK_DEV_SYS_DIR, d->d_name);
1180 printf("------ BLOCK STAT (%s) ------\n", new_path.c_str());
1181 dump_files("", new_path.c_str(), skip_not_stat, dump_stat_from_fd);
1182 printf("\n");
1183 }
Wei Wang1dc1ef52017-06-12 11:28:37 -07001184 return;
Wei Wang509bb5d2017-06-09 14:42:12 -07001185}
Jayachandran Ca94c7172017-06-10 15:08:12 -07001186
1187static void DumpPacketStats() {
1188 DumpFile("NETWORK DEV INFO", "/proc/net/dev");
1189 DumpFile("QTAGUID NETWORK INTERFACES INFO", "/proc/net/xt_qtaguid/iface_stat_all");
1190 DumpFile("QTAGUID NETWORK INTERFACES INFO (xt)", "/proc/net/xt_qtaguid/iface_stat_fmt");
1191 DumpFile("QTAGUID CTRL INFO", "/proc/net/xt_qtaguid/ctrl");
1192 DumpFile("QTAGUID STATS INFO", "/proc/net/xt_qtaguid/stats");
1193}
1194
1195static void DumpIpAddrAndRules() {
1196 /* The following have a tendency to get wedged when wifi drivers/fw goes belly-up. */
1197 RunCommand("NETWORK INTERFACES", {"ip", "link"});
1198 RunCommand("IPv4 ADDRESSES", {"ip", "-4", "addr", "show"});
1199 RunCommand("IPv6 ADDRESSES", {"ip", "-6", "addr", "show"});
1200 RunCommand("IP RULES", {"ip", "rule", "show"});
1201 RunCommand("IP RULES v6", {"ip", "-6", "rule", "show"});
1202}
1203
Nandana Dutt5c390032019-03-12 10:52:56 +00001204static Dumpstate::RunStatus RunDumpsysTextByPriority(const std::string& title, int priority,
1205 std::chrono::milliseconds timeout,
1206 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001207 auto start = std::chrono::steady_clock::now();
Vishnu Naire97d6122018-01-18 13:58:56 -08001208 sp<android::IServiceManager> sm = defaultServiceManager();
1209 Dumpsys dumpsys(sm.get());
Vishnu Naire97d6122018-01-18 13:58:56 -08001210 Vector<String16> args;
1211 Dumpsys::setServiceArgs(args, /* asProto = */ false, priority);
Vishnu Naire97d6122018-01-18 13:58:56 -08001212 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ false);
1213 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001214 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001215 std::string path(title);
1216 path.append(" - ").append(String8(service).c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -08001217 size_t bytes_written = 0;
Steven Moreland5a30d342019-10-08 13:53:28 -07001218 status_t status = dumpsys.startDumpThread(Dumpsys::Type::DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001219 if (status == OK) {
1220 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1221 std::chrono::duration<double> elapsed_seconds;
1222 status = dumpsys.writeDump(STDOUT_FILENO, service, service_timeout,
1223 /* as_proto = */ false, elapsed_seconds, bytes_written);
Vishnu Naire97d6122018-01-18 13:58:56 -08001224 dumpsys.writeDumpFooter(STDOUT_FILENO, service, elapsed_seconds);
1225 bool dump_complete = (status == OK);
1226 dumpsys.stopDumpThread(dump_complete);
1227 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001228
1229 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1230 std::chrono::steady_clock::now() - start);
1231 if (elapsed_duration > timeout) {
1232 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1233 elapsed_duration.count());
1234 break;
1235 }
1236 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001237 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001238}
1239
Vishnu Nair64afc022018-02-01 15:29:34 -08001240static void RunDumpsysText(const std::string& title, int priority,
1241 std::chrono::milliseconds timeout,
1242 std::chrono::milliseconds service_timeout) {
1243 DurationReporter duration_reporter(title);
1244 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1245 fsync(STDOUT_FILENO);
1246 RunDumpsysTextByPriority(title, priority, timeout, service_timeout);
1247}
1248
1249/* Dump all services registered with Normal or Default priority. */
Nandana Dutt5c390032019-03-12 10:52:56 +00001250static Dumpstate::RunStatus RunDumpsysTextNormalPriority(const std::string& title,
1251 std::chrono::milliseconds timeout,
1252 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001253 DurationReporter duration_reporter(title);
1254 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1255 fsync(STDOUT_FILENO);
1256 RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_NORMAL, timeout,
1257 service_timeout);
Nandana Dutt5c390032019-03-12 10:52:56 +00001258
1259 RETURN_IF_USER_DENIED_CONSENT();
1260
1261 return RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_DEFAULT, timeout,
1262 service_timeout);
Vishnu Nair64afc022018-02-01 15:29:34 -08001263}
1264
Nandana Dutt5c390032019-03-12 10:52:56 +00001265static Dumpstate::RunStatus RunDumpsysProto(const std::string& title, int priority,
1266 std::chrono::milliseconds timeout,
1267 std::chrono::milliseconds service_timeout) {
Luis Hector Chavez1e27b082018-03-22 15:36:42 -07001268 if (!ds.IsZipping()) {
1269 MYLOGD("Not dumping %s because it's not a zipped bugreport\n", title.c_str());
Nandana Dutt5c390032019-03-12 10:52:56 +00001270 return Dumpstate::RunStatus::OK;
Luis Hector Chavez1e27b082018-03-22 15:36:42 -07001271 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001272 sp<android::IServiceManager> sm = defaultServiceManager();
1273 Dumpsys dumpsys(sm.get());
1274 Vector<String16> args;
1275 Dumpsys::setServiceArgs(args, /* asProto = */ true, priority);
1276 DurationReporter duration_reporter(title);
1277
1278 auto start = std::chrono::steady_clock::now();
1279 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ true);
1280 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001281 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001282 std::string path(kProtoPath);
1283 path.append(String8(service).c_str());
1284 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL) {
1285 path.append("_CRITICAL");
1286 } else if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH) {
1287 path.append("_HIGH");
1288 }
1289 path.append(kProtoExt);
Steven Moreland5a30d342019-10-08 13:53:28 -07001290 status_t status = dumpsys.startDumpThread(Dumpsys::Type::DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001291 if (status == OK) {
1292 status = ds.AddZipEntryFromFd(path, dumpsys.getDumpFd(), service_timeout);
1293 bool dumpTerminated = (status == OK);
1294 dumpsys.stopDumpThread(dumpTerminated);
1295 }
1296 ZipWriter::FileEntry file_entry;
1297 ds.zip_writer_->GetLastEntry(&file_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -08001298
1299 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1300 std::chrono::steady_clock::now() - start);
1301 if (elapsed_duration > timeout) {
1302 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1303 elapsed_duration.count());
1304 break;
1305 }
1306 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001307 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001308}
1309
Nandana Dutta7db6342018-11-21 14:53:34 +00001310// Runs dumpsys on services that must dump first and will take less than 100ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001311static Dumpstate::RunStatus RunDumpsysCritical() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001312 RunDumpsysText("DUMPSYS CRITICAL", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1313 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Nandana Dutt5c390032019-03-12 10:52:56 +00001314
1315 RETURN_IF_USER_DENIED_CONSENT();
1316
1317 return RunDumpsysProto("DUMPSYS CRITICAL PROTO", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1318 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Vishnu Nair780b1282017-10-10 13:57:24 -07001319}
1320
1321// Runs dumpsys on services that must dump first but can take up to 250ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001322static Dumpstate::RunStatus RunDumpsysHigh() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001323 // TODO meminfo takes ~10s, connectivity takes ~5sec to dump. They are both
1324 // high priority. Reduce timeout once they are able to dump in a shorter time or
1325 // moved to a parallel task.
1326 RunDumpsysText("DUMPSYS HIGH", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1327 /* timeout= */ 90s, /* service_timeout= */ 30s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001328
1329 RETURN_IF_USER_DENIED_CONSENT();
1330
1331 return RunDumpsysProto("DUMPSYS HIGH PROTO", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1332 /* timeout= */ 5s, /* service_timeout= */ 1s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001333}
1334
1335// Runs dumpsys on services that must dump but can take up to 10s to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001336static Dumpstate::RunStatus RunDumpsysNormal() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001337 RunDumpsysTextNormalPriority("DUMPSYS", /* timeout= */ 90s, /* service_timeout= */ 10s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001338
1339 RETURN_IF_USER_DENIED_CONSENT();
1340
1341 return RunDumpsysProto("DUMPSYS PROTO", IServiceManager::DUMP_FLAG_PRIORITY_NORMAL,
1342 /* timeout= */ 90s, /* service_timeout= */ 10s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001343}
1344
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001345/*
1346 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1347 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1348 * if it's not running in the parallel task.
1349 */
1350static void DumpHals(int out_fd = STDOUT_FILENO) {
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001351 if (!ds.IsZipping()) {
Yifan Hong30528a22020-08-07 18:24:06 -07001352 RunCommand("HARDWARE HALS", {"lshal", "--all", "--types=all", "--debug"},
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001353 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build(),
1354 false, out_fd);
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001355 return;
1356 }
Yifan Hong30528a22020-08-07 18:24:06 -07001357 RunCommand("HARDWARE HALS", {"lshal", "--all", "--types=all"},
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001358 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build(),
1359 false, out_fd);
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001360
Steven Moreland44cd9482018-01-04 16:24:13 -08001361 using android::hidl::manager::V1_0::IServiceManager;
1362 using android::hardware::defaultServiceManager;
1363
1364 sp<IServiceManager> sm = defaultServiceManager();
1365 if (sm == nullptr) {
1366 MYLOGE("Could not retrieve hwservicemanager to dump hals.\n");
1367 return;
1368 }
1369
1370 auto ret = sm->list([&](const auto& interfaces) {
1371 for (const std::string& interface : interfaces) {
1372 std::string cleanName = interface;
1373 std::replace_if(cleanName.begin(),
1374 cleanName.end(),
1375 [](char c) {
1376 return !isalnum(c) &&
1377 std::string("@-_:.").find(c) == std::string::npos;
1378 }, '_');
Nandana Dutt979388e2018-11-30 16:48:55 +00001379 const std::string path = ds.bugreport_internal_dir_ + "/lshal_debug_" + cleanName;
Steven Moreland44cd9482018-01-04 16:24:13 -08001380
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001381 bool empty = false;
Steven Moreland44cd9482018-01-04 16:24:13 -08001382 {
1383 auto fd = android::base::unique_fd(
1384 TEMP_FAILURE_RETRY(open(path.c_str(),
1385 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1386 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1387 if (fd < 0) {
1388 MYLOGE("Could not open %s to dump additional hal information.\n", path.c_str());
1389 continue;
1390 }
1391 RunCommandToFd(fd,
1392 "",
Steven Morelandc81cd3c2018-01-18 14:36:26 -08001393 {"lshal", "debug", "-E", interface},
Steven Moreland44cd9482018-01-04 16:24:13 -08001394 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
1395
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001396 empty = 0 == lseek(fd, 0, SEEK_END);
Steven Moreland44cd9482018-01-04 16:24:13 -08001397 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001398 if (!empty) {
1399 ds.EnqueueAddZipEntryAndCleanupIfNeeded("lshal-debug/" + cleanName + ".txt",
1400 path);
1401 } else {
1402 unlink(path.c_str());
1403 }
Steven Moreland44cd9482018-01-04 16:24:13 -08001404 }
1405 });
1406
1407 if (!ret.isOk()) {
1408 MYLOGE("Could not list hals from hwservicemanager.\n");
1409 }
1410}
1411
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001412static void DumpExternalFragmentationInfo() {
1413 struct stat st;
1414 if (stat("/proc/buddyinfo", &st) != 0) {
1415 MYLOGE("Unable to dump external fragmentation info\n");
1416 return;
1417 }
1418
1419 printf("------ EXTERNAL FRAGMENTATION INFO ------\n");
1420 std::ifstream ifs("/proc/buddyinfo");
1421 auto unusable_index_regex = std::regex{"Node\\s+([0-9]+),\\s+zone\\s+(\\S+)\\s+(.*)"};
1422 for (std::string line; std::getline(ifs, line);) {
1423 std::smatch match_results;
1424 if (std::regex_match(line, match_results, unusable_index_regex)) {
1425 std::stringstream free_pages(std::string{match_results[3]});
1426 std::vector<int> free_pages_per_order(std::istream_iterator<int>{free_pages},
1427 std::istream_iterator<int>());
1428
1429 int total_free_pages = 0;
1430 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1431 total_free_pages += (free_pages_per_order[i] * std::pow(2, i));
1432 }
1433
1434 printf("Node %s, zone %8s", match_results[1].str().c_str(),
1435 match_results[2].str().c_str());
1436
1437 int usable_free_pages = total_free_pages;
1438 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1439 auto unusable_index = (total_free_pages - usable_free_pages) /
1440 static_cast<double>(total_free_pages);
1441 printf(" %5.3f", unusable_index);
1442 usable_free_pages -= (free_pages_per_order[i] * std::pow(2, i));
1443 }
1444
1445 printf("\n");
1446 }
1447 }
1448 printf("\n");
1449}
1450
mhasankd451a472020-05-26 18:02:39 -07001451static void DumpstateLimitedOnly() {
1452 // Trimmed-down version of dumpstate to only include a whitelisted
1453 // set of logs (system log, event log, and system server / system app
1454 // crashes, and networking logs). See b/136273873 and b/138459828
1455 // for context.
1456 DurationReporter duration_reporter("DUMPSTATE");
1457 unsigned long timeout_ms;
1458 // calculate timeout
1459 timeout_ms = logcat_timeout({"main", "system", "crash"});
1460 RunCommand("SYSTEM LOG",
1461 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1462 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1463 timeout_ms = logcat_timeout({"events"});
1464 RunCommand(
1465 "EVENT LOG",
1466 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1467 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1468
1469 printf("========================================================\n");
1470 printf("== Networking Service\n");
1471 printf("========================================================\n");
1472
1473 RunDumpsys("DUMPSYS NETWORK_SERVICE_LIMITED", {"wifi", "-a"},
1474 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
1475
1476 printf("========================================================\n");
1477 printf("== Dropbox crashes\n");
1478 printf("========================================================\n");
1479
1480 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1481 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1482
1483 printf("========================================================\n");
1484 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1485 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1486 printf("========================================================\n");
1487 printf("== dumpstate: done (id %d)\n", ds.id_);
1488 printf("========================================================\n");
1489}
1490
Rhed Jaoe017f982020-07-21 17:58:41 +08001491/*
1492 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1493 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1494 * if it's not running in the parallel task.
1495 */
1496static void DumpCheckins(int out_fd = STDOUT_FILENO) {
1497 dprintf(out_fd, "========================================================\n");
1498 dprintf(out_fd, "== Checkins\n");
1499 dprintf(out_fd, "========================================================\n");
1500
1501 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"}, out_fd);
1502 RunDumpsys("CHECKIN MEMINFO", {"meminfo", "--checkin"}, out_fd);
1503 RunDumpsys("CHECKIN NETSTATS", {"netstats", "--checkin"}, out_fd);
1504 RunDumpsys("CHECKIN PROCSTATS", {"procstats", "-c"}, out_fd);
1505 RunDumpsys("CHECKIN USAGESTATS", {"usagestats", "-c"}, out_fd);
1506 RunDumpsys("CHECKIN PACKAGE", {"package", "--checkin"}, out_fd);
1507}
1508
1509/*
1510 * Runs dumpsys on activity service to dump all application activities, services
1511 * and providers in the device.
1512 *
1513 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1514 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1515 * if it's not running in the parallel task.
1516 */
1517static void DumpAppInfos(int out_fd = STDOUT_FILENO) {
1518 dprintf(out_fd, "========================================================\n");
1519 dprintf(out_fd, "== Running Application Activities\n");
1520 dprintf(out_fd, "========================================================\n");
1521
1522 // The following dumpsys internally collects output from running apps, so it can take a long
1523 // time. So let's extend the timeout.
1524
1525 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
1526
1527 RunDumpsys("APP ACTIVITIES", {"activity", "-v", "all"}, DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1528
1529 dprintf(out_fd, "========================================================\n");
1530 dprintf(out_fd, "== Running Application Services (platform)\n");
1531 dprintf(out_fd, "========================================================\n");
1532
1533 RunDumpsys("APP SERVICES PLATFORM", {"activity", "service", "all-platform-non-critical"},
1534 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1535
1536 dprintf(out_fd, "========================================================\n");
1537 dprintf(out_fd, "== Running Application Services (non-platform)\n");
1538 dprintf(out_fd, "========================================================\n");
1539
1540 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1541 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1542
1543 dprintf(out_fd, "========================================================\n");
1544 dprintf(out_fd, "== Running Application Providers (platform)\n");
1545 dprintf(out_fd, "========================================================\n");
1546
1547 RunDumpsys("APP PROVIDERS PLATFORM", {"activity", "provider", "all-platform"},
1548 DUMPSYS_COMPONENTS_OPTIONS, out_fd);
1549
1550 dprintf(out_fd, "========================================================\n");
1551 dprintf(out_fd, "== Running Application Providers (non-platform)\n");
1552 dprintf(out_fd, "========================================================\n");
1553
1554 RunDumpsys("APP PROVIDERS NON-PLATFORM", {"activity", "provider", "all-non-platform"},
1555 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1556}
1557
Nandana Dutt5c390032019-03-12 10:52:56 +00001558// Dumps various things. Returns early with status USER_CONSENT_DENIED if user denies consent
1559// via the consent they are shown. Ignores other errors that occur while running various
1560// commands. The consent checking is currently done around long running tasks, which happen to
1561// be distributed fairly evenly throughout the function.
1562static Dumpstate::RunStatus dumpstate() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001563 DurationReporter duration_reporter("DUMPSTATE");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001564
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001565 // Enqueue slow functions into the thread pool, if the parallel run is enabled.
1566 if (ds.dump_pool_) {
1567 // Pool was shutdown in DumpstateDefaultAfterCritical method in order to
1568 // drop root user. Restarts it with two threads for the parallel run.
1569 ds.dump_pool_->start(/* thread_counts = */2);
1570
1571 ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
1572 ds.dump_pool_->enqueueTask(DUMP_INCIDENT_REPORT_TASK, &DumpIncidentReport);
1573 ds.dump_pool_->enqueueTaskWithFd(DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
Rhed Jaoe017f982020-07-21 17:58:41 +08001574 ds.dump_pool_->enqueueTaskWithFd(DUMP_CHECKINS_TASK, &DumpCheckins, _1);
1575 ds.dump_pool_->enqueueTaskWithFd(DUMP_APP_INFOS_TASK, &DumpAppInfos, _1);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001576 }
1577
Nandana Dutt5c390032019-03-12 10:52:56 +00001578 // Dump various things. Note that anything that takes "long" (i.e. several seconds) should
1579 // check intermittently (if it's intrerruptable like a foreach on pids) and/or should be wrapped
1580 // in a consent check (via RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK).
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -07001581 dump_dev_files("TRUSTY VERSION", "/sys/bus/platform/drivers/trusty", "trusty_version");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001582 RunCommand("UPTIME", {"uptime"});
Wei Wang509bb5d2017-06-09 14:42:12 -07001583 DumpBlockStatFiles();
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001584 DumpFile("MEMORY INFO", "/proc/meminfo");
1585 RunCommand("CPU INFO", {"top", "-b", "-n", "1", "-H", "-s", "6", "-o",
Felipe Leme30dbfa12016-09-02 12:43:26 -07001586 "pid,tid,user,pr,ni,%cpu,s,virt,res,pcy,cmd,name"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001587
1588 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "PROCRANK", {"procrank"}, AS_ROOT_20);
1589
Sunny Goyal35949782019-11-19 15:54:36 -08001590 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpVisibleWindowViews);
1591
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001592 DumpFile("VIRTUAL MEMORY STATS", "/proc/vmstat");
1593 DumpFile("VMALLOC INFO", "/proc/vmallocinfo");
1594 DumpFile("SLAB INFO", "/proc/slabinfo");
1595 DumpFile("ZONEINFO", "/proc/zoneinfo");
1596 DumpFile("PAGETYPEINFO", "/proc/pagetypeinfo");
1597 DumpFile("BUDDYINFO", "/proc/buddyinfo");
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001598 DumpExternalFragmentationInfo();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001599
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001600 DumpFile("KERNEL WAKE SOURCES", "/d/wakeup_sources");
1601 DumpFile("KERNEL CPUFREQ", "/sys/devices/system/cpu/cpu0/cpufreq/stats/time_in_state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001602
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001603 RunCommand("PROCESSES AND THREADS",
Yohei Yukawa591a72d2017-10-05 21:36:35 -07001604 {"ps", "-A", "-T", "-Z", "-O", "pri,nice,rtprio,sched,pcy,time"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001605
1606 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "LIBRANK", {"librank"},
1607 CommandOptions::AS_ROOT);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001608
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001609 if (ds.dump_pool_) {
1610 WAIT_TASK_WITH_CONSENT_CHECK(DUMP_HALS_TASK, ds.dump_pool_);
1611 } else {
1612 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_HALS_TASK, DumpHals);
1613 }
Steven Moreland81b429e2017-01-31 19:50:46 -08001614
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001615 RunCommand("PRINTENV", {"printenv"});
Elliott Hughes21b7c8d2016-10-28 08:53:02 -07001616 RunCommand("NETSTAT", {"netstat", "-nW"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001617 struct stat s;
1618 if (stat("/proc/modules", &s) != 0) {
1619 MYLOGD("Skipping 'lsmod' because /proc/modules does not exist\n");
1620 } else {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001621 RunCommand("LSMOD", {"lsmod"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001622 }
Michal Karpinski4db754f2015-12-11 18:04:32 +00001623
Tom Cherryb87dbfa2020-07-28 11:28:53 -07001624 if (android::base::GetBoolProperty("ro.logd.kernel", false)) {
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001625 DoKernelLogcat();
1626 } else {
1627 do_dmesg();
1628 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001629
Felipe Lemef0292972016-11-22 13:57:05 -08001630 RunCommand("LIST OF OPEN FILES", {"lsof"}, CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001631
1632 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(for_each_pid, do_showmap, "SMAPS OF ALL PROCESSES");
1633
Jeff Brown1dc94e32014-09-11 14:15:27 -07001634 for_each_tid(show_wchan, "BLOCKED PROCESS WAIT-CHANNELS");
Mark Salyzyna297c322016-02-05 15:33:17 -08001635 for_each_pid(show_showtime, "PROCESS TIMES (pid cmd user system iowait+percentage)");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001636
Ajay Panicker2ff8e872017-04-27 14:04:32 -07001637 /* Dump Bluetooth HCI logs */
1638 ds.AddDir("/data/misc/bluetooth/logs", true);
Ajay Panickerd886ec42016-09-14 12:26:46 -07001639
Paul Chang0d2aad72020-02-13 20:04:03 +08001640 if (ds.options_->do_screenshot && !ds.do_early_screenshot_) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001641 MYLOGI("taking late screenshot\n");
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001642 ds.TakeScreenshot();
Jeff Sharkey5a930032013-03-19 15:05:19 -07001643 }
1644
Felipe Lemee184f662016-10-27 10:04:47 -07001645 AddAnrTraceFiles();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001646
Narayan Kamath8f788292017-05-25 13:20:39 +01001647 // NOTE: tombstones are always added as separate entries in the zip archive
1648 // and are not interspersed with the main report.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001649 const bool tombstones_dumped = AddDumps(ds.tombstone_data_.begin(), ds.tombstone_data_.end(),
Narayan Kamathbd863722017-06-01 18:50:12 +01001650 "TOMBSTONE", true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001651 if (!tombstones_dumped) {
1652 printf("*** NO TOMBSTONES to dump in %s\n\n", TOMBSTONE_DIR.c_str());
Christopher Ferris7dc7f322014-07-22 16:08:19 -07001653 }
1654
Jayachandran Ca94c7172017-06-10 15:08:12 -07001655 DumpPacketStats();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001656
Chenbo Feng276a3b62018-08-07 11:44:49 -07001657 RunDumpsys("EBPF MAP STATS", {"netd", "trafficcontroller"});
1658
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001659 DoKmsg();
Mark Salyzyn2262c162014-12-16 09:09:26 -08001660
Jayachandran Ca94c7172017-06-10 15:08:12 -07001661 DumpIpAddrAndRules();
Sreeram Ramachandran2b3bba32014-07-08 15:40:55 -07001662
1663 dump_route_tables();
1664
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001665 RunCommand("ARP CACHE", {"ip", "-4", "neigh", "show"});
1666 RunCommand("IPv6 ND CACHE", {"ip", "-6", "neigh", "show"});
1667 RunCommand("MULTICAST ADDRESSES", {"ip", "maddr"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001668
Nandana Dutt5c390032019-03-12 10:52:56 +00001669 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysHigh);
Lorenzo Colitti6afc38c2015-09-09 22:59:25 +09001670
Elliott Hughes23ccc622017-02-28 10:14:22 -08001671 RunCommand("SYSTEM PROPERTIES", {"getprop"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001672
Jin Qianf334d662017-10-10 14:41:37 -07001673 RunCommand("STORAGED IO INFO", {"storaged", "-u", "-p"});
ynwangf649a6e2016-07-17 21:56:00 -07001674
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001675 RunCommand("FILESYSTEMS & FREE SPACE", {"df"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001676
Colin Crossf45fa6b2012-03-26 12:38:26 -07001677 /* Binder state is expensive to look at as it uses a lot of memory. */
Hridya Valsaraju920ba712020-02-09 16:27:01 -08001678 std::string binder_logs_dir = access("/dev/binderfs/binder_logs", R_OK) ?
1679 "/sys/kernel/debug/binder" : "/dev/binderfs/binder_logs";
1680
1681 DumpFile("BINDER FAILED TRANSACTION LOG", binder_logs_dir + "/failed_transaction_log");
1682 DumpFile("BINDER TRANSACTION LOG", binder_logs_dir + "/transaction_log");
1683 DumpFile("BINDER TRANSACTIONS", binder_logs_dir + "/transactions");
1684 DumpFile("BINDER STATS", binder_logs_dir + "/stats");
1685 DumpFile("BINDER STATE", binder_logs_dir + "/state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001686
Vishnu Nair36b4cdb2017-11-17 10:27:05 -08001687 /* Add window and surface trace files. */
1688 if (!PropertiesHelper::IsUserBuild()) {
1689 ds.AddDir(WMTRACE_DATA_DIR, false);
1690 }
1691
Yifan Hongd90cc652020-02-08 16:52:02 -08001692 ds.AddDir(SNAPSHOTCTL_LOG_DIR, false);
1693
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001694 if (ds.dump_pool_) {
1695 WAIT_TASK_WITH_CONSENT_CHECK(DUMP_BOARD_TASK, ds.dump_pool_);
1696 } else {
1697 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
1698 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001699
Steven Moreland7440ddb2016-12-15 16:13:39 -08001700 /* Migrate the ril_dumpstate to a device specific dumpstate? */
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001701 int rilDumpstateTimeout = android::base::GetIntProperty("ril.dumpstate.timeout", 0);
1702 if (rilDumpstateTimeout > 0) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001703 // su does not exist on user builds, so try running without it.
1704 // This way any implementations of vril-dump that do not require
1705 // root can run on user builds.
1706 CommandOptions::CommandOptionsBuilder options =
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001707 CommandOptions::WithTimeout(rilDumpstateTimeout);
Felipe Lemef0292972016-11-22 13:57:05 -08001708 if (!PropertiesHelper::IsUserBuild()) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001709 options.AsRoot();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001710 }
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001711 RunCommand("DUMP VENDOR RIL LOGS", {"vril-dump"}, options.Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -07001712 }
1713
Felipe Lemed8b94e52016-12-08 10:21:44 -08001714 printf("========================================================\n");
1715 printf("== Android Framework Services\n");
1716 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001717
Nandana Dutt5c390032019-03-12 10:52:56 +00001718 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysNormal);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001719
Rhed Jaoe017f982020-07-21 17:58:41 +08001720 if (ds.dump_pool_) {
1721 WAIT_TASK_WITH_CONSENT_CHECK(DUMP_CHECKINS_TASK, ds.dump_pool_);
1722 } else {
1723 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_CHECKINS_TASK, DumpCheckins);
1724 }
Dianne Hackborn02bea972013-06-26 18:59:09 -07001725
Rhed Jaoe017f982020-07-21 17:58:41 +08001726 if (ds.dump_pool_) {
1727 WAIT_TASK_WITH_CONSENT_CHECK(DUMP_APP_INFOS_TASK, ds.dump_pool_);
1728 } else {
1729 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_APP_INFOS_TASK, DumpAppInfos);
1730 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001731
Adrian Roos8b397ab2017-04-04 16:35:44 -07001732 printf("========================================================\n");
1733 printf("== Dropbox crashes\n");
1734 printf("========================================================\n");
1735
1736 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1737 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1738
Felipe Lemed8b94e52016-12-08 10:21:44 -08001739 printf("========================================================\n");
1740 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1741 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1742 printf("========================================================\n");
1743 printf("== dumpstate: done (id %d)\n", ds.id_);
1744 printf("========================================================\n");
Bookatz38472142018-09-28 10:20:24 -07001745
1746 printf("========================================================\n");
1747 printf("== Obtaining statsd metadata\n");
1748 printf("========================================================\n");
1749 // This differs from the usual dumpsys stats, which is the stats report data.
1750 RunDumpsys("STATSDSTATS", {"stats", "--metadata"});
Mike Ma5c267872019-08-21 11:31:34 -07001751
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +09001752 // Add linker configuration directory
1753 ds.AddDir(LINKERCONFIG_DIR, true);
1754
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001755 if (ds.dump_pool_) {
1756 WAIT_TASK_WITH_CONSENT_CHECK(DUMP_INCIDENT_REPORT_TASK, ds.dump_pool_);
1757 } else {
1758 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_INCIDENT_REPORT_TASK,
1759 DumpIncidentReport);
1760 }
Mike Ma5c267872019-08-21 11:31:34 -07001761
Nandana Dutt5c390032019-03-12 10:52:56 +00001762 return Dumpstate::RunStatus::OK;
Colin Crossf45fa6b2012-03-26 12:38:26 -07001763}
1764
Nandana Dutt5c390032019-03-12 10:52:56 +00001765/*
1766 * Dumps state for the default case; drops root after it's no longer necessary.
1767 *
1768 * Returns RunStatus::OK if everything went fine.
1769 * Returns RunStatus::ERROR if there was an error.
1770 * Returns RunStatus::USER_DENIED_CONSENT if user explicitly denied consent to sharing the bugreport
1771 * with the caller.
1772 */
Jichao Lie89d9c12019-11-21 19:02:51 -08001773Dumpstate::RunStatus Dumpstate::DumpstateDefaultAfterCritical() {
Nandana Duttdb379fa2019-10-09 16:54:41 +01001774 // Capture first logcat early on; useful to take a snapshot before dumpstate logs take over the
1775 // buffer.
1776 DoLogcat();
1777 // Capture timestamp after first logcat to use in next logcat
1778 time_t logcat_ts = time(nullptr);
1779
Nandana Dutt4be45d12018-09-26 15:04:23 +01001780 /* collect stack traces from Dalvik and native processes (needs root) */
Rhed Jao5377d792020-07-16 17:37:39 +08001781 if (dump_pool_) {
1782 RETURN_IF_USER_DENIED_CONSENT();
1783 // One thread is enough since we only need to enqueue DumpTraces here.
1784 dump_pool_->start(/* thread_counts = */1);
1785
1786 // DumpTraces takes long time, post it to the another thread in the
1787 // pool, if pool is available
1788 dump_pool_->enqueueTask(DUMP_TRACES_TASK, &Dumpstate::DumpTraces, &ds, &dump_traces_path);
1789 } else {
1790 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_TRACES_TASK, ds.DumpTraces,
1791 &dump_traces_path);
1792 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001793
1794 /* Run some operations that require root. */
1795 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX, !ds.IsZipping());
1796 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX, !ds.IsZipping());
1797
1798 ds.AddDir(RECOVERY_DIR, true);
1799 ds.AddDir(RECOVERY_DATA_DIR, true);
1800 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
1801 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1802 if (!PropertiesHelper::IsUserBuild()) {
1803 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1804 ds.AddDir(PROFILE_DATA_DIR_REF, true);
Calin Juravlef84d3692020-04-28 15:31:12 -07001805 ds.AddZipEntry(ZIP_ROOT_DIR + PACKAGE_DEX_USE_LIST, PACKAGE_DEX_USE_LIST);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001806 }
Jerry Changa1df8a92020-01-02 16:03:39 +08001807 ds.AddDir(PREREBOOT_DATA_DIR, false);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001808 add_mountinfo();
1809 DumpIpTablesAsRoot();
David Andersond9ba4752018-12-11 18:26:59 -08001810 DumpDynamicPartitionInfo();
Yifan Hong3945e1b2019-10-29 12:59:23 -07001811 ds.AddDir(OTA_METADATA_DIR, true);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001812
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001813 // Capture any IPSec policies in play. No keys are exposed here.
Nandana Dutt4be45d12018-09-26 15:04:23 +01001814 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1815
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001816 // Dump IPsec stats. No keys are exposed here.
1817 DumpFile("XFRM STATS", XFRM_STAT_PROC_FILE);
1818
Nandana Dutt4be45d12018-09-26 15:04:23 +01001819 // Run ss as root so we can see socket marks.
1820 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
1821
1822 // Run iotop as root to show top 100 IO threads
1823 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
1824
Erick Reyese68df822019-02-11 14:46:36 -08001825 // Gather shared memory buffer info if the product implements it
1826 struct stat st;
1827 if (!stat("/product/bin/dmabuf_dump", &st)) {
1828 RunCommand("Dmabuf dump", {"/product/bin/dmabuf_dump"});
1829 }
1830
Minchan Kim22c6a1e2019-09-30 15:58:10 -07001831 DumpFile("PSI cpu", "/proc/pressure/cpu");
1832 DumpFile("PSI memory", "/proc/pressure/memory");
1833 DumpFile("PSI io", "/proc/pressure/io");
1834
Rhed Jao5377d792020-07-16 17:37:39 +08001835 if (dump_pool_) {
1836 RETURN_IF_USER_DENIED_CONSENT();
1837 dump_pool_->waitForTask(DUMP_TRACES_TASK);
1838
1839 // Current running thread in the pool is the root user also. Shutdown
1840 // the pool and restart later to ensure all threads in the pool could
1841 // drop the root user.
1842 dump_pool_->shutdown();
1843 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001844 if (!DropRootUser()) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001845 return Dumpstate::RunStatus::ERROR;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001846 }
1847
Nandana Dutt5c390032019-03-12 10:52:56 +00001848 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttdb379fa2019-10-09 16:54:41 +01001849 Dumpstate::RunStatus status = dumpstate();
1850 // Capture logcat since the last time we did it.
1851 DoSystemLogcat(logcat_ts);
1852 return status;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001853}
1854
Rhed Jaob5685b32020-08-14 17:19:17 +08001855// Common states for telephony and wifi which are needed to be collected before
1856// dumpstate drop the root user.
1857static void DumpstateRadioAsRoot() {
1858 DumpIpTablesAsRoot();
1859 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1860}
1861
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001862// This method collects common dumpsys for telephony and wifi. Typically, wifi
1863// reports are fine to include all information, but telephony reports on user
1864// builds need to strip some content (see DumpstateTelephonyOnly).
1865static void DumpstateRadioCommon(bool include_sensitive_info = true) {
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001866 // We need to be picky about some stuff for telephony reports on user builds.
1867 if (!include_sensitive_info) {
1868 // Only dump the radio log buffer (other buffers and dumps contain too much unrelated info).
1869 DoRadioLogcat();
1870 } else {
Rhed Jaob5685b32020-08-14 17:19:17 +08001871 // DumpHals takes long time, post it to the another thread in the pool,
1872 // if pool is available.
1873 if (ds.dump_pool_) {
1874 ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
1875 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001876 // Contains various system properties and process startup info.
1877 do_dmesg();
1878 // Logs other than the radio buffer may contain package/component names and potential PII.
1879 DoLogcat();
1880 // Too broad for connectivity problems.
1881 DoKmsg();
Rhed Jaob5685b32020-08-14 17:19:17 +08001882 // DumpHals contains unrelated hardware info (camera, NFC, biometrics, ...).
1883 if (ds.dump_pool_) {
1884 ds.dump_pool_->waitForTask(DUMP_HALS_TASK);
1885 } else {
1886 RUN_SLOW_FUNCTION_AND_LOG(DUMP_HALS_TASK, DumpHals);
1887 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001888 }
1889
Jayachandran Ca94c7172017-06-10 15:08:12 -07001890 DumpPacketStats();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001891 DumpIpAddrAndRules();
1892 dump_route_tables();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001893 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
1894 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08001895}
1896
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001897// We use "telephony" here for legacy reasons, though this now really means "connectivity" (cellular
1898// + wifi + networking). This method collects dumpsys for connectivity debugging only. General rules
1899// for what can be included on user builds: all reported information MUST directly relate to
1900// connectivity debugging or customer support and MUST NOT contain unrelated personally identifiable
1901// information. This information MUST NOT identify user-installed packages (UIDs are OK, package
1902// names are not), and MUST NOT contain logs of user application traffic.
1903// TODO(b/148168577) rename this and other related fields/methods to "connectivity" instead.
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08001904static void DumpstateTelephonyOnly(const std::string& calling_package) {
mukesh agrawal253dad42018-01-23 21:59:59 -08001905 DurationReporter duration_reporter("DUMPSTATE");
Jichao Lie89d9c12019-11-21 19:02:51 -08001906
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001907 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08001908
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001909 const bool include_sensitive_info = !PropertiesHelper::IsUserBuild();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001910
Rhed Jaob5685b32020-08-14 17:19:17 +08001911 DumpstateRadioAsRoot();
1912 if (!DropRootUser()) {
1913 return;
1914 }
1915
1916 // Starts thread pool after the root user is dropped, and two additional threads
1917 // are created for DumpHals in the DumpstateRadioCommon and DumpstateBoard.
1918 if (ds.dump_pool_) {
1919 ds.dump_pool_->start(/*thread_counts =*/2);
1920
1921 // DumpstateBoard takes long time, post it to the another thread in the pool,
1922 // if pool is available.
1923 ds.dump_pool_->enqueueTaskWithFd(DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
1924 }
1925
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001926 DumpstateRadioCommon(include_sensitive_info);
1927
1928 if (include_sensitive_info) {
1929 // Contains too much unrelated PII, and given the unstructured nature of sysprops, we can't
1930 // really cherrypick all of the connectivity-related ones. Apps generally have no business
1931 // reading these anyway, and there should be APIs to supply the info in a more app-friendly
1932 // way.
1933 RunCommand("SYSTEM PROPERTIES", {"getprop"});
1934 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07001935
1936 printf("========================================================\n");
1937 printf("== Android Framework Services\n");
1938 printf("========================================================\n");
1939
Vishnu Nair652cc802017-11-30 15:18:30 -08001940 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1941 SEC_TO_MSEC(10));
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08001942 if (include_sensitive_info) {
1943 // Carrier apps' services will be dumped below in dumpsys activity service all-non-platform.
1944 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
1945 SEC_TO_MSEC(10));
1946 } else {
1947 // If the caller is a carrier app and has a carrier service, dump it here since we aren't
1948 // running dumpsys activity service all-non-platform below. Due to the increased output, we
1949 // give a higher timeout as well.
1950 RunDumpsys("DUMPSYS", {"carrier_config", "--requesting-package", calling_package},
1951 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(30));
1952 }
1953 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001954 RunDumpsys("DUMPSYS", {"netpolicy"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
1955 RunDumpsys("DUMPSYS", {"network_management"}, CommandOptions::WithTimeout(90).Build(),
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07001956 SEC_TO_MSEC(10));
Hunter Knepshield0fe51b12020-03-05 16:58:20 -08001957 RunDumpsys("DUMPSYS", {"telephony.registry"}, CommandOptions::WithTimeout(90).Build(),
1958 SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001959 if (include_sensitive_info) {
1960 // Contains raw IP addresses, omit from reports on user builds.
1961 RunDumpsys("DUMPSYS", {"netd"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
1962 // Contains raw destination IP/MAC addresses, omit from reports on user builds.
1963 RunDumpsys("DUMPSYS", {"connmetrics"}, CommandOptions::WithTimeout(90).Build(),
1964 SEC_TO_MSEC(10));
1965 // Contains package/component names, omit from reports on user builds.
1966 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
1967 SEC_TO_MSEC(10));
1968 // Contains package names, but should be relatively simple to remove them (also contains
1969 // UIDs already), omit from reports on user builds.
1970 RunDumpsys("BATTERYSTATS", {"deviceidle"}, CommandOptions::WithTimeout(90).Build(),
1971 SEC_TO_MSEC(10));
1972 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07001973
1974 printf("========================================================\n");
1975 printf("== Running Application Services\n");
1976 printf("========================================================\n");
1977
1978 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
1979
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001980 if (include_sensitive_info) {
1981 printf("========================================================\n");
1982 printf("== Running Application Services (non-platform)\n");
1983 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001984
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001985 // Contains package/component names and potential PII, omit from reports on user builds.
1986 // To get dumps of the active CarrierService(s) on user builds, we supply an argument to the
1987 // carrier_config dumpsys instead.
1988 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1989 DUMPSYS_COMPONENTS_OPTIONS);
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001990
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001991 printf("========================================================\n");
1992 printf("== Checkins\n");
1993 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07001994
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001995 // Contains package/component names, omit from reports on user builds.
1996 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
1997 }
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07001998
1999 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07002000 printf("== dumpstate: done (id %d)\n", ds.id_);
2001 printf("========================================================\n");
Rhed Jaob5685b32020-08-14 17:19:17 +08002002
2003 if (ds.dump_pool_) {
2004 ds.dump_pool_->waitForTask(DUMP_BOARD_TASK);
2005 } else {
2006 RUN_SLOW_FUNCTION_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
2007 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002008}
2009
mukesh agrawal253dad42018-01-23 21:59:59 -08002010// This method collects dumpsys for wifi debugging only
2011static void DumpstateWifiOnly() {
2012 DurationReporter duration_reporter("DUMPSTATE");
2013
Rhed Jaob5685b32020-08-14 17:19:17 +08002014 DumpstateRadioAsRoot();
2015 if (!DropRootUser()) {
2016 return;
2017 }
2018
2019 // Starts thread pool after the root user is dropped. Only one additional
2020 // thread is needed for DumpHals in the DumpstateRadioCommon.
2021 if (ds.dump_pool_) {
2022 ds.dump_pool_->start(/*thread_counts =*/1);
2023 }
2024
mukesh agrawal253dad42018-01-23 21:59:59 -08002025 DumpstateRadioCommon();
2026
2027 printf("========================================================\n");
2028 printf("== Android Framework Services\n");
2029 printf("========================================================\n");
2030
2031 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
2032 SEC_TO_MSEC(10));
2033 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
2034 SEC_TO_MSEC(10));
2035
2036 printf("========================================================\n");
2037 printf("== dumpstate: done (id %d)\n", ds.id_);
2038 printf("========================================================\n");
2039}
2040
Nandana Duttcf419a72019-03-14 10:40:17 +00002041Dumpstate::RunStatus Dumpstate::DumpTraces(const char** path) {
Nandana Duttfaafd522019-03-11 09:23:09 +00002042 const std::string temp_file_pattern = "/data/anr/dumptrace_XXXXXX";
2043 const size_t buf_size = temp_file_pattern.length() + 1;
2044 std::unique_ptr<char[]> file_name_buf(new char[buf_size]);
2045 memcpy(file_name_buf.get(), temp_file_pattern.c_str(), buf_size);
2046
2047 // Create a new, empty file to receive all trace dumps.
2048 //
2049 // TODO: This can be simplified once we remove support for the old style
2050 // dumps. We can have a file descriptor passed in to dump_traces instead
2051 // of creating a file, closing it and then reopening it again.
2052 android::base::unique_fd fd(mkostemp(file_name_buf.get(), O_APPEND | O_CLOEXEC));
2053 if (fd < 0) {
2054 MYLOGE("mkostemp on pattern %s: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002055 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002056 }
2057
2058 // Nobody should have access to this temporary file except dumpstate, but we
2059 // temporarily grant 'read' to 'others' here because this file is created
2060 // when tombstoned is still running as root, but dumped after dropping. This
2061 // can go away once support for old style dumping has.
2062 const int chmod_ret = fchmod(fd, 0666);
2063 if (chmod_ret < 0) {
2064 MYLOGE("fchmod on %s failed: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002065 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002066 }
2067
2068 std::unique_ptr<DIR, decltype(&closedir)> proc(opendir("/proc"), closedir);
2069 if (proc.get() == nullptr) {
2070 MYLOGE("opendir /proc failed: %s\n", strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002071 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002072 }
2073
2074 // Number of times process dumping has timed out. If we encounter too many
2075 // failures, we'll give up.
2076 int timeout_failures = 0;
2077 bool dalvik_found = false;
2078
2079 const std::set<int> hal_pids = get_interesting_hal_pids();
2080
2081 struct dirent* d;
2082 while ((d = readdir(proc.get()))) {
Nandana Duttcf419a72019-03-14 10:40:17 +00002083 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttfaafd522019-03-11 09:23:09 +00002084 int pid = atoi(d->d_name);
2085 if (pid <= 0) {
2086 continue;
2087 }
2088
2089 const std::string link_name = android::base::StringPrintf("/proc/%d/exe", pid);
2090 std::string exe;
2091 if (!android::base::Readlink(link_name, &exe)) {
2092 continue;
2093 }
2094
2095 bool is_java_process;
2096 if (exe == "/system/bin/app_process32" || exe == "/system/bin/app_process64") {
2097 // Don't bother dumping backtraces for the zygote.
2098 if (IsZygote(pid)) {
2099 continue;
2100 }
2101
2102 dalvik_found = true;
2103 is_java_process = true;
2104 } else if (should_dump_native_traces(exe.c_str()) || hal_pids.find(pid) != hal_pids.end()) {
2105 is_java_process = false;
2106 } else {
2107 // Probably a native process we don't care about, continue.
2108 continue;
2109 }
2110
2111 // If 3 backtrace dumps fail in a row, consider debuggerd dead.
2112 if (timeout_failures == 3) {
2113 dprintf(fd, "ERROR: Too many stack dump failures, exiting.\n");
2114 break;
2115 }
2116
2117 const uint64_t start = Nanotime();
2118 const int ret = dump_backtrace_to_file_timeout(
2119 pid, is_java_process ? kDebuggerdJavaBacktrace : kDebuggerdNativeBacktrace,
2120 is_java_process ? 5 : 20, fd);
2121
2122 if (ret == -1) {
2123 // For consistency, the header and footer to this message match those
2124 // dumped by debuggerd in the success case.
2125 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
2126 dprintf(fd, "Dump failed, likely due to a timeout.\n");
2127 dprintf(fd, "---- end %d ----", pid);
2128 timeout_failures++;
2129 continue;
2130 }
2131
2132 // We've successfully dumped stack traces, reset the failure count
2133 // and write a summary of the elapsed time to the file and continue with the
2134 // next process.
2135 timeout_failures = 0;
2136
2137 dprintf(fd, "[dump %s stack %d: %.3fs elapsed]\n", is_java_process ? "dalvik" : "native",
2138 pid, (float)(Nanotime() - start) / NANOS_PER_SEC);
2139 }
2140
2141 if (!dalvik_found) {
2142 MYLOGE("Warning: no Dalvik processes found to dump stacks\n");
2143 }
2144
Nandana Duttcf419a72019-03-14 10:40:17 +00002145 *path = file_name_buf.release();
2146 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002147}
2148
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002149void Dumpstate::DumpstateBoard(int out_fd) {
2150 dprintf(out_fd, "========================================================\n");
2151 dprintf(out_fd, "== Board\n");
2152 dprintf(out_fd, "========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08002153
Felipe Leme6f674ae2016-11-18 17:10:33 -08002154 if (!IsZipping()) {
Steven Moreland7440ddb2016-12-15 16:13:39 -08002155 MYLOGD("Not dumping board info because it's not a zipped bugreport\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08002156 return;
2157 }
2158
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002159 std::vector<std::string> paths;
2160 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07002161 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002162 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
2163 kDumpstateBoardFiles[i].c_str()));
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002164 remover.emplace_back(android::base::make_scope_guard(
2165 std::bind([](std::string path) { android::os::UnlinkAndLogOnError(path); }, paths[i])));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002166 }
Jie Song9fbfad02017-06-20 16:29:42 -07002167
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002168 sp<IDumpstateDevice_1_0> dumpstate_device_1_0(IDumpstateDevice_1_0::getService());
2169 if (dumpstate_device_1_0 == nullptr) {
Wei Wang587eac92018-04-05 12:17:20 -07002170 MYLOGE("No IDumpstateDevice implementation\n");
2171 return;
2172 }
2173
2174 using ScopedNativeHandle =
2175 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
2176 ScopedNativeHandle handle(native_handle_create(static_cast<int>(paths.size()), 0),
2177 [](native_handle_t* handle) {
2178 native_handle_close(handle);
2179 native_handle_delete(handle);
2180 });
2181 if (handle == nullptr) {
2182 MYLOGE("Could not create native_handle\n");
2183 return;
2184 }
2185
Nandana Dutt5c390032019-03-12 10:52:56 +00002186 // TODO(128270426): Check for consent in between?
Wei Wang587eac92018-04-05 12:17:20 -07002187 for (size_t i = 0; i < paths.size(); i++) {
2188 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
2189
2190 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
2191 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
2192 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
2193 if (fd < 0) {
2194 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
2195 return;
2196 }
2197 handle.get()->data[i] = fd.release();
2198 }
2199
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002200 // Given that bugreport is required to diagnose failures, it's better to set an arbitrary amount
2201 // of timeout for IDumpstateDevice than to block the rest of bugreport. In the timeout case, we
2202 // will kill the HAL and grab whatever it dumped in time.
2203 constexpr size_t timeout_sec = 30;
2204 // Prefer version 1.1 if available. New devices launching with R are no longer allowed to
2205 // implement just 1.0.
2206 const char* descriptor_to_kill;
2207 using DumpstateBoardTask = std::packaged_task<bool()>;
2208 DumpstateBoardTask dumpstate_board_task;
2209 sp<IDumpstateDevice_1_1> dumpstate_device_1_1(
2210 IDumpstateDevice_1_1::castFrom(dumpstate_device_1_0));
2211 if (dumpstate_device_1_1 != nullptr) {
2212 MYLOGI("Using IDumpstateDevice v1.1");
2213 descriptor_to_kill = IDumpstateDevice_1_1::descriptor;
2214 dumpstate_board_task = DumpstateBoardTask([this, dumpstate_device_1_1, &handle]() -> bool {
2215 ::android::hardware::Return<DumpstateStatus> status =
2216 dumpstate_device_1_1->dumpstateBoard_1_1(handle.get(), options_->dumpstate_hal_mode,
2217 SEC_TO_MSEC(timeout_sec));
2218 if (!status.isOk()) {
2219 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2220 return false;
2221 } else if (status != DumpstateStatus::OK) {
2222 MYLOGE("dumpstateBoard failed with DumpstateStatus::%s\n", toString(status).c_str());
2223 return false;
2224 }
2225 return true;
2226 });
2227 } else {
2228 MYLOGI("Using IDumpstateDevice v1.0");
2229 descriptor_to_kill = IDumpstateDevice_1_0::descriptor;
2230 dumpstate_board_task = DumpstateBoardTask([dumpstate_device_1_0, &handle]() -> bool {
2231 ::android::hardware::Return<void> status =
2232 dumpstate_device_1_0->dumpstateBoard(handle.get());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002233 if (!status.isOk()) {
2234 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
Wei Wang587eac92018-04-05 12:17:20 -07002235 return false;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002236 }
Wei Wang587eac92018-04-05 12:17:20 -07002237 return true;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002238 });
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002239 }
2240 auto result = dumpstate_board_task.get_future();
2241 std::thread(std::move(dumpstate_board_task)).detach();
Wei Wang587eac92018-04-05 12:17:20 -07002242
Wei Wang587eac92018-04-05 12:17:20 -07002243 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2244 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate vendor HAL\n", timeout_sec);
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002245 if (!android::base::SetProperty(
2246 "ctl.interface_restart",
2247 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
Wei Wang587eac92018-04-05 12:17:20 -07002248 MYLOGE("Couldn't restart dumpstate HAL\n");
2249 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002250 }
Wei Wang587eac92018-04-05 12:17:20 -07002251 // Wait some time for init to kill dumpstate vendor HAL
2252 constexpr size_t killing_timeout_sec = 10;
2253 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2254 MYLOGE("killing dumpstateBoard timed out after %zus, continue and "
2255 "there might be racing in content\n", killing_timeout_sec);
2256 }
2257
2258 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
2259 for (size_t i = 0; i < paths.size(); i++) {
2260 struct stat s;
2261 if (fstat(handle.get()->data[i], &s) == -1) {
2262 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(),
2263 strerror(errno));
2264 file_sizes[i] = -1;
2265 continue;
2266 }
2267 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002268 }
2269
2270 for (size_t i = 0; i < paths.size(); i++) {
2271 if (file_sizes[i] == -1) {
2272 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002273 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002274 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07002275 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002276 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002277 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002278 remover[i].Disable();
2279 EnqueueAddZipEntryAndCleanupIfNeeded(kDumpstateBoardFiles[i], paths[i]);
2280 dprintf(out_fd, "*** See %s entry ***\n", kDumpstateBoardFiles[i].c_str());
Jie Song9fbfad02017-06-20 16:29:42 -07002281 }
Felipe Leme6f674ae2016-11-18 17:10:33 -08002282}
2283
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002284static void ShowUsage() {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002285 fprintf(stderr,
mhasank2d75c442020-06-11 15:05:25 -07002286 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-o directory] [-d] [-p] "
mhasankd451a472020-05-26 18:02:39 -07002287 "[-z] [-s] [-S] [-q] [-P] [-R] [-L] [-V version]\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002288 " -h: display this help message\n"
2289 " -b: play sound file instead of vibrate, at beginning of job\n"
2290 " -e: play sound file instead of vibrate, at end of job\n"
mhasank2d75c442020-06-11 15:05:25 -07002291 " -o: write to custom directory (only in limited mode)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01002292 " -d: append date to filename\n"
2293 " -p: capture screenshot to filename.png\n"
2294 " -z: generate zipped file\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002295 " -s: write output to control socket (for init)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01002296 " -S: write file location to control socket (for init; requires -z)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002297 " -q: disable vibrate\n"
Abhijeet Kaure370d682019-10-01 16:49:30 +01002298 " -P: send broadcast when started and do progress updates\n"
2299 " -R: take bugreport in remote mode (requires -z and -d, shouldn't be used with -P)\n"
Nandana Dutt235864b2019-01-22 12:10:16 +00002300 " -w: start binder service and make it wait for a call to startBugreport\n"
mhasankd451a472020-05-26 18:02:39 -07002301 " -L: output limited information that is safe for submission in feedback reports\n"
Felipe Lemed071c682016-10-20 16:48:00 -07002302 " -v: prints the dumpstate header and exit\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002303}
2304
Wei Liuf87959e2016-08-26 14:51:42 -07002305static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07002306 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07002307}
2308
Felipe Leme1d486fe2016-10-14 18:06:47 -07002309bool Dumpstate::FinishZipFile() {
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002310 // Runs all enqueued adding zip entry and cleanup tasks before finishing the zip file.
2311 if (zip_entry_tasks_) {
2312 zip_entry_tasks_->run(/* do_cancel = */false);
2313 }
2314
Felipe Leme9a523ae2016-10-20 15:10:33 -07002315 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07002316 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07002317 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002318 // Final timestamp
2319 char date[80];
2320 time_t the_real_now_please_stand_up = time(nullptr);
2321 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002322 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07002323 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002324
Felipe Leme9a523ae2016-10-20 15:10:33 -07002325 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002326 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08002327 return false;
2328 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07002329 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002330 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08002331 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08002332 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08002333
Felipe Leme0f3fb202016-06-10 17:10:53 -07002334 // Add log file (which contains stderr output) to zip...
2335 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07002336 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07002337 MYLOGE("Failed to add dumpstate log to .zip file\n");
2338 return false;
2339 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002340 // TODO: Should truncate the existing file.
2341 // ... and re-open it for further logging.
Nandana Dutta344cb62019-02-22 15:12:35 +00002342 if (!redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()))) {
2343 return false;
2344 }
Felipe Leme0f3fb202016-06-10 17:10:53 -07002345 fprintf(stderr, "\n");
2346
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002347 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07002348 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002349 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002350 return false;
2351 }
2352
Felipe Leme1d486fe2016-10-14 18:06:47 -07002353 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
2354 ds.zip_file.reset(nullptr);
2355
Felipe Lemee9d2c542016-11-15 11:48:26 -08002356 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002357 android::os::UnlinkAndLogOnError(tmp_path_);
Felipe Lemec4eee562016-04-21 15:42:55 -07002358
Felipe Leme1e9edc62015-12-21 16:02:13 -08002359 return true;
2360}
Felipe Leme6e01fa62015-11-11 19:35:14 -08002361
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002362static void SendBroadcast(const std::string& action, const std::vector<std::string>& args) {
2363 // clang-format off
2364 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user", "0",
2365 "--receiver-foreground", "--receiver-include-background", "-a", action};
2366 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08002367
2368 am.insert(am.end(), args.begin(), args.end());
2369
Felipe Leme8d2410e2017-02-08 09:46:08 -08002370 RunCommand("", am,
2371 CommandOptions::WithTimeout(20)
2372 .Log("Sending broadcast: '%s'\n")
2373 .Always()
2374 .DropRoot()
2375 .RedirectStderr()
2376 .Build());
2377}
2378
Felipe Leme35b8cf12017-02-10 15:47:29 -08002379static void Vibrate(int duration_ms) {
2380 // clang-format off
Chris Fries0c3de872019-09-14 15:49:41 +00002381 RunCommand("", {"cmd", "vibrator", "vibrate", "-f", std::to_string(duration_ms), "dumpstate"},
Felipe Leme35b8cf12017-02-10 15:47:29 -08002382 CommandOptions::WithTimeout(10)
2383 .Log("Vibrate: '%s'\n")
2384 .Always()
2385 .Build());
2386 // clang-format on
2387}
2388
Nandana Dutt979388e2018-11-30 16:48:55 +00002389static void MaybeResolveSymlink(std::string* path) {
2390 std::string resolved_path;
2391 if (android::base::Readlink(*path, &resolved_path)) {
2392 *path = resolved_path;
2393 }
2394}
2395
Nandana Dutt4be45d12018-09-26 15:04:23 +01002396/*
2397 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
2398 * if we are writing zip files and adds the version file.
2399 */
2400static void PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002401 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
2402
Nandana Dutt4be45d12018-09-26 15:04:23 +01002403 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
2404 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002405 ds.base_name_ = StringPrintf("bugreport-%s-%s", device_name.c_str(), build_id.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002406 if (ds.options_->do_add_date) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002407 char date[80];
2408 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
2409 ds.name_ = date;
2410 } else {
2411 ds.name_ = "undated";
2412 }
2413
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002414 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002415 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002416 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002417 ds.base_name_ += "-wifi";
2418 }
2419
Paul Chang0d2aad72020-02-13 20:04:03 +08002420 if (ds.options_->do_screenshot) {
Nandana Dutt9d17b942020-03-26 10:02:59 +00002421 ds.screenshot_path_ = ds.GetPath(ds.CalledByApi() ? "-png.tmp" : ".png");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002422 }
2423 ds.tmp_path_ = ds.GetPath(".tmp");
2424 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
2425
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002426 std::string destination = ds.CalledByApi()
Nandana Dutt54dbd672019-01-11 12:58:05 +00002427 ? StringPrintf("[fd:%d]", ds.options_->bugreport_fd.get())
Nandana Dutt9a76d202019-01-21 15:56:48 +00002428 : ds.bugreport_internal_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01002429 MYLOGD(
Nandana Dutt235c6672019-11-14 15:22:32 +00002430 "Bugreport dir: [%s] "
2431 "Base name: [%s] "
2432 "Suffix: [%s] "
2433 "Log path: [%s] "
2434 "Temporary path: [%s] "
2435 "Screenshot path: [%s]\n",
Nandana Dutt9a76d202019-01-21 15:56:48 +00002436 destination.c_str(), ds.base_name_.c_str(), ds.name_.c_str(), ds.log_path_.c_str(),
2437 ds.tmp_path_.c_str(), ds.screenshot_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002438
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002439 if (ds.options_->do_zip_file) {
Nandana Dutt9d17b942020-03-26 10:02:59 +00002440 ds.path_ = ds.GetPath(ds.CalledByApi() ? "-zip.tmp" : ".zip");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002441 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
2442 create_parent_dirs(ds.path_.c_str());
2443 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
2444 if (ds.zip_file == nullptr) {
2445 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
2446 } else {
2447 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
2448 }
2449 ds.AddTextZipEntry("version.txt", ds.version_);
2450 }
2451}
2452
2453/*
Abhijeet Kaure370d682019-10-01 16:49:30 +01002454 * Finalizes writing to the file by zipping the tmp file to the final location,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002455 * printing zipped file status, etc.
2456 */
2457static void FinalizeFile() {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002458 bool do_text_file = true;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002459 if (ds.options_->do_zip_file) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002460 if (!ds.FinishZipFile()) {
2461 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
2462 do_text_file = true;
2463 } else {
2464 do_text_file = false;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002465 }
2466 }
mhasank2d75c442020-06-11 15:05:25 -07002467
2468 std::string final_path = ds.path_;
2469 if (ds.options_->OutputToCustomFile()) {
mhasank3a4cfb42020-06-15 18:06:43 -07002470 final_path = ds.GetPath(ds.options_->out_dir, ".zip");
mhasank2d75c442020-06-11 15:05:25 -07002471 android::os::CopyFileToFile(ds.path_, final_path);
2472 }
2473
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002474 if (ds.options_->use_control_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002475 if (do_text_file) {
2476 dprintf(ds.control_socket_fd_,
2477 "FAIL:could not create zip file, check %s "
2478 "for more details\n",
2479 ds.log_path_.c_str());
2480 } else {
mhasank2d75c442020-06-11 15:05:25 -07002481 dprintf(ds.control_socket_fd_, "OK:%s\n", final_path.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002482 }
2483 }
2484}
2485
Nandana Dutt4be45d12018-09-26 15:04:23 +01002486
Nandana Dutt58d72e22018-11-16 10:30:48 +00002487static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2488 switch (mode) {
2489 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2490 return "BUGREPORT_FULL";
2491 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2492 return "BUGREPORT_INTERACTIVE";
2493 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2494 return "BUGREPORT_REMOTE";
2495 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2496 return "BUGREPORT_WEAR";
2497 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2498 return "BUGREPORT_TELEPHONY";
2499 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2500 return "BUGREPORT_WIFI";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002501 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2502 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002503 }
2504}
2505
Paul Changf59c2b72020-03-10 02:08:55 +08002506static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options,
2507 bool is_screenshot_requested) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002508 // Modify com.android.shell.BugreportProgressService#isDefaultScreenshotRequired as well for
2509 // default system screenshots.
Abhijeet Kaure370d682019-10-01 16:49:30 +01002510 options->bugreport_mode = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002511 switch (mode) {
2512 case Dumpstate::BugreportMode::BUGREPORT_FULL:
Paul Changf59c2b72020-03-10 02:08:55 +08002513 options->do_screenshot = is_screenshot_requested;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002514 options->dumpstate_hal_mode = DumpstateMode::FULL;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002515 break;
2516 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002517 // Currently, the dumpstate binder is only used by Shell to update progress.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002518 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002519 options->do_screenshot = is_screenshot_requested;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002520 options->dumpstate_hal_mode = DumpstateMode::INTERACTIVE;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002521 break;
2522 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002523 options->do_vibrate = false;
2524 options->is_remote_mode = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002525 options->do_screenshot = false;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002526 options->dumpstate_hal_mode = DumpstateMode::REMOTE;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002527 break;
2528 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002529 options->do_progress_updates = true;
2530 options->do_zip_file = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002531 options->do_screenshot = is_screenshot_requested;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002532 options->dumpstate_hal_mode = DumpstateMode::WEAR;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002533 break;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002534 // TODO(b/148168577) rename TELEPHONY everywhere to CONNECTIVITY.
Nandana Dutt58d72e22018-11-16 10:30:48 +00002535 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002536 options->telephony_only = true;
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002537 options->do_progress_updates = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002538 options->do_screenshot = false;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002539 options->dumpstate_hal_mode = DumpstateMode::CONNECTIVITY;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002540 break;
2541 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002542 options->wifi_only = true;
2543 options->do_zip_file = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002544 options->do_screenshot = false;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002545 options->dumpstate_hal_mode = DumpstateMode::WIFI;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002546 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002547 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2548 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002549 }
2550}
2551
Nandana Dutt58d72e22018-11-16 10:30:48 +00002552static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
Nandana Dutt235c6672019-11-14 15:22:32 +00002553 MYLOGI(
Paul Chang0d2aad72020-02-13 20:04:03 +08002554 "do_zip_file: %d do_vibrate: %d use_socket: %d use_control_socket: %d do_screenshot: %d "
Rhed Jao25f50e02020-08-20 00:10:32 +08002555 "is_remote_mode: %d show_header_only: %d telephony_only: %d "
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002556 "wifi_only: %d do_progress_updates: %d fd: %d bugreport_mode: %s dumpstate_hal_mode: %s "
mhasankd451a472020-05-26 18:02:39 -07002557 "limited_only: %d args: %s\n",
Nandana Dutt235c6672019-11-14 15:22:32 +00002558 options.do_zip_file, options.do_vibrate, options.use_socket, options.use_control_socket,
Paul Chang0d2aad72020-02-13 20:04:03 +08002559 options.do_screenshot, options.is_remote_mode, options.show_header_only,
Rhed Jao25f50e02020-08-20 00:10:32 +08002560 options.telephony_only, options.wifi_only,
mhasankd451a472020-05-26 18:02:39 -07002561 options.do_progress_updates, options.bugreport_fd.get(), options.bugreport_mode.c_str(),
2562 toString(options.dumpstate_hal_mode).c_str(), options.limited_only, options.args.c_str());
Nandana Dutt58d72e22018-11-16 10:30:48 +00002563}
2564
Nandana Dutt54dbd672019-01-11 12:58:05 +00002565void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode,
2566 const android::base::unique_fd& bugreport_fd_in,
Paul Changf59c2b72020-03-10 02:08:55 +08002567 const android::base::unique_fd& screenshot_fd_in,
2568 bool is_screenshot_requested) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002569 // In the new API world, date is always added; output is always a zip file.
2570 // TODO(111441001): remove these options once they are obsolete.
2571 do_add_date = true;
2572 do_zip_file = true;
2573
Nandana Dutt54dbd672019-01-11 12:58:05 +00002574 // Duplicate the fds because the passed in fds don't outlive the binder transaction.
2575 bugreport_fd.reset(dup(bugreport_fd_in.get()));
2576 screenshot_fd.reset(dup(screenshot_fd_in.get()));
Nandana Dutt58d72e22018-11-16 10:30:48 +00002577
Paul Changf59c2b72020-03-10 02:08:55 +08002578 SetOptionsFromMode(bugreport_mode, this, is_screenshot_requested);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002579}
2580
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002581Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
2582 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002583 int c;
mhasankd451a472020-05-26 18:02:39 -07002584 while ((c = getopt(argc, argv, "dho:svqzpLPBRSV:w")) != -1) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002585 switch (c) {
2586 // clang-format off
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002587 case 'd': do_add_date = true; break;
2588 case 'z': do_zip_file = true; break;
mhasank3a4cfb42020-06-15 18:06:43 -07002589 case 'o': out_dir = optarg; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002590 case 's': use_socket = true; break;
2591 case 'S': use_control_socket = true; break;
2592 case 'v': show_header_only = true; break;
2593 case 'q': do_vibrate = false; break;
Paul Chang0d2aad72020-02-13 20:04:03 +08002594 case 'p': do_screenshot = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002595 case 'P': do_progress_updates = true; break;
2596 case 'R': is_remote_mode = true; break;
mhasankd451a472020-05-26 18:02:39 -07002597 case 'L': limited_only = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002598 case 'V': break; // compatibility no-op
Nandana Dutt235864b2019-01-22 12:10:16 +00002599 case 'w':
2600 // This was already processed
2601 break;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002602 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002603 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002604 break;
2605 default:
2606 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002607 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002608 break;
2609 // clang-format on
2610 }
2611 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08002612
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002613 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002614 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002615 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002616 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002617 }
2618 }
2619
2620 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
2621 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002622
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002623 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002624}
2625
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002626bool Dumpstate::DumpOptions::ValidateOptions() const {
Nandana Dutt54dbd672019-01-11 12:58:05 +00002627 if (bugreport_fd.get() != -1 && !do_zip_file) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002628 return false;
2629 }
2630
Abhijeet Kaure370d682019-10-01 16:49:30 +01002631 if ((do_zip_file || do_add_date || do_progress_updates) && !OutputToFile()) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002632 return false;
2633 }
2634
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002635 if (use_control_socket && !do_zip_file) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002636 return false;
2637 }
2638
Abhijeet Kaure370d682019-10-01 16:49:30 +01002639 if (is_remote_mode && (do_progress_updates || !do_zip_file || !do_add_date)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002640 return false;
2641 }
2642 return true;
2643}
2644
Nandana Dutt197661d2018-11-16 16:40:21 +00002645void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
2646 options_ = std::move(options);
2647}
2648
Abhijeet Kaura407fb82020-03-27 12:51:12 +00002649void Dumpstate::Initialize() {
2650 /* gets the sequential id */
2651 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
2652 id_ = ++last_id;
2653 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
2654}
2655
Nandana Duttd2f5f082019-01-18 17:13:52 +00002656Dumpstate::RunStatus Dumpstate::Run(int32_t calling_uid, const std::string& calling_package) {
2657 Dumpstate::RunStatus status = RunInternal(calling_uid, calling_package);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002658 if (listener_ != nullptr) {
2659 switch (status) {
2660 case Dumpstate::RunStatus::OK:
Nandana Duttcc4ead82019-01-23 08:29:23 +00002661 listener_->onFinished();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002662 break;
2663 case Dumpstate::RunStatus::HELP:
2664 break;
2665 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002666 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_INVALID_INPUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002667 break;
2668 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002669 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_RUNTIME_ERROR);
2670 break;
2671 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2672 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_DENIED_CONSENT);
2673 break;
2674 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
2675 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_CONSENT_TIMED_OUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002676 break;
2677 }
2678 }
2679 return status;
2680}
2681
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002682void Dumpstate::Cancel() {
2683 CleanupTmpFiles();
2684 android::os::UnlinkAndLogOnError(log_path_);
2685 for (int i = 0; i < NUM_OF_DUMPS; i++) {
2686 android::os::UnlinkAndLogOnError(ds.bugreport_internal_dir_ + "/" +
2687 kDumpstateBoardFiles[i]);
2688 }
2689 tombstone_data_.clear();
2690 anr_data_.clear();
Rhed Jao0daac912020-08-21 14:48:20 +08002691
2692 // Instead of shutdown the pool, we delete temporary files directly since
2693 // shutdown blocking the call.
2694 if (dump_pool_) {
2695 dump_pool_->deleteTempFiles();
2696 }
2697 if (zip_entry_tasks_) {
2698 zip_entry_tasks_->run(/*do_cancel =*/ true);
2699 }
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002700}
2701
Nandana Dutt979388e2018-11-30 16:48:55 +00002702/*
2703 * Dumps relevant information to a bugreport based on the given options.
2704 *
2705 * The bugreport can be dumped to a file or streamed to a socket.
2706 *
2707 * How dumping to file works:
2708 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
2709 * stderr is redirected a log file.
2710 *
2711 * The temporary bugreport is then populated via printfs, dumping contents of files and
2712 * output of commands to stdout.
2713 *
2714 * If zipping, the temporary bugreport file is added to the zip archive. Else it's renamed to final
2715 * text file.
2716 *
2717 * If zipping, a bunch of other files and dumps also get added to the zip archive. The log file also
2718 * gets added to the archive.
2719 *
mhasank2d75c442020-06-11 15:05:25 -07002720 * Bugreports are first generated in a local directory and later copied to the caller's fd
2721 * or directory if supplied.
Nandana Dutt979388e2018-11-30 16:48:55 +00002722 */
Nandana Duttd2f5f082019-01-18 17:13:52 +00002723Dumpstate::RunStatus Dumpstate::RunInternal(int32_t calling_uid,
2724 const std::string& calling_package) {
Rhed Jao5377d792020-07-16 17:37:39 +08002725 DurationReporter duration_reporter("RUN INTERNAL", /* logcat_only = */true);
Nandana Dutt979388e2018-11-30 16:48:55 +00002726 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00002727 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002728 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002729 return RunStatus::INVALID_INPUT;
2730 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002731 /* set as high priority, and protect from OOM killer */
2732 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002733
Felipe Lemed071c682016-10-20 16:48:00 -07002734 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002735 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002736 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002737 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002738 } else {
2739 /* fallback to kernels <= 2.6.35 */
2740 oom_adj = fopen("/proc/self/oom_adj", "we");
2741 if (oom_adj) {
2742 fputs("-17", oom_adj);
2743 fclose(oom_adj);
2744 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002745 }
2746
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002747 if (version_ == VERSION_DEFAULT) {
2748 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00002749 }
2750
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002751 if (version_ != VERSION_CURRENT && version_ != VERSION_SPLIT_ANR) {
Vishnu Nair64afc022018-02-01 15:29:34 -08002752 MYLOGE("invalid version requested ('%s'); suppported values are: ('%s', '%s', '%s')\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002753 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str(),
Vishnu Nair64afc022018-02-01 15:29:34 -08002754 VERSION_SPLIT_ANR.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002755 return RunStatus::INVALID_INPUT;
Felipe Lemed071c682016-10-20 16:48:00 -07002756 }
2757
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002758 if (options_->show_header_only) {
2759 PrintHeader();
2760 return RunStatus::OK;
Felipe Lemed071c682016-10-20 16:48:00 -07002761 }
2762
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002763 MYLOGD("dumpstate calling_uid = %d ; calling package = %s \n",
2764 calling_uid, calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00002765
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002766 // Redirect output if needed
Nandana Dutt9a76d202019-01-21 15:56:48 +00002767 bool is_redirecting = options_->OutputToFile();
Felipe Leme7447d7c2016-11-03 18:12:22 -07002768
2769 // TODO: temporarily set progress until it's part of the Dumpstate constructor
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002770 std::string stats_path =
Nandana Dutt979388e2018-11-30 16:48:55 +00002771 is_redirecting
2772 ? android::base::StringPrintf("%s/dumpstate-stats.txt", bugreport_internal_dir_.c_str())
2773 : "";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002774 progress_.reset(new Progress(stats_path));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002775
Sahana Raof35ed432019-07-12 10:47:52 +01002776 if (acquire_wake_lock(PARTIAL_WAKE_LOCK, WAKE_LOCK_NAME) < 0) {
2777 MYLOGE("Failed to acquire wake lock: %s\n", strerror(errno));
2778 } else {
2779 // Wake lock will be released automatically on process death
2780 MYLOGD("Wake lock acquired.\n");
2781 }
2782
Felipe Leme6ae5c4f2017-01-10 14:13:22 -08002783 register_sig_handler();
Felipe Lemed071c682016-10-20 16:48:00 -07002784
Felipe Lemef0292972016-11-22 13:57:05 -08002785 if (PropertiesHelper::IsDryRun()) {
Felipe Lemed071c682016-10-20 16:48:00 -07002786 MYLOGI("Running on dry-run mode (to disable it, call 'setprop dumpstate.dry_run false')\n");
2787 }
2788
Nandana Dutt235c6672019-11-14 15:22:32 +00002789 MYLOGI("dumpstate info: id=%d, args='%s', bugreport_mode= %s bugreport format version: %s\n",
2790 id_, options_->args.c_str(), options_->bugreport_mode.c_str(), version_.c_str());
Felipe Leme809d74e2016-02-02 12:57:00 -08002791
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002792 do_early_screenshot_ = options_->do_progress_updates;
Felipe Lemee338bf62015-12-07 14:03:50 -08002793
Christopher Ferrised9354f2014-10-01 17:35:01 -07002794 // If we are going to use a socket, do it as early as possible
2795 // to avoid timeouts from bugreport.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002796 if (options_->use_socket) {
Nandana Dutta344cb62019-02-22 15:12:35 +00002797 if (!redirect_to_socket(stdout, "dumpstate")) {
2798 return ERROR;
2799 }
Christopher Ferrised9354f2014-10-01 17:35:01 -07002800 }
2801
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002802 if (options_->use_control_socket) {
Felipe Leme2628e9e2016-04-12 16:36:51 -07002803 MYLOGD("Opening control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002804 control_socket_fd_ = open_socket("dumpstate");
Nandana Dutta344cb62019-02-22 15:12:35 +00002805 if (control_socket_fd_ == -1) {
2806 return ERROR;
2807 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002808 options_->do_progress_updates = 1;
Felipe Leme2628e9e2016-04-12 16:36:51 -07002809 }
2810
Felipe Leme71bbfc52015-11-23 14:14:51 -08002811 if (is_redirecting) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002812 PrepareToWriteToFile();
Felipe Leme1e9edc62015-12-21 16:02:13 -08002813
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002814 if (options_->do_progress_updates) {
Abhijeet Kaure370d682019-10-01 16:49:30 +01002815 // clang-format off
2816 std::vector<std::string> am_args = {
2817 "--receiver-permission", "android.permission.DUMP",
2818 };
2819 // clang-format on
2820 // Send STARTED broadcast for apps that listen to bugreport generation events
2821 SendBroadcast("com.android.internal.intent.action.BUGREPORT_STARTED", am_args);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002822 if (options_->use_control_socket) {
2823 dprintf(control_socket_fd_, "BEGIN:%s\n", path_.c_str());
Felipe Lemeaabfcae2016-07-29 09:49:04 -07002824 }
Felipe Leme71bbfc52015-11-23 14:14:51 -08002825 }
2826 }
2827
Nick Kralevichf3599b32016-01-25 15:05:16 -08002828 /* read /proc/cmdline before dropping root */
2829 FILE *cmdline = fopen("/proc/cmdline", "re");
2830 if (cmdline) {
2831 fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
2832 fclose(cmdline);
2833 }
2834
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002835 if (options_->do_vibrate) {
Felipe Leme35b8cf12017-02-10 15:47:29 -08002836 Vibrate(150);
John Michelau1f794c42012-09-17 11:20:19 -05002837 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002838
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002839 if (options_->do_zip_file && zip_file != nullptr) {
2840 if (chown(path_.c_str(), AID_SHELL, AID_SHELL)) {
2841 MYLOGE("Unable to change ownership of zip file %s: %s\n", path_.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -07002842 strerror(errno));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002843 }
2844 }
2845
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002846 int dup_stdout_fd;
2847 int dup_stderr_fd;
Felipe Leme71bbfc52015-11-23 14:14:51 -08002848 if (is_redirecting) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002849 // Redirect stderr to log_path_ for debugging.
Vishnu Nair20cf5032018-01-05 13:15:49 -08002850 TEMP_FAILURE_RETRY(dup_stderr_fd = dup(fileno(stderr)));
Nandana Dutta344cb62019-02-22 15:12:35 +00002851 if (!redirect_to_file(stderr, const_cast<char*>(log_path_.c_str()))) {
2852 return ERROR;
2853 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002854 if (chown(log_path_.c_str(), AID_SHELL, AID_SHELL)) {
2855 MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n", log_path_.c_str(),
2856 strerror(errno));
Felipe Leme6fe9db62016-02-12 09:04:16 -08002857 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002858
2859 // Redirect stdout to tmp_path_. This is the main bugreport entry and will be
2860 // moved into zip file later, if zipping.
Vishnu Nair20cf5032018-01-05 13:15:49 -08002861 TEMP_FAILURE_RETRY(dup_stdout_fd = dup(fileno(stdout)));
Nandana Dutt979388e2018-11-30 16:48:55 +00002862 // TODO: why not write to a file instead of stdout to overcome this problem?
Felipe Leme6e01fa62015-11-11 19:35:14 -08002863 /* TODO: rather than generating a text file now and zipping it later,
2864 it would be more efficient to redirect stdout to the zip entry
2865 directly, but the libziparchive doesn't support that option yet. */
Nandana Dutta344cb62019-02-22 15:12:35 +00002866 if (!redirect_to_file(stdout, const_cast<char*>(tmp_path_.c_str()))) {
2867 return ERROR;
2868 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002869 if (chown(tmp_path_.c_str(), AID_SHELL, AID_SHELL)) {
Felipe Leme6fe9db62016-02-12 09:04:16 -08002870 MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002871 tmp_path_.c_str(), strerror(errno));
Felipe Leme6fe9db62016-02-12 09:04:16 -08002872 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002873 }
Felipe Lemed8b94e52016-12-08 10:21:44 -08002874
2875 // Don't buffer stdout
2876 setvbuf(stdout, nullptr, _IONBF, 0);
2877
Rhed Jao5377d792020-07-16 17:37:39 +08002878 // Enable the parallel run if the client requests to output to a file.
2879 EnableParallelRunIfNeeded();
2880 // Using scope guard to make sure the dump pool can be shut down correctly.
2881 auto scope_guard_to_shutdown_pool = android::base::make_scope_guard([=]() {
2882 ShutdownDumpPool();
2883 });
2884
Felipe Leme608385d2016-02-01 10:35:38 -08002885 // NOTE: there should be no stdout output until now, otherwise it would break the header.
2886 // In particular, DurationReport objects should be created passing 'title, NULL', so their
Felipe Lemecbce55d2016-02-08 09:53:18 -08002887 // duration is logged into MYLOG instead.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002888 PrintHeader();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002889
mhasankd451a472020-05-26 18:02:39 -07002890 // TODO(b/158737089) reduce code repetition in if branches
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002891 if (options_->telephony_only) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002892 MaybeTakeEarlyScreenshot();
Paul Changc490e662020-04-11 18:14:09 +08002893 onUiIntensiveBugreportDumpsFinished(calling_uid, calling_package);
Jichao Lie89d9c12019-11-21 19:02:51 -08002894 MaybeCheckUserConsent(calling_uid, calling_package);
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08002895 DumpstateTelephonyOnly(calling_package);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002896 } else if (options_->wifi_only) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002897 MaybeTakeEarlyScreenshot();
Paul Changc490e662020-04-11 18:14:09 +08002898 onUiIntensiveBugreportDumpsFinished(calling_uid, calling_package);
Jichao Lie89d9c12019-11-21 19:02:51 -08002899 MaybeCheckUserConsent(calling_uid, calling_package);
mukesh agrawal253dad42018-01-23 21:59:59 -08002900 DumpstateWifiOnly();
mhasankd451a472020-05-26 18:02:39 -07002901 } else if (options_->limited_only) {
2902 MaybeTakeEarlyScreenshot();
2903 onUiIntensiveBugreportDumpsFinished(calling_uid, calling_package);
2904 MaybeCheckUserConsent(calling_uid, calling_package);
2905 DumpstateLimitedOnly();
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002906 } else {
Paul Chang0d2aad72020-02-13 20:04:03 +08002907 // Invoke critical dumpsys first to preserve system state, before doing anything else.
Jichao Lie89d9c12019-11-21 19:02:51 -08002908 RunDumpsysCritical();
2909
Paul Chang0d2aad72020-02-13 20:04:03 +08002910 // Take screenshot and get consent only after critical dumpsys has finished.
2911 MaybeTakeEarlyScreenshot();
Paul Changc490e662020-04-11 18:14:09 +08002912 onUiIntensiveBugreportDumpsFinished(calling_uid, calling_package);
Jichao Lie89d9c12019-11-21 19:02:51 -08002913 MaybeCheckUserConsent(calling_uid, calling_package);
2914
Nandana Dutt4be45d12018-09-26 15:04:23 +01002915 // Dump state for the default case. This also drops root.
Jichao Lie89d9c12019-11-21 19:02:51 -08002916 RunStatus s = DumpstateDefaultAfterCritical();
Nandana Dutt5c390032019-03-12 10:52:56 +00002917 if (s != RunStatus::OK) {
Nandana Duttaac6f582019-07-26 14:32:47 +01002918 if (s == RunStatus::USER_CONSENT_DENIED) {
Nandana Dutt5c390032019-03-12 10:52:56 +00002919 HandleUserConsentDenied();
2920 }
2921 return s;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002922 }
Zhengyin Qian068ecc72016-08-10 16:48:14 -07002923 }
Felipe Leme71a74ac2016-03-17 15:43:25 -07002924
Felipe Leme55b42a62015-11-10 17:39:08 -08002925 /* close output if needed */
Felipe Leme71bbfc52015-11-23 14:14:51 -08002926 if (is_redirecting) {
Vishnu Nair20cf5032018-01-05 13:15:49 -08002927 TEMP_FAILURE_RETRY(dup2(dup_stdout_fd, fileno(stdout)));
Colin Crossf45fa6b2012-03-26 12:38:26 -07002928 }
2929
Abhijeet Kaure370d682019-10-01 16:49:30 +01002930 // Zip the (now complete) .tmp file within the internal directory.
Nandana Dutt9a76d202019-01-21 15:56:48 +00002931 if (options_->OutputToFile()) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002932 FinalizeFile();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002933 }
2934
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002935 // Share the final file with the caller if the user has consented or Shell is the caller.
Nandana Duttd2f5f082019-01-18 17:13:52 +00002936 Dumpstate::RunStatus status = Dumpstate::RunStatus::OK;
Abhijeet Kaure370d682019-10-01 16:49:30 +01002937 if (CalledByApi()) {
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002938 status = CopyBugreportIfUserConsented(calling_uid);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002939 if (status != Dumpstate::RunStatus::OK &&
2940 status != Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2941 // Do an early return if there were errors. We make an exception for consent
2942 // timing out because it's possible the user got distracted. In this case the
2943 // bugreport is not shared but made available for manual retrieval.
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002944 MYLOGI("User denied consent. Returning\n");
Nandana Duttd2f5f082019-01-18 17:13:52 +00002945 return status;
2946 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002947 if (status == Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2948 MYLOGI(
2949 "Did not receive user consent yet."
2950 " Will not copy the bugreport artifacts to caller.\n");
Abhijeet Kaur57627412019-04-17 16:00:09 +01002951 const String16 incidentcompanion("incidentcompanion");
2952 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
2953 if (ics != nullptr) {
2954 MYLOGD("Canceling user consent request via incidentcompanion service\n");
2955 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
2956 consent_callback_.get());
2957 } else {
2958 MYLOGD("Unable to cancel user consent; incidentcompanion service unavailable\n");
2959 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002960 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00002961 }
2962
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002963 /* vibrate a few but shortly times to let user know it's finished */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002964 if (options_->do_vibrate) {
Takuya Ogawa47f644e2017-12-20 18:09:09 +09002965 for (int i = 0; i < 3; i++) {
2966 Vibrate(75);
2967 usleep((75 + 50) * 1000);
2968 }
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002969 }
2970
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002971 MYLOGD("Final progress: %d/%d (estimated %d)\n", progress_->Get(), progress_->GetMax(),
2972 progress_->GetInitialMax());
2973 progress_->Save();
2974 MYLOGI("done (id %d)\n", id_);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002975
Felipe Leme107a05f2016-03-08 15:11:15 -08002976 if (is_redirecting) {
Vishnu Nair20cf5032018-01-05 13:15:49 -08002977 TEMP_FAILURE_RETRY(dup2(dup_stderr_fd, fileno(stderr)));
Felipe Leme107a05f2016-03-08 15:11:15 -08002978 }
2979
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002980 if (options_->use_control_socket && control_socket_fd_ != -1) {
Felipe Lemee844a9d2016-09-21 15:01:39 -07002981 MYLOGD("Closing control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002982 close(control_socket_fd_);
Felipe Leme2628e9e2016-04-12 16:36:51 -07002983 }
2984
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002985 tombstone_data_.clear();
2986 anr_data_.clear();
Narayan Kamath6b9516c2017-10-27 11:15:51 +01002987
Nandana Duttd2f5f082019-01-18 17:13:52 +00002988 return (consent_callback_ != nullptr &&
2989 consent_callback_->getResult() == UserConsentResult::UNAVAILABLE)
2990 ? USER_CONSENT_TIMED_OUT
2991 : RunStatus::OK;
2992}
2993
Paul Chang0d2aad72020-02-13 20:04:03 +08002994void Dumpstate::MaybeTakeEarlyScreenshot() {
2995 if (!options_->do_screenshot || !do_early_screenshot_) {
2996 return;
2997 }
2998
2999 TakeScreenshot();
3000}
3001
Paul Changc490e662020-04-11 18:14:09 +08003002void Dumpstate::onUiIntensiveBugreportDumpsFinished(int32_t calling_uid,
3003 const std::string& calling_package) {
3004 if (calling_uid == AID_SHELL || !CalledByApi()) {
3005 return;
3006 }
3007 if (listener_ != nullptr) {
3008 // Let listener know ui intensive bugreport dumps are finished, then it can do event
3009 // handling if required.
3010 android::String16 package(calling_package.c_str());
3011 listener_->onUiIntensiveBugreportDumpsFinished(package);
3012 }
3013}
3014
Jichao Lie89d9c12019-11-21 19:02:51 -08003015void Dumpstate::MaybeCheckUserConsent(int32_t calling_uid, const std::string& calling_package) {
3016 if (calling_uid == AID_SHELL || !CalledByApi()) {
3017 // No need to get consent for shell triggered dumpstates, or not through
3018 // bugreporting API (i.e. no fd to copy back).
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003019 return;
3020 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003021 consent_callback_ = new ConsentCallback();
3022 const String16 incidentcompanion("incidentcompanion");
3023 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
Jichao Lie89d9c12019-11-21 19:02:51 -08003024 android::String16 package(calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003025 if (ics != nullptr) {
3026 MYLOGD("Checking user consent via incidentcompanion service\n");
3027 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
Jichao Lie89d9c12019-11-21 19:02:51 -08003028 calling_uid, package, String16(), String16(),
Joe Onorato1c36d752019-03-17 18:26:43 -07003029 0x1 /* FLAG_CONFIRMATION_DIALOG */, consent_callback_.get());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003030 } else {
3031 MYLOGD("Unable to check user consent; incidentcompanion service unavailable\n");
3032 }
3033}
3034
Nandana Dutt5c390032019-03-12 10:52:56 +00003035bool Dumpstate::IsUserConsentDenied() const {
3036 return ds.consent_callback_ != nullptr &&
3037 ds.consent_callback_->getResult() == UserConsentResult::DENIED;
3038}
3039
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01003040bool Dumpstate::CalledByApi() const {
3041 return ds.options_->bugreport_fd.get() != -1 ? true : false;
3042}
3043
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003044void Dumpstate::CleanupTmpFiles() {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003045 android::os::UnlinkAndLogOnError(tmp_path_);
3046 android::os::UnlinkAndLogOnError(screenshot_path_);
3047 android::os::UnlinkAndLogOnError(path_);
3048}
3049
Rhed Jao5377d792020-07-16 17:37:39 +08003050void Dumpstate::EnableParallelRunIfNeeded() {
3051 // The thread pool needs to create temporary files to receive dump results.
3052 // That's why we only enable it when the bugreport client chooses to output
3053 // to a file.
3054 if (!PropertiesHelper::IsParallelRun() || !options_->OutputToFile()) {
3055 return;
3056 }
3057 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003058 zip_entry_tasks_ = std::make_unique<TaskQueue>();
Rhed Jao5377d792020-07-16 17:37:39 +08003059}
3060
3061void Dumpstate::ShutdownDumpPool() {
3062 if (dump_pool_) {
3063 dump_pool_->shutdown();
3064 dump_pool_ = nullptr;
3065 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003066 if (zip_entry_tasks_) {
3067 zip_entry_tasks_->run(/* do_cancel = */true);
3068 zip_entry_tasks_ = nullptr;
3069 }
3070}
3071
3072void Dumpstate::EnqueueAddZipEntryAndCleanupIfNeeded(const std::string& entry_name,
3073 const std::string& entry_path) {
3074 auto func_add_zip_entry_and_cleanup = [=](bool task_cancelled) {
3075 if (!task_cancelled) {
3076 AddZipEntry(entry_name, entry_path);
3077 }
3078 android::os::UnlinkAndLogOnError(entry_path);
3079 };
3080 if (zip_entry_tasks_) {
3081 // Enqueues AddZipEntryAndCleanup function if the parallel run is enabled.
3082 zip_entry_tasks_->add(func_add_zip_entry_and_cleanup, _1);
3083 } else {
3084 // Invokes AddZipEntryAndCleanup immediately
3085 std::invoke(func_add_zip_entry_and_cleanup, /* task_cancelled = */false);
3086 }
Rhed Jao5377d792020-07-16 17:37:39 +08003087}
3088
Nandana Duttd2f5f082019-01-18 17:13:52 +00003089Dumpstate::RunStatus Dumpstate::HandleUserConsentDenied() {
3090 MYLOGD("User denied consent; deleting files and returning\n");
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003091 CleanupTmpFiles();
Nandana Duttd2f5f082019-01-18 17:13:52 +00003092 return USER_CONSENT_DENIED;
3093}
3094
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003095Dumpstate::RunStatus Dumpstate::CopyBugreportIfUserConsented(int32_t calling_uid) {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003096 // If the caller has asked to copy the bugreport over to their directory, we need explicit
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003097 // user consent (unless the caller is Shell).
3098 UserConsentResult consent_result;
3099 if (calling_uid == AID_SHELL) {
3100 consent_result = UserConsentResult::APPROVED;
3101 } else {
3102 consent_result = consent_callback_->getResult();
3103 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003104 if (consent_result == UserConsentResult::UNAVAILABLE) {
3105 // User has not responded yet.
3106 uint64_t elapsed_ms = consent_callback_->getElapsedTimeMs();
Hunter Knepshield70610fa2020-01-03 15:27:33 -08003107 // Telephony is a fast report type, particularly on user builds where information may be
3108 // more aggressively limited. To give the user time to read the consent dialog, increase the
3109 // timeout.
3110 uint64_t timeout_ms = options_->telephony_only ? TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS
3111 : USER_CONSENT_TIMEOUT_MS;
3112 if (elapsed_ms < timeout_ms) {
3113 uint delay_seconds = (timeout_ms - elapsed_ms) / 1000;
Nandana Duttd2f5f082019-01-18 17:13:52 +00003114 MYLOGD("Did not receive user consent yet; going to wait for %d seconds", delay_seconds);
3115 sleep(delay_seconds);
3116 }
3117 consent_result = consent_callback_->getResult();
3118 }
3119 if (consent_result == UserConsentResult::DENIED) {
3120 // User has explicitly denied sharing with the app. To be safe delete the
3121 // internal bugreport & tmp files.
3122 return HandleUserConsentDenied();
3123 }
3124 if (consent_result == UserConsentResult::APPROVED) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00003125 bool copy_succeeded = android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
3126 if (copy_succeeded) {
3127 android::os::UnlinkAndLogOnError(path_);
Abhijeet Kaur9ce94672020-04-01 17:22:36 +01003128 if (options_->do_screenshot &&
3129 options_->screenshot_fd.get() != -1 &&
3130 !options_->is_screenshot_copied) {
3131 copy_succeeded = android::os::CopyFileToFd(screenshot_path_,
3132 options_->screenshot_fd.get());
3133 options_->is_screenshot_copied = copy_succeeded;
3134 if (copy_succeeded) {
3135 android::os::UnlinkAndLogOnError(screenshot_path_);
3136 }
3137 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003138 }
3139 return copy_succeeded ? Dumpstate::RunStatus::OK : Dumpstate::RunStatus::ERROR;
3140 } else if (consent_result == UserConsentResult::UNAVAILABLE) {
3141 // consent_result is still UNAVAILABLE. The user has likely not responded yet.
3142 // Since we do not have user consent to share the bugreport it does not get
3143 // copied over to the calling app but remains in the internal directory from
3144 // where the user can manually pull it.
3145 return Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT;
3146 }
3147 // Unknown result; must be a programming error.
3148 MYLOGE("Unknown user consent result:%d\n", consent_result);
3149 return Dumpstate::RunStatus::ERROR;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003150}
3151
Nandana Duttf02564e2019-02-15 15:24:24 +00003152Dumpstate::RunStatus Dumpstate::ParseCommandlineAndRun(int argc, char* argv[]) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003153 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
3154 Dumpstate::RunStatus status = options->Initialize(argc, argv);
3155 if (status == Dumpstate::RunStatus::OK) {
Nandana Duttf02564e2019-02-15 15:24:24 +00003156 SetOptions(std::move(options));
Nandana Duttd2f5f082019-01-18 17:13:52 +00003157 // When directly running dumpstate binary, the output is not expected to be written
3158 // to any external file descriptor.
Nandana Duttf02564e2019-02-15 15:24:24 +00003159 assert(options_->bugreport_fd.get() == -1);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003160
3161 // calling_uid and calling_package are for user consent to share the bugreport with
Abhijeet Kaura407fb82020-03-27 12:51:12 +00003162 // an app; they are irrelevant here because bugreport is triggered via command line.
3163 // Update Last ID before calling Run().
3164 Initialize();
Nandana Duttf02564e2019-02-15 15:24:24 +00003165 status = Run(-1 /* calling_uid */, "" /* calling_package */);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003166 }
Nandana Duttf02564e2019-02-15 15:24:24 +00003167 return status;
3168}
3169
3170/* Main entry point for dumpstate binary. */
3171int run_main(int argc, char* argv[]) {
3172 Dumpstate::RunStatus status = ds.ParseCommandlineAndRun(argc, argv);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003173
3174 switch (status) {
3175 case Dumpstate::RunStatus::OK:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003176 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003177 case Dumpstate::RunStatus::HELP:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003178 ShowUsage();
3179 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003180 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003181 fprintf(stderr, "Invalid combination of args\n");
3182 ShowUsage();
3183 exit(1);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003184 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00003185 FALLTHROUGH_INTENDED;
3186 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
3187 FALLTHROUGH_INTENDED;
3188 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003189 exit(2);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003190 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003191}
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003192
3193// TODO(111441001): Default DumpOptions to sensible values.
3194Dumpstate::Dumpstate(const std::string& version)
3195 : pid_(getpid()),
3196 options_(new Dumpstate::DumpOptions()),
Nandana Dutt402a8392019-06-14 14:25:13 +01003197 last_reported_percent_progress_(0),
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003198 version_(version),
3199 now_(time(nullptr)) {
3200}
3201
3202Dumpstate& Dumpstate::GetInstance() {
3203 static Dumpstate singleton_(android::base::GetProperty("dumpstate.version", VERSION_CURRENT));
3204 return singleton_;
3205}
3206
Rhed Jao5377d792020-07-16 17:37:39 +08003207DurationReporter::DurationReporter(const std::string& title, bool logcat_only, bool verbose,
3208 int duration_fd) : title_(title), logcat_only_(logcat_only), verbose_(verbose),
3209 duration_fd_(duration_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003210 if (!title_.empty()) {
3211 started_ = Nanotime();
3212 }
3213}
3214
3215DurationReporter::~DurationReporter() {
3216 if (!title_.empty()) {
3217 float elapsed = (float)(Nanotime() - started_) / NANOS_PER_SEC;
chenqiwuaf8b2d92019-12-12 18:53:51 +08003218 if (elapsed >= .5f || verbose_) {
3219 MYLOGD("Duration of '%s': %.2fs\n", title_.c_str(), elapsed);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003220 }
chenqiwuaf8b2d92019-12-12 18:53:51 +08003221 if (!logcat_only_) {
3222 // Use "Yoda grammar" to make it easier to grep|sort sections.
Rhed Jao5377d792020-07-16 17:37:39 +08003223 dprintf(duration_fd_, "------ %.3fs was the duration of '%s' ------\n",
3224 elapsed, title_.c_str());
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003225 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003226 }
3227}
3228
3229const int32_t Progress::kDefaultMax = 5000;
3230
3231Progress::Progress(const std::string& path) : Progress(Progress::kDefaultMax, 1.1, path) {
3232}
3233
3234Progress::Progress(int32_t initial_max, int32_t progress, float growth_factor)
3235 : Progress(initial_max, growth_factor, "") {
3236 progress_ = progress;
3237}
3238
3239Progress::Progress(int32_t initial_max, float growth_factor, const std::string& path)
3240 : initial_max_(initial_max),
3241 progress_(0),
3242 max_(initial_max),
3243 growth_factor_(growth_factor),
3244 n_runs_(0),
3245 average_max_(0),
3246 path_(path) {
3247 if (!path_.empty()) {
3248 Load();
3249 }
3250}
3251
3252void Progress::Load() {
3253 MYLOGD("Loading stats from %s\n", path_.c_str());
3254 std::string content;
3255 if (!android::base::ReadFileToString(path_, &content)) {
3256 MYLOGI("Could not read stats from %s; using max of %d\n", path_.c_str(), max_);
3257 return;
3258 }
3259 if (content.empty()) {
3260 MYLOGE("No stats (empty file) on %s; using max of %d\n", path_.c_str(), max_);
3261 return;
3262 }
3263 std::vector<std::string> lines = android::base::Split(content, "\n");
3264
3265 if (lines.size() < 1) {
3266 MYLOGE("Invalid stats on file %s: not enough lines (%d). Using max of %d\n", path_.c_str(),
3267 (int)lines.size(), max_);
3268 return;
3269 }
3270 char* ptr;
3271 n_runs_ = strtol(lines[0].c_str(), &ptr, 10);
3272 average_max_ = strtol(ptr, nullptr, 10);
3273 if (n_runs_ <= 0 || average_max_ <= 0 || n_runs_ > STATS_MAX_N_RUNS ||
3274 average_max_ > STATS_MAX_AVERAGE) {
3275 MYLOGE("Invalid stats line on file %s: %s\n", path_.c_str(), lines[0].c_str());
3276 initial_max_ = Progress::kDefaultMax;
3277 } else {
3278 initial_max_ = average_max_;
3279 }
3280 max_ = initial_max_;
3281
3282 MYLOGI("Average max progress: %d in %d runs; estimated max: %d\n", average_max_, n_runs_, max_);
3283}
3284
3285void Progress::Save() {
3286 int32_t total = n_runs_ * average_max_ + progress_;
3287 int32_t runs = n_runs_ + 1;
3288 int32_t average = floor(((float)total) / runs);
3289 MYLOGI("Saving stats (total=%d, runs=%d, average=%d) on %s\n", total, runs, average,
3290 path_.c_str());
3291 if (path_.empty()) {
3292 return;
3293 }
3294
3295 std::string content = android::base::StringPrintf("%d %d\n", runs, average);
3296 if (!android::base::WriteStringToFile(content, path_)) {
3297 MYLOGE("Could not save stats on %s\n", path_.c_str());
3298 }
3299}
3300
3301int32_t Progress::Get() const {
3302 return progress_;
3303}
3304
3305bool Progress::Inc(int32_t delta_sec) {
3306 bool changed = false;
3307 if (delta_sec >= 0) {
3308 progress_ += delta_sec;
3309 if (progress_ > max_) {
3310 int32_t old_max = max_;
3311 max_ = floor((float)progress_ * growth_factor_);
3312 MYLOGD("Adjusting max progress from %d to %d\n", old_max, max_);
3313 changed = true;
3314 }
3315 }
3316 return changed;
3317}
3318
3319int32_t Progress::GetMax() const {
3320 return max_;
3321}
3322
3323int32_t Progress::GetInitialMax() const {
3324 return initial_max_;
3325}
3326
3327void Progress::Dump(int fd, const std::string& prefix) const {
3328 const char* pr = prefix.c_str();
3329 dprintf(fd, "%sprogress: %d\n", pr, progress_);
3330 dprintf(fd, "%smax: %d\n", pr, max_);
3331 dprintf(fd, "%sinitial_max: %d\n", pr, initial_max_);
3332 dprintf(fd, "%sgrowth_factor: %0.2f\n", pr, growth_factor_);
3333 dprintf(fd, "%spath: %s\n", pr, path_.c_str());
3334 dprintf(fd, "%sn_runs: %d\n", pr, n_runs_);
3335 dprintf(fd, "%saverage_max: %d\n", pr, average_max_);
3336}
3337
3338bool Dumpstate::IsZipping() const {
3339 return zip_writer_ != nullptr;
3340}
3341
3342std::string Dumpstate::GetPath(const std::string& suffix) const {
3343 return GetPath(bugreport_internal_dir_, suffix);
3344}
3345
3346std::string Dumpstate::GetPath(const std::string& directory, const std::string& suffix) const {
3347 return android::base::StringPrintf("%s/%s-%s%s", directory.c_str(), base_name_.c_str(),
3348 name_.c_str(), suffix.c_str());
3349}
3350
3351void Dumpstate::SetProgress(std::unique_ptr<Progress> progress) {
3352 progress_ = std::move(progress);
3353}
3354
3355void for_each_userid(void (*func)(int), const char *header) {
3356 std::string title = header == nullptr ? "for_each_userid" : android::base::StringPrintf(
3357 "for_each_userid(%s)", header);
3358 DurationReporter duration_reporter(title);
3359 if (PropertiesHelper::IsDryRun()) return;
3360
3361 DIR *d;
3362 struct dirent *de;
3363
3364 if (header) printf("\n------ %s ------\n", header);
3365 func(0);
3366
3367 if (!(d = opendir("/data/system/users"))) {
3368 printf("Failed to open /data/system/users (%s)\n", strerror(errno));
3369 return;
3370 }
3371
3372 while ((de = readdir(d))) {
3373 int userid;
3374 if (de->d_type != DT_DIR || !(userid = atoi(de->d_name))) {
3375 continue;
3376 }
3377 func(userid);
3378 }
3379
3380 closedir(d);
3381}
3382
3383static void __for_each_pid(void (*helper)(int, const char *, void *), const char *header, void *arg) {
3384 DIR *d;
3385 struct dirent *de;
3386
3387 if (!(d = opendir("/proc"))) {
3388 printf("Failed to open /proc (%s)\n", strerror(errno));
3389 return;
3390 }
3391
3392 if (header) printf("\n------ %s ------\n", header);
3393 while ((de = readdir(d))) {
3394 if (ds.IsUserConsentDenied()) {
3395 MYLOGE(
3396 "Returning early because user denied consent to share bugreport with calling app.");
3397 closedir(d);
3398 return;
3399 }
3400 int pid;
3401 int fd;
3402 char cmdpath[255];
3403 char cmdline[255];
3404
3405 if (!(pid = atoi(de->d_name))) {
3406 continue;
3407 }
3408
3409 memset(cmdline, 0, sizeof(cmdline));
3410
3411 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/cmdline", pid);
3412 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3413 TEMP_FAILURE_RETRY(read(fd, cmdline, sizeof(cmdline) - 2));
3414 close(fd);
3415 if (cmdline[0]) {
3416 helper(pid, cmdline, arg);
3417 continue;
3418 }
3419 }
3420
3421 // if no cmdline, a kernel thread has comm
3422 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/comm", pid);
3423 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3424 TEMP_FAILURE_RETRY(read(fd, cmdline + 1, sizeof(cmdline) - 4));
3425 close(fd);
3426 if (cmdline[1]) {
3427 cmdline[0] = '[';
3428 size_t len = strcspn(cmdline, "\f\b\r\n");
3429 cmdline[len] = ']';
3430 cmdline[len+1] = '\0';
3431 }
3432 }
3433 if (!cmdline[0]) {
3434 strcpy(cmdline, "N/A");
3435 }
3436 helper(pid, cmdline, arg);
3437 }
3438
3439 closedir(d);
3440}
3441
3442static void for_each_pid_helper(int pid, const char *cmdline, void *arg) {
3443 for_each_pid_func *func = (for_each_pid_func*) arg;
3444 func(pid, cmdline);
3445}
3446
3447void for_each_pid(for_each_pid_func func, const char *header) {
3448 std::string title = header == nullptr ? "for_each_pid"
3449 : android::base::StringPrintf("for_each_pid(%s)", header);
3450 DurationReporter duration_reporter(title);
3451 if (PropertiesHelper::IsDryRun()) return;
3452
3453 __for_each_pid(for_each_pid_helper, header, (void *) func);
3454}
3455
3456static void for_each_tid_helper(int pid, const char *cmdline, void *arg) {
3457 DIR *d;
3458 struct dirent *de;
3459 char taskpath[255];
3460 for_each_tid_func *func = (for_each_tid_func *) arg;
3461
3462 snprintf(taskpath, sizeof(taskpath), "/proc/%d/task", pid);
3463
3464 if (!(d = opendir(taskpath))) {
3465 printf("Failed to open %s (%s)\n", taskpath, strerror(errno));
3466 return;
3467 }
3468
3469 func(pid, pid, cmdline);
3470
3471 while ((de = readdir(d))) {
3472 if (ds.IsUserConsentDenied()) {
3473 MYLOGE(
3474 "Returning early because user denied consent to share bugreport with calling app.");
3475 closedir(d);
3476 return;
3477 }
3478 int tid;
3479 int fd;
3480 char commpath[255];
3481 char comm[255];
3482
3483 if (!(tid = atoi(de->d_name))) {
3484 continue;
3485 }
3486
3487 if (tid == pid)
3488 continue;
3489
3490 snprintf(commpath, sizeof(commpath), "/proc/%d/comm", tid);
3491 memset(comm, 0, sizeof(comm));
3492 if ((fd = TEMP_FAILURE_RETRY(open(commpath, O_RDONLY | O_CLOEXEC))) < 0) {
3493 strcpy(comm, "N/A");
3494 } else {
3495 char *c;
3496 TEMP_FAILURE_RETRY(read(fd, comm, sizeof(comm) - 2));
3497 close(fd);
3498
3499 c = strrchr(comm, '\n');
3500 if (c) {
3501 *c = '\0';
3502 }
3503 }
3504 func(pid, tid, comm);
3505 }
3506
3507 closedir(d);
3508}
3509
3510void for_each_tid(for_each_tid_func func, const char *header) {
3511 std::string title = header == nullptr ? "for_each_tid"
3512 : android::base::StringPrintf("for_each_tid(%s)", header);
3513 DurationReporter duration_reporter(title);
3514
3515 if (PropertiesHelper::IsDryRun()) return;
3516
3517 __for_each_pid(for_each_tid_helper, header, (void *) func);
3518}
3519
3520void show_wchan(int pid, int tid, const char *name) {
3521 if (PropertiesHelper::IsDryRun()) return;
3522
3523 char path[255];
3524 char buffer[255];
3525 int fd, ret, save_errno;
3526 char name_buffer[255];
3527
3528 memset(buffer, 0, sizeof(buffer));
3529
3530 snprintf(path, sizeof(path), "/proc/%d/wchan", tid);
3531 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3532 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3533 return;
3534 }
3535
3536 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3537 save_errno = errno;
3538 close(fd);
3539
3540 if (ret < 0) {
3541 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3542 return;
3543 }
3544
3545 snprintf(name_buffer, sizeof(name_buffer), "%*s%s",
3546 pid == tid ? 0 : 3, "", name);
3547
3548 printf("%-7d %-32s %s\n", tid, name_buffer, buffer);
3549
3550 return;
3551}
3552
3553// print time in centiseconds
3554static void snprcent(char *buffer, size_t len, size_t spc,
3555 unsigned long long time) {
3556 static long hz; // cache discovered hz
3557
3558 if (hz <= 0) {
3559 hz = sysconf(_SC_CLK_TCK);
3560 if (hz <= 0) {
3561 hz = 1000;
3562 }
3563 }
3564
3565 // convert to centiseconds
3566 time = (time * 100 + (hz / 2)) / hz;
3567
3568 char str[16];
3569
3570 snprintf(str, sizeof(str), " %llu.%02u",
3571 time / 100, (unsigned)(time % 100));
3572 size_t offset = strlen(buffer);
3573 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3574 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3575}
3576
3577// print permille as a percent
3578static void snprdec(char *buffer, size_t len, size_t spc, unsigned permille) {
3579 char str[16];
3580
3581 snprintf(str, sizeof(str), " %u.%u%%", permille / 10, permille % 10);
3582 size_t offset = strlen(buffer);
3583 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3584 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3585}
3586
3587void show_showtime(int pid, const char *name) {
3588 if (PropertiesHelper::IsDryRun()) return;
3589
3590 char path[255];
3591 char buffer[1023];
3592 int fd, ret, save_errno;
3593
3594 memset(buffer, 0, sizeof(buffer));
3595
3596 snprintf(path, sizeof(path), "/proc/%d/stat", pid);
3597 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3598 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3599 return;
3600 }
3601
3602 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3603 save_errno = errno;
3604 close(fd);
3605
3606 if (ret < 0) {
3607 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3608 return;
3609 }
3610
3611 // field 14 is utime
3612 // field 15 is stime
3613 // field 42 is iotime
3614 unsigned long long utime = 0, stime = 0, iotime = 0;
3615 if (sscanf(buffer,
3616 "%*u %*s %*s %*d %*d %*d %*d %*d %*d %*d %*d "
3617 "%*d %*d %llu %llu %*d %*d %*d %*d %*d %*d "
3618 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %*d "
3619 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %llu ",
3620 &utime, &stime, &iotime) != 3) {
3621 return;
3622 }
3623
3624 unsigned long long total = utime + stime;
3625 if (!total) {
3626 return;
3627 }
3628
3629 unsigned permille = (iotime * 1000 + (total / 2)) / total;
3630 if (permille > 1000) {
3631 permille = 1000;
3632 }
3633
3634 // try to beautify and stabilize columns at <80 characters
3635 snprintf(buffer, sizeof(buffer), "%-6d%s", pid, name);
3636 if ((name[0] != '[') || utime) {
3637 snprcent(buffer, sizeof(buffer), 57, utime);
3638 }
3639 snprcent(buffer, sizeof(buffer), 65, stime);
3640 if ((name[0] != '[') || iotime) {
3641 snprcent(buffer, sizeof(buffer), 73, iotime);
3642 }
3643 if (iotime) {
3644 snprdec(buffer, sizeof(buffer), 79, permille);
3645 }
3646 puts(buffer); // adds a trailing newline
3647
3648 return;
3649}
3650
3651void do_dmesg() {
3652 const char *title = "KERNEL LOG (dmesg)";
3653 DurationReporter duration_reporter(title);
3654 printf("------ %s ------\n", title);
3655
3656 if (PropertiesHelper::IsDryRun()) return;
3657
3658 /* Get size of kernel buffer */
3659 int size = klogctl(KLOG_SIZE_BUFFER, nullptr, 0);
3660 if (size <= 0) {
3661 printf("Unexpected klogctl return value: %d\n\n", size);
3662 return;
3663 }
3664 char *buf = (char *) malloc(size + 1);
3665 if (buf == nullptr) {
3666 printf("memory allocation failed\n\n");
3667 return;
3668 }
3669 int retval = klogctl(KLOG_READ_ALL, buf, size);
3670 if (retval < 0) {
3671 printf("klogctl failure\n\n");
3672 free(buf);
3673 return;
3674 }
3675 buf[retval] = '\0';
3676 printf("%s\n\n", buf);
3677 free(buf);
3678 return;
3679}
3680
3681void do_showmap(int pid, const char *name) {
3682 char title[255];
3683 char arg[255];
3684
3685 snprintf(title, sizeof(title), "SHOW MAP %d (%s)", pid, name);
3686 snprintf(arg, sizeof(arg), "%d", pid);
3687 RunCommand(title, {"showmap", "-q", arg}, CommandOptions::AS_ROOT);
3688}
3689
3690int Dumpstate::DumpFile(const std::string& title, const std::string& path) {
3691 DurationReporter duration_reporter(title);
3692
3693 int status = DumpFileToFd(STDOUT_FILENO, title, path);
3694
3695 UpdateProgress(WEIGHT_FILE);
3696
3697 return status;
3698}
3699
3700int read_file_as_long(const char *path, long int *output) {
3701 int fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC));
3702 if (fd < 0) {
3703 int err = errno;
3704 MYLOGE("Error opening file descriptor for %s: %s\n", path, strerror(err));
3705 return -1;
3706 }
3707 char buffer[50];
3708 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3709 if (bytes_read == -1) {
3710 MYLOGE("Error reading file %s: %s\n", path, strerror(errno));
3711 return -2;
3712 }
3713 if (bytes_read == 0) {
3714 MYLOGE("File %s is empty\n", path);
3715 return -3;
3716 }
3717 *output = atoi(buffer);
3718 return 0;
3719}
3720
3721/* calls skip to gate calling dump_from_fd recursively
3722 * in the specified directory. dump_from_fd defaults to
3723 * dump_file_from_fd above when set to NULL. skip defaults
3724 * to false when set to NULL. dump_from_fd will always be
3725 * called with title NULL.
3726 */
3727int dump_files(const std::string& title, const char* dir, bool (*skip)(const char* path),
3728 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
3729 DurationReporter duration_reporter(title);
3730 DIR *dirp;
3731 struct dirent *d;
3732 char *newpath = nullptr;
3733 const char *slash = "/";
3734 int retval = 0;
3735
3736 if (!title.empty()) {
3737 printf("------ %s (%s) ------\n", title.c_str(), dir);
3738 }
3739 if (PropertiesHelper::IsDryRun()) return 0;
3740
3741 if (dir[strlen(dir) - 1] == '/') {
3742 ++slash;
3743 }
3744 dirp = opendir(dir);
3745 if (dirp == nullptr) {
3746 retval = -errno;
3747 MYLOGE("%s: %s\n", dir, strerror(errno));
3748 return retval;
3749 }
3750
3751 if (!dump_from_fd) {
3752 dump_from_fd = dump_file_from_fd;
3753 }
3754 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
3755 if ((d->d_name[0] == '.')
3756 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
3757 || (d->d_name[1] == '\0'))) {
3758 continue;
3759 }
3760 asprintf(&newpath, "%s%s%s%s", dir, slash, d->d_name,
3761 (d->d_type == DT_DIR) ? "/" : "");
3762 if (!newpath) {
3763 retval = -errno;
3764 continue;
3765 }
3766 if (skip && (*skip)(newpath)) {
3767 continue;
3768 }
3769 if (d->d_type == DT_DIR) {
3770 int ret = dump_files("", newpath, skip, dump_from_fd);
3771 if (ret < 0) {
3772 retval = ret;
3773 }
3774 continue;
3775 }
3776 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(newpath, O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
3777 if (fd.get() < 0) {
3778 retval = -1;
3779 printf("*** %s: %s\n", newpath, strerror(errno));
3780 continue;
3781 }
3782 (*dump_from_fd)(nullptr, newpath, fd.get());
3783 }
3784 closedir(dirp);
3785 if (!title.empty()) {
3786 printf("\n");
3787 }
3788 return retval;
3789}
3790
3791/* fd must have been opened with the flag O_NONBLOCK. With this flag set,
3792 * it's possible to avoid issues where opening the file itself can get
3793 * stuck.
3794 */
3795int dump_file_from_fd(const char *title, const char *path, int fd) {
3796 if (PropertiesHelper::IsDryRun()) return 0;
3797
3798 int flags = fcntl(fd, F_GETFL);
3799 if (flags == -1) {
3800 printf("*** %s: failed to get flags on fd %d: %s\n", path, fd, strerror(errno));
3801 return -1;
3802 } else if (!(flags & O_NONBLOCK)) {
3803 printf("*** %s: fd must have O_NONBLOCK set.\n", path);
3804 return -1;
3805 }
3806 return DumpFileFromFdToFd(title, path, fd, STDOUT_FILENO, PropertiesHelper::IsDryRun());
3807}
3808
3809int Dumpstate::RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003810 const CommandOptions& options, bool verbose_duration, int out_fd) {
3811 DurationReporter duration_reporter(title, false /* logcat_only */,
3812 verbose_duration, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003813
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003814 int status = RunCommandToFd(out_fd, title, full_command, options);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003815
3816 /* TODO: for now we're simplifying the progress calculation by using the
3817 * timeout as the weight. It's a good approximation for most cases, except when calling dumpsys,
3818 * where its weight should be much higher proportionally to its timeout.
3819 * Ideally, it should use a options.EstimatedDuration() instead...*/
3820 UpdateProgress(options.Timeout());
3821
3822 return status;
3823}
3824
3825void Dumpstate::RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsys_args,
Rhed Jaoe017f982020-07-21 17:58:41 +08003826 const CommandOptions& options, long dumpsysTimeoutMs, int out_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003827 long timeout_ms = dumpsysTimeoutMs > 0 ? dumpsysTimeoutMs : options.TimeoutInMs();
3828 std::vector<std::string> dumpsys = {"/system/bin/dumpsys", "-T", std::to_string(timeout_ms)};
3829 dumpsys.insert(dumpsys.end(), dumpsys_args.begin(), dumpsys_args.end());
Rhed Jaoe017f982020-07-21 17:58:41 +08003830 RunCommand(title, dumpsys, options, false, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003831}
3832
3833int open_socket(const char *service) {
3834 int s = android_get_control_socket(service);
3835 if (s < 0) {
3836 MYLOGE("android_get_control_socket(%s): %s\n", service, strerror(errno));
3837 return -1;
3838 }
3839 fcntl(s, F_SETFD, FD_CLOEXEC);
3840
3841 // Set backlog to 0 to make sure that queue size will be minimum.
3842 // In Linux, because the minimum queue will be 1, connect() will be blocked
3843 // if the other clients already called connect() and the connection request was not accepted.
3844 if (listen(s, 0) < 0) {
3845 MYLOGE("listen(control socket): %s\n", strerror(errno));
3846 return -1;
3847 }
3848
3849 struct sockaddr addr;
3850 socklen_t alen = sizeof(addr);
Abhijeet Kaur2113cae2019-09-13 09:24:15 +01003851 int fd = accept4(s, &addr, &alen, SOCK_CLOEXEC);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003852
3853 // Close socket just after accept(), to make sure that connect() by client will get error
3854 // when the socket is used by the other services.
3855 // There is still a race condition possibility between accept and close, but there is no way
3856 // to close-on-accept atomically.
3857 // See detail; b/123306389#comment25
3858 close(s);
3859
3860 if (fd < 0) {
3861 MYLOGE("accept(control socket): %s\n", strerror(errno));
3862 return -1;
3863 }
3864
3865 return fd;
3866}
3867
3868/* redirect output to a service control socket */
3869bool redirect_to_socket(FILE* redirect, const char* service) {
3870 int fd = open_socket(service);
3871 if (fd == -1) {
3872 return false;
3873 }
3874 fflush(redirect);
3875 // TODO: handle dup2 failure
3876 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
3877 close(fd);
3878 return true;
3879}
3880
3881// TODO: should call is_valid_output_file and/or be merged into it.
3882void create_parent_dirs(const char *path) {
3883 char *chp = const_cast<char *> (path);
3884
3885 /* skip initial slash */
3886 if (chp[0] == '/')
3887 chp++;
3888
3889 /* create leading directories, if necessary */
3890 struct stat dir_stat;
3891 while (chp && chp[0]) {
3892 chp = strchr(chp, '/');
3893 if (chp) {
3894 *chp = 0;
3895 if (stat(path, &dir_stat) == -1 || !S_ISDIR(dir_stat.st_mode)) {
3896 MYLOGI("Creating directory %s\n", path);
3897 if (mkdir(path, 0770)) { /* drwxrwx--- */
3898 MYLOGE("Unable to create directory %s: %s\n", path, strerror(errno));
3899 } else if (chown(path, AID_SHELL, AID_SHELL)) {
3900 MYLOGE("Unable to change ownership of dir %s: %s\n", path, strerror(errno));
3901 }
3902 }
3903 *chp++ = '/';
3904 }
3905 }
3906}
3907
3908bool _redirect_to_file(FILE* redirect, char* path, int truncate_flag) {
3909 create_parent_dirs(path);
3910
3911 int fd = TEMP_FAILURE_RETRY(open(path,
3912 O_WRONLY | O_CREAT | truncate_flag | O_CLOEXEC | O_NOFOLLOW,
3913 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH));
3914 if (fd < 0) {
3915 MYLOGE("%s: %s\n", path, strerror(errno));
3916 return false;
3917 }
3918
3919 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
3920 close(fd);
3921 return true;
3922}
3923
3924bool redirect_to_file(FILE* redirect, char* path) {
3925 return _redirect_to_file(redirect, path, O_TRUNC);
3926}
3927
3928bool redirect_to_existing_file(FILE* redirect, char* path) {
3929 return _redirect_to_file(redirect, path, O_APPEND);
3930}
3931
3932void dump_route_tables() {
3933 DurationReporter duration_reporter("DUMP ROUTE TABLES");
3934 if (PropertiesHelper::IsDryRun()) return;
3935 const char* const RT_TABLES_PATH = "/data/misc/net/rt_tables";
3936 ds.DumpFile("RT_TABLES", RT_TABLES_PATH);
3937 FILE* fp = fopen(RT_TABLES_PATH, "re");
3938 if (!fp) {
3939 printf("*** %s: %s\n", RT_TABLES_PATH, strerror(errno));
3940 return;
3941 }
3942 char table[16];
3943 // Each line has an integer (the table number), a space, and a string (the table name). We only
3944 // need the table number. It's a 32-bit unsigned number, so max 10 chars. Skip the table name.
3945 // Add a fixed max limit so this doesn't go awry.
3946 for (int i = 0; i < 64 && fscanf(fp, " %10s %*s", table) == 1; ++i) {
3947 RunCommand("ROUTE TABLE IPv4", {"ip", "-4", "route", "show", "table", table});
3948 RunCommand("ROUTE TABLE IPv6", {"ip", "-6", "route", "show", "table", table});
3949 }
3950 fclose(fp);
3951}
3952
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003953void Dumpstate::UpdateProgress(int32_t delta_sec) {
3954 if (progress_ == nullptr) {
3955 MYLOGE("UpdateProgress: progress_ not set\n");
3956 return;
3957 }
Rhed Jaobf63d8a2020-07-21 15:42:55 +08003958 // This function updates progress related members of the dumpstate and reports
3959 // progress percentage to the bugreport client. Since it could be called by
3960 // different dump tasks at the same time if the parallel run is enabled, a
3961 // mutex lock is necessary here to synchronize the call.
3962 std::lock_guard<std::recursive_mutex> lock(mutex_);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003963
3964 // Always update progess so stats can be tuned...
Nandana Dutt402a8392019-06-14 14:25:13 +01003965 progress_->Inc(delta_sec);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003966
3967 // ...but only notifiy listeners when necessary.
3968 if (!options_->do_progress_updates) return;
3969
3970 int progress = progress_->Get();
3971 int max = progress_->GetMax();
Nandana Dutt402a8392019-06-14 14:25:13 +01003972 int percent = 100 * progress / max;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003973
Nandana Dutt402a8392019-06-14 14:25:13 +01003974 if (last_reported_percent_progress_ > 0 && percent <= last_reported_percent_progress_) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003975 return;
3976 }
Nandana Dutt402a8392019-06-14 14:25:13 +01003977 last_reported_percent_progress_ = percent;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003978
3979 if (control_socket_fd_ >= 0) {
3980 dprintf(control_socket_fd_, "PROGRESS:%d/%d\n", progress, max);
3981 fsync(control_socket_fd_);
3982 }
3983
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003984 if (listener_ != nullptr) {
Nandana Dutt235c6672019-11-14 15:22:32 +00003985 if (percent % 10 == 0) {
3986 // We don't want to spam logcat, so only log multiples of 10.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01003987 MYLOGD("Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003988 } else {
3989 // stderr is ignored on normal invocations, but useful when calling
3990 // /system/bin/dumpstate directly for debuggging.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01003991 fprintf(stderr, "Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003992 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003993
3994 listener_->onProgress(percent);
3995 }
3996}
3997
3998void Dumpstate::TakeScreenshot(const std::string& path) {
3999 const std::string& real_path = path.empty() ? screenshot_path_ : path;
4000 int status =
4001 RunCommand("", {"/system/bin/screencap", "-p", real_path},
4002 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
4003 if (status == 0) {
4004 MYLOGD("Screenshot saved on %s\n", real_path.c_str());
4005 } else {
4006 MYLOGE("Failed to take screenshot on %s\n", real_path.c_str());
4007 }
Paul Chang0d2aad72020-02-13 20:04:03 +08004008 if (listener_ != nullptr) {
4009 // Show a visual indication to indicate screenshot is taken via
4010 // IDumpstateListener.onScreenshotTaken()
4011 listener_->onScreenshotTaken(status == 0);
4012 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004013}
4014
4015bool is_dir(const char* pathname) {
4016 struct stat info;
4017 if (stat(pathname, &info) == -1) {
4018 return false;
4019 }
4020 return S_ISDIR(info.st_mode);
4021}
4022
4023time_t get_mtime(int fd, time_t default_mtime) {
4024 struct stat info;
4025 if (fstat(fd, &info) == -1) {
4026 return default_mtime;
4027 }
4028 return info.st_mtime;
4029}