blob: 1fc8107f9eb9ee4f382378af290efe1716204e57 [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>
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +000037#include <fstream>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070038#include <functional>
39#include <future>
Narayan Kamath8f788292017-05-25 13:20:39 +010040#include <memory>
41#include <regex>
42#include <set>
43#include <string>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070044#include <utility>
Narayan Kamath8f788292017-05-25 13:20:39 +010045#include <vector>
Colin Crossf45fa6b2012-03-26 12:38:26 -070046
Felipe Leme96c2bbb2016-09-26 09:21:21 -070047#include <android-base/file.h>
48#include <android-base/properties.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070049#include <android-base/scopeguard.h>
Elliott Hughes9dc117c2015-12-07 14:21:50 -080050#include <android-base/stringprintf.h>
Naveen Kalla058e1e82016-10-19 21:38:44 -070051#include <android-base/strings.h>
Andreas Gampeaff68432016-07-18 18:01:27 -070052#include <android-base/unique_fd.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080053#include <android/hardware/dumpstate/1.0/IDumpstateDevice.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080054#include <android/hidl/manager/1.0/IServiceManager.h>
Nandana Duttd2f5f082019-01-18 17:13:52 +000055#include <android/os/IIncidentCompanion.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080056#include <cutils/native_handle.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070057#include <cutils/properties.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000058#include <debuggerd/client.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080059#include <dumpsys.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000060#include <dumputils/dump_utils.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080061#include <hidl/ServiceManagement.h>
Felipe Leme75876a22016-10-27 16:31:27 -070062#include <openssl/sha.h>
Mark Salyzyn6c3d90f2016-09-27 14:55:27 -070063#include <private/android_filesystem_config.h>
64#include <private/android_logger.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080065#include <serviceutils/PriorityDumper.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070066#include <utils/StrongPointer.h>
Felipe Lemef0292972016-11-22 13:57:05 -080067#include "DumpstateInternal.h"
Vishnu Naire97d6122018-01-18 13:58:56 -080068#include "DumpstateSectionReporter.h"
Felipe Leme75876a22016-10-27 16:31:27 -070069#include "DumpstateService.h"
Colin Crossf45fa6b2012-03-26 12:38:26 -070070#include "dumpstate.h"
Felipe Leme6e01fa62015-11-11 19:35:14 -080071
Steven Morelandcb7ef822016-11-29 13:20:37 -080072using ::android::hardware::dumpstate::V1_0::IDumpstateDevice;
Vishnu Naire97d6122018-01-18 13:58:56 -080073using ::std::literals::chrono_literals::operator""ms;
74using ::std::literals::chrono_literals::operator""s;
Steven Morelandcb7ef822016-11-29 13:20:37 -080075
Felipe Leme47e9be22016-12-21 15:37:07 -080076// TODO: remove once moved to namespace
Vishnu Naire97d6122018-01-18 13:58:56 -080077using android::defaultServiceManager;
78using android::Dumpsys;
79using android::INVALID_OPERATION;
80using android::IServiceManager;
81using android::OK;
82using android::sp;
83using android::status_t;
84using android::String16;
85using android::String8;
86using android::TIMED_OUT;
87using android::UNKNOWN_ERROR;
88using android::Vector;
Nandana Dutt979388e2018-11-30 16:48:55 +000089using android::base::StringPrintf;
Nandana Duttd2f5f082019-01-18 17:13:52 +000090using android::os::IDumpstateListener;
Felipe Leme47e9be22016-12-21 15:37:07 -080091using android::os::dumpstate::CommandOptions;
92using android::os::dumpstate::DumpFileToFd;
Vishnu Naire97d6122018-01-18 13:58:56 -080093using android::os::dumpstate::DumpstateSectionReporter;
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
Nandana Duttbbdb5b42019-03-12 10:52:56 +0000134#define RETURN_IF_USER_DENIED_CONSENT() \
135 if (ds.IsUserConsentDenied()) { \
136 MYLOGE("Returning early as user denied consent to share bugreport with calling app."); \
137 return Dumpstate::RunStatus::USER_CONSENT_DENIED; \
138 }
139
140// Runs func_ptr, but checks user consent before and after running it. Returns USER_CONSENT_DENIED
141// if consent is found to be denied.
142#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(func_ptr, ...) \
143 RETURN_IF_USER_DENIED_CONSENT(); \
144 func_ptr(__VA_ARGS__); \
145 RETURN_IF_USER_DENIED_CONSENT();
146
Nandana Dutt979388e2018-11-30 16:48:55 +0000147namespace android {
148namespace os {
149namespace {
150
151static int Open(std::string path, int flags, mode_t mode = 0) {
152 int fd = TEMP_FAILURE_RETRY(open(path.c_str(), flags, mode));
153 if (fd == -1) {
154 MYLOGE("open(%s, %s)\n", path.c_str(), strerror(errno));
155 }
156 return fd;
157}
158
Nandana Dutt979388e2018-11-30 16:48:55 +0000159
160static int OpenForRead(std::string path) {
161 return Open(path, O_RDONLY | O_CLOEXEC | O_NOFOLLOW);
162}
163
164bool CopyFile(int in_fd, int out_fd) {
165 char buf[4096];
166 ssize_t byte_count;
167 while ((byte_count = TEMP_FAILURE_RETRY(read(in_fd, buf, sizeof(buf)))) > 0) {
168 if (!android::base::WriteFully(out_fd, buf, byte_count)) {
169 return false;
170 }
171 }
172 return (byte_count != -1);
173}
174
175static bool CopyFileToFd(const std::string& input_file, int out_fd) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000176 MYLOGD("Going to copy file (%s) to %d\n", input_file.c_str(), out_fd);
Nandana Dutt979388e2018-11-30 16:48:55 +0000177
178 // Obtain a handle to the source file.
179 android::base::unique_fd in_fd(OpenForRead(input_file));
180 if (out_fd != -1 && in_fd.get() != -1) {
181 if (CopyFile(in_fd.get(), out_fd)) {
182 return true;
183 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000184 MYLOGE("Failed to copy file: %s\n", strerror(errno));
Nandana Dutt979388e2018-11-30 16:48:55 +0000185 }
186 return false;
187}
188
Nandana Duttd2f5f082019-01-18 17:13:52 +0000189static bool UnlinkAndLogOnError(const std::string& file) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000190 if (unlink(file.c_str())) {
191 MYLOGE("Failed to unlink file (%s): %s\n", file.c_str(), strerror(errno));
Nandana Duttd2f5f082019-01-18 17:13:52 +0000192 return false;
193 }
194 return true;
195}
Nandana Dutt979388e2018-11-30 16:48:55 +0000196
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +0000197static bool IsFileEmpty(const std::string& file_path) {
198 std::ifstream file(file_path, std::ios::binary | std::ios::ate);
199 if(file.bad()) {
200 MYLOGE("Cannot open file: %s\n", file_path.c_str());
201 return true;
202 }
203 return file.tellg() <= 0;
204}
205
Nandana Dutt979388e2018-11-30 16:48:55 +0000206} // namespace
207} // namespace os
208} // namespace android
209
Felipe Leme678727a2016-09-21 17:22:11 -0700210static int RunCommand(const std::string& title, const std::vector<std::string>& fullCommand,
211 const CommandOptions& options = CommandOptions::DEFAULT) {
212 return ds.RunCommand(title, fullCommand, options);
213}
214static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
Felipe Lemebda15a02016-11-16 17:48:25 -0800215 const CommandOptions& options = Dumpstate::DEFAULT_DUMPSYS,
Vishnu Nair6921f802017-11-22 09:17:23 -0800216 long dumpsysTimeoutMs = 0) {
217 return ds.RunDumpsys(title, dumpsysArgs, options, dumpsysTimeoutMs);
Felipe Leme678727a2016-09-21 17:22:11 -0700218}
219static int DumpFile(const std::string& title, const std::string& path) {
220 return ds.DumpFile(title, path);
221}
Felipe Lemee82a27d2016-01-05 13:35:44 -0800222
Felipe Lemee844a9d2016-09-21 15:01:39 -0700223// Relative directory (inside the zip) for all files copied as-is into the bugreport.
224static const std::string ZIP_ROOT_DIR = "FS";
225
Vishnu Naire97d6122018-01-18 13:58:56 -0800226static const std::string kProtoPath = "proto/";
227static const std::string kProtoExt = ".proto";
Jie Song9fbfad02017-06-20 16:29:42 -0700228static const std::string kDumpstateBoardFiles[] = {
229 "dumpstate_board.txt",
Felipe Leme95d6ca52017-08-01 16:35:56 -0700230 "dumpstate_board.bin"
Jie Song9fbfad02017-06-20 16:29:42 -0700231};
232static const int NUM_OF_DUMPS = arraysize(kDumpstateBoardFiles);
233
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700234static constexpr char PROPERTY_EXTRA_OPTIONS[] = "dumpstate.options";
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700235static constexpr char PROPERTY_LAST_ID[] = "dumpstate.last_id";
Felipe Lemed071c682016-10-20 16:48:00 -0700236static constexpr char PROPERTY_VERSION[] = "dumpstate.version";
Naveen Kallab53a1c92017-03-16 18:17:25 -0700237static constexpr char PROPERTY_EXTRA_TITLE[] = "dumpstate.options.title";
238static constexpr char PROPERTY_EXTRA_DESCRIPTION[] = "dumpstate.options.description";
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700239
Felipe Lemef0292972016-11-22 13:57:05 -0800240static const CommandOptions AS_ROOT_20 = CommandOptions::WithTimeout(20).AsRoot().Build();
241
Narayan Kamath8f788292017-05-25 13:20:39 +0100242/*
Narayan Kamathbd863722017-06-01 18:50:12 +0100243 * Returns a vector of dump fds under |dir_path| with a given |file_prefix|.
244 * The returned vector is sorted by the mtimes of the dumps. If |limit_by_mtime|
245 * is set, the vector only contains files that were written in the last 30 minutes.
Andreas Gamped0d76952017-08-22 13:08:37 -0700246 * If |limit_by_count| is set, the vector only contains the ten latest files.
Narayan Kamath8f788292017-05-25 13:20:39 +0100247 */
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700248static std::vector<DumpData> GetDumpFds(const std::string& dir_path,
249 const std::string& file_prefix,
250 bool limit_by_mtime,
251 bool limit_by_count = true) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100252 const time_t thirty_minutes_ago = ds.now_ - 60 * 30;
253
Narayan Kamathbd863722017-06-01 18:50:12 +0100254 std::unique_ptr<DIR, decltype(&closedir)> dump_dir(opendir(dir_path.c_str()), closedir);
Narayan Kamath8f788292017-05-25 13:20:39 +0100255
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700256 if (dump_dir == nullptr) {
257 MYLOGW("Unable to open directory %s: %s\n", dir_path.c_str(), strerror(errno));
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700258 return std::vector<DumpData>();
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700259 }
260
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700261 std::vector<DumpData> dump_data;
Narayan Kamathbd863722017-06-01 18:50:12 +0100262 struct dirent* entry = nullptr;
263 while ((entry = readdir(dump_dir.get()))) {
264 if (entry->d_type != DT_REG) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100265 continue;
266 }
267
Narayan Kamathbd863722017-06-01 18:50:12 +0100268 const std::string base_name(entry->d_name);
269 if (base_name.find(file_prefix) != 0) {
270 continue;
271 }
272
273 const std::string abs_path = dir_path + base_name;
274 android::base::unique_fd fd(
275 TEMP_FAILURE_RETRY(open(abs_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW | O_NONBLOCK)));
276 if (fd == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700277 MYLOGW("Unable to open dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamathbd863722017-06-01 18:50:12 +0100278 break;
279 }
280
281 struct stat st = {};
282 if (fstat(fd, &st) == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700283 MYLOGW("Unable to stat dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamath8f788292017-05-25 13:20:39 +0100284 continue;
285 }
286
Narayan Kamath3f31b632018-02-22 19:42:36 +0000287 if (limit_by_mtime && st.st_mtime < thirty_minutes_ago) {
Narayan Kamathbd863722017-06-01 18:50:12 +0100288 MYLOGI("Excluding stale dump file: %s\n", abs_path.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100289 continue;
290 }
291
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700292 dump_data.emplace_back(DumpData{abs_path, std::move(fd), st.st_mtime});
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700293 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100294
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700295 // Sort in descending modification time so that we only keep the newest
296 // reports if |limit_by_count| is true.
297 std::sort(dump_data.begin(), dump_data.end(),
298 [](const DumpData& d1, const DumpData& d2) { return d1.mtime > d2.mtime; });
Narayan Kamath8f788292017-05-25 13:20:39 +0100299
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700300 if (limit_by_count && dump_data.size() > 10) {
301 dump_data.erase(dump_data.begin() + 10, dump_data.end());
Andreas Gamped0d76952017-08-22 13:08:37 -0700302 }
303
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700304 return dump_data;
Narayan Kamath8f788292017-05-25 13:20:39 +0100305}
306
Narayan Kamathbd863722017-06-01 18:50:12 +0100307static bool AddDumps(const std::vector<DumpData>::const_iterator start,
308 const std::vector<DumpData>::const_iterator end,
309 const char* type_name, const bool add_to_zip) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100310 bool dumped = false;
Narayan Kamathbd863722017-06-01 18:50:12 +0100311 for (auto it = start; it != end; ++it) {
312 const std::string& name = it->name;
313 const int fd = it->fd;
Narayan Kamath8f788292017-05-25 13:20:39 +0100314 dumped = true;
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100315
316 // Seek to the beginning of the file before dumping any data. A given
317 // DumpData entry might be dumped multiple times in the report.
318 //
319 // For example, the most recent ANR entry is dumped to the body of the
320 // main entry and it also shows up as a separate entry in the bugreport
321 // ZIP file.
322 if (lseek(fd, 0, SEEK_SET) != static_cast<off_t>(0)) {
323 MYLOGE("Unable to add %s to zip file, lseek failed: %s\n", name.c_str(),
324 strerror(errno));
325 }
326
Narayan Kamath8f788292017-05-25 13:20:39 +0100327 if (ds.IsZipping() && add_to_zip) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800328 if (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + name, fd, /* timeout = */ 0ms) != OK) {
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100329 MYLOGE("Unable to add %s to zip file, addZipEntryFromFd failed\n", name.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100330 }
331 } else {
332 dump_file_from_fd(type_name, name.c_str(), fd);
333 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100334 }
335
336 return dumped;
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700337}
338
Felipe Leme635ca312016-01-05 14:23:02 -0800339// for_each_pid() callback to get mount info about a process.
Felipe Leme4c2d6632016-09-28 14:32:00 -0700340void do_mountinfo(int pid, const char* name __attribute__((unused))) {
Felipe Leme635ca312016-01-05 14:23:02 -0800341 char path[PATH_MAX];
342
343 // Gets the the content of the /proc/PID/ns/mnt link, so only unique mount points
344 // are added.
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700345 snprintf(path, sizeof(path), "/proc/%d/ns/mnt", pid);
Felipe Leme635ca312016-01-05 14:23:02 -0800346 char linkname[PATH_MAX];
347 ssize_t r = readlink(path, linkname, PATH_MAX);
348 if (r == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800349 MYLOGE("Unable to read link for %s: %s\n", path, strerror(errno));
Felipe Leme635ca312016-01-05 14:23:02 -0800350 return;
351 }
352 linkname[r] = '\0';
353
354 if (mount_points.find(linkname) == mount_points.end()) {
355 // First time this mount point was found: add it
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700356 snprintf(path, sizeof(path), "/proc/%d/mountinfo", pid);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700357 if (ds.AddZipEntry(ZIP_ROOT_DIR + path, path)) {
Felipe Leme635ca312016-01-05 14:23:02 -0800358 mount_points.insert(linkname);
359 } else {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800360 MYLOGE("Unable to add mountinfo %s to zip file\n", path);
Felipe Leme635ca312016-01-05 14:23:02 -0800361 }
362 }
363}
364
365void add_mountinfo() {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700366 if (!ds.IsZipping()) return;
Felipe Leme678727a2016-09-21 17:22:11 -0700367 std::string title = "MOUNT INFO";
Felipe Leme635ca312016-01-05 14:23:02 -0800368 mount_points.clear();
Felipe Leme46b85da2016-11-21 17:40:45 -0800369 DurationReporter duration_reporter(title, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700370 for_each_pid(do_mountinfo, nullptr);
371 MYLOGD("%s: %d entries added to zip file\n", title.c_str(), (int)mount_points.size());
Felipe Leme635ca312016-01-05 14:23:02 -0800372}
373
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700374static void dump_dev_files(const char *title, const char *driverpath, const char *filename)
375{
376 DIR *d;
377 struct dirent *de;
378 char path[PATH_MAX];
379
380 d = opendir(driverpath);
Yi Kong19d5c002018-07-20 13:39:55 -0700381 if (d == nullptr) {
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700382 return;
383 }
384
385 while ((de = readdir(d))) {
386 if (de->d_type != DT_LNK) {
387 continue;
388 }
389 snprintf(path, sizeof(path), "%s/%s/%s", driverpath, de->d_name, filename);
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700390 DumpFile(title, path);
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700391 }
392
393 closedir(d);
394}
395
Mark Salyzyn326842f2015-04-30 09:49:41 -0700396static bool skip_not_stat(const char *path) {
397 static const char stat[] = "/stat";
398 size_t len = strlen(path);
399 if (path[len - 1] == '/') { /* Directory? */
400 return false;
401 }
402 return strcmp(path + len - sizeof(stat) + 1, stat); /* .../stat? */
403}
404
Felipe Leme4c2d6632016-09-28 14:32:00 -0700405static bool skip_none(const char* path __attribute__((unused))) {
Felipe Lemee82a27d2016-01-05 13:35:44 -0800406 return false;
407}
408
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700409unsigned long worst_write_perf = 20000; /* in KB/s */
Mark Salyzyn326842f2015-04-30 09:49:41 -0700410
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800411//
412// stat offsets
413// Name units description
414// ---- ----- -----------
415// read I/Os requests number of read I/Os processed
416#define __STAT_READ_IOS 0
417// read merges requests number of read I/Os merged with in-queue I/O
418#define __STAT_READ_MERGES 1
419// read sectors sectors number of sectors read
420#define __STAT_READ_SECTORS 2
421// read ticks milliseconds total wait time for read requests
422#define __STAT_READ_TICKS 3
423// write I/Os requests number of write I/Os processed
424#define __STAT_WRITE_IOS 4
425// write merges requests number of write I/Os merged with in-queue I/O
426#define __STAT_WRITE_MERGES 5
427// write sectors sectors number of sectors written
428#define __STAT_WRITE_SECTORS 6
429// write ticks milliseconds total wait time for write requests
430#define __STAT_WRITE_TICKS 7
431// in_flight requests number of I/Os currently in flight
432#define __STAT_IN_FLIGHT 8
433// io_ticks milliseconds total time this block device has been active
434#define __STAT_IO_TICKS 9
435// time_in_queue milliseconds total wait time for all requests
436#define __STAT_IN_QUEUE 10
437#define __STAT_NUMBER_FIELD 11
438//
439// read I/Os, write I/Os
440// =====================
441//
442// These values increment when an I/O request completes.
443//
444// read merges, write merges
445// =========================
446//
447// These values increment when an I/O request is merged with an
448// already-queued I/O request.
449//
450// read sectors, write sectors
451// ===========================
452//
453// These values count the number of sectors read from or written to this
454// block device. The "sectors" in question are the standard UNIX 512-byte
455// sectors, not any device- or filesystem-specific block size. The
456// counters are incremented when the I/O completes.
457#define SECTOR_SIZE 512
458//
459// read ticks, write ticks
460// =======================
461//
462// These values count the number of milliseconds that I/O requests have
463// waited on this block device. If there are multiple I/O requests waiting,
464// these values will increase at a rate greater than 1000/second; for
465// example, if 60 read requests wait for an average of 30 ms, the read_ticks
466// field will increase by 60*30 = 1800.
467//
468// in_flight
469// =========
470//
471// This value counts the number of I/O requests that have been issued to
472// the device driver but have not yet completed. It does not include I/O
473// requests that are in the queue but not yet issued to the device driver.
474//
475// io_ticks
476// ========
477//
478// This value counts the number of milliseconds during which the device has
479// had I/O requests queued.
480//
481// time_in_queue
482// =============
483//
484// This value counts the number of milliseconds that I/O requests have waited
485// on this block device. If there are multiple I/O requests waiting, this
486// value will increase as the product of the number of milliseconds times the
487// number of requests waiting (see "read ticks" above for an example).
488#define S_TO_MS 1000
489//
490
Mark Salyzyn326842f2015-04-30 09:49:41 -0700491static int dump_stat_from_fd(const char *title __unused, const char *path, int fd) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800492 unsigned long long fields[__STAT_NUMBER_FIELD];
Mark Salyzyn326842f2015-04-30 09:49:41 -0700493 bool z;
Yi Kong19d5c002018-07-20 13:39:55 -0700494 char *cp, *buffer = nullptr;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700495 size_t i = 0;
Josh Gao7c4258c2018-06-25 13:40:08 -0700496 FILE *fp = fdopen(dup(fd), "rb");
Mark Salyzyn326842f2015-04-30 09:49:41 -0700497 getline(&buffer, &i, fp);
498 fclose(fp);
499 if (!buffer) {
500 return -errno;
501 }
502 i = strlen(buffer);
503 while ((i > 0) && (buffer[i - 1] == '\n')) {
504 buffer[--i] = '\0';
505 }
506 if (!*buffer) {
507 free(buffer);
508 return 0;
509 }
510 z = true;
511 for (cp = buffer, i = 0; i < (sizeof(fields) / sizeof(fields[0])); ++i) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800512 fields[i] = strtoull(cp, &cp, 10);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700513 if (fields[i] != 0) {
514 z = false;
515 }
516 }
517 if (z) { /* never accessed */
518 free(buffer);
519 return 0;
520 }
521
Wei Wang509bb5d2017-06-09 14:42:12 -0700522 if (!strncmp(path, BLK_DEV_SYS_DIR, sizeof(BLK_DEV_SYS_DIR) - 1)) {
523 path += sizeof(BLK_DEV_SYS_DIR) - 1;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700524 }
Wei Wang1dc1ef52017-06-12 11:28:37 -0700525
526 printf("%-30s:%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s\n%-30s:\t%s\n", "Block-Dev",
527 "R-IOs", "R-merg", "R-sect", "R-wait", "W-IOs", "W-merg", "W-sect",
528 "W-wait", "in-fli", "activ", "T-wait", path, buffer);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700529 free(buffer);
530
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800531 if (fields[__STAT_IO_TICKS]) {
532 unsigned long read_perf = 0;
533 unsigned long read_ios = 0;
534 if (fields[__STAT_READ_TICKS]) {
535 unsigned long long divisor = fields[__STAT_READ_TICKS]
536 * fields[__STAT_IO_TICKS];
537 read_perf = ((unsigned long long)SECTOR_SIZE
538 * fields[__STAT_READ_SECTORS]
539 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
540 / divisor;
541 read_ios = ((unsigned long long)S_TO_MS * fields[__STAT_READ_IOS]
542 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
543 / divisor;
544 }
545
546 unsigned long write_perf = 0;
547 unsigned long write_ios = 0;
548 if (fields[__STAT_WRITE_TICKS]) {
549 unsigned long long divisor = fields[__STAT_WRITE_TICKS]
550 * fields[__STAT_IO_TICKS];
551 write_perf = ((unsigned long long)SECTOR_SIZE
552 * fields[__STAT_WRITE_SECTORS]
553 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
554 / divisor;
555 write_ios = ((unsigned long long)S_TO_MS * fields[__STAT_WRITE_IOS]
556 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
557 / divisor;
558 }
559
560 unsigned queue = (fields[__STAT_IN_QUEUE]
561 + (fields[__STAT_IO_TICKS] >> 1))
562 / fields[__STAT_IO_TICKS];
563
564 if (!write_perf && !write_ios) {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700565 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 -0800566 } else {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700567 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 -0800568 read_ios, write_perf, write_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800569 }
570
571 /* bugreport timeout factor adjustment */
572 if ((write_perf > 1) && (write_perf < worst_write_perf)) {
573 worst_write_perf = write_perf;
574 }
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700575 }
Mark Salyzyn326842f2015-04-30 09:49:41 -0700576 return 0;
577}
578
Yao Chenbe3bbc12018-01-17 16:31:10 -0800579static const long MINIMUM_LOGCAT_TIMEOUT_MS = 50000;
580
581/* timeout in ms to read a list of buffers */
582static unsigned long logcat_timeout(const std::vector<std::string>& buffers) {
583 unsigned long timeout_ms = 0;
584 for (const auto& buffer : buffers) {
585 log_id_t id = android_name_to_log_id(buffer.c_str());
586 unsigned long property_size = __android_logger_get_buffer_size(id);
587 /* Engineering margin is ten-fold our guess */
588 timeout_ms += 10 * (property_size + worst_write_perf) / worst_write_perf;
589 }
590 return timeout_ms > MINIMUM_LOGCAT_TIMEOUT_MS ? timeout_ms : MINIMUM_LOGCAT_TIMEOUT_MS;
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700591}
592
Nandana Duttd2f5f082019-01-18 17:13:52 +0000593Dumpstate::ConsentCallback::ConsentCallback() : result_(UNAVAILABLE), start_time_(Nanotime()) {
594}
595
596android::binder::Status Dumpstate::ConsentCallback::onReportApproved() {
597 std::lock_guard<std::mutex> lock(lock_);
598 result_ = APPROVED;
599 MYLOGD("User approved consent to share bugreport\n");
600 return android::binder::Status::ok();
601}
602
603android::binder::Status Dumpstate::ConsentCallback::onReportDenied() {
604 std::lock_guard<std::mutex> lock(lock_);
605 result_ = DENIED;
606 MYLOGW("User denied consent to share bugreport\n");
607 return android::binder::Status::ok();
608}
609
610UserConsentResult Dumpstate::ConsentCallback::getResult() {
611 std::lock_guard<std::mutex> lock(lock_);
612 return result_;
613}
614
615uint64_t Dumpstate::ConsentCallback::getElapsedTimeMs() const {
616 return Nanotime() - start_time_;
617}
618
Felipe Leme2b9b06c2016-10-14 09:13:06 -0700619void Dumpstate::PrintHeader() const {
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700620 std::string build, fingerprint, radio, bootloader, network;
621 char date[80];
Colin Crossf45fa6b2012-03-26 12:38:26 -0700622
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700623 build = android::base::GetProperty("ro.build.display.id", "(unknown)");
624 fingerprint = android::base::GetProperty("ro.build.fingerprint", "(unknown)");
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700625 radio = android::base::GetProperty("gsm.version.baseband", "(unknown)");
626 bootloader = android::base::GetProperty("ro.bootloader", "(unknown)");
627 network = android::base::GetProperty("gsm.operator.alpha", "(unknown)");
Felipe Lemebbaf3c12016-10-11 14:32:25 -0700628 strftime(date, sizeof(date), "%Y-%m-%d %H:%M:%S", localtime(&now_));
Colin Crossf45fa6b2012-03-26 12:38:26 -0700629
Felipe Lemed8b94e52016-12-08 10:21:44 -0800630 printf("========================================================\n");
631 printf("== dumpstate: %s\n", date);
632 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -0700633
Felipe Lemed8b94e52016-12-08 10:21:44 -0800634 printf("\n");
635 printf("Build: %s\n", build.c_str());
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700636 // NOTE: fingerprint entry format is important for other tools.
Felipe Lemed8b94e52016-12-08 10:21:44 -0800637 printf("Build fingerprint: '%s'\n", fingerprint.c_str());
638 printf("Bootloader: %s\n", bootloader.c_str());
639 printf("Radio: %s\n", radio.c_str());
640 printf("Network: %s\n", network.c_str());
Colin Crossf45fa6b2012-03-26 12:38:26 -0700641
Felipe Lemed8b94e52016-12-08 10:21:44 -0800642 printf("Kernel: ");
Felipe Lemef0292972016-11-22 13:57:05 -0800643 DumpFileToFd(STDOUT_FILENO, "", "/proc/version");
Felipe Lemed8b94e52016-12-08 10:21:44 -0800644 printf("Command line: %s\n", strtok(cmdline_buf, "\n"));
Felipe Leme7709f8a2017-12-05 09:30:09 -0800645 printf("Uptime: ");
646 RunCommandToFd(STDOUT_FILENO, "", {"uptime", "-p"},
647 CommandOptions::WithTimeout(1).Always().Build());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800648 printf("Bugreport format version: %s\n", version_.c_str());
649 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 +0100650 PropertiesHelper::IsDryRun(), options_->args.c_str(), options_->extra_options.c_str());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800651 printf("\n");
Felipe Leme78f2c862015-12-21 09:55:22 -0800652}
653
Felipe Leme24b66ee2016-06-16 10:55:26 -0700654// List of file extensions that can cause a zip file attachment to be rejected by some email
655// service providers.
656static const std::set<std::string> PROBLEMATIC_FILE_EXTENSIONS = {
657 ".ade", ".adp", ".bat", ".chm", ".cmd", ".com", ".cpl", ".exe", ".hta", ".ins", ".isp",
658 ".jar", ".jse", ".lib", ".lnk", ".mde", ".msc", ".msp", ".mst", ".pif", ".scr", ".sct",
659 ".shb", ".sys", ".vb", ".vbe", ".vbs", ".vxd", ".wsc", ".wsf", ".wsh"
660};
661
Vishnu Naire97d6122018-01-18 13:58:56 -0800662status_t Dumpstate::AddZipEntryFromFd(const std::string& entry_name, int fd,
663 std::chrono::milliseconds timeout = 0ms) {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700664 if (!IsZipping()) {
665 MYLOGD("Not adding zip entry %s from fd because it's not a zipped bugreport\n",
666 entry_name.c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -0800667 return INVALID_OPERATION;
Felipe Leme111b9d02016-02-03 09:28:24 -0800668 }
Felipe Leme24b66ee2016-06-16 10:55:26 -0700669 std::string valid_name = entry_name;
670
671 // Rename extension if necessary.
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -0700672 size_t idx = entry_name.rfind('.');
Felipe Leme24b66ee2016-06-16 10:55:26 -0700673 if (idx != std::string::npos) {
674 std::string extension = entry_name.substr(idx);
675 std::transform(extension.begin(), extension.end(), extension.begin(), ::tolower);
676 if (PROBLEMATIC_FILE_EXTENSIONS.count(extension) != 0) {
677 valid_name = entry_name + ".renamed";
678 MYLOGI("Renaming entry %s to %s\n", entry_name.c_str(), valid_name.c_str());
679 }
680 }
681
Felipe Leme6fe9db62016-02-12 09:04:16 -0800682 // Logging statement below is useful to time how long each entry takes, but it's too verbose.
683 // MYLOGD("Adding zip entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700684 int32_t err = zip_writer_->StartEntryWithTime(valid_name.c_str(), ZipWriter::kCompress,
685 get_mtime(fd, ds.now_));
Felipe Leme1d486fe2016-10-14 18:06:47 -0700686 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700687 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", valid_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700688 ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800689 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800690 }
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000691 bool finished_entry = false;
692 auto finish_entry = [this, &finished_entry] {
693 if (!finished_entry) {
694 // This should only be called when we're going to return an earlier error,
695 // which would've been logged. This may imply the file is already corrupt
696 // and any further logging from FinishEntry is more likely to mislead than
697 // not.
698 this->zip_writer_->FinishEntry();
699 }
700 };
701 auto scope_guard = android::base::make_scope_guard(finish_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -0800702 auto start = std::chrono::steady_clock::now();
703 auto end = start + timeout;
704 struct pollfd pfd = {fd, POLLIN};
Felipe Lemee82a27d2016-01-05 13:35:44 -0800705
Felipe Leme770410d2016-01-26 17:07:14 -0800706 std::vector<uint8_t> buffer(65536);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800707 while (1) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800708 if (timeout.count() > 0) {
709 // lambda to recalculate the timeout.
710 auto time_left_ms = [end]() {
711 auto now = std::chrono::steady_clock::now();
712 auto diff = std::chrono::duration_cast<std::chrono::milliseconds>(end - now);
713 return std::max(diff.count(), 0LL);
714 };
715
716 int rc = TEMP_FAILURE_RETRY(poll(&pfd, 1, time_left_ms()));
717 if (rc < 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000718 MYLOGE("Error in poll while adding from fd to zip entry %s:%s\n",
719 entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800720 return -errno;
721 } else if (rc == 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000722 MYLOGE("Timed out adding from fd to zip entry %s:%s Timeout:%lldms\n",
Vishnu Naire97d6122018-01-18 13:58:56 -0800723 entry_name.c_str(), strerror(errno), timeout.count());
724 return TIMED_OUT;
725 }
726 }
727
Zach Riggle22200402016-08-18 01:01:24 -0400728 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800729 if (bytes_read == 0) {
730 break;
731 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800732 MYLOGE("read(%s): %s\n", entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800733 return -errno;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800734 }
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700735 err = zip_writer_->WriteBytes(buffer.data(), bytes_read);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800736 if (err) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700737 MYLOGE("zip_writer_->WriteBytes(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800738 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800739 }
740 }
741
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700742 err = zip_writer_->FinishEntry();
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000743 finished_entry = true;
Felipe Leme1d486fe2016-10-14 18:06:47 -0700744 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700745 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800746 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800747 }
748
Vishnu Naire97d6122018-01-18 13:58:56 -0800749 return OK;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800750}
751
Felipe Leme1d486fe2016-10-14 18:06:47 -0700752bool Dumpstate::AddZipEntry(const std::string& entry_name, const std::string& entry_path) {
753 android::base::unique_fd fd(
754 TEMP_FAILURE_RETRY(open(entry_path.c_str(), O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
Andreas Gampeaff68432016-07-18 18:01:27 -0700755 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800756 MYLOGE("open(%s): %s\n", entry_path.c_str(), strerror(errno));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800757 return false;
758 }
759
Vishnu Naire97d6122018-01-18 13:58:56 -0800760 return (AddZipEntryFromFd(entry_name, fd.get()) == OK);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800761}
762
763/* adds a file to the existing zipped bugreport */
Felipe Leme4c2d6632016-09-28 14:32:00 -0700764static int _add_file_from_fd(const char* title __attribute__((unused)), const char* path, int fd) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800765 return (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + path, fd) == OK) ? 0 : 1;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800766}
767
Felipe Leme1d486fe2016-10-14 18:06:47 -0700768void Dumpstate::AddDir(const std::string& dir, bool recursive) {
769 if (!IsZipping()) {
770 MYLOGD("Not adding dir %s because it's not a zipped bugreport\n", dir.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800771 return;
772 }
Felipe Leme678727a2016-09-21 17:22:11 -0700773 MYLOGD("Adding dir %s (recursive: %d)\n", dir.c_str(), recursive);
Felipe Leme46b85da2016-11-21 17:40:45 -0800774 DurationReporter duration_reporter(dir, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700775 dump_files("", dir.c_str(), recursive ? skip_none : is_dir, _add_file_from_fd);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800776}
777
Felipe Leme1d486fe2016-10-14 18:06:47 -0700778bool Dumpstate::AddTextZipEntry(const std::string& entry_name, const std::string& content) {
779 if (!IsZipping()) {
780 MYLOGD("Not adding text zip entry %s because it's not a zipped bugreport\n",
781 entry_name.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800782 return false;
783 }
Felipe Lemecbce55d2016-02-08 09:53:18 -0800784 MYLOGD("Adding zip text entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700785 int32_t err = zip_writer_->StartEntryWithTime(entry_name.c_str(), ZipWriter::kCompress, ds.now_);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700786 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700787 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700788 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800789 return false;
790 }
791
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700792 err = zip_writer_->WriteBytes(content.c_str(), content.length());
Felipe Leme1d486fe2016-10-14 18:06:47 -0700793 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700794 MYLOGE("zip_writer_->WriteBytes(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700795 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800796 return false;
797 }
798
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700799 err = zip_writer_->FinishEntry();
Felipe Leme1d486fe2016-10-14 18:06:47 -0700800 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700801 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800802 return false;
803 }
804
805 return true;
806}
807
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800808static void DoKmsg() {
809 struct stat st;
810 if (!stat(PSTORE_LAST_KMSG, &st)) {
811 /* Also TODO: Make console-ramoops CAP_SYSLOG protected. */
812 DumpFile("LAST KMSG", PSTORE_LAST_KMSG);
813 } else if (!stat(ALT_PSTORE_LAST_KMSG, &st)) {
814 DumpFile("LAST KMSG", ALT_PSTORE_LAST_KMSG);
815 } else {
816 /* TODO: Make last_kmsg CAP_SYSLOG protected. b/5555691 */
817 DumpFile("LAST KMSG", "/proc/last_kmsg");
818 }
819}
820
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800821static void DoKernelLogcat() {
Yao Chenbe3bbc12018-01-17 16:31:10 -0800822 unsigned long timeout_ms = logcat_timeout({"kernel"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800823 RunCommand(
824 "KERNEL LOG",
825 {"logcat", "-b", "kernel", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
826 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
827}
828
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800829static void DoLogcat() {
Vishnu Nair6921f802017-11-22 09:17:23 -0800830 unsigned long timeout_ms;
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800831 // DumpFile("EVENT LOG TAGS", "/etc/event-log-tags");
832 // calculate timeout
Yao Chenbe3bbc12018-01-17 16:31:10 -0800833 timeout_ms = logcat_timeout({"main", "system", "crash"});
Tony Makae737652017-03-30 17:47:09 +0100834 RunCommand("SYSTEM LOG",
Vishnu Nair6921f802017-11-22 09:17:23 -0800835 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
836 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -0800837 timeout_ms = logcat_timeout({"events"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800838 RunCommand(
839 "EVENT LOG",
840 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
841 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -0800842 timeout_ms = logcat_timeout({"stats"});
843 RunCommand(
844 "STATS LOG",
845 {"logcat", "-b", "stats", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
846 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
847 timeout_ms = logcat_timeout({"radio"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800848 RunCommand(
849 "RADIO LOG",
850 {"logcat", "-b", "radio", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
851 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800852
853 RunCommand("LOG STATISTICS", {"logcat", "-b", "all", "-S"});
854
855 /* kernels must set CONFIG_PSTORE_PMSG, slice up pstore with device tree */
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800856 RunCommand("LAST LOGCAT", {"logcat", "-L", "-b", "all", "-v", "threadtime", "-v", "printable",
857 "-v", "uid", "-d", "*:v"});
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800858}
859
Jayachandran Ca94c7172017-06-10 15:08:12 -0700860static void DumpIpTablesAsRoot() {
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700861 RunCommand("IPTABLES", {"iptables", "-L", "-nvx"});
862 RunCommand("IP6TABLES", {"ip6tables", "-L", "-nvx"});
Erik Kline32af8c22016-09-28 17:26:26 +0900863 RunCommand("IPTABLES NAT", {"iptables", "-t", "nat", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -0700864 /* no ip6 nat */
Erik Kline32af8c22016-09-28 17:26:26 +0900865 RunCommand("IPTABLES MANGLE", {"iptables", "-t", "mangle", "-L", "-nvx"});
866 RunCommand("IP6TABLES MANGLE", {"ip6tables", "-t", "mangle", "-L", "-nvx"});
867 RunCommand("IPTABLES RAW", {"iptables", "-t", "raw", "-L", "-nvx"});
868 RunCommand("IP6TABLES RAW", {"ip6tables", "-t", "raw", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -0700869}
870
Narayan Kamath8f788292017-05-25 13:20:39 +0100871static void AddAnrTraceDir(const bool add_to_zip, const std::string& anr_traces_dir) {
872 MYLOGD("AddAnrTraceDir(): dump_traces_file=%s, anr_traces_dir=%s\n", dump_traces_path,
873 anr_traces_dir.c_str());
874
875 // If we're here, dump_traces_path will always be a temporary file
876 // (created with mkostemp or similar) that contains dumps taken earlier
877 // on in the process.
878 if (dump_traces_path != nullptr) {
879 if (add_to_zip) {
880 ds.AddZipEntry(ZIP_ROOT_DIR + anr_traces_dir + "/traces-just-now.txt", dump_traces_path);
881 } else {
882 MYLOGD("Dumping current ANR traces (%s) to the main bugreport entry\n",
883 dump_traces_path);
884 ds.DumpFile("VM TRACES JUST NOW", dump_traces_path);
885 }
886
887 const int ret = unlink(dump_traces_path);
888 if (ret == -1) {
889 MYLOGW("Error unlinking temporary trace path %s: %s\n", dump_traces_path,
890 strerror(errno));
Felipe Lemee184f662016-10-27 10:04:47 -0700891 }
892 }
893
Narayan Kamathbd863722017-06-01 18:50:12 +0100894 // Add a specific message for the first ANR Dump.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700895 if (ds.anr_data_.size() > 0) {
896 AddDumps(ds.anr_data_.begin(), ds.anr_data_.begin() + 1,
Narayan Kamathbd863722017-06-01 18:50:12 +0100897 "VM TRACES AT LAST ANR", add_to_zip);
898
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100899 // The "last" ANR will always be included as separate entry in the zip file. In addition,
900 // it will be present in the body of the main entry if |add_to_zip| == false.
901 //
902 // Historical ANRs are always included as separate entries in the bugreport zip file.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700903 AddDumps(ds.anr_data_.begin() + ((add_to_zip) ? 1 : 0), ds.anr_data_.end(),
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100904 "HISTORICAL ANR", true /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +0100905 } else {
Narayan Kamath8f788292017-05-25 13:20:39 +0100906 printf("*** NO ANRs to dump in %s\n\n", ANR_DIR.c_str());
907 }
908}
909
910static void AddAnrTraceFiles() {
911 const bool add_to_zip = ds.IsZipping() && ds.version_ == VERSION_SPLIT_ANR;
912
Elliott Hughes69fe5ec2018-03-23 11:04:25 -0700913 std::string anr_traces_dir = "/data/anr";
Narayan Kamath8f788292017-05-25 13:20:39 +0100914
Elliott Hughes69fe5ec2018-03-23 11:04:25 -0700915 AddAnrTraceDir(add_to_zip, anr_traces_dir);
Narayan Kamath8f788292017-05-25 13:20:39 +0100916
Makoto Onuki83ec63f2019-01-31 17:08:59 -0800917 RunCommand("ANR FILES", {"ls", "-lt", ANR_DIR});
918
Elliott Hughes69fe5ec2018-03-23 11:04:25 -0700919 // Slow traces for slow operations.
Felipe Lemee184f662016-10-27 10:04:47 -0700920 struct stat st;
Elliott Hughes69fe5ec2018-03-23 11:04:25 -0700921 int i = 0;
922 while (true) {
923 const std::string slow_trace_path =
924 anr_traces_dir + android::base::StringPrintf("slow%02d.txt", i);
925 if (stat(slow_trace_path.c_str(), &st)) {
926 // No traces file at this index, done with the files.
927 break;
Felipe Lemee184f662016-10-27 10:04:47 -0700928 }
Elliott Hughes69fe5ec2018-03-23 11:04:25 -0700929 ds.DumpFile("VM TRACES WHEN SLOW", slow_trace_path.c_str());
930 i++;
Felipe Lemee184f662016-10-27 10:04:47 -0700931 }
932}
933
Wei Wang509bb5d2017-06-09 14:42:12 -0700934static void DumpBlockStatFiles() {
935 DurationReporter duration_reporter("DUMP BLOCK STAT");
Wei Wang509bb5d2017-06-09 14:42:12 -0700936
Wei Wang1dc1ef52017-06-12 11:28:37 -0700937 std::unique_ptr<DIR, std::function<int(DIR*)>> dirptr(opendir(BLK_DEV_SYS_DIR), closedir);
938
939 if (dirptr == nullptr) {
Wei Wang509bb5d2017-06-09 14:42:12 -0700940 MYLOGE("Failed to open %s: %s\n", BLK_DEV_SYS_DIR, strerror(errno));
941 return;
942 }
943
944 printf("------ DUMP BLOCK STAT ------\n\n");
Wei Wang1dc1ef52017-06-12 11:28:37 -0700945 while (struct dirent *d = readdir(dirptr.get())) {
Wei Wang509bb5d2017-06-09 14:42:12 -0700946 if ((d->d_name[0] == '.')
947 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
948 || (d->d_name[1] == '\0'))) {
949 continue;
950 }
951 const std::string new_path =
952 android::base::StringPrintf("%s/%s", BLK_DEV_SYS_DIR, d->d_name);
953 printf("------ BLOCK STAT (%s) ------\n", new_path.c_str());
954 dump_files("", new_path.c_str(), skip_not_stat, dump_stat_from_fd);
955 printf("\n");
956 }
Wei Wang1dc1ef52017-06-12 11:28:37 -0700957 return;
Wei Wang509bb5d2017-06-09 14:42:12 -0700958}
Jayachandran Ca94c7172017-06-10 15:08:12 -0700959
960static void DumpPacketStats() {
961 DumpFile("NETWORK DEV INFO", "/proc/net/dev");
962 DumpFile("QTAGUID NETWORK INTERFACES INFO", "/proc/net/xt_qtaguid/iface_stat_all");
963 DumpFile("QTAGUID NETWORK INTERFACES INFO (xt)", "/proc/net/xt_qtaguid/iface_stat_fmt");
964 DumpFile("QTAGUID CTRL INFO", "/proc/net/xt_qtaguid/ctrl");
965 DumpFile("QTAGUID STATS INFO", "/proc/net/xt_qtaguid/stats");
966}
967
968static void DumpIpAddrAndRules() {
969 /* The following have a tendency to get wedged when wifi drivers/fw goes belly-up. */
970 RunCommand("NETWORK INTERFACES", {"ip", "link"});
971 RunCommand("IPv4 ADDRESSES", {"ip", "-4", "addr", "show"});
972 RunCommand("IPv6 ADDRESSES", {"ip", "-6", "addr", "show"});
973 RunCommand("IP RULES", {"ip", "rule", "show"});
974 RunCommand("IP RULES v6", {"ip", "-6", "rule", "show"});
975}
976
Nandana Duttbbdb5b42019-03-12 10:52:56 +0000977static Dumpstate::RunStatus RunDumpsysTextByPriority(const std::string& title, int priority,
978 std::chrono::milliseconds timeout,
979 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -0800980 auto start = std::chrono::steady_clock::now();
Vishnu Naire97d6122018-01-18 13:58:56 -0800981 sp<android::IServiceManager> sm = defaultServiceManager();
982 Dumpsys dumpsys(sm.get());
Vishnu Naire97d6122018-01-18 13:58:56 -0800983 Vector<String16> args;
984 Dumpsys::setServiceArgs(args, /* asProto = */ false, priority);
Vishnu Naire97d6122018-01-18 13:58:56 -0800985 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ false);
986 for (const String16& service : services) {
Nandana Duttbbdb5b42019-03-12 10:52:56 +0000987 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -0800988 std::string path(title);
989 path.append(" - ").append(String8(service).c_str());
990 DumpstateSectionReporter section_reporter(path, ds.listener_, ds.report_section_);
991 size_t bytes_written = 0;
992 status_t status = dumpsys.startDumpThread(service, args);
993 if (status == OK) {
994 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
995 std::chrono::duration<double> elapsed_seconds;
996 status = dumpsys.writeDump(STDOUT_FILENO, service, service_timeout,
997 /* as_proto = */ false, elapsed_seconds, bytes_written);
998 section_reporter.setSize(bytes_written);
999 dumpsys.writeDumpFooter(STDOUT_FILENO, service, elapsed_seconds);
1000 bool dump_complete = (status == OK);
1001 dumpsys.stopDumpThread(dump_complete);
1002 }
1003 section_reporter.setStatus(status);
1004
1005 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1006 std::chrono::steady_clock::now() - start);
1007 if (elapsed_duration > timeout) {
1008 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1009 elapsed_duration.count());
1010 break;
1011 }
1012 }
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001013 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001014}
1015
Vishnu Nair64afc022018-02-01 15:29:34 -08001016static void RunDumpsysText(const std::string& title, int priority,
1017 std::chrono::milliseconds timeout,
1018 std::chrono::milliseconds service_timeout) {
1019 DurationReporter duration_reporter(title);
1020 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1021 fsync(STDOUT_FILENO);
1022 RunDumpsysTextByPriority(title, priority, timeout, service_timeout);
1023}
1024
1025/* Dump all services registered with Normal or Default priority. */
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001026static Dumpstate::RunStatus RunDumpsysTextNormalPriority(const std::string& title,
1027 std::chrono::milliseconds timeout,
1028 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001029 DurationReporter duration_reporter(title);
1030 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1031 fsync(STDOUT_FILENO);
1032 RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_NORMAL, timeout,
1033 service_timeout);
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001034
1035 RETURN_IF_USER_DENIED_CONSENT();
1036
1037 return RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_DEFAULT, timeout,
1038 service_timeout);
Vishnu Nair64afc022018-02-01 15:29:34 -08001039}
1040
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001041static Dumpstate::RunStatus RunDumpsysProto(const std::string& title, int priority,
1042 std::chrono::milliseconds timeout,
1043 std::chrono::milliseconds service_timeout) {
Luis Hector Chavez1e27b082018-03-22 15:36:42 -07001044 if (!ds.IsZipping()) {
1045 MYLOGD("Not dumping %s because it's not a zipped bugreport\n", title.c_str());
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001046 return Dumpstate::RunStatus::OK;
Luis Hector Chavez1e27b082018-03-22 15:36:42 -07001047 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001048 sp<android::IServiceManager> sm = defaultServiceManager();
1049 Dumpsys dumpsys(sm.get());
1050 Vector<String16> args;
1051 Dumpsys::setServiceArgs(args, /* asProto = */ true, priority);
1052 DurationReporter duration_reporter(title);
1053
1054 auto start = std::chrono::steady_clock::now();
1055 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ true);
1056 for (const String16& service : services) {
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001057 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001058 std::string path(kProtoPath);
1059 path.append(String8(service).c_str());
1060 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL) {
1061 path.append("_CRITICAL");
1062 } else if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH) {
1063 path.append("_HIGH");
1064 }
1065 path.append(kProtoExt);
1066 DumpstateSectionReporter section_reporter(path, ds.listener_, ds.report_section_);
1067 status_t status = dumpsys.startDumpThread(service, args);
1068 if (status == OK) {
1069 status = ds.AddZipEntryFromFd(path, dumpsys.getDumpFd(), service_timeout);
1070 bool dumpTerminated = (status == OK);
1071 dumpsys.stopDumpThread(dumpTerminated);
1072 }
1073 ZipWriter::FileEntry file_entry;
1074 ds.zip_writer_->GetLastEntry(&file_entry);
1075 section_reporter.setSize(file_entry.compressed_size);
1076 section_reporter.setStatus(status);
1077
1078 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1079 std::chrono::steady_clock::now() - start);
1080 if (elapsed_duration > timeout) {
1081 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1082 elapsed_duration.count());
1083 break;
1084 }
1085 }
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001086 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001087}
1088
Nandana Dutta7db6342018-11-21 14:53:34 +00001089// Runs dumpsys on services that must dump first and will take less than 100ms to dump.
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001090static Dumpstate::RunStatus RunDumpsysCritical() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001091 RunDumpsysText("DUMPSYS CRITICAL", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1092 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001093
1094 RETURN_IF_USER_DENIED_CONSENT();
1095
1096 return RunDumpsysProto("DUMPSYS CRITICAL PROTO", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1097 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Vishnu Nair780b1282017-10-10 13:57:24 -07001098}
1099
1100// Runs dumpsys on services that must dump first but can take up to 250ms to dump.
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001101static Dumpstate::RunStatus RunDumpsysHigh() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001102 // TODO meminfo takes ~10s, connectivity takes ~5sec to dump. They are both
1103 // high priority. Reduce timeout once they are able to dump in a shorter time or
1104 // moved to a parallel task.
1105 RunDumpsysText("DUMPSYS HIGH", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1106 /* timeout= */ 90s, /* service_timeout= */ 30s);
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001107
1108 RETURN_IF_USER_DENIED_CONSENT();
1109
1110 return RunDumpsysProto("DUMPSYS HIGH PROTO", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1111 /* timeout= */ 5s, /* service_timeout= */ 1s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001112}
1113
1114// Runs dumpsys on services that must dump but can take up to 10s to dump.
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001115static Dumpstate::RunStatus RunDumpsysNormal() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001116 RunDumpsysTextNormalPriority("DUMPSYS", /* timeout= */ 90s, /* service_timeout= */ 10s);
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001117
1118 RETURN_IF_USER_DENIED_CONSENT();
1119
1120 return RunDumpsysProto("DUMPSYS PROTO", IServiceManager::DUMP_FLAG_PRIORITY_NORMAL,
1121 /* timeout= */ 90s, /* service_timeout= */ 10s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001122}
1123
Steven Moreland44cd9482018-01-04 16:24:13 -08001124static void DumpHals() {
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001125 if (!ds.IsZipping()) {
1126 RunCommand("HARDWARE HALS", {"lshal", "-lVSietrpc", "--types=b,c,l,z", "--debug"},
1127 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build());
1128 return;
1129 }
1130 DurationReporter duration_reporter("DUMP HALS");
1131 RunCommand("HARDWARE HALS", {"lshal", "-lVSietrpc", "--types=b,c,l,z"},
Greg Kaiser3dfeda32019-05-16 10:32:51 -07001132 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build());
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001133
Steven Moreland44cd9482018-01-04 16:24:13 -08001134 using android::hidl::manager::V1_0::IServiceManager;
1135 using android::hardware::defaultServiceManager;
1136
1137 sp<IServiceManager> sm = defaultServiceManager();
1138 if (sm == nullptr) {
1139 MYLOGE("Could not retrieve hwservicemanager to dump hals.\n");
1140 return;
1141 }
1142
1143 auto ret = sm->list([&](const auto& interfaces) {
1144 for (const std::string& interface : interfaces) {
1145 std::string cleanName = interface;
1146 std::replace_if(cleanName.begin(),
1147 cleanName.end(),
1148 [](char c) {
1149 return !isalnum(c) &&
1150 std::string("@-_:.").find(c) == std::string::npos;
1151 }, '_');
Nandana Dutt979388e2018-11-30 16:48:55 +00001152 const std::string path = ds.bugreport_internal_dir_ + "/lshal_debug_" + cleanName;
Steven Moreland44cd9482018-01-04 16:24:13 -08001153
1154 {
1155 auto fd = android::base::unique_fd(
1156 TEMP_FAILURE_RETRY(open(path.c_str(),
1157 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1158 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1159 if (fd < 0) {
1160 MYLOGE("Could not open %s to dump additional hal information.\n", path.c_str());
1161 continue;
1162 }
1163 RunCommandToFd(fd,
1164 "",
Steven Morelandc81cd3c2018-01-18 14:36:26 -08001165 {"lshal", "debug", "-E", interface},
Steven Moreland44cd9482018-01-04 16:24:13 -08001166 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
1167
1168 bool empty = 0 == lseek(fd, 0, SEEK_END);
1169 if (!empty) {
1170 ds.AddZipEntry("lshal-debug/" + cleanName + ".txt", path);
1171 }
1172 }
1173
1174 unlink(path.c_str());
1175 }
1176 });
1177
1178 if (!ret.isOk()) {
1179 MYLOGE("Could not list hals from hwservicemanager.\n");
1180 }
1181}
1182
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001183// Dumps various things. Returns early with status USER_CONSENT_DENIED if user denies consent
1184// via the consent they are shown. Ignores other errors that occur while running various
1185// commands. The consent checking is currently done around long running tasks, which happen to
1186// be distributed fairly evenly throughout the function.
1187static Dumpstate::RunStatus dumpstate() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001188 DurationReporter duration_reporter("DUMPSTATE");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001189
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001190 // Dump various things. Note that anything that takes "long" (i.e. several seconds) should
1191 // check intermittently (if it's intrerruptable like a foreach on pids) and/or should be wrapped
1192 // in a consent check (via RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK).
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -07001193 dump_dev_files("TRUSTY VERSION", "/sys/bus/platform/drivers/trusty", "trusty_version");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001194 RunCommand("UPTIME", {"uptime"});
Wei Wang509bb5d2017-06-09 14:42:12 -07001195 DumpBlockStatFiles();
Mark Salyzyn8c8130e2015-12-09 11:21:28 -08001196 dump_emmc_ecsd("/d/mmc0/mmc0:0001/ext_csd");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001197 DumpFile("MEMORY INFO", "/proc/meminfo");
1198 RunCommand("CPU INFO", {"top", "-b", "-n", "1", "-H", "-s", "6", "-o",
Felipe Leme30dbfa12016-09-02 12:43:26 -07001199 "pid,tid,user,pr,ni,%cpu,s,virt,res,pcy,cmd,name"});
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001200
1201 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "PROCRANK", {"procrank"}, AS_ROOT_20);
1202
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001203 DumpFile("VIRTUAL MEMORY STATS", "/proc/vmstat");
1204 DumpFile("VMALLOC INFO", "/proc/vmallocinfo");
1205 DumpFile("SLAB INFO", "/proc/slabinfo");
1206 DumpFile("ZONEINFO", "/proc/zoneinfo");
1207 DumpFile("PAGETYPEINFO", "/proc/pagetypeinfo");
1208 DumpFile("BUDDYINFO", "/proc/buddyinfo");
1209 DumpFile("FRAGMENTATION INFO", "/d/extfrag/unusable_index");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001210
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001211 DumpFile("KERNEL WAKE SOURCES", "/d/wakeup_sources");
1212 DumpFile("KERNEL CPUFREQ", "/sys/devices/system/cpu/cpu0/cpufreq/stats/time_in_state");
1213 DumpFile("KERNEL SYNC", "/d/sync");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001214
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001215 RunCommand("PROCESSES AND THREADS",
Yohei Yukawa591a72d2017-10-05 21:36:35 -07001216 {"ps", "-A", "-T", "-Z", "-O", "pri,nice,rtprio,sched,pcy,time"});
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001217
1218 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "LIBRANK", {"librank"},
1219 CommandOptions::AS_ROOT);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001220
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001221 DumpHals();
Steven Moreland81b429e2017-01-31 19:50:46 -08001222
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001223 RunCommand("PRINTENV", {"printenv"});
Elliott Hughes21b7c8d2016-10-28 08:53:02 -07001224 RunCommand("NETSTAT", {"netstat", "-nW"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001225 struct stat s;
1226 if (stat("/proc/modules", &s) != 0) {
1227 MYLOGD("Skipping 'lsmod' because /proc/modules does not exist\n");
1228 } else {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001229 RunCommand("LSMOD", {"lsmod"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001230 }
Michal Karpinski4db754f2015-12-11 18:04:32 +00001231
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001232 if (__android_logger_property_get_bool(
1233 "ro.logd.kernel", BOOL_DEFAULT_TRUE | BOOL_DEFAULT_FLAG_ENG | BOOL_DEFAULT_FLAG_SVELTE)) {
1234 DoKernelLogcat();
1235 } else {
1236 do_dmesg();
1237 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001238
Felipe Lemef0292972016-11-22 13:57:05 -08001239 RunCommand("LIST OF OPEN FILES", {"lsof"}, CommandOptions::AS_ROOT);
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001240
1241 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(for_each_pid, do_showmap, "SMAPS OF ALL PROCESSES");
1242
Jeff Brown1dc94e32014-09-11 14:15:27 -07001243 for_each_tid(show_wchan, "BLOCKED PROCESS WAIT-CHANNELS");
Mark Salyzyna297c322016-02-05 15:33:17 -08001244 for_each_pid(show_showtime, "PROCESS TIMES (pid cmd user system iowait+percentage)");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001245
Ajay Panicker2ff8e872017-04-27 14:04:32 -07001246 /* Dump Bluetooth HCI logs */
1247 ds.AddDir("/data/misc/bluetooth/logs", true);
Ajay Panickerd886ec42016-09-14 12:26:46 -07001248
Greg Kaiser3ddc3fa2019-05-23 16:14:52 -07001249 if (ds.options_->do_fb && !ds.do_early_screenshot_) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001250 MYLOGI("taking late screenshot\n");
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001251 ds.TakeScreenshot();
Jeff Sharkey5a930032013-03-19 15:05:19 -07001252 }
1253
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001254 DoLogcat();
Mark Salyzynecc07632015-07-30 14:57:09 -07001255
Felipe Lemee184f662016-10-27 10:04:47 -07001256 AddAnrTraceFiles();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001257
Narayan Kamath8f788292017-05-25 13:20:39 +01001258 // NOTE: tombstones are always added as separate entries in the zip archive
1259 // and are not interspersed with the main report.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001260 const bool tombstones_dumped = AddDumps(ds.tombstone_data_.begin(), ds.tombstone_data_.end(),
Narayan Kamathbd863722017-06-01 18:50:12 +01001261 "TOMBSTONE", true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001262 if (!tombstones_dumped) {
1263 printf("*** NO TOMBSTONES to dump in %s\n\n", TOMBSTONE_DIR.c_str());
Christopher Ferris7dc7f322014-07-22 16:08:19 -07001264 }
1265
Jayachandran Ca94c7172017-06-10 15:08:12 -07001266 DumpPacketStats();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001267
Chenbo Feng276a3b62018-08-07 11:44:49 -07001268 RunDumpsys("EBPF MAP STATS", {"netd", "trafficcontroller"});
1269
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001270 DoKmsg();
Mark Salyzyn2262c162014-12-16 09:09:26 -08001271
Jayachandran Ca94c7172017-06-10 15:08:12 -07001272 DumpIpAddrAndRules();
Sreeram Ramachandran2b3bba32014-07-08 15:40:55 -07001273
1274 dump_route_tables();
1275
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001276 RunCommand("ARP CACHE", {"ip", "-4", "neigh", "show"});
1277 RunCommand("IPv6 ND CACHE", {"ip", "-6", "neigh", "show"});
1278 RunCommand("MULTICAST ADDRESSES", {"ip", "maddr"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001279
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001280 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysHigh);
Lorenzo Colitti6afc38c2015-09-09 22:59:25 +09001281
Elliott Hughes23ccc622017-02-28 10:14:22 -08001282 RunCommand("SYSTEM PROPERTIES", {"getprop"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001283
Jin Qianf334d662017-10-10 14:41:37 -07001284 RunCommand("STORAGED IO INFO", {"storaged", "-u", "-p"});
ynwangf649a6e2016-07-17 21:56:00 -07001285
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001286 RunCommand("FILESYSTEMS & FREE SPACE", {"df"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001287
Colin Crossf45fa6b2012-03-26 12:38:26 -07001288 /* Binder state is expensive to look at as it uses a lot of memory. */
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001289 DumpFile("BINDER FAILED TRANSACTION LOG", "/sys/kernel/debug/binder/failed_transaction_log");
1290 DumpFile("BINDER TRANSACTION LOG", "/sys/kernel/debug/binder/transaction_log");
1291 DumpFile("BINDER TRANSACTIONS", "/sys/kernel/debug/binder/transactions");
1292 DumpFile("BINDER STATS", "/sys/kernel/debug/binder/stats");
1293 DumpFile("BINDER STATE", "/sys/kernel/debug/binder/state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001294
Vishnu Nair36b4cdb2017-11-17 10:27:05 -08001295 /* Add window and surface trace files. */
1296 if (!PropertiesHelper::IsUserBuild()) {
1297 ds.AddDir(WMTRACE_DATA_DIR, false);
1298 }
1299
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001300 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(ds.DumpstateBoard);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001301
Steven Moreland7440ddb2016-12-15 16:13:39 -08001302 /* Migrate the ril_dumpstate to a device specific dumpstate? */
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001303 int rilDumpstateTimeout = android::base::GetIntProperty("ril.dumpstate.timeout", 0);
1304 if (rilDumpstateTimeout > 0) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001305 // su does not exist on user builds, so try running without it.
1306 // This way any implementations of vril-dump that do not require
1307 // root can run on user builds.
1308 CommandOptions::CommandOptionsBuilder options =
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001309 CommandOptions::WithTimeout(rilDumpstateTimeout);
Felipe Lemef0292972016-11-22 13:57:05 -08001310 if (!PropertiesHelper::IsUserBuild()) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001311 options.AsRoot();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001312 }
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001313 RunCommand("DUMP VENDOR RIL LOGS", {"vril-dump"}, options.Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -07001314 }
1315
Felipe Lemed8b94e52016-12-08 10:21:44 -08001316 printf("========================================================\n");
1317 printf("== Android Framework Services\n");
1318 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001319
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001320 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysNormal);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001321
Felipe Lemed8b94e52016-12-08 10:21:44 -08001322 printf("========================================================\n");
1323 printf("== Checkins\n");
1324 printf("========================================================\n");
Dianne Hackborn02bea972013-06-26 18:59:09 -07001325
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001326 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001327
1328 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsys, "CHECKIN MEMINFO", {"meminfo", "--checkin"});
1329
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001330 RunDumpsys("CHECKIN NETSTATS", {"netstats", "--checkin"});
1331 RunDumpsys("CHECKIN PROCSTATS", {"procstats", "-c"});
1332 RunDumpsys("CHECKIN USAGESTATS", {"usagestats", "-c"});
1333 RunDumpsys("CHECKIN PACKAGE", {"package", "--checkin"});
Dianne Hackborn02bea972013-06-26 18:59:09 -07001334
Felipe Lemed8b94e52016-12-08 10:21:44 -08001335 printf("========================================================\n");
1336 printf("== Running Application Activities\n");
1337 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001338
Makoto Onuki60780982018-04-16 15:34:00 -07001339 // The following dumpsys internally collects output from running apps, so it can take a long
1340 // time. So let's extend the timeout.
1341
1342 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
1343
1344 RunDumpsys("APP ACTIVITIES", {"activity", "-v", "all"}, DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001345
Felipe Lemed8b94e52016-12-08 10:21:44 -08001346 printf("========================================================\n");
Makoto Onuki60780982018-04-16 15:34:00 -07001347 printf("== Running Application Services (platform)\n");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001348 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001349
Vishnu Nairc6e6ea72018-07-02 14:20:06 -07001350 RunDumpsys("APP SERVICES PLATFORM", {"activity", "service", "all-platform-non-critical"},
Makoto Onuki60780982018-04-16 15:34:00 -07001351 DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001352
Felipe Lemed8b94e52016-12-08 10:21:44 -08001353 printf("========================================================\n");
Makoto Onuki60780982018-04-16 15:34:00 -07001354 printf("== Running Application Services (non-platform)\n");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001355 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001356
Makoto Onuki60780982018-04-16 15:34:00 -07001357 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1358 DUMPSYS_COMPONENTS_OPTIONS);
1359
1360 printf("========================================================\n");
1361 printf("== Running Application Providers (platform)\n");
1362 printf("========================================================\n");
1363
1364 RunDumpsys("APP PROVIDERS PLATFORM", {"activity", "provider", "all-platform"},
1365 DUMPSYS_COMPONENTS_OPTIONS);
1366
1367 printf("========================================================\n");
1368 printf("== Running Application Providers (non-platform)\n");
1369 printf("========================================================\n");
1370
1371 RunDumpsys("APP PROVIDERS NON-PLATFORM", {"activity", "provider", "all-non-platform"},
1372 DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001373
Adrian Roos8b397ab2017-04-04 16:35:44 -07001374 printf("========================================================\n");
1375 printf("== Dropbox crashes\n");
1376 printf("========================================================\n");
1377
1378 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1379 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1380
Felipe Lemed8b94e52016-12-08 10:21:44 -08001381 printf("========================================================\n");
1382 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1383 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1384 printf("========================================================\n");
1385 printf("== dumpstate: done (id %d)\n", ds.id_);
1386 printf("========================================================\n");
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001387 return Dumpstate::RunStatus::OK;
Colin Crossf45fa6b2012-03-26 12:38:26 -07001388}
1389
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001390/*
1391 * Dumps state for the default case; drops root after it's no longer necessary.
1392 *
1393 * Returns RunStatus::OK if everything went fine.
1394 * Returns RunStatus::ERROR if there was an error.
1395 * Returns RunStatus::USER_DENIED_CONSENT if user explicitly denied consent to sharing the bugreport
1396 * with the caller.
1397 */
1398static Dumpstate::RunStatus DumpstateDefault() {
Nandana Duttcf419a72019-03-14 10:40:17 +00001399 // Invoking the following dumpsys calls before DumpTraces() to try and
Nandana Dutt4be45d12018-09-26 15:04:23 +01001400 // keep the system stats as close to its initial state as possible.
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001401 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysCritical);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001402
1403 /* collect stack traces from Dalvik and native processes (needs root) */
Nandana Duttcf419a72019-03-14 10:40:17 +00001404 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(ds.DumpTraces, &dump_traces_path);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001405
1406 /* Run some operations that require root. */
1407 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX, !ds.IsZipping());
1408 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX, !ds.IsZipping());
1409
1410 ds.AddDir(RECOVERY_DIR, true);
1411 ds.AddDir(RECOVERY_DATA_DIR, true);
1412 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
1413 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1414 if (!PropertiesHelper::IsUserBuild()) {
1415 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1416 ds.AddDir(PROFILE_DATA_DIR_REF, true);
1417 }
1418 add_mountinfo();
1419 DumpIpTablesAsRoot();
1420
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001421 // Capture any IPSec policies in play. No keys are exposed here.
Nandana Dutt4be45d12018-09-26 15:04:23 +01001422 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1423
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001424 // Dump IPsec stats. No keys are exposed here.
1425 DumpFile("XFRM STATS", XFRM_STAT_PROC_FILE);
1426
Nandana Dutt4be45d12018-09-26 15:04:23 +01001427 // Run ss as root so we can see socket marks.
1428 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
1429
1430 // Run iotop as root to show top 100 IO threads
1431 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
1432
Erick Reyese68df822019-02-11 14:46:36 -08001433 // Gather shared memory buffer info if the product implements it
1434 struct stat st;
1435 if (!stat("/product/bin/dmabuf_dump", &st)) {
1436 RunCommand("Dmabuf dump", {"/product/bin/dmabuf_dump"});
1437 }
1438
Nandana Dutt4be45d12018-09-26 15:04:23 +01001439 if (!DropRootUser()) {
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001440 return Dumpstate::RunStatus::ERROR;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001441 }
1442
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001443 RETURN_IF_USER_DENIED_CONSENT();
1444 return dumpstate();
Nandana Dutt4be45d12018-09-26 15:04:23 +01001445}
1446
mukesh agrawal253dad42018-01-23 21:59:59 -08001447// This method collects common dumpsys for telephony and wifi
1448static void DumpstateRadioCommon() {
Jayachandran Ca94c7172017-06-10 15:08:12 -07001449 DumpIpTablesAsRoot();
1450
1451 if (!DropRootUser()) {
1452 return;
1453 }
1454
1455 do_dmesg();
1456 DoLogcat();
1457 DumpPacketStats();
1458 DoKmsg();
1459 DumpIpAddrAndRules();
1460 dump_route_tables();
1461
1462 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
1463 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08001464}
1465
1466// This method collects dumpsys for telephony debugging only
1467static void DumpstateTelephonyOnly() {
1468 DurationReporter duration_reporter("DUMPSTATE");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001469 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08001470
1471 DumpstateRadioCommon();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001472
1473 RunCommand("SYSTEM PROPERTIES", {"getprop"});
1474
1475 printf("========================================================\n");
1476 printf("== Android Framework Services\n");
1477 printf("========================================================\n");
1478
Vishnu Nair652cc802017-11-30 15:18:30 -08001479 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1480 SEC_TO_MSEC(10));
Chiachang Wang85e0db32019-03-25 08:59:55 +08001481 RunDumpsys("DUMPSYS", {"connmetrics"}, CommandOptions::WithTimeout(90).Build(),
1482 SEC_TO_MSEC(10));
1483 RunDumpsys("DUMPSYS", {"netd"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Vishnu Nair652cc802017-11-30 15:18:30 -08001484 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
1485 SEC_TO_MSEC(10));
Amruth Ramachandrand25a9142018-04-02 16:16:09 -07001486 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
1487 SEC_TO_MSEC(10));
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07001488 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
1489 SEC_TO_MSEC(10));
Jayachandran Ca94c7172017-06-10 15:08:12 -07001490
1491 printf("========================================================\n");
1492 printf("== Running Application Services\n");
1493 printf("========================================================\n");
1494
1495 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
1496
1497 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001498 printf("== Running Application Services (non-platform)\n");
1499 printf("========================================================\n");
1500
1501 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1502 DUMPSYS_COMPONENTS_OPTIONS);
1503
1504 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07001505 printf("== Checkins\n");
1506 printf("========================================================\n");
1507
1508 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
1509
1510 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07001511 printf("== dumpstate: done (id %d)\n", ds.id_);
1512 printf("========================================================\n");
1513}
1514
mukesh agrawal253dad42018-01-23 21:59:59 -08001515// This method collects dumpsys for wifi debugging only
1516static void DumpstateWifiOnly() {
1517 DurationReporter duration_reporter("DUMPSTATE");
1518
1519 DumpstateRadioCommon();
1520
1521 printf("========================================================\n");
1522 printf("== Android Framework Services\n");
1523 printf("========================================================\n");
1524
1525 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1526 SEC_TO_MSEC(10));
1527 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
1528 SEC_TO_MSEC(10));
1529
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001530 DumpHals();
Roger Wang70399032019-01-08 16:10:37 +08001531
mukesh agrawal253dad42018-01-23 21:59:59 -08001532 printf("========================================================\n");
1533 printf("== dumpstate: done (id %d)\n", ds.id_);
1534 printf("========================================================\n");
1535}
1536
Nandana Duttcf419a72019-03-14 10:40:17 +00001537Dumpstate::RunStatus Dumpstate::DumpTraces(const char** path) {
Nandana Duttfaafd522019-03-11 09:23:09 +00001538 DurationReporter duration_reporter("DUMP TRACES");
1539
1540 const std::string temp_file_pattern = "/data/anr/dumptrace_XXXXXX";
1541 const size_t buf_size = temp_file_pattern.length() + 1;
1542 std::unique_ptr<char[]> file_name_buf(new char[buf_size]);
1543 memcpy(file_name_buf.get(), temp_file_pattern.c_str(), buf_size);
1544
1545 // Create a new, empty file to receive all trace dumps.
1546 //
1547 // TODO: This can be simplified once we remove support for the old style
1548 // dumps. We can have a file descriptor passed in to dump_traces instead
1549 // of creating a file, closing it and then reopening it again.
1550 android::base::unique_fd fd(mkostemp(file_name_buf.get(), O_APPEND | O_CLOEXEC));
1551 if (fd < 0) {
1552 MYLOGE("mkostemp on pattern %s: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001553 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001554 }
1555
1556 // Nobody should have access to this temporary file except dumpstate, but we
1557 // temporarily grant 'read' to 'others' here because this file is created
1558 // when tombstoned is still running as root, but dumped after dropping. This
1559 // can go away once support for old style dumping has.
1560 const int chmod_ret = fchmod(fd, 0666);
1561 if (chmod_ret < 0) {
1562 MYLOGE("fchmod on %s failed: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001563 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001564 }
1565
1566 std::unique_ptr<DIR, decltype(&closedir)> proc(opendir("/proc"), closedir);
1567 if (proc.get() == nullptr) {
1568 MYLOGE("opendir /proc failed: %s\n", strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001569 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001570 }
1571
1572 // Number of times process dumping has timed out. If we encounter too many
1573 // failures, we'll give up.
1574 int timeout_failures = 0;
1575 bool dalvik_found = false;
1576
1577 const std::set<int> hal_pids = get_interesting_hal_pids();
1578
1579 struct dirent* d;
1580 while ((d = readdir(proc.get()))) {
Nandana Duttcf419a72019-03-14 10:40:17 +00001581 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttfaafd522019-03-11 09:23:09 +00001582 int pid = atoi(d->d_name);
1583 if (pid <= 0) {
1584 continue;
1585 }
1586
1587 const std::string link_name = android::base::StringPrintf("/proc/%d/exe", pid);
1588 std::string exe;
1589 if (!android::base::Readlink(link_name, &exe)) {
1590 continue;
1591 }
1592
1593 bool is_java_process;
1594 if (exe == "/system/bin/app_process32" || exe == "/system/bin/app_process64") {
1595 // Don't bother dumping backtraces for the zygote.
1596 if (IsZygote(pid)) {
1597 continue;
1598 }
1599
1600 dalvik_found = true;
1601 is_java_process = true;
1602 } else if (should_dump_native_traces(exe.c_str()) || hal_pids.find(pid) != hal_pids.end()) {
1603 is_java_process = false;
1604 } else {
1605 // Probably a native process we don't care about, continue.
1606 continue;
1607 }
1608
1609 // If 3 backtrace dumps fail in a row, consider debuggerd dead.
1610 if (timeout_failures == 3) {
1611 dprintf(fd, "ERROR: Too many stack dump failures, exiting.\n");
1612 break;
1613 }
1614
1615 const uint64_t start = Nanotime();
1616 const int ret = dump_backtrace_to_file_timeout(
1617 pid, is_java_process ? kDebuggerdJavaBacktrace : kDebuggerdNativeBacktrace,
1618 is_java_process ? 5 : 20, fd);
1619
1620 if (ret == -1) {
1621 // For consistency, the header and footer to this message match those
1622 // dumped by debuggerd in the success case.
1623 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
1624 dprintf(fd, "Dump failed, likely due to a timeout.\n");
1625 dprintf(fd, "---- end %d ----", pid);
1626 timeout_failures++;
1627 continue;
1628 }
1629
1630 // We've successfully dumped stack traces, reset the failure count
1631 // and write a summary of the elapsed time to the file and continue with the
1632 // next process.
1633 timeout_failures = 0;
1634
1635 dprintf(fd, "[dump %s stack %d: %.3fs elapsed]\n", is_java_process ? "dalvik" : "native",
1636 pid, (float)(Nanotime() - start) / NANOS_PER_SEC);
1637 }
1638
1639 if (!dalvik_found) {
1640 MYLOGE("Warning: no Dalvik processes found to dump stacks\n");
1641 }
1642
Nandana Duttcf419a72019-03-14 10:40:17 +00001643 *path = file_name_buf.release();
1644 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001645}
1646
Felipe Leme6f674ae2016-11-18 17:10:33 -08001647void Dumpstate::DumpstateBoard() {
1648 DurationReporter duration_reporter("dumpstate_board()");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001649 printf("========================================================\n");
1650 printf("== Board\n");
1651 printf("========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001652
Felipe Leme6f674ae2016-11-18 17:10:33 -08001653 if (!IsZipping()) {
Steven Moreland7440ddb2016-12-15 16:13:39 -08001654 MYLOGD("Not dumping board info because it's not a zipped bugreport\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001655 return;
1656 }
1657
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001658 std::vector<std::string> paths;
1659 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07001660 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00001661 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
1662 kDumpstateBoardFiles[i].c_str()));
Nandana Dutt16d1aee2019-02-15 16:13:53 +00001663 remover.emplace_back(android::base::make_scope_guard(
1664 std::bind([](std::string path) { android::os::UnlinkAndLogOnError(path); }, paths[i])));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001665 }
Jie Song9fbfad02017-06-20 16:29:42 -07001666
Wei Wang587eac92018-04-05 12:17:20 -07001667 sp<IDumpstateDevice> dumpstate_device(IDumpstateDevice::getService());
1668 if (dumpstate_device == nullptr) {
1669 MYLOGE("No IDumpstateDevice implementation\n");
1670 return;
1671 }
1672
1673 using ScopedNativeHandle =
1674 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
1675 ScopedNativeHandle handle(native_handle_create(static_cast<int>(paths.size()), 0),
1676 [](native_handle_t* handle) {
1677 native_handle_close(handle);
1678 native_handle_delete(handle);
1679 });
1680 if (handle == nullptr) {
1681 MYLOGE("Could not create native_handle\n");
1682 return;
1683 }
1684
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001685 // TODO(128270426): Check for consent in between?
Wei Wang587eac92018-04-05 12:17:20 -07001686 for (size_t i = 0; i < paths.size(); i++) {
1687 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
1688
1689 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
1690 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1691 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1692 if (fd < 0) {
1693 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
1694 return;
1695 }
1696 handle.get()->data[i] = fd.release();
1697 }
1698
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001699 // Given that bugreport is required to diagnose failures, it's better to
Wei Wang587eac92018-04-05 12:17:20 -07001700 // set an arbitrary amount of timeout for IDumpstateDevice than to block the
1701 // rest of bugreport. In the timeout case, we will kill dumpstate board HAL
1702 // and grab whatever dumped
1703 std::packaged_task<bool()>
1704 dumpstate_task([paths, dumpstate_device, &handle]() -> bool {
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001705 android::hardware::Return<void> status = dumpstate_device->dumpstateBoard(handle.get());
1706 if (!status.isOk()) {
1707 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
Wei Wang587eac92018-04-05 12:17:20 -07001708 return false;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001709 }
Wei Wang587eac92018-04-05 12:17:20 -07001710 return true;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001711 });
Wei Wang587eac92018-04-05 12:17:20 -07001712
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001713 auto result = dumpstate_task.get_future();
1714 std::thread(std::move(dumpstate_task)).detach();
Wei Wang587eac92018-04-05 12:17:20 -07001715
1716 constexpr size_t timeout_sec = 30;
1717 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
1718 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate vendor HAL\n", timeout_sec);
1719 if (!android::base::SetProperty("ctl.interface_restart",
1720 android::base::StringPrintf("%s/default",
1721 IDumpstateDevice::descriptor))) {
1722 MYLOGE("Couldn't restart dumpstate HAL\n");
1723 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001724 }
Wei Wang587eac92018-04-05 12:17:20 -07001725 // Wait some time for init to kill dumpstate vendor HAL
1726 constexpr size_t killing_timeout_sec = 10;
1727 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
1728 MYLOGE("killing dumpstateBoard timed out after %zus, continue and "
1729 "there might be racing in content\n", killing_timeout_sec);
1730 }
1731
1732 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
1733 for (size_t i = 0; i < paths.size(); i++) {
1734 struct stat s;
1735 if (fstat(handle.get()->data[i], &s) == -1) {
1736 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(),
1737 strerror(errno));
1738 file_sizes[i] = -1;
1739 continue;
1740 }
1741 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001742 }
1743
1744 for (size_t i = 0; i < paths.size(); i++) {
1745 if (file_sizes[i] == -1) {
1746 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07001747 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001748 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07001749 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001750 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07001751 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001752 AddZipEntry(kDumpstateBoardFiles[i], paths[i]);
Jie Song9fbfad02017-06-20 16:29:42 -07001753 }
1754
Felipe Lemed8b94e52016-12-08 10:21:44 -08001755 printf("*** See dumpstate-board.txt entry ***\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001756}
1757
Nandana Dutt12ae14a2019-01-09 10:35:53 +00001758static void ShowUsage() {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001759 fprintf(stderr,
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001760 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-d] [-p] "
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001761 "[-z]] [-s] [-S] [-q] [-B] [-P] [-R] [-V version]\n"
1762 " -h: display this help message\n"
1763 " -b: play sound file instead of vibrate, at beginning of job\n"
1764 " -e: play sound file instead of vibrate, at end of job\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001765 " -d: append date to filename\n"
1766 " -p: capture screenshot to filename.png\n"
1767 " -z: generate zipped file\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001768 " -s: write output to control socket (for init)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001769 " -S: write file location to control socket (for init; requires -z)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001770 " -q: disable vibrate\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001771 " -B: send broadcast when finished\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001772 " -P: send broadcast when started and update system properties on "
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001773 "progress (requires -B)\n"
1774 " -R: take bugreport in remote mode (requires -z, -d and -B, "
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001775 "shouldn't be used with -P)\n"
Nandana Dutt235864b2019-01-22 12:10:16 +00001776 " -w: start binder service and make it wait for a call to startBugreport\n"
Felipe Lemed071c682016-10-20 16:48:00 -07001777 " -v: prints the dumpstate header and exit\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001778}
1779
Wei Liuf87959e2016-08-26 14:51:42 -07001780static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07001781 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07001782}
1783
Felipe Leme1d486fe2016-10-14 18:06:47 -07001784bool Dumpstate::FinishZipFile() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001785 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07001786 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07001787 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07001788 // Final timestamp
1789 char date[80];
1790 time_t the_real_now_please_stand_up = time(nullptr);
1791 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07001792 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001793 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07001794
Felipe Leme9a523ae2016-10-20 15:10:33 -07001795 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001796 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08001797 return false;
1798 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07001799 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001800 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08001801 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08001802 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08001803
Felipe Leme0f3fb202016-06-10 17:10:53 -07001804 // Add log file (which contains stderr output) to zip...
1805 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07001806 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07001807 MYLOGE("Failed to add dumpstate log to .zip file\n");
1808 return false;
1809 }
Nandana Dutt979388e2018-11-30 16:48:55 +00001810 // TODO: Should truncate the existing file.
1811 // ... and re-open it for further logging.
Nandana Dutta344cb62019-02-22 15:12:35 +00001812 if (!redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()))) {
1813 return false;
1814 }
Felipe Leme0f3fb202016-06-10 17:10:53 -07001815 fprintf(stderr, "\n");
1816
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07001817 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07001818 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07001819 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08001820 return false;
1821 }
1822
Felipe Leme1d486fe2016-10-14 18:06:47 -07001823 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
1824 ds.zip_file.reset(nullptr);
1825
Felipe Lemee9d2c542016-11-15 11:48:26 -08001826 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
Nandana Dutt16d1aee2019-02-15 16:13:53 +00001827 android::os::UnlinkAndLogOnError(tmp_path_);
Felipe Lemec4eee562016-04-21 15:42:55 -07001828
Felipe Leme1e9edc62015-12-21 16:02:13 -08001829 return true;
1830}
Felipe Leme6e01fa62015-11-11 19:35:14 -08001831
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -07001832static std::string SHA256_file_hash(const std::string& filepath) {
Andreas Gampe27cd7b22016-07-18 18:24:05 -07001833 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(filepath.c_str(), O_RDONLY | O_NONBLOCK
1834 | O_CLOEXEC | O_NOFOLLOW)));
Andreas Gampeaff68432016-07-18 18:01:27 -07001835 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001836 MYLOGE("open(%s): %s\n", filepath.c_str(), strerror(errno));
Yi Kong19d5c002018-07-20 13:39:55 -07001837 return nullptr;
Michal Karpinski4db754f2015-12-11 18:04:32 +00001838 }
1839
1840 SHA256_CTX ctx;
Elliott Hughesc4dc1412016-04-12 16:28:31 -07001841 SHA256_Init(&ctx);
Michal Karpinski4db754f2015-12-11 18:04:32 +00001842
1843 std::vector<uint8_t> buffer(65536);
1844 while (1) {
1845 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd.get(), buffer.data(), buffer.size()));
1846 if (bytes_read == 0) {
1847 break;
1848 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001849 MYLOGE("read(%s): %s\n", filepath.c_str(), strerror(errno));
Yi Kong19d5c002018-07-20 13:39:55 -07001850 return nullptr;
Michal Karpinski4db754f2015-12-11 18:04:32 +00001851 }
1852
Elliott Hughesc4dc1412016-04-12 16:28:31 -07001853 SHA256_Update(&ctx, buffer.data(), bytes_read);
Michal Karpinski4db754f2015-12-11 18:04:32 +00001854 }
1855
Elliott Hughesc4dc1412016-04-12 16:28:31 -07001856 uint8_t hash[SHA256_DIGEST_LENGTH];
1857 SHA256_Final(hash, &ctx);
1858
1859 char hash_buffer[SHA256_DIGEST_LENGTH * 2 + 1];
1860 for(size_t i = 0; i < SHA256_DIGEST_LENGTH; i++) {
Michal Karpinskicbbdf732016-01-07 20:45:02 +00001861 sprintf(hash_buffer + (i * 2), "%02x", hash[i]);
Michal Karpinski4db754f2015-12-11 18:04:32 +00001862 }
1863 hash_buffer[sizeof(hash_buffer) - 1] = 0;
1864 return std::string(hash_buffer);
1865}
1866
Felipe Lemea4ef1f02017-02-15 17:27:40 -08001867static void SendBroadcast(const std::string& action, const std::vector<std::string>& args) {
1868 // clang-format off
1869 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user", "0",
1870 "--receiver-foreground", "--receiver-include-background", "-a", action};
1871 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08001872
1873 am.insert(am.end(), args.begin(), args.end());
1874
Felipe Leme8d2410e2017-02-08 09:46:08 -08001875 RunCommand("", am,
1876 CommandOptions::WithTimeout(20)
1877 .Log("Sending broadcast: '%s'\n")
1878 .Always()
1879 .DropRoot()
1880 .RedirectStderr()
1881 .Build());
1882}
1883
Felipe Leme35b8cf12017-02-10 15:47:29 -08001884static void Vibrate(int duration_ms) {
1885 // clang-format off
Chris Friese7e95fb2019-06-14 14:47:59 +00001886 RunCommand("", {"cmd", "vibrator", "vibrate", std::to_string(duration_ms), "dumpstate"},
Felipe Leme35b8cf12017-02-10 15:47:29 -08001887 CommandOptions::WithTimeout(10)
1888 .Log("Vibrate: '%s'\n")
1889 .Always()
1890 .Build());
1891 // clang-format on
1892}
1893
Nandana Dutt979388e2018-11-30 16:48:55 +00001894static void MaybeResolveSymlink(std::string* path) {
1895 std::string resolved_path;
1896 if (android::base::Readlink(*path, &resolved_path)) {
1897 *path = resolved_path;
1898 }
1899}
1900
Nandana Dutt4be45d12018-09-26 15:04:23 +01001901/*
1902 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
1903 * if we are writing zip files and adds the version file.
1904 */
1905static void PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00001906 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
1907
Nandana Dutt4be45d12018-09-26 15:04:23 +01001908 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
1909 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt9a76d202019-01-21 15:56:48 +00001910 ds.base_name_ = StringPrintf("bugreport-%s-%s", device_name.c_str(), build_id.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01001911 if (ds.options_->do_add_date) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01001912 char date[80];
1913 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
1914 ds.name_ = date;
1915 } else {
1916 ds.name_ = "undated";
1917 }
1918
Nandana Dutt5fb117b2018-09-27 09:23:36 +01001919 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01001920 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01001921 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01001922 ds.base_name_ += "-wifi";
1923 }
1924
Nandana Dutt5fb117b2018-09-27 09:23:36 +01001925 if (ds.options_->do_fb) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01001926 ds.screenshot_path_ = ds.GetPath(".png");
1927 }
1928 ds.tmp_path_ = ds.GetPath(".tmp");
1929 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
1930
Nandana Dutt54dbd672019-01-11 12:58:05 +00001931 std::string destination = ds.options_->bugreport_fd.get() != -1
1932 ? StringPrintf("[fd:%d]", ds.options_->bugreport_fd.get())
Nandana Dutt9a76d202019-01-21 15:56:48 +00001933 : ds.bugreport_internal_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01001934 MYLOGD(
1935 "Bugreport dir: %s\n"
1936 "Base name: %s\n"
1937 "Suffix: %s\n"
1938 "Log path: %s\n"
1939 "Temporary path: %s\n"
1940 "Screenshot path: %s\n",
Nandana Dutt9a76d202019-01-21 15:56:48 +00001941 destination.c_str(), ds.base_name_.c_str(), ds.name_.c_str(), ds.log_path_.c_str(),
1942 ds.tmp_path_.c_str(), ds.screenshot_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01001943
Nandana Dutt5fb117b2018-09-27 09:23:36 +01001944 if (ds.options_->do_zip_file) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01001945 ds.path_ = ds.GetPath(".zip");
1946 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
1947 create_parent_dirs(ds.path_.c_str());
1948 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
1949 if (ds.zip_file == nullptr) {
1950 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
1951 } else {
1952 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
1953 }
1954 ds.AddTextZipEntry("version.txt", ds.version_);
1955 }
1956}
1957
1958/*
1959 * Finalizes writing to the file by renaming or zipping the tmp file to the final location,
1960 * printing zipped file status, etc.
1961 */
1962static void FinalizeFile() {
Nandana Dutt4be45d12018-09-26 15:04:23 +01001963 /* check if user changed the suffix using system properties */
1964 std::string name =
1965 android::base::GetProperty(android::base::StringPrintf("dumpstate.%d.name", ds.pid_), "");
1966 bool change_suffix = false;
1967 if (!name.empty()) {
1968 /* must whitelist which characters are allowed, otherwise it could cross directories */
1969 std::regex valid_regex("^[-_a-zA-Z0-9]+$");
1970 if (std::regex_match(name.c_str(), valid_regex)) {
1971 change_suffix = true;
1972 } else {
1973 MYLOGE("invalid suffix provided by user: %s\n", name.c_str());
1974 }
1975 }
1976 if (change_suffix) {
1977 MYLOGI("changing suffix from %s to %s\n", ds.name_.c_str(), name.c_str());
1978 ds.name_ = name;
1979 if (!ds.screenshot_path_.empty()) {
1980 std::string new_screenshot_path = ds.GetPath(".png");
1981 if (rename(ds.screenshot_path_.c_str(), new_screenshot_path.c_str())) {
1982 MYLOGE("rename(%s, %s): %s\n", ds.screenshot_path_.c_str(),
1983 new_screenshot_path.c_str(), strerror(errno));
1984 } else {
1985 ds.screenshot_path_ = new_screenshot_path;
1986 }
1987 }
1988 }
1989
1990 bool do_text_file = true;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01001991 if (ds.options_->do_zip_file) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01001992 if (!ds.FinishZipFile()) {
1993 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
1994 do_text_file = true;
1995 } else {
1996 do_text_file = false;
Nandana Dutt383d0c12018-11-30 15:54:56 +00001997 // If the user has changed the suffix, we need to change the zip file name.
1998 std::string new_path = ds.GetPath(".zip");
1999 if (ds.path_ != new_path) {
2000 MYLOGD("Renaming zip file from %s to %s\n", ds.path_.c_str(), new_path.c_str());
2001 if (rename(ds.path_.c_str(), new_path.c_str())) {
2002 MYLOGE("rename(%s, %s): %s\n", ds.path_.c_str(), new_path.c_str(),
2003 strerror(errno));
2004 } else {
2005 ds.path_ = new_path;
2006 }
2007 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01002008 }
2009 }
2010 if (do_text_file) {
2011 ds.path_ = ds.GetPath(".txt");
2012 MYLOGD("Generating .txt bugreport at %s from %s\n", ds.path_.c_str(), ds.tmp_path_.c_str());
2013 if (rename(ds.tmp_path_.c_str(), ds.path_.c_str())) {
2014 MYLOGE("rename(%s, %s): %s\n", ds.tmp_path_.c_str(), ds.path_.c_str(), strerror(errno));
2015 ds.path_.clear();
2016 }
2017 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002018 if (ds.options_->use_control_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002019 if (do_text_file) {
2020 dprintf(ds.control_socket_fd_,
2021 "FAIL:could not create zip file, check %s "
2022 "for more details\n",
2023 ds.log_path_.c_str());
2024 } else {
2025 dprintf(ds.control_socket_fd_, "OK:%s\n", ds.path_.c_str());
2026 }
2027 }
2028}
2029
2030/* Broadcasts that we are done with the bugreport */
2031static void SendBugreportFinishedBroadcast() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002032 // TODO(b/111441001): use callback instead of broadcast.
Nandana Dutt9a76d202019-01-21 15:56:48 +00002033 if (!ds.path_.empty()) {
2034 MYLOGI("Final bugreport path: %s\n", ds.path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002035 // clang-format off
2036
2037 std::vector<std::string> am_args = {
2038 "--receiver-permission", "android.permission.DUMP",
2039 "--ei", "android.intent.extra.ID", std::to_string(ds.id_),
2040 "--ei", "android.intent.extra.PID", std::to_string(ds.pid_),
2041 "--ei", "android.intent.extra.MAX", std::to_string(ds.progress_->GetMax()),
Nandana Dutt9a76d202019-01-21 15:56:48 +00002042 "--es", "android.intent.extra.BUGREPORT", ds.path_,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002043 "--es", "android.intent.extra.DUMPSTATE_LOG", ds.log_path_
2044 };
2045 // clang-format on
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +00002046 if (ds.options_->do_fb && !android::os::IsFileEmpty(ds.screenshot_path_)) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002047 am_args.push_back("--es");
2048 am_args.push_back("android.intent.extra.SCREENSHOT");
2049 am_args.push_back(ds.screenshot_path_);
2050 }
Nandana Dutt15b89d72018-11-16 14:14:12 +00002051 if (!ds.options_->notification_title.empty()) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002052 am_args.push_back("--es");
2053 am_args.push_back("android.intent.extra.TITLE");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002054 am_args.push_back(ds.options_->notification_title);
2055 if (!ds.options_->notification_description.empty()) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002056 am_args.push_back("--es");
2057 am_args.push_back("android.intent.extra.DESCRIPTION");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002058 am_args.push_back(ds.options_->notification_description);
Nandana Dutt4be45d12018-09-26 15:04:23 +01002059 }
2060 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002061 if (ds.options_->is_remote_mode) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002062 am_args.push_back("--es");
2063 am_args.push_back("android.intent.extra.REMOTE_BUGREPORT_HASH");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002064 am_args.push_back(SHA256_file_hash(ds.path_));
Nandana Dutt4be45d12018-09-26 15:04:23 +01002065 SendBroadcast("com.android.internal.intent.action.REMOTE_BUGREPORT_FINISHED", am_args);
2066 } else {
2067 SendBroadcast("com.android.internal.intent.action.BUGREPORT_FINISHED", am_args);
2068 }
2069 } else {
2070 MYLOGE("Skipping finished broadcast because bugreport could not be generated\n");
2071 }
2072}
2073
Nandana Dutt58d72e22018-11-16 10:30:48 +00002074static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2075 switch (mode) {
2076 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2077 return "BUGREPORT_FULL";
2078 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2079 return "BUGREPORT_INTERACTIVE";
2080 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2081 return "BUGREPORT_REMOTE";
2082 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2083 return "BUGREPORT_WEAR";
2084 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2085 return "BUGREPORT_TELEPHONY";
2086 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2087 return "BUGREPORT_WIFI";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002088 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2089 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002090 }
2091}
2092
2093static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options) {
Abhijeet Kaur8ca245e2018-12-12 10:34:21 +00002094 options->extra_options = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002095 switch (mode) {
2096 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2097 options->do_broadcast = true;
2098 options->do_fb = true;
2099 break;
2100 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002101 // Currently, the dumpstate binder is only used by Shell to update progress.
2102 options->do_start_service = true;
2103 options->do_progress_updates = true;
2104 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002105 options->do_broadcast = true;
2106 break;
2107 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002108 options->do_vibrate = false;
2109 options->is_remote_mode = true;
2110 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002111 options->do_broadcast = true;
2112 break;
2113 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002114 options->do_start_service = true;
2115 options->do_progress_updates = true;
2116 options->do_zip_file = true;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002117 options->do_fb = true;
2118 options->do_broadcast = true;
2119 break;
2120 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002121 options->telephony_only = true;
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +00002122 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002123 options->do_broadcast = true;
2124 break;
2125 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002126 options->wifi_only = true;
2127 options->do_zip_file = true;
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +00002128 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002129 options->do_broadcast = true;
2130 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002131 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2132 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002133 }
2134}
2135
2136static Dumpstate::BugreportMode getBugreportModeFromProperty() {
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002137 // If the system property is not set, it's assumed to be a default bugreport.
2138 Dumpstate::BugreportMode mode = Dumpstate::BugreportMode::BUGREPORT_DEFAULT;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002139
2140 std::string extra_options = android::base::GetProperty(PROPERTY_EXTRA_OPTIONS, "");
2141 if (!extra_options.empty()) {
2142 // Framework uses a system property to override some command-line args.
2143 // Currently, it contains the type of the requested bugreport.
2144 if (extra_options == "bugreportplus") {
2145 mode = Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002146 } else if (extra_options == "bugreportfull") {
2147 mode = Dumpstate::BugreportMode::BUGREPORT_FULL;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002148 } else if (extra_options == "bugreportremote") {
2149 mode = Dumpstate::BugreportMode::BUGREPORT_REMOTE;
2150 } else if (extra_options == "bugreportwear") {
2151 mode = Dumpstate::BugreportMode::BUGREPORT_WEAR;
2152 } else if (extra_options == "bugreporttelephony") {
2153 mode = Dumpstate::BugreportMode::BUGREPORT_TELEPHONY;
2154 } else if (extra_options == "bugreportwifi") {
2155 mode = Dumpstate::BugreportMode::BUGREPORT_WIFI;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002156 } else {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002157 MYLOGE("Unknown extra option: %s\n", extra_options.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002158 }
2159 // Reset the property
2160 android::base::SetProperty(PROPERTY_EXTRA_OPTIONS, "");
2161 }
Nandana Dutt58d72e22018-11-16 10:30:48 +00002162 return mode;
2163}
2164
2165// TODO: Move away from system properties when we have options passed via binder calls.
2166/* Sets runtime options from the system properties and then clears those properties. */
2167static void SetOptionsFromProperties(Dumpstate::DumpOptions* options) {
2168 Dumpstate::BugreportMode mode = getBugreportModeFromProperty();
2169 SetOptionsFromMode(mode, options);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002170
2171 options->notification_title = android::base::GetProperty(PROPERTY_EXTRA_TITLE, "");
2172 if (!options->notification_title.empty()) {
2173 // Reset the property
2174 android::base::SetProperty(PROPERTY_EXTRA_TITLE, "");
2175
Nandana Duttdd8cca32018-11-14 10:10:29 +00002176 options->notification_description =
2177 android::base::GetProperty(PROPERTY_EXTRA_DESCRIPTION, "");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002178 if (!options->notification_description.empty()) {
2179 // Reset the property
2180 android::base::SetProperty(PROPERTY_EXTRA_DESCRIPTION, "");
2181 }
2182 MYLOGD("notification (title: %s, description: %s)\n", options->notification_title.c_str(),
2183 options->notification_description.c_str());
2184 }
2185}
2186
Nandana Dutt58d72e22018-11-16 10:30:48 +00002187static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
2188 MYLOGI("do_zip_file: %d\n", options.do_zip_file);
2189 MYLOGI("do_add_date: %d\n", options.do_add_date);
2190 MYLOGI("do_vibrate: %d\n", options.do_vibrate);
2191 MYLOGI("use_socket: %d\n", options.use_socket);
2192 MYLOGI("use_control_socket: %d\n", options.use_control_socket);
2193 MYLOGI("do_fb: %d\n", options.do_fb);
2194 MYLOGI("do_broadcast: %d\n", options.do_broadcast);
2195 MYLOGI("is_remote_mode: %d\n", options.is_remote_mode);
2196 MYLOGI("show_header_only: %d\n", options.show_header_only);
2197 MYLOGI("do_start_service: %d\n", options.do_start_service);
2198 MYLOGI("telephony_only: %d\n", options.telephony_only);
2199 MYLOGI("wifi_only: %d\n", options.wifi_only);
2200 MYLOGI("do_progress_updates: %d\n", options.do_progress_updates);
Nandana Dutt54dbd672019-01-11 12:58:05 +00002201 MYLOGI("fd: %d\n", options.bugreport_fd.get());
Nandana Dutt58d72e22018-11-16 10:30:48 +00002202 MYLOGI("extra_options: %s\n", options.extra_options.c_str());
2203 MYLOGI("args: %s\n", options.args.c_str());
2204 MYLOGI("notification_title: %s\n", options.notification_title.c_str());
2205 MYLOGI("notification_description: %s\n", options.notification_description.c_str());
2206}
2207
Nandana Dutt54dbd672019-01-11 12:58:05 +00002208void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode,
2209 const android::base::unique_fd& bugreport_fd_in,
2210 const android::base::unique_fd& screenshot_fd_in) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002211 // In the new API world, date is always added; output is always a zip file.
2212 // TODO(111441001): remove these options once they are obsolete.
2213 do_add_date = true;
2214 do_zip_file = true;
2215
Nandana Dutt54dbd672019-01-11 12:58:05 +00002216 // Duplicate the fds because the passed in fds don't outlive the binder transaction.
2217 bugreport_fd.reset(dup(bugreport_fd_in.get()));
2218 screenshot_fd.reset(dup(screenshot_fd_in.get()));
Nandana Dutt58d72e22018-11-16 10:30:48 +00002219
2220 extra_options = ModeToString(bugreport_mode);
2221 SetOptionsFromMode(bugreport_mode, this);
2222}
2223
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002224Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
2225 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002226 int c;
Nandana Dutt235864b2019-01-22 12:10:16 +00002227 while ((c = getopt(argc, argv, "dho:svqzpPBRSV:w")) != -1) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002228 switch (c) {
2229 // clang-format off
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002230 case 'd': do_add_date = true; break;
2231 case 'z': do_zip_file = true; break;
Nandana Dutt9a76d202019-01-21 15:56:48 +00002232 // o=use_outfile not supported anymore.
2233 // TODO(b/111441001): Remove when all callers have migrated.
2234 case 'o': break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002235 case 's': use_socket = true; break;
2236 case 'S': use_control_socket = true; break;
2237 case 'v': show_header_only = true; break;
2238 case 'q': do_vibrate = false; break;
2239 case 'p': do_fb = true; break;
2240 case 'P': do_progress_updates = true; break;
2241 case 'R': is_remote_mode = true; break;
2242 case 'B': do_broadcast = true; break;
2243 case 'V': break; // compatibility no-op
Nandana Dutt235864b2019-01-22 12:10:16 +00002244 case 'w':
2245 // This was already processed
2246 break;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002247 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002248 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002249 break;
2250 default:
2251 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002252 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002253 break;
2254 // clang-format on
2255 }
2256 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08002257
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002258 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002259 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002260 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002261 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002262 }
2263 }
2264
2265 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
2266 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002267
2268 SetOptionsFromProperties(this);
2269 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002270}
2271
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002272bool Dumpstate::DumpOptions::ValidateOptions() const {
Nandana Dutt54dbd672019-01-11 12:58:05 +00002273 if (bugreport_fd.get() != -1 && !do_zip_file) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002274 return false;
2275 }
2276
Nandana Dutt9a76d202019-01-21 15:56:48 +00002277 if ((do_zip_file || do_add_date || do_progress_updates || do_broadcast) && !OutputToFile()) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002278 return false;
2279 }
2280
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002281 if (use_control_socket && !do_zip_file) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002282 return false;
2283 }
2284
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002285 if (do_progress_updates && !do_broadcast) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002286 return false;
2287 }
2288
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002289 if (is_remote_mode && (do_progress_updates || !do_broadcast || !do_zip_file || !do_add_date)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002290 return false;
2291 }
2292 return true;
2293}
2294
Nandana Dutt197661d2018-11-16 16:40:21 +00002295void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
2296 options_ = std::move(options);
2297}
2298
Nandana Duttd2f5f082019-01-18 17:13:52 +00002299Dumpstate::RunStatus Dumpstate::Run(int32_t calling_uid, const std::string& calling_package) {
2300 Dumpstate::RunStatus status = RunInternal(calling_uid, calling_package);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002301 if (listener_ != nullptr) {
2302 switch (status) {
2303 case Dumpstate::RunStatus::OK:
Nandana Duttcc4ead82019-01-23 08:29:23 +00002304 listener_->onFinished();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002305 break;
2306 case Dumpstate::RunStatus::HELP:
2307 break;
2308 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002309 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_INVALID_INPUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002310 break;
2311 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002312 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_RUNTIME_ERROR);
2313 break;
2314 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2315 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_DENIED_CONSENT);
2316 break;
2317 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
2318 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_CONSENT_TIMED_OUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002319 break;
2320 }
2321 }
2322 return status;
2323}
2324
Nandana Dutt979388e2018-11-30 16:48:55 +00002325/*
2326 * Dumps relevant information to a bugreport based on the given options.
2327 *
2328 * The bugreport can be dumped to a file or streamed to a socket.
2329 *
2330 * How dumping to file works:
2331 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
2332 * stderr is redirected a log file.
2333 *
2334 * The temporary bugreport is then populated via printfs, dumping contents of files and
2335 * output of commands to stdout.
2336 *
2337 * If zipping, the temporary bugreport file is added to the zip archive. Else it's renamed to final
2338 * text file.
2339 *
2340 * If zipping, a bunch of other files and dumps also get added to the zip archive. The log file also
2341 * gets added to the archive.
2342 *
Nandana Dutt9a76d202019-01-21 15:56:48 +00002343 * Bugreports are first generated in a local directory and later copied to the caller's fd if
2344 * supplied.
Nandana Dutt979388e2018-11-30 16:48:55 +00002345 */
Nandana Duttd2f5f082019-01-18 17:13:52 +00002346Dumpstate::RunStatus Dumpstate::RunInternal(int32_t calling_uid,
2347 const std::string& calling_package) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002348 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00002349 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002350 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002351 return RunStatus::INVALID_INPUT;
2352 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002353 /* set as high priority, and protect from OOM killer */
2354 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002355
Felipe Lemed071c682016-10-20 16:48:00 -07002356 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002357 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002358 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002359 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002360 } else {
2361 /* fallback to kernels <= 2.6.35 */
2362 oom_adj = fopen("/proc/self/oom_adj", "we");
2363 if (oom_adj) {
2364 fputs("-17", oom_adj);
2365 fclose(oom_adj);
2366 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002367 }
2368
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002369 if (version_ == VERSION_DEFAULT) {
2370 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00002371 }
2372
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002373 if (version_ != VERSION_CURRENT && version_ != VERSION_SPLIT_ANR) {
Vishnu Nair64afc022018-02-01 15:29:34 -08002374 MYLOGE("invalid version requested ('%s'); suppported values are: ('%s', '%s', '%s')\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002375 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str(),
Vishnu Nair64afc022018-02-01 15:29:34 -08002376 VERSION_SPLIT_ANR.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002377 return RunStatus::INVALID_INPUT;
Felipe Lemed071c682016-10-20 16:48:00 -07002378 }
2379
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002380 if (options_->show_header_only) {
2381 PrintHeader();
2382 return RunStatus::OK;
Felipe Lemed071c682016-10-20 16:48:00 -07002383 }
2384
Nandana Duttd2f5f082019-01-18 17:13:52 +00002385 if (options_->bugreport_fd.get() != -1) {
2386 // If the output needs to be copied over to the caller's fd, get user consent.
2387 android::String16 package(calling_package.c_str());
2388 CheckUserConsent(calling_uid, package);
2389 }
2390
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002391 // Redirect output if needed
Nandana Dutt9a76d202019-01-21 15:56:48 +00002392 bool is_redirecting = options_->OutputToFile();
Felipe Leme7447d7c2016-11-03 18:12:22 -07002393
2394 // TODO: temporarily set progress until it's part of the Dumpstate constructor
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002395 std::string stats_path =
Nandana Dutt979388e2018-11-30 16:48:55 +00002396 is_redirecting
2397 ? android::base::StringPrintf("%s/dumpstate-stats.txt", bugreport_internal_dir_.c_str())
2398 : "";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002399 progress_.reset(new Progress(stats_path));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002400
Felipe Lemed071c682016-10-20 16:48:00 -07002401 /* gets the sequential id */
Felipe Leme7447d7c2016-11-03 18:12:22 -07002402 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002403 id_ = ++last_id;
Felipe Lemed071c682016-10-20 16:48:00 -07002404 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
2405
2406 MYLOGI("begin\n");
2407
Felipe Leme6ae5c4f2017-01-10 14:13:22 -08002408 register_sig_handler();
Felipe Lemed071c682016-10-20 16:48:00 -07002409
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002410 // TODO(b/111441001): maybe skip if already started?
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002411 if (options_->do_start_service) {
Felipe Leme75876a22016-10-27 16:31:27 -07002412 MYLOGI("Starting 'dumpstate' service\n");
2413 android::status_t ret;
2414 if ((ret = android::os::DumpstateService::Start()) != android::OK) {
2415 MYLOGE("Unable to start DumpstateService: %d\n", ret);
2416 }
2417 }
2418
Felipe Lemef0292972016-11-22 13:57:05 -08002419 if (PropertiesHelper::IsDryRun()) {
Felipe Lemed071c682016-10-20 16:48:00 -07002420 MYLOGI("Running on dry-run mode (to disable it, call 'setprop dumpstate.dry_run false')\n");
2421 }
2422
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002423 MYLOGI("dumpstate info: id=%d, args='%s', extra_options= %s)\n", id_, options_->args.c_str(),
2424 options_->extra_options.c_str());
Felipe Lemed071c682016-10-20 16:48:00 -07002425
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002426 MYLOGI("bugreport format version: %s\n", version_.c_str());
Felipe Leme809d74e2016-02-02 12:57:00 -08002427
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002428 do_early_screenshot_ = options_->do_progress_updates;
Felipe Lemee338bf62015-12-07 14:03:50 -08002429
Christopher Ferrised9354f2014-10-01 17:35:01 -07002430 // If we are going to use a socket, do it as early as possible
2431 // to avoid timeouts from bugreport.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002432 if (options_->use_socket) {
Nandana Dutta344cb62019-02-22 15:12:35 +00002433 if (!redirect_to_socket(stdout, "dumpstate")) {
2434 return ERROR;
2435 }
Christopher Ferrised9354f2014-10-01 17:35:01 -07002436 }
2437
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002438 if (options_->use_control_socket) {
Felipe Leme2628e9e2016-04-12 16:36:51 -07002439 MYLOGD("Opening control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002440 control_socket_fd_ = open_socket("dumpstate");
Nandana Dutta344cb62019-02-22 15:12:35 +00002441 if (control_socket_fd_ == -1) {
2442 return ERROR;
2443 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002444 options_->do_progress_updates = 1;
Felipe Leme2628e9e2016-04-12 16:36:51 -07002445 }
2446
Felipe Leme71bbfc52015-11-23 14:14:51 -08002447 if (is_redirecting) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002448 PrepareToWriteToFile();
Felipe Leme1e9edc62015-12-21 16:02:13 -08002449
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002450 if (options_->do_progress_updates) {
2451 if (options_->do_broadcast) {
Felipe Lemedcd1f0d2016-08-04 12:48:50 -07002452 // clang-format off
2453 std::vector<std::string> am_args = {
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002454 "--receiver-permission", "android.permission.DUMP",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002455 "--es", "android.intent.extra.NAME", name_,
2456 "--ei", "android.intent.extra.ID", std::to_string(id_),
2457 "--ei", "android.intent.extra.PID", std::to_string(pid_),
2458 "--ei", "android.intent.extra.MAX", std::to_string(progress_->GetMax()),
Felipe Lemedcd1f0d2016-08-04 12:48:50 -07002459 };
2460 // clang-format on
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002461 SendBroadcast("com.android.internal.intent.action.BUGREPORT_STARTED", am_args);
Felipe Lemedcd1f0d2016-08-04 12:48:50 -07002462 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002463 if (options_->use_control_socket) {
2464 dprintf(control_socket_fd_, "BEGIN:%s\n", path_.c_str());
Felipe Lemeaabfcae2016-07-29 09:49:04 -07002465 }
Felipe Leme71bbfc52015-11-23 14:14:51 -08002466 }
2467 }
2468
Nick Kralevichf3599b32016-01-25 15:05:16 -08002469 /* read /proc/cmdline before dropping root */
2470 FILE *cmdline = fopen("/proc/cmdline", "re");
2471 if (cmdline) {
2472 fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
2473 fclose(cmdline);
2474 }
2475
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002476 if (options_->do_vibrate) {
Felipe Leme35b8cf12017-02-10 15:47:29 -08002477 Vibrate(150);
John Michelau1f794c42012-09-17 11:20:19 -05002478 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002479
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002480 if (options_->do_fb && do_early_screenshot_) {
Greg Kaiser3ddc3fa2019-05-23 16:14:52 -07002481 MYLOGI("taking early screenshot\n");
2482 TakeScreenshot();
Felipe Lemee338bf62015-12-07 14:03:50 -08002483 }
2484
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002485 if (options_->do_zip_file && zip_file != nullptr) {
2486 if (chown(path_.c_str(), AID_SHELL, AID_SHELL)) {
2487 MYLOGE("Unable to change ownership of zip file %s: %s\n", path_.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -07002488 strerror(errno));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002489 }
2490 }
2491
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002492 int dup_stdout_fd;
2493 int dup_stderr_fd;
Felipe Leme71bbfc52015-11-23 14:14:51 -08002494 if (is_redirecting) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002495 // Redirect stderr to log_path_ for debugging.
Vishnu Nair20cf5032018-01-05 13:15:49 -08002496 TEMP_FAILURE_RETRY(dup_stderr_fd = dup(fileno(stderr)));
Nandana Dutta344cb62019-02-22 15:12:35 +00002497 if (!redirect_to_file(stderr, const_cast<char*>(log_path_.c_str()))) {
2498 return ERROR;
2499 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002500 if (chown(log_path_.c_str(), AID_SHELL, AID_SHELL)) {
2501 MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n", log_path_.c_str(),
2502 strerror(errno));
Felipe Leme6fe9db62016-02-12 09:04:16 -08002503 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002504
2505 // Redirect stdout to tmp_path_. This is the main bugreport entry and will be
2506 // moved into zip file later, if zipping.
Vishnu Nair20cf5032018-01-05 13:15:49 -08002507 TEMP_FAILURE_RETRY(dup_stdout_fd = dup(fileno(stdout)));
Nandana Dutt979388e2018-11-30 16:48:55 +00002508 // TODO: why not write to a file instead of stdout to overcome this problem?
Felipe Leme6e01fa62015-11-11 19:35:14 -08002509 /* TODO: rather than generating a text file now and zipping it later,
2510 it would be more efficient to redirect stdout to the zip entry
2511 directly, but the libziparchive doesn't support that option yet. */
Nandana Dutta344cb62019-02-22 15:12:35 +00002512 if (!redirect_to_file(stdout, const_cast<char*>(tmp_path_.c_str()))) {
2513 return ERROR;
2514 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002515 if (chown(tmp_path_.c_str(), AID_SHELL, AID_SHELL)) {
Felipe Leme6fe9db62016-02-12 09:04:16 -08002516 MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002517 tmp_path_.c_str(), strerror(errno));
Felipe Leme6fe9db62016-02-12 09:04:16 -08002518 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002519 }
Felipe Lemed8b94e52016-12-08 10:21:44 -08002520
2521 // Don't buffer stdout
2522 setvbuf(stdout, nullptr, _IONBF, 0);
2523
Felipe Leme608385d2016-02-01 10:35:38 -08002524 // NOTE: there should be no stdout output until now, otherwise it would break the header.
2525 // In particular, DurationReport objects should be created passing 'title, NULL', so their
Felipe Lemecbce55d2016-02-08 09:53:18 -08002526 // duration is logged into MYLOG instead.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002527 PrintHeader();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002528
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002529 if (options_->telephony_only) {
Jayachandran Ca94c7172017-06-10 15:08:12 -07002530 DumpstateTelephonyOnly();
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002531 DumpstateBoard();
2532 } else if (options_->wifi_only) {
mukesh agrawal253dad42018-01-23 21:59:59 -08002533 DumpstateWifiOnly();
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002534 } else {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002535 // Dump state for the default case. This also drops root.
Nandana Duttbbdb5b42019-03-12 10:52:56 +00002536 RunStatus s = DumpstateDefault();
2537 if (s != RunStatus::OK) {
2538 if (s == RunStatus::USER_CONSENT_TIMED_OUT) {
2539 HandleUserConsentDenied();
2540 }
2541 return s;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002542 }
Zhengyin Qian068ecc72016-08-10 16:48:14 -07002543 }
Felipe Leme71a74ac2016-03-17 15:43:25 -07002544
Felipe Leme55b42a62015-11-10 17:39:08 -08002545 /* close output if needed */
Felipe Leme71bbfc52015-11-23 14:14:51 -08002546 if (is_redirecting) {
Vishnu Nair20cf5032018-01-05 13:15:49 -08002547 TEMP_FAILURE_RETRY(dup2(dup_stdout_fd, fileno(stdout)));
Colin Crossf45fa6b2012-03-26 12:38:26 -07002548 }
2549
Nandana Duttd2f5f082019-01-18 17:13:52 +00002550 // Rename, and/or zip the (now complete) .tmp file within the internal directory.
Nandana Dutt9a76d202019-01-21 15:56:48 +00002551 if (options_->OutputToFile()) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002552 FinalizeFile();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002553 }
2554
Nandana Duttd2f5f082019-01-18 17:13:52 +00002555 // Share the final file with the caller if the user has consented.
2556 Dumpstate::RunStatus status = Dumpstate::RunStatus::OK;
2557 if (options_->bugreport_fd.get() != -1) {
2558 status = CopyBugreportIfUserConsented();
2559 if (status != Dumpstate::RunStatus::OK &&
2560 status != Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2561 // Do an early return if there were errors. We make an exception for consent
2562 // timing out because it's possible the user got distracted. In this case the
2563 // bugreport is not shared but made available for manual retrieval.
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002564 MYLOGI("User denied consent. Returning\n");
Nandana Duttd2f5f082019-01-18 17:13:52 +00002565 return status;
2566 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002567 if (options_->do_fb && options_->screenshot_fd.get() != -1) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00002568 bool copy_succeeded = android::os::CopyFileToFd(screenshot_path_,
2569 options_->screenshot_fd.get());
2570 if (copy_succeeded) {
2571 android::os::UnlinkAndLogOnError(screenshot_path_);
2572 }
2573 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002574 if (status == Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2575 MYLOGI(
2576 "Did not receive user consent yet."
2577 " Will not copy the bugreport artifacts to caller.\n");
Abhijeet Kaur57627412019-04-17 16:00:09 +01002578 const String16 incidentcompanion("incidentcompanion");
2579 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
2580 if (ics != nullptr) {
2581 MYLOGD("Canceling user consent request via incidentcompanion service\n");
2582 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
2583 consent_callback_.get());
2584 } else {
2585 MYLOGD("Unable to cancel user consent; incidentcompanion service unavailable\n");
2586 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002587 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00002588 }
2589
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002590 /* vibrate a few but shortly times to let user know it's finished */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002591 if (options_->do_vibrate) {
Takuya Ogawa47f644e2017-12-20 18:09:09 +09002592 for (int i = 0; i < 3; i++) {
2593 Vibrate(75);
2594 usleep((75 + 50) * 1000);
2595 }
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002596 }
2597
Jeff Brown1dc94e32014-09-11 14:15:27 -07002598 /* tell activity manager we're done */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002599 if (options_->do_broadcast) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002600 SendBugreportFinishedBroadcast();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002601 // Note that listener_ is notified in Run();
Jeff Sharkey27f9e6d2013-03-13 15:45:50 -07002602 }
2603
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002604 MYLOGD("Final progress: %d/%d (estimated %d)\n", progress_->Get(), progress_->GetMax(),
2605 progress_->GetInitialMax());
2606 progress_->Save();
2607 MYLOGI("done (id %d)\n", id_);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002608
Felipe Leme107a05f2016-03-08 15:11:15 -08002609 if (is_redirecting) {
Vishnu Nair20cf5032018-01-05 13:15:49 -08002610 TEMP_FAILURE_RETRY(dup2(dup_stderr_fd, fileno(stderr)));
Felipe Leme107a05f2016-03-08 15:11:15 -08002611 }
2612
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002613 if (options_->use_control_socket && control_socket_fd_ != -1) {
Felipe Lemee844a9d2016-09-21 15:01:39 -07002614 MYLOGD("Closing control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002615 close(control_socket_fd_);
Felipe Leme2628e9e2016-04-12 16:36:51 -07002616 }
2617
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002618 tombstone_data_.clear();
2619 anr_data_.clear();
Narayan Kamath6b9516c2017-10-27 11:15:51 +01002620
Nandana Duttd2f5f082019-01-18 17:13:52 +00002621 return (consent_callback_ != nullptr &&
2622 consent_callback_->getResult() == UserConsentResult::UNAVAILABLE)
2623 ? USER_CONSENT_TIMED_OUT
2624 : RunStatus::OK;
2625}
2626
2627void Dumpstate::CheckUserConsent(int32_t calling_uid, const android::String16& calling_package) {
2628 consent_callback_ = new ConsentCallback();
2629 const String16 incidentcompanion("incidentcompanion");
2630 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
2631 if (ics != nullptr) {
2632 MYLOGD("Checking user consent via incidentcompanion service\n");
2633 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
2634 calling_uid, calling_package, 0x1 /* FLAG_CONFIRMATION_DIALOG */,
2635 consent_callback_.get());
2636 } else {
2637 MYLOGD("Unable to check user consent; incidentcompanion service unavailable\n");
2638 }
2639}
2640
Nandana Duttbbdb5b42019-03-12 10:52:56 +00002641bool Dumpstate::IsUserConsentDenied() const {
2642 return ds.consent_callback_ != nullptr &&
2643 ds.consent_callback_->getResult() == UserConsentResult::DENIED;
2644}
2645
Nandana Duttd2f5f082019-01-18 17:13:52 +00002646void Dumpstate::CleanupFiles() {
2647 android::os::UnlinkAndLogOnError(tmp_path_);
2648 android::os::UnlinkAndLogOnError(screenshot_path_);
2649 android::os::UnlinkAndLogOnError(path_);
2650}
2651
2652Dumpstate::RunStatus Dumpstate::HandleUserConsentDenied() {
2653 MYLOGD("User denied consent; deleting files and returning\n");
2654 CleanupFiles();
2655 return USER_CONSENT_DENIED;
2656}
2657
2658Dumpstate::RunStatus Dumpstate::CopyBugreportIfUserConsented() {
2659 // If the caller has asked to copy the bugreport over to their directory, we need explicit
2660 // user consent.
2661 UserConsentResult consent_result = consent_callback_->getResult();
2662 if (consent_result == UserConsentResult::UNAVAILABLE) {
2663 // User has not responded yet.
2664 uint64_t elapsed_ms = consent_callback_->getElapsedTimeMs();
2665 if (elapsed_ms < USER_CONSENT_TIMEOUT_MS) {
2666 uint delay_seconds = (USER_CONSENT_TIMEOUT_MS - elapsed_ms) / 1000;
2667 MYLOGD("Did not receive user consent yet; going to wait for %d seconds", delay_seconds);
2668 sleep(delay_seconds);
2669 }
2670 consent_result = consent_callback_->getResult();
2671 }
2672 if (consent_result == UserConsentResult::DENIED) {
2673 // User has explicitly denied sharing with the app. To be safe delete the
2674 // internal bugreport & tmp files.
2675 return HandleUserConsentDenied();
2676 }
2677 if (consent_result == UserConsentResult::APPROVED) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00002678 bool copy_succeeded = android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
2679 if (copy_succeeded) {
2680 android::os::UnlinkAndLogOnError(path_);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002681 }
2682 return copy_succeeded ? Dumpstate::RunStatus::OK : Dumpstate::RunStatus::ERROR;
2683 } else if (consent_result == UserConsentResult::UNAVAILABLE) {
2684 // consent_result is still UNAVAILABLE. The user has likely not responded yet.
2685 // Since we do not have user consent to share the bugreport it does not get
2686 // copied over to the calling app but remains in the internal directory from
2687 // where the user can manually pull it.
2688 return Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT;
2689 }
2690 // Unknown result; must be a programming error.
2691 MYLOGE("Unknown user consent result:%d\n", consent_result);
2692 return Dumpstate::RunStatus::ERROR;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002693}
2694
Nandana Duttf02564e2019-02-15 15:24:24 +00002695Dumpstate::RunStatus Dumpstate::ParseCommandlineAndRun(int argc, char* argv[]) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002696 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
2697 Dumpstate::RunStatus status = options->Initialize(argc, argv);
2698 if (status == Dumpstate::RunStatus::OK) {
Nandana Duttf02564e2019-02-15 15:24:24 +00002699 SetOptions(std::move(options));
Nandana Duttd2f5f082019-01-18 17:13:52 +00002700 // When directly running dumpstate binary, the output is not expected to be written
2701 // to any external file descriptor.
Nandana Duttf02564e2019-02-15 15:24:24 +00002702 assert(options_->bugreport_fd.get() == -1);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002703
2704 // calling_uid and calling_package are for user consent to share the bugreport with
2705 // an app; they are irrelvant here because bugreport is only written to a local
2706 // directory, and not shared.
Nandana Duttf02564e2019-02-15 15:24:24 +00002707 status = Run(-1 /* calling_uid */, "" /* calling_package */);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002708 }
Nandana Duttf02564e2019-02-15 15:24:24 +00002709 return status;
2710}
2711
2712/* Main entry point for dumpstate binary. */
2713int run_main(int argc, char* argv[]) {
2714 Dumpstate::RunStatus status = ds.ParseCommandlineAndRun(argc, argv);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002715
2716 switch (status) {
2717 case Dumpstate::RunStatus::OK:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002718 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002719 case Dumpstate::RunStatus::HELP:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002720 ShowUsage();
2721 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002722 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002723 fprintf(stderr, "Invalid combination of args\n");
2724 ShowUsage();
2725 exit(1);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002726 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002727 FALLTHROUGH_INTENDED;
2728 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2729 FALLTHROUGH_INTENDED;
2730 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002731 exit(2);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002732 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002733}