blob: 5b4317224ab48c894597e45f91a2a60882280732 [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>
Felipe Lemead5f6c42015-11-30 14:26:46 -080022#include <libgen.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070023#include <limits.h>
Mark Salyzyn8f37aa52015-06-12 12:28:24 -070024#include <stdbool.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070025#include <stdio.h>
26#include <stdlib.h>
27#include <string.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080028#include <sys/poll.h>
Christopher Ferris7dc7f322014-07-22 16:08:19 -070029#include <sys/prctl.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070030#include <sys/resource.h>
31#include <sys/stat.h>
32#include <sys/time.h>
33#include <sys/wait.h>
34#include <unistd.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070035
36#include <chrono>
37#include <functional>
38#include <future>
Narayan Kamath8f788292017-05-25 13:20:39 +010039#include <memory>
40#include <regex>
41#include <set>
42#include <string>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070043#include <utility>
Narayan Kamath8f788292017-05-25 13:20:39 +010044#include <vector>
Colin Crossf45fa6b2012-03-26 12:38:26 -070045
Felipe Leme96c2bbb2016-09-26 09:21:21 -070046#include <android-base/file.h>
47#include <android-base/properties.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070048#include <android-base/scopeguard.h>
Elliott Hughes9dc117c2015-12-07 14:21:50 -080049#include <android-base/stringprintf.h>
Naveen Kalla058e1e82016-10-19 21:38:44 -070050#include <android-base/strings.h>
Andreas Gampeaff68432016-07-18 18:01:27 -070051#include <android-base/unique_fd.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080052#include <android/hardware/dumpstate/1.0/IDumpstateDevice.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080053#include <android/hidl/manager/1.0/IServiceManager.h>
Nandana Duttd2f5f082019-01-18 17:13:52 +000054#include <android/os/IIncidentCompanion.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080055#include <cutils/native_handle.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070056#include <cutils/properties.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000057#include <debuggerd/client.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080058#include <dumpsys.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000059#include <dumputils/dump_utils.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080060#include <hidl/ServiceManagement.h>
Felipe Leme75876a22016-10-27 16:31:27 -070061#include <openssl/sha.h>
Mark Salyzyn6c3d90f2016-09-27 14:55:27 -070062#include <private/android_filesystem_config.h>
63#include <private/android_logger.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080064#include <serviceutils/PriorityDumper.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070065#include <utils/StrongPointer.h>
Felipe Lemef0292972016-11-22 13:57:05 -080066#include "DumpstateInternal.h"
Vishnu Naire97d6122018-01-18 13:58:56 -080067#include "DumpstateSectionReporter.h"
Felipe Leme75876a22016-10-27 16:31:27 -070068#include "DumpstateService.h"
Colin Crossf45fa6b2012-03-26 12:38:26 -070069#include "dumpstate.h"
Felipe Leme6e01fa62015-11-11 19:35:14 -080070
Steven Morelandcb7ef822016-11-29 13:20:37 -080071using ::android::hardware::dumpstate::V1_0::IDumpstateDevice;
Vishnu Naire97d6122018-01-18 13:58:56 -080072using ::std::literals::chrono_literals::operator""ms;
73using ::std::literals::chrono_literals::operator""s;
Steven Morelandcb7ef822016-11-29 13:20:37 -080074
Felipe Leme47e9be22016-12-21 15:37:07 -080075// TODO: remove once moved to namespace
Vishnu Naire97d6122018-01-18 13:58:56 -080076using android::defaultServiceManager;
77using android::Dumpsys;
78using android::INVALID_OPERATION;
79using android::IServiceManager;
80using android::OK;
81using android::sp;
82using android::status_t;
83using android::String16;
84using android::String8;
85using android::TIMED_OUT;
86using android::UNKNOWN_ERROR;
87using android::Vector;
Nandana Dutt979388e2018-11-30 16:48:55 +000088using android::base::StringPrintf;
Nandana Duttd2f5f082019-01-18 17:13:52 +000089using android::os::IDumpstateListener;
Felipe Leme47e9be22016-12-21 15:37:07 -080090using android::os::dumpstate::CommandOptions;
91using android::os::dumpstate::DumpFileToFd;
Vishnu Naire97d6122018-01-18 13:58:56 -080092using android::os::dumpstate::DumpstateSectionReporter;
Felipe Leme47e9be22016-12-21 15:37:07 -080093using android::os::dumpstate::GetPidByName;
Vishnu Naire97d6122018-01-18 13:58:56 -080094using android::os::dumpstate::PropertiesHelper;
Felipe Leme47e9be22016-12-21 15:37:07 -080095
Nandana Duttd2f5f082019-01-18 17:13:52 +000096typedef Dumpstate::ConsentCallback::ConsentResult UserConsentResult;
97
Colin Crossf45fa6b2012-03-26 12:38:26 -070098/* read before root is shed */
99static char cmdline_buf[16384] = "(unknown)";
Yi Kong19d5c002018-07-20 13:39:55 -0700100static const char *dump_traces_path = nullptr;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000101static const uint64_t USER_CONSENT_TIMEOUT_MS = 30 * 1000;
Colin Crossf45fa6b2012-03-26 12:38:26 -0700102
Felipe Leme1d486fe2016-10-14 18:06:47 -0700103// TODO: variables and functions below should be part of dumpstate object
104
Felipe Leme635ca312016-01-05 14:23:02 -0800105static std::set<std::string> mount_points;
106void add_mountinfo();
Felipe Leme78f2c862015-12-21 09:55:22 -0800107
Todd Poynor2a83daa2013-11-22 15:44:22 -0800108#define PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops"
Mark Salyzyn7d0a7622016-06-24 14:06:15 -0700109#define ALT_PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops-0"
Wei Wang509bb5d2017-06-09 14:42:12 -0700110#define BLK_DEV_SYS_DIR "/sys/block"
Todd Poynor2a83daa2013-11-22 15:44:22 -0800111
Felipe Lemee82a27d2016-01-05 13:35:44 -0800112#define RECOVERY_DIR "/cache/recovery"
Mark Salyzynd6ab0112016-03-25 12:56:39 -0700113#define RECOVERY_DATA_DIR "/data/misc/recovery"
Tianjie Xu75d53362018-04-11 16:42:28 -0700114#define UPDATE_ENGINE_LOG_DIR "/data/misc/update_engine_log"
Mark Salyzyn4d42dea2016-04-01 10:03:14 -0700115#define LOGPERSIST_DATA_DIR "/data/misc/logd"
David Brazdild2991962016-06-03 14:40:44 +0100116#define PROFILE_DATA_DIR_CUR "/data/misc/profiles/cur"
117#define PROFILE_DATA_DIR_REF "/data/misc/profiles/ref"
Benedict Wong8f9d8a42019-01-03 16:19:38 -0800118#define XFRM_STAT_PROC_FILE "/proc/net/xfrm_stat"
Erik Kline08165202016-05-30 11:55:44 +0900119#define WLUTIL "/vendor/xbin/wlutil"
Vishnu Nair36b4cdb2017-11-17 10:27:05 -0800120#define WMTRACE_DATA_DIR "/data/misc/wmtrace"
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700121
Narayan Kamath8f788292017-05-25 13:20:39 +0100122// TODO(narayan): Since this information has to be kept in sync
123// with tombstoned, we should just put it in a common header.
124//
125// File: system/core/debuggerd/tombstoned/tombstoned.cpp
Narayan Kamathbd863722017-06-01 18:50:12 +0100126static const std::string TOMBSTONE_DIR = "/data/tombstones/";
127static const std::string TOMBSTONE_FILE_PREFIX = "tombstone_";
128static const std::string ANR_DIR = "/data/anr/";
129static const std::string ANR_FILE_PREFIX = "anr_";
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700130
Felipe Lemee844a9d2016-09-21 15:01:39 -0700131// TODO: temporary variables and functions used during C++ refactoring
132static Dumpstate& ds = Dumpstate::GetInstance();
Nandana Dutt979388e2018-11-30 16:48:55 +0000133
134namespace android {
135namespace os {
136namespace {
137
138static int Open(std::string path, int flags, mode_t mode = 0) {
139 int fd = TEMP_FAILURE_RETRY(open(path.c_str(), flags, mode));
140 if (fd == -1) {
141 MYLOGE("open(%s, %s)\n", path.c_str(), strerror(errno));
142 }
143 return fd;
144}
145
Nandana Dutt979388e2018-11-30 16:48:55 +0000146
147static int OpenForRead(std::string path) {
148 return Open(path, O_RDONLY | O_CLOEXEC | O_NOFOLLOW);
149}
150
151bool CopyFile(int in_fd, int out_fd) {
152 char buf[4096];
153 ssize_t byte_count;
154 while ((byte_count = TEMP_FAILURE_RETRY(read(in_fd, buf, sizeof(buf)))) > 0) {
155 if (!android::base::WriteFully(out_fd, buf, byte_count)) {
156 return false;
157 }
158 }
159 return (byte_count != -1);
160}
161
162static bool CopyFileToFd(const std::string& input_file, int out_fd) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000163 MYLOGD("Going to copy file (%s) to %d\n", input_file.c_str(), out_fd);
Nandana Dutt979388e2018-11-30 16:48:55 +0000164
165 // Obtain a handle to the source file.
166 android::base::unique_fd in_fd(OpenForRead(input_file));
167 if (out_fd != -1 && in_fd.get() != -1) {
168 if (CopyFile(in_fd.get(), out_fd)) {
169 return true;
170 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000171 MYLOGE("Failed to copy file: %s\n", strerror(errno));
Nandana Dutt979388e2018-11-30 16:48:55 +0000172 }
173 return false;
174}
175
Nandana Duttd2f5f082019-01-18 17:13:52 +0000176static bool UnlinkAndLogOnError(const std::string& file) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000177 if (unlink(file.c_str())) {
178 MYLOGE("Failed to unlink file (%s): %s\n", file.c_str(), strerror(errno));
Nandana Duttd2f5f082019-01-18 17:13:52 +0000179 return false;
180 }
181 return true;
182}
Nandana Dutt979388e2018-11-30 16:48:55 +0000183
184} // namespace
185} // namespace os
186} // namespace android
187
Felipe Leme678727a2016-09-21 17:22:11 -0700188static int RunCommand(const std::string& title, const std::vector<std::string>& fullCommand,
189 const CommandOptions& options = CommandOptions::DEFAULT) {
190 return ds.RunCommand(title, fullCommand, options);
191}
192static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
Felipe Lemebda15a02016-11-16 17:48:25 -0800193 const CommandOptions& options = Dumpstate::DEFAULT_DUMPSYS,
Vishnu Nair6921f802017-11-22 09:17:23 -0800194 long dumpsysTimeoutMs = 0) {
195 return ds.RunDumpsys(title, dumpsysArgs, options, dumpsysTimeoutMs);
Felipe Leme678727a2016-09-21 17:22:11 -0700196}
197static int DumpFile(const std::string& title, const std::string& path) {
198 return ds.DumpFile(title, path);
199}
Felipe Lemee82a27d2016-01-05 13:35:44 -0800200
Felipe Lemee844a9d2016-09-21 15:01:39 -0700201// Relative directory (inside the zip) for all files copied as-is into the bugreport.
202static const std::string ZIP_ROOT_DIR = "FS";
203
Vishnu Naire97d6122018-01-18 13:58:56 -0800204static const std::string kProtoPath = "proto/";
205static const std::string kProtoExt = ".proto";
Jie Song9fbfad02017-06-20 16:29:42 -0700206static const std::string kDumpstateBoardFiles[] = {
207 "dumpstate_board.txt",
Felipe Leme95d6ca52017-08-01 16:35:56 -0700208 "dumpstate_board.bin"
Jie Song9fbfad02017-06-20 16:29:42 -0700209};
210static const int NUM_OF_DUMPS = arraysize(kDumpstateBoardFiles);
211
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700212static constexpr char PROPERTY_EXTRA_OPTIONS[] = "dumpstate.options";
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700213static constexpr char PROPERTY_LAST_ID[] = "dumpstate.last_id";
Felipe Lemed071c682016-10-20 16:48:00 -0700214static constexpr char PROPERTY_VERSION[] = "dumpstate.version";
Naveen Kallab53a1c92017-03-16 18:17:25 -0700215static constexpr char PROPERTY_EXTRA_TITLE[] = "dumpstate.options.title";
216static constexpr char PROPERTY_EXTRA_DESCRIPTION[] = "dumpstate.options.description";
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700217
Felipe Lemef0292972016-11-22 13:57:05 -0800218static const CommandOptions AS_ROOT_20 = CommandOptions::WithTimeout(20).AsRoot().Build();
219
Narayan Kamath8f788292017-05-25 13:20:39 +0100220/*
Narayan Kamathbd863722017-06-01 18:50:12 +0100221 * Returns a vector of dump fds under |dir_path| with a given |file_prefix|.
222 * The returned vector is sorted by the mtimes of the dumps. If |limit_by_mtime|
223 * is set, the vector only contains files that were written in the last 30 minutes.
Andreas Gamped0d76952017-08-22 13:08:37 -0700224 * If |limit_by_count| is set, the vector only contains the ten latest files.
Narayan Kamath8f788292017-05-25 13:20:39 +0100225 */
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700226static std::vector<DumpData> GetDumpFds(const std::string& dir_path,
227 const std::string& file_prefix,
228 bool limit_by_mtime,
229 bool limit_by_count = true) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100230 const time_t thirty_minutes_ago = ds.now_ - 60 * 30;
231
Narayan Kamathbd863722017-06-01 18:50:12 +0100232 std::unique_ptr<DIR, decltype(&closedir)> dump_dir(opendir(dir_path.c_str()), closedir);
Narayan Kamath8f788292017-05-25 13:20:39 +0100233
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700234 if (dump_dir == nullptr) {
235 MYLOGW("Unable to open directory %s: %s\n", dir_path.c_str(), strerror(errno));
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700236 return std::vector<DumpData>();
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700237 }
238
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700239 std::vector<DumpData> dump_data;
Narayan Kamathbd863722017-06-01 18:50:12 +0100240 struct dirent* entry = nullptr;
241 while ((entry = readdir(dump_dir.get()))) {
242 if (entry->d_type != DT_REG) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100243 continue;
244 }
245
Narayan Kamathbd863722017-06-01 18:50:12 +0100246 const std::string base_name(entry->d_name);
247 if (base_name.find(file_prefix) != 0) {
248 continue;
249 }
250
251 const std::string abs_path = dir_path + base_name;
252 android::base::unique_fd fd(
253 TEMP_FAILURE_RETRY(open(abs_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW | O_NONBLOCK)));
254 if (fd == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700255 MYLOGW("Unable to open dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamathbd863722017-06-01 18:50:12 +0100256 break;
257 }
258
259 struct stat st = {};
260 if (fstat(fd, &st) == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700261 MYLOGW("Unable to stat dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamath8f788292017-05-25 13:20:39 +0100262 continue;
263 }
264
Narayan Kamath3f31b632018-02-22 19:42:36 +0000265 if (limit_by_mtime && st.st_mtime < thirty_minutes_ago) {
Narayan Kamathbd863722017-06-01 18:50:12 +0100266 MYLOGI("Excluding stale dump file: %s\n", abs_path.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100267 continue;
268 }
269
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700270 dump_data.emplace_back(DumpData{abs_path, std::move(fd), st.st_mtime});
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700271 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100272
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700273 // Sort in descending modification time so that we only keep the newest
274 // reports if |limit_by_count| is true.
275 std::sort(dump_data.begin(), dump_data.end(),
276 [](const DumpData& d1, const DumpData& d2) { return d1.mtime > d2.mtime; });
Narayan Kamath8f788292017-05-25 13:20:39 +0100277
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700278 if (limit_by_count && dump_data.size() > 10) {
279 dump_data.erase(dump_data.begin() + 10, dump_data.end());
Andreas Gamped0d76952017-08-22 13:08:37 -0700280 }
281
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700282 return dump_data;
Narayan Kamath8f788292017-05-25 13:20:39 +0100283}
284
Narayan Kamathbd863722017-06-01 18:50:12 +0100285static bool AddDumps(const std::vector<DumpData>::const_iterator start,
286 const std::vector<DumpData>::const_iterator end,
287 const char* type_name, const bool add_to_zip) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100288 bool dumped = false;
Narayan Kamathbd863722017-06-01 18:50:12 +0100289 for (auto it = start; it != end; ++it) {
290 const std::string& name = it->name;
291 const int fd = it->fd;
Narayan Kamath8f788292017-05-25 13:20:39 +0100292 dumped = true;
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100293
294 // Seek to the beginning of the file before dumping any data. A given
295 // DumpData entry might be dumped multiple times in the report.
296 //
297 // For example, the most recent ANR entry is dumped to the body of the
298 // main entry and it also shows up as a separate entry in the bugreport
299 // ZIP file.
300 if (lseek(fd, 0, SEEK_SET) != static_cast<off_t>(0)) {
301 MYLOGE("Unable to add %s to zip file, lseek failed: %s\n", name.c_str(),
302 strerror(errno));
303 }
304
Narayan Kamath8f788292017-05-25 13:20:39 +0100305 if (ds.IsZipping() && add_to_zip) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800306 if (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + name, fd, /* timeout = */ 0ms) != OK) {
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100307 MYLOGE("Unable to add %s to zip file, addZipEntryFromFd failed\n", name.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100308 }
309 } else {
310 dump_file_from_fd(type_name, name.c_str(), fd);
311 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100312 }
313
314 return dumped;
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700315}
316
Felipe Leme635ca312016-01-05 14:23:02 -0800317// for_each_pid() callback to get mount info about a process.
Felipe Leme4c2d6632016-09-28 14:32:00 -0700318void do_mountinfo(int pid, const char* name __attribute__((unused))) {
Felipe Leme635ca312016-01-05 14:23:02 -0800319 char path[PATH_MAX];
320
321 // Gets the the content of the /proc/PID/ns/mnt link, so only unique mount points
322 // are added.
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700323 snprintf(path, sizeof(path), "/proc/%d/ns/mnt", pid);
Felipe Leme635ca312016-01-05 14:23:02 -0800324 char linkname[PATH_MAX];
325 ssize_t r = readlink(path, linkname, PATH_MAX);
326 if (r == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800327 MYLOGE("Unable to read link for %s: %s\n", path, strerror(errno));
Felipe Leme635ca312016-01-05 14:23:02 -0800328 return;
329 }
330 linkname[r] = '\0';
331
332 if (mount_points.find(linkname) == mount_points.end()) {
333 // First time this mount point was found: add it
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700334 snprintf(path, sizeof(path), "/proc/%d/mountinfo", pid);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700335 if (ds.AddZipEntry(ZIP_ROOT_DIR + path, path)) {
Felipe Leme635ca312016-01-05 14:23:02 -0800336 mount_points.insert(linkname);
337 } else {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800338 MYLOGE("Unable to add mountinfo %s to zip file\n", path);
Felipe Leme635ca312016-01-05 14:23:02 -0800339 }
340 }
341}
342
343void add_mountinfo() {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700344 if (!ds.IsZipping()) return;
Felipe Leme678727a2016-09-21 17:22:11 -0700345 std::string title = "MOUNT INFO";
Felipe Leme635ca312016-01-05 14:23:02 -0800346 mount_points.clear();
Felipe Leme46b85da2016-11-21 17:40:45 -0800347 DurationReporter duration_reporter(title, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700348 for_each_pid(do_mountinfo, nullptr);
349 MYLOGD("%s: %d entries added to zip file\n", title.c_str(), (int)mount_points.size());
Felipe Leme635ca312016-01-05 14:23:02 -0800350}
351
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700352static void dump_dev_files(const char *title, const char *driverpath, const char *filename)
353{
354 DIR *d;
355 struct dirent *de;
356 char path[PATH_MAX];
357
358 d = opendir(driverpath);
Yi Kong19d5c002018-07-20 13:39:55 -0700359 if (d == nullptr) {
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700360 return;
361 }
362
363 while ((de = readdir(d))) {
364 if (de->d_type != DT_LNK) {
365 continue;
366 }
367 snprintf(path, sizeof(path), "%s/%s/%s", driverpath, de->d_name, filename);
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700368 DumpFile(title, path);
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700369 }
370
371 closedir(d);
372}
373
Zhengyin Qian068ecc72016-08-10 16:48:14 -0700374
Zhengyin Qian068ecc72016-08-10 16:48:14 -0700375
376// dump anrd's trace and add to the zip file.
377// 1. check if anrd is running on this device.
378// 2. send a SIGUSR1 to its pid which will dump anrd's trace.
379// 3. wait until the trace generation completes and add to the zip file.
380static bool dump_anrd_trace() {
381 unsigned int pid;
382 char buf[50], path[PATH_MAX];
383 struct dirent *trace;
384 struct stat st;
385 DIR *trace_dir;
Zhengyin Qianafc38fe2016-09-08 16:50:09 -0700386 int retry = 5;
387 long max_ctime = 0, old_mtime;
Zhengyin Qian068ecc72016-08-10 16:48:14 -0700388 long long cur_size = 0;
389 const char *trace_path = "/data/misc/anrd/";
390
Felipe Leme1d486fe2016-10-14 18:06:47 -0700391 if (!ds.IsZipping()) {
392 MYLOGE("Not dumping anrd trace because it's not a zipped bugreport\n");
Zhengyin Qian068ecc72016-08-10 16:48:14 -0700393 return false;
394 }
395
396 // find anrd's pid if it is running.
Dan Willemsen4a0a8342018-05-04 13:05:01 -0700397 pid = GetPidByName("/system/bin/anrd");
Zhengyin Qian068ecc72016-08-10 16:48:14 -0700398
399 if (pid > 0) {
Zhengyin Qianafc38fe2016-09-08 16:50:09 -0700400 if (stat(trace_path, &st) == 0) {
401 old_mtime = st.st_mtime;
402 } else {
403 MYLOGE("Failed to find: %s\n", trace_path);
404 return false;
405 }
406
Zhengyin Qian068ecc72016-08-10 16:48:14 -0700407 // send SIGUSR1 to the anrd to generate a trace.
408 sprintf(buf, "%u", pid);
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700409 if (RunCommand("ANRD_DUMP", {"kill", "-SIGUSR1", buf},
Felipe Leme30dbfa12016-09-02 12:43:26 -0700410 CommandOptions::WithTimeout(1).Build())) {
Zhengyin Qian068ecc72016-08-10 16:48:14 -0700411 MYLOGE("anrd signal timed out. Please manually collect trace\n");
412 return false;
413 }
414
Zhengyin Qianafc38fe2016-09-08 16:50:09 -0700415 while (retry-- > 0 && old_mtime == st.st_mtime) {
416 sleep(1);
417 stat(trace_path, &st);
418 }
419
420 if (retry < 0 && old_mtime == st.st_mtime) {
421 MYLOGE("Failed to stat %s or trace creation timeout\n", trace_path);
422 return false;
423 }
424
Zhengyin Qian068ecc72016-08-10 16:48:14 -0700425 // identify the trace file by its creation time.
426 if (!(trace_dir = opendir(trace_path))) {
427 MYLOGE("Can't open trace file under %s\n", trace_path);
428 }
429 while ((trace = readdir(trace_dir))) {
430 if (strcmp(trace->d_name, ".") == 0
431 || strcmp(trace->d_name, "..") == 0) {
432 continue;
433 }
434 sprintf(path, "%s%s", trace_path, trace->d_name);
435 if (stat(path, &st) == 0) {
436 if (st.st_ctime > max_ctime) {
437 max_ctime = st.st_ctime;
438 sprintf(buf, "%s", trace->d_name);
439 }
440 }
441 }
442 closedir(trace_dir);
443
444 // Wait until the dump completes by checking the size of the trace.
445 if (max_ctime > 0) {
446 sprintf(path, "%s%s", trace_path, buf);
447 while(true) {
448 sleep(1);
449 if (stat(path, &st) == 0) {
450 if (st.st_size == cur_size) {
451 break;
452 } else if (st.st_size > cur_size) {
453 cur_size = st.st_size;
454 } else {
455 return false;
456 }
457 } else {
458 MYLOGE("Cant stat() %s anymore\n", path);
459 return false;
460 }
461 }
462 // Add to the zip file.
Felipe Leme1d486fe2016-10-14 18:06:47 -0700463 if (!ds.AddZipEntry("anrd_trace.txt", path)) {
Zhengyin Qian068ecc72016-08-10 16:48:14 -0700464 MYLOGE("Unable to add anrd_trace file %s to zip file\n", path);
465 } else {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000466 android::os::UnlinkAndLogOnError(path);
Zhengyin Qian068ecc72016-08-10 16:48:14 -0700467 return true;
468 }
469 } else {
470 MYLOGE("Can't stats any trace file under %s\n", trace_path);
471 }
472 }
473 return false;
474}
475
Mark Salyzyn326842f2015-04-30 09:49:41 -0700476static bool skip_not_stat(const char *path) {
477 static const char stat[] = "/stat";
478 size_t len = strlen(path);
479 if (path[len - 1] == '/') { /* Directory? */
480 return false;
481 }
482 return strcmp(path + len - sizeof(stat) + 1, stat); /* .../stat? */
483}
484
Felipe Leme4c2d6632016-09-28 14:32:00 -0700485static bool skip_none(const char* path __attribute__((unused))) {
Felipe Lemee82a27d2016-01-05 13:35:44 -0800486 return false;
487}
488
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700489unsigned long worst_write_perf = 20000; /* in KB/s */
Mark Salyzyn326842f2015-04-30 09:49:41 -0700490
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800491//
492// stat offsets
493// Name units description
494// ---- ----- -----------
495// read I/Os requests number of read I/Os processed
496#define __STAT_READ_IOS 0
497// read merges requests number of read I/Os merged with in-queue I/O
498#define __STAT_READ_MERGES 1
499// read sectors sectors number of sectors read
500#define __STAT_READ_SECTORS 2
501// read ticks milliseconds total wait time for read requests
502#define __STAT_READ_TICKS 3
503// write I/Os requests number of write I/Os processed
504#define __STAT_WRITE_IOS 4
505// write merges requests number of write I/Os merged with in-queue I/O
506#define __STAT_WRITE_MERGES 5
507// write sectors sectors number of sectors written
508#define __STAT_WRITE_SECTORS 6
509// write ticks milliseconds total wait time for write requests
510#define __STAT_WRITE_TICKS 7
511// in_flight requests number of I/Os currently in flight
512#define __STAT_IN_FLIGHT 8
513// io_ticks milliseconds total time this block device has been active
514#define __STAT_IO_TICKS 9
515// time_in_queue milliseconds total wait time for all requests
516#define __STAT_IN_QUEUE 10
517#define __STAT_NUMBER_FIELD 11
518//
519// read I/Os, write I/Os
520// =====================
521//
522// These values increment when an I/O request completes.
523//
524// read merges, write merges
525// =========================
526//
527// These values increment when an I/O request is merged with an
528// already-queued I/O request.
529//
530// read sectors, write sectors
531// ===========================
532//
533// These values count the number of sectors read from or written to this
534// block device. The "sectors" in question are the standard UNIX 512-byte
535// sectors, not any device- or filesystem-specific block size. The
536// counters are incremented when the I/O completes.
537#define SECTOR_SIZE 512
538//
539// read ticks, write ticks
540// =======================
541//
542// These values count the number of milliseconds that I/O requests have
543// waited on this block device. If there are multiple I/O requests waiting,
544// these values will increase at a rate greater than 1000/second; for
545// example, if 60 read requests wait for an average of 30 ms, the read_ticks
546// field will increase by 60*30 = 1800.
547//
548// in_flight
549// =========
550//
551// This value counts the number of I/O requests that have been issued to
552// the device driver but have not yet completed. It does not include I/O
553// requests that are in the queue but not yet issued to the device driver.
554//
555// io_ticks
556// ========
557//
558// This value counts the number of milliseconds during which the device has
559// had I/O requests queued.
560//
561// time_in_queue
562// =============
563//
564// This value counts the number of milliseconds that I/O requests have waited
565// on this block device. If there are multiple I/O requests waiting, this
566// value will increase as the product of the number of milliseconds times the
567// number of requests waiting (see "read ticks" above for an example).
568#define S_TO_MS 1000
569//
570
Mark Salyzyn326842f2015-04-30 09:49:41 -0700571static int dump_stat_from_fd(const char *title __unused, const char *path, int fd) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800572 unsigned long long fields[__STAT_NUMBER_FIELD];
Mark Salyzyn326842f2015-04-30 09:49:41 -0700573 bool z;
Yi Kong19d5c002018-07-20 13:39:55 -0700574 char *cp, *buffer = nullptr;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700575 size_t i = 0;
Josh Gao7c4258c2018-06-25 13:40:08 -0700576 FILE *fp = fdopen(dup(fd), "rb");
Mark Salyzyn326842f2015-04-30 09:49:41 -0700577 getline(&buffer, &i, fp);
578 fclose(fp);
579 if (!buffer) {
580 return -errno;
581 }
582 i = strlen(buffer);
583 while ((i > 0) && (buffer[i - 1] == '\n')) {
584 buffer[--i] = '\0';
585 }
586 if (!*buffer) {
587 free(buffer);
588 return 0;
589 }
590 z = true;
591 for (cp = buffer, i = 0; i < (sizeof(fields) / sizeof(fields[0])); ++i) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800592 fields[i] = strtoull(cp, &cp, 10);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700593 if (fields[i] != 0) {
594 z = false;
595 }
596 }
597 if (z) { /* never accessed */
598 free(buffer);
599 return 0;
600 }
601
Wei Wang509bb5d2017-06-09 14:42:12 -0700602 if (!strncmp(path, BLK_DEV_SYS_DIR, sizeof(BLK_DEV_SYS_DIR) - 1)) {
603 path += sizeof(BLK_DEV_SYS_DIR) - 1;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700604 }
Wei Wang1dc1ef52017-06-12 11:28:37 -0700605
606 printf("%-30s:%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s\n%-30s:\t%s\n", "Block-Dev",
607 "R-IOs", "R-merg", "R-sect", "R-wait", "W-IOs", "W-merg", "W-sect",
608 "W-wait", "in-fli", "activ", "T-wait", path, buffer);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700609 free(buffer);
610
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800611 if (fields[__STAT_IO_TICKS]) {
612 unsigned long read_perf = 0;
613 unsigned long read_ios = 0;
614 if (fields[__STAT_READ_TICKS]) {
615 unsigned long long divisor = fields[__STAT_READ_TICKS]
616 * fields[__STAT_IO_TICKS];
617 read_perf = ((unsigned long long)SECTOR_SIZE
618 * fields[__STAT_READ_SECTORS]
619 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
620 / divisor;
621 read_ios = ((unsigned long long)S_TO_MS * fields[__STAT_READ_IOS]
622 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
623 / divisor;
624 }
625
626 unsigned long write_perf = 0;
627 unsigned long write_ios = 0;
628 if (fields[__STAT_WRITE_TICKS]) {
629 unsigned long long divisor = fields[__STAT_WRITE_TICKS]
630 * fields[__STAT_IO_TICKS];
631 write_perf = ((unsigned long long)SECTOR_SIZE
632 * fields[__STAT_WRITE_SECTORS]
633 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
634 / divisor;
635 write_ios = ((unsigned long long)S_TO_MS * fields[__STAT_WRITE_IOS]
636 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
637 / divisor;
638 }
639
640 unsigned queue = (fields[__STAT_IN_QUEUE]
641 + (fields[__STAT_IO_TICKS] >> 1))
642 / fields[__STAT_IO_TICKS];
643
644 if (!write_perf && !write_ios) {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700645 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 -0800646 } else {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700647 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 -0800648 read_ios, write_perf, write_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800649 }
650
651 /* bugreport timeout factor adjustment */
652 if ((write_perf > 1) && (write_perf < worst_write_perf)) {
653 worst_write_perf = write_perf;
654 }
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700655 }
Mark Salyzyn326842f2015-04-30 09:49:41 -0700656 return 0;
657}
658
Yao Chenbe3bbc12018-01-17 16:31:10 -0800659static const long MINIMUM_LOGCAT_TIMEOUT_MS = 50000;
660
661/* timeout in ms to read a list of buffers */
662static unsigned long logcat_timeout(const std::vector<std::string>& buffers) {
663 unsigned long timeout_ms = 0;
664 for (const auto& buffer : buffers) {
665 log_id_t id = android_name_to_log_id(buffer.c_str());
666 unsigned long property_size = __android_logger_get_buffer_size(id);
667 /* Engineering margin is ten-fold our guess */
668 timeout_ms += 10 * (property_size + worst_write_perf) / worst_write_perf;
669 }
670 return timeout_ms > MINIMUM_LOGCAT_TIMEOUT_MS ? timeout_ms : MINIMUM_LOGCAT_TIMEOUT_MS;
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700671}
672
Nandana Duttd2f5f082019-01-18 17:13:52 +0000673Dumpstate::ConsentCallback::ConsentCallback() : result_(UNAVAILABLE), start_time_(Nanotime()) {
674}
675
676android::binder::Status Dumpstate::ConsentCallback::onReportApproved() {
677 std::lock_guard<std::mutex> lock(lock_);
678 result_ = APPROVED;
679 MYLOGD("User approved consent to share bugreport\n");
680 return android::binder::Status::ok();
681}
682
683android::binder::Status Dumpstate::ConsentCallback::onReportDenied() {
684 std::lock_guard<std::mutex> lock(lock_);
685 result_ = DENIED;
686 MYLOGW("User denied consent to share bugreport\n");
687 return android::binder::Status::ok();
688}
689
690UserConsentResult Dumpstate::ConsentCallback::getResult() {
691 std::lock_guard<std::mutex> lock(lock_);
692 return result_;
693}
694
695uint64_t Dumpstate::ConsentCallback::getElapsedTimeMs() const {
696 return Nanotime() - start_time_;
697}
698
Felipe Leme2b9b06c2016-10-14 09:13:06 -0700699void Dumpstate::PrintHeader() const {
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700700 std::string build, fingerprint, radio, bootloader, network;
701 char date[80];
Colin Crossf45fa6b2012-03-26 12:38:26 -0700702
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700703 build = android::base::GetProperty("ro.build.display.id", "(unknown)");
704 fingerprint = android::base::GetProperty("ro.build.fingerprint", "(unknown)");
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700705 radio = android::base::GetProperty("gsm.version.baseband", "(unknown)");
706 bootloader = android::base::GetProperty("ro.bootloader", "(unknown)");
707 network = android::base::GetProperty("gsm.operator.alpha", "(unknown)");
Felipe Lemebbaf3c12016-10-11 14:32:25 -0700708 strftime(date, sizeof(date), "%Y-%m-%d %H:%M:%S", localtime(&now_));
Colin Crossf45fa6b2012-03-26 12:38:26 -0700709
Felipe Lemed8b94e52016-12-08 10:21:44 -0800710 printf("========================================================\n");
711 printf("== dumpstate: %s\n", date);
712 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -0700713
Felipe Lemed8b94e52016-12-08 10:21:44 -0800714 printf("\n");
715 printf("Build: %s\n", build.c_str());
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700716 // NOTE: fingerprint entry format is important for other tools.
Felipe Lemed8b94e52016-12-08 10:21:44 -0800717 printf("Build fingerprint: '%s'\n", fingerprint.c_str());
718 printf("Bootloader: %s\n", bootloader.c_str());
719 printf("Radio: %s\n", radio.c_str());
720 printf("Network: %s\n", network.c_str());
Colin Crossf45fa6b2012-03-26 12:38:26 -0700721
Felipe Lemed8b94e52016-12-08 10:21:44 -0800722 printf("Kernel: ");
Felipe Lemef0292972016-11-22 13:57:05 -0800723 DumpFileToFd(STDOUT_FILENO, "", "/proc/version");
Felipe Lemed8b94e52016-12-08 10:21:44 -0800724 printf("Command line: %s\n", strtok(cmdline_buf, "\n"));
Felipe Leme7709f8a2017-12-05 09:30:09 -0800725 printf("Uptime: ");
726 RunCommandToFd(STDOUT_FILENO, "", {"uptime", "-p"},
727 CommandOptions::WithTimeout(1).Always().Build());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800728 printf("Bugreport format version: %s\n", version_.c_str());
729 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 +0100730 PropertiesHelper::IsDryRun(), options_->args.c_str(), options_->extra_options.c_str());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800731 printf("\n");
Felipe Leme78f2c862015-12-21 09:55:22 -0800732}
733
Felipe Leme24b66ee2016-06-16 10:55:26 -0700734// List of file extensions that can cause a zip file attachment to be rejected by some email
735// service providers.
736static const std::set<std::string> PROBLEMATIC_FILE_EXTENSIONS = {
737 ".ade", ".adp", ".bat", ".chm", ".cmd", ".com", ".cpl", ".exe", ".hta", ".ins", ".isp",
738 ".jar", ".jse", ".lib", ".lnk", ".mde", ".msc", ".msp", ".mst", ".pif", ".scr", ".sct",
739 ".shb", ".sys", ".vb", ".vbe", ".vbs", ".vxd", ".wsc", ".wsf", ".wsh"
740};
741
Vishnu Naire97d6122018-01-18 13:58:56 -0800742status_t Dumpstate::AddZipEntryFromFd(const std::string& entry_name, int fd,
743 std::chrono::milliseconds timeout = 0ms) {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700744 if (!IsZipping()) {
745 MYLOGD("Not adding zip entry %s from fd because it's not a zipped bugreport\n",
746 entry_name.c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -0800747 return INVALID_OPERATION;
Felipe Leme111b9d02016-02-03 09:28:24 -0800748 }
Felipe Leme24b66ee2016-06-16 10:55:26 -0700749 std::string valid_name = entry_name;
750
751 // Rename extension if necessary.
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -0700752 size_t idx = entry_name.rfind('.');
Felipe Leme24b66ee2016-06-16 10:55:26 -0700753 if (idx != std::string::npos) {
754 std::string extension = entry_name.substr(idx);
755 std::transform(extension.begin(), extension.end(), extension.begin(), ::tolower);
756 if (PROBLEMATIC_FILE_EXTENSIONS.count(extension) != 0) {
757 valid_name = entry_name + ".renamed";
758 MYLOGI("Renaming entry %s to %s\n", entry_name.c_str(), valid_name.c_str());
759 }
760 }
761
Felipe Leme6fe9db62016-02-12 09:04:16 -0800762 // Logging statement below is useful to time how long each entry takes, but it's too verbose.
763 // MYLOGD("Adding zip entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700764 int32_t err = zip_writer_->StartEntryWithTime(valid_name.c_str(), ZipWriter::kCompress,
765 get_mtime(fd, ds.now_));
Felipe Leme1d486fe2016-10-14 18:06:47 -0700766 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700767 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", valid_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700768 ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800769 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800770 }
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000771 bool finished_entry = false;
772 auto finish_entry = [this, &finished_entry] {
773 if (!finished_entry) {
774 // This should only be called when we're going to return an earlier error,
775 // which would've been logged. This may imply the file is already corrupt
776 // and any further logging from FinishEntry is more likely to mislead than
777 // not.
778 this->zip_writer_->FinishEntry();
779 }
780 };
781 auto scope_guard = android::base::make_scope_guard(finish_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -0800782 auto start = std::chrono::steady_clock::now();
783 auto end = start + timeout;
784 struct pollfd pfd = {fd, POLLIN};
Felipe Lemee82a27d2016-01-05 13:35:44 -0800785
Felipe Leme770410d2016-01-26 17:07:14 -0800786 std::vector<uint8_t> buffer(65536);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800787 while (1) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800788 if (timeout.count() > 0) {
789 // lambda to recalculate the timeout.
790 auto time_left_ms = [end]() {
791 auto now = std::chrono::steady_clock::now();
792 auto diff = std::chrono::duration_cast<std::chrono::milliseconds>(end - now);
793 return std::max(diff.count(), 0LL);
794 };
795
796 int rc = TEMP_FAILURE_RETRY(poll(&pfd, 1, time_left_ms()));
797 if (rc < 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000798 MYLOGE("Error in poll while adding from fd to zip entry %s:%s\n",
799 entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800800 return -errno;
801 } else if (rc == 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000802 MYLOGE("Timed out adding from fd to zip entry %s:%s Timeout:%lldms\n",
Vishnu Naire97d6122018-01-18 13:58:56 -0800803 entry_name.c_str(), strerror(errno), timeout.count());
804 return TIMED_OUT;
805 }
806 }
807
Zach Riggle22200402016-08-18 01:01:24 -0400808 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800809 if (bytes_read == 0) {
810 break;
811 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800812 MYLOGE("read(%s): %s\n", entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800813 return -errno;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800814 }
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700815 err = zip_writer_->WriteBytes(buffer.data(), bytes_read);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800816 if (err) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700817 MYLOGE("zip_writer_->WriteBytes(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800818 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800819 }
820 }
821
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700822 err = zip_writer_->FinishEntry();
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000823 finished_entry = true;
Felipe Leme1d486fe2016-10-14 18:06:47 -0700824 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700825 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800826 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800827 }
828
Vishnu Naire97d6122018-01-18 13:58:56 -0800829 return OK;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800830}
831
Felipe Leme1d486fe2016-10-14 18:06:47 -0700832bool Dumpstate::AddZipEntry(const std::string& entry_name, const std::string& entry_path) {
833 android::base::unique_fd fd(
834 TEMP_FAILURE_RETRY(open(entry_path.c_str(), O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
Andreas Gampeaff68432016-07-18 18:01:27 -0700835 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800836 MYLOGE("open(%s): %s\n", entry_path.c_str(), strerror(errno));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800837 return false;
838 }
839
Vishnu Naire97d6122018-01-18 13:58:56 -0800840 return (AddZipEntryFromFd(entry_name, fd.get()) == OK);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800841}
842
843/* adds a file to the existing zipped bugreport */
Felipe Leme4c2d6632016-09-28 14:32:00 -0700844static int _add_file_from_fd(const char* title __attribute__((unused)), const char* path, int fd) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800845 return (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + path, fd) == OK) ? 0 : 1;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800846}
847
Felipe Leme1d486fe2016-10-14 18:06:47 -0700848void Dumpstate::AddDir(const std::string& dir, bool recursive) {
849 if (!IsZipping()) {
850 MYLOGD("Not adding dir %s because it's not a zipped bugreport\n", dir.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800851 return;
852 }
Felipe Leme678727a2016-09-21 17:22:11 -0700853 MYLOGD("Adding dir %s (recursive: %d)\n", dir.c_str(), recursive);
Felipe Leme46b85da2016-11-21 17:40:45 -0800854 DurationReporter duration_reporter(dir, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700855 dump_files("", dir.c_str(), recursive ? skip_none : is_dir, _add_file_from_fd);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800856}
857
Felipe Leme1d486fe2016-10-14 18:06:47 -0700858bool Dumpstate::AddTextZipEntry(const std::string& entry_name, const std::string& content) {
859 if (!IsZipping()) {
860 MYLOGD("Not adding text zip entry %s because it's not a zipped bugreport\n",
861 entry_name.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800862 return false;
863 }
Felipe Lemecbce55d2016-02-08 09:53:18 -0800864 MYLOGD("Adding zip text entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700865 int32_t err = zip_writer_->StartEntryWithTime(entry_name.c_str(), ZipWriter::kCompress, ds.now_);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700866 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700867 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700868 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800869 return false;
870 }
871
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700872 err = zip_writer_->WriteBytes(content.c_str(), content.length());
Felipe Leme1d486fe2016-10-14 18:06:47 -0700873 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700874 MYLOGE("zip_writer_->WriteBytes(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700875 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800876 return false;
877 }
878
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700879 err = zip_writer_->FinishEntry();
Felipe Leme1d486fe2016-10-14 18:06:47 -0700880 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700881 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800882 return false;
883 }
884
885 return true;
886}
887
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800888static void DoKmsg() {
889 struct stat st;
890 if (!stat(PSTORE_LAST_KMSG, &st)) {
891 /* Also TODO: Make console-ramoops CAP_SYSLOG protected. */
892 DumpFile("LAST KMSG", PSTORE_LAST_KMSG);
893 } else if (!stat(ALT_PSTORE_LAST_KMSG, &st)) {
894 DumpFile("LAST KMSG", ALT_PSTORE_LAST_KMSG);
895 } else {
896 /* TODO: Make last_kmsg CAP_SYSLOG protected. b/5555691 */
897 DumpFile("LAST KMSG", "/proc/last_kmsg");
898 }
899}
900
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800901static void DoKernelLogcat() {
Yao Chenbe3bbc12018-01-17 16:31:10 -0800902 unsigned long timeout_ms = logcat_timeout({"kernel"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800903 RunCommand(
904 "KERNEL LOG",
905 {"logcat", "-b", "kernel", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
906 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
907}
908
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800909static void DoLogcat() {
Vishnu Nair6921f802017-11-22 09:17:23 -0800910 unsigned long timeout_ms;
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800911 // DumpFile("EVENT LOG TAGS", "/etc/event-log-tags");
912 // calculate timeout
Yao Chenbe3bbc12018-01-17 16:31:10 -0800913 timeout_ms = logcat_timeout({"main", "system", "crash"});
Tony Makae737652017-03-30 17:47:09 +0100914 RunCommand("SYSTEM LOG",
Vishnu Nair6921f802017-11-22 09:17:23 -0800915 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
916 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -0800917 timeout_ms = logcat_timeout({"events"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800918 RunCommand(
919 "EVENT LOG",
920 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
921 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -0800922 timeout_ms = logcat_timeout({"stats"});
923 RunCommand(
924 "STATS LOG",
925 {"logcat", "-b", "stats", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
926 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
927 timeout_ms = logcat_timeout({"radio"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800928 RunCommand(
929 "RADIO LOG",
930 {"logcat", "-b", "radio", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
931 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800932
933 RunCommand("LOG STATISTICS", {"logcat", "-b", "all", "-S"});
934
935 /* kernels must set CONFIG_PSTORE_PMSG, slice up pstore with device tree */
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800936 RunCommand("LAST LOGCAT", {"logcat", "-L", "-b", "all", "-v", "threadtime", "-v", "printable",
937 "-v", "uid", "-d", "*:v"});
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800938}
939
Jayachandran Ca94c7172017-06-10 15:08:12 -0700940static void DumpIpTablesAsRoot() {
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700941 RunCommand("IPTABLES", {"iptables", "-L", "-nvx"});
942 RunCommand("IP6TABLES", {"ip6tables", "-L", "-nvx"});
Erik Kline32af8c22016-09-28 17:26:26 +0900943 RunCommand("IPTABLES NAT", {"iptables", "-t", "nat", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -0700944 /* no ip6 nat */
Erik Kline32af8c22016-09-28 17:26:26 +0900945 RunCommand("IPTABLES MANGLE", {"iptables", "-t", "mangle", "-L", "-nvx"});
946 RunCommand("IP6TABLES MANGLE", {"ip6tables", "-t", "mangle", "-L", "-nvx"});
947 RunCommand("IPTABLES RAW", {"iptables", "-t", "raw", "-L", "-nvx"});
948 RunCommand("IP6TABLES RAW", {"ip6tables", "-t", "raw", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -0700949}
950
Narayan Kamath8f788292017-05-25 13:20:39 +0100951static void AddAnrTraceDir(const bool add_to_zip, const std::string& anr_traces_dir) {
952 MYLOGD("AddAnrTraceDir(): dump_traces_file=%s, anr_traces_dir=%s\n", dump_traces_path,
953 anr_traces_dir.c_str());
954
955 // If we're here, dump_traces_path will always be a temporary file
956 // (created with mkostemp or similar) that contains dumps taken earlier
957 // on in the process.
958 if (dump_traces_path != nullptr) {
959 if (add_to_zip) {
960 ds.AddZipEntry(ZIP_ROOT_DIR + anr_traces_dir + "/traces-just-now.txt", dump_traces_path);
961 } else {
962 MYLOGD("Dumping current ANR traces (%s) to the main bugreport entry\n",
963 dump_traces_path);
964 ds.DumpFile("VM TRACES JUST NOW", dump_traces_path);
965 }
966
967 const int ret = unlink(dump_traces_path);
968 if (ret == -1) {
969 MYLOGW("Error unlinking temporary trace path %s: %s\n", dump_traces_path,
970 strerror(errno));
Felipe Lemee184f662016-10-27 10:04:47 -0700971 }
972 }
973
Narayan Kamathbd863722017-06-01 18:50:12 +0100974 // Add a specific message for the first ANR Dump.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700975 if (ds.anr_data_.size() > 0) {
976 AddDumps(ds.anr_data_.begin(), ds.anr_data_.begin() + 1,
Narayan Kamathbd863722017-06-01 18:50:12 +0100977 "VM TRACES AT LAST ANR", add_to_zip);
978
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100979 // The "last" ANR will always be included as separate entry in the zip file. In addition,
980 // it will be present in the body of the main entry if |add_to_zip| == false.
981 //
982 // Historical ANRs are always included as separate entries in the bugreport zip file.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700983 AddDumps(ds.anr_data_.begin() + ((add_to_zip) ? 1 : 0), ds.anr_data_.end(),
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100984 "HISTORICAL ANR", true /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +0100985 } else {
Narayan Kamath8f788292017-05-25 13:20:39 +0100986 printf("*** NO ANRs to dump in %s\n\n", ANR_DIR.c_str());
987 }
988}
989
990static void AddAnrTraceFiles() {
991 const bool add_to_zip = ds.IsZipping() && ds.version_ == VERSION_SPLIT_ANR;
992
Elliott Hughes69fe5ec2018-03-23 11:04:25 -0700993 std::string anr_traces_dir = "/data/anr";
Narayan Kamath8f788292017-05-25 13:20:39 +0100994
Elliott Hughes69fe5ec2018-03-23 11:04:25 -0700995 AddAnrTraceDir(add_to_zip, anr_traces_dir);
Narayan Kamath8f788292017-05-25 13:20:39 +0100996
Makoto Onuki83ec63f2019-01-31 17:08:59 -0800997 RunCommand("ANR FILES", {"ls", "-lt", ANR_DIR});
998
Elliott Hughes69fe5ec2018-03-23 11:04:25 -0700999 // Slow traces for slow operations.
Felipe Lemee184f662016-10-27 10:04:47 -07001000 struct stat st;
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001001 int i = 0;
1002 while (true) {
1003 const std::string slow_trace_path =
1004 anr_traces_dir + android::base::StringPrintf("slow%02d.txt", i);
1005 if (stat(slow_trace_path.c_str(), &st)) {
1006 // No traces file at this index, done with the files.
1007 break;
Felipe Lemee184f662016-10-27 10:04:47 -07001008 }
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001009 ds.DumpFile("VM TRACES WHEN SLOW", slow_trace_path.c_str());
1010 i++;
Felipe Lemee184f662016-10-27 10:04:47 -07001011 }
1012}
1013
Wei Wang509bb5d2017-06-09 14:42:12 -07001014static void DumpBlockStatFiles() {
1015 DurationReporter duration_reporter("DUMP BLOCK STAT");
Wei Wang509bb5d2017-06-09 14:42:12 -07001016
Wei Wang1dc1ef52017-06-12 11:28:37 -07001017 std::unique_ptr<DIR, std::function<int(DIR*)>> dirptr(opendir(BLK_DEV_SYS_DIR), closedir);
1018
1019 if (dirptr == nullptr) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001020 MYLOGE("Failed to open %s: %s\n", BLK_DEV_SYS_DIR, strerror(errno));
1021 return;
1022 }
1023
1024 printf("------ DUMP BLOCK STAT ------\n\n");
Wei Wang1dc1ef52017-06-12 11:28:37 -07001025 while (struct dirent *d = readdir(dirptr.get())) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001026 if ((d->d_name[0] == '.')
1027 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
1028 || (d->d_name[1] == '\0'))) {
1029 continue;
1030 }
1031 const std::string new_path =
1032 android::base::StringPrintf("%s/%s", BLK_DEV_SYS_DIR, d->d_name);
1033 printf("------ BLOCK STAT (%s) ------\n", new_path.c_str());
1034 dump_files("", new_path.c_str(), skip_not_stat, dump_stat_from_fd);
1035 printf("\n");
1036 }
Wei Wang1dc1ef52017-06-12 11:28:37 -07001037 return;
Wei Wang509bb5d2017-06-09 14:42:12 -07001038}
Jayachandran Ca94c7172017-06-10 15:08:12 -07001039
1040static void DumpPacketStats() {
1041 DumpFile("NETWORK DEV INFO", "/proc/net/dev");
1042 DumpFile("QTAGUID NETWORK INTERFACES INFO", "/proc/net/xt_qtaguid/iface_stat_all");
1043 DumpFile("QTAGUID NETWORK INTERFACES INFO (xt)", "/proc/net/xt_qtaguid/iface_stat_fmt");
1044 DumpFile("QTAGUID CTRL INFO", "/proc/net/xt_qtaguid/ctrl");
1045 DumpFile("QTAGUID STATS INFO", "/proc/net/xt_qtaguid/stats");
1046}
1047
1048static void DumpIpAddrAndRules() {
1049 /* The following have a tendency to get wedged when wifi drivers/fw goes belly-up. */
1050 RunCommand("NETWORK INTERFACES", {"ip", "link"});
1051 RunCommand("IPv4 ADDRESSES", {"ip", "-4", "addr", "show"});
1052 RunCommand("IPv6 ADDRESSES", {"ip", "-6", "addr", "show"});
1053 RunCommand("IP RULES", {"ip", "rule", "show"});
1054 RunCommand("IP RULES v6", {"ip", "-6", "rule", "show"});
1055}
1056
Vishnu Nair64afc022018-02-01 15:29:34 -08001057static void RunDumpsysTextByPriority(const std::string& title, int priority,
1058 std::chrono::milliseconds timeout,
1059 std::chrono::milliseconds service_timeout) {
1060 auto start = std::chrono::steady_clock::now();
Vishnu Naire97d6122018-01-18 13:58:56 -08001061 sp<android::IServiceManager> sm = defaultServiceManager();
1062 Dumpsys dumpsys(sm.get());
Vishnu Naire97d6122018-01-18 13:58:56 -08001063 Vector<String16> args;
1064 Dumpsys::setServiceArgs(args, /* asProto = */ false, priority);
Vishnu Naire97d6122018-01-18 13:58:56 -08001065 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ false);
1066 for (const String16& service : services) {
1067 std::string path(title);
1068 path.append(" - ").append(String8(service).c_str());
1069 DumpstateSectionReporter section_reporter(path, ds.listener_, ds.report_section_);
1070 size_t bytes_written = 0;
1071 status_t status = dumpsys.startDumpThread(service, args);
1072 if (status == OK) {
1073 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1074 std::chrono::duration<double> elapsed_seconds;
1075 status = dumpsys.writeDump(STDOUT_FILENO, service, service_timeout,
1076 /* as_proto = */ false, elapsed_seconds, bytes_written);
1077 section_reporter.setSize(bytes_written);
1078 dumpsys.writeDumpFooter(STDOUT_FILENO, service, elapsed_seconds);
1079 bool dump_complete = (status == OK);
1080 dumpsys.stopDumpThread(dump_complete);
1081 }
1082 section_reporter.setStatus(status);
1083
1084 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1085 std::chrono::steady_clock::now() - start);
1086 if (elapsed_duration > timeout) {
1087 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1088 elapsed_duration.count());
1089 break;
1090 }
1091 }
1092}
1093
Vishnu Nair64afc022018-02-01 15:29:34 -08001094static void RunDumpsysText(const std::string& title, int priority,
1095 std::chrono::milliseconds timeout,
1096 std::chrono::milliseconds service_timeout) {
1097 DurationReporter duration_reporter(title);
1098 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1099 fsync(STDOUT_FILENO);
1100 RunDumpsysTextByPriority(title, priority, timeout, service_timeout);
1101}
1102
1103/* Dump all services registered with Normal or Default priority. */
1104static void RunDumpsysTextNormalPriority(const std::string& title,
1105 std::chrono::milliseconds timeout,
1106 std::chrono::milliseconds service_timeout) {
1107 DurationReporter duration_reporter(title);
1108 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1109 fsync(STDOUT_FILENO);
1110 RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_NORMAL, timeout,
1111 service_timeout);
1112 RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_DEFAULT, timeout,
1113 service_timeout);
1114}
1115
1116static void RunDumpsysProto(const std::string& title, int priority,
1117 std::chrono::milliseconds timeout,
1118 std::chrono::milliseconds service_timeout) {
Luis Hector Chavez1e27b082018-03-22 15:36:42 -07001119 if (!ds.IsZipping()) {
1120 MYLOGD("Not dumping %s because it's not a zipped bugreport\n", title.c_str());
1121 return;
1122 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001123 sp<android::IServiceManager> sm = defaultServiceManager();
1124 Dumpsys dumpsys(sm.get());
1125 Vector<String16> args;
1126 Dumpsys::setServiceArgs(args, /* asProto = */ true, priority);
1127 DurationReporter duration_reporter(title);
1128
1129 auto start = std::chrono::steady_clock::now();
1130 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ true);
1131 for (const String16& service : services) {
1132 std::string path(kProtoPath);
1133 path.append(String8(service).c_str());
1134 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL) {
1135 path.append("_CRITICAL");
1136 } else if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH) {
1137 path.append("_HIGH");
1138 }
1139 path.append(kProtoExt);
1140 DumpstateSectionReporter section_reporter(path, ds.listener_, ds.report_section_);
1141 status_t status = dumpsys.startDumpThread(service, args);
1142 if (status == OK) {
1143 status = ds.AddZipEntryFromFd(path, dumpsys.getDumpFd(), service_timeout);
1144 bool dumpTerminated = (status == OK);
1145 dumpsys.stopDumpThread(dumpTerminated);
1146 }
1147 ZipWriter::FileEntry file_entry;
1148 ds.zip_writer_->GetLastEntry(&file_entry);
1149 section_reporter.setSize(file_entry.compressed_size);
1150 section_reporter.setStatus(status);
1151
1152 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1153 std::chrono::steady_clock::now() - start);
1154 if (elapsed_duration > timeout) {
1155 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1156 elapsed_duration.count());
1157 break;
1158 }
1159 }
1160}
1161
Nandana Dutta7db6342018-11-21 14:53:34 +00001162// Runs dumpsys on services that must dump first and will take less than 100ms to dump.
Vishnu Nair780b1282017-10-10 13:57:24 -07001163static void RunDumpsysCritical() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001164 RunDumpsysText("DUMPSYS CRITICAL", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1165 /* timeout= */ 5s, /* service_timeout= */ 500ms);
1166 RunDumpsysProto("DUMPSYS CRITICAL PROTO", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1167 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Vishnu Nair780b1282017-10-10 13:57:24 -07001168}
1169
1170// Runs dumpsys on services that must dump first but can take up to 250ms to dump.
1171static void RunDumpsysHigh() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001172 // TODO meminfo takes ~10s, connectivity takes ~5sec to dump. They are both
1173 // high priority. Reduce timeout once they are able to dump in a shorter time or
1174 // moved to a parallel task.
1175 RunDumpsysText("DUMPSYS HIGH", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1176 /* timeout= */ 90s, /* service_timeout= */ 30s);
1177 RunDumpsysProto("DUMPSYS HIGH PROTO", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1178 /* timeout= */ 5s, /* service_timeout= */ 1s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001179}
1180
1181// Runs dumpsys on services that must dump but can take up to 10s to dump.
1182static void RunDumpsysNormal() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001183 RunDumpsysTextNormalPriority("DUMPSYS", /* timeout= */ 90s, /* service_timeout= */ 10s);
1184 RunDumpsysProto("DUMPSYS PROTO", IServiceManager::DUMP_FLAG_PRIORITY_NORMAL,
1185 /* timeout= */ 90s, /* service_timeout= */ 10s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001186}
1187
Steven Moreland44cd9482018-01-04 16:24:13 -08001188static void DumpHals() {
Steven Moreland44cd9482018-01-04 16:24:13 -08001189 using android::hidl::manager::V1_0::IServiceManager;
1190 using android::hardware::defaultServiceManager;
1191
1192 sp<IServiceManager> sm = defaultServiceManager();
1193 if (sm == nullptr) {
1194 MYLOGE("Could not retrieve hwservicemanager to dump hals.\n");
1195 return;
1196 }
1197
1198 auto ret = sm->list([&](const auto& interfaces) {
1199 for (const std::string& interface : interfaces) {
1200 std::string cleanName = interface;
1201 std::replace_if(cleanName.begin(),
1202 cleanName.end(),
1203 [](char c) {
1204 return !isalnum(c) &&
1205 std::string("@-_:.").find(c) == std::string::npos;
1206 }, '_');
Nandana Dutt979388e2018-11-30 16:48:55 +00001207 const std::string path = ds.bugreport_internal_dir_ + "/lshal_debug_" + cleanName;
Steven Moreland44cd9482018-01-04 16:24:13 -08001208
1209 {
1210 auto fd = android::base::unique_fd(
1211 TEMP_FAILURE_RETRY(open(path.c_str(),
1212 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1213 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1214 if (fd < 0) {
1215 MYLOGE("Could not open %s to dump additional hal information.\n", path.c_str());
1216 continue;
1217 }
1218 RunCommandToFd(fd,
1219 "",
Steven Morelandc81cd3c2018-01-18 14:36:26 -08001220 {"lshal", "debug", "-E", interface},
Steven Moreland44cd9482018-01-04 16:24:13 -08001221 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
1222
1223 bool empty = 0 == lseek(fd, 0, SEEK_END);
1224 if (!empty) {
1225 ds.AddZipEntry("lshal-debug/" + cleanName + ".txt", path);
1226 }
1227 }
1228
1229 unlink(path.c_str());
1230 }
1231 });
1232
1233 if (!ret.isOk()) {
1234 MYLOGE("Could not list hals from hwservicemanager.\n");
1235 }
1236}
1237
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001238static void dumpstate() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001239 DurationReporter duration_reporter("DUMPSTATE");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001240
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -07001241 dump_dev_files("TRUSTY VERSION", "/sys/bus/platform/drivers/trusty", "trusty_version");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001242 RunCommand("UPTIME", {"uptime"});
Wei Wang509bb5d2017-06-09 14:42:12 -07001243 DumpBlockStatFiles();
Mark Salyzyn8c8130e2015-12-09 11:21:28 -08001244 dump_emmc_ecsd("/d/mmc0/mmc0:0001/ext_csd");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001245 DumpFile("MEMORY INFO", "/proc/meminfo");
1246 RunCommand("CPU INFO", {"top", "-b", "-n", "1", "-H", "-s", "6", "-o",
Felipe Leme30dbfa12016-09-02 12:43:26 -07001247 "pid,tid,user,pr,ni,%cpu,s,virt,res,pcy,cmd,name"});
Felipe Lemef0292972016-11-22 13:57:05 -08001248 RunCommand("PROCRANK", {"procrank"}, AS_ROOT_20);
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001249 DumpFile("VIRTUAL MEMORY STATS", "/proc/vmstat");
1250 DumpFile("VMALLOC INFO", "/proc/vmallocinfo");
1251 DumpFile("SLAB INFO", "/proc/slabinfo");
1252 DumpFile("ZONEINFO", "/proc/zoneinfo");
1253 DumpFile("PAGETYPEINFO", "/proc/pagetypeinfo");
1254 DumpFile("BUDDYINFO", "/proc/buddyinfo");
1255 DumpFile("FRAGMENTATION INFO", "/d/extfrag/unusable_index");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001256
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001257 DumpFile("KERNEL WAKE SOURCES", "/d/wakeup_sources");
1258 DumpFile("KERNEL CPUFREQ", "/sys/devices/system/cpu/cpu0/cpufreq/stats/time_in_state");
1259 DumpFile("KERNEL SYNC", "/d/sync");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001260
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001261 RunCommand("PROCESSES AND THREADS",
Yohei Yukawa591a72d2017-10-05 21:36:35 -07001262 {"ps", "-A", "-T", "-Z", "-O", "pri,nice,rtprio,sched,pcy,time"});
Felipe Lemef0292972016-11-22 13:57:05 -08001263 RunCommand("LIBRANK", {"librank"}, CommandOptions::AS_ROOT);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001264
Andreas Huber69ec3ac2017-03-23 09:47:51 -07001265 if (ds.IsZipping()) {
Yifan Hong90e8d8d2018-06-28 13:14:39 -07001266 RunCommand("HARDWARE HALS", {"lshal", "-lVSietrpc", "--types=b,c,l,z"},
1267 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
Steven Moreland44cd9482018-01-04 16:24:13 -08001268 DumpHals();
Andreas Huber69ec3ac2017-03-23 09:47:51 -07001269 } else {
Yifan Hong90e8d8d2018-06-28 13:14:39 -07001270 RunCommand("HARDWARE HALS", {"lshal", "-lVSietrpc", "--types=b,c,l,z", "--debug"},
1271 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build());
Andreas Huber69ec3ac2017-03-23 09:47:51 -07001272 }
Steven Moreland81b429e2017-01-31 19:50:46 -08001273
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001274 RunCommand("PRINTENV", {"printenv"});
Elliott Hughes21b7c8d2016-10-28 08:53:02 -07001275 RunCommand("NETSTAT", {"netstat", "-nW"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001276 struct stat s;
1277 if (stat("/proc/modules", &s) != 0) {
1278 MYLOGD("Skipping 'lsmod' because /proc/modules does not exist\n");
1279 } else {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001280 RunCommand("LSMOD", {"lsmod"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001281 }
Michal Karpinski4db754f2015-12-11 18:04:32 +00001282
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001283 if (__android_logger_property_get_bool(
1284 "ro.logd.kernel", BOOL_DEFAULT_TRUE | BOOL_DEFAULT_FLAG_ENG | BOOL_DEFAULT_FLAG_SVELTE)) {
1285 DoKernelLogcat();
1286 } else {
1287 do_dmesg();
1288 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001289
Felipe Lemef0292972016-11-22 13:57:05 -08001290 RunCommand("LIST OF OPEN FILES", {"lsof"}, CommandOptions::AS_ROOT);
Jeff Brown1dc94e32014-09-11 14:15:27 -07001291 for_each_pid(do_showmap, "SMAPS OF ALL PROCESSES");
1292 for_each_tid(show_wchan, "BLOCKED PROCESS WAIT-CHANNELS");
Mark Salyzyna297c322016-02-05 15:33:17 -08001293 for_each_pid(show_showtime, "PROCESS TIMES (pid cmd user system iowait+percentage)");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001294
Ajay Panicker2ff8e872017-04-27 14:04:32 -07001295 /* Dump Bluetooth HCI logs */
1296 ds.AddDir("/data/misc/bluetooth/logs", true);
Ajay Panickerd886ec42016-09-14 12:26:46 -07001297
Felipe Leme9a523ae2016-10-20 15:10:33 -07001298 if (!ds.do_early_screenshot_) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001299 MYLOGI("taking late screenshot\n");
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001300 ds.TakeScreenshot();
Jeff Sharkey5a930032013-03-19 15:05:19 -07001301 }
1302
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001303 DoLogcat();
Mark Salyzynecc07632015-07-30 14:57:09 -07001304
Felipe Lemee184f662016-10-27 10:04:47 -07001305 AddAnrTraceFiles();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001306
Narayan Kamath8f788292017-05-25 13:20:39 +01001307 // NOTE: tombstones are always added as separate entries in the zip archive
1308 // and are not interspersed with the main report.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001309 const bool tombstones_dumped = AddDumps(ds.tombstone_data_.begin(), ds.tombstone_data_.end(),
Narayan Kamathbd863722017-06-01 18:50:12 +01001310 "TOMBSTONE", true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001311 if (!tombstones_dumped) {
1312 printf("*** NO TOMBSTONES to dump in %s\n\n", TOMBSTONE_DIR.c_str());
Christopher Ferris7dc7f322014-07-22 16:08:19 -07001313 }
1314
Jayachandran Ca94c7172017-06-10 15:08:12 -07001315 DumpPacketStats();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001316
Chenbo Feng276a3b62018-08-07 11:44:49 -07001317 RunDumpsys("EBPF MAP STATS", {"netd", "trafficcontroller"});
1318
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001319 DoKmsg();
Mark Salyzyn2262c162014-12-16 09:09:26 -08001320
Jayachandran Ca94c7172017-06-10 15:08:12 -07001321 DumpIpAddrAndRules();
Sreeram Ramachandran2b3bba32014-07-08 15:40:55 -07001322
1323 dump_route_tables();
1324
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001325 RunCommand("ARP CACHE", {"ip", "-4", "neigh", "show"});
1326 RunCommand("IPv6 ND CACHE", {"ip", "-6", "neigh", "show"});
1327 RunCommand("MULTICAST ADDRESSES", {"ip", "maddr"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001328
Vishnu Nair780b1282017-10-10 13:57:24 -07001329 RunDumpsysHigh();
Lorenzo Colitti6afc38c2015-09-09 22:59:25 +09001330
Elliott Hughes23ccc622017-02-28 10:14:22 -08001331 RunCommand("SYSTEM PROPERTIES", {"getprop"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001332
Jin Qianf334d662017-10-10 14:41:37 -07001333 RunCommand("STORAGED IO INFO", {"storaged", "-u", "-p"});
ynwangf649a6e2016-07-17 21:56:00 -07001334
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001335 RunCommand("FILESYSTEMS & FREE SPACE", {"df"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001336
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001337 RunCommand("LAST RADIO LOG", {"parse_radio_log", "/proc/last_radio_log"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001338
Colin Crossf45fa6b2012-03-26 12:38:26 -07001339 /* Binder state is expensive to look at as it uses a lot of memory. */
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001340 DumpFile("BINDER FAILED TRANSACTION LOG", "/sys/kernel/debug/binder/failed_transaction_log");
1341 DumpFile("BINDER TRANSACTION LOG", "/sys/kernel/debug/binder/transaction_log");
1342 DumpFile("BINDER TRANSACTIONS", "/sys/kernel/debug/binder/transactions");
1343 DumpFile("BINDER STATS", "/sys/kernel/debug/binder/stats");
1344 DumpFile("BINDER STATE", "/sys/kernel/debug/binder/state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001345
Nataniel Borgesbc73f522019-01-25 16:37:16 -08001346 RunDumpsys("WINSCOPE TRACE", {"window", "trace"});
Vishnu Nair36b4cdb2017-11-17 10:27:05 -08001347 /* Add window and surface trace files. */
1348 if (!PropertiesHelper::IsUserBuild()) {
1349 ds.AddDir(WMTRACE_DATA_DIR, false);
1350 }
1351
Felipe Leme6f674ae2016-11-18 17:10:33 -08001352 ds.DumpstateBoard();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001353
Steven Moreland7440ddb2016-12-15 16:13:39 -08001354 /* Migrate the ril_dumpstate to a device specific dumpstate? */
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001355 int rilDumpstateTimeout = android::base::GetIntProperty("ril.dumpstate.timeout", 0);
1356 if (rilDumpstateTimeout > 0) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001357 // su does not exist on user builds, so try running without it.
1358 // This way any implementations of vril-dump that do not require
1359 // root can run on user builds.
1360 CommandOptions::CommandOptionsBuilder options =
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001361 CommandOptions::WithTimeout(rilDumpstateTimeout);
Felipe Lemef0292972016-11-22 13:57:05 -08001362 if (!PropertiesHelper::IsUserBuild()) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001363 options.AsRoot();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001364 }
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001365 RunCommand("DUMP VENDOR RIL LOGS", {"vril-dump"}, options.Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -07001366 }
1367
Felipe Lemed8b94e52016-12-08 10:21:44 -08001368 printf("========================================================\n");
1369 printf("== Android Framework Services\n");
1370 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001371
Vishnu Nair780b1282017-10-10 13:57:24 -07001372 RunDumpsysNormal();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001373
Felipe Lemed8b94e52016-12-08 10:21:44 -08001374 printf("========================================================\n");
1375 printf("== Checkins\n");
1376 printf("========================================================\n");
Dianne Hackborn02bea972013-06-26 18:59:09 -07001377
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001378 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
1379 RunDumpsys("CHECKIN MEMINFO", {"meminfo", "--checkin"});
1380 RunDumpsys("CHECKIN NETSTATS", {"netstats", "--checkin"});
1381 RunDumpsys("CHECKIN PROCSTATS", {"procstats", "-c"});
1382 RunDumpsys("CHECKIN USAGESTATS", {"usagestats", "-c"});
1383 RunDumpsys("CHECKIN PACKAGE", {"package", "--checkin"});
Dianne Hackborn02bea972013-06-26 18:59:09 -07001384
Felipe Lemed8b94e52016-12-08 10:21:44 -08001385 printf("========================================================\n");
1386 printf("== Running Application Activities\n");
1387 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001388
Makoto Onuki60780982018-04-16 15:34:00 -07001389 // The following dumpsys internally collects output from running apps, so it can take a long
1390 // time. So let's extend the timeout.
1391
1392 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
1393
1394 RunDumpsys("APP ACTIVITIES", {"activity", "-v", "all"}, DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001395
Felipe Lemed8b94e52016-12-08 10:21:44 -08001396 printf("========================================================\n");
Makoto Onuki60780982018-04-16 15:34:00 -07001397 printf("== Running Application Services (platform)\n");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001398 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001399
Vishnu Nairc6e6ea72018-07-02 14:20:06 -07001400 RunDumpsys("APP SERVICES PLATFORM", {"activity", "service", "all-platform-non-critical"},
Makoto Onuki60780982018-04-16 15:34:00 -07001401 DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001402
Felipe Lemed8b94e52016-12-08 10:21:44 -08001403 printf("========================================================\n");
Makoto Onuki60780982018-04-16 15:34:00 -07001404 printf("== Running Application Services (non-platform)\n");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001405 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001406
Makoto Onuki60780982018-04-16 15:34:00 -07001407 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1408 DUMPSYS_COMPONENTS_OPTIONS);
1409
1410 printf("========================================================\n");
1411 printf("== Running Application Providers (platform)\n");
1412 printf("========================================================\n");
1413
1414 RunDumpsys("APP PROVIDERS PLATFORM", {"activity", "provider", "all-platform"},
1415 DUMPSYS_COMPONENTS_OPTIONS);
1416
1417 printf("========================================================\n");
1418 printf("== Running Application Providers (non-platform)\n");
1419 printf("========================================================\n");
1420
1421 RunDumpsys("APP PROVIDERS NON-PLATFORM", {"activity", "provider", "all-non-platform"},
1422 DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001423
Adrian Roos8b397ab2017-04-04 16:35:44 -07001424 printf("========================================================\n");
1425 printf("== Dropbox crashes\n");
1426 printf("========================================================\n");
1427
1428 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1429 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1430
Felipe Lemed8b94e52016-12-08 10:21:44 -08001431 printf("========================================================\n");
1432 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1433 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1434 printf("========================================================\n");
1435 printf("== dumpstate: done (id %d)\n", ds.id_);
1436 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001437}
1438
Nandana Dutt4be45d12018-09-26 15:04:23 +01001439/* Dumps state for the default case. Returns true if everything went fine. */
1440static bool DumpstateDefault() {
Primiano Tucci2d7f5c22019-01-17 15:51:14 +00001441 // Try to dump anrd trace if the daemon is running.
1442 dump_anrd_trace();
Nandana Dutt4be45d12018-09-26 15:04:23 +01001443
1444 // Invoking the following dumpsys calls before dump_traces() to try and
1445 // keep the system stats as close to its initial state as possible.
1446 RunDumpsysCritical();
1447
1448 /* collect stack traces from Dalvik and native processes (needs root) */
Nandana Duttfaafd522019-03-11 09:23:09 +00001449 dump_traces_path = ds.DumpTraces();
Nandana Dutt4be45d12018-09-26 15:04:23 +01001450
1451 /* Run some operations that require root. */
1452 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX, !ds.IsZipping());
1453 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX, !ds.IsZipping());
1454
1455 ds.AddDir(RECOVERY_DIR, true);
1456 ds.AddDir(RECOVERY_DATA_DIR, true);
1457 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
1458 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1459 if (!PropertiesHelper::IsUserBuild()) {
1460 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1461 ds.AddDir(PROFILE_DATA_DIR_REF, true);
1462 }
1463 add_mountinfo();
1464 DumpIpTablesAsRoot();
1465
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001466 // Capture any IPSec policies in play. No keys are exposed here.
Nandana Dutt4be45d12018-09-26 15:04:23 +01001467 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1468
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001469 // Dump IPsec stats. No keys are exposed here.
1470 DumpFile("XFRM STATS", XFRM_STAT_PROC_FILE);
1471
Nandana Dutt4be45d12018-09-26 15:04:23 +01001472 // Run ss as root so we can see socket marks.
1473 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
1474
1475 // Run iotop as root to show top 100 IO threads
1476 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
1477
Erick Reyese68df822019-02-11 14:46:36 -08001478 // Gather shared memory buffer info if the product implements it
1479 struct stat st;
1480 if (!stat("/product/bin/dmabuf_dump", &st)) {
1481 RunCommand("Dmabuf dump", {"/product/bin/dmabuf_dump"});
1482 }
1483
Nandana Dutt4be45d12018-09-26 15:04:23 +01001484 if (!DropRootUser()) {
1485 return false;
1486 }
1487
1488 dumpstate();
1489 return true;
1490}
1491
mukesh agrawal253dad42018-01-23 21:59:59 -08001492// This method collects common dumpsys for telephony and wifi
1493static void DumpstateRadioCommon() {
Jayachandran Ca94c7172017-06-10 15:08:12 -07001494 DumpIpTablesAsRoot();
1495
1496 if (!DropRootUser()) {
1497 return;
1498 }
1499
1500 do_dmesg();
1501 DoLogcat();
1502 DumpPacketStats();
1503 DoKmsg();
1504 DumpIpAddrAndRules();
1505 dump_route_tables();
1506
1507 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
1508 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08001509}
1510
1511// This method collects dumpsys for telephony debugging only
1512static void DumpstateTelephonyOnly() {
1513 DurationReporter duration_reporter("DUMPSTATE");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001514 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08001515
1516 DumpstateRadioCommon();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001517
1518 RunCommand("SYSTEM PROPERTIES", {"getprop"});
1519
1520 printf("========================================================\n");
1521 printf("== Android Framework Services\n");
1522 printf("========================================================\n");
1523
Vishnu Nair652cc802017-11-30 15:18:30 -08001524 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1525 SEC_TO_MSEC(10));
1526 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
1527 SEC_TO_MSEC(10));
Amruth Ramachandrand25a9142018-04-02 16:16:09 -07001528 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
1529 SEC_TO_MSEC(10));
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07001530 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
1531 SEC_TO_MSEC(10));
Jayachandran Ca94c7172017-06-10 15:08:12 -07001532
1533 printf("========================================================\n");
1534 printf("== Running Application Services\n");
1535 printf("========================================================\n");
1536
1537 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
1538
1539 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001540 printf("== Running Application Services (non-platform)\n");
1541 printf("========================================================\n");
1542
1543 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1544 DUMPSYS_COMPONENTS_OPTIONS);
1545
1546 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07001547 printf("== Checkins\n");
1548 printf("========================================================\n");
1549
1550 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
1551
1552 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07001553 printf("== dumpstate: done (id %d)\n", ds.id_);
1554 printf("========================================================\n");
1555}
1556
mukesh agrawal253dad42018-01-23 21:59:59 -08001557// This method collects dumpsys for wifi debugging only
1558static void DumpstateWifiOnly() {
1559 DurationReporter duration_reporter("DUMPSTATE");
1560
1561 DumpstateRadioCommon();
1562
1563 printf("========================================================\n");
1564 printf("== Android Framework Services\n");
1565 printf("========================================================\n");
1566
1567 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1568 SEC_TO_MSEC(10));
1569 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
1570 SEC_TO_MSEC(10));
1571
Roger Wang70399032019-01-08 16:10:37 +08001572 if (ds.IsZipping()) {
1573 RunCommand("HARDWARE HALS", {"lshal", "-lVSietrpc", "--types=b,c,l,z"},
1574 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
1575 DumpHals();
1576 } else {
1577 RunCommand("HARDWARE HALS", {"lshal", "-lVSietrpc", "--types=b,c,l,z", "--debug"},
1578 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build());
1579 }
1580
mukesh agrawal253dad42018-01-23 21:59:59 -08001581 printf("========================================================\n");
1582 printf("== dumpstate: done (id %d)\n", ds.id_);
1583 printf("========================================================\n");
1584}
1585
Nandana Duttfaafd522019-03-11 09:23:09 +00001586const char* Dumpstate::DumpTraces() {
1587 DurationReporter duration_reporter("DUMP TRACES");
1588
1589 const std::string temp_file_pattern = "/data/anr/dumptrace_XXXXXX";
1590 const size_t buf_size = temp_file_pattern.length() + 1;
1591 std::unique_ptr<char[]> file_name_buf(new char[buf_size]);
1592 memcpy(file_name_buf.get(), temp_file_pattern.c_str(), buf_size);
1593
1594 // Create a new, empty file to receive all trace dumps.
1595 //
1596 // TODO: This can be simplified once we remove support for the old style
1597 // dumps. We can have a file descriptor passed in to dump_traces instead
1598 // of creating a file, closing it and then reopening it again.
1599 android::base::unique_fd fd(mkostemp(file_name_buf.get(), O_APPEND | O_CLOEXEC));
1600 if (fd < 0) {
1601 MYLOGE("mkostemp on pattern %s: %s\n", file_name_buf.get(), strerror(errno));
1602 return nullptr;
1603 }
1604
1605 // Nobody should have access to this temporary file except dumpstate, but we
1606 // temporarily grant 'read' to 'others' here because this file is created
1607 // when tombstoned is still running as root, but dumped after dropping. This
1608 // can go away once support for old style dumping has.
1609 const int chmod_ret = fchmod(fd, 0666);
1610 if (chmod_ret < 0) {
1611 MYLOGE("fchmod on %s failed: %s\n", file_name_buf.get(), strerror(errno));
1612 return nullptr;
1613 }
1614
1615 std::unique_ptr<DIR, decltype(&closedir)> proc(opendir("/proc"), closedir);
1616 if (proc.get() == nullptr) {
1617 MYLOGE("opendir /proc failed: %s\n", strerror(errno));
1618 return nullptr;
1619 }
1620
1621 // Number of times process dumping has timed out. If we encounter too many
1622 // failures, we'll give up.
1623 int timeout_failures = 0;
1624 bool dalvik_found = false;
1625
1626 const std::set<int> hal_pids = get_interesting_hal_pids();
1627
1628 struct dirent* d;
1629 while ((d = readdir(proc.get()))) {
1630 int pid = atoi(d->d_name);
1631 if (pid <= 0) {
1632 continue;
1633 }
1634
1635 const std::string link_name = android::base::StringPrintf("/proc/%d/exe", pid);
1636 std::string exe;
1637 if (!android::base::Readlink(link_name, &exe)) {
1638 continue;
1639 }
1640
1641 bool is_java_process;
1642 if (exe == "/system/bin/app_process32" || exe == "/system/bin/app_process64") {
1643 // Don't bother dumping backtraces for the zygote.
1644 if (IsZygote(pid)) {
1645 continue;
1646 }
1647
1648 dalvik_found = true;
1649 is_java_process = true;
1650 } else if (should_dump_native_traces(exe.c_str()) || hal_pids.find(pid) != hal_pids.end()) {
1651 is_java_process = false;
1652 } else {
1653 // Probably a native process we don't care about, continue.
1654 continue;
1655 }
1656
1657 // If 3 backtrace dumps fail in a row, consider debuggerd dead.
1658 if (timeout_failures == 3) {
1659 dprintf(fd, "ERROR: Too many stack dump failures, exiting.\n");
1660 break;
1661 }
1662
1663 const uint64_t start = Nanotime();
1664 const int ret = dump_backtrace_to_file_timeout(
1665 pid, is_java_process ? kDebuggerdJavaBacktrace : kDebuggerdNativeBacktrace,
1666 is_java_process ? 5 : 20, fd);
1667
1668 if (ret == -1) {
1669 // For consistency, the header and footer to this message match those
1670 // dumped by debuggerd in the success case.
1671 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
1672 dprintf(fd, "Dump failed, likely due to a timeout.\n");
1673 dprintf(fd, "---- end %d ----", pid);
1674 timeout_failures++;
1675 continue;
1676 }
1677
1678 // We've successfully dumped stack traces, reset the failure count
1679 // and write a summary of the elapsed time to the file and continue with the
1680 // next process.
1681 timeout_failures = 0;
1682
1683 dprintf(fd, "[dump %s stack %d: %.3fs elapsed]\n", is_java_process ? "dalvik" : "native",
1684 pid, (float)(Nanotime() - start) / NANOS_PER_SEC);
1685 }
1686
1687 if (!dalvik_found) {
1688 MYLOGE("Warning: no Dalvik processes found to dump stacks\n");
1689 }
1690
1691 return file_name_buf.release();
1692}
1693
Felipe Leme6f674ae2016-11-18 17:10:33 -08001694void Dumpstate::DumpstateBoard() {
1695 DurationReporter duration_reporter("dumpstate_board()");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001696 printf("========================================================\n");
1697 printf("== Board\n");
1698 printf("========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001699
Felipe Leme6f674ae2016-11-18 17:10:33 -08001700 if (!IsZipping()) {
Steven Moreland7440ddb2016-12-15 16:13:39 -08001701 MYLOGD("Not dumping board info because it's not a zipped bugreport\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001702 return;
1703 }
1704
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001705 std::vector<std::string> paths;
1706 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07001707 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00001708 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
1709 kDumpstateBoardFiles[i].c_str()));
Nandana Dutt16d1aee2019-02-15 16:13:53 +00001710 remover.emplace_back(android::base::make_scope_guard(
1711 std::bind([](std::string path) { android::os::UnlinkAndLogOnError(path); }, paths[i])));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001712 }
Jie Song9fbfad02017-06-20 16:29:42 -07001713
Wei Wang587eac92018-04-05 12:17:20 -07001714 sp<IDumpstateDevice> dumpstate_device(IDumpstateDevice::getService());
1715 if (dumpstate_device == nullptr) {
1716 MYLOGE("No IDumpstateDevice implementation\n");
1717 return;
1718 }
1719
1720 using ScopedNativeHandle =
1721 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
1722 ScopedNativeHandle handle(native_handle_create(static_cast<int>(paths.size()), 0),
1723 [](native_handle_t* handle) {
1724 native_handle_close(handle);
1725 native_handle_delete(handle);
1726 });
1727 if (handle == nullptr) {
1728 MYLOGE("Could not create native_handle\n");
1729 return;
1730 }
1731
1732 for (size_t i = 0; i < paths.size(); i++) {
1733 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
1734
1735 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
1736 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1737 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1738 if (fd < 0) {
1739 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
1740 return;
1741 }
1742 handle.get()->data[i] = fd.release();
1743 }
1744
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001745 // Given that bugreport is required to diagnose failures, it's better to
Wei Wang587eac92018-04-05 12:17:20 -07001746 // set an arbitrary amount of timeout for IDumpstateDevice than to block the
1747 // rest of bugreport. In the timeout case, we will kill dumpstate board HAL
1748 // and grab whatever dumped
1749 std::packaged_task<bool()>
1750 dumpstate_task([paths, dumpstate_device, &handle]() -> bool {
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001751 android::hardware::Return<void> status = dumpstate_device->dumpstateBoard(handle.get());
1752 if (!status.isOk()) {
1753 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
Wei Wang587eac92018-04-05 12:17:20 -07001754 return false;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001755 }
Wei Wang587eac92018-04-05 12:17:20 -07001756 return true;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001757 });
Wei Wang587eac92018-04-05 12:17:20 -07001758
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001759 auto result = dumpstate_task.get_future();
1760 std::thread(std::move(dumpstate_task)).detach();
Wei Wang587eac92018-04-05 12:17:20 -07001761
1762 constexpr size_t timeout_sec = 30;
1763 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
1764 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate vendor HAL\n", timeout_sec);
1765 if (!android::base::SetProperty("ctl.interface_restart",
1766 android::base::StringPrintf("%s/default",
1767 IDumpstateDevice::descriptor))) {
1768 MYLOGE("Couldn't restart dumpstate HAL\n");
1769 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001770 }
Wei Wang587eac92018-04-05 12:17:20 -07001771 // Wait some time for init to kill dumpstate vendor HAL
1772 constexpr size_t killing_timeout_sec = 10;
1773 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
1774 MYLOGE("killing dumpstateBoard timed out after %zus, continue and "
1775 "there might be racing in content\n", killing_timeout_sec);
1776 }
1777
1778 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
1779 for (size_t i = 0; i < paths.size(); i++) {
1780 struct stat s;
1781 if (fstat(handle.get()->data[i], &s) == -1) {
1782 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(),
1783 strerror(errno));
1784 file_sizes[i] = -1;
1785 continue;
1786 }
1787 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001788 }
1789
1790 for (size_t i = 0; i < paths.size(); i++) {
1791 if (file_sizes[i] == -1) {
1792 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07001793 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001794 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07001795 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001796 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07001797 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001798 AddZipEntry(kDumpstateBoardFiles[i], paths[i]);
Jie Song9fbfad02017-06-20 16:29:42 -07001799 }
1800
Felipe Lemed8b94e52016-12-08 10:21:44 -08001801 printf("*** See dumpstate-board.txt entry ***\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001802}
1803
Nandana Dutt12ae14a2019-01-09 10:35:53 +00001804static void ShowUsage() {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001805 fprintf(stderr,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001806 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-o file] [-d] [-p] "
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001807 "[-z]] [-s] [-S] [-q] [-B] [-P] [-R] [-V version]\n"
1808 " -h: display this help message\n"
1809 " -b: play sound file instead of vibrate, at beginning of job\n"
1810 " -e: play sound file instead of vibrate, at end of job\n"
1811 " -o: write to file (instead of stdout)\n"
1812 " -d: append date to filename (requires -o)\n"
1813 " -p: capture screenshot to filename.png (requires -o)\n"
1814 " -z: generate zipped file (requires -o)\n"
1815 " -s: write output to control socket (for init)\n"
Takuya Ogawa47f644e2017-12-20 18:09:09 +09001816 " -S: write file location to control socket (for init; requires -o and -z)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001817 " -q: disable vibrate\n"
1818 " -B: send broadcast when finished (requires -o)\n"
1819 " -P: send broadcast when started and update system properties on "
1820 "progress (requires -o and -B)\n"
1821 " -R: take bugreport in remote mode (requires -o, -z, -d and -B, "
1822 "shouldn't be used with -P)\n"
Nandana Dutt235864b2019-01-22 12:10:16 +00001823 " -w: start binder service and make it wait for a call to startBugreport\n"
Felipe Lemed071c682016-10-20 16:48:00 -07001824 " -v: prints the dumpstate header and exit\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001825}
1826
Wei Liuf87959e2016-08-26 14:51:42 -07001827static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07001828 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07001829}
1830
Felipe Leme1d486fe2016-10-14 18:06:47 -07001831bool Dumpstate::FinishZipFile() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001832 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07001833 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07001834 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07001835 // Final timestamp
1836 char date[80];
1837 time_t the_real_now_please_stand_up = time(nullptr);
1838 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07001839 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001840 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07001841
Felipe Leme9a523ae2016-10-20 15:10:33 -07001842 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001843 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08001844 return false;
1845 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07001846 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001847 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08001848 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08001849 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08001850
Felipe Leme0f3fb202016-06-10 17:10:53 -07001851 // Add log file (which contains stderr output) to zip...
1852 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07001853 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07001854 MYLOGE("Failed to add dumpstate log to .zip file\n");
1855 return false;
1856 }
Nandana Dutt979388e2018-11-30 16:48:55 +00001857 // TODO: Should truncate the existing file.
1858 // ... and re-open it for further logging.
Nandana Dutta344cb62019-02-22 15:12:35 +00001859 if (!redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()))) {
1860 return false;
1861 }
Felipe Leme0f3fb202016-06-10 17:10:53 -07001862 fprintf(stderr, "\n");
1863
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07001864 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07001865 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07001866 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08001867 return false;
1868 }
1869
Felipe Leme1d486fe2016-10-14 18:06:47 -07001870 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
1871 ds.zip_file.reset(nullptr);
1872
Felipe Lemee9d2c542016-11-15 11:48:26 -08001873 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
Nandana Dutt16d1aee2019-02-15 16:13:53 +00001874 android::os::UnlinkAndLogOnError(tmp_path_);
Felipe Lemec4eee562016-04-21 15:42:55 -07001875
Felipe Leme1e9edc62015-12-21 16:02:13 -08001876 return true;
1877}
Felipe Leme6e01fa62015-11-11 19:35:14 -08001878
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -07001879static std::string SHA256_file_hash(const std::string& filepath) {
Andreas Gampe27cd7b22016-07-18 18:24:05 -07001880 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(filepath.c_str(), O_RDONLY | O_NONBLOCK
1881 | O_CLOEXEC | O_NOFOLLOW)));
Andreas Gampeaff68432016-07-18 18:01:27 -07001882 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001883 MYLOGE("open(%s): %s\n", filepath.c_str(), strerror(errno));
Yi Kong19d5c002018-07-20 13:39:55 -07001884 return nullptr;
Michal Karpinski4db754f2015-12-11 18:04:32 +00001885 }
1886
1887 SHA256_CTX ctx;
Elliott Hughesc4dc1412016-04-12 16:28:31 -07001888 SHA256_Init(&ctx);
Michal Karpinski4db754f2015-12-11 18:04:32 +00001889
1890 std::vector<uint8_t> buffer(65536);
1891 while (1) {
1892 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd.get(), buffer.data(), buffer.size()));
1893 if (bytes_read == 0) {
1894 break;
1895 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001896 MYLOGE("read(%s): %s\n", filepath.c_str(), strerror(errno));
Yi Kong19d5c002018-07-20 13:39:55 -07001897 return nullptr;
Michal Karpinski4db754f2015-12-11 18:04:32 +00001898 }
1899
Elliott Hughesc4dc1412016-04-12 16:28:31 -07001900 SHA256_Update(&ctx, buffer.data(), bytes_read);
Michal Karpinski4db754f2015-12-11 18:04:32 +00001901 }
1902
Elliott Hughesc4dc1412016-04-12 16:28:31 -07001903 uint8_t hash[SHA256_DIGEST_LENGTH];
1904 SHA256_Final(hash, &ctx);
1905
1906 char hash_buffer[SHA256_DIGEST_LENGTH * 2 + 1];
1907 for(size_t i = 0; i < SHA256_DIGEST_LENGTH; i++) {
Michal Karpinskicbbdf732016-01-07 20:45:02 +00001908 sprintf(hash_buffer + (i * 2), "%02x", hash[i]);
Michal Karpinski4db754f2015-12-11 18:04:32 +00001909 }
1910 hash_buffer[sizeof(hash_buffer) - 1] = 0;
1911 return std::string(hash_buffer);
1912}
1913
Felipe Lemea4ef1f02017-02-15 17:27:40 -08001914static void SendBroadcast(const std::string& action, const std::vector<std::string>& args) {
1915 // clang-format off
1916 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user", "0",
1917 "--receiver-foreground", "--receiver-include-background", "-a", action};
1918 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08001919
1920 am.insert(am.end(), args.begin(), args.end());
1921
Felipe Leme8d2410e2017-02-08 09:46:08 -08001922 RunCommand("", am,
1923 CommandOptions::WithTimeout(20)
1924 .Log("Sending broadcast: '%s'\n")
1925 .Always()
1926 .DropRoot()
1927 .RedirectStderr()
1928 .Build());
1929}
1930
Felipe Leme35b8cf12017-02-10 15:47:29 -08001931static void Vibrate(int duration_ms) {
1932 // clang-format off
1933 RunCommand("", {"cmd", "vibrator", "vibrate", std::to_string(duration_ms), "dumpstate"},
1934 CommandOptions::WithTimeout(10)
1935 .Log("Vibrate: '%s'\n")
1936 .Always()
1937 .Build());
1938 // clang-format on
1939}
1940
Nandana Dutt979388e2018-11-30 16:48:55 +00001941static void MaybeResolveSymlink(std::string* path) {
1942 std::string resolved_path;
1943 if (android::base::Readlink(*path, &resolved_path)) {
1944 *path = resolved_path;
1945 }
1946}
1947
Nandana Dutt4be45d12018-09-26 15:04:23 +01001948/*
1949 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
1950 * if we are writing zip files and adds the version file.
1951 */
1952static void PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00001953 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
1954
Nandana Dutt4be45d12018-09-26 15:04:23 +01001955 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
1956 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt9a76d202019-01-21 15:56:48 +00001957 ds.base_name_ = StringPrintf("bugreport-%s-%s", device_name.c_str(), build_id.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01001958 if (ds.options_->do_add_date) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01001959 char date[80];
1960 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
1961 ds.name_ = date;
1962 } else {
1963 ds.name_ = "undated";
1964 }
1965
Nandana Dutt5fb117b2018-09-27 09:23:36 +01001966 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01001967 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01001968 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01001969 ds.base_name_ += "-wifi";
1970 }
1971
Nandana Dutt5fb117b2018-09-27 09:23:36 +01001972 if (ds.options_->do_fb) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01001973 ds.screenshot_path_ = ds.GetPath(".png");
1974 }
1975 ds.tmp_path_ = ds.GetPath(".tmp");
1976 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
1977
Nandana Dutt54dbd672019-01-11 12:58:05 +00001978 std::string destination = ds.options_->bugreport_fd.get() != -1
1979 ? StringPrintf("[fd:%d]", ds.options_->bugreport_fd.get())
Nandana Dutt9a76d202019-01-21 15:56:48 +00001980 : ds.bugreport_internal_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01001981 MYLOGD(
1982 "Bugreport dir: %s\n"
1983 "Base name: %s\n"
1984 "Suffix: %s\n"
1985 "Log path: %s\n"
1986 "Temporary path: %s\n"
1987 "Screenshot path: %s\n",
Nandana Dutt9a76d202019-01-21 15:56:48 +00001988 destination.c_str(), ds.base_name_.c_str(), ds.name_.c_str(), ds.log_path_.c_str(),
1989 ds.tmp_path_.c_str(), ds.screenshot_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01001990
Nandana Dutt5fb117b2018-09-27 09:23:36 +01001991 if (ds.options_->do_zip_file) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01001992 ds.path_ = ds.GetPath(".zip");
1993 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
1994 create_parent_dirs(ds.path_.c_str());
1995 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
1996 if (ds.zip_file == nullptr) {
1997 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
1998 } else {
1999 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
2000 }
2001 ds.AddTextZipEntry("version.txt", ds.version_);
2002 }
2003}
2004
2005/*
2006 * Finalizes writing to the file by renaming or zipping the tmp file to the final location,
2007 * printing zipped file status, etc.
2008 */
2009static void FinalizeFile() {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002010 /* check if user changed the suffix using system properties */
2011 std::string name =
2012 android::base::GetProperty(android::base::StringPrintf("dumpstate.%d.name", ds.pid_), "");
2013 bool change_suffix = false;
2014 if (!name.empty()) {
2015 /* must whitelist which characters are allowed, otherwise it could cross directories */
2016 std::regex valid_regex("^[-_a-zA-Z0-9]+$");
2017 if (std::regex_match(name.c_str(), valid_regex)) {
2018 change_suffix = true;
2019 } else {
2020 MYLOGE("invalid suffix provided by user: %s\n", name.c_str());
2021 }
2022 }
2023 if (change_suffix) {
2024 MYLOGI("changing suffix from %s to %s\n", ds.name_.c_str(), name.c_str());
2025 ds.name_ = name;
2026 if (!ds.screenshot_path_.empty()) {
2027 std::string new_screenshot_path = ds.GetPath(".png");
2028 if (rename(ds.screenshot_path_.c_str(), new_screenshot_path.c_str())) {
2029 MYLOGE("rename(%s, %s): %s\n", ds.screenshot_path_.c_str(),
2030 new_screenshot_path.c_str(), strerror(errno));
2031 } else {
2032 ds.screenshot_path_ = new_screenshot_path;
2033 }
2034 }
2035 }
2036
2037 bool do_text_file = true;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002038 if (ds.options_->do_zip_file) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002039 if (!ds.FinishZipFile()) {
2040 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
2041 do_text_file = true;
2042 } else {
2043 do_text_file = false;
Nandana Dutt383d0c12018-11-30 15:54:56 +00002044 // If the user has changed the suffix, we need to change the zip file name.
2045 std::string new_path = ds.GetPath(".zip");
2046 if (ds.path_ != new_path) {
2047 MYLOGD("Renaming zip file from %s to %s\n", ds.path_.c_str(), new_path.c_str());
2048 if (rename(ds.path_.c_str(), new_path.c_str())) {
2049 MYLOGE("rename(%s, %s): %s\n", ds.path_.c_str(), new_path.c_str(),
2050 strerror(errno));
2051 } else {
2052 ds.path_ = new_path;
2053 }
2054 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01002055 }
2056 }
2057 if (do_text_file) {
2058 ds.path_ = ds.GetPath(".txt");
2059 MYLOGD("Generating .txt bugreport at %s from %s\n", ds.path_.c_str(), ds.tmp_path_.c_str());
2060 if (rename(ds.tmp_path_.c_str(), ds.path_.c_str())) {
2061 MYLOGE("rename(%s, %s): %s\n", ds.tmp_path_.c_str(), ds.path_.c_str(), strerror(errno));
2062 ds.path_.clear();
2063 }
2064 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002065 if (ds.options_->use_control_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002066 if (do_text_file) {
2067 dprintf(ds.control_socket_fd_,
2068 "FAIL:could not create zip file, check %s "
2069 "for more details\n",
2070 ds.log_path_.c_str());
2071 } else {
2072 dprintf(ds.control_socket_fd_, "OK:%s\n", ds.path_.c_str());
2073 }
2074 }
2075}
2076
2077/* Broadcasts that we are done with the bugreport */
2078static void SendBugreportFinishedBroadcast() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002079 // TODO(b/111441001): use callback instead of broadcast.
Nandana Dutt9a76d202019-01-21 15:56:48 +00002080 if (!ds.path_.empty()) {
2081 MYLOGI("Final bugreport path: %s\n", ds.path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002082 // clang-format off
2083
2084 std::vector<std::string> am_args = {
2085 "--receiver-permission", "android.permission.DUMP",
2086 "--ei", "android.intent.extra.ID", std::to_string(ds.id_),
2087 "--ei", "android.intent.extra.PID", std::to_string(ds.pid_),
2088 "--ei", "android.intent.extra.MAX", std::to_string(ds.progress_->GetMax()),
Nandana Dutt9a76d202019-01-21 15:56:48 +00002089 "--es", "android.intent.extra.BUGREPORT", ds.path_,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002090 "--es", "android.intent.extra.DUMPSTATE_LOG", ds.log_path_
2091 };
2092 // clang-format on
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002093 if (ds.options_->do_fb) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002094 am_args.push_back("--es");
2095 am_args.push_back("android.intent.extra.SCREENSHOT");
2096 am_args.push_back(ds.screenshot_path_);
2097 }
Nandana Dutt15b89d72018-11-16 14:14:12 +00002098 if (!ds.options_->notification_title.empty()) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002099 am_args.push_back("--es");
2100 am_args.push_back("android.intent.extra.TITLE");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002101 am_args.push_back(ds.options_->notification_title);
2102 if (!ds.options_->notification_description.empty()) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002103 am_args.push_back("--es");
2104 am_args.push_back("android.intent.extra.DESCRIPTION");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002105 am_args.push_back(ds.options_->notification_description);
Nandana Dutt4be45d12018-09-26 15:04:23 +01002106 }
2107 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002108 if (ds.options_->is_remote_mode) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002109 am_args.push_back("--es");
2110 am_args.push_back("android.intent.extra.REMOTE_BUGREPORT_HASH");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002111 am_args.push_back(SHA256_file_hash(ds.path_));
Nandana Dutt4be45d12018-09-26 15:04:23 +01002112 SendBroadcast("com.android.internal.intent.action.REMOTE_BUGREPORT_FINISHED", am_args);
2113 } else {
2114 SendBroadcast("com.android.internal.intent.action.BUGREPORT_FINISHED", am_args);
2115 }
2116 } else {
2117 MYLOGE("Skipping finished broadcast because bugreport could not be generated\n");
2118 }
2119}
2120
Nandana Dutt58d72e22018-11-16 10:30:48 +00002121static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2122 switch (mode) {
2123 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2124 return "BUGREPORT_FULL";
2125 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2126 return "BUGREPORT_INTERACTIVE";
2127 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2128 return "BUGREPORT_REMOTE";
2129 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2130 return "BUGREPORT_WEAR";
2131 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2132 return "BUGREPORT_TELEPHONY";
2133 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2134 return "BUGREPORT_WIFI";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002135 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2136 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002137 }
2138}
2139
2140static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options) {
Abhijeet Kaur8ca245e2018-12-12 10:34:21 +00002141 options->extra_options = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002142 switch (mode) {
2143 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2144 options->do_broadcast = true;
2145 options->do_fb = true;
2146 break;
2147 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002148 // Currently, the dumpstate binder is only used by Shell to update progress.
2149 options->do_start_service = true;
2150 options->do_progress_updates = true;
2151 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002152 options->do_broadcast = true;
2153 break;
2154 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002155 options->do_vibrate = false;
2156 options->is_remote_mode = true;
2157 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002158 options->do_broadcast = true;
2159 break;
2160 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002161 options->do_start_service = true;
2162 options->do_progress_updates = true;
2163 options->do_zip_file = true;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002164 options->do_fb = true;
2165 options->do_broadcast = true;
2166 break;
2167 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002168 options->telephony_only = true;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002169 options->do_fb = true;
2170 options->do_broadcast = true;
2171 break;
2172 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002173 options->wifi_only = true;
2174 options->do_zip_file = true;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002175 options->do_fb = true;
2176 options->do_broadcast = true;
2177 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002178 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2179 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002180 }
2181}
2182
2183static Dumpstate::BugreportMode getBugreportModeFromProperty() {
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002184 // If the system property is not set, it's assumed to be a default bugreport.
2185 Dumpstate::BugreportMode mode = Dumpstate::BugreportMode::BUGREPORT_DEFAULT;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002186
2187 std::string extra_options = android::base::GetProperty(PROPERTY_EXTRA_OPTIONS, "");
2188 if (!extra_options.empty()) {
2189 // Framework uses a system property to override some command-line args.
2190 // Currently, it contains the type of the requested bugreport.
2191 if (extra_options == "bugreportplus") {
2192 mode = Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002193 } else if (extra_options == "bugreportfull") {
2194 mode = Dumpstate::BugreportMode::BUGREPORT_FULL;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002195 } else if (extra_options == "bugreportremote") {
2196 mode = Dumpstate::BugreportMode::BUGREPORT_REMOTE;
2197 } else if (extra_options == "bugreportwear") {
2198 mode = Dumpstate::BugreportMode::BUGREPORT_WEAR;
2199 } else if (extra_options == "bugreporttelephony") {
2200 mode = Dumpstate::BugreportMode::BUGREPORT_TELEPHONY;
2201 } else if (extra_options == "bugreportwifi") {
2202 mode = Dumpstate::BugreportMode::BUGREPORT_WIFI;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002203 } else {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002204 MYLOGE("Unknown extra option: %s\n", extra_options.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002205 }
2206 // Reset the property
2207 android::base::SetProperty(PROPERTY_EXTRA_OPTIONS, "");
2208 }
Nandana Dutt58d72e22018-11-16 10:30:48 +00002209 return mode;
2210}
2211
2212// TODO: Move away from system properties when we have options passed via binder calls.
2213/* Sets runtime options from the system properties and then clears those properties. */
2214static void SetOptionsFromProperties(Dumpstate::DumpOptions* options) {
2215 Dumpstate::BugreportMode mode = getBugreportModeFromProperty();
2216 SetOptionsFromMode(mode, options);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002217
2218 options->notification_title = android::base::GetProperty(PROPERTY_EXTRA_TITLE, "");
2219 if (!options->notification_title.empty()) {
2220 // Reset the property
2221 android::base::SetProperty(PROPERTY_EXTRA_TITLE, "");
2222
Nandana Duttdd8cca32018-11-14 10:10:29 +00002223 options->notification_description =
2224 android::base::GetProperty(PROPERTY_EXTRA_DESCRIPTION, "");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002225 if (!options->notification_description.empty()) {
2226 // Reset the property
2227 android::base::SetProperty(PROPERTY_EXTRA_DESCRIPTION, "");
2228 }
2229 MYLOGD("notification (title: %s, description: %s)\n", options->notification_title.c_str(),
2230 options->notification_description.c_str());
2231 }
2232}
2233
Nandana Dutt58d72e22018-11-16 10:30:48 +00002234static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
2235 MYLOGI("do_zip_file: %d\n", options.do_zip_file);
2236 MYLOGI("do_add_date: %d\n", options.do_add_date);
2237 MYLOGI("do_vibrate: %d\n", options.do_vibrate);
2238 MYLOGI("use_socket: %d\n", options.use_socket);
2239 MYLOGI("use_control_socket: %d\n", options.use_control_socket);
2240 MYLOGI("do_fb: %d\n", options.do_fb);
2241 MYLOGI("do_broadcast: %d\n", options.do_broadcast);
2242 MYLOGI("is_remote_mode: %d\n", options.is_remote_mode);
2243 MYLOGI("show_header_only: %d\n", options.show_header_only);
2244 MYLOGI("do_start_service: %d\n", options.do_start_service);
2245 MYLOGI("telephony_only: %d\n", options.telephony_only);
2246 MYLOGI("wifi_only: %d\n", options.wifi_only);
2247 MYLOGI("do_progress_updates: %d\n", options.do_progress_updates);
Nandana Dutt54dbd672019-01-11 12:58:05 +00002248 MYLOGI("fd: %d\n", options.bugreport_fd.get());
Nandana Dutt58d72e22018-11-16 10:30:48 +00002249 MYLOGI("extra_options: %s\n", options.extra_options.c_str());
2250 MYLOGI("args: %s\n", options.args.c_str());
2251 MYLOGI("notification_title: %s\n", options.notification_title.c_str());
2252 MYLOGI("notification_description: %s\n", options.notification_description.c_str());
2253}
2254
Nandana Dutt54dbd672019-01-11 12:58:05 +00002255void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode,
2256 const android::base::unique_fd& bugreport_fd_in,
2257 const android::base::unique_fd& screenshot_fd_in) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002258 // In the new API world, date is always added; output is always a zip file.
2259 // TODO(111441001): remove these options once they are obsolete.
2260 do_add_date = true;
2261 do_zip_file = true;
2262
Nandana Dutt54dbd672019-01-11 12:58:05 +00002263 // Duplicate the fds because the passed in fds don't outlive the binder transaction.
2264 bugreport_fd.reset(dup(bugreport_fd_in.get()));
2265 screenshot_fd.reset(dup(screenshot_fd_in.get()));
Nandana Dutt58d72e22018-11-16 10:30:48 +00002266
2267 extra_options = ModeToString(bugreport_mode);
2268 SetOptionsFromMode(bugreport_mode, this);
2269}
2270
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002271Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
2272 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002273 int c;
Nandana Dutt235864b2019-01-22 12:10:16 +00002274 while ((c = getopt(argc, argv, "dho:svqzpPBRSV:w")) != -1) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002275 switch (c) {
2276 // clang-format off
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002277 case 'd': do_add_date = true; break;
2278 case 'z': do_zip_file = true; break;
Nandana Dutt9a76d202019-01-21 15:56:48 +00002279 // o=use_outfile not supported anymore.
2280 // TODO(b/111441001): Remove when all callers have migrated.
2281 case 'o': break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002282 case 's': use_socket = true; break;
2283 case 'S': use_control_socket = true; break;
2284 case 'v': show_header_only = true; break;
2285 case 'q': do_vibrate = false; break;
2286 case 'p': do_fb = true; break;
2287 case 'P': do_progress_updates = true; break;
2288 case 'R': is_remote_mode = true; break;
2289 case 'B': do_broadcast = true; break;
2290 case 'V': break; // compatibility no-op
Nandana Dutt235864b2019-01-22 12:10:16 +00002291 case 'w':
2292 // This was already processed
2293 break;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002294 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002295 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002296 break;
2297 default:
2298 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002299 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002300 break;
2301 // clang-format on
2302 }
2303 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08002304
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002305 // TODO: use helper function to convert argv into a string
2306 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002307 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002308 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002309 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002310 }
2311 }
2312
2313 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
2314 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002315
2316 SetOptionsFromProperties(this);
2317 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002318}
2319
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002320bool Dumpstate::DumpOptions::ValidateOptions() const {
Nandana Dutt54dbd672019-01-11 12:58:05 +00002321 if (bugreport_fd.get() != -1 && !do_zip_file) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002322 return false;
2323 }
2324
Nandana Dutt9a76d202019-01-21 15:56:48 +00002325 if ((do_zip_file || do_add_date || do_progress_updates || do_broadcast) && !OutputToFile()) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002326 return false;
2327 }
2328
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002329 if (use_control_socket && !do_zip_file) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002330 return false;
2331 }
2332
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002333 if (do_progress_updates && !do_broadcast) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002334 return false;
2335 }
2336
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002337 if (is_remote_mode && (do_progress_updates || !do_broadcast || !do_zip_file || !do_add_date)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002338 return false;
2339 }
2340 return true;
2341}
2342
Nandana Dutt197661d2018-11-16 16:40:21 +00002343void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
2344 options_ = std::move(options);
2345}
2346
Nandana Duttd2f5f082019-01-18 17:13:52 +00002347Dumpstate::RunStatus Dumpstate::Run(int32_t calling_uid, const std::string& calling_package) {
2348 Dumpstate::RunStatus status = RunInternal(calling_uid, calling_package);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002349 if (listener_ != nullptr) {
2350 switch (status) {
2351 case Dumpstate::RunStatus::OK:
Nandana Duttcc4ead82019-01-23 08:29:23 +00002352 listener_->onFinished();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002353 break;
2354 case Dumpstate::RunStatus::HELP:
2355 break;
2356 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002357 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_INVALID_INPUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002358 break;
2359 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002360 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_RUNTIME_ERROR);
2361 break;
2362 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2363 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_DENIED_CONSENT);
2364 break;
2365 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
2366 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_CONSENT_TIMED_OUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002367 break;
2368 }
2369 }
2370 return status;
2371}
2372
Nandana Dutt979388e2018-11-30 16:48:55 +00002373/*
2374 * Dumps relevant information to a bugreport based on the given options.
2375 *
2376 * The bugreport can be dumped to a file or streamed to a socket.
2377 *
2378 * How dumping to file works:
2379 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
2380 * stderr is redirected a log file.
2381 *
2382 * The temporary bugreport is then populated via printfs, dumping contents of files and
2383 * output of commands to stdout.
2384 *
2385 * If zipping, the temporary bugreport file is added to the zip archive. Else it's renamed to final
2386 * text file.
2387 *
2388 * If zipping, a bunch of other files and dumps also get added to the zip archive. The log file also
2389 * gets added to the archive.
2390 *
Nandana Dutt9a76d202019-01-21 15:56:48 +00002391 * Bugreports are first generated in a local directory and later copied to the caller's fd if
2392 * supplied.
Nandana Dutt979388e2018-11-30 16:48:55 +00002393 */
Nandana Duttd2f5f082019-01-18 17:13:52 +00002394Dumpstate::RunStatus Dumpstate::RunInternal(int32_t calling_uid,
2395 const std::string& calling_package) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002396 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00002397 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002398 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002399 return RunStatus::INVALID_INPUT;
2400 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002401 /* set as high priority, and protect from OOM killer */
2402 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002403
Felipe Lemed071c682016-10-20 16:48:00 -07002404 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002405 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002406 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002407 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002408 } else {
2409 /* fallback to kernels <= 2.6.35 */
2410 oom_adj = fopen("/proc/self/oom_adj", "we");
2411 if (oom_adj) {
2412 fputs("-17", oom_adj);
2413 fclose(oom_adj);
2414 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002415 }
2416
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002417 if (version_ == VERSION_DEFAULT) {
2418 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00002419 }
2420
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002421 if (version_ != VERSION_CURRENT && version_ != VERSION_SPLIT_ANR) {
Vishnu Nair64afc022018-02-01 15:29:34 -08002422 MYLOGE("invalid version requested ('%s'); suppported values are: ('%s', '%s', '%s')\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002423 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str(),
Vishnu Nair64afc022018-02-01 15:29:34 -08002424 VERSION_SPLIT_ANR.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002425 return RunStatus::INVALID_INPUT;
Felipe Lemed071c682016-10-20 16:48:00 -07002426 }
2427
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002428 if (options_->show_header_only) {
2429 PrintHeader();
2430 return RunStatus::OK;
Felipe Lemed071c682016-10-20 16:48:00 -07002431 }
2432
Nandana Duttd2f5f082019-01-18 17:13:52 +00002433 if (options_->bugreport_fd.get() != -1) {
2434 // If the output needs to be copied over to the caller's fd, get user consent.
2435 android::String16 package(calling_package.c_str());
2436 CheckUserConsent(calling_uid, package);
2437 }
2438
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002439 // Redirect output if needed
Nandana Dutt9a76d202019-01-21 15:56:48 +00002440 bool is_redirecting = options_->OutputToFile();
Felipe Leme7447d7c2016-11-03 18:12:22 -07002441
2442 // TODO: temporarily set progress until it's part of the Dumpstate constructor
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002443 std::string stats_path =
Nandana Dutt979388e2018-11-30 16:48:55 +00002444 is_redirecting
2445 ? android::base::StringPrintf("%s/dumpstate-stats.txt", bugreport_internal_dir_.c_str())
2446 : "";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002447 progress_.reset(new Progress(stats_path));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002448
Felipe Lemed071c682016-10-20 16:48:00 -07002449 /* gets the sequential id */
Felipe Leme7447d7c2016-11-03 18:12:22 -07002450 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002451 id_ = ++last_id;
Felipe Lemed071c682016-10-20 16:48:00 -07002452 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
2453
2454 MYLOGI("begin\n");
2455
Felipe Leme6ae5c4f2017-01-10 14:13:22 -08002456 register_sig_handler();
Felipe Lemed071c682016-10-20 16:48:00 -07002457
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002458 // TODO(b/111441001): maybe skip if already started?
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002459 if (options_->do_start_service) {
Felipe Leme75876a22016-10-27 16:31:27 -07002460 MYLOGI("Starting 'dumpstate' service\n");
2461 android::status_t ret;
2462 if ((ret = android::os::DumpstateService::Start()) != android::OK) {
2463 MYLOGE("Unable to start DumpstateService: %d\n", ret);
2464 }
2465 }
2466
Felipe Lemef0292972016-11-22 13:57:05 -08002467 if (PropertiesHelper::IsDryRun()) {
Felipe Lemed071c682016-10-20 16:48:00 -07002468 MYLOGI("Running on dry-run mode (to disable it, call 'setprop dumpstate.dry_run false')\n");
2469 }
2470
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002471 MYLOGI("dumpstate info: id=%d, args='%s', extra_options= %s)\n", id_, options_->args.c_str(),
2472 options_->extra_options.c_str());
Felipe Lemed071c682016-10-20 16:48:00 -07002473
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002474 MYLOGI("bugreport format version: %s\n", version_.c_str());
Felipe Leme809d74e2016-02-02 12:57:00 -08002475
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002476 do_early_screenshot_ = options_->do_progress_updates;
Felipe Lemee338bf62015-12-07 14:03:50 -08002477
Christopher Ferrised9354f2014-10-01 17:35:01 -07002478 // If we are going to use a socket, do it as early as possible
2479 // to avoid timeouts from bugreport.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002480 if (options_->use_socket) {
Nandana Dutta344cb62019-02-22 15:12:35 +00002481 if (!redirect_to_socket(stdout, "dumpstate")) {
2482 return ERROR;
2483 }
Christopher Ferrised9354f2014-10-01 17:35:01 -07002484 }
2485
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002486 if (options_->use_control_socket) {
Felipe Leme2628e9e2016-04-12 16:36:51 -07002487 MYLOGD("Opening control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002488 control_socket_fd_ = open_socket("dumpstate");
Nandana Dutta344cb62019-02-22 15:12:35 +00002489 if (control_socket_fd_ == -1) {
2490 return ERROR;
2491 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002492 options_->do_progress_updates = 1;
Felipe Leme2628e9e2016-04-12 16:36:51 -07002493 }
2494
Felipe Leme71bbfc52015-11-23 14:14:51 -08002495 if (is_redirecting) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002496 PrepareToWriteToFile();
Felipe Leme1e9edc62015-12-21 16:02:13 -08002497
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002498 if (options_->do_progress_updates) {
2499 if (options_->do_broadcast) {
Felipe Lemedcd1f0d2016-08-04 12:48:50 -07002500 // clang-format off
2501 std::vector<std::string> am_args = {
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002502 "--receiver-permission", "android.permission.DUMP",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002503 "--es", "android.intent.extra.NAME", name_,
2504 "--ei", "android.intent.extra.ID", std::to_string(id_),
2505 "--ei", "android.intent.extra.PID", std::to_string(pid_),
2506 "--ei", "android.intent.extra.MAX", std::to_string(progress_->GetMax()),
Felipe Lemedcd1f0d2016-08-04 12:48:50 -07002507 };
2508 // clang-format on
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002509 SendBroadcast("com.android.internal.intent.action.BUGREPORT_STARTED", am_args);
Felipe Lemedcd1f0d2016-08-04 12:48:50 -07002510 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002511 if (options_->use_control_socket) {
2512 dprintf(control_socket_fd_, "BEGIN:%s\n", path_.c_str());
Felipe Lemeaabfcae2016-07-29 09:49:04 -07002513 }
Felipe Leme71bbfc52015-11-23 14:14:51 -08002514 }
2515 }
2516
Nick Kralevichf3599b32016-01-25 15:05:16 -08002517 /* read /proc/cmdline before dropping root */
2518 FILE *cmdline = fopen("/proc/cmdline", "re");
2519 if (cmdline) {
2520 fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
2521 fclose(cmdline);
2522 }
2523
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002524 if (options_->do_vibrate) {
Felipe Leme35b8cf12017-02-10 15:47:29 -08002525 Vibrate(150);
John Michelau1f794c42012-09-17 11:20:19 -05002526 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002527
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002528 if (options_->do_fb && do_early_screenshot_) {
2529 if (screenshot_path_.empty()) {
Felipe Leme3634a1e2015-12-09 10:11:47 -08002530 // should not have happened
Felipe Lemecbce55d2016-02-08 09:53:18 -08002531 MYLOGE("INTERNAL ERROR: skipping early screenshot because path was not set\n");
Felipe Leme3634a1e2015-12-09 10:11:47 -08002532 } else {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002533 MYLOGI("taking early screenshot\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002534 TakeScreenshot();
Felipe Lemee338bf62015-12-07 14:03:50 -08002535 }
2536 }
2537
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002538 if (options_->do_zip_file && zip_file != nullptr) {
2539 if (chown(path_.c_str(), AID_SHELL, AID_SHELL)) {
2540 MYLOGE("Unable to change ownership of zip file %s: %s\n", path_.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -07002541 strerror(errno));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002542 }
2543 }
2544
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002545 int dup_stdout_fd;
2546 int dup_stderr_fd;
Felipe Leme71bbfc52015-11-23 14:14:51 -08002547 if (is_redirecting) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002548 // Redirect stderr to log_path_ for debugging.
Vishnu Nair20cf5032018-01-05 13:15:49 -08002549 TEMP_FAILURE_RETRY(dup_stderr_fd = dup(fileno(stderr)));
Nandana Dutta344cb62019-02-22 15:12:35 +00002550 if (!redirect_to_file(stderr, const_cast<char*>(log_path_.c_str()))) {
2551 return ERROR;
2552 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002553 if (chown(log_path_.c_str(), AID_SHELL, AID_SHELL)) {
2554 MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n", log_path_.c_str(),
2555 strerror(errno));
Felipe Leme6fe9db62016-02-12 09:04:16 -08002556 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002557
2558 // Redirect stdout to tmp_path_. This is the main bugreport entry and will be
2559 // moved into zip file later, if zipping.
Vishnu Nair20cf5032018-01-05 13:15:49 -08002560 TEMP_FAILURE_RETRY(dup_stdout_fd = dup(fileno(stdout)));
Nandana Dutt979388e2018-11-30 16:48:55 +00002561 // TODO: why not write to a file instead of stdout to overcome this problem?
Felipe Leme6e01fa62015-11-11 19:35:14 -08002562 /* TODO: rather than generating a text file now and zipping it later,
2563 it would be more efficient to redirect stdout to the zip entry
2564 directly, but the libziparchive doesn't support that option yet. */
Nandana Dutta344cb62019-02-22 15:12:35 +00002565 if (!redirect_to_file(stdout, const_cast<char*>(tmp_path_.c_str()))) {
2566 return ERROR;
2567 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002568 if (chown(tmp_path_.c_str(), AID_SHELL, AID_SHELL)) {
Felipe Leme6fe9db62016-02-12 09:04:16 -08002569 MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002570 tmp_path_.c_str(), strerror(errno));
Felipe Leme6fe9db62016-02-12 09:04:16 -08002571 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002572 }
Felipe Lemed8b94e52016-12-08 10:21:44 -08002573
2574 // Don't buffer stdout
2575 setvbuf(stdout, nullptr, _IONBF, 0);
2576
Felipe Leme608385d2016-02-01 10:35:38 -08002577 // NOTE: there should be no stdout output until now, otherwise it would break the header.
2578 // In particular, DurationReport objects should be created passing 'title, NULL', so their
Felipe Lemecbce55d2016-02-08 09:53:18 -08002579 // duration is logged into MYLOG instead.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002580 PrintHeader();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002581
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002582 if (options_->telephony_only) {
Jayachandran Ca94c7172017-06-10 15:08:12 -07002583 DumpstateTelephonyOnly();
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002584 DumpstateBoard();
2585 } else if (options_->wifi_only) {
mukesh agrawal253dad42018-01-23 21:59:59 -08002586 DumpstateWifiOnly();
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002587 } else {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002588 // Dump state for the default case. This also drops root.
2589 if (!DumpstateDefault()) {
2590 // Something went wrong.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002591 return RunStatus::ERROR;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002592 }
Zhengyin Qian068ecc72016-08-10 16:48:14 -07002593 }
Felipe Leme71a74ac2016-03-17 15:43:25 -07002594
Felipe Leme55b42a62015-11-10 17:39:08 -08002595 /* close output if needed */
Felipe Leme71bbfc52015-11-23 14:14:51 -08002596 if (is_redirecting) {
Vishnu Nair20cf5032018-01-05 13:15:49 -08002597 TEMP_FAILURE_RETRY(dup2(dup_stdout_fd, fileno(stdout)));
Colin Crossf45fa6b2012-03-26 12:38:26 -07002598 }
2599
Nandana Duttd2f5f082019-01-18 17:13:52 +00002600 // Rename, and/or zip the (now complete) .tmp file within the internal directory.
Nandana Dutt9a76d202019-01-21 15:56:48 +00002601 if (options_->OutputToFile()) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002602 FinalizeFile();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002603 }
2604
Nandana Duttd2f5f082019-01-18 17:13:52 +00002605 // Share the final file with the caller if the user has consented.
2606 Dumpstate::RunStatus status = Dumpstate::RunStatus::OK;
2607 if (options_->bugreport_fd.get() != -1) {
2608 status = CopyBugreportIfUserConsented();
2609 if (status != Dumpstate::RunStatus::OK &&
2610 status != Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2611 // Do an early return if there were errors. We make an exception for consent
2612 // timing out because it's possible the user got distracted. In this case the
2613 // bugreport is not shared but made available for manual retrieval.
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002614 MYLOGI("User denied consent. Returning\n");
Nandana Duttd2f5f082019-01-18 17:13:52 +00002615 return status;
2616 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002617 if (options_->do_fb && options_->screenshot_fd.get() != -1) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00002618 bool copy_succeeded = android::os::CopyFileToFd(screenshot_path_,
2619 options_->screenshot_fd.get());
2620 if (copy_succeeded) {
2621 android::os::UnlinkAndLogOnError(screenshot_path_);
2622 }
2623 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002624 if (status == Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2625 MYLOGI(
2626 "Did not receive user consent yet."
2627 " Will not copy the bugreport artifacts to caller.\n");
2628 // TODO(b/111441001):
2629 // 1. cancel outstanding requests
2630 // 2. check for result more frequently
2631 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00002632 }
2633
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002634 /* vibrate a few but shortly times to let user know it's finished */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002635 if (options_->do_vibrate) {
Takuya Ogawa47f644e2017-12-20 18:09:09 +09002636 for (int i = 0; i < 3; i++) {
2637 Vibrate(75);
2638 usleep((75 + 50) * 1000);
2639 }
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002640 }
2641
Jeff Brown1dc94e32014-09-11 14:15:27 -07002642 /* tell activity manager we're done */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002643 if (options_->do_broadcast) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002644 SendBugreportFinishedBroadcast();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002645 // Note that listener_ is notified in Run();
Jeff Sharkey27f9e6d2013-03-13 15:45:50 -07002646 }
2647
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002648 MYLOGD("Final progress: %d/%d (estimated %d)\n", progress_->Get(), progress_->GetMax(),
2649 progress_->GetInitialMax());
2650 progress_->Save();
2651 MYLOGI("done (id %d)\n", id_);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002652
Felipe Leme107a05f2016-03-08 15:11:15 -08002653 if (is_redirecting) {
Vishnu Nair20cf5032018-01-05 13:15:49 -08002654 TEMP_FAILURE_RETRY(dup2(dup_stderr_fd, fileno(stderr)));
Felipe Leme107a05f2016-03-08 15:11:15 -08002655 }
2656
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002657 if (options_->use_control_socket && control_socket_fd_ != -1) {
Felipe Lemee844a9d2016-09-21 15:01:39 -07002658 MYLOGD("Closing control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002659 close(control_socket_fd_);
Felipe Leme2628e9e2016-04-12 16:36:51 -07002660 }
2661
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002662 tombstone_data_.clear();
2663 anr_data_.clear();
Narayan Kamath6b9516c2017-10-27 11:15:51 +01002664
Nandana Duttd2f5f082019-01-18 17:13:52 +00002665 return (consent_callback_ != nullptr &&
2666 consent_callback_->getResult() == UserConsentResult::UNAVAILABLE)
2667 ? USER_CONSENT_TIMED_OUT
2668 : RunStatus::OK;
2669}
2670
2671void Dumpstate::CheckUserConsent(int32_t calling_uid, const android::String16& calling_package) {
2672 consent_callback_ = new ConsentCallback();
2673 const String16 incidentcompanion("incidentcompanion");
2674 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
2675 if (ics != nullptr) {
2676 MYLOGD("Checking user consent via incidentcompanion service\n");
2677 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
2678 calling_uid, calling_package, 0x1 /* FLAG_CONFIRMATION_DIALOG */,
2679 consent_callback_.get());
2680 } else {
2681 MYLOGD("Unable to check user consent; incidentcompanion service unavailable\n");
2682 }
2683}
2684
2685void Dumpstate::CleanupFiles() {
2686 android::os::UnlinkAndLogOnError(tmp_path_);
2687 android::os::UnlinkAndLogOnError(screenshot_path_);
2688 android::os::UnlinkAndLogOnError(path_);
2689}
2690
2691Dumpstate::RunStatus Dumpstate::HandleUserConsentDenied() {
2692 MYLOGD("User denied consent; deleting files and returning\n");
2693 CleanupFiles();
2694 return USER_CONSENT_DENIED;
2695}
2696
2697Dumpstate::RunStatus Dumpstate::CopyBugreportIfUserConsented() {
2698 // If the caller has asked to copy the bugreport over to their directory, we need explicit
2699 // user consent.
2700 UserConsentResult consent_result = consent_callback_->getResult();
2701 if (consent_result == UserConsentResult::UNAVAILABLE) {
2702 // User has not responded yet.
2703 uint64_t elapsed_ms = consent_callback_->getElapsedTimeMs();
2704 if (elapsed_ms < USER_CONSENT_TIMEOUT_MS) {
2705 uint delay_seconds = (USER_CONSENT_TIMEOUT_MS - elapsed_ms) / 1000;
2706 MYLOGD("Did not receive user consent yet; going to wait for %d seconds", delay_seconds);
2707 sleep(delay_seconds);
2708 }
2709 consent_result = consent_callback_->getResult();
2710 }
2711 if (consent_result == UserConsentResult::DENIED) {
2712 // User has explicitly denied sharing with the app. To be safe delete the
2713 // internal bugreport & tmp files.
2714 return HandleUserConsentDenied();
2715 }
2716 if (consent_result == UserConsentResult::APPROVED) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00002717 bool copy_succeeded = android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
2718 if (copy_succeeded) {
2719 android::os::UnlinkAndLogOnError(path_);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002720 }
2721 return copy_succeeded ? Dumpstate::RunStatus::OK : Dumpstate::RunStatus::ERROR;
2722 } else if (consent_result == UserConsentResult::UNAVAILABLE) {
2723 // consent_result is still UNAVAILABLE. The user has likely not responded yet.
2724 // Since we do not have user consent to share the bugreport it does not get
2725 // copied over to the calling app but remains in the internal directory from
2726 // where the user can manually pull it.
2727 return Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT;
2728 }
2729 // Unknown result; must be a programming error.
2730 MYLOGE("Unknown user consent result:%d\n", consent_result);
2731 return Dumpstate::RunStatus::ERROR;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002732}
2733
Nandana Duttf02564e2019-02-15 15:24:24 +00002734Dumpstate::RunStatus Dumpstate::ParseCommandlineAndRun(int argc, char* argv[]) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002735 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
2736 Dumpstate::RunStatus status = options->Initialize(argc, argv);
2737 if (status == Dumpstate::RunStatus::OK) {
Nandana Duttf02564e2019-02-15 15:24:24 +00002738 SetOptions(std::move(options));
Nandana Duttd2f5f082019-01-18 17:13:52 +00002739 // When directly running dumpstate binary, the output is not expected to be written
2740 // to any external file descriptor.
Nandana Duttf02564e2019-02-15 15:24:24 +00002741 assert(options_->bugreport_fd.get() == -1);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002742
2743 // calling_uid and calling_package are for user consent to share the bugreport with
2744 // an app; they are irrelvant here because bugreport is only written to a local
2745 // directory, and not shared.
Nandana Duttf02564e2019-02-15 15:24:24 +00002746 status = Run(-1 /* calling_uid */, "" /* calling_package */);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002747 }
Nandana Duttf02564e2019-02-15 15:24:24 +00002748 return status;
2749}
2750
2751/* Main entry point for dumpstate binary. */
2752int run_main(int argc, char* argv[]) {
2753 Dumpstate::RunStatus status = ds.ParseCommandlineAndRun(argc, argv);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002754
2755 switch (status) {
2756 case Dumpstate::RunStatus::OK:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002757 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002758 case Dumpstate::RunStatus::HELP:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002759 ShowUsage();
2760 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002761 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002762 fprintf(stderr, "Invalid combination of args\n");
2763 ShowUsage();
2764 exit(1);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002765 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002766 FALLTHROUGH_INTENDED;
2767 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2768 FALLTHROUGH_INTENDED;
2769 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002770 exit(2);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002771 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002772}