blob: cc745708c84271273bc5f0facd3c8de40fbdc056 [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>
Mark Salyzyn8f37aa52015-06-12 12:28:24 -070025#include <stdbool.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070026#include <stdio.h>
27#include <stdlib.h>
28#include <string.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080029#include <sys/poll.h>
Christopher Ferris7dc7f322014-07-22 16:08:19 -070030#include <sys/prctl.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070031#include <sys/resource.h>
32#include <sys/stat.h>
33#include <sys/time.h>
34#include <sys/wait.h>
35#include <unistd.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070036
37#include <chrono>
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +000038#include <fstream>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070039#include <functional>
40#include <future>
Narayan Kamath8f788292017-05-25 13:20:39 +010041#include <memory>
42#include <regex>
43#include <set>
44#include <string>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070045#include <utility>
Narayan Kamath8f788292017-05-25 13:20:39 +010046#include <vector>
Colin Crossf45fa6b2012-03-26 12:38:26 -070047
Felipe Leme96c2bbb2016-09-26 09:21:21 -070048#include <android-base/file.h>
49#include <android-base/properties.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070050#include <android-base/scopeguard.h>
Elliott Hughes9dc117c2015-12-07 14:21:50 -080051#include <android-base/stringprintf.h>
Naveen Kalla058e1e82016-10-19 21:38:44 -070052#include <android-base/strings.h>
Andreas Gampeaff68432016-07-18 18:01:27 -070053#include <android-base/unique_fd.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010054#include <android/content/pm/IPackageManagerNative.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080055#include <android/hardware/dumpstate/1.0/IDumpstateDevice.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080056#include <android/hidl/manager/1.0/IServiceManager.h>
Nandana Duttd2f5f082019-01-18 17:13:52 +000057#include <android/os/IIncidentCompanion.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010058#include <binder/IServiceManager.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080059#include <cutils/native_handle.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070060#include <cutils/properties.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000061#include <debuggerd/client.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080062#include <dumpsys.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000063#include <dumputils/dump_utils.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080064#include <hidl/ServiceManagement.h>
Felipe Leme75876a22016-10-27 16:31:27 -070065#include <openssl/sha.h>
Mark Salyzyn6c3d90f2016-09-27 14:55:27 -070066#include <private/android_filesystem_config.h>
67#include <private/android_logger.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080068#include <serviceutils/PriorityDumper.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070069#include <utils/StrongPointer.h>
Felipe Lemef0292972016-11-22 13:57:05 -080070#include "DumpstateInternal.h"
Vishnu Naire97d6122018-01-18 13:58:56 -080071#include "DumpstateSectionReporter.h"
Felipe Leme75876a22016-10-27 16:31:27 -070072#include "DumpstateService.h"
Colin Crossf45fa6b2012-03-26 12:38:26 -070073#include "dumpstate.h"
Felipe Leme6e01fa62015-11-11 19:35:14 -080074
Steven Morelandcb7ef822016-11-29 13:20:37 -080075using ::android::hardware::dumpstate::V1_0::IDumpstateDevice;
Vishnu Naire97d6122018-01-18 13:58:56 -080076using ::std::literals::chrono_literals::operator""ms;
77using ::std::literals::chrono_literals::operator""s;
Steven Morelandcb7ef822016-11-29 13:20:37 -080078
Felipe Leme47e9be22016-12-21 15:37:07 -080079// TODO: remove once moved to namespace
Vishnu Naire97d6122018-01-18 13:58:56 -080080using android::defaultServiceManager;
81using android::Dumpsys;
82using android::INVALID_OPERATION;
83using android::IServiceManager;
84using android::OK;
85using android::sp;
86using android::status_t;
87using android::String16;
88using android::String8;
89using android::TIMED_OUT;
90using android::UNKNOWN_ERROR;
91using android::Vector;
Nandana Dutt979388e2018-11-30 16:48:55 +000092using android::base::StringPrintf;
Nandana Duttd2f5f082019-01-18 17:13:52 +000093using android::os::IDumpstateListener;
Felipe Leme47e9be22016-12-21 15:37:07 -080094using android::os::dumpstate::CommandOptions;
95using android::os::dumpstate::DumpFileToFd;
Vishnu Naire97d6122018-01-18 13:58:56 -080096using android::os::dumpstate::DumpstateSectionReporter;
Vishnu Naire97d6122018-01-18 13:58:56 -080097using android::os::dumpstate::PropertiesHelper;
Felipe Leme47e9be22016-12-21 15:37:07 -080098
Nandana Duttd2f5f082019-01-18 17:13:52 +000099typedef Dumpstate::ConsentCallback::ConsentResult UserConsentResult;
100
Colin Crossf45fa6b2012-03-26 12:38:26 -0700101/* read before root is shed */
102static char cmdline_buf[16384] = "(unknown)";
Yi Kong19d5c002018-07-20 13:39:55 -0700103static const char *dump_traces_path = nullptr;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000104static const uint64_t USER_CONSENT_TIMEOUT_MS = 30 * 1000;
Colin Crossf45fa6b2012-03-26 12:38:26 -0700105
Felipe Leme1d486fe2016-10-14 18:06:47 -0700106// TODO: variables and functions below should be part of dumpstate object
107
Felipe Leme635ca312016-01-05 14:23:02 -0800108static std::set<std::string> mount_points;
109void add_mountinfo();
Felipe Leme78f2c862015-12-21 09:55:22 -0800110
Todd Poynor2a83daa2013-11-22 15:44:22 -0800111#define PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops"
Mark Salyzyn7d0a7622016-06-24 14:06:15 -0700112#define ALT_PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops-0"
Wei Wang509bb5d2017-06-09 14:42:12 -0700113#define BLK_DEV_SYS_DIR "/sys/block"
Todd Poynor2a83daa2013-11-22 15:44:22 -0800114
Felipe Lemee82a27d2016-01-05 13:35:44 -0800115#define RECOVERY_DIR "/cache/recovery"
Mark Salyzynd6ab0112016-03-25 12:56:39 -0700116#define RECOVERY_DATA_DIR "/data/misc/recovery"
Tianjie Xu75d53362018-04-11 16:42:28 -0700117#define UPDATE_ENGINE_LOG_DIR "/data/misc/update_engine_log"
Mark Salyzyn4d42dea2016-04-01 10:03:14 -0700118#define LOGPERSIST_DATA_DIR "/data/misc/logd"
David Brazdild2991962016-06-03 14:40:44 +0100119#define PROFILE_DATA_DIR_CUR "/data/misc/profiles/cur"
120#define PROFILE_DATA_DIR_REF "/data/misc/profiles/ref"
Benedict Wong8f9d8a42019-01-03 16:19:38 -0800121#define XFRM_STAT_PROC_FILE "/proc/net/xfrm_stat"
Erik Kline08165202016-05-30 11:55:44 +0900122#define WLUTIL "/vendor/xbin/wlutil"
Vishnu Nair36b4cdb2017-11-17 10:27:05 -0800123#define WMTRACE_DATA_DIR "/data/misc/wmtrace"
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700124
Narayan Kamath8f788292017-05-25 13:20:39 +0100125// TODO(narayan): Since this information has to be kept in sync
126// with tombstoned, we should just put it in a common header.
127//
128// File: system/core/debuggerd/tombstoned/tombstoned.cpp
Narayan Kamathbd863722017-06-01 18:50:12 +0100129static const std::string TOMBSTONE_DIR = "/data/tombstones/";
130static const std::string TOMBSTONE_FILE_PREFIX = "tombstone_";
131static const std::string ANR_DIR = "/data/anr/";
132static const std::string ANR_FILE_PREFIX = "anr_";
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700133
Felipe Lemee844a9d2016-09-21 15:01:39 -0700134// TODO: temporary variables and functions used during C++ refactoring
135static Dumpstate& ds = Dumpstate::GetInstance();
Nandana Dutt979388e2018-11-30 16:48:55 +0000136
Nandana Dutt5c390032019-03-12 10:52:56 +0000137#define RETURN_IF_USER_DENIED_CONSENT() \
138 if (ds.IsUserConsentDenied()) { \
139 MYLOGE("Returning early as user denied consent to share bugreport with calling app."); \
140 return Dumpstate::RunStatus::USER_CONSENT_DENIED; \
141 }
142
143// Runs func_ptr, but checks user consent before and after running it. Returns USER_CONSENT_DENIED
144// if consent is found to be denied.
145#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(func_ptr, ...) \
146 RETURN_IF_USER_DENIED_CONSENT(); \
147 func_ptr(__VA_ARGS__); \
148 RETURN_IF_USER_DENIED_CONSENT();
149
Nandana Dutt979388e2018-11-30 16:48:55 +0000150namespace android {
151namespace os {
152namespace {
153
154static int Open(std::string path, int flags, mode_t mode = 0) {
155 int fd = TEMP_FAILURE_RETRY(open(path.c_str(), flags, mode));
156 if (fd == -1) {
157 MYLOGE("open(%s, %s)\n", path.c_str(), strerror(errno));
158 }
159 return fd;
160}
161
Nandana Dutt979388e2018-11-30 16:48:55 +0000162
163static int OpenForRead(std::string path) {
164 return Open(path, O_RDONLY | O_CLOEXEC | O_NOFOLLOW);
165}
166
167bool CopyFile(int in_fd, int out_fd) {
168 char buf[4096];
169 ssize_t byte_count;
170 while ((byte_count = TEMP_FAILURE_RETRY(read(in_fd, buf, sizeof(buf)))) > 0) {
171 if (!android::base::WriteFully(out_fd, buf, byte_count)) {
172 return false;
173 }
174 }
175 return (byte_count != -1);
176}
177
178static bool CopyFileToFd(const std::string& input_file, int out_fd) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000179 MYLOGD("Going to copy file (%s) to %d\n", input_file.c_str(), out_fd);
Nandana Dutt979388e2018-11-30 16:48:55 +0000180
181 // Obtain a handle to the source file.
182 android::base::unique_fd in_fd(OpenForRead(input_file));
183 if (out_fd != -1 && in_fd.get() != -1) {
184 if (CopyFile(in_fd.get(), out_fd)) {
185 return true;
186 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000187 MYLOGE("Failed to copy file: %s\n", strerror(errno));
Nandana Dutt979388e2018-11-30 16:48:55 +0000188 }
189 return false;
190}
191
Nandana Duttd2f5f082019-01-18 17:13:52 +0000192static bool UnlinkAndLogOnError(const std::string& file) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000193 if (unlink(file.c_str())) {
194 MYLOGE("Failed to unlink file (%s): %s\n", file.c_str(), strerror(errno));
Nandana Duttd2f5f082019-01-18 17:13:52 +0000195 return false;
196 }
197 return true;
198}
Nandana Dutt979388e2018-11-30 16:48:55 +0000199
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +0000200static bool IsFileEmpty(const std::string& file_path) {
201 std::ifstream file(file_path, std::ios::binary | std::ios::ate);
202 if(file.bad()) {
203 MYLOGE("Cannot open file: %s\n", file_path.c_str());
204 return true;
205 }
206 return file.tellg() <= 0;
207}
208
Nikita Ioffea325a572019-05-16 19:49:47 +0100209int64_t GetModuleMetadataVersion() {
210 auto binder = defaultServiceManager()->getService(android::String16("package_native"));
211 if (binder == nullptr) {
212 MYLOGE("Failed to retrieve package_native service");
213 return 0L;
214 }
215 auto package_service = android::interface_cast<content::pm::IPackageManagerNative>(binder);
216 std::string package_name;
217 auto status = package_service->getModuleMetadataPackageName(&package_name);
218 if (!status.isOk()) {
219 MYLOGE("Failed to retrieve module metadata package name: %s", status.toString8().c_str());
220 return 0L;
221 }
222 MYLOGD("Module metadata package name: %s", package_name.c_str());
223 int64_t version_code;
224 status = package_service->getVersionCodeForPackage(android::String16(package_name.c_str()),
225 &version_code);
226 if (!status.isOk()) {
227 MYLOGE("Failed to retrieve module metadata version: %s", status.toString8().c_str());
228 return 0L;
229 }
230 return version_code;
231}
232
Nandana Dutt979388e2018-11-30 16:48:55 +0000233} // namespace
234} // namespace os
235} // namespace android
236
Felipe Leme678727a2016-09-21 17:22:11 -0700237static int RunCommand(const std::string& title, const std::vector<std::string>& fullCommand,
238 const CommandOptions& options = CommandOptions::DEFAULT) {
239 return ds.RunCommand(title, fullCommand, options);
240}
241static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
Felipe Lemebda15a02016-11-16 17:48:25 -0800242 const CommandOptions& options = Dumpstate::DEFAULT_DUMPSYS,
Vishnu Nair6921f802017-11-22 09:17:23 -0800243 long dumpsysTimeoutMs = 0) {
244 return ds.RunDumpsys(title, dumpsysArgs, options, dumpsysTimeoutMs);
Felipe Leme678727a2016-09-21 17:22:11 -0700245}
246static int DumpFile(const std::string& title, const std::string& path) {
247 return ds.DumpFile(title, path);
248}
Felipe Lemee82a27d2016-01-05 13:35:44 -0800249
Felipe Lemee844a9d2016-09-21 15:01:39 -0700250// Relative directory (inside the zip) for all files copied as-is into the bugreport.
251static const std::string ZIP_ROOT_DIR = "FS";
252
Vishnu Naire97d6122018-01-18 13:58:56 -0800253static const std::string kProtoPath = "proto/";
254static const std::string kProtoExt = ".proto";
Jie Song9fbfad02017-06-20 16:29:42 -0700255static const std::string kDumpstateBoardFiles[] = {
256 "dumpstate_board.txt",
Felipe Leme95d6ca52017-08-01 16:35:56 -0700257 "dumpstate_board.bin"
Jie Song9fbfad02017-06-20 16:29:42 -0700258};
259static const int NUM_OF_DUMPS = arraysize(kDumpstateBoardFiles);
260
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700261static constexpr char PROPERTY_EXTRA_OPTIONS[] = "dumpstate.options";
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700262static constexpr char PROPERTY_LAST_ID[] = "dumpstate.last_id";
Felipe Lemed071c682016-10-20 16:48:00 -0700263static constexpr char PROPERTY_VERSION[] = "dumpstate.version";
Naveen Kallab53a1c92017-03-16 18:17:25 -0700264static constexpr char PROPERTY_EXTRA_TITLE[] = "dumpstate.options.title";
265static constexpr char PROPERTY_EXTRA_DESCRIPTION[] = "dumpstate.options.description";
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700266
Felipe Lemef0292972016-11-22 13:57:05 -0800267static const CommandOptions AS_ROOT_20 = CommandOptions::WithTimeout(20).AsRoot().Build();
268
Narayan Kamath8f788292017-05-25 13:20:39 +0100269/*
Narayan Kamathbd863722017-06-01 18:50:12 +0100270 * Returns a vector of dump fds under |dir_path| with a given |file_prefix|.
271 * The returned vector is sorted by the mtimes of the dumps. If |limit_by_mtime|
272 * is set, the vector only contains files that were written in the last 30 minutes.
Andreas Gamped0d76952017-08-22 13:08:37 -0700273 * If |limit_by_count| is set, the vector only contains the ten latest files.
Narayan Kamath8f788292017-05-25 13:20:39 +0100274 */
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700275static std::vector<DumpData> GetDumpFds(const std::string& dir_path,
276 const std::string& file_prefix,
277 bool limit_by_mtime,
278 bool limit_by_count = true) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100279 const time_t thirty_minutes_ago = ds.now_ - 60 * 30;
280
Narayan Kamathbd863722017-06-01 18:50:12 +0100281 std::unique_ptr<DIR, decltype(&closedir)> dump_dir(opendir(dir_path.c_str()), closedir);
Narayan Kamath8f788292017-05-25 13:20:39 +0100282
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700283 if (dump_dir == nullptr) {
284 MYLOGW("Unable to open directory %s: %s\n", dir_path.c_str(), strerror(errno));
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700285 return std::vector<DumpData>();
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700286 }
287
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700288 std::vector<DumpData> dump_data;
Narayan Kamathbd863722017-06-01 18:50:12 +0100289 struct dirent* entry = nullptr;
290 while ((entry = readdir(dump_dir.get()))) {
291 if (entry->d_type != DT_REG) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100292 continue;
293 }
294
Narayan Kamathbd863722017-06-01 18:50:12 +0100295 const std::string base_name(entry->d_name);
296 if (base_name.find(file_prefix) != 0) {
297 continue;
298 }
299
300 const std::string abs_path = dir_path + base_name;
301 android::base::unique_fd fd(
302 TEMP_FAILURE_RETRY(open(abs_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW | O_NONBLOCK)));
303 if (fd == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700304 MYLOGW("Unable to open dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamathbd863722017-06-01 18:50:12 +0100305 break;
306 }
307
308 struct stat st = {};
309 if (fstat(fd, &st) == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700310 MYLOGW("Unable to stat dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamath8f788292017-05-25 13:20:39 +0100311 continue;
312 }
313
Narayan Kamath3f31b632018-02-22 19:42:36 +0000314 if (limit_by_mtime && st.st_mtime < thirty_minutes_ago) {
Narayan Kamathbd863722017-06-01 18:50:12 +0100315 MYLOGI("Excluding stale dump file: %s\n", abs_path.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100316 continue;
317 }
318
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700319 dump_data.emplace_back(DumpData{abs_path, std::move(fd), st.st_mtime});
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700320 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100321
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700322 // Sort in descending modification time so that we only keep the newest
323 // reports if |limit_by_count| is true.
324 std::sort(dump_data.begin(), dump_data.end(),
325 [](const DumpData& d1, const DumpData& d2) { return d1.mtime > d2.mtime; });
Narayan Kamath8f788292017-05-25 13:20:39 +0100326
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700327 if (limit_by_count && dump_data.size() > 10) {
328 dump_data.erase(dump_data.begin() + 10, dump_data.end());
Andreas Gamped0d76952017-08-22 13:08:37 -0700329 }
330
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700331 return dump_data;
Narayan Kamath8f788292017-05-25 13:20:39 +0100332}
333
Narayan Kamathbd863722017-06-01 18:50:12 +0100334static bool AddDumps(const std::vector<DumpData>::const_iterator start,
335 const std::vector<DumpData>::const_iterator end,
336 const char* type_name, const bool add_to_zip) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100337 bool dumped = false;
Narayan Kamathbd863722017-06-01 18:50:12 +0100338 for (auto it = start; it != end; ++it) {
339 const std::string& name = it->name;
340 const int fd = it->fd;
Narayan Kamath8f788292017-05-25 13:20:39 +0100341 dumped = true;
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100342
343 // Seek to the beginning of the file before dumping any data. A given
344 // DumpData entry might be dumped multiple times in the report.
345 //
346 // For example, the most recent ANR entry is dumped to the body of the
347 // main entry and it also shows up as a separate entry in the bugreport
348 // ZIP file.
349 if (lseek(fd, 0, SEEK_SET) != static_cast<off_t>(0)) {
350 MYLOGE("Unable to add %s to zip file, lseek failed: %s\n", name.c_str(),
351 strerror(errno));
352 }
353
Narayan Kamath8f788292017-05-25 13:20:39 +0100354 if (ds.IsZipping() && add_to_zip) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800355 if (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + name, fd, /* timeout = */ 0ms) != OK) {
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100356 MYLOGE("Unable to add %s to zip file, addZipEntryFromFd failed\n", name.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100357 }
358 } else {
359 dump_file_from_fd(type_name, name.c_str(), fd);
360 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100361 }
362
363 return dumped;
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700364}
365
Felipe Leme635ca312016-01-05 14:23:02 -0800366// for_each_pid() callback to get mount info about a process.
Felipe Leme4c2d6632016-09-28 14:32:00 -0700367void do_mountinfo(int pid, const char* name __attribute__((unused))) {
Felipe Leme635ca312016-01-05 14:23:02 -0800368 char path[PATH_MAX];
369
370 // Gets the the content of the /proc/PID/ns/mnt link, so only unique mount points
371 // are added.
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700372 snprintf(path, sizeof(path), "/proc/%d/ns/mnt", pid);
Felipe Leme635ca312016-01-05 14:23:02 -0800373 char linkname[PATH_MAX];
374 ssize_t r = readlink(path, linkname, PATH_MAX);
375 if (r == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800376 MYLOGE("Unable to read link for %s: %s\n", path, strerror(errno));
Felipe Leme635ca312016-01-05 14:23:02 -0800377 return;
378 }
379 linkname[r] = '\0';
380
381 if (mount_points.find(linkname) == mount_points.end()) {
382 // First time this mount point was found: add it
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700383 snprintf(path, sizeof(path), "/proc/%d/mountinfo", pid);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700384 if (ds.AddZipEntry(ZIP_ROOT_DIR + path, path)) {
Felipe Leme635ca312016-01-05 14:23:02 -0800385 mount_points.insert(linkname);
386 } else {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800387 MYLOGE("Unable to add mountinfo %s to zip file\n", path);
Felipe Leme635ca312016-01-05 14:23:02 -0800388 }
389 }
390}
391
392void add_mountinfo() {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700393 if (!ds.IsZipping()) return;
Felipe Leme678727a2016-09-21 17:22:11 -0700394 std::string title = "MOUNT INFO";
Felipe Leme635ca312016-01-05 14:23:02 -0800395 mount_points.clear();
Felipe Leme46b85da2016-11-21 17:40:45 -0800396 DurationReporter duration_reporter(title, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700397 for_each_pid(do_mountinfo, nullptr);
398 MYLOGD("%s: %d entries added to zip file\n", title.c_str(), (int)mount_points.size());
Felipe Leme635ca312016-01-05 14:23:02 -0800399}
400
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700401static void dump_dev_files(const char *title, const char *driverpath, const char *filename)
402{
403 DIR *d;
404 struct dirent *de;
405 char path[PATH_MAX];
406
407 d = opendir(driverpath);
Yi Kong19d5c002018-07-20 13:39:55 -0700408 if (d == nullptr) {
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700409 return;
410 }
411
412 while ((de = readdir(d))) {
413 if (de->d_type != DT_LNK) {
414 continue;
415 }
416 snprintf(path, sizeof(path), "%s/%s/%s", driverpath, de->d_name, filename);
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700417 DumpFile(title, path);
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700418 }
419
420 closedir(d);
421}
422
Mark Salyzyn326842f2015-04-30 09:49:41 -0700423static bool skip_not_stat(const char *path) {
424 static const char stat[] = "/stat";
425 size_t len = strlen(path);
426 if (path[len - 1] == '/') { /* Directory? */
427 return false;
428 }
429 return strcmp(path + len - sizeof(stat) + 1, stat); /* .../stat? */
430}
431
Felipe Leme4c2d6632016-09-28 14:32:00 -0700432static bool skip_none(const char* path __attribute__((unused))) {
Felipe Lemee82a27d2016-01-05 13:35:44 -0800433 return false;
434}
435
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700436unsigned long worst_write_perf = 20000; /* in KB/s */
Mark Salyzyn326842f2015-04-30 09:49:41 -0700437
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800438//
439// stat offsets
440// Name units description
441// ---- ----- -----------
442// read I/Os requests number of read I/Os processed
443#define __STAT_READ_IOS 0
444// read merges requests number of read I/Os merged with in-queue I/O
445#define __STAT_READ_MERGES 1
446// read sectors sectors number of sectors read
447#define __STAT_READ_SECTORS 2
448// read ticks milliseconds total wait time for read requests
449#define __STAT_READ_TICKS 3
450// write I/Os requests number of write I/Os processed
451#define __STAT_WRITE_IOS 4
452// write merges requests number of write I/Os merged with in-queue I/O
453#define __STAT_WRITE_MERGES 5
454// write sectors sectors number of sectors written
455#define __STAT_WRITE_SECTORS 6
456// write ticks milliseconds total wait time for write requests
457#define __STAT_WRITE_TICKS 7
458// in_flight requests number of I/Os currently in flight
459#define __STAT_IN_FLIGHT 8
460// io_ticks milliseconds total time this block device has been active
461#define __STAT_IO_TICKS 9
462// time_in_queue milliseconds total wait time for all requests
463#define __STAT_IN_QUEUE 10
464#define __STAT_NUMBER_FIELD 11
465//
466// read I/Os, write I/Os
467// =====================
468//
469// These values increment when an I/O request completes.
470//
471// read merges, write merges
472// =========================
473//
474// These values increment when an I/O request is merged with an
475// already-queued I/O request.
476//
477// read sectors, write sectors
478// ===========================
479//
480// These values count the number of sectors read from or written to this
481// block device. The "sectors" in question are the standard UNIX 512-byte
482// sectors, not any device- or filesystem-specific block size. The
483// counters are incremented when the I/O completes.
484#define SECTOR_SIZE 512
485//
486// read ticks, write ticks
487// =======================
488//
489// These values count the number of milliseconds that I/O requests have
490// waited on this block device. If there are multiple I/O requests waiting,
491// these values will increase at a rate greater than 1000/second; for
492// example, if 60 read requests wait for an average of 30 ms, the read_ticks
493// field will increase by 60*30 = 1800.
494//
495// in_flight
496// =========
497//
498// This value counts the number of I/O requests that have been issued to
499// the device driver but have not yet completed. It does not include I/O
500// requests that are in the queue but not yet issued to the device driver.
501//
502// io_ticks
503// ========
504//
505// This value counts the number of milliseconds during which the device has
506// had I/O requests queued.
507//
508// time_in_queue
509// =============
510//
511// This value counts the number of milliseconds that I/O requests have waited
512// on this block device. If there are multiple I/O requests waiting, this
513// value will increase as the product of the number of milliseconds times the
514// number of requests waiting (see "read ticks" above for an example).
515#define S_TO_MS 1000
516//
517
Mark Salyzyn326842f2015-04-30 09:49:41 -0700518static int dump_stat_from_fd(const char *title __unused, const char *path, int fd) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800519 unsigned long long fields[__STAT_NUMBER_FIELD];
Mark Salyzyn326842f2015-04-30 09:49:41 -0700520 bool z;
Yi Kong19d5c002018-07-20 13:39:55 -0700521 char *cp, *buffer = nullptr;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700522 size_t i = 0;
Josh Gao7c4258c2018-06-25 13:40:08 -0700523 FILE *fp = fdopen(dup(fd), "rb");
Mark Salyzyn326842f2015-04-30 09:49:41 -0700524 getline(&buffer, &i, fp);
525 fclose(fp);
526 if (!buffer) {
527 return -errno;
528 }
529 i = strlen(buffer);
530 while ((i > 0) && (buffer[i - 1] == '\n')) {
531 buffer[--i] = '\0';
532 }
533 if (!*buffer) {
534 free(buffer);
535 return 0;
536 }
537 z = true;
538 for (cp = buffer, i = 0; i < (sizeof(fields) / sizeof(fields[0])); ++i) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800539 fields[i] = strtoull(cp, &cp, 10);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700540 if (fields[i] != 0) {
541 z = false;
542 }
543 }
544 if (z) { /* never accessed */
545 free(buffer);
546 return 0;
547 }
548
Wei Wang509bb5d2017-06-09 14:42:12 -0700549 if (!strncmp(path, BLK_DEV_SYS_DIR, sizeof(BLK_DEV_SYS_DIR) - 1)) {
550 path += sizeof(BLK_DEV_SYS_DIR) - 1;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700551 }
Wei Wang1dc1ef52017-06-12 11:28:37 -0700552
553 printf("%-30s:%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s\n%-30s:\t%s\n", "Block-Dev",
554 "R-IOs", "R-merg", "R-sect", "R-wait", "W-IOs", "W-merg", "W-sect",
555 "W-wait", "in-fli", "activ", "T-wait", path, buffer);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700556 free(buffer);
557
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800558 if (fields[__STAT_IO_TICKS]) {
559 unsigned long read_perf = 0;
560 unsigned long read_ios = 0;
561 if (fields[__STAT_READ_TICKS]) {
562 unsigned long long divisor = fields[__STAT_READ_TICKS]
563 * fields[__STAT_IO_TICKS];
564 read_perf = ((unsigned long long)SECTOR_SIZE
565 * fields[__STAT_READ_SECTORS]
566 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
567 / divisor;
568 read_ios = ((unsigned long long)S_TO_MS * fields[__STAT_READ_IOS]
569 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
570 / divisor;
571 }
572
573 unsigned long write_perf = 0;
574 unsigned long write_ios = 0;
575 if (fields[__STAT_WRITE_TICKS]) {
576 unsigned long long divisor = fields[__STAT_WRITE_TICKS]
577 * fields[__STAT_IO_TICKS];
578 write_perf = ((unsigned long long)SECTOR_SIZE
579 * fields[__STAT_WRITE_SECTORS]
580 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
581 / divisor;
582 write_ios = ((unsigned long long)S_TO_MS * fields[__STAT_WRITE_IOS]
583 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
584 / divisor;
585 }
586
587 unsigned queue = (fields[__STAT_IN_QUEUE]
588 + (fields[__STAT_IO_TICKS] >> 1))
589 / fields[__STAT_IO_TICKS];
590
591 if (!write_perf && !write_ios) {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700592 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 -0800593 } else {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700594 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 -0800595 read_ios, write_perf, write_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800596 }
597
598 /* bugreport timeout factor adjustment */
599 if ((write_perf > 1) && (write_perf < worst_write_perf)) {
600 worst_write_perf = write_perf;
601 }
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700602 }
Mark Salyzyn326842f2015-04-30 09:49:41 -0700603 return 0;
604}
605
Yao Chenbe3bbc12018-01-17 16:31:10 -0800606static const long MINIMUM_LOGCAT_TIMEOUT_MS = 50000;
607
608/* timeout in ms to read a list of buffers */
609static unsigned long logcat_timeout(const std::vector<std::string>& buffers) {
610 unsigned long timeout_ms = 0;
611 for (const auto& buffer : buffers) {
612 log_id_t id = android_name_to_log_id(buffer.c_str());
613 unsigned long property_size = __android_logger_get_buffer_size(id);
614 /* Engineering margin is ten-fold our guess */
615 timeout_ms += 10 * (property_size + worst_write_perf) / worst_write_perf;
616 }
617 return timeout_ms > MINIMUM_LOGCAT_TIMEOUT_MS ? timeout_ms : MINIMUM_LOGCAT_TIMEOUT_MS;
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700618}
619
Nandana Duttd2f5f082019-01-18 17:13:52 +0000620Dumpstate::ConsentCallback::ConsentCallback() : result_(UNAVAILABLE), start_time_(Nanotime()) {
621}
622
623android::binder::Status Dumpstate::ConsentCallback::onReportApproved() {
624 std::lock_guard<std::mutex> lock(lock_);
625 result_ = APPROVED;
626 MYLOGD("User approved consent to share bugreport\n");
627 return android::binder::Status::ok();
628}
629
630android::binder::Status Dumpstate::ConsentCallback::onReportDenied() {
631 std::lock_guard<std::mutex> lock(lock_);
632 result_ = DENIED;
633 MYLOGW("User denied consent to share bugreport\n");
634 return android::binder::Status::ok();
635}
636
637UserConsentResult Dumpstate::ConsentCallback::getResult() {
638 std::lock_guard<std::mutex> lock(lock_);
639 return result_;
640}
641
642uint64_t Dumpstate::ConsentCallback::getElapsedTimeMs() const {
643 return Nanotime() - start_time_;
644}
645
Felipe Leme2b9b06c2016-10-14 09:13:06 -0700646void Dumpstate::PrintHeader() const {
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700647 std::string build, fingerprint, radio, bootloader, network;
648 char date[80];
Colin Crossf45fa6b2012-03-26 12:38:26 -0700649
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700650 build = android::base::GetProperty("ro.build.display.id", "(unknown)");
651 fingerprint = android::base::GetProperty("ro.build.fingerprint", "(unknown)");
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700652 radio = android::base::GetProperty("gsm.version.baseband", "(unknown)");
653 bootloader = android::base::GetProperty("ro.bootloader", "(unknown)");
654 network = android::base::GetProperty("gsm.operator.alpha", "(unknown)");
Felipe Lemebbaf3c12016-10-11 14:32:25 -0700655 strftime(date, sizeof(date), "%Y-%m-%d %H:%M:%S", localtime(&now_));
Colin Crossf45fa6b2012-03-26 12:38:26 -0700656
Felipe Lemed8b94e52016-12-08 10:21:44 -0800657 printf("========================================================\n");
658 printf("== dumpstate: %s\n", date);
659 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -0700660
Felipe Lemed8b94e52016-12-08 10:21:44 -0800661 printf("\n");
662 printf("Build: %s\n", build.c_str());
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700663 // NOTE: fingerprint entry format is important for other tools.
Felipe Lemed8b94e52016-12-08 10:21:44 -0800664 printf("Build fingerprint: '%s'\n", fingerprint.c_str());
665 printf("Bootloader: %s\n", bootloader.c_str());
666 printf("Radio: %s\n", radio.c_str());
667 printf("Network: %s\n", network.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100668 int64_t module_metadata_version = android::os::GetModuleMetadataVersion();
669 if (module_metadata_version != 0) {
670 printf("Module Metadata version: %" PRId64 "\n", module_metadata_version);
671 }
Colin Crossf45fa6b2012-03-26 12:38:26 -0700672
Felipe Lemed8b94e52016-12-08 10:21:44 -0800673 printf("Kernel: ");
Felipe Lemef0292972016-11-22 13:57:05 -0800674 DumpFileToFd(STDOUT_FILENO, "", "/proc/version");
Felipe Lemed8b94e52016-12-08 10:21:44 -0800675 printf("Command line: %s\n", strtok(cmdline_buf, "\n"));
Felipe Leme7709f8a2017-12-05 09:30:09 -0800676 printf("Uptime: ");
677 RunCommandToFd(STDOUT_FILENO, "", {"uptime", "-p"},
678 CommandOptions::WithTimeout(1).Always().Build());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800679 printf("Bugreport format version: %s\n", version_.c_str());
680 printf("Dumpstate info: id=%d pid=%d dry_run=%d args=%s extra_options=%s\n", id_, pid_,
Nandana Dutt5fb117b2018-09-27 09:23:36 +0100681 PropertiesHelper::IsDryRun(), options_->args.c_str(), options_->extra_options.c_str());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800682 printf("\n");
Felipe Leme78f2c862015-12-21 09:55:22 -0800683}
684
Felipe Leme24b66ee2016-06-16 10:55:26 -0700685// List of file extensions that can cause a zip file attachment to be rejected by some email
686// service providers.
687static const std::set<std::string> PROBLEMATIC_FILE_EXTENSIONS = {
688 ".ade", ".adp", ".bat", ".chm", ".cmd", ".com", ".cpl", ".exe", ".hta", ".ins", ".isp",
689 ".jar", ".jse", ".lib", ".lnk", ".mde", ".msc", ".msp", ".mst", ".pif", ".scr", ".sct",
690 ".shb", ".sys", ".vb", ".vbe", ".vbs", ".vxd", ".wsc", ".wsf", ".wsh"
691};
692
Vishnu Naire97d6122018-01-18 13:58:56 -0800693status_t Dumpstate::AddZipEntryFromFd(const std::string& entry_name, int fd,
694 std::chrono::milliseconds timeout = 0ms) {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700695 if (!IsZipping()) {
696 MYLOGD("Not adding zip entry %s from fd because it's not a zipped bugreport\n",
697 entry_name.c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -0800698 return INVALID_OPERATION;
Felipe Leme111b9d02016-02-03 09:28:24 -0800699 }
Felipe Leme24b66ee2016-06-16 10:55:26 -0700700 std::string valid_name = entry_name;
701
702 // Rename extension if necessary.
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -0700703 size_t idx = entry_name.rfind('.');
Felipe Leme24b66ee2016-06-16 10:55:26 -0700704 if (idx != std::string::npos) {
705 std::string extension = entry_name.substr(idx);
706 std::transform(extension.begin(), extension.end(), extension.begin(), ::tolower);
707 if (PROBLEMATIC_FILE_EXTENSIONS.count(extension) != 0) {
708 valid_name = entry_name + ".renamed";
709 MYLOGI("Renaming entry %s to %s\n", entry_name.c_str(), valid_name.c_str());
710 }
711 }
712
Felipe Leme6fe9db62016-02-12 09:04:16 -0800713 // Logging statement below is useful to time how long each entry takes, but it's too verbose.
714 // MYLOGD("Adding zip entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700715 int32_t err = zip_writer_->StartEntryWithTime(valid_name.c_str(), ZipWriter::kCompress,
716 get_mtime(fd, ds.now_));
Felipe Leme1d486fe2016-10-14 18:06:47 -0700717 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700718 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", valid_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700719 ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800720 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800721 }
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000722 bool finished_entry = false;
723 auto finish_entry = [this, &finished_entry] {
724 if (!finished_entry) {
725 // This should only be called when we're going to return an earlier error,
726 // which would've been logged. This may imply the file is already corrupt
727 // and any further logging from FinishEntry is more likely to mislead than
728 // not.
729 this->zip_writer_->FinishEntry();
730 }
731 };
732 auto scope_guard = android::base::make_scope_guard(finish_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -0800733 auto start = std::chrono::steady_clock::now();
734 auto end = start + timeout;
735 struct pollfd pfd = {fd, POLLIN};
Felipe Lemee82a27d2016-01-05 13:35:44 -0800736
Felipe Leme770410d2016-01-26 17:07:14 -0800737 std::vector<uint8_t> buffer(65536);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800738 while (1) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800739 if (timeout.count() > 0) {
740 // lambda to recalculate the timeout.
741 auto time_left_ms = [end]() {
742 auto now = std::chrono::steady_clock::now();
743 auto diff = std::chrono::duration_cast<std::chrono::milliseconds>(end - now);
744 return std::max(diff.count(), 0LL);
745 };
746
747 int rc = TEMP_FAILURE_RETRY(poll(&pfd, 1, time_left_ms()));
748 if (rc < 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000749 MYLOGE("Error in poll while adding from fd to zip entry %s:%s\n",
750 entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800751 return -errno;
752 } else if (rc == 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000753 MYLOGE("Timed out adding from fd to zip entry %s:%s Timeout:%lldms\n",
Vishnu Naire97d6122018-01-18 13:58:56 -0800754 entry_name.c_str(), strerror(errno), timeout.count());
755 return TIMED_OUT;
756 }
757 }
758
Zach Riggle22200402016-08-18 01:01:24 -0400759 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800760 if (bytes_read == 0) {
761 break;
762 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800763 MYLOGE("read(%s): %s\n", entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800764 return -errno;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800765 }
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700766 err = zip_writer_->WriteBytes(buffer.data(), bytes_read);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800767 if (err) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700768 MYLOGE("zip_writer_->WriteBytes(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800769 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800770 }
771 }
772
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700773 err = zip_writer_->FinishEntry();
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000774 finished_entry = true;
Felipe Leme1d486fe2016-10-14 18:06:47 -0700775 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700776 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800777 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800778 }
779
Vishnu Naire97d6122018-01-18 13:58:56 -0800780 return OK;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800781}
782
Felipe Leme1d486fe2016-10-14 18:06:47 -0700783bool Dumpstate::AddZipEntry(const std::string& entry_name, const std::string& entry_path) {
784 android::base::unique_fd fd(
785 TEMP_FAILURE_RETRY(open(entry_path.c_str(), O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
Andreas Gampeaff68432016-07-18 18:01:27 -0700786 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800787 MYLOGE("open(%s): %s\n", entry_path.c_str(), strerror(errno));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800788 return false;
789 }
790
Vishnu Naire97d6122018-01-18 13:58:56 -0800791 return (AddZipEntryFromFd(entry_name, fd.get()) == OK);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800792}
793
794/* adds a file to the existing zipped bugreport */
Felipe Leme4c2d6632016-09-28 14:32:00 -0700795static int _add_file_from_fd(const char* title __attribute__((unused)), const char* path, int fd) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800796 return (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + path, fd) == OK) ? 0 : 1;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800797}
798
Felipe Leme1d486fe2016-10-14 18:06:47 -0700799void Dumpstate::AddDir(const std::string& dir, bool recursive) {
800 if (!IsZipping()) {
801 MYLOGD("Not adding dir %s because it's not a zipped bugreport\n", dir.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800802 return;
803 }
Felipe Leme678727a2016-09-21 17:22:11 -0700804 MYLOGD("Adding dir %s (recursive: %d)\n", dir.c_str(), recursive);
Felipe Leme46b85da2016-11-21 17:40:45 -0800805 DurationReporter duration_reporter(dir, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700806 dump_files("", dir.c_str(), recursive ? skip_none : is_dir, _add_file_from_fd);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800807}
808
Felipe Leme1d486fe2016-10-14 18:06:47 -0700809bool Dumpstate::AddTextZipEntry(const std::string& entry_name, const std::string& content) {
810 if (!IsZipping()) {
811 MYLOGD("Not adding text zip entry %s because it's not a zipped bugreport\n",
812 entry_name.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800813 return false;
814 }
Felipe Lemecbce55d2016-02-08 09:53:18 -0800815 MYLOGD("Adding zip text entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700816 int32_t err = zip_writer_->StartEntryWithTime(entry_name.c_str(), ZipWriter::kCompress, ds.now_);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700817 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700818 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700819 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800820 return false;
821 }
822
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700823 err = zip_writer_->WriteBytes(content.c_str(), content.length());
Felipe Leme1d486fe2016-10-14 18:06:47 -0700824 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700825 MYLOGE("zip_writer_->WriteBytes(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700826 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800827 return false;
828 }
829
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700830 err = zip_writer_->FinishEntry();
Felipe Leme1d486fe2016-10-14 18:06:47 -0700831 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700832 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800833 return false;
834 }
835
836 return true;
837}
838
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800839static void DoKmsg() {
840 struct stat st;
841 if (!stat(PSTORE_LAST_KMSG, &st)) {
842 /* Also TODO: Make console-ramoops CAP_SYSLOG protected. */
843 DumpFile("LAST KMSG", PSTORE_LAST_KMSG);
844 } else if (!stat(ALT_PSTORE_LAST_KMSG, &st)) {
845 DumpFile("LAST KMSG", ALT_PSTORE_LAST_KMSG);
846 } else {
847 /* TODO: Make last_kmsg CAP_SYSLOG protected. b/5555691 */
848 DumpFile("LAST KMSG", "/proc/last_kmsg");
849 }
850}
851
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800852static void DoKernelLogcat() {
Yao Chenbe3bbc12018-01-17 16:31:10 -0800853 unsigned long timeout_ms = logcat_timeout({"kernel"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800854 RunCommand(
855 "KERNEL LOG",
856 {"logcat", "-b", "kernel", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
857 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
858}
859
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800860static void DoLogcat() {
Vishnu Nair6921f802017-11-22 09:17:23 -0800861 unsigned long timeout_ms;
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800862 // DumpFile("EVENT LOG TAGS", "/etc/event-log-tags");
863 // calculate timeout
Yao Chenbe3bbc12018-01-17 16:31:10 -0800864 timeout_ms = logcat_timeout({"main", "system", "crash"});
Tony Makae737652017-03-30 17:47:09 +0100865 RunCommand("SYSTEM LOG",
Vishnu Nair6921f802017-11-22 09:17:23 -0800866 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
867 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -0800868 timeout_ms = logcat_timeout({"events"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800869 RunCommand(
870 "EVENT LOG",
871 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
872 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -0800873 timeout_ms = logcat_timeout({"stats"});
874 RunCommand(
875 "STATS LOG",
876 {"logcat", "-b", "stats", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
877 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
878 timeout_ms = logcat_timeout({"radio"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800879 RunCommand(
880 "RADIO LOG",
881 {"logcat", "-b", "radio", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
882 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800883
884 RunCommand("LOG STATISTICS", {"logcat", "-b", "all", "-S"});
885
886 /* kernels must set CONFIG_PSTORE_PMSG, slice up pstore with device tree */
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800887 RunCommand("LAST LOGCAT", {"logcat", "-L", "-b", "all", "-v", "threadtime", "-v", "printable",
888 "-v", "uid", "-d", "*:v"});
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800889}
890
Jayachandran Ca94c7172017-06-10 15:08:12 -0700891static void DumpIpTablesAsRoot() {
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700892 RunCommand("IPTABLES", {"iptables", "-L", "-nvx"});
893 RunCommand("IP6TABLES", {"ip6tables", "-L", "-nvx"});
Erik Kline32af8c22016-09-28 17:26:26 +0900894 RunCommand("IPTABLES NAT", {"iptables", "-t", "nat", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -0700895 /* no ip6 nat */
Erik Kline32af8c22016-09-28 17:26:26 +0900896 RunCommand("IPTABLES MANGLE", {"iptables", "-t", "mangle", "-L", "-nvx"});
897 RunCommand("IP6TABLES MANGLE", {"ip6tables", "-t", "mangle", "-L", "-nvx"});
898 RunCommand("IPTABLES RAW", {"iptables", "-t", "raw", "-L", "-nvx"});
899 RunCommand("IP6TABLES RAW", {"ip6tables", "-t", "raw", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -0700900}
901
Narayan Kamath8f788292017-05-25 13:20:39 +0100902static void AddAnrTraceDir(const bool add_to_zip, const std::string& anr_traces_dir) {
903 MYLOGD("AddAnrTraceDir(): dump_traces_file=%s, anr_traces_dir=%s\n", dump_traces_path,
904 anr_traces_dir.c_str());
905
906 // If we're here, dump_traces_path will always be a temporary file
907 // (created with mkostemp or similar) that contains dumps taken earlier
908 // on in the process.
909 if (dump_traces_path != nullptr) {
910 if (add_to_zip) {
911 ds.AddZipEntry(ZIP_ROOT_DIR + anr_traces_dir + "/traces-just-now.txt", dump_traces_path);
912 } else {
913 MYLOGD("Dumping current ANR traces (%s) to the main bugreport entry\n",
914 dump_traces_path);
915 ds.DumpFile("VM TRACES JUST NOW", dump_traces_path);
916 }
917
918 const int ret = unlink(dump_traces_path);
919 if (ret == -1) {
920 MYLOGW("Error unlinking temporary trace path %s: %s\n", dump_traces_path,
921 strerror(errno));
Felipe Lemee184f662016-10-27 10:04:47 -0700922 }
923 }
924
Narayan Kamathbd863722017-06-01 18:50:12 +0100925 // Add a specific message for the first ANR Dump.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700926 if (ds.anr_data_.size() > 0) {
927 AddDumps(ds.anr_data_.begin(), ds.anr_data_.begin() + 1,
Narayan Kamathbd863722017-06-01 18:50:12 +0100928 "VM TRACES AT LAST ANR", add_to_zip);
929
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100930 // The "last" ANR will always be included as separate entry in the zip file. In addition,
931 // it will be present in the body of the main entry if |add_to_zip| == false.
932 //
933 // Historical ANRs are always included as separate entries in the bugreport zip file.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700934 AddDumps(ds.anr_data_.begin() + ((add_to_zip) ? 1 : 0), ds.anr_data_.end(),
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100935 "HISTORICAL ANR", true /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +0100936 } else {
Narayan Kamath8f788292017-05-25 13:20:39 +0100937 printf("*** NO ANRs to dump in %s\n\n", ANR_DIR.c_str());
938 }
939}
940
941static void AddAnrTraceFiles() {
942 const bool add_to_zip = ds.IsZipping() && ds.version_ == VERSION_SPLIT_ANR;
943
Elliott Hughes69fe5ec2018-03-23 11:04:25 -0700944 std::string anr_traces_dir = "/data/anr";
Narayan Kamath8f788292017-05-25 13:20:39 +0100945
Elliott Hughes69fe5ec2018-03-23 11:04:25 -0700946 AddAnrTraceDir(add_to_zip, anr_traces_dir);
Narayan Kamath8f788292017-05-25 13:20:39 +0100947
Makoto Onuki83ec63f2019-01-31 17:08:59 -0800948 RunCommand("ANR FILES", {"ls", "-lt", ANR_DIR});
949
Elliott Hughes69fe5ec2018-03-23 11:04:25 -0700950 // Slow traces for slow operations.
Felipe Lemee184f662016-10-27 10:04:47 -0700951 struct stat st;
Elliott Hughes69fe5ec2018-03-23 11:04:25 -0700952 int i = 0;
953 while (true) {
954 const std::string slow_trace_path =
955 anr_traces_dir + android::base::StringPrintf("slow%02d.txt", i);
956 if (stat(slow_trace_path.c_str(), &st)) {
957 // No traces file at this index, done with the files.
958 break;
Felipe Lemee184f662016-10-27 10:04:47 -0700959 }
Elliott Hughes69fe5ec2018-03-23 11:04:25 -0700960 ds.DumpFile("VM TRACES WHEN SLOW", slow_trace_path.c_str());
961 i++;
Felipe Lemee184f662016-10-27 10:04:47 -0700962 }
963}
964
Wei Wang509bb5d2017-06-09 14:42:12 -0700965static void DumpBlockStatFiles() {
966 DurationReporter duration_reporter("DUMP BLOCK STAT");
Wei Wang509bb5d2017-06-09 14:42:12 -0700967
Wei Wang1dc1ef52017-06-12 11:28:37 -0700968 std::unique_ptr<DIR, std::function<int(DIR*)>> dirptr(opendir(BLK_DEV_SYS_DIR), closedir);
969
970 if (dirptr == nullptr) {
Wei Wang509bb5d2017-06-09 14:42:12 -0700971 MYLOGE("Failed to open %s: %s\n", BLK_DEV_SYS_DIR, strerror(errno));
972 return;
973 }
974
975 printf("------ DUMP BLOCK STAT ------\n\n");
Wei Wang1dc1ef52017-06-12 11:28:37 -0700976 while (struct dirent *d = readdir(dirptr.get())) {
Wei Wang509bb5d2017-06-09 14:42:12 -0700977 if ((d->d_name[0] == '.')
978 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
979 || (d->d_name[1] == '\0'))) {
980 continue;
981 }
982 const std::string new_path =
983 android::base::StringPrintf("%s/%s", BLK_DEV_SYS_DIR, d->d_name);
984 printf("------ BLOCK STAT (%s) ------\n", new_path.c_str());
985 dump_files("", new_path.c_str(), skip_not_stat, dump_stat_from_fd);
986 printf("\n");
987 }
Wei Wang1dc1ef52017-06-12 11:28:37 -0700988 return;
Wei Wang509bb5d2017-06-09 14:42:12 -0700989}
Jayachandran Ca94c7172017-06-10 15:08:12 -0700990
991static void DumpPacketStats() {
992 DumpFile("NETWORK DEV INFO", "/proc/net/dev");
993 DumpFile("QTAGUID NETWORK INTERFACES INFO", "/proc/net/xt_qtaguid/iface_stat_all");
994 DumpFile("QTAGUID NETWORK INTERFACES INFO (xt)", "/proc/net/xt_qtaguid/iface_stat_fmt");
995 DumpFile("QTAGUID CTRL INFO", "/proc/net/xt_qtaguid/ctrl");
996 DumpFile("QTAGUID STATS INFO", "/proc/net/xt_qtaguid/stats");
997}
998
999static void DumpIpAddrAndRules() {
1000 /* The following have a tendency to get wedged when wifi drivers/fw goes belly-up. */
1001 RunCommand("NETWORK INTERFACES", {"ip", "link"});
1002 RunCommand("IPv4 ADDRESSES", {"ip", "-4", "addr", "show"});
1003 RunCommand("IPv6 ADDRESSES", {"ip", "-6", "addr", "show"});
1004 RunCommand("IP RULES", {"ip", "rule", "show"});
1005 RunCommand("IP RULES v6", {"ip", "-6", "rule", "show"});
1006}
1007
Nandana Dutt5c390032019-03-12 10:52:56 +00001008static Dumpstate::RunStatus RunDumpsysTextByPriority(const std::string& title, int priority,
1009 std::chrono::milliseconds timeout,
1010 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001011 auto start = std::chrono::steady_clock::now();
Vishnu Naire97d6122018-01-18 13:58:56 -08001012 sp<android::IServiceManager> sm = defaultServiceManager();
1013 Dumpsys dumpsys(sm.get());
Vishnu Naire97d6122018-01-18 13:58:56 -08001014 Vector<String16> args;
1015 Dumpsys::setServiceArgs(args, /* asProto = */ false, priority);
Vishnu Naire97d6122018-01-18 13:58:56 -08001016 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ false);
1017 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001018 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001019 std::string path(title);
1020 path.append(" - ").append(String8(service).c_str());
1021 DumpstateSectionReporter section_reporter(path, ds.listener_, ds.report_section_);
1022 size_t bytes_written = 0;
1023 status_t status = dumpsys.startDumpThread(service, args);
1024 if (status == OK) {
1025 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1026 std::chrono::duration<double> elapsed_seconds;
1027 status = dumpsys.writeDump(STDOUT_FILENO, service, service_timeout,
1028 /* as_proto = */ false, elapsed_seconds, bytes_written);
1029 section_reporter.setSize(bytes_written);
1030 dumpsys.writeDumpFooter(STDOUT_FILENO, service, elapsed_seconds);
1031 bool dump_complete = (status == OK);
1032 dumpsys.stopDumpThread(dump_complete);
1033 }
1034 section_reporter.setStatus(status);
1035
1036 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1037 std::chrono::steady_clock::now() - start);
1038 if (elapsed_duration > timeout) {
1039 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1040 elapsed_duration.count());
1041 break;
1042 }
1043 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001044 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001045}
1046
Vishnu Nair64afc022018-02-01 15:29:34 -08001047static void RunDumpsysText(const std::string& title, int priority,
1048 std::chrono::milliseconds timeout,
1049 std::chrono::milliseconds service_timeout) {
1050 DurationReporter duration_reporter(title);
1051 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1052 fsync(STDOUT_FILENO);
1053 RunDumpsysTextByPriority(title, priority, timeout, service_timeout);
1054}
1055
1056/* Dump all services registered with Normal or Default priority. */
Nandana Dutt5c390032019-03-12 10:52:56 +00001057static Dumpstate::RunStatus RunDumpsysTextNormalPriority(const std::string& title,
1058 std::chrono::milliseconds timeout,
1059 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001060 DurationReporter duration_reporter(title);
1061 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1062 fsync(STDOUT_FILENO);
1063 RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_NORMAL, timeout,
1064 service_timeout);
Nandana Dutt5c390032019-03-12 10:52:56 +00001065
1066 RETURN_IF_USER_DENIED_CONSENT();
1067
1068 return RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_DEFAULT, timeout,
1069 service_timeout);
Vishnu Nair64afc022018-02-01 15:29:34 -08001070}
1071
Nandana Dutt5c390032019-03-12 10:52:56 +00001072static Dumpstate::RunStatus RunDumpsysProto(const std::string& title, int priority,
1073 std::chrono::milliseconds timeout,
1074 std::chrono::milliseconds service_timeout) {
Luis Hector Chavez1e27b082018-03-22 15:36:42 -07001075 if (!ds.IsZipping()) {
1076 MYLOGD("Not dumping %s because it's not a zipped bugreport\n", title.c_str());
Nandana Dutt5c390032019-03-12 10:52:56 +00001077 return Dumpstate::RunStatus::OK;
Luis Hector Chavez1e27b082018-03-22 15:36:42 -07001078 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001079 sp<android::IServiceManager> sm = defaultServiceManager();
1080 Dumpsys dumpsys(sm.get());
1081 Vector<String16> args;
1082 Dumpsys::setServiceArgs(args, /* asProto = */ true, priority);
1083 DurationReporter duration_reporter(title);
1084
1085 auto start = std::chrono::steady_clock::now();
1086 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ true);
1087 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001088 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001089 std::string path(kProtoPath);
1090 path.append(String8(service).c_str());
1091 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL) {
1092 path.append("_CRITICAL");
1093 } else if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH) {
1094 path.append("_HIGH");
1095 }
1096 path.append(kProtoExt);
1097 DumpstateSectionReporter section_reporter(path, ds.listener_, ds.report_section_);
1098 status_t status = dumpsys.startDumpThread(service, args);
1099 if (status == OK) {
1100 status = ds.AddZipEntryFromFd(path, dumpsys.getDumpFd(), service_timeout);
1101 bool dumpTerminated = (status == OK);
1102 dumpsys.stopDumpThread(dumpTerminated);
1103 }
1104 ZipWriter::FileEntry file_entry;
1105 ds.zip_writer_->GetLastEntry(&file_entry);
1106 section_reporter.setSize(file_entry.compressed_size);
1107 section_reporter.setStatus(status);
1108
1109 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1110 std::chrono::steady_clock::now() - start);
1111 if (elapsed_duration > timeout) {
1112 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1113 elapsed_duration.count());
1114 break;
1115 }
1116 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001117 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001118}
1119
Nandana Dutta7db6342018-11-21 14:53:34 +00001120// Runs dumpsys on services that must dump first and will take less than 100ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001121static Dumpstate::RunStatus RunDumpsysCritical() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001122 RunDumpsysText("DUMPSYS CRITICAL", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1123 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Nandana Dutt5c390032019-03-12 10:52:56 +00001124
1125 RETURN_IF_USER_DENIED_CONSENT();
1126
1127 return RunDumpsysProto("DUMPSYS CRITICAL PROTO", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1128 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Vishnu Nair780b1282017-10-10 13:57:24 -07001129}
1130
1131// Runs dumpsys on services that must dump first but can take up to 250ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001132static Dumpstate::RunStatus RunDumpsysHigh() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001133 // TODO meminfo takes ~10s, connectivity takes ~5sec to dump. They are both
1134 // high priority. Reduce timeout once they are able to dump in a shorter time or
1135 // moved to a parallel task.
1136 RunDumpsysText("DUMPSYS HIGH", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1137 /* timeout= */ 90s, /* service_timeout= */ 30s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001138
1139 RETURN_IF_USER_DENIED_CONSENT();
1140
1141 return RunDumpsysProto("DUMPSYS HIGH PROTO", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1142 /* timeout= */ 5s, /* service_timeout= */ 1s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001143}
1144
1145// Runs dumpsys on services that must dump but can take up to 10s to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001146static Dumpstate::RunStatus RunDumpsysNormal() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001147 RunDumpsysTextNormalPriority("DUMPSYS", /* timeout= */ 90s, /* service_timeout= */ 10s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001148
1149 RETURN_IF_USER_DENIED_CONSENT();
1150
1151 return RunDumpsysProto("DUMPSYS PROTO", IServiceManager::DUMP_FLAG_PRIORITY_NORMAL,
1152 /* timeout= */ 90s, /* service_timeout= */ 10s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001153}
1154
Steven Moreland44cd9482018-01-04 16:24:13 -08001155static void DumpHals() {
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001156 if (!ds.IsZipping()) {
1157 RunCommand("HARDWARE HALS", {"lshal", "-lVSietrpc", "--types=b,c,l,z", "--debug"},
1158 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build());
1159 return;
1160 }
1161 DurationReporter duration_reporter("DUMP HALS");
1162 RunCommand("HARDWARE HALS", {"lshal", "-lVSietrpc", "--types=b,c,l,z"},
Greg Kaiser3dfeda32019-05-16 10:32:51 -07001163 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build());
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001164
Steven Moreland44cd9482018-01-04 16:24:13 -08001165 using android::hidl::manager::V1_0::IServiceManager;
1166 using android::hardware::defaultServiceManager;
1167
1168 sp<IServiceManager> sm = defaultServiceManager();
1169 if (sm == nullptr) {
1170 MYLOGE("Could not retrieve hwservicemanager to dump hals.\n");
1171 return;
1172 }
1173
1174 auto ret = sm->list([&](const auto& interfaces) {
1175 for (const std::string& interface : interfaces) {
1176 std::string cleanName = interface;
1177 std::replace_if(cleanName.begin(),
1178 cleanName.end(),
1179 [](char c) {
1180 return !isalnum(c) &&
1181 std::string("@-_:.").find(c) == std::string::npos;
1182 }, '_');
Nandana Dutt979388e2018-11-30 16:48:55 +00001183 const std::string path = ds.bugreport_internal_dir_ + "/lshal_debug_" + cleanName;
Steven Moreland44cd9482018-01-04 16:24:13 -08001184
1185 {
1186 auto fd = android::base::unique_fd(
1187 TEMP_FAILURE_RETRY(open(path.c_str(),
1188 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1189 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1190 if (fd < 0) {
1191 MYLOGE("Could not open %s to dump additional hal information.\n", path.c_str());
1192 continue;
1193 }
1194 RunCommandToFd(fd,
1195 "",
Steven Morelandc81cd3c2018-01-18 14:36:26 -08001196 {"lshal", "debug", "-E", interface},
Steven Moreland44cd9482018-01-04 16:24:13 -08001197 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
1198
1199 bool empty = 0 == lseek(fd, 0, SEEK_END);
1200 if (!empty) {
1201 ds.AddZipEntry("lshal-debug/" + cleanName + ".txt", path);
1202 }
1203 }
1204
1205 unlink(path.c_str());
1206 }
1207 });
1208
1209 if (!ret.isOk()) {
1210 MYLOGE("Could not list hals from hwservicemanager.\n");
1211 }
1212}
1213
Nandana Dutt5c390032019-03-12 10:52:56 +00001214// Dumps various things. Returns early with status USER_CONSENT_DENIED if user denies consent
1215// via the consent they are shown. Ignores other errors that occur while running various
1216// commands. The consent checking is currently done around long running tasks, which happen to
1217// be distributed fairly evenly throughout the function.
1218static Dumpstate::RunStatus dumpstate() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001219 DurationReporter duration_reporter("DUMPSTATE");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001220
Nandana Dutt5c390032019-03-12 10:52:56 +00001221 // Dump various things. Note that anything that takes "long" (i.e. several seconds) should
1222 // check intermittently (if it's intrerruptable like a foreach on pids) and/or should be wrapped
1223 // in a consent check (via RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK).
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -07001224 dump_dev_files("TRUSTY VERSION", "/sys/bus/platform/drivers/trusty", "trusty_version");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001225 RunCommand("UPTIME", {"uptime"});
Wei Wang509bb5d2017-06-09 14:42:12 -07001226 DumpBlockStatFiles();
Mark Salyzyn8c8130e2015-12-09 11:21:28 -08001227 dump_emmc_ecsd("/d/mmc0/mmc0:0001/ext_csd");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001228 DumpFile("MEMORY INFO", "/proc/meminfo");
1229 RunCommand("CPU INFO", {"top", "-b", "-n", "1", "-H", "-s", "6", "-o",
Felipe Leme30dbfa12016-09-02 12:43:26 -07001230 "pid,tid,user,pr,ni,%cpu,s,virt,res,pcy,cmd,name"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001231
1232 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "PROCRANK", {"procrank"}, AS_ROOT_20);
1233
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001234 DumpFile("VIRTUAL MEMORY STATS", "/proc/vmstat");
1235 DumpFile("VMALLOC INFO", "/proc/vmallocinfo");
1236 DumpFile("SLAB INFO", "/proc/slabinfo");
1237 DumpFile("ZONEINFO", "/proc/zoneinfo");
1238 DumpFile("PAGETYPEINFO", "/proc/pagetypeinfo");
1239 DumpFile("BUDDYINFO", "/proc/buddyinfo");
1240 DumpFile("FRAGMENTATION INFO", "/d/extfrag/unusable_index");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001241
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001242 DumpFile("KERNEL WAKE SOURCES", "/d/wakeup_sources");
1243 DumpFile("KERNEL CPUFREQ", "/sys/devices/system/cpu/cpu0/cpufreq/stats/time_in_state");
1244 DumpFile("KERNEL SYNC", "/d/sync");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001245
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001246 RunCommand("PROCESSES AND THREADS",
Yohei Yukawa591a72d2017-10-05 21:36:35 -07001247 {"ps", "-A", "-T", "-Z", "-O", "pri,nice,rtprio,sched,pcy,time"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001248
1249 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "LIBRANK", {"librank"},
1250 CommandOptions::AS_ROOT);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001251
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001252 DumpHals();
Steven Moreland81b429e2017-01-31 19:50:46 -08001253
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001254 RunCommand("PRINTENV", {"printenv"});
Elliott Hughes21b7c8d2016-10-28 08:53:02 -07001255 RunCommand("NETSTAT", {"netstat", "-nW"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001256 struct stat s;
1257 if (stat("/proc/modules", &s) != 0) {
1258 MYLOGD("Skipping 'lsmod' because /proc/modules does not exist\n");
1259 } else {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001260 RunCommand("LSMOD", {"lsmod"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001261 }
Michal Karpinski4db754f2015-12-11 18:04:32 +00001262
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001263 if (__android_logger_property_get_bool(
1264 "ro.logd.kernel", BOOL_DEFAULT_TRUE | BOOL_DEFAULT_FLAG_ENG | BOOL_DEFAULT_FLAG_SVELTE)) {
1265 DoKernelLogcat();
1266 } else {
1267 do_dmesg();
1268 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001269
Felipe Lemef0292972016-11-22 13:57:05 -08001270 RunCommand("LIST OF OPEN FILES", {"lsof"}, CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001271
1272 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(for_each_pid, do_showmap, "SMAPS OF ALL PROCESSES");
1273
Jeff Brown1dc94e32014-09-11 14:15:27 -07001274 for_each_tid(show_wchan, "BLOCKED PROCESS WAIT-CHANNELS");
Mark Salyzyna297c322016-02-05 15:33:17 -08001275 for_each_pid(show_showtime, "PROCESS TIMES (pid cmd user system iowait+percentage)");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001276
Ajay Panicker2ff8e872017-04-27 14:04:32 -07001277 /* Dump Bluetooth HCI logs */
1278 ds.AddDir("/data/misc/bluetooth/logs", true);
Ajay Panickerd886ec42016-09-14 12:26:46 -07001279
Greg Kaiser3ddc3fa2019-05-23 16:14:52 -07001280 if (ds.options_->do_fb && !ds.do_early_screenshot_) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001281 MYLOGI("taking late screenshot\n");
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001282 ds.TakeScreenshot();
Jeff Sharkey5a930032013-03-19 15:05:19 -07001283 }
1284
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001285 DoLogcat();
Mark Salyzynecc07632015-07-30 14:57:09 -07001286
Felipe Lemee184f662016-10-27 10:04:47 -07001287 AddAnrTraceFiles();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001288
Narayan Kamath8f788292017-05-25 13:20:39 +01001289 // NOTE: tombstones are always added as separate entries in the zip archive
1290 // and are not interspersed with the main report.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001291 const bool tombstones_dumped = AddDumps(ds.tombstone_data_.begin(), ds.tombstone_data_.end(),
Narayan Kamathbd863722017-06-01 18:50:12 +01001292 "TOMBSTONE", true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001293 if (!tombstones_dumped) {
1294 printf("*** NO TOMBSTONES to dump in %s\n\n", TOMBSTONE_DIR.c_str());
Christopher Ferris7dc7f322014-07-22 16:08:19 -07001295 }
1296
Jayachandran Ca94c7172017-06-10 15:08:12 -07001297 DumpPacketStats();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001298
Chenbo Feng276a3b62018-08-07 11:44:49 -07001299 RunDumpsys("EBPF MAP STATS", {"netd", "trafficcontroller"});
1300
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001301 DoKmsg();
Mark Salyzyn2262c162014-12-16 09:09:26 -08001302
Jayachandran Ca94c7172017-06-10 15:08:12 -07001303 DumpIpAddrAndRules();
Sreeram Ramachandran2b3bba32014-07-08 15:40:55 -07001304
1305 dump_route_tables();
1306
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001307 RunCommand("ARP CACHE", {"ip", "-4", "neigh", "show"});
1308 RunCommand("IPv6 ND CACHE", {"ip", "-6", "neigh", "show"});
1309 RunCommand("MULTICAST ADDRESSES", {"ip", "maddr"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001310
Nandana Dutt5c390032019-03-12 10:52:56 +00001311 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysHigh);
Lorenzo Colitti6afc38c2015-09-09 22:59:25 +09001312
Elliott Hughes23ccc622017-02-28 10:14:22 -08001313 RunCommand("SYSTEM PROPERTIES", {"getprop"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001314
Jin Qianf334d662017-10-10 14:41:37 -07001315 RunCommand("STORAGED IO INFO", {"storaged", "-u", "-p"});
ynwangf649a6e2016-07-17 21:56:00 -07001316
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001317 RunCommand("FILESYSTEMS & FREE SPACE", {"df"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001318
Colin Crossf45fa6b2012-03-26 12:38:26 -07001319 /* Binder state is expensive to look at as it uses a lot of memory. */
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001320 DumpFile("BINDER FAILED TRANSACTION LOG", "/sys/kernel/debug/binder/failed_transaction_log");
1321 DumpFile("BINDER TRANSACTION LOG", "/sys/kernel/debug/binder/transaction_log");
1322 DumpFile("BINDER TRANSACTIONS", "/sys/kernel/debug/binder/transactions");
1323 DumpFile("BINDER STATS", "/sys/kernel/debug/binder/stats");
1324 DumpFile("BINDER STATE", "/sys/kernel/debug/binder/state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001325
Vishnu Nair36b4cdb2017-11-17 10:27:05 -08001326 /* Add window and surface trace files. */
1327 if (!PropertiesHelper::IsUserBuild()) {
1328 ds.AddDir(WMTRACE_DATA_DIR, false);
1329 }
1330
Nandana Dutt5c390032019-03-12 10:52:56 +00001331 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(ds.DumpstateBoard);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001332
Steven Moreland7440ddb2016-12-15 16:13:39 -08001333 /* Migrate the ril_dumpstate to a device specific dumpstate? */
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001334 int rilDumpstateTimeout = android::base::GetIntProperty("ril.dumpstate.timeout", 0);
1335 if (rilDumpstateTimeout > 0) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001336 // su does not exist on user builds, so try running without it.
1337 // This way any implementations of vril-dump that do not require
1338 // root can run on user builds.
1339 CommandOptions::CommandOptionsBuilder options =
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001340 CommandOptions::WithTimeout(rilDumpstateTimeout);
Felipe Lemef0292972016-11-22 13:57:05 -08001341 if (!PropertiesHelper::IsUserBuild()) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001342 options.AsRoot();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001343 }
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001344 RunCommand("DUMP VENDOR RIL LOGS", {"vril-dump"}, options.Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -07001345 }
1346
Felipe Lemed8b94e52016-12-08 10:21:44 -08001347 printf("========================================================\n");
1348 printf("== Android Framework Services\n");
1349 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001350
Nandana Dutt5c390032019-03-12 10:52:56 +00001351 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysNormal);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001352
Felipe Lemed8b94e52016-12-08 10:21:44 -08001353 printf("========================================================\n");
1354 printf("== Checkins\n");
1355 printf("========================================================\n");
Dianne Hackborn02bea972013-06-26 18:59:09 -07001356
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001357 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001358
1359 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsys, "CHECKIN MEMINFO", {"meminfo", "--checkin"});
1360
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001361 RunDumpsys("CHECKIN NETSTATS", {"netstats", "--checkin"});
1362 RunDumpsys("CHECKIN PROCSTATS", {"procstats", "-c"});
1363 RunDumpsys("CHECKIN USAGESTATS", {"usagestats", "-c"});
1364 RunDumpsys("CHECKIN PACKAGE", {"package", "--checkin"});
Dianne Hackborn02bea972013-06-26 18:59:09 -07001365
Felipe Lemed8b94e52016-12-08 10:21:44 -08001366 printf("========================================================\n");
1367 printf("== Running Application Activities\n");
1368 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001369
Makoto Onuki60780982018-04-16 15:34:00 -07001370 // The following dumpsys internally collects output from running apps, so it can take a long
1371 // time. So let's extend the timeout.
1372
1373 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
1374
1375 RunDumpsys("APP ACTIVITIES", {"activity", "-v", "all"}, DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001376
Felipe Lemed8b94e52016-12-08 10:21:44 -08001377 printf("========================================================\n");
Makoto Onuki60780982018-04-16 15:34:00 -07001378 printf("== Running Application Services (platform)\n");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001379 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001380
Vishnu Nairc6e6ea72018-07-02 14:20:06 -07001381 RunDumpsys("APP SERVICES PLATFORM", {"activity", "service", "all-platform-non-critical"},
Makoto Onuki60780982018-04-16 15:34:00 -07001382 DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001383
Felipe Lemed8b94e52016-12-08 10:21:44 -08001384 printf("========================================================\n");
Makoto Onuki60780982018-04-16 15:34:00 -07001385 printf("== Running Application Services (non-platform)\n");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001386 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001387
Makoto Onuki60780982018-04-16 15:34:00 -07001388 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1389 DUMPSYS_COMPONENTS_OPTIONS);
1390
1391 printf("========================================================\n");
1392 printf("== Running Application Providers (platform)\n");
1393 printf("========================================================\n");
1394
1395 RunDumpsys("APP PROVIDERS PLATFORM", {"activity", "provider", "all-platform"},
1396 DUMPSYS_COMPONENTS_OPTIONS);
1397
1398 printf("========================================================\n");
1399 printf("== Running Application Providers (non-platform)\n");
1400 printf("========================================================\n");
1401
1402 RunDumpsys("APP PROVIDERS NON-PLATFORM", {"activity", "provider", "all-non-platform"},
1403 DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001404
Adrian Roos8b397ab2017-04-04 16:35:44 -07001405 printf("========================================================\n");
1406 printf("== Dropbox crashes\n");
1407 printf("========================================================\n");
1408
1409 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1410 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1411
Felipe Lemed8b94e52016-12-08 10:21:44 -08001412 printf("========================================================\n");
1413 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1414 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1415 printf("========================================================\n");
1416 printf("== dumpstate: done (id %d)\n", ds.id_);
1417 printf("========================================================\n");
Bookatz38472142018-09-28 10:20:24 -07001418
1419 printf("========================================================\n");
1420 printf("== Obtaining statsd metadata\n");
1421 printf("========================================================\n");
1422 // This differs from the usual dumpsys stats, which is the stats report data.
1423 RunDumpsys("STATSDSTATS", {"stats", "--metadata"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001424 return Dumpstate::RunStatus::OK;
Colin Crossf45fa6b2012-03-26 12:38:26 -07001425}
1426
Nandana Dutt5c390032019-03-12 10:52:56 +00001427/*
1428 * Dumps state for the default case; drops root after it's no longer necessary.
1429 *
1430 * Returns RunStatus::OK if everything went fine.
1431 * Returns RunStatus::ERROR if there was an error.
1432 * Returns RunStatus::USER_DENIED_CONSENT if user explicitly denied consent to sharing the bugreport
1433 * with the caller.
1434 */
1435static Dumpstate::RunStatus DumpstateDefault() {
Nandana Duttcf419a72019-03-14 10:40:17 +00001436 // Invoking the following dumpsys calls before DumpTraces() to try and
Nandana Dutt4be45d12018-09-26 15:04:23 +01001437 // keep the system stats as close to its initial state as possible.
Nandana Dutt5c390032019-03-12 10:52:56 +00001438 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysCritical);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001439
1440 /* collect stack traces from Dalvik and native processes (needs root) */
Nandana Duttcf419a72019-03-14 10:40:17 +00001441 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(ds.DumpTraces, &dump_traces_path);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001442
1443 /* Run some operations that require root. */
1444 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX, !ds.IsZipping());
1445 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX, !ds.IsZipping());
1446
1447 ds.AddDir(RECOVERY_DIR, true);
1448 ds.AddDir(RECOVERY_DATA_DIR, true);
1449 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
1450 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1451 if (!PropertiesHelper::IsUserBuild()) {
1452 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1453 ds.AddDir(PROFILE_DATA_DIR_REF, true);
1454 }
1455 add_mountinfo();
1456 DumpIpTablesAsRoot();
1457
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001458 // Capture any IPSec policies in play. No keys are exposed here.
Nandana Dutt4be45d12018-09-26 15:04:23 +01001459 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1460
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001461 // Dump IPsec stats. No keys are exposed here.
1462 DumpFile("XFRM STATS", XFRM_STAT_PROC_FILE);
1463
Nandana Dutt4be45d12018-09-26 15:04:23 +01001464 // Run ss as root so we can see socket marks.
1465 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
1466
1467 // Run iotop as root to show top 100 IO threads
1468 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
1469
Erick Reyese68df822019-02-11 14:46:36 -08001470 // Gather shared memory buffer info if the product implements it
1471 struct stat st;
1472 if (!stat("/product/bin/dmabuf_dump", &st)) {
1473 RunCommand("Dmabuf dump", {"/product/bin/dmabuf_dump"});
1474 }
1475
Nandana Dutt4be45d12018-09-26 15:04:23 +01001476 if (!DropRootUser()) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001477 return Dumpstate::RunStatus::ERROR;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001478 }
1479
Nandana Dutt5c390032019-03-12 10:52:56 +00001480 RETURN_IF_USER_DENIED_CONSENT();
1481 return dumpstate();
Nandana Dutt4be45d12018-09-26 15:04:23 +01001482}
1483
mukesh agrawal253dad42018-01-23 21:59:59 -08001484// This method collects common dumpsys for telephony and wifi
1485static void DumpstateRadioCommon() {
Jayachandran Ca94c7172017-06-10 15:08:12 -07001486 DumpIpTablesAsRoot();
1487
1488 if (!DropRootUser()) {
1489 return;
1490 }
1491
1492 do_dmesg();
1493 DoLogcat();
1494 DumpPacketStats();
1495 DoKmsg();
1496 DumpIpAddrAndRules();
1497 dump_route_tables();
1498
1499 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
1500 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08001501}
1502
1503// This method collects dumpsys for telephony debugging only
1504static void DumpstateTelephonyOnly() {
1505 DurationReporter duration_reporter("DUMPSTATE");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001506 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08001507
1508 DumpstateRadioCommon();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001509
1510 RunCommand("SYSTEM PROPERTIES", {"getprop"});
1511
1512 printf("========================================================\n");
1513 printf("== Android Framework Services\n");
1514 printf("========================================================\n");
1515
Vishnu Nair652cc802017-11-30 15:18:30 -08001516 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1517 SEC_TO_MSEC(10));
Chiachang Wang85e0db32019-03-25 08:59:55 +08001518 RunDumpsys("DUMPSYS", {"connmetrics"}, CommandOptions::WithTimeout(90).Build(),
1519 SEC_TO_MSEC(10));
1520 RunDumpsys("DUMPSYS", {"netd"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Vishnu Nair652cc802017-11-30 15:18:30 -08001521 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
1522 SEC_TO_MSEC(10));
Amruth Ramachandrand25a9142018-04-02 16:16:09 -07001523 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
1524 SEC_TO_MSEC(10));
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07001525 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
1526 SEC_TO_MSEC(10));
Jayachandran Ca94c7172017-06-10 15:08:12 -07001527
1528 printf("========================================================\n");
1529 printf("== Running Application Services\n");
1530 printf("========================================================\n");
1531
1532 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
1533
1534 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001535 printf("== Running Application Services (non-platform)\n");
1536 printf("========================================================\n");
1537
1538 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1539 DUMPSYS_COMPONENTS_OPTIONS);
1540
1541 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07001542 printf("== Checkins\n");
1543 printf("========================================================\n");
1544
1545 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
1546
1547 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07001548 printf("== dumpstate: done (id %d)\n", ds.id_);
1549 printf("========================================================\n");
1550}
1551
mukesh agrawal253dad42018-01-23 21:59:59 -08001552// This method collects dumpsys for wifi debugging only
1553static void DumpstateWifiOnly() {
1554 DurationReporter duration_reporter("DUMPSTATE");
1555
1556 DumpstateRadioCommon();
1557
1558 printf("========================================================\n");
1559 printf("== Android Framework Services\n");
1560 printf("========================================================\n");
1561
1562 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1563 SEC_TO_MSEC(10));
1564 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
1565 SEC_TO_MSEC(10));
1566
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001567 DumpHals();
Roger Wang70399032019-01-08 16:10:37 +08001568
mukesh agrawal253dad42018-01-23 21:59:59 -08001569 printf("========================================================\n");
1570 printf("== dumpstate: done (id %d)\n", ds.id_);
1571 printf("========================================================\n");
1572}
1573
Nandana Duttcf419a72019-03-14 10:40:17 +00001574Dumpstate::RunStatus Dumpstate::DumpTraces(const char** path) {
Nandana Duttfaafd522019-03-11 09:23:09 +00001575 DurationReporter duration_reporter("DUMP TRACES");
1576
1577 const std::string temp_file_pattern = "/data/anr/dumptrace_XXXXXX";
1578 const size_t buf_size = temp_file_pattern.length() + 1;
1579 std::unique_ptr<char[]> file_name_buf(new char[buf_size]);
1580 memcpy(file_name_buf.get(), temp_file_pattern.c_str(), buf_size);
1581
1582 // Create a new, empty file to receive all trace dumps.
1583 //
1584 // TODO: This can be simplified once we remove support for the old style
1585 // dumps. We can have a file descriptor passed in to dump_traces instead
1586 // of creating a file, closing it and then reopening it again.
1587 android::base::unique_fd fd(mkostemp(file_name_buf.get(), O_APPEND | O_CLOEXEC));
1588 if (fd < 0) {
1589 MYLOGE("mkostemp on pattern %s: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001590 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001591 }
1592
1593 // Nobody should have access to this temporary file except dumpstate, but we
1594 // temporarily grant 'read' to 'others' here because this file is created
1595 // when tombstoned is still running as root, but dumped after dropping. This
1596 // can go away once support for old style dumping has.
1597 const int chmod_ret = fchmod(fd, 0666);
1598 if (chmod_ret < 0) {
1599 MYLOGE("fchmod on %s failed: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001600 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001601 }
1602
1603 std::unique_ptr<DIR, decltype(&closedir)> proc(opendir("/proc"), closedir);
1604 if (proc.get() == nullptr) {
1605 MYLOGE("opendir /proc failed: %s\n", strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001606 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001607 }
1608
1609 // Number of times process dumping has timed out. If we encounter too many
1610 // failures, we'll give up.
1611 int timeout_failures = 0;
1612 bool dalvik_found = false;
1613
1614 const std::set<int> hal_pids = get_interesting_hal_pids();
1615
1616 struct dirent* d;
1617 while ((d = readdir(proc.get()))) {
Nandana Duttcf419a72019-03-14 10:40:17 +00001618 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttfaafd522019-03-11 09:23:09 +00001619 int pid = atoi(d->d_name);
1620 if (pid <= 0) {
1621 continue;
1622 }
1623
1624 const std::string link_name = android::base::StringPrintf("/proc/%d/exe", pid);
1625 std::string exe;
1626 if (!android::base::Readlink(link_name, &exe)) {
1627 continue;
1628 }
1629
1630 bool is_java_process;
1631 if (exe == "/system/bin/app_process32" || exe == "/system/bin/app_process64") {
1632 // Don't bother dumping backtraces for the zygote.
1633 if (IsZygote(pid)) {
1634 continue;
1635 }
1636
1637 dalvik_found = true;
1638 is_java_process = true;
1639 } else if (should_dump_native_traces(exe.c_str()) || hal_pids.find(pid) != hal_pids.end()) {
1640 is_java_process = false;
1641 } else {
1642 // Probably a native process we don't care about, continue.
1643 continue;
1644 }
1645
1646 // If 3 backtrace dumps fail in a row, consider debuggerd dead.
1647 if (timeout_failures == 3) {
1648 dprintf(fd, "ERROR: Too many stack dump failures, exiting.\n");
1649 break;
1650 }
1651
1652 const uint64_t start = Nanotime();
1653 const int ret = dump_backtrace_to_file_timeout(
1654 pid, is_java_process ? kDebuggerdJavaBacktrace : kDebuggerdNativeBacktrace,
1655 is_java_process ? 5 : 20, fd);
1656
1657 if (ret == -1) {
1658 // For consistency, the header and footer to this message match those
1659 // dumped by debuggerd in the success case.
1660 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
1661 dprintf(fd, "Dump failed, likely due to a timeout.\n");
1662 dprintf(fd, "---- end %d ----", pid);
1663 timeout_failures++;
1664 continue;
1665 }
1666
1667 // We've successfully dumped stack traces, reset the failure count
1668 // and write a summary of the elapsed time to the file and continue with the
1669 // next process.
1670 timeout_failures = 0;
1671
1672 dprintf(fd, "[dump %s stack %d: %.3fs elapsed]\n", is_java_process ? "dalvik" : "native",
1673 pid, (float)(Nanotime() - start) / NANOS_PER_SEC);
1674 }
1675
1676 if (!dalvik_found) {
1677 MYLOGE("Warning: no Dalvik processes found to dump stacks\n");
1678 }
1679
Nandana Duttcf419a72019-03-14 10:40:17 +00001680 *path = file_name_buf.release();
1681 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001682}
1683
Felipe Leme6f674ae2016-11-18 17:10:33 -08001684void Dumpstate::DumpstateBoard() {
1685 DurationReporter duration_reporter("dumpstate_board()");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001686 printf("========================================================\n");
1687 printf("== Board\n");
1688 printf("========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001689
Felipe Leme6f674ae2016-11-18 17:10:33 -08001690 if (!IsZipping()) {
Steven Moreland7440ddb2016-12-15 16:13:39 -08001691 MYLOGD("Not dumping board info because it's not a zipped bugreport\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001692 return;
1693 }
1694
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001695 std::vector<std::string> paths;
1696 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07001697 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00001698 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
1699 kDumpstateBoardFiles[i].c_str()));
Nandana Dutt16d1aee2019-02-15 16:13:53 +00001700 remover.emplace_back(android::base::make_scope_guard(
1701 std::bind([](std::string path) { android::os::UnlinkAndLogOnError(path); }, paths[i])));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001702 }
Jie Song9fbfad02017-06-20 16:29:42 -07001703
Wei Wang587eac92018-04-05 12:17:20 -07001704 sp<IDumpstateDevice> dumpstate_device(IDumpstateDevice::getService());
1705 if (dumpstate_device == nullptr) {
1706 MYLOGE("No IDumpstateDevice implementation\n");
1707 return;
1708 }
1709
1710 using ScopedNativeHandle =
1711 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
1712 ScopedNativeHandle handle(native_handle_create(static_cast<int>(paths.size()), 0),
1713 [](native_handle_t* handle) {
1714 native_handle_close(handle);
1715 native_handle_delete(handle);
1716 });
1717 if (handle == nullptr) {
1718 MYLOGE("Could not create native_handle\n");
1719 return;
1720 }
1721
Nandana Dutt5c390032019-03-12 10:52:56 +00001722 // TODO(128270426): Check for consent in between?
Wei Wang587eac92018-04-05 12:17:20 -07001723 for (size_t i = 0; i < paths.size(); i++) {
1724 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
1725
1726 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
1727 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1728 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1729 if (fd < 0) {
1730 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
1731 return;
1732 }
1733 handle.get()->data[i] = fd.release();
1734 }
1735
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001736 // Given that bugreport is required to diagnose failures, it's better to
Wei Wang587eac92018-04-05 12:17:20 -07001737 // set an arbitrary amount of timeout for IDumpstateDevice than to block the
1738 // rest of bugreport. In the timeout case, we will kill dumpstate board HAL
1739 // and grab whatever dumped
1740 std::packaged_task<bool()>
1741 dumpstate_task([paths, dumpstate_device, &handle]() -> bool {
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001742 android::hardware::Return<void> status = dumpstate_device->dumpstateBoard(handle.get());
1743 if (!status.isOk()) {
1744 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
Wei Wang587eac92018-04-05 12:17:20 -07001745 return false;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001746 }
Wei Wang587eac92018-04-05 12:17:20 -07001747 return true;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001748 });
Wei Wang587eac92018-04-05 12:17:20 -07001749
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001750 auto result = dumpstate_task.get_future();
1751 std::thread(std::move(dumpstate_task)).detach();
Wei Wang587eac92018-04-05 12:17:20 -07001752
1753 constexpr size_t timeout_sec = 30;
1754 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
1755 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate vendor HAL\n", timeout_sec);
1756 if (!android::base::SetProperty("ctl.interface_restart",
1757 android::base::StringPrintf("%s/default",
1758 IDumpstateDevice::descriptor))) {
1759 MYLOGE("Couldn't restart dumpstate HAL\n");
1760 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001761 }
Wei Wang587eac92018-04-05 12:17:20 -07001762 // Wait some time for init to kill dumpstate vendor HAL
1763 constexpr size_t killing_timeout_sec = 10;
1764 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
1765 MYLOGE("killing dumpstateBoard timed out after %zus, continue and "
1766 "there might be racing in content\n", killing_timeout_sec);
1767 }
1768
1769 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
1770 for (size_t i = 0; i < paths.size(); i++) {
1771 struct stat s;
1772 if (fstat(handle.get()->data[i], &s) == -1) {
1773 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(),
1774 strerror(errno));
1775 file_sizes[i] = -1;
1776 continue;
1777 }
1778 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001779 }
1780
1781 for (size_t i = 0; i < paths.size(); i++) {
1782 if (file_sizes[i] == -1) {
1783 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07001784 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001785 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07001786 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001787 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07001788 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001789 AddZipEntry(kDumpstateBoardFiles[i], paths[i]);
Jie Song9fbfad02017-06-20 16:29:42 -07001790 }
1791
Felipe Lemed8b94e52016-12-08 10:21:44 -08001792 printf("*** See dumpstate-board.txt entry ***\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001793}
1794
Nandana Dutt12ae14a2019-01-09 10:35:53 +00001795static void ShowUsage() {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001796 fprintf(stderr,
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001797 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-d] [-p] "
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001798 "[-z]] [-s] [-S] [-q] [-B] [-P] [-R] [-V version]\n"
1799 " -h: display this help message\n"
1800 " -b: play sound file instead of vibrate, at beginning of job\n"
1801 " -e: play sound file instead of vibrate, at end of job\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001802 " -d: append date to filename\n"
1803 " -p: capture screenshot to filename.png\n"
1804 " -z: generate zipped file\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001805 " -s: write output to control socket (for init)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001806 " -S: write file location to control socket (for init; requires -z)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001807 " -q: disable vibrate\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001808 " -B: send broadcast when finished\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001809 " -P: send broadcast when started and update system properties on "
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001810 "progress (requires -B)\n"
1811 " -R: take bugreport in remote mode (requires -z, -d and -B, "
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001812 "shouldn't be used with -P)\n"
Nandana Dutt235864b2019-01-22 12:10:16 +00001813 " -w: start binder service and make it wait for a call to startBugreport\n"
Felipe Lemed071c682016-10-20 16:48:00 -07001814 " -v: prints the dumpstate header and exit\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001815}
1816
Wei Liuf87959e2016-08-26 14:51:42 -07001817static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07001818 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07001819}
1820
Felipe Leme1d486fe2016-10-14 18:06:47 -07001821bool Dumpstate::FinishZipFile() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001822 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07001823 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07001824 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07001825 // Final timestamp
1826 char date[80];
1827 time_t the_real_now_please_stand_up = time(nullptr);
1828 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07001829 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001830 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07001831
Felipe Leme9a523ae2016-10-20 15:10:33 -07001832 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001833 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08001834 return false;
1835 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07001836 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001837 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08001838 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08001839 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08001840
Felipe Leme0f3fb202016-06-10 17:10:53 -07001841 // Add log file (which contains stderr output) to zip...
1842 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07001843 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07001844 MYLOGE("Failed to add dumpstate log to .zip file\n");
1845 return false;
1846 }
Nandana Dutt979388e2018-11-30 16:48:55 +00001847 // TODO: Should truncate the existing file.
1848 // ... and re-open it for further logging.
Nandana Dutta344cb62019-02-22 15:12:35 +00001849 if (!redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()))) {
1850 return false;
1851 }
Felipe Leme0f3fb202016-06-10 17:10:53 -07001852 fprintf(stderr, "\n");
1853
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07001854 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07001855 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07001856 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08001857 return false;
1858 }
1859
Felipe Leme1d486fe2016-10-14 18:06:47 -07001860 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
1861 ds.zip_file.reset(nullptr);
1862
Felipe Lemee9d2c542016-11-15 11:48:26 -08001863 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
Nandana Dutt16d1aee2019-02-15 16:13:53 +00001864 android::os::UnlinkAndLogOnError(tmp_path_);
Felipe Lemec4eee562016-04-21 15:42:55 -07001865
Felipe Leme1e9edc62015-12-21 16:02:13 -08001866 return true;
1867}
Felipe Leme6e01fa62015-11-11 19:35:14 -08001868
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -07001869static std::string SHA256_file_hash(const std::string& filepath) {
Andreas Gampe27cd7b22016-07-18 18:24:05 -07001870 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(filepath.c_str(), O_RDONLY | O_NONBLOCK
1871 | O_CLOEXEC | O_NOFOLLOW)));
Andreas Gampeaff68432016-07-18 18:01:27 -07001872 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001873 MYLOGE("open(%s): %s\n", filepath.c_str(), strerror(errno));
Yi Kong19d5c002018-07-20 13:39:55 -07001874 return nullptr;
Michal Karpinski4db754f2015-12-11 18:04:32 +00001875 }
1876
1877 SHA256_CTX ctx;
Elliott Hughesc4dc1412016-04-12 16:28:31 -07001878 SHA256_Init(&ctx);
Michal Karpinski4db754f2015-12-11 18:04:32 +00001879
1880 std::vector<uint8_t> buffer(65536);
1881 while (1) {
1882 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd.get(), buffer.data(), buffer.size()));
1883 if (bytes_read == 0) {
1884 break;
1885 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001886 MYLOGE("read(%s): %s\n", filepath.c_str(), strerror(errno));
Yi Kong19d5c002018-07-20 13:39:55 -07001887 return nullptr;
Michal Karpinski4db754f2015-12-11 18:04:32 +00001888 }
1889
Elliott Hughesc4dc1412016-04-12 16:28:31 -07001890 SHA256_Update(&ctx, buffer.data(), bytes_read);
Michal Karpinski4db754f2015-12-11 18:04:32 +00001891 }
1892
Elliott Hughesc4dc1412016-04-12 16:28:31 -07001893 uint8_t hash[SHA256_DIGEST_LENGTH];
1894 SHA256_Final(hash, &ctx);
1895
1896 char hash_buffer[SHA256_DIGEST_LENGTH * 2 + 1];
1897 for(size_t i = 0; i < SHA256_DIGEST_LENGTH; i++) {
Michal Karpinskicbbdf732016-01-07 20:45:02 +00001898 sprintf(hash_buffer + (i * 2), "%02x", hash[i]);
Michal Karpinski4db754f2015-12-11 18:04:32 +00001899 }
1900 hash_buffer[sizeof(hash_buffer) - 1] = 0;
1901 return std::string(hash_buffer);
1902}
1903
Felipe Lemea4ef1f02017-02-15 17:27:40 -08001904static void SendBroadcast(const std::string& action, const std::vector<std::string>& args) {
1905 // clang-format off
1906 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user", "0",
1907 "--receiver-foreground", "--receiver-include-background", "-a", action};
1908 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08001909
1910 am.insert(am.end(), args.begin(), args.end());
1911
Felipe Leme8d2410e2017-02-08 09:46:08 -08001912 RunCommand("", am,
1913 CommandOptions::WithTimeout(20)
1914 .Log("Sending broadcast: '%s'\n")
1915 .Always()
1916 .DropRoot()
1917 .RedirectStderr()
1918 .Build());
1919}
1920
Felipe Leme35b8cf12017-02-10 15:47:29 -08001921static void Vibrate(int duration_ms) {
1922 // clang-format off
Chris Friese7e95fb2019-06-14 14:47:59 +00001923 RunCommand("", {"cmd", "vibrator", "vibrate", std::to_string(duration_ms), "dumpstate"},
Felipe Leme35b8cf12017-02-10 15:47:29 -08001924 CommandOptions::WithTimeout(10)
1925 .Log("Vibrate: '%s'\n")
1926 .Always()
1927 .Build());
1928 // clang-format on
1929}
1930
Nandana Dutt979388e2018-11-30 16:48:55 +00001931static void MaybeResolveSymlink(std::string* path) {
1932 std::string resolved_path;
1933 if (android::base::Readlink(*path, &resolved_path)) {
1934 *path = resolved_path;
1935 }
1936}
1937
Nandana Dutt4be45d12018-09-26 15:04:23 +01001938/*
1939 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
1940 * if we are writing zip files and adds the version file.
1941 */
1942static void PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00001943 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
1944
Nandana Dutt4be45d12018-09-26 15:04:23 +01001945 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
1946 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt9a76d202019-01-21 15:56:48 +00001947 ds.base_name_ = StringPrintf("bugreport-%s-%s", device_name.c_str(), build_id.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01001948 if (ds.options_->do_add_date) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01001949 char date[80];
1950 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
1951 ds.name_ = date;
1952 } else {
1953 ds.name_ = "undated";
1954 }
1955
Nandana Dutt5fb117b2018-09-27 09:23:36 +01001956 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01001957 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01001958 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01001959 ds.base_name_ += "-wifi";
1960 }
1961
Nandana Dutt5fb117b2018-09-27 09:23:36 +01001962 if (ds.options_->do_fb) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01001963 ds.screenshot_path_ = ds.GetPath(".png");
1964 }
1965 ds.tmp_path_ = ds.GetPath(".tmp");
1966 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
1967
Nandana Dutt54dbd672019-01-11 12:58:05 +00001968 std::string destination = ds.options_->bugreport_fd.get() != -1
1969 ? StringPrintf("[fd:%d]", ds.options_->bugreport_fd.get())
Nandana Dutt9a76d202019-01-21 15:56:48 +00001970 : ds.bugreport_internal_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01001971 MYLOGD(
1972 "Bugreport dir: %s\n"
1973 "Base name: %s\n"
1974 "Suffix: %s\n"
1975 "Log path: %s\n"
1976 "Temporary path: %s\n"
1977 "Screenshot path: %s\n",
Nandana Dutt9a76d202019-01-21 15:56:48 +00001978 destination.c_str(), ds.base_name_.c_str(), ds.name_.c_str(), ds.log_path_.c_str(),
1979 ds.tmp_path_.c_str(), ds.screenshot_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01001980
Nandana Dutt5fb117b2018-09-27 09:23:36 +01001981 if (ds.options_->do_zip_file) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01001982 ds.path_ = ds.GetPath(".zip");
1983 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
1984 create_parent_dirs(ds.path_.c_str());
1985 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
1986 if (ds.zip_file == nullptr) {
1987 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
1988 } else {
1989 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
1990 }
1991 ds.AddTextZipEntry("version.txt", ds.version_);
1992 }
1993}
1994
1995/*
1996 * Finalizes writing to the file by renaming or zipping the tmp file to the final location,
1997 * printing zipped file status, etc.
1998 */
1999static void FinalizeFile() {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002000 /* check if user changed the suffix using system properties */
2001 std::string name =
2002 android::base::GetProperty(android::base::StringPrintf("dumpstate.%d.name", ds.pid_), "");
2003 bool change_suffix = false;
2004 if (!name.empty()) {
2005 /* must whitelist which characters are allowed, otherwise it could cross directories */
2006 std::regex valid_regex("^[-_a-zA-Z0-9]+$");
2007 if (std::regex_match(name.c_str(), valid_regex)) {
2008 change_suffix = true;
2009 } else {
2010 MYLOGE("invalid suffix provided by user: %s\n", name.c_str());
2011 }
2012 }
2013 if (change_suffix) {
2014 MYLOGI("changing suffix from %s to %s\n", ds.name_.c_str(), name.c_str());
2015 ds.name_ = name;
2016 if (!ds.screenshot_path_.empty()) {
2017 std::string new_screenshot_path = ds.GetPath(".png");
2018 if (rename(ds.screenshot_path_.c_str(), new_screenshot_path.c_str())) {
2019 MYLOGE("rename(%s, %s): %s\n", ds.screenshot_path_.c_str(),
2020 new_screenshot_path.c_str(), strerror(errno));
2021 } else {
2022 ds.screenshot_path_ = new_screenshot_path;
2023 }
2024 }
2025 }
2026
2027 bool do_text_file = true;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002028 if (ds.options_->do_zip_file) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002029 if (!ds.FinishZipFile()) {
2030 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
2031 do_text_file = true;
2032 } else {
2033 do_text_file = false;
Nandana Dutt383d0c12018-11-30 15:54:56 +00002034 // If the user has changed the suffix, we need to change the zip file name.
2035 std::string new_path = ds.GetPath(".zip");
2036 if (ds.path_ != new_path) {
2037 MYLOGD("Renaming zip file from %s to %s\n", ds.path_.c_str(), new_path.c_str());
2038 if (rename(ds.path_.c_str(), new_path.c_str())) {
2039 MYLOGE("rename(%s, %s): %s\n", ds.path_.c_str(), new_path.c_str(),
2040 strerror(errno));
2041 } else {
2042 ds.path_ = new_path;
2043 }
2044 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01002045 }
2046 }
2047 if (do_text_file) {
2048 ds.path_ = ds.GetPath(".txt");
2049 MYLOGD("Generating .txt bugreport at %s from %s\n", ds.path_.c_str(), ds.tmp_path_.c_str());
2050 if (rename(ds.tmp_path_.c_str(), ds.path_.c_str())) {
2051 MYLOGE("rename(%s, %s): %s\n", ds.tmp_path_.c_str(), ds.path_.c_str(), strerror(errno));
2052 ds.path_.clear();
2053 }
2054 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002055 if (ds.options_->use_control_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002056 if (do_text_file) {
2057 dprintf(ds.control_socket_fd_,
2058 "FAIL:could not create zip file, check %s "
2059 "for more details\n",
2060 ds.log_path_.c_str());
2061 } else {
2062 dprintf(ds.control_socket_fd_, "OK:%s\n", ds.path_.c_str());
2063 }
2064 }
2065}
2066
2067/* Broadcasts that we are done with the bugreport */
2068static void SendBugreportFinishedBroadcast() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002069 // TODO(b/111441001): use callback instead of broadcast.
Nandana Dutt9a76d202019-01-21 15:56:48 +00002070 if (!ds.path_.empty()) {
2071 MYLOGI("Final bugreport path: %s\n", ds.path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002072 // clang-format off
2073
2074 std::vector<std::string> am_args = {
2075 "--receiver-permission", "android.permission.DUMP",
2076 "--ei", "android.intent.extra.ID", std::to_string(ds.id_),
2077 "--ei", "android.intent.extra.PID", std::to_string(ds.pid_),
2078 "--ei", "android.intent.extra.MAX", std::to_string(ds.progress_->GetMax()),
Nandana Dutt9a76d202019-01-21 15:56:48 +00002079 "--es", "android.intent.extra.BUGREPORT", ds.path_,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002080 "--es", "android.intent.extra.DUMPSTATE_LOG", ds.log_path_
2081 };
2082 // clang-format on
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +00002083 if (ds.options_->do_fb && !android::os::IsFileEmpty(ds.screenshot_path_)) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002084 am_args.push_back("--es");
2085 am_args.push_back("android.intent.extra.SCREENSHOT");
2086 am_args.push_back(ds.screenshot_path_);
2087 }
Nandana Dutt15b89d72018-11-16 14:14:12 +00002088 if (!ds.options_->notification_title.empty()) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002089 am_args.push_back("--es");
2090 am_args.push_back("android.intent.extra.TITLE");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002091 am_args.push_back(ds.options_->notification_title);
2092 if (!ds.options_->notification_description.empty()) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002093 am_args.push_back("--es");
2094 am_args.push_back("android.intent.extra.DESCRIPTION");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002095 am_args.push_back(ds.options_->notification_description);
Nandana Dutt4be45d12018-09-26 15:04:23 +01002096 }
2097 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002098 if (ds.options_->is_remote_mode) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002099 am_args.push_back("--es");
2100 am_args.push_back("android.intent.extra.REMOTE_BUGREPORT_HASH");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002101 am_args.push_back(SHA256_file_hash(ds.path_));
Nandana Dutt4be45d12018-09-26 15:04:23 +01002102 SendBroadcast("com.android.internal.intent.action.REMOTE_BUGREPORT_FINISHED", am_args);
2103 } else {
2104 SendBroadcast("com.android.internal.intent.action.BUGREPORT_FINISHED", am_args);
2105 }
2106 } else {
2107 MYLOGE("Skipping finished broadcast because bugreport could not be generated\n");
2108 }
2109}
2110
Nandana Dutt58d72e22018-11-16 10:30:48 +00002111static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2112 switch (mode) {
2113 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2114 return "BUGREPORT_FULL";
2115 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2116 return "BUGREPORT_INTERACTIVE";
2117 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2118 return "BUGREPORT_REMOTE";
2119 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2120 return "BUGREPORT_WEAR";
2121 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2122 return "BUGREPORT_TELEPHONY";
2123 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2124 return "BUGREPORT_WIFI";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002125 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2126 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002127 }
2128}
2129
2130static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options) {
Abhijeet Kaur8ca245e2018-12-12 10:34:21 +00002131 options->extra_options = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002132 switch (mode) {
2133 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2134 options->do_broadcast = true;
2135 options->do_fb = true;
2136 break;
2137 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002138 // Currently, the dumpstate binder is only used by Shell to update progress.
2139 options->do_start_service = true;
2140 options->do_progress_updates = true;
2141 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002142 options->do_broadcast = true;
2143 break;
2144 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002145 options->do_vibrate = false;
2146 options->is_remote_mode = true;
2147 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002148 options->do_broadcast = true;
2149 break;
2150 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002151 options->do_start_service = true;
2152 options->do_progress_updates = true;
2153 options->do_zip_file = true;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002154 options->do_fb = true;
2155 options->do_broadcast = true;
2156 break;
2157 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002158 options->telephony_only = true;
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +00002159 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002160 options->do_broadcast = true;
2161 break;
2162 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002163 options->wifi_only = true;
2164 options->do_zip_file = true;
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +00002165 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002166 options->do_broadcast = true;
2167 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002168 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2169 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002170 }
2171}
2172
2173static Dumpstate::BugreportMode getBugreportModeFromProperty() {
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002174 // If the system property is not set, it's assumed to be a default bugreport.
2175 Dumpstate::BugreportMode mode = Dumpstate::BugreportMode::BUGREPORT_DEFAULT;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002176
2177 std::string extra_options = android::base::GetProperty(PROPERTY_EXTRA_OPTIONS, "");
2178 if (!extra_options.empty()) {
2179 // Framework uses a system property to override some command-line args.
2180 // Currently, it contains the type of the requested bugreport.
2181 if (extra_options == "bugreportplus") {
2182 mode = Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002183 } else if (extra_options == "bugreportfull") {
2184 mode = Dumpstate::BugreportMode::BUGREPORT_FULL;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002185 } else if (extra_options == "bugreportremote") {
2186 mode = Dumpstate::BugreportMode::BUGREPORT_REMOTE;
2187 } else if (extra_options == "bugreportwear") {
2188 mode = Dumpstate::BugreportMode::BUGREPORT_WEAR;
2189 } else if (extra_options == "bugreporttelephony") {
2190 mode = Dumpstate::BugreportMode::BUGREPORT_TELEPHONY;
2191 } else if (extra_options == "bugreportwifi") {
2192 mode = Dumpstate::BugreportMode::BUGREPORT_WIFI;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002193 } else {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002194 MYLOGE("Unknown extra option: %s\n", extra_options.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002195 }
2196 // Reset the property
2197 android::base::SetProperty(PROPERTY_EXTRA_OPTIONS, "");
2198 }
Nandana Dutt58d72e22018-11-16 10:30:48 +00002199 return mode;
2200}
2201
2202// TODO: Move away from system properties when we have options passed via binder calls.
2203/* Sets runtime options from the system properties and then clears those properties. */
2204static void SetOptionsFromProperties(Dumpstate::DumpOptions* options) {
2205 Dumpstate::BugreportMode mode = getBugreportModeFromProperty();
2206 SetOptionsFromMode(mode, options);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002207
2208 options->notification_title = android::base::GetProperty(PROPERTY_EXTRA_TITLE, "");
2209 if (!options->notification_title.empty()) {
2210 // Reset the property
2211 android::base::SetProperty(PROPERTY_EXTRA_TITLE, "");
2212
Nandana Duttdd8cca32018-11-14 10:10:29 +00002213 options->notification_description =
2214 android::base::GetProperty(PROPERTY_EXTRA_DESCRIPTION, "");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002215 if (!options->notification_description.empty()) {
2216 // Reset the property
2217 android::base::SetProperty(PROPERTY_EXTRA_DESCRIPTION, "");
2218 }
2219 MYLOGD("notification (title: %s, description: %s)\n", options->notification_title.c_str(),
2220 options->notification_description.c_str());
2221 }
2222}
2223
Nandana Dutt58d72e22018-11-16 10:30:48 +00002224static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
2225 MYLOGI("do_zip_file: %d\n", options.do_zip_file);
2226 MYLOGI("do_add_date: %d\n", options.do_add_date);
2227 MYLOGI("do_vibrate: %d\n", options.do_vibrate);
2228 MYLOGI("use_socket: %d\n", options.use_socket);
2229 MYLOGI("use_control_socket: %d\n", options.use_control_socket);
2230 MYLOGI("do_fb: %d\n", options.do_fb);
2231 MYLOGI("do_broadcast: %d\n", options.do_broadcast);
2232 MYLOGI("is_remote_mode: %d\n", options.is_remote_mode);
2233 MYLOGI("show_header_only: %d\n", options.show_header_only);
2234 MYLOGI("do_start_service: %d\n", options.do_start_service);
2235 MYLOGI("telephony_only: %d\n", options.telephony_only);
2236 MYLOGI("wifi_only: %d\n", options.wifi_only);
2237 MYLOGI("do_progress_updates: %d\n", options.do_progress_updates);
Nandana Dutt54dbd672019-01-11 12:58:05 +00002238 MYLOGI("fd: %d\n", options.bugreport_fd.get());
Nandana Dutt58d72e22018-11-16 10:30:48 +00002239 MYLOGI("extra_options: %s\n", options.extra_options.c_str());
2240 MYLOGI("args: %s\n", options.args.c_str());
2241 MYLOGI("notification_title: %s\n", options.notification_title.c_str());
2242 MYLOGI("notification_description: %s\n", options.notification_description.c_str());
2243}
2244
Nandana Dutt54dbd672019-01-11 12:58:05 +00002245void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode,
2246 const android::base::unique_fd& bugreport_fd_in,
2247 const android::base::unique_fd& screenshot_fd_in) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002248 // In the new API world, date is always added; output is always a zip file.
2249 // TODO(111441001): remove these options once they are obsolete.
2250 do_add_date = true;
2251 do_zip_file = true;
2252
Nandana Dutt54dbd672019-01-11 12:58:05 +00002253 // Duplicate the fds because the passed in fds don't outlive the binder transaction.
2254 bugreport_fd.reset(dup(bugreport_fd_in.get()));
2255 screenshot_fd.reset(dup(screenshot_fd_in.get()));
Nandana Dutt58d72e22018-11-16 10:30:48 +00002256
2257 extra_options = ModeToString(bugreport_mode);
2258 SetOptionsFromMode(bugreport_mode, this);
2259}
2260
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002261Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
2262 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002263 int c;
Nandana Dutt235864b2019-01-22 12:10:16 +00002264 while ((c = getopt(argc, argv, "dho:svqzpPBRSV:w")) != -1) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002265 switch (c) {
2266 // clang-format off
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002267 case 'd': do_add_date = true; break;
2268 case 'z': do_zip_file = true; break;
Nandana Dutt9a76d202019-01-21 15:56:48 +00002269 // o=use_outfile not supported anymore.
2270 // TODO(b/111441001): Remove when all callers have migrated.
2271 case 'o': break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002272 case 's': use_socket = true; break;
2273 case 'S': use_control_socket = true; break;
2274 case 'v': show_header_only = true; break;
2275 case 'q': do_vibrate = false; break;
2276 case 'p': do_fb = true; break;
2277 case 'P': do_progress_updates = true; break;
2278 case 'R': is_remote_mode = true; break;
2279 case 'B': do_broadcast = true; break;
2280 case 'V': break; // compatibility no-op
Nandana Dutt235864b2019-01-22 12:10:16 +00002281 case 'w':
2282 // This was already processed
2283 break;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002284 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002285 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002286 break;
2287 default:
2288 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002289 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002290 break;
2291 // clang-format on
2292 }
2293 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08002294
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002295 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002296 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002297 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002298 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002299 }
2300 }
2301
2302 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
2303 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002304
2305 SetOptionsFromProperties(this);
2306 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002307}
2308
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002309bool Dumpstate::DumpOptions::ValidateOptions() const {
Nandana Dutt54dbd672019-01-11 12:58:05 +00002310 if (bugreport_fd.get() != -1 && !do_zip_file) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002311 return false;
2312 }
2313
Nandana Dutt9a76d202019-01-21 15:56:48 +00002314 if ((do_zip_file || do_add_date || do_progress_updates || do_broadcast) && !OutputToFile()) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002315 return false;
2316 }
2317
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002318 if (use_control_socket && !do_zip_file) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002319 return false;
2320 }
2321
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002322 if (do_progress_updates && !do_broadcast) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002323 return false;
2324 }
2325
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002326 if (is_remote_mode && (do_progress_updates || !do_broadcast || !do_zip_file || !do_add_date)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002327 return false;
2328 }
2329 return true;
2330}
2331
Nandana Dutt197661d2018-11-16 16:40:21 +00002332void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
2333 options_ = std::move(options);
2334}
2335
Nandana Duttd2f5f082019-01-18 17:13:52 +00002336Dumpstate::RunStatus Dumpstate::Run(int32_t calling_uid, const std::string& calling_package) {
2337 Dumpstate::RunStatus status = RunInternal(calling_uid, calling_package);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002338 if (listener_ != nullptr) {
2339 switch (status) {
2340 case Dumpstate::RunStatus::OK:
Nandana Duttcc4ead82019-01-23 08:29:23 +00002341 listener_->onFinished();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002342 break;
2343 case Dumpstate::RunStatus::HELP:
2344 break;
2345 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002346 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_INVALID_INPUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002347 break;
2348 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002349 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_RUNTIME_ERROR);
2350 break;
2351 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2352 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_DENIED_CONSENT);
2353 break;
2354 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
2355 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_CONSENT_TIMED_OUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002356 break;
2357 }
2358 }
2359 return status;
2360}
2361
Nandana Dutt979388e2018-11-30 16:48:55 +00002362/*
2363 * Dumps relevant information to a bugreport based on the given options.
2364 *
2365 * The bugreport can be dumped to a file or streamed to a socket.
2366 *
2367 * How dumping to file works:
2368 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
2369 * stderr is redirected a log file.
2370 *
2371 * The temporary bugreport is then populated via printfs, dumping contents of files and
2372 * output of commands to stdout.
2373 *
2374 * If zipping, the temporary bugreport file is added to the zip archive. Else it's renamed to final
2375 * text file.
2376 *
2377 * If zipping, a bunch of other files and dumps also get added to the zip archive. The log file also
2378 * gets added to the archive.
2379 *
Nandana Dutt9a76d202019-01-21 15:56:48 +00002380 * Bugreports are first generated in a local directory and later copied to the caller's fd if
2381 * supplied.
Nandana Dutt979388e2018-11-30 16:48:55 +00002382 */
Nandana Duttd2f5f082019-01-18 17:13:52 +00002383Dumpstate::RunStatus Dumpstate::RunInternal(int32_t calling_uid,
2384 const std::string& calling_package) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002385 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00002386 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002387 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002388 return RunStatus::INVALID_INPUT;
2389 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002390 /* set as high priority, and protect from OOM killer */
2391 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002392
Felipe Lemed071c682016-10-20 16:48:00 -07002393 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002394 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002395 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002396 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002397 } else {
2398 /* fallback to kernels <= 2.6.35 */
2399 oom_adj = fopen("/proc/self/oom_adj", "we");
2400 if (oom_adj) {
2401 fputs("-17", oom_adj);
2402 fclose(oom_adj);
2403 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002404 }
2405
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002406 if (version_ == VERSION_DEFAULT) {
2407 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00002408 }
2409
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002410 if (version_ != VERSION_CURRENT && version_ != VERSION_SPLIT_ANR) {
Vishnu Nair64afc022018-02-01 15:29:34 -08002411 MYLOGE("invalid version requested ('%s'); suppported values are: ('%s', '%s', '%s')\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002412 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str(),
Vishnu Nair64afc022018-02-01 15:29:34 -08002413 VERSION_SPLIT_ANR.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002414 return RunStatus::INVALID_INPUT;
Felipe Lemed071c682016-10-20 16:48:00 -07002415 }
2416
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002417 if (options_->show_header_only) {
2418 PrintHeader();
2419 return RunStatus::OK;
Felipe Lemed071c682016-10-20 16:48:00 -07002420 }
2421
Nandana Duttd2f5f082019-01-18 17:13:52 +00002422 if (options_->bugreport_fd.get() != -1) {
2423 // If the output needs to be copied over to the caller's fd, get user consent.
2424 android::String16 package(calling_package.c_str());
2425 CheckUserConsent(calling_uid, package);
2426 }
2427
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002428 // Redirect output if needed
Nandana Dutt9a76d202019-01-21 15:56:48 +00002429 bool is_redirecting = options_->OutputToFile();
Felipe Leme7447d7c2016-11-03 18:12:22 -07002430
2431 // TODO: temporarily set progress until it's part of the Dumpstate constructor
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002432 std::string stats_path =
Nandana Dutt979388e2018-11-30 16:48:55 +00002433 is_redirecting
2434 ? android::base::StringPrintf("%s/dumpstate-stats.txt", bugreport_internal_dir_.c_str())
2435 : "";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002436 progress_.reset(new Progress(stats_path));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002437
Felipe Lemed071c682016-10-20 16:48:00 -07002438 /* gets the sequential id */
Felipe Leme7447d7c2016-11-03 18:12:22 -07002439 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002440 id_ = ++last_id;
Felipe Lemed071c682016-10-20 16:48:00 -07002441 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
2442
2443 MYLOGI("begin\n");
2444
Felipe Leme6ae5c4f2017-01-10 14:13:22 -08002445 register_sig_handler();
Felipe Lemed071c682016-10-20 16:48:00 -07002446
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002447 // TODO(b/111441001): maybe skip if already started?
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002448 if (options_->do_start_service) {
Felipe Leme75876a22016-10-27 16:31:27 -07002449 MYLOGI("Starting 'dumpstate' service\n");
2450 android::status_t ret;
2451 if ((ret = android::os::DumpstateService::Start()) != android::OK) {
2452 MYLOGE("Unable to start DumpstateService: %d\n", ret);
2453 }
2454 }
2455
Felipe Lemef0292972016-11-22 13:57:05 -08002456 if (PropertiesHelper::IsDryRun()) {
Felipe Lemed071c682016-10-20 16:48:00 -07002457 MYLOGI("Running on dry-run mode (to disable it, call 'setprop dumpstate.dry_run false')\n");
2458 }
2459
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002460 MYLOGI("dumpstate info: id=%d, args='%s', extra_options= %s)\n", id_, options_->args.c_str(),
2461 options_->extra_options.c_str());
Felipe Lemed071c682016-10-20 16:48:00 -07002462
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002463 MYLOGI("bugreport format version: %s\n", version_.c_str());
Felipe Leme809d74e2016-02-02 12:57:00 -08002464
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002465 do_early_screenshot_ = options_->do_progress_updates;
Felipe Lemee338bf62015-12-07 14:03:50 -08002466
Christopher Ferrised9354f2014-10-01 17:35:01 -07002467 // If we are going to use a socket, do it as early as possible
2468 // to avoid timeouts from bugreport.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002469 if (options_->use_socket) {
Nandana Dutta344cb62019-02-22 15:12:35 +00002470 if (!redirect_to_socket(stdout, "dumpstate")) {
2471 return ERROR;
2472 }
Christopher Ferrised9354f2014-10-01 17:35:01 -07002473 }
2474
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002475 if (options_->use_control_socket) {
Felipe Leme2628e9e2016-04-12 16:36:51 -07002476 MYLOGD("Opening control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002477 control_socket_fd_ = open_socket("dumpstate");
Nandana Dutta344cb62019-02-22 15:12:35 +00002478 if (control_socket_fd_ == -1) {
2479 return ERROR;
2480 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002481 options_->do_progress_updates = 1;
Felipe Leme2628e9e2016-04-12 16:36:51 -07002482 }
2483
Felipe Leme71bbfc52015-11-23 14:14:51 -08002484 if (is_redirecting) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002485 PrepareToWriteToFile();
Felipe Leme1e9edc62015-12-21 16:02:13 -08002486
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002487 if (options_->do_progress_updates) {
2488 if (options_->do_broadcast) {
Felipe Lemedcd1f0d2016-08-04 12:48:50 -07002489 // clang-format off
2490 std::vector<std::string> am_args = {
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002491 "--receiver-permission", "android.permission.DUMP",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002492 "--es", "android.intent.extra.NAME", name_,
2493 "--ei", "android.intent.extra.ID", std::to_string(id_),
2494 "--ei", "android.intent.extra.PID", std::to_string(pid_),
2495 "--ei", "android.intent.extra.MAX", std::to_string(progress_->GetMax()),
Felipe Lemedcd1f0d2016-08-04 12:48:50 -07002496 };
2497 // clang-format on
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002498 SendBroadcast("com.android.internal.intent.action.BUGREPORT_STARTED", am_args);
Felipe Lemedcd1f0d2016-08-04 12:48:50 -07002499 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002500 if (options_->use_control_socket) {
2501 dprintf(control_socket_fd_, "BEGIN:%s\n", path_.c_str());
Felipe Lemeaabfcae2016-07-29 09:49:04 -07002502 }
Felipe Leme71bbfc52015-11-23 14:14:51 -08002503 }
2504 }
2505
Nick Kralevichf3599b32016-01-25 15:05:16 -08002506 /* read /proc/cmdline before dropping root */
2507 FILE *cmdline = fopen("/proc/cmdline", "re");
2508 if (cmdline) {
2509 fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
2510 fclose(cmdline);
2511 }
2512
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002513 if (options_->do_vibrate) {
Felipe Leme35b8cf12017-02-10 15:47:29 -08002514 Vibrate(150);
John Michelau1f794c42012-09-17 11:20:19 -05002515 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002516
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002517 if (options_->do_fb && do_early_screenshot_) {
Greg Kaiser3ddc3fa2019-05-23 16:14:52 -07002518 MYLOGI("taking early screenshot\n");
2519 TakeScreenshot();
Felipe Lemee338bf62015-12-07 14:03:50 -08002520 }
2521
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002522 if (options_->do_zip_file && zip_file != nullptr) {
2523 if (chown(path_.c_str(), AID_SHELL, AID_SHELL)) {
2524 MYLOGE("Unable to change ownership of zip file %s: %s\n", path_.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -07002525 strerror(errno));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002526 }
2527 }
2528
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002529 int dup_stdout_fd;
2530 int dup_stderr_fd;
Felipe Leme71bbfc52015-11-23 14:14:51 -08002531 if (is_redirecting) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002532 // Redirect stderr to log_path_ for debugging.
Vishnu Nair20cf5032018-01-05 13:15:49 -08002533 TEMP_FAILURE_RETRY(dup_stderr_fd = dup(fileno(stderr)));
Nandana Dutta344cb62019-02-22 15:12:35 +00002534 if (!redirect_to_file(stderr, const_cast<char*>(log_path_.c_str()))) {
2535 return ERROR;
2536 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002537 if (chown(log_path_.c_str(), AID_SHELL, AID_SHELL)) {
2538 MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n", log_path_.c_str(),
2539 strerror(errno));
Felipe Leme6fe9db62016-02-12 09:04:16 -08002540 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002541
2542 // Redirect stdout to tmp_path_. This is the main bugreport entry and will be
2543 // moved into zip file later, if zipping.
Vishnu Nair20cf5032018-01-05 13:15:49 -08002544 TEMP_FAILURE_RETRY(dup_stdout_fd = dup(fileno(stdout)));
Nandana Dutt979388e2018-11-30 16:48:55 +00002545 // TODO: why not write to a file instead of stdout to overcome this problem?
Felipe Leme6e01fa62015-11-11 19:35:14 -08002546 /* TODO: rather than generating a text file now and zipping it later,
2547 it would be more efficient to redirect stdout to the zip entry
2548 directly, but the libziparchive doesn't support that option yet. */
Nandana Dutta344cb62019-02-22 15:12:35 +00002549 if (!redirect_to_file(stdout, const_cast<char*>(tmp_path_.c_str()))) {
2550 return ERROR;
2551 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002552 if (chown(tmp_path_.c_str(), AID_SHELL, AID_SHELL)) {
Felipe Leme6fe9db62016-02-12 09:04:16 -08002553 MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002554 tmp_path_.c_str(), strerror(errno));
Felipe Leme6fe9db62016-02-12 09:04:16 -08002555 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002556 }
Felipe Lemed8b94e52016-12-08 10:21:44 -08002557
2558 // Don't buffer stdout
2559 setvbuf(stdout, nullptr, _IONBF, 0);
2560
Felipe Leme608385d2016-02-01 10:35:38 -08002561 // NOTE: there should be no stdout output until now, otherwise it would break the header.
2562 // In particular, DurationReport objects should be created passing 'title, NULL', so their
Felipe Lemecbce55d2016-02-08 09:53:18 -08002563 // duration is logged into MYLOG instead.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002564 PrintHeader();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002565
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002566 if (options_->telephony_only) {
Jayachandran Ca94c7172017-06-10 15:08:12 -07002567 DumpstateTelephonyOnly();
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002568 DumpstateBoard();
2569 } else if (options_->wifi_only) {
mukesh agrawal253dad42018-01-23 21:59:59 -08002570 DumpstateWifiOnly();
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002571 } else {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002572 // Dump state for the default case. This also drops root.
Nandana Dutt5c390032019-03-12 10:52:56 +00002573 RunStatus s = DumpstateDefault();
2574 if (s != RunStatus::OK) {
2575 if (s == RunStatus::USER_CONSENT_TIMED_OUT) {
2576 HandleUserConsentDenied();
2577 }
2578 return s;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002579 }
Zhengyin Qian068ecc72016-08-10 16:48:14 -07002580 }
Felipe Leme71a74ac2016-03-17 15:43:25 -07002581
Felipe Leme55b42a62015-11-10 17:39:08 -08002582 /* close output if needed */
Felipe Leme71bbfc52015-11-23 14:14:51 -08002583 if (is_redirecting) {
Vishnu Nair20cf5032018-01-05 13:15:49 -08002584 TEMP_FAILURE_RETRY(dup2(dup_stdout_fd, fileno(stdout)));
Colin Crossf45fa6b2012-03-26 12:38:26 -07002585 }
2586
Nandana Duttd2f5f082019-01-18 17:13:52 +00002587 // Rename, and/or zip the (now complete) .tmp file within the internal directory.
Nandana Dutt9a76d202019-01-21 15:56:48 +00002588 if (options_->OutputToFile()) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002589 FinalizeFile();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002590 }
2591
Nandana Duttd2f5f082019-01-18 17:13:52 +00002592 // Share the final file with the caller if the user has consented.
2593 Dumpstate::RunStatus status = Dumpstate::RunStatus::OK;
2594 if (options_->bugreport_fd.get() != -1) {
2595 status = CopyBugreportIfUserConsented();
2596 if (status != Dumpstate::RunStatus::OK &&
2597 status != Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2598 // Do an early return if there were errors. We make an exception for consent
2599 // timing out because it's possible the user got distracted. In this case the
2600 // bugreport is not shared but made available for manual retrieval.
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002601 MYLOGI("User denied consent. Returning\n");
Nandana Duttd2f5f082019-01-18 17:13:52 +00002602 return status;
2603 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002604 if (options_->do_fb && options_->screenshot_fd.get() != -1) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00002605 bool copy_succeeded = android::os::CopyFileToFd(screenshot_path_,
2606 options_->screenshot_fd.get());
2607 if (copy_succeeded) {
2608 android::os::UnlinkAndLogOnError(screenshot_path_);
2609 }
2610 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002611 if (status == Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2612 MYLOGI(
2613 "Did not receive user consent yet."
2614 " Will not copy the bugreport artifacts to caller.\n");
Abhijeet Kaur57627412019-04-17 16:00:09 +01002615 const String16 incidentcompanion("incidentcompanion");
2616 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
2617 if (ics != nullptr) {
2618 MYLOGD("Canceling user consent request via incidentcompanion service\n");
2619 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
2620 consent_callback_.get());
2621 } else {
2622 MYLOGD("Unable to cancel user consent; incidentcompanion service unavailable\n");
2623 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002624 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00002625 }
2626
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002627 /* vibrate a few but shortly times to let user know it's finished */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002628 if (options_->do_vibrate) {
Takuya Ogawa47f644e2017-12-20 18:09:09 +09002629 for (int i = 0; i < 3; i++) {
2630 Vibrate(75);
2631 usleep((75 + 50) * 1000);
2632 }
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002633 }
2634
Jeff Brown1dc94e32014-09-11 14:15:27 -07002635 /* tell activity manager we're done */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002636 if (options_->do_broadcast) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002637 SendBugreportFinishedBroadcast();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002638 // Note that listener_ is notified in Run();
Jeff Sharkey27f9e6d2013-03-13 15:45:50 -07002639 }
2640
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002641 MYLOGD("Final progress: %d/%d (estimated %d)\n", progress_->Get(), progress_->GetMax(),
2642 progress_->GetInitialMax());
2643 progress_->Save();
2644 MYLOGI("done (id %d)\n", id_);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002645
Felipe Leme107a05f2016-03-08 15:11:15 -08002646 if (is_redirecting) {
Vishnu Nair20cf5032018-01-05 13:15:49 -08002647 TEMP_FAILURE_RETRY(dup2(dup_stderr_fd, fileno(stderr)));
Felipe Leme107a05f2016-03-08 15:11:15 -08002648 }
2649
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002650 if (options_->use_control_socket && control_socket_fd_ != -1) {
Felipe Lemee844a9d2016-09-21 15:01:39 -07002651 MYLOGD("Closing control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002652 close(control_socket_fd_);
Felipe Leme2628e9e2016-04-12 16:36:51 -07002653 }
2654
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002655 tombstone_data_.clear();
2656 anr_data_.clear();
Narayan Kamath6b9516c2017-10-27 11:15:51 +01002657
Nandana Duttd2f5f082019-01-18 17:13:52 +00002658 return (consent_callback_ != nullptr &&
2659 consent_callback_->getResult() == UserConsentResult::UNAVAILABLE)
2660 ? USER_CONSENT_TIMED_OUT
2661 : RunStatus::OK;
2662}
2663
2664void Dumpstate::CheckUserConsent(int32_t calling_uid, const android::String16& calling_package) {
2665 consent_callback_ = new ConsentCallback();
2666 const String16 incidentcompanion("incidentcompanion");
2667 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
2668 if (ics != nullptr) {
2669 MYLOGD("Checking user consent via incidentcompanion service\n");
2670 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
Joe Onorato1c36d752019-03-17 18:26:43 -07002671 calling_uid, calling_package, String16(), String16(),
2672 0x1 /* FLAG_CONFIRMATION_DIALOG */, consent_callback_.get());
Nandana Duttd2f5f082019-01-18 17:13:52 +00002673 } else {
2674 MYLOGD("Unable to check user consent; incidentcompanion service unavailable\n");
2675 }
2676}
2677
Nandana Dutt5c390032019-03-12 10:52:56 +00002678bool Dumpstate::IsUserConsentDenied() const {
2679 return ds.consent_callback_ != nullptr &&
2680 ds.consent_callback_->getResult() == UserConsentResult::DENIED;
2681}
2682
Nandana Duttd2f5f082019-01-18 17:13:52 +00002683void Dumpstate::CleanupFiles() {
2684 android::os::UnlinkAndLogOnError(tmp_path_);
2685 android::os::UnlinkAndLogOnError(screenshot_path_);
2686 android::os::UnlinkAndLogOnError(path_);
2687}
2688
2689Dumpstate::RunStatus Dumpstate::HandleUserConsentDenied() {
2690 MYLOGD("User denied consent; deleting files and returning\n");
2691 CleanupFiles();
2692 return USER_CONSENT_DENIED;
2693}
2694
2695Dumpstate::RunStatus Dumpstate::CopyBugreportIfUserConsented() {
2696 // If the caller has asked to copy the bugreport over to their directory, we need explicit
2697 // user consent.
2698 UserConsentResult consent_result = consent_callback_->getResult();
2699 if (consent_result == UserConsentResult::UNAVAILABLE) {
2700 // User has not responded yet.
2701 uint64_t elapsed_ms = consent_callback_->getElapsedTimeMs();
2702 if (elapsed_ms < USER_CONSENT_TIMEOUT_MS) {
2703 uint delay_seconds = (USER_CONSENT_TIMEOUT_MS - elapsed_ms) / 1000;
2704 MYLOGD("Did not receive user consent yet; going to wait for %d seconds", delay_seconds);
2705 sleep(delay_seconds);
2706 }
2707 consent_result = consent_callback_->getResult();
2708 }
2709 if (consent_result == UserConsentResult::DENIED) {
2710 // User has explicitly denied sharing with the app. To be safe delete the
2711 // internal bugreport & tmp files.
2712 return HandleUserConsentDenied();
2713 }
2714 if (consent_result == UserConsentResult::APPROVED) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00002715 bool copy_succeeded = android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
2716 if (copy_succeeded) {
2717 android::os::UnlinkAndLogOnError(path_);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002718 }
2719 return copy_succeeded ? Dumpstate::RunStatus::OK : Dumpstate::RunStatus::ERROR;
2720 } else if (consent_result == UserConsentResult::UNAVAILABLE) {
2721 // consent_result is still UNAVAILABLE. The user has likely not responded yet.
2722 // Since we do not have user consent to share the bugreport it does not get
2723 // copied over to the calling app but remains in the internal directory from
2724 // where the user can manually pull it.
2725 return Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT;
2726 }
2727 // Unknown result; must be a programming error.
2728 MYLOGE("Unknown user consent result:%d\n", consent_result);
2729 return Dumpstate::RunStatus::ERROR;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002730}
2731
Nandana Duttf02564e2019-02-15 15:24:24 +00002732Dumpstate::RunStatus Dumpstate::ParseCommandlineAndRun(int argc, char* argv[]) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002733 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
2734 Dumpstate::RunStatus status = options->Initialize(argc, argv);
2735 if (status == Dumpstate::RunStatus::OK) {
Nandana Duttf02564e2019-02-15 15:24:24 +00002736 SetOptions(std::move(options));
Nandana Duttd2f5f082019-01-18 17:13:52 +00002737 // When directly running dumpstate binary, the output is not expected to be written
2738 // to any external file descriptor.
Nandana Duttf02564e2019-02-15 15:24:24 +00002739 assert(options_->bugreport_fd.get() == -1);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002740
2741 // calling_uid and calling_package are for user consent to share the bugreport with
2742 // an app; they are irrelvant here because bugreport is only written to a local
2743 // directory, and not shared.
Nandana Duttf02564e2019-02-15 15:24:24 +00002744 status = Run(-1 /* calling_uid */, "" /* calling_package */);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002745 }
Nandana Duttf02564e2019-02-15 15:24:24 +00002746 return status;
2747}
2748
2749/* Main entry point for dumpstate binary. */
2750int run_main(int argc, char* argv[]) {
2751 Dumpstate::RunStatus status = ds.ParseCommandlineAndRun(argc, argv);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002752
2753 switch (status) {
2754 case Dumpstate::RunStatus::OK:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002755 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002756 case Dumpstate::RunStatus::HELP:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002757 ShowUsage();
2758 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002759 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002760 fprintf(stderr, "Invalid combination of args\n");
2761 ShowUsage();
2762 exit(1);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002763 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002764 FALLTHROUGH_INTENDED;
2765 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2766 FALLTHROUGH_INTENDED;
2767 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002768 exit(2);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002769 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002770}