blob: 483cb9e938d3068ffbde27848c69c70668b4c4a1 [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>
Sahana Raof35ed432019-07-12 10:47:52 +010061#include <hardware_legacy/power.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080062#include <hidl/ServiceManagement.h>
Felipe Leme75876a22016-10-27 16:31:27 -070063#include <openssl/sha.h>
Mark Salyzyn6c3d90f2016-09-27 14:55:27 -070064#include <private/android_filesystem_config.h>
65#include <private/android_logger.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080066#include <serviceutils/PriorityDumper.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070067#include <utils/StrongPointer.h>
Felipe Lemef0292972016-11-22 13:57:05 -080068#include "DumpstateInternal.h"
Vishnu Naire97d6122018-01-18 13:58:56 -080069#include "DumpstateSectionReporter.h"
Felipe Leme75876a22016-10-27 16:31:27 -070070#include "DumpstateService.h"
Colin Crossf45fa6b2012-03-26 12:38:26 -070071#include "dumpstate.h"
Felipe Leme6e01fa62015-11-11 19:35:14 -080072
Steven Morelandcb7ef822016-11-29 13:20:37 -080073using ::android::hardware::dumpstate::V1_0::IDumpstateDevice;
Vishnu Naire97d6122018-01-18 13:58:56 -080074using ::std::literals::chrono_literals::operator""ms;
75using ::std::literals::chrono_literals::operator""s;
Steven Morelandcb7ef822016-11-29 13:20:37 -080076
Felipe Leme47e9be22016-12-21 15:37:07 -080077// TODO: remove once moved to namespace
Vishnu Naire97d6122018-01-18 13:58:56 -080078using android::defaultServiceManager;
79using android::Dumpsys;
80using android::INVALID_OPERATION;
81using android::IServiceManager;
82using android::OK;
83using android::sp;
84using android::status_t;
85using android::String16;
86using android::String8;
87using android::TIMED_OUT;
88using android::UNKNOWN_ERROR;
89using android::Vector;
Nandana Dutt979388e2018-11-30 16:48:55 +000090using android::base::StringPrintf;
Nandana Duttd2f5f082019-01-18 17:13:52 +000091using android::os::IDumpstateListener;
Felipe Leme47e9be22016-12-21 15:37:07 -080092using android::os::dumpstate::CommandOptions;
93using android::os::dumpstate::DumpFileToFd;
Vishnu Naire97d6122018-01-18 13:58:56 -080094using android::os::dumpstate::DumpstateSectionReporter;
Vishnu Naire97d6122018-01-18 13:58:56 -080095using android::os::dumpstate::PropertiesHelper;
Felipe Leme47e9be22016-12-21 15:37:07 -080096
Nandana Duttd2f5f082019-01-18 17:13:52 +000097typedef Dumpstate::ConsentCallback::ConsentResult UserConsentResult;
98
Colin Crossf45fa6b2012-03-26 12:38:26 -070099/* read before root is shed */
100static char cmdline_buf[16384] = "(unknown)";
Yi Kong19d5c002018-07-20 13:39:55 -0700101static const char *dump_traces_path = nullptr;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000102static const uint64_t USER_CONSENT_TIMEOUT_MS = 30 * 1000;
Colin Crossf45fa6b2012-03-26 12:38:26 -0700103
Felipe Leme1d486fe2016-10-14 18:06:47 -0700104// TODO: variables and functions below should be part of dumpstate object
105
Felipe Leme635ca312016-01-05 14:23:02 -0800106static std::set<std::string> mount_points;
107void add_mountinfo();
Felipe Leme78f2c862015-12-21 09:55:22 -0800108
Todd Poynor2a83daa2013-11-22 15:44:22 -0800109#define PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops"
Mark Salyzyn7d0a7622016-06-24 14:06:15 -0700110#define ALT_PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops-0"
Wei Wang509bb5d2017-06-09 14:42:12 -0700111#define BLK_DEV_SYS_DIR "/sys/block"
Todd Poynor2a83daa2013-11-22 15:44:22 -0800112
Felipe Lemee82a27d2016-01-05 13:35:44 -0800113#define RECOVERY_DIR "/cache/recovery"
Mark Salyzynd6ab0112016-03-25 12:56:39 -0700114#define RECOVERY_DATA_DIR "/data/misc/recovery"
Tianjie Xu75d53362018-04-11 16:42:28 -0700115#define UPDATE_ENGINE_LOG_DIR "/data/misc/update_engine_log"
Mark Salyzyn4d42dea2016-04-01 10:03:14 -0700116#define LOGPERSIST_DATA_DIR "/data/misc/logd"
David Brazdild2991962016-06-03 14:40:44 +0100117#define PROFILE_DATA_DIR_CUR "/data/misc/profiles/cur"
118#define PROFILE_DATA_DIR_REF "/data/misc/profiles/ref"
Benedict Wong8f9d8a42019-01-03 16:19:38 -0800119#define XFRM_STAT_PROC_FILE "/proc/net/xfrm_stat"
Erik Kline08165202016-05-30 11:55:44 +0900120#define WLUTIL "/vendor/xbin/wlutil"
Vishnu Nair36b4cdb2017-11-17 10:27:05 -0800121#define WMTRACE_DATA_DIR "/data/misc/wmtrace"
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700122
Narayan Kamath8f788292017-05-25 13:20:39 +0100123// TODO(narayan): Since this information has to be kept in sync
124// with tombstoned, we should just put it in a common header.
125//
126// File: system/core/debuggerd/tombstoned/tombstoned.cpp
Narayan Kamathbd863722017-06-01 18:50:12 +0100127static const std::string TOMBSTONE_DIR = "/data/tombstones/";
128static const std::string TOMBSTONE_FILE_PREFIX = "tombstone_";
129static const std::string ANR_DIR = "/data/anr/";
130static const std::string ANR_FILE_PREFIX = "anr_";
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700131
Felipe Lemee844a9d2016-09-21 15:01:39 -0700132// TODO: temporary variables and functions used during C++ refactoring
133static Dumpstate& ds = Dumpstate::GetInstance();
Nandana Dutt979388e2018-11-30 16:48:55 +0000134
Nandana Duttbbdb5b42019-03-12 10:52:56 +0000135#define RETURN_IF_USER_DENIED_CONSENT() \
136 if (ds.IsUserConsentDenied()) { \
137 MYLOGE("Returning early as user denied consent to share bugreport with calling app."); \
138 return Dumpstate::RunStatus::USER_CONSENT_DENIED; \
139 }
140
141// Runs func_ptr, but checks user consent before and after running it. Returns USER_CONSENT_DENIED
142// if consent is found to be denied.
143#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(func_ptr, ...) \
144 RETURN_IF_USER_DENIED_CONSENT(); \
145 func_ptr(__VA_ARGS__); \
146 RETURN_IF_USER_DENIED_CONSENT();
147
Sahana Raof35ed432019-07-12 10:47:52 +0100148static const char* WAKE_LOCK_NAME = "dumpstate_wakelock";
149
Nandana Dutt979388e2018-11-30 16:48:55 +0000150namespace android {
151namespace os {
152namespace {
153
154static int Open(std::string path, int flags, mode_t mode = 0) {
155 int fd = TEMP_FAILURE_RETRY(open(path.c_str(), flags, mode));
156 if (fd == -1) {
157 MYLOGE("open(%s, %s)\n", path.c_str(), strerror(errno));
158 }
159 return fd;
160}
161
Nandana Dutt979388e2018-11-30 16:48:55 +0000162
163static int OpenForRead(std::string path) {
164 return Open(path, O_RDONLY | O_CLOEXEC | O_NOFOLLOW);
165}
166
167bool CopyFile(int in_fd, int out_fd) {
168 char buf[4096];
169 ssize_t byte_count;
170 while ((byte_count = TEMP_FAILURE_RETRY(read(in_fd, buf, sizeof(buf)))) > 0) {
171 if (!android::base::WriteFully(out_fd, buf, byte_count)) {
172 return false;
173 }
174 }
175 return (byte_count != -1);
176}
177
178static bool CopyFileToFd(const std::string& input_file, int out_fd) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000179 MYLOGD("Going to copy file (%s) to %d\n", input_file.c_str(), out_fd);
Nandana Dutt979388e2018-11-30 16:48:55 +0000180
181 // Obtain a handle to the source file.
182 android::base::unique_fd in_fd(OpenForRead(input_file));
183 if (out_fd != -1 && in_fd.get() != -1) {
184 if (CopyFile(in_fd.get(), out_fd)) {
185 return true;
186 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000187 MYLOGE("Failed to copy file: %s\n", strerror(errno));
Nandana Dutt979388e2018-11-30 16:48:55 +0000188 }
189 return false;
190}
191
Nandana Duttd2f5f082019-01-18 17:13:52 +0000192static bool UnlinkAndLogOnError(const std::string& file) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000193 if (unlink(file.c_str())) {
194 MYLOGE("Failed to unlink file (%s): %s\n", file.c_str(), strerror(errno));
Nandana Duttd2f5f082019-01-18 17:13:52 +0000195 return false;
196 }
197 return true;
198}
Nandana Dutt979388e2018-11-30 16:48:55 +0000199
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +0000200static bool IsFileEmpty(const std::string& file_path) {
201 std::ifstream file(file_path, std::ios::binary | std::ios::ate);
202 if(file.bad()) {
203 MYLOGE("Cannot open file: %s\n", file_path.c_str());
204 return true;
205 }
206 return file.tellg() <= 0;
207}
208
Nandana Dutt979388e2018-11-30 16:48:55 +0000209} // namespace
210} // namespace os
211} // namespace android
212
Felipe Leme678727a2016-09-21 17:22:11 -0700213static int RunCommand(const std::string& title, const std::vector<std::string>& fullCommand,
214 const CommandOptions& options = CommandOptions::DEFAULT) {
215 return ds.RunCommand(title, fullCommand, options);
216}
217static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
Felipe Lemebda15a02016-11-16 17:48:25 -0800218 const CommandOptions& options = Dumpstate::DEFAULT_DUMPSYS,
Vishnu Nair6921f802017-11-22 09:17:23 -0800219 long dumpsysTimeoutMs = 0) {
220 return ds.RunDumpsys(title, dumpsysArgs, options, dumpsysTimeoutMs);
Felipe Leme678727a2016-09-21 17:22:11 -0700221}
222static int DumpFile(const std::string& title, const std::string& path) {
223 return ds.DumpFile(title, path);
224}
Felipe Lemee82a27d2016-01-05 13:35:44 -0800225
Felipe Lemee844a9d2016-09-21 15:01:39 -0700226// Relative directory (inside the zip) for all files copied as-is into the bugreport.
227static const std::string ZIP_ROOT_DIR = "FS";
228
Vishnu Naire97d6122018-01-18 13:58:56 -0800229static const std::string kProtoPath = "proto/";
230static const std::string kProtoExt = ".proto";
Jie Song9fbfad02017-06-20 16:29:42 -0700231static const std::string kDumpstateBoardFiles[] = {
232 "dumpstate_board.txt",
Felipe Leme95d6ca52017-08-01 16:35:56 -0700233 "dumpstate_board.bin"
Jie Song9fbfad02017-06-20 16:29:42 -0700234};
235static const int NUM_OF_DUMPS = arraysize(kDumpstateBoardFiles);
236
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700237static constexpr char PROPERTY_EXTRA_OPTIONS[] = "dumpstate.options";
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700238static constexpr char PROPERTY_LAST_ID[] = "dumpstate.last_id";
Felipe Lemed071c682016-10-20 16:48:00 -0700239static constexpr char PROPERTY_VERSION[] = "dumpstate.version";
Naveen Kallab53a1c92017-03-16 18:17:25 -0700240static constexpr char PROPERTY_EXTRA_TITLE[] = "dumpstate.options.title";
241static constexpr char PROPERTY_EXTRA_DESCRIPTION[] = "dumpstate.options.description";
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700242
Felipe Lemef0292972016-11-22 13:57:05 -0800243static const CommandOptions AS_ROOT_20 = CommandOptions::WithTimeout(20).AsRoot().Build();
244
Narayan Kamath8f788292017-05-25 13:20:39 +0100245/*
Narayan Kamathbd863722017-06-01 18:50:12 +0100246 * Returns a vector of dump fds under |dir_path| with a given |file_prefix|.
247 * The returned vector is sorted by the mtimes of the dumps. If |limit_by_mtime|
248 * is set, the vector only contains files that were written in the last 30 minutes.
Andreas Gamped0d76952017-08-22 13:08:37 -0700249 * If |limit_by_count| is set, the vector only contains the ten latest files.
Narayan Kamath8f788292017-05-25 13:20:39 +0100250 */
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700251static std::vector<DumpData> GetDumpFds(const std::string& dir_path,
252 const std::string& file_prefix,
253 bool limit_by_mtime,
254 bool limit_by_count = true) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100255 const time_t thirty_minutes_ago = ds.now_ - 60 * 30;
256
Narayan Kamathbd863722017-06-01 18:50:12 +0100257 std::unique_ptr<DIR, decltype(&closedir)> dump_dir(opendir(dir_path.c_str()), closedir);
Narayan Kamath8f788292017-05-25 13:20:39 +0100258
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700259 if (dump_dir == nullptr) {
260 MYLOGW("Unable to open directory %s: %s\n", dir_path.c_str(), strerror(errno));
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700261 return std::vector<DumpData>();
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700262 }
263
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700264 std::vector<DumpData> dump_data;
Narayan Kamathbd863722017-06-01 18:50:12 +0100265 struct dirent* entry = nullptr;
266 while ((entry = readdir(dump_dir.get()))) {
267 if (entry->d_type != DT_REG) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100268 continue;
269 }
270
Narayan Kamathbd863722017-06-01 18:50:12 +0100271 const std::string base_name(entry->d_name);
272 if (base_name.find(file_prefix) != 0) {
273 continue;
274 }
275
276 const std::string abs_path = dir_path + base_name;
277 android::base::unique_fd fd(
278 TEMP_FAILURE_RETRY(open(abs_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW | O_NONBLOCK)));
279 if (fd == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700280 MYLOGW("Unable to open dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamathbd863722017-06-01 18:50:12 +0100281 break;
282 }
283
284 struct stat st = {};
285 if (fstat(fd, &st) == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700286 MYLOGW("Unable to stat dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamath8f788292017-05-25 13:20:39 +0100287 continue;
288 }
289
Narayan Kamath3f31b632018-02-22 19:42:36 +0000290 if (limit_by_mtime && st.st_mtime < thirty_minutes_ago) {
Narayan Kamathbd863722017-06-01 18:50:12 +0100291 MYLOGI("Excluding stale dump file: %s\n", abs_path.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100292 continue;
293 }
294
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700295 dump_data.emplace_back(DumpData{abs_path, std::move(fd), st.st_mtime});
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700296 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100297
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700298 // Sort in descending modification time so that we only keep the newest
299 // reports if |limit_by_count| is true.
300 std::sort(dump_data.begin(), dump_data.end(),
301 [](const DumpData& d1, const DumpData& d2) { return d1.mtime > d2.mtime; });
Narayan Kamath8f788292017-05-25 13:20:39 +0100302
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700303 if (limit_by_count && dump_data.size() > 10) {
304 dump_data.erase(dump_data.begin() + 10, dump_data.end());
Andreas Gamped0d76952017-08-22 13:08:37 -0700305 }
306
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700307 return dump_data;
Narayan Kamath8f788292017-05-25 13:20:39 +0100308}
309
Narayan Kamathbd863722017-06-01 18:50:12 +0100310static bool AddDumps(const std::vector<DumpData>::const_iterator start,
311 const std::vector<DumpData>::const_iterator end,
312 const char* type_name, const bool add_to_zip) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100313 bool dumped = false;
Narayan Kamathbd863722017-06-01 18:50:12 +0100314 for (auto it = start; it != end; ++it) {
315 const std::string& name = it->name;
316 const int fd = it->fd;
Narayan Kamath8f788292017-05-25 13:20:39 +0100317 dumped = true;
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100318
319 // Seek to the beginning of the file before dumping any data. A given
320 // DumpData entry might be dumped multiple times in the report.
321 //
322 // For example, the most recent ANR entry is dumped to the body of the
323 // main entry and it also shows up as a separate entry in the bugreport
324 // ZIP file.
325 if (lseek(fd, 0, SEEK_SET) != static_cast<off_t>(0)) {
326 MYLOGE("Unable to add %s to zip file, lseek failed: %s\n", name.c_str(),
327 strerror(errno));
328 }
329
Narayan Kamath8f788292017-05-25 13:20:39 +0100330 if (ds.IsZipping() && add_to_zip) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800331 if (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + name, fd, /* timeout = */ 0ms) != OK) {
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100332 MYLOGE("Unable to add %s to zip file, addZipEntryFromFd failed\n", name.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100333 }
334 } else {
335 dump_file_from_fd(type_name, name.c_str(), fd);
336 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100337 }
338
339 return dumped;
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700340}
341
Felipe Leme635ca312016-01-05 14:23:02 -0800342// for_each_pid() callback to get mount info about a process.
Felipe Leme4c2d6632016-09-28 14:32:00 -0700343void do_mountinfo(int pid, const char* name __attribute__((unused))) {
Felipe Leme635ca312016-01-05 14:23:02 -0800344 char path[PATH_MAX];
345
346 // Gets the the content of the /proc/PID/ns/mnt link, so only unique mount points
347 // are added.
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700348 snprintf(path, sizeof(path), "/proc/%d/ns/mnt", pid);
Felipe Leme635ca312016-01-05 14:23:02 -0800349 char linkname[PATH_MAX];
350 ssize_t r = readlink(path, linkname, PATH_MAX);
351 if (r == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800352 MYLOGE("Unable to read link for %s: %s\n", path, strerror(errno));
Felipe Leme635ca312016-01-05 14:23:02 -0800353 return;
354 }
355 linkname[r] = '\0';
356
357 if (mount_points.find(linkname) == mount_points.end()) {
358 // First time this mount point was found: add it
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700359 snprintf(path, sizeof(path), "/proc/%d/mountinfo", pid);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700360 if (ds.AddZipEntry(ZIP_ROOT_DIR + path, path)) {
Felipe Leme635ca312016-01-05 14:23:02 -0800361 mount_points.insert(linkname);
362 } else {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800363 MYLOGE("Unable to add mountinfo %s to zip file\n", path);
Felipe Leme635ca312016-01-05 14:23:02 -0800364 }
365 }
366}
367
368void add_mountinfo() {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700369 if (!ds.IsZipping()) return;
Felipe Leme678727a2016-09-21 17:22:11 -0700370 std::string title = "MOUNT INFO";
Felipe Leme635ca312016-01-05 14:23:02 -0800371 mount_points.clear();
Felipe Leme46b85da2016-11-21 17:40:45 -0800372 DurationReporter duration_reporter(title, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700373 for_each_pid(do_mountinfo, nullptr);
374 MYLOGD("%s: %d entries added to zip file\n", title.c_str(), (int)mount_points.size());
Felipe Leme635ca312016-01-05 14:23:02 -0800375}
376
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700377static void dump_dev_files(const char *title, const char *driverpath, const char *filename)
378{
379 DIR *d;
380 struct dirent *de;
381 char path[PATH_MAX];
382
383 d = opendir(driverpath);
Yi Kong19d5c002018-07-20 13:39:55 -0700384 if (d == nullptr) {
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700385 return;
386 }
387
388 while ((de = readdir(d))) {
389 if (de->d_type != DT_LNK) {
390 continue;
391 }
392 snprintf(path, sizeof(path), "%s/%s/%s", driverpath, de->d_name, filename);
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700393 DumpFile(title, path);
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700394 }
395
396 closedir(d);
397}
398
Mark Salyzyn326842f2015-04-30 09:49:41 -0700399static bool skip_not_stat(const char *path) {
400 static const char stat[] = "/stat";
401 size_t len = strlen(path);
402 if (path[len - 1] == '/') { /* Directory? */
403 return false;
404 }
405 return strcmp(path + len - sizeof(stat) + 1, stat); /* .../stat? */
406}
407
Felipe Leme4c2d6632016-09-28 14:32:00 -0700408static bool skip_none(const char* path __attribute__((unused))) {
Felipe Lemee82a27d2016-01-05 13:35:44 -0800409 return false;
410}
411
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700412unsigned long worst_write_perf = 20000; /* in KB/s */
Mark Salyzyn326842f2015-04-30 09:49:41 -0700413
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800414//
415// stat offsets
416// Name units description
417// ---- ----- -----------
418// read I/Os requests number of read I/Os processed
419#define __STAT_READ_IOS 0
420// read merges requests number of read I/Os merged with in-queue I/O
421#define __STAT_READ_MERGES 1
422// read sectors sectors number of sectors read
423#define __STAT_READ_SECTORS 2
424// read ticks milliseconds total wait time for read requests
425#define __STAT_READ_TICKS 3
426// write I/Os requests number of write I/Os processed
427#define __STAT_WRITE_IOS 4
428// write merges requests number of write I/Os merged with in-queue I/O
429#define __STAT_WRITE_MERGES 5
430// write sectors sectors number of sectors written
431#define __STAT_WRITE_SECTORS 6
432// write ticks milliseconds total wait time for write requests
433#define __STAT_WRITE_TICKS 7
434// in_flight requests number of I/Os currently in flight
435#define __STAT_IN_FLIGHT 8
436// io_ticks milliseconds total time this block device has been active
437#define __STAT_IO_TICKS 9
438// time_in_queue milliseconds total wait time for all requests
439#define __STAT_IN_QUEUE 10
440#define __STAT_NUMBER_FIELD 11
441//
442// read I/Os, write I/Os
443// =====================
444//
445// These values increment when an I/O request completes.
446//
447// read merges, write merges
448// =========================
449//
450// These values increment when an I/O request is merged with an
451// already-queued I/O request.
452//
453// read sectors, write sectors
454// ===========================
455//
456// These values count the number of sectors read from or written to this
457// block device. The "sectors" in question are the standard UNIX 512-byte
458// sectors, not any device- or filesystem-specific block size. The
459// counters are incremented when the I/O completes.
460#define SECTOR_SIZE 512
461//
462// read ticks, write ticks
463// =======================
464//
465// These values count the number of milliseconds that I/O requests have
466// waited on this block device. If there are multiple I/O requests waiting,
467// these values will increase at a rate greater than 1000/second; for
468// example, if 60 read requests wait for an average of 30 ms, the read_ticks
469// field will increase by 60*30 = 1800.
470//
471// in_flight
472// =========
473//
474// This value counts the number of I/O requests that have been issued to
475// the device driver but have not yet completed. It does not include I/O
476// requests that are in the queue but not yet issued to the device driver.
477//
478// io_ticks
479// ========
480//
481// This value counts the number of milliseconds during which the device has
482// had I/O requests queued.
483//
484// time_in_queue
485// =============
486//
487// This value counts the number of milliseconds that I/O requests have waited
488// on this block device. If there are multiple I/O requests waiting, this
489// value will increase as the product of the number of milliseconds times the
490// number of requests waiting (see "read ticks" above for an example).
491#define S_TO_MS 1000
492//
493
Mark Salyzyn326842f2015-04-30 09:49:41 -0700494static int dump_stat_from_fd(const char *title __unused, const char *path, int fd) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800495 unsigned long long fields[__STAT_NUMBER_FIELD];
Mark Salyzyn326842f2015-04-30 09:49:41 -0700496 bool z;
Yi Kong19d5c002018-07-20 13:39:55 -0700497 char *cp, *buffer = nullptr;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700498 size_t i = 0;
Josh Gao7c4258c2018-06-25 13:40:08 -0700499 FILE *fp = fdopen(dup(fd), "rb");
Mark Salyzyn326842f2015-04-30 09:49:41 -0700500 getline(&buffer, &i, fp);
501 fclose(fp);
502 if (!buffer) {
503 return -errno;
504 }
505 i = strlen(buffer);
506 while ((i > 0) && (buffer[i - 1] == '\n')) {
507 buffer[--i] = '\0';
508 }
509 if (!*buffer) {
510 free(buffer);
511 return 0;
512 }
513 z = true;
514 for (cp = buffer, i = 0; i < (sizeof(fields) / sizeof(fields[0])); ++i) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800515 fields[i] = strtoull(cp, &cp, 10);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700516 if (fields[i] != 0) {
517 z = false;
518 }
519 }
520 if (z) { /* never accessed */
521 free(buffer);
522 return 0;
523 }
524
Wei Wang509bb5d2017-06-09 14:42:12 -0700525 if (!strncmp(path, BLK_DEV_SYS_DIR, sizeof(BLK_DEV_SYS_DIR) - 1)) {
526 path += sizeof(BLK_DEV_SYS_DIR) - 1;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700527 }
Wei Wang1dc1ef52017-06-12 11:28:37 -0700528
529 printf("%-30s:%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s\n%-30s:\t%s\n", "Block-Dev",
530 "R-IOs", "R-merg", "R-sect", "R-wait", "W-IOs", "W-merg", "W-sect",
531 "W-wait", "in-fli", "activ", "T-wait", path, buffer);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700532 free(buffer);
533
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800534 if (fields[__STAT_IO_TICKS]) {
535 unsigned long read_perf = 0;
536 unsigned long read_ios = 0;
537 if (fields[__STAT_READ_TICKS]) {
538 unsigned long long divisor = fields[__STAT_READ_TICKS]
539 * fields[__STAT_IO_TICKS];
540 read_perf = ((unsigned long long)SECTOR_SIZE
541 * fields[__STAT_READ_SECTORS]
542 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
543 / divisor;
544 read_ios = ((unsigned long long)S_TO_MS * fields[__STAT_READ_IOS]
545 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
546 / divisor;
547 }
548
549 unsigned long write_perf = 0;
550 unsigned long write_ios = 0;
551 if (fields[__STAT_WRITE_TICKS]) {
552 unsigned long long divisor = fields[__STAT_WRITE_TICKS]
553 * fields[__STAT_IO_TICKS];
554 write_perf = ((unsigned long long)SECTOR_SIZE
555 * fields[__STAT_WRITE_SECTORS]
556 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
557 / divisor;
558 write_ios = ((unsigned long long)S_TO_MS * fields[__STAT_WRITE_IOS]
559 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
560 / divisor;
561 }
562
563 unsigned queue = (fields[__STAT_IN_QUEUE]
564 + (fields[__STAT_IO_TICKS] >> 1))
565 / fields[__STAT_IO_TICKS];
566
567 if (!write_perf && !write_ios) {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700568 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 -0800569 } else {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700570 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 -0800571 read_ios, write_perf, write_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800572 }
573
574 /* bugreport timeout factor adjustment */
575 if ((write_perf > 1) && (write_perf < worst_write_perf)) {
576 worst_write_perf = write_perf;
577 }
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700578 }
Mark Salyzyn326842f2015-04-30 09:49:41 -0700579 return 0;
580}
581
Yao Chenbe3bbc12018-01-17 16:31:10 -0800582static const long MINIMUM_LOGCAT_TIMEOUT_MS = 50000;
583
584/* timeout in ms to read a list of buffers */
585static unsigned long logcat_timeout(const std::vector<std::string>& buffers) {
586 unsigned long timeout_ms = 0;
587 for (const auto& buffer : buffers) {
588 log_id_t id = android_name_to_log_id(buffer.c_str());
589 unsigned long property_size = __android_logger_get_buffer_size(id);
590 /* Engineering margin is ten-fold our guess */
591 timeout_ms += 10 * (property_size + worst_write_perf) / worst_write_perf;
592 }
593 return timeout_ms > MINIMUM_LOGCAT_TIMEOUT_MS ? timeout_ms : MINIMUM_LOGCAT_TIMEOUT_MS;
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700594}
595
Nandana Duttd2f5f082019-01-18 17:13:52 +0000596Dumpstate::ConsentCallback::ConsentCallback() : result_(UNAVAILABLE), start_time_(Nanotime()) {
597}
598
599android::binder::Status Dumpstate::ConsentCallback::onReportApproved() {
600 std::lock_guard<std::mutex> lock(lock_);
601 result_ = APPROVED;
602 MYLOGD("User approved consent to share bugreport\n");
603 return android::binder::Status::ok();
604}
605
606android::binder::Status Dumpstate::ConsentCallback::onReportDenied() {
607 std::lock_guard<std::mutex> lock(lock_);
608 result_ = DENIED;
609 MYLOGW("User denied consent to share bugreport\n");
610 return android::binder::Status::ok();
611}
612
613UserConsentResult Dumpstate::ConsentCallback::getResult() {
614 std::lock_guard<std::mutex> lock(lock_);
615 return result_;
616}
617
618uint64_t Dumpstate::ConsentCallback::getElapsedTimeMs() const {
619 return Nanotime() - start_time_;
620}
621
Felipe Leme2b9b06c2016-10-14 09:13:06 -0700622void Dumpstate::PrintHeader() const {
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700623 std::string build, fingerprint, radio, bootloader, network;
624 char date[80];
Colin Crossf45fa6b2012-03-26 12:38:26 -0700625
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700626 build = android::base::GetProperty("ro.build.display.id", "(unknown)");
627 fingerprint = android::base::GetProperty("ro.build.fingerprint", "(unknown)");
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700628 radio = android::base::GetProperty("gsm.version.baseband", "(unknown)");
629 bootloader = android::base::GetProperty("ro.bootloader", "(unknown)");
630 network = android::base::GetProperty("gsm.operator.alpha", "(unknown)");
Felipe Lemebbaf3c12016-10-11 14:32:25 -0700631 strftime(date, sizeof(date), "%Y-%m-%d %H:%M:%S", localtime(&now_));
Colin Crossf45fa6b2012-03-26 12:38:26 -0700632
Felipe Lemed8b94e52016-12-08 10:21:44 -0800633 printf("========================================================\n");
634 printf("== dumpstate: %s\n", date);
635 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -0700636
Felipe Lemed8b94e52016-12-08 10:21:44 -0800637 printf("\n");
638 printf("Build: %s\n", build.c_str());
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700639 // NOTE: fingerprint entry format is important for other tools.
Felipe Lemed8b94e52016-12-08 10:21:44 -0800640 printf("Build fingerprint: '%s'\n", fingerprint.c_str());
641 printf("Bootloader: %s\n", bootloader.c_str());
642 printf("Radio: %s\n", radio.c_str());
643 printf("Network: %s\n", network.c_str());
Colin Crossf45fa6b2012-03-26 12:38:26 -0700644
Felipe Lemed8b94e52016-12-08 10:21:44 -0800645 printf("Kernel: ");
Felipe Lemef0292972016-11-22 13:57:05 -0800646 DumpFileToFd(STDOUT_FILENO, "", "/proc/version");
Felipe Lemed8b94e52016-12-08 10:21:44 -0800647 printf("Command line: %s\n", strtok(cmdline_buf, "\n"));
Felipe Leme7709f8a2017-12-05 09:30:09 -0800648 printf("Uptime: ");
649 RunCommandToFd(STDOUT_FILENO, "", {"uptime", "-p"},
650 CommandOptions::WithTimeout(1).Always().Build());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800651 printf("Bugreport format version: %s\n", version_.c_str());
652 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 +0100653 PropertiesHelper::IsDryRun(), options_->args.c_str(), options_->extra_options.c_str());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800654 printf("\n");
Felipe Leme78f2c862015-12-21 09:55:22 -0800655}
656
Felipe Leme24b66ee2016-06-16 10:55:26 -0700657// List of file extensions that can cause a zip file attachment to be rejected by some email
658// service providers.
659static const std::set<std::string> PROBLEMATIC_FILE_EXTENSIONS = {
660 ".ade", ".adp", ".bat", ".chm", ".cmd", ".com", ".cpl", ".exe", ".hta", ".ins", ".isp",
661 ".jar", ".jse", ".lib", ".lnk", ".mde", ".msc", ".msp", ".mst", ".pif", ".scr", ".sct",
662 ".shb", ".sys", ".vb", ".vbe", ".vbs", ".vxd", ".wsc", ".wsf", ".wsh"
663};
664
Vishnu Naire97d6122018-01-18 13:58:56 -0800665status_t Dumpstate::AddZipEntryFromFd(const std::string& entry_name, int fd,
666 std::chrono::milliseconds timeout = 0ms) {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700667 if (!IsZipping()) {
668 MYLOGD("Not adding zip entry %s from fd because it's not a zipped bugreport\n",
669 entry_name.c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -0800670 return INVALID_OPERATION;
Felipe Leme111b9d02016-02-03 09:28:24 -0800671 }
Felipe Leme24b66ee2016-06-16 10:55:26 -0700672 std::string valid_name = entry_name;
673
674 // Rename extension if necessary.
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -0700675 size_t idx = entry_name.rfind('.');
Felipe Leme24b66ee2016-06-16 10:55:26 -0700676 if (idx != std::string::npos) {
677 std::string extension = entry_name.substr(idx);
678 std::transform(extension.begin(), extension.end(), extension.begin(), ::tolower);
679 if (PROBLEMATIC_FILE_EXTENSIONS.count(extension) != 0) {
680 valid_name = entry_name + ".renamed";
681 MYLOGI("Renaming entry %s to %s\n", entry_name.c_str(), valid_name.c_str());
682 }
683 }
684
Felipe Leme6fe9db62016-02-12 09:04:16 -0800685 // Logging statement below is useful to time how long each entry takes, but it's too verbose.
686 // MYLOGD("Adding zip entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700687 int32_t err = zip_writer_->StartEntryWithTime(valid_name.c_str(), ZipWriter::kCompress,
688 get_mtime(fd, ds.now_));
Felipe Leme1d486fe2016-10-14 18:06:47 -0700689 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700690 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", valid_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700691 ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800692 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800693 }
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000694 bool finished_entry = false;
695 auto finish_entry = [this, &finished_entry] {
696 if (!finished_entry) {
697 // This should only be called when we're going to return an earlier error,
698 // which would've been logged. This may imply the file is already corrupt
699 // and any further logging from FinishEntry is more likely to mislead than
700 // not.
701 this->zip_writer_->FinishEntry();
702 }
703 };
704 auto scope_guard = android::base::make_scope_guard(finish_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -0800705 auto start = std::chrono::steady_clock::now();
706 auto end = start + timeout;
707 struct pollfd pfd = {fd, POLLIN};
Felipe Lemee82a27d2016-01-05 13:35:44 -0800708
Felipe Leme770410d2016-01-26 17:07:14 -0800709 std::vector<uint8_t> buffer(65536);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800710 while (1) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800711 if (timeout.count() > 0) {
712 // lambda to recalculate the timeout.
713 auto time_left_ms = [end]() {
714 auto now = std::chrono::steady_clock::now();
715 auto diff = std::chrono::duration_cast<std::chrono::milliseconds>(end - now);
716 return std::max(diff.count(), 0LL);
717 };
718
719 int rc = TEMP_FAILURE_RETRY(poll(&pfd, 1, time_left_ms()));
720 if (rc < 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000721 MYLOGE("Error in poll while adding from fd to zip entry %s:%s\n",
722 entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800723 return -errno;
724 } else if (rc == 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000725 MYLOGE("Timed out adding from fd to zip entry %s:%s Timeout:%lldms\n",
Vishnu Naire97d6122018-01-18 13:58:56 -0800726 entry_name.c_str(), strerror(errno), timeout.count());
727 return TIMED_OUT;
728 }
729 }
730
Zach Riggle22200402016-08-18 01:01:24 -0400731 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800732 if (bytes_read == 0) {
733 break;
734 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800735 MYLOGE("read(%s): %s\n", entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800736 return -errno;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800737 }
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700738 err = zip_writer_->WriteBytes(buffer.data(), bytes_read);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800739 if (err) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700740 MYLOGE("zip_writer_->WriteBytes(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800741 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800742 }
743 }
744
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700745 err = zip_writer_->FinishEntry();
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000746 finished_entry = true;
Felipe Leme1d486fe2016-10-14 18:06:47 -0700747 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700748 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800749 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800750 }
751
Vishnu Naire97d6122018-01-18 13:58:56 -0800752 return OK;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800753}
754
Felipe Leme1d486fe2016-10-14 18:06:47 -0700755bool Dumpstate::AddZipEntry(const std::string& entry_name, const std::string& entry_path) {
756 android::base::unique_fd fd(
757 TEMP_FAILURE_RETRY(open(entry_path.c_str(), O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
Andreas Gampeaff68432016-07-18 18:01:27 -0700758 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800759 MYLOGE("open(%s): %s\n", entry_path.c_str(), strerror(errno));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800760 return false;
761 }
762
Vishnu Naire97d6122018-01-18 13:58:56 -0800763 return (AddZipEntryFromFd(entry_name, fd.get()) == OK);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800764}
765
766/* adds a file to the existing zipped bugreport */
Felipe Leme4c2d6632016-09-28 14:32:00 -0700767static int _add_file_from_fd(const char* title __attribute__((unused)), const char* path, int fd) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800768 return (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + path, fd) == OK) ? 0 : 1;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800769}
770
Felipe Leme1d486fe2016-10-14 18:06:47 -0700771void Dumpstate::AddDir(const std::string& dir, bool recursive) {
772 if (!IsZipping()) {
773 MYLOGD("Not adding dir %s because it's not a zipped bugreport\n", dir.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800774 return;
775 }
Felipe Leme678727a2016-09-21 17:22:11 -0700776 MYLOGD("Adding dir %s (recursive: %d)\n", dir.c_str(), recursive);
Felipe Leme46b85da2016-11-21 17:40:45 -0800777 DurationReporter duration_reporter(dir, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700778 dump_files("", dir.c_str(), recursive ? skip_none : is_dir, _add_file_from_fd);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800779}
780
Felipe Leme1d486fe2016-10-14 18:06:47 -0700781bool Dumpstate::AddTextZipEntry(const std::string& entry_name, const std::string& content) {
782 if (!IsZipping()) {
783 MYLOGD("Not adding text zip entry %s because it's not a zipped bugreport\n",
784 entry_name.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800785 return false;
786 }
Felipe Lemecbce55d2016-02-08 09:53:18 -0800787 MYLOGD("Adding zip text entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700788 int32_t err = zip_writer_->StartEntryWithTime(entry_name.c_str(), ZipWriter::kCompress, ds.now_);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700789 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700790 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700791 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800792 return false;
793 }
794
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700795 err = zip_writer_->WriteBytes(content.c_str(), content.length());
Felipe Leme1d486fe2016-10-14 18:06:47 -0700796 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700797 MYLOGE("zip_writer_->WriteBytes(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700798 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800799 return false;
800 }
801
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700802 err = zip_writer_->FinishEntry();
Felipe Leme1d486fe2016-10-14 18:06:47 -0700803 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700804 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800805 return false;
806 }
807
808 return true;
809}
810
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800811static void DoKmsg() {
812 struct stat st;
813 if (!stat(PSTORE_LAST_KMSG, &st)) {
814 /* Also TODO: Make console-ramoops CAP_SYSLOG protected. */
815 DumpFile("LAST KMSG", PSTORE_LAST_KMSG);
816 } else if (!stat(ALT_PSTORE_LAST_KMSG, &st)) {
817 DumpFile("LAST KMSG", ALT_PSTORE_LAST_KMSG);
818 } else {
819 /* TODO: Make last_kmsg CAP_SYSLOG protected. b/5555691 */
820 DumpFile("LAST KMSG", "/proc/last_kmsg");
821 }
822}
823
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800824static void DoKernelLogcat() {
Yao Chenbe3bbc12018-01-17 16:31:10 -0800825 unsigned long timeout_ms = logcat_timeout({"kernel"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800826 RunCommand(
827 "KERNEL LOG",
828 {"logcat", "-b", "kernel", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
829 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
830}
831
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800832static void DoLogcat() {
Vishnu Nair6921f802017-11-22 09:17:23 -0800833 unsigned long timeout_ms;
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800834 // DumpFile("EVENT LOG TAGS", "/etc/event-log-tags");
835 // calculate timeout
Yao Chenbe3bbc12018-01-17 16:31:10 -0800836 timeout_ms = logcat_timeout({"main", "system", "crash"});
Tony Makae737652017-03-30 17:47:09 +0100837 RunCommand("SYSTEM LOG",
Vishnu Nair6921f802017-11-22 09:17:23 -0800838 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
839 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -0800840 timeout_ms = logcat_timeout({"events"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800841 RunCommand(
842 "EVENT LOG",
843 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
844 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -0800845 timeout_ms = logcat_timeout({"stats"});
846 RunCommand(
847 "STATS LOG",
848 {"logcat", "-b", "stats", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
849 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
850 timeout_ms = logcat_timeout({"radio"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800851 RunCommand(
852 "RADIO LOG",
853 {"logcat", "-b", "radio", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
854 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800855
856 RunCommand("LOG STATISTICS", {"logcat", "-b", "all", "-S"});
857
858 /* kernels must set CONFIG_PSTORE_PMSG, slice up pstore with device tree */
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800859 RunCommand("LAST LOGCAT", {"logcat", "-L", "-b", "all", "-v", "threadtime", "-v", "printable",
860 "-v", "uid", "-d", "*:v"});
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800861}
862
Jayachandran Ca94c7172017-06-10 15:08:12 -0700863static void DumpIpTablesAsRoot() {
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700864 RunCommand("IPTABLES", {"iptables", "-L", "-nvx"});
865 RunCommand("IP6TABLES", {"ip6tables", "-L", "-nvx"});
Erik Kline32af8c22016-09-28 17:26:26 +0900866 RunCommand("IPTABLES NAT", {"iptables", "-t", "nat", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -0700867 /* no ip6 nat */
Erik Kline32af8c22016-09-28 17:26:26 +0900868 RunCommand("IPTABLES MANGLE", {"iptables", "-t", "mangle", "-L", "-nvx"});
869 RunCommand("IP6TABLES MANGLE", {"ip6tables", "-t", "mangle", "-L", "-nvx"});
870 RunCommand("IPTABLES RAW", {"iptables", "-t", "raw", "-L", "-nvx"});
871 RunCommand("IP6TABLES RAW", {"ip6tables", "-t", "raw", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -0700872}
873
Narayan Kamath8f788292017-05-25 13:20:39 +0100874static void AddAnrTraceDir(const bool add_to_zip, const std::string& anr_traces_dir) {
875 MYLOGD("AddAnrTraceDir(): dump_traces_file=%s, anr_traces_dir=%s\n", dump_traces_path,
876 anr_traces_dir.c_str());
877
878 // If we're here, dump_traces_path will always be a temporary file
879 // (created with mkostemp or similar) that contains dumps taken earlier
880 // on in the process.
881 if (dump_traces_path != nullptr) {
882 if (add_to_zip) {
883 ds.AddZipEntry(ZIP_ROOT_DIR + anr_traces_dir + "/traces-just-now.txt", dump_traces_path);
884 } else {
885 MYLOGD("Dumping current ANR traces (%s) to the main bugreport entry\n",
886 dump_traces_path);
887 ds.DumpFile("VM TRACES JUST NOW", dump_traces_path);
888 }
889
890 const int ret = unlink(dump_traces_path);
891 if (ret == -1) {
892 MYLOGW("Error unlinking temporary trace path %s: %s\n", dump_traces_path,
893 strerror(errno));
Felipe Lemee184f662016-10-27 10:04:47 -0700894 }
895 }
896
Narayan Kamathbd863722017-06-01 18:50:12 +0100897 // Add a specific message for the first ANR Dump.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700898 if (ds.anr_data_.size() > 0) {
899 AddDumps(ds.anr_data_.begin(), ds.anr_data_.begin() + 1,
Narayan Kamathbd863722017-06-01 18:50:12 +0100900 "VM TRACES AT LAST ANR", add_to_zip);
901
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100902 // The "last" ANR will always be included as separate entry in the zip file. In addition,
903 // it will be present in the body of the main entry if |add_to_zip| == false.
904 //
905 // Historical ANRs are always included as separate entries in the bugreport zip file.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700906 AddDumps(ds.anr_data_.begin() + ((add_to_zip) ? 1 : 0), ds.anr_data_.end(),
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100907 "HISTORICAL ANR", true /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +0100908 } else {
Narayan Kamath8f788292017-05-25 13:20:39 +0100909 printf("*** NO ANRs to dump in %s\n\n", ANR_DIR.c_str());
910 }
911}
912
913static void AddAnrTraceFiles() {
914 const bool add_to_zip = ds.IsZipping() && ds.version_ == VERSION_SPLIT_ANR;
915
Elliott Hughes69fe5ec2018-03-23 11:04:25 -0700916 std::string anr_traces_dir = "/data/anr";
Narayan Kamath8f788292017-05-25 13:20:39 +0100917
Elliott Hughes69fe5ec2018-03-23 11:04:25 -0700918 AddAnrTraceDir(add_to_zip, anr_traces_dir);
Narayan Kamath8f788292017-05-25 13:20:39 +0100919
Makoto Onuki83ec63f2019-01-31 17:08:59 -0800920 RunCommand("ANR FILES", {"ls", "-lt", ANR_DIR});
921
Elliott Hughes69fe5ec2018-03-23 11:04:25 -0700922 // Slow traces for slow operations.
Felipe Lemee184f662016-10-27 10:04:47 -0700923 struct stat st;
Elliott Hughes69fe5ec2018-03-23 11:04:25 -0700924 int i = 0;
925 while (true) {
926 const std::string slow_trace_path =
927 anr_traces_dir + android::base::StringPrintf("slow%02d.txt", i);
928 if (stat(slow_trace_path.c_str(), &st)) {
929 // No traces file at this index, done with the files.
930 break;
Felipe Lemee184f662016-10-27 10:04:47 -0700931 }
Elliott Hughes69fe5ec2018-03-23 11:04:25 -0700932 ds.DumpFile("VM TRACES WHEN SLOW", slow_trace_path.c_str());
933 i++;
Felipe Lemee184f662016-10-27 10:04:47 -0700934 }
935}
936
Wei Wang509bb5d2017-06-09 14:42:12 -0700937static void DumpBlockStatFiles() {
938 DurationReporter duration_reporter("DUMP BLOCK STAT");
Wei Wang509bb5d2017-06-09 14:42:12 -0700939
Wei Wang1dc1ef52017-06-12 11:28:37 -0700940 std::unique_ptr<DIR, std::function<int(DIR*)>> dirptr(opendir(BLK_DEV_SYS_DIR), closedir);
941
942 if (dirptr == nullptr) {
Wei Wang509bb5d2017-06-09 14:42:12 -0700943 MYLOGE("Failed to open %s: %s\n", BLK_DEV_SYS_DIR, strerror(errno));
944 return;
945 }
946
947 printf("------ DUMP BLOCK STAT ------\n\n");
Wei Wang1dc1ef52017-06-12 11:28:37 -0700948 while (struct dirent *d = readdir(dirptr.get())) {
Wei Wang509bb5d2017-06-09 14:42:12 -0700949 if ((d->d_name[0] == '.')
950 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
951 || (d->d_name[1] == '\0'))) {
952 continue;
953 }
954 const std::string new_path =
955 android::base::StringPrintf("%s/%s", BLK_DEV_SYS_DIR, d->d_name);
956 printf("------ BLOCK STAT (%s) ------\n", new_path.c_str());
957 dump_files("", new_path.c_str(), skip_not_stat, dump_stat_from_fd);
958 printf("\n");
959 }
Wei Wang1dc1ef52017-06-12 11:28:37 -0700960 return;
Wei Wang509bb5d2017-06-09 14:42:12 -0700961}
Jayachandran Ca94c7172017-06-10 15:08:12 -0700962
963static void DumpPacketStats() {
964 DumpFile("NETWORK DEV INFO", "/proc/net/dev");
965 DumpFile("QTAGUID NETWORK INTERFACES INFO", "/proc/net/xt_qtaguid/iface_stat_all");
966 DumpFile("QTAGUID NETWORK INTERFACES INFO (xt)", "/proc/net/xt_qtaguid/iface_stat_fmt");
967 DumpFile("QTAGUID CTRL INFO", "/proc/net/xt_qtaguid/ctrl");
968 DumpFile("QTAGUID STATS INFO", "/proc/net/xt_qtaguid/stats");
969}
970
971static void DumpIpAddrAndRules() {
972 /* The following have a tendency to get wedged when wifi drivers/fw goes belly-up. */
973 RunCommand("NETWORK INTERFACES", {"ip", "link"});
974 RunCommand("IPv4 ADDRESSES", {"ip", "-4", "addr", "show"});
975 RunCommand("IPv6 ADDRESSES", {"ip", "-6", "addr", "show"});
976 RunCommand("IP RULES", {"ip", "rule", "show"});
977 RunCommand("IP RULES v6", {"ip", "-6", "rule", "show"});
978}
979
Nandana Duttbbdb5b42019-03-12 10:52:56 +0000980static Dumpstate::RunStatus RunDumpsysTextByPriority(const std::string& title, int priority,
981 std::chrono::milliseconds timeout,
982 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -0800983 auto start = std::chrono::steady_clock::now();
Vishnu Naire97d6122018-01-18 13:58:56 -0800984 sp<android::IServiceManager> sm = defaultServiceManager();
985 Dumpsys dumpsys(sm.get());
Vishnu Naire97d6122018-01-18 13:58:56 -0800986 Vector<String16> args;
987 Dumpsys::setServiceArgs(args, /* asProto = */ false, priority);
Vishnu Naire97d6122018-01-18 13:58:56 -0800988 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ false);
989 for (const String16& service : services) {
Nandana Duttbbdb5b42019-03-12 10:52:56 +0000990 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -0800991 std::string path(title);
992 path.append(" - ").append(String8(service).c_str());
993 DumpstateSectionReporter section_reporter(path, ds.listener_, ds.report_section_);
994 size_t bytes_written = 0;
995 status_t status = dumpsys.startDumpThread(service, args);
996 if (status == OK) {
997 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
998 std::chrono::duration<double> elapsed_seconds;
999 status = dumpsys.writeDump(STDOUT_FILENO, service, service_timeout,
1000 /* as_proto = */ false, elapsed_seconds, bytes_written);
1001 section_reporter.setSize(bytes_written);
1002 dumpsys.writeDumpFooter(STDOUT_FILENO, service, elapsed_seconds);
1003 bool dump_complete = (status == OK);
1004 dumpsys.stopDumpThread(dump_complete);
1005 }
1006 section_reporter.setStatus(status);
1007
1008 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1009 std::chrono::steady_clock::now() - start);
1010 if (elapsed_duration > timeout) {
1011 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1012 elapsed_duration.count());
1013 break;
1014 }
1015 }
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001016 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001017}
1018
Vishnu Nair64afc022018-02-01 15:29:34 -08001019static void RunDumpsysText(const std::string& title, int priority,
1020 std::chrono::milliseconds timeout,
1021 std::chrono::milliseconds service_timeout) {
1022 DurationReporter duration_reporter(title);
1023 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1024 fsync(STDOUT_FILENO);
1025 RunDumpsysTextByPriority(title, priority, timeout, service_timeout);
1026}
1027
1028/* Dump all services registered with Normal or Default priority. */
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001029static Dumpstate::RunStatus RunDumpsysTextNormalPriority(const std::string& title,
1030 std::chrono::milliseconds timeout,
1031 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001032 DurationReporter duration_reporter(title);
1033 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1034 fsync(STDOUT_FILENO);
1035 RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_NORMAL, timeout,
1036 service_timeout);
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001037
1038 RETURN_IF_USER_DENIED_CONSENT();
1039
1040 return RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_DEFAULT, timeout,
1041 service_timeout);
Vishnu Nair64afc022018-02-01 15:29:34 -08001042}
1043
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001044static Dumpstate::RunStatus RunDumpsysProto(const std::string& title, int priority,
1045 std::chrono::milliseconds timeout,
1046 std::chrono::milliseconds service_timeout) {
Luis Hector Chavez1e27b082018-03-22 15:36:42 -07001047 if (!ds.IsZipping()) {
1048 MYLOGD("Not dumping %s because it's not a zipped bugreport\n", title.c_str());
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001049 return Dumpstate::RunStatus::OK;
Luis Hector Chavez1e27b082018-03-22 15:36:42 -07001050 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001051 sp<android::IServiceManager> sm = defaultServiceManager();
1052 Dumpsys dumpsys(sm.get());
1053 Vector<String16> args;
1054 Dumpsys::setServiceArgs(args, /* asProto = */ true, priority);
1055 DurationReporter duration_reporter(title);
1056
1057 auto start = std::chrono::steady_clock::now();
1058 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ true);
1059 for (const String16& service : services) {
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001060 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001061 std::string path(kProtoPath);
1062 path.append(String8(service).c_str());
1063 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL) {
1064 path.append("_CRITICAL");
1065 } else if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH) {
1066 path.append("_HIGH");
1067 }
1068 path.append(kProtoExt);
1069 DumpstateSectionReporter section_reporter(path, ds.listener_, ds.report_section_);
1070 status_t status = dumpsys.startDumpThread(service, args);
1071 if (status == OK) {
1072 status = ds.AddZipEntryFromFd(path, dumpsys.getDumpFd(), service_timeout);
1073 bool dumpTerminated = (status == OK);
1074 dumpsys.stopDumpThread(dumpTerminated);
1075 }
1076 ZipWriter::FileEntry file_entry;
1077 ds.zip_writer_->GetLastEntry(&file_entry);
1078 section_reporter.setSize(file_entry.compressed_size);
1079 section_reporter.setStatus(status);
1080
1081 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1082 std::chrono::steady_clock::now() - start);
1083 if (elapsed_duration > timeout) {
1084 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1085 elapsed_duration.count());
1086 break;
1087 }
1088 }
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001089 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001090}
1091
Nandana Dutta7db6342018-11-21 14:53:34 +00001092// Runs dumpsys on services that must dump first and will take less than 100ms to dump.
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001093static Dumpstate::RunStatus RunDumpsysCritical() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001094 RunDumpsysText("DUMPSYS CRITICAL", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1095 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001096
1097 RETURN_IF_USER_DENIED_CONSENT();
1098
1099 return RunDumpsysProto("DUMPSYS CRITICAL PROTO", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1100 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Vishnu Nair780b1282017-10-10 13:57:24 -07001101}
1102
1103// Runs dumpsys on services that must dump first but can take up to 250ms to dump.
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001104static Dumpstate::RunStatus RunDumpsysHigh() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001105 // TODO meminfo takes ~10s, connectivity takes ~5sec to dump. They are both
1106 // high priority. Reduce timeout once they are able to dump in a shorter time or
1107 // moved to a parallel task.
1108 RunDumpsysText("DUMPSYS HIGH", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1109 /* timeout= */ 90s, /* service_timeout= */ 30s);
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001110
1111 RETURN_IF_USER_DENIED_CONSENT();
1112
1113 return RunDumpsysProto("DUMPSYS HIGH PROTO", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1114 /* timeout= */ 5s, /* service_timeout= */ 1s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001115}
1116
1117// Runs dumpsys on services that must dump but can take up to 10s to dump.
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001118static Dumpstate::RunStatus RunDumpsysNormal() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001119 RunDumpsysTextNormalPriority("DUMPSYS", /* timeout= */ 90s, /* service_timeout= */ 10s);
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001120
1121 RETURN_IF_USER_DENIED_CONSENT();
1122
1123 return RunDumpsysProto("DUMPSYS PROTO", IServiceManager::DUMP_FLAG_PRIORITY_NORMAL,
1124 /* timeout= */ 90s, /* service_timeout= */ 10s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001125}
1126
Steven Moreland44cd9482018-01-04 16:24:13 -08001127static void DumpHals() {
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001128 if (!ds.IsZipping()) {
1129 RunCommand("HARDWARE HALS", {"lshal", "-lVSietrpc", "--types=b,c,l,z", "--debug"},
1130 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build());
1131 return;
1132 }
1133 DurationReporter duration_reporter("DUMP HALS");
1134 RunCommand("HARDWARE HALS", {"lshal", "-lVSietrpc", "--types=b,c,l,z"},
Greg Kaiser3dfeda32019-05-16 10:32:51 -07001135 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build());
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001136
Steven Moreland44cd9482018-01-04 16:24:13 -08001137 using android::hidl::manager::V1_0::IServiceManager;
1138 using android::hardware::defaultServiceManager;
1139
1140 sp<IServiceManager> sm = defaultServiceManager();
1141 if (sm == nullptr) {
1142 MYLOGE("Could not retrieve hwservicemanager to dump hals.\n");
1143 return;
1144 }
1145
1146 auto ret = sm->list([&](const auto& interfaces) {
1147 for (const std::string& interface : interfaces) {
1148 std::string cleanName = interface;
1149 std::replace_if(cleanName.begin(),
1150 cleanName.end(),
1151 [](char c) {
1152 return !isalnum(c) &&
1153 std::string("@-_:.").find(c) == std::string::npos;
1154 }, '_');
Nandana Dutt979388e2018-11-30 16:48:55 +00001155 const std::string path = ds.bugreport_internal_dir_ + "/lshal_debug_" + cleanName;
Steven Moreland44cd9482018-01-04 16:24:13 -08001156
1157 {
1158 auto fd = android::base::unique_fd(
1159 TEMP_FAILURE_RETRY(open(path.c_str(),
1160 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1161 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1162 if (fd < 0) {
1163 MYLOGE("Could not open %s to dump additional hal information.\n", path.c_str());
1164 continue;
1165 }
1166 RunCommandToFd(fd,
1167 "",
Steven Morelandc81cd3c2018-01-18 14:36:26 -08001168 {"lshal", "debug", "-E", interface},
Steven Moreland44cd9482018-01-04 16:24:13 -08001169 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
1170
1171 bool empty = 0 == lseek(fd, 0, SEEK_END);
1172 if (!empty) {
1173 ds.AddZipEntry("lshal-debug/" + cleanName + ".txt", path);
1174 }
1175 }
1176
1177 unlink(path.c_str());
1178 }
1179 });
1180
1181 if (!ret.isOk()) {
1182 MYLOGE("Could not list hals from hwservicemanager.\n");
1183 }
1184}
1185
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001186// Dumps various things. Returns early with status USER_CONSENT_DENIED if user denies consent
1187// via the consent they are shown. Ignores other errors that occur while running various
1188// commands. The consent checking is currently done around long running tasks, which happen to
1189// be distributed fairly evenly throughout the function.
1190static Dumpstate::RunStatus dumpstate() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001191 DurationReporter duration_reporter("DUMPSTATE");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001192
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001193 // Dump various things. Note that anything that takes "long" (i.e. several seconds) should
1194 // check intermittently (if it's intrerruptable like a foreach on pids) and/or should be wrapped
1195 // in a consent check (via RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK).
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -07001196 dump_dev_files("TRUSTY VERSION", "/sys/bus/platform/drivers/trusty", "trusty_version");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001197 RunCommand("UPTIME", {"uptime"});
Wei Wang509bb5d2017-06-09 14:42:12 -07001198 DumpBlockStatFiles();
Mark Salyzyn8c8130e2015-12-09 11:21:28 -08001199 dump_emmc_ecsd("/d/mmc0/mmc0:0001/ext_csd");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001200 DumpFile("MEMORY INFO", "/proc/meminfo");
1201 RunCommand("CPU INFO", {"top", "-b", "-n", "1", "-H", "-s", "6", "-o",
Felipe Leme30dbfa12016-09-02 12:43:26 -07001202 "pid,tid,user,pr,ni,%cpu,s,virt,res,pcy,cmd,name"});
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001203
1204 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "PROCRANK", {"procrank"}, AS_ROOT_20);
1205
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001206 DumpFile("VIRTUAL MEMORY STATS", "/proc/vmstat");
1207 DumpFile("VMALLOC INFO", "/proc/vmallocinfo");
1208 DumpFile("SLAB INFO", "/proc/slabinfo");
1209 DumpFile("ZONEINFO", "/proc/zoneinfo");
1210 DumpFile("PAGETYPEINFO", "/proc/pagetypeinfo");
1211 DumpFile("BUDDYINFO", "/proc/buddyinfo");
1212 DumpFile("FRAGMENTATION INFO", "/d/extfrag/unusable_index");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001213
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001214 DumpFile("KERNEL WAKE SOURCES", "/d/wakeup_sources");
1215 DumpFile("KERNEL CPUFREQ", "/sys/devices/system/cpu/cpu0/cpufreq/stats/time_in_state");
1216 DumpFile("KERNEL SYNC", "/d/sync");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001217
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001218 RunCommand("PROCESSES AND THREADS",
Yohei Yukawa591a72d2017-10-05 21:36:35 -07001219 {"ps", "-A", "-T", "-Z", "-O", "pri,nice,rtprio,sched,pcy,time"});
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001220
1221 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "LIBRANK", {"librank"},
1222 CommandOptions::AS_ROOT);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001223
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001224 DumpHals();
Steven Moreland81b429e2017-01-31 19:50:46 -08001225
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001226 RunCommand("PRINTENV", {"printenv"});
Elliott Hughes21b7c8d2016-10-28 08:53:02 -07001227 RunCommand("NETSTAT", {"netstat", "-nW"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001228 struct stat s;
1229 if (stat("/proc/modules", &s) != 0) {
1230 MYLOGD("Skipping 'lsmod' because /proc/modules does not exist\n");
1231 } else {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001232 RunCommand("LSMOD", {"lsmod"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001233 }
Michal Karpinski4db754f2015-12-11 18:04:32 +00001234
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001235 if (__android_logger_property_get_bool(
1236 "ro.logd.kernel", BOOL_DEFAULT_TRUE | BOOL_DEFAULT_FLAG_ENG | BOOL_DEFAULT_FLAG_SVELTE)) {
1237 DoKernelLogcat();
1238 } else {
1239 do_dmesg();
1240 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001241
Felipe Lemef0292972016-11-22 13:57:05 -08001242 RunCommand("LIST OF OPEN FILES", {"lsof"}, CommandOptions::AS_ROOT);
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001243
1244 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(for_each_pid, do_showmap, "SMAPS OF ALL PROCESSES");
1245
Jeff Brown1dc94e32014-09-11 14:15:27 -07001246 for_each_tid(show_wchan, "BLOCKED PROCESS WAIT-CHANNELS");
Mark Salyzyna297c322016-02-05 15:33:17 -08001247 for_each_pid(show_showtime, "PROCESS TIMES (pid cmd user system iowait+percentage)");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001248
Ajay Panicker2ff8e872017-04-27 14:04:32 -07001249 /* Dump Bluetooth HCI logs */
1250 ds.AddDir("/data/misc/bluetooth/logs", true);
Ajay Panickerd886ec42016-09-14 12:26:46 -07001251
Greg Kaiser3ddc3fa2019-05-23 16:14:52 -07001252 if (ds.options_->do_fb && !ds.do_early_screenshot_) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001253 MYLOGI("taking late screenshot\n");
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001254 ds.TakeScreenshot();
Jeff Sharkey5a930032013-03-19 15:05:19 -07001255 }
1256
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001257 DoLogcat();
Mark Salyzynecc07632015-07-30 14:57:09 -07001258
Felipe Lemee184f662016-10-27 10:04:47 -07001259 AddAnrTraceFiles();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001260
Narayan Kamath8f788292017-05-25 13:20:39 +01001261 // NOTE: tombstones are always added as separate entries in the zip archive
1262 // and are not interspersed with the main report.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001263 const bool tombstones_dumped = AddDumps(ds.tombstone_data_.begin(), ds.tombstone_data_.end(),
Narayan Kamathbd863722017-06-01 18:50:12 +01001264 "TOMBSTONE", true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001265 if (!tombstones_dumped) {
1266 printf("*** NO TOMBSTONES to dump in %s\n\n", TOMBSTONE_DIR.c_str());
Christopher Ferris7dc7f322014-07-22 16:08:19 -07001267 }
1268
Jayachandran Ca94c7172017-06-10 15:08:12 -07001269 DumpPacketStats();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001270
Chenbo Feng276a3b62018-08-07 11:44:49 -07001271 RunDumpsys("EBPF MAP STATS", {"netd", "trafficcontroller"});
1272
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001273 DoKmsg();
Mark Salyzyn2262c162014-12-16 09:09:26 -08001274
Jayachandran Ca94c7172017-06-10 15:08:12 -07001275 DumpIpAddrAndRules();
Sreeram Ramachandran2b3bba32014-07-08 15:40:55 -07001276
1277 dump_route_tables();
1278
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001279 RunCommand("ARP CACHE", {"ip", "-4", "neigh", "show"});
1280 RunCommand("IPv6 ND CACHE", {"ip", "-6", "neigh", "show"});
1281 RunCommand("MULTICAST ADDRESSES", {"ip", "maddr"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001282
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001283 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysHigh);
Lorenzo Colitti6afc38c2015-09-09 22:59:25 +09001284
Elliott Hughes23ccc622017-02-28 10:14:22 -08001285 RunCommand("SYSTEM PROPERTIES", {"getprop"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001286
Jin Qianf334d662017-10-10 14:41:37 -07001287 RunCommand("STORAGED IO INFO", {"storaged", "-u", "-p"});
ynwangf649a6e2016-07-17 21:56:00 -07001288
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001289 RunCommand("FILESYSTEMS & FREE SPACE", {"df"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001290
Colin Crossf45fa6b2012-03-26 12:38:26 -07001291 /* Binder state is expensive to look at as it uses a lot of memory. */
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001292 DumpFile("BINDER FAILED TRANSACTION LOG", "/sys/kernel/debug/binder/failed_transaction_log");
1293 DumpFile("BINDER TRANSACTION LOG", "/sys/kernel/debug/binder/transaction_log");
1294 DumpFile("BINDER TRANSACTIONS", "/sys/kernel/debug/binder/transactions");
1295 DumpFile("BINDER STATS", "/sys/kernel/debug/binder/stats");
1296 DumpFile("BINDER STATE", "/sys/kernel/debug/binder/state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001297
Vishnu Nair36b4cdb2017-11-17 10:27:05 -08001298 /* Add window and surface trace files. */
1299 if (!PropertiesHelper::IsUserBuild()) {
1300 ds.AddDir(WMTRACE_DATA_DIR, false);
1301 }
1302
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001303 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(ds.DumpstateBoard);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001304
Steven Moreland7440ddb2016-12-15 16:13:39 -08001305 /* Migrate the ril_dumpstate to a device specific dumpstate? */
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001306 int rilDumpstateTimeout = android::base::GetIntProperty("ril.dumpstate.timeout", 0);
1307 if (rilDumpstateTimeout > 0) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001308 // su does not exist on user builds, so try running without it.
1309 // This way any implementations of vril-dump that do not require
1310 // root can run on user builds.
1311 CommandOptions::CommandOptionsBuilder options =
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001312 CommandOptions::WithTimeout(rilDumpstateTimeout);
Felipe Lemef0292972016-11-22 13:57:05 -08001313 if (!PropertiesHelper::IsUserBuild()) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001314 options.AsRoot();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001315 }
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001316 RunCommand("DUMP VENDOR RIL LOGS", {"vril-dump"}, options.Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -07001317 }
1318
Felipe Lemed8b94e52016-12-08 10:21:44 -08001319 printf("========================================================\n");
1320 printf("== Android Framework Services\n");
1321 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001322
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001323 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysNormal);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001324
Felipe Lemed8b94e52016-12-08 10:21:44 -08001325 printf("========================================================\n");
1326 printf("== Checkins\n");
1327 printf("========================================================\n");
Dianne Hackborn02bea972013-06-26 18:59:09 -07001328
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001329 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001330
1331 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsys, "CHECKIN MEMINFO", {"meminfo", "--checkin"});
1332
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001333 RunDumpsys("CHECKIN NETSTATS", {"netstats", "--checkin"});
1334 RunDumpsys("CHECKIN PROCSTATS", {"procstats", "-c"});
1335 RunDumpsys("CHECKIN USAGESTATS", {"usagestats", "-c"});
1336 RunDumpsys("CHECKIN PACKAGE", {"package", "--checkin"});
Dianne Hackborn02bea972013-06-26 18:59:09 -07001337
Felipe Lemed8b94e52016-12-08 10:21:44 -08001338 printf("========================================================\n");
1339 printf("== Running Application Activities\n");
1340 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001341
Makoto Onuki60780982018-04-16 15:34:00 -07001342 // The following dumpsys internally collects output from running apps, so it can take a long
1343 // time. So let's extend the timeout.
1344
1345 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
1346
1347 RunDumpsys("APP ACTIVITIES", {"activity", "-v", "all"}, DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001348
Felipe Lemed8b94e52016-12-08 10:21:44 -08001349 printf("========================================================\n");
Makoto Onuki60780982018-04-16 15:34:00 -07001350 printf("== Running Application Services (platform)\n");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001351 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001352
Vishnu Nairc6e6ea72018-07-02 14:20:06 -07001353 RunDumpsys("APP SERVICES PLATFORM", {"activity", "service", "all-platform-non-critical"},
Makoto Onuki60780982018-04-16 15:34:00 -07001354 DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001355
Felipe Lemed8b94e52016-12-08 10:21:44 -08001356 printf("========================================================\n");
Makoto Onuki60780982018-04-16 15:34:00 -07001357 printf("== Running Application Services (non-platform)\n");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001358 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001359
Makoto Onuki60780982018-04-16 15:34:00 -07001360 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1361 DUMPSYS_COMPONENTS_OPTIONS);
1362
1363 printf("========================================================\n");
1364 printf("== Running Application Providers (platform)\n");
1365 printf("========================================================\n");
1366
1367 RunDumpsys("APP PROVIDERS PLATFORM", {"activity", "provider", "all-platform"},
1368 DUMPSYS_COMPONENTS_OPTIONS);
1369
1370 printf("========================================================\n");
1371 printf("== Running Application Providers (non-platform)\n");
1372 printf("========================================================\n");
1373
1374 RunDumpsys("APP PROVIDERS NON-PLATFORM", {"activity", "provider", "all-non-platform"},
1375 DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001376
Adrian Roos8b397ab2017-04-04 16:35:44 -07001377 printf("========================================================\n");
1378 printf("== Dropbox crashes\n");
1379 printf("========================================================\n");
1380
1381 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1382 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1383
Felipe Lemed8b94e52016-12-08 10:21:44 -08001384 printf("========================================================\n");
1385 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1386 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1387 printf("========================================================\n");
1388 printf("== dumpstate: done (id %d)\n", ds.id_);
1389 printf("========================================================\n");
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001390 return Dumpstate::RunStatus::OK;
Colin Crossf45fa6b2012-03-26 12:38:26 -07001391}
1392
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001393/*
1394 * Dumps state for the default case; drops root after it's no longer necessary.
1395 *
1396 * Returns RunStatus::OK if everything went fine.
1397 * Returns RunStatus::ERROR if there was an error.
1398 * Returns RunStatus::USER_DENIED_CONSENT if user explicitly denied consent to sharing the bugreport
1399 * with the caller.
1400 */
1401static Dumpstate::RunStatus DumpstateDefault() {
Nandana Duttcf419a72019-03-14 10:40:17 +00001402 // Invoking the following dumpsys calls before DumpTraces() to try and
Nandana Dutt4be45d12018-09-26 15:04:23 +01001403 // keep the system stats as close to its initial state as possible.
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001404 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysCritical);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001405
1406 /* collect stack traces from Dalvik and native processes (needs root) */
Nandana Duttcf419a72019-03-14 10:40:17 +00001407 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(ds.DumpTraces, &dump_traces_path);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001408
1409 /* Run some operations that require root. */
1410 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX, !ds.IsZipping());
1411 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX, !ds.IsZipping());
1412
1413 ds.AddDir(RECOVERY_DIR, true);
1414 ds.AddDir(RECOVERY_DATA_DIR, true);
1415 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
1416 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1417 if (!PropertiesHelper::IsUserBuild()) {
1418 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1419 ds.AddDir(PROFILE_DATA_DIR_REF, true);
1420 }
1421 add_mountinfo();
1422 DumpIpTablesAsRoot();
1423
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001424 // Capture any IPSec policies in play. No keys are exposed here.
Nandana Dutt4be45d12018-09-26 15:04:23 +01001425 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1426
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001427 // Dump IPsec stats. No keys are exposed here.
1428 DumpFile("XFRM STATS", XFRM_STAT_PROC_FILE);
1429
Nandana Dutt4be45d12018-09-26 15:04:23 +01001430 // Run ss as root so we can see socket marks.
1431 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
1432
1433 // Run iotop as root to show top 100 IO threads
1434 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
1435
Erick Reyese68df822019-02-11 14:46:36 -08001436 // Gather shared memory buffer info if the product implements it
1437 struct stat st;
1438 if (!stat("/product/bin/dmabuf_dump", &st)) {
1439 RunCommand("Dmabuf dump", {"/product/bin/dmabuf_dump"});
1440 }
1441
Nandana Dutt4be45d12018-09-26 15:04:23 +01001442 if (!DropRootUser()) {
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001443 return Dumpstate::RunStatus::ERROR;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001444 }
1445
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001446 RETURN_IF_USER_DENIED_CONSENT();
1447 return dumpstate();
Nandana Dutt4be45d12018-09-26 15:04:23 +01001448}
1449
mukesh agrawal253dad42018-01-23 21:59:59 -08001450// This method collects common dumpsys for telephony and wifi
1451static void DumpstateRadioCommon() {
Jayachandran Ca94c7172017-06-10 15:08:12 -07001452 DumpIpTablesAsRoot();
1453
1454 if (!DropRootUser()) {
1455 return;
1456 }
1457
1458 do_dmesg();
1459 DoLogcat();
1460 DumpPacketStats();
1461 DoKmsg();
1462 DumpIpAddrAndRules();
1463 dump_route_tables();
1464
1465 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
1466 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08001467}
1468
1469// This method collects dumpsys for telephony debugging only
1470static void DumpstateTelephonyOnly() {
1471 DurationReporter duration_reporter("DUMPSTATE");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001472 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08001473
1474 DumpstateRadioCommon();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001475
1476 RunCommand("SYSTEM PROPERTIES", {"getprop"});
1477
1478 printf("========================================================\n");
1479 printf("== Android Framework Services\n");
1480 printf("========================================================\n");
1481
Vishnu Nair652cc802017-11-30 15:18:30 -08001482 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1483 SEC_TO_MSEC(10));
Chiachang Wang85e0db32019-03-25 08:59:55 +08001484 RunDumpsys("DUMPSYS", {"connmetrics"}, CommandOptions::WithTimeout(90).Build(),
1485 SEC_TO_MSEC(10));
1486 RunDumpsys("DUMPSYS", {"netd"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Vishnu Nair652cc802017-11-30 15:18:30 -08001487 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
1488 SEC_TO_MSEC(10));
Amruth Ramachandrand25a9142018-04-02 16:16:09 -07001489 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
1490 SEC_TO_MSEC(10));
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07001491 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
1492 SEC_TO_MSEC(10));
Jayachandran Ca94c7172017-06-10 15:08:12 -07001493
1494 printf("========================================================\n");
1495 printf("== Running Application Services\n");
1496 printf("========================================================\n");
1497
1498 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
1499
1500 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001501 printf("== Running Application Services (non-platform)\n");
1502 printf("========================================================\n");
1503
1504 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1505 DUMPSYS_COMPONENTS_OPTIONS);
1506
1507 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07001508 printf("== Checkins\n");
1509 printf("========================================================\n");
1510
1511 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
1512
1513 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07001514 printf("== dumpstate: done (id %d)\n", ds.id_);
1515 printf("========================================================\n");
1516}
1517
mukesh agrawal253dad42018-01-23 21:59:59 -08001518// This method collects dumpsys for wifi debugging only
1519static void DumpstateWifiOnly() {
1520 DurationReporter duration_reporter("DUMPSTATE");
1521
1522 DumpstateRadioCommon();
1523
1524 printf("========================================================\n");
1525 printf("== Android Framework Services\n");
1526 printf("========================================================\n");
1527
1528 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1529 SEC_TO_MSEC(10));
1530 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
1531 SEC_TO_MSEC(10));
1532
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001533 DumpHals();
Roger Wang70399032019-01-08 16:10:37 +08001534
mukesh agrawal253dad42018-01-23 21:59:59 -08001535 printf("========================================================\n");
1536 printf("== dumpstate: done (id %d)\n", ds.id_);
1537 printf("========================================================\n");
1538}
1539
Nandana Duttcf419a72019-03-14 10:40:17 +00001540Dumpstate::RunStatus Dumpstate::DumpTraces(const char** path) {
Nandana Duttfaafd522019-03-11 09:23:09 +00001541 DurationReporter duration_reporter("DUMP TRACES");
1542
1543 const std::string temp_file_pattern = "/data/anr/dumptrace_XXXXXX";
1544 const size_t buf_size = temp_file_pattern.length() + 1;
1545 std::unique_ptr<char[]> file_name_buf(new char[buf_size]);
1546 memcpy(file_name_buf.get(), temp_file_pattern.c_str(), buf_size);
1547
1548 // Create a new, empty file to receive all trace dumps.
1549 //
1550 // TODO: This can be simplified once we remove support for the old style
1551 // dumps. We can have a file descriptor passed in to dump_traces instead
1552 // of creating a file, closing it and then reopening it again.
1553 android::base::unique_fd fd(mkostemp(file_name_buf.get(), O_APPEND | O_CLOEXEC));
1554 if (fd < 0) {
1555 MYLOGE("mkostemp on pattern %s: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001556 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001557 }
1558
1559 // Nobody should have access to this temporary file except dumpstate, but we
1560 // temporarily grant 'read' to 'others' here because this file is created
1561 // when tombstoned is still running as root, but dumped after dropping. This
1562 // can go away once support for old style dumping has.
1563 const int chmod_ret = fchmod(fd, 0666);
1564 if (chmod_ret < 0) {
1565 MYLOGE("fchmod on %s failed: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001566 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001567 }
1568
1569 std::unique_ptr<DIR, decltype(&closedir)> proc(opendir("/proc"), closedir);
1570 if (proc.get() == nullptr) {
1571 MYLOGE("opendir /proc failed: %s\n", strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001572 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001573 }
1574
1575 // Number of times process dumping has timed out. If we encounter too many
1576 // failures, we'll give up.
1577 int timeout_failures = 0;
1578 bool dalvik_found = false;
1579
1580 const std::set<int> hal_pids = get_interesting_hal_pids();
1581
1582 struct dirent* d;
1583 while ((d = readdir(proc.get()))) {
Nandana Duttcf419a72019-03-14 10:40:17 +00001584 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttfaafd522019-03-11 09:23:09 +00001585 int pid = atoi(d->d_name);
1586 if (pid <= 0) {
1587 continue;
1588 }
1589
1590 const std::string link_name = android::base::StringPrintf("/proc/%d/exe", pid);
1591 std::string exe;
1592 if (!android::base::Readlink(link_name, &exe)) {
1593 continue;
1594 }
1595
1596 bool is_java_process;
1597 if (exe == "/system/bin/app_process32" || exe == "/system/bin/app_process64") {
1598 // Don't bother dumping backtraces for the zygote.
1599 if (IsZygote(pid)) {
1600 continue;
1601 }
1602
1603 dalvik_found = true;
1604 is_java_process = true;
1605 } else if (should_dump_native_traces(exe.c_str()) || hal_pids.find(pid) != hal_pids.end()) {
1606 is_java_process = false;
1607 } else {
1608 // Probably a native process we don't care about, continue.
1609 continue;
1610 }
1611
1612 // If 3 backtrace dumps fail in a row, consider debuggerd dead.
1613 if (timeout_failures == 3) {
1614 dprintf(fd, "ERROR: Too many stack dump failures, exiting.\n");
1615 break;
1616 }
1617
1618 const uint64_t start = Nanotime();
1619 const int ret = dump_backtrace_to_file_timeout(
1620 pid, is_java_process ? kDebuggerdJavaBacktrace : kDebuggerdNativeBacktrace,
1621 is_java_process ? 5 : 20, fd);
1622
1623 if (ret == -1) {
1624 // For consistency, the header and footer to this message match those
1625 // dumped by debuggerd in the success case.
1626 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
1627 dprintf(fd, "Dump failed, likely due to a timeout.\n");
1628 dprintf(fd, "---- end %d ----", pid);
1629 timeout_failures++;
1630 continue;
1631 }
1632
1633 // We've successfully dumped stack traces, reset the failure count
1634 // and write a summary of the elapsed time to the file and continue with the
1635 // next process.
1636 timeout_failures = 0;
1637
1638 dprintf(fd, "[dump %s stack %d: %.3fs elapsed]\n", is_java_process ? "dalvik" : "native",
1639 pid, (float)(Nanotime() - start) / NANOS_PER_SEC);
1640 }
1641
1642 if (!dalvik_found) {
1643 MYLOGE("Warning: no Dalvik processes found to dump stacks\n");
1644 }
1645
Nandana Duttcf419a72019-03-14 10:40:17 +00001646 *path = file_name_buf.release();
1647 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001648}
1649
Felipe Leme6f674ae2016-11-18 17:10:33 -08001650void Dumpstate::DumpstateBoard() {
1651 DurationReporter duration_reporter("dumpstate_board()");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001652 printf("========================================================\n");
1653 printf("== Board\n");
1654 printf("========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001655
Felipe Leme6f674ae2016-11-18 17:10:33 -08001656 if (!IsZipping()) {
Steven Moreland7440ddb2016-12-15 16:13:39 -08001657 MYLOGD("Not dumping board info because it's not a zipped bugreport\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001658 return;
1659 }
1660
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001661 std::vector<std::string> paths;
1662 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07001663 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00001664 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
1665 kDumpstateBoardFiles[i].c_str()));
Nandana Dutt16d1aee2019-02-15 16:13:53 +00001666 remover.emplace_back(android::base::make_scope_guard(
1667 std::bind([](std::string path) { android::os::UnlinkAndLogOnError(path); }, paths[i])));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001668 }
Jie Song9fbfad02017-06-20 16:29:42 -07001669
Wei Wang587eac92018-04-05 12:17:20 -07001670 sp<IDumpstateDevice> dumpstate_device(IDumpstateDevice::getService());
1671 if (dumpstate_device == nullptr) {
1672 MYLOGE("No IDumpstateDevice implementation\n");
1673 return;
1674 }
1675
1676 using ScopedNativeHandle =
1677 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
1678 ScopedNativeHandle handle(native_handle_create(static_cast<int>(paths.size()), 0),
1679 [](native_handle_t* handle) {
1680 native_handle_close(handle);
1681 native_handle_delete(handle);
1682 });
1683 if (handle == nullptr) {
1684 MYLOGE("Could not create native_handle\n");
1685 return;
1686 }
1687
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001688 // TODO(128270426): Check for consent in between?
Wei Wang587eac92018-04-05 12:17:20 -07001689 for (size_t i = 0; i < paths.size(); i++) {
1690 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
1691
1692 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
1693 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1694 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1695 if (fd < 0) {
1696 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
1697 return;
1698 }
1699 handle.get()->data[i] = fd.release();
1700 }
1701
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001702 // Given that bugreport is required to diagnose failures, it's better to
Wei Wang587eac92018-04-05 12:17:20 -07001703 // set an arbitrary amount of timeout for IDumpstateDevice than to block the
1704 // rest of bugreport. In the timeout case, we will kill dumpstate board HAL
1705 // and grab whatever dumped
1706 std::packaged_task<bool()>
1707 dumpstate_task([paths, dumpstate_device, &handle]() -> bool {
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001708 android::hardware::Return<void> status = dumpstate_device->dumpstateBoard(handle.get());
1709 if (!status.isOk()) {
1710 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
Wei Wang587eac92018-04-05 12:17:20 -07001711 return false;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001712 }
Wei Wang587eac92018-04-05 12:17:20 -07001713 return true;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001714 });
Wei Wang587eac92018-04-05 12:17:20 -07001715
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001716 auto result = dumpstate_task.get_future();
1717 std::thread(std::move(dumpstate_task)).detach();
Wei Wang587eac92018-04-05 12:17:20 -07001718
1719 constexpr size_t timeout_sec = 30;
1720 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
1721 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate vendor HAL\n", timeout_sec);
1722 if (!android::base::SetProperty("ctl.interface_restart",
1723 android::base::StringPrintf("%s/default",
1724 IDumpstateDevice::descriptor))) {
1725 MYLOGE("Couldn't restart dumpstate HAL\n");
1726 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001727 }
Wei Wang587eac92018-04-05 12:17:20 -07001728 // Wait some time for init to kill dumpstate vendor HAL
1729 constexpr size_t killing_timeout_sec = 10;
1730 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
1731 MYLOGE("killing dumpstateBoard timed out after %zus, continue and "
1732 "there might be racing in content\n", killing_timeout_sec);
1733 }
1734
1735 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
1736 for (size_t i = 0; i < paths.size(); i++) {
1737 struct stat s;
1738 if (fstat(handle.get()->data[i], &s) == -1) {
1739 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(),
1740 strerror(errno));
1741 file_sizes[i] = -1;
1742 continue;
1743 }
1744 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001745 }
1746
1747 for (size_t i = 0; i < paths.size(); i++) {
1748 if (file_sizes[i] == -1) {
1749 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07001750 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001751 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07001752 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001753 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07001754 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001755 AddZipEntry(kDumpstateBoardFiles[i], paths[i]);
Jie Song9fbfad02017-06-20 16:29:42 -07001756 }
1757
Felipe Lemed8b94e52016-12-08 10:21:44 -08001758 printf("*** See dumpstate-board.txt entry ***\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001759}
1760
Nandana Dutt12ae14a2019-01-09 10:35:53 +00001761static void ShowUsage() {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001762 fprintf(stderr,
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001763 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-d] [-p] "
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001764 "[-z]] [-s] [-S] [-q] [-B] [-P] [-R] [-V version]\n"
1765 " -h: display this help message\n"
1766 " -b: play sound file instead of vibrate, at beginning of job\n"
1767 " -e: play sound file instead of vibrate, at end of job\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001768 " -d: append date to filename\n"
1769 " -p: capture screenshot to filename.png\n"
1770 " -z: generate zipped file\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001771 " -s: write output to control socket (for init)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001772 " -S: write file location to control socket (for init; requires -z)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001773 " -q: disable vibrate\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001774 " -B: send broadcast when finished\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001775 " -P: send broadcast when started and update system properties on "
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001776 "progress (requires -B)\n"
1777 " -R: take bugreport in remote mode (requires -z, -d and -B, "
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001778 "shouldn't be used with -P)\n"
Nandana Dutt235864b2019-01-22 12:10:16 +00001779 " -w: start binder service and make it wait for a call to startBugreport\n"
Felipe Lemed071c682016-10-20 16:48:00 -07001780 " -v: prints the dumpstate header and exit\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001781}
1782
Wei Liuf87959e2016-08-26 14:51:42 -07001783static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07001784 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07001785}
1786
Felipe Leme1d486fe2016-10-14 18:06:47 -07001787bool Dumpstate::FinishZipFile() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001788 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07001789 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07001790 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07001791 // Final timestamp
1792 char date[80];
1793 time_t the_real_now_please_stand_up = time(nullptr);
1794 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07001795 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001796 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07001797
Felipe Leme9a523ae2016-10-20 15:10:33 -07001798 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001799 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08001800 return false;
1801 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07001802 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001803 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08001804 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08001805 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08001806
Felipe Leme0f3fb202016-06-10 17:10:53 -07001807 // Add log file (which contains stderr output) to zip...
1808 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07001809 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07001810 MYLOGE("Failed to add dumpstate log to .zip file\n");
1811 return false;
1812 }
Nandana Dutt979388e2018-11-30 16:48:55 +00001813 // TODO: Should truncate the existing file.
1814 // ... and re-open it for further logging.
Nandana Dutta344cb62019-02-22 15:12:35 +00001815 if (!redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()))) {
1816 return false;
1817 }
Felipe Leme0f3fb202016-06-10 17:10:53 -07001818 fprintf(stderr, "\n");
1819
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07001820 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07001821 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07001822 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08001823 return false;
1824 }
1825
Felipe Leme1d486fe2016-10-14 18:06:47 -07001826 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
1827 ds.zip_file.reset(nullptr);
1828
Felipe Lemee9d2c542016-11-15 11:48:26 -08001829 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
Nandana Dutt16d1aee2019-02-15 16:13:53 +00001830 android::os::UnlinkAndLogOnError(tmp_path_);
Felipe Lemec4eee562016-04-21 15:42:55 -07001831
Felipe Leme1e9edc62015-12-21 16:02:13 -08001832 return true;
1833}
Felipe Leme6e01fa62015-11-11 19:35:14 -08001834
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -07001835static std::string SHA256_file_hash(const std::string& filepath) {
Andreas Gampe27cd7b22016-07-18 18:24:05 -07001836 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(filepath.c_str(), O_RDONLY | O_NONBLOCK
1837 | O_CLOEXEC | O_NOFOLLOW)));
Andreas Gampeaff68432016-07-18 18:01:27 -07001838 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001839 MYLOGE("open(%s): %s\n", filepath.c_str(), strerror(errno));
Yi Kong19d5c002018-07-20 13:39:55 -07001840 return nullptr;
Michal Karpinski4db754f2015-12-11 18:04:32 +00001841 }
1842
1843 SHA256_CTX ctx;
Elliott Hughesc4dc1412016-04-12 16:28:31 -07001844 SHA256_Init(&ctx);
Michal Karpinski4db754f2015-12-11 18:04:32 +00001845
1846 std::vector<uint8_t> buffer(65536);
1847 while (1) {
1848 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd.get(), buffer.data(), buffer.size()));
1849 if (bytes_read == 0) {
1850 break;
1851 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001852 MYLOGE("read(%s): %s\n", filepath.c_str(), strerror(errno));
Yi Kong19d5c002018-07-20 13:39:55 -07001853 return nullptr;
Michal Karpinski4db754f2015-12-11 18:04:32 +00001854 }
1855
Elliott Hughesc4dc1412016-04-12 16:28:31 -07001856 SHA256_Update(&ctx, buffer.data(), bytes_read);
Michal Karpinski4db754f2015-12-11 18:04:32 +00001857 }
1858
Elliott Hughesc4dc1412016-04-12 16:28:31 -07001859 uint8_t hash[SHA256_DIGEST_LENGTH];
1860 SHA256_Final(hash, &ctx);
1861
1862 char hash_buffer[SHA256_DIGEST_LENGTH * 2 + 1];
1863 for(size_t i = 0; i < SHA256_DIGEST_LENGTH; i++) {
Michal Karpinskicbbdf732016-01-07 20:45:02 +00001864 sprintf(hash_buffer + (i * 2), "%02x", hash[i]);
Michal Karpinski4db754f2015-12-11 18:04:32 +00001865 }
1866 hash_buffer[sizeof(hash_buffer) - 1] = 0;
1867 return std::string(hash_buffer);
1868}
1869
Felipe Lemea4ef1f02017-02-15 17:27:40 -08001870static void SendBroadcast(const std::string& action, const std::vector<std::string>& args) {
1871 // clang-format off
1872 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user", "0",
1873 "--receiver-foreground", "--receiver-include-background", "-a", action};
1874 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08001875
1876 am.insert(am.end(), args.begin(), args.end());
1877
Felipe Leme8d2410e2017-02-08 09:46:08 -08001878 RunCommand("", am,
1879 CommandOptions::WithTimeout(20)
1880 .Log("Sending broadcast: '%s'\n")
1881 .Always()
1882 .DropRoot()
1883 .RedirectStderr()
1884 .Build());
1885}
1886
Felipe Leme35b8cf12017-02-10 15:47:29 -08001887static void Vibrate(int duration_ms) {
1888 // clang-format off
Chris Friese7e95fb2019-06-14 14:47:59 +00001889 RunCommand("", {"cmd", "vibrator", "vibrate", std::to_string(duration_ms), "dumpstate"},
Felipe Leme35b8cf12017-02-10 15:47:29 -08001890 CommandOptions::WithTimeout(10)
1891 .Log("Vibrate: '%s'\n")
1892 .Always()
1893 .Build());
1894 // clang-format on
1895}
1896
Nandana Dutt979388e2018-11-30 16:48:55 +00001897static void MaybeResolveSymlink(std::string* path) {
1898 std::string resolved_path;
1899 if (android::base::Readlink(*path, &resolved_path)) {
1900 *path = resolved_path;
1901 }
1902}
1903
Nandana Dutt4be45d12018-09-26 15:04:23 +01001904/*
1905 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
1906 * if we are writing zip files and adds the version file.
1907 */
1908static void PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00001909 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
1910
Nandana Dutt4be45d12018-09-26 15:04:23 +01001911 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
1912 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt9a76d202019-01-21 15:56:48 +00001913 ds.base_name_ = StringPrintf("bugreport-%s-%s", device_name.c_str(), build_id.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01001914 if (ds.options_->do_add_date) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01001915 char date[80];
1916 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
1917 ds.name_ = date;
1918 } else {
1919 ds.name_ = "undated";
1920 }
1921
Nandana Dutt5fb117b2018-09-27 09:23:36 +01001922 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01001923 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01001924 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01001925 ds.base_name_ += "-wifi";
1926 }
1927
Nandana Dutt5fb117b2018-09-27 09:23:36 +01001928 if (ds.options_->do_fb) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01001929 ds.screenshot_path_ = ds.GetPath(".png");
1930 }
1931 ds.tmp_path_ = ds.GetPath(".tmp");
1932 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
1933
Nandana Dutt54dbd672019-01-11 12:58:05 +00001934 std::string destination = ds.options_->bugreport_fd.get() != -1
1935 ? StringPrintf("[fd:%d]", ds.options_->bugreport_fd.get())
Nandana Dutt9a76d202019-01-21 15:56:48 +00001936 : ds.bugreport_internal_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01001937 MYLOGD(
1938 "Bugreport dir: %s\n"
1939 "Base name: %s\n"
1940 "Suffix: %s\n"
1941 "Log path: %s\n"
1942 "Temporary path: %s\n"
1943 "Screenshot path: %s\n",
Nandana Dutt9a76d202019-01-21 15:56:48 +00001944 destination.c_str(), ds.base_name_.c_str(), ds.name_.c_str(), ds.log_path_.c_str(),
1945 ds.tmp_path_.c_str(), ds.screenshot_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01001946
Nandana Dutt5fb117b2018-09-27 09:23:36 +01001947 if (ds.options_->do_zip_file) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01001948 ds.path_ = ds.GetPath(".zip");
1949 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
1950 create_parent_dirs(ds.path_.c_str());
1951 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
1952 if (ds.zip_file == nullptr) {
1953 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
1954 } else {
1955 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
1956 }
1957 ds.AddTextZipEntry("version.txt", ds.version_);
1958 }
1959}
1960
1961/*
1962 * Finalizes writing to the file by renaming or zipping the tmp file to the final location,
1963 * printing zipped file status, etc.
1964 */
1965static void FinalizeFile() {
Nandana Dutt4be45d12018-09-26 15:04:23 +01001966 /* check if user changed the suffix using system properties */
1967 std::string name =
1968 android::base::GetProperty(android::base::StringPrintf("dumpstate.%d.name", ds.pid_), "");
1969 bool change_suffix = false;
1970 if (!name.empty()) {
1971 /* must whitelist which characters are allowed, otherwise it could cross directories */
1972 std::regex valid_regex("^[-_a-zA-Z0-9]+$");
1973 if (std::regex_match(name.c_str(), valid_regex)) {
1974 change_suffix = true;
1975 } else {
1976 MYLOGE("invalid suffix provided by user: %s\n", name.c_str());
1977 }
1978 }
1979 if (change_suffix) {
1980 MYLOGI("changing suffix from %s to %s\n", ds.name_.c_str(), name.c_str());
1981 ds.name_ = name;
1982 if (!ds.screenshot_path_.empty()) {
1983 std::string new_screenshot_path = ds.GetPath(".png");
1984 if (rename(ds.screenshot_path_.c_str(), new_screenshot_path.c_str())) {
1985 MYLOGE("rename(%s, %s): %s\n", ds.screenshot_path_.c_str(),
1986 new_screenshot_path.c_str(), strerror(errno));
1987 } else {
1988 ds.screenshot_path_ = new_screenshot_path;
1989 }
1990 }
1991 }
1992
1993 bool do_text_file = true;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01001994 if (ds.options_->do_zip_file) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01001995 if (!ds.FinishZipFile()) {
1996 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
1997 do_text_file = true;
1998 } else {
1999 do_text_file = false;
Nandana Dutt383d0c12018-11-30 15:54:56 +00002000 // If the user has changed the suffix, we need to change the zip file name.
2001 std::string new_path = ds.GetPath(".zip");
2002 if (ds.path_ != new_path) {
2003 MYLOGD("Renaming zip file from %s to %s\n", ds.path_.c_str(), new_path.c_str());
2004 if (rename(ds.path_.c_str(), new_path.c_str())) {
2005 MYLOGE("rename(%s, %s): %s\n", ds.path_.c_str(), new_path.c_str(),
2006 strerror(errno));
2007 } else {
2008 ds.path_ = new_path;
2009 }
2010 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01002011 }
2012 }
2013 if (do_text_file) {
2014 ds.path_ = ds.GetPath(".txt");
2015 MYLOGD("Generating .txt bugreport at %s from %s\n", ds.path_.c_str(), ds.tmp_path_.c_str());
2016 if (rename(ds.tmp_path_.c_str(), ds.path_.c_str())) {
2017 MYLOGE("rename(%s, %s): %s\n", ds.tmp_path_.c_str(), ds.path_.c_str(), strerror(errno));
2018 ds.path_.clear();
2019 }
2020 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002021 if (ds.options_->use_control_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002022 if (do_text_file) {
2023 dprintf(ds.control_socket_fd_,
2024 "FAIL:could not create zip file, check %s "
2025 "for more details\n",
2026 ds.log_path_.c_str());
2027 } else {
2028 dprintf(ds.control_socket_fd_, "OK:%s\n", ds.path_.c_str());
2029 }
2030 }
2031}
2032
2033/* Broadcasts that we are done with the bugreport */
2034static void SendBugreportFinishedBroadcast() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002035 // TODO(b/111441001): use callback instead of broadcast.
Nandana Dutt9a76d202019-01-21 15:56:48 +00002036 if (!ds.path_.empty()) {
2037 MYLOGI("Final bugreport path: %s\n", ds.path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002038 // clang-format off
2039
2040 std::vector<std::string> am_args = {
2041 "--receiver-permission", "android.permission.DUMP",
2042 "--ei", "android.intent.extra.ID", std::to_string(ds.id_),
2043 "--ei", "android.intent.extra.PID", std::to_string(ds.pid_),
2044 "--ei", "android.intent.extra.MAX", std::to_string(ds.progress_->GetMax()),
Nandana Dutt9a76d202019-01-21 15:56:48 +00002045 "--es", "android.intent.extra.BUGREPORT", ds.path_,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002046 "--es", "android.intent.extra.DUMPSTATE_LOG", ds.log_path_
2047 };
2048 // clang-format on
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +00002049 if (ds.options_->do_fb && !android::os::IsFileEmpty(ds.screenshot_path_)) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002050 am_args.push_back("--es");
2051 am_args.push_back("android.intent.extra.SCREENSHOT");
2052 am_args.push_back(ds.screenshot_path_);
2053 }
Nandana Dutt15b89d72018-11-16 14:14:12 +00002054 if (!ds.options_->notification_title.empty()) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002055 am_args.push_back("--es");
2056 am_args.push_back("android.intent.extra.TITLE");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002057 am_args.push_back(ds.options_->notification_title);
2058 if (!ds.options_->notification_description.empty()) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002059 am_args.push_back("--es");
2060 am_args.push_back("android.intent.extra.DESCRIPTION");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002061 am_args.push_back(ds.options_->notification_description);
Nandana Dutt4be45d12018-09-26 15:04:23 +01002062 }
2063 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002064 if (ds.options_->is_remote_mode) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002065 am_args.push_back("--es");
2066 am_args.push_back("android.intent.extra.REMOTE_BUGREPORT_HASH");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002067 am_args.push_back(SHA256_file_hash(ds.path_));
Nandana Dutt4be45d12018-09-26 15:04:23 +01002068 SendBroadcast("com.android.internal.intent.action.REMOTE_BUGREPORT_FINISHED", am_args);
2069 } else {
2070 SendBroadcast("com.android.internal.intent.action.BUGREPORT_FINISHED", am_args);
2071 }
2072 } else {
2073 MYLOGE("Skipping finished broadcast because bugreport could not be generated\n");
2074 }
2075}
2076
Nandana Dutt58d72e22018-11-16 10:30:48 +00002077static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2078 switch (mode) {
2079 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2080 return "BUGREPORT_FULL";
2081 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2082 return "BUGREPORT_INTERACTIVE";
2083 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2084 return "BUGREPORT_REMOTE";
2085 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2086 return "BUGREPORT_WEAR";
2087 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2088 return "BUGREPORT_TELEPHONY";
2089 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2090 return "BUGREPORT_WIFI";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002091 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2092 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002093 }
2094}
2095
2096static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options) {
Abhijeet Kaur8ca245e2018-12-12 10:34:21 +00002097 options->extra_options = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002098 switch (mode) {
2099 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2100 options->do_broadcast = true;
2101 options->do_fb = true;
2102 break;
2103 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002104 // Currently, the dumpstate binder is only used by Shell to update progress.
2105 options->do_start_service = true;
2106 options->do_progress_updates = true;
2107 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002108 options->do_broadcast = true;
2109 break;
2110 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002111 options->do_vibrate = false;
2112 options->is_remote_mode = true;
2113 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002114 options->do_broadcast = true;
2115 break;
2116 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002117 options->do_start_service = true;
2118 options->do_progress_updates = true;
2119 options->do_zip_file = true;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002120 options->do_fb = true;
2121 options->do_broadcast = true;
2122 break;
2123 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002124 options->telephony_only = true;
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +00002125 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002126 options->do_broadcast = true;
2127 break;
2128 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002129 options->wifi_only = true;
2130 options->do_zip_file = true;
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +00002131 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002132 options->do_broadcast = true;
2133 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002134 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2135 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002136 }
2137}
2138
2139static Dumpstate::BugreportMode getBugreportModeFromProperty() {
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002140 // If the system property is not set, it's assumed to be a default bugreport.
2141 Dumpstate::BugreportMode mode = Dumpstate::BugreportMode::BUGREPORT_DEFAULT;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002142
2143 std::string extra_options = android::base::GetProperty(PROPERTY_EXTRA_OPTIONS, "");
2144 if (!extra_options.empty()) {
2145 // Framework uses a system property to override some command-line args.
2146 // Currently, it contains the type of the requested bugreport.
2147 if (extra_options == "bugreportplus") {
2148 mode = Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002149 } else if (extra_options == "bugreportfull") {
2150 mode = Dumpstate::BugreportMode::BUGREPORT_FULL;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002151 } else if (extra_options == "bugreportremote") {
2152 mode = Dumpstate::BugreportMode::BUGREPORT_REMOTE;
2153 } else if (extra_options == "bugreportwear") {
2154 mode = Dumpstate::BugreportMode::BUGREPORT_WEAR;
2155 } else if (extra_options == "bugreporttelephony") {
2156 mode = Dumpstate::BugreportMode::BUGREPORT_TELEPHONY;
2157 } else if (extra_options == "bugreportwifi") {
2158 mode = Dumpstate::BugreportMode::BUGREPORT_WIFI;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002159 } else {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002160 MYLOGE("Unknown extra option: %s\n", extra_options.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002161 }
2162 // Reset the property
2163 android::base::SetProperty(PROPERTY_EXTRA_OPTIONS, "");
2164 }
Nandana Dutt58d72e22018-11-16 10:30:48 +00002165 return mode;
2166}
2167
2168// TODO: Move away from system properties when we have options passed via binder calls.
2169/* Sets runtime options from the system properties and then clears those properties. */
2170static void SetOptionsFromProperties(Dumpstate::DumpOptions* options) {
2171 Dumpstate::BugreportMode mode = getBugreportModeFromProperty();
2172 SetOptionsFromMode(mode, options);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002173
2174 options->notification_title = android::base::GetProperty(PROPERTY_EXTRA_TITLE, "");
2175 if (!options->notification_title.empty()) {
2176 // Reset the property
2177 android::base::SetProperty(PROPERTY_EXTRA_TITLE, "");
2178
Nandana Duttdd8cca32018-11-14 10:10:29 +00002179 options->notification_description =
2180 android::base::GetProperty(PROPERTY_EXTRA_DESCRIPTION, "");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002181 if (!options->notification_description.empty()) {
2182 // Reset the property
2183 android::base::SetProperty(PROPERTY_EXTRA_DESCRIPTION, "");
2184 }
2185 MYLOGD("notification (title: %s, description: %s)\n", options->notification_title.c_str(),
2186 options->notification_description.c_str());
2187 }
2188}
2189
Nandana Dutt58d72e22018-11-16 10:30:48 +00002190static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
2191 MYLOGI("do_zip_file: %d\n", options.do_zip_file);
2192 MYLOGI("do_add_date: %d\n", options.do_add_date);
2193 MYLOGI("do_vibrate: %d\n", options.do_vibrate);
2194 MYLOGI("use_socket: %d\n", options.use_socket);
2195 MYLOGI("use_control_socket: %d\n", options.use_control_socket);
2196 MYLOGI("do_fb: %d\n", options.do_fb);
2197 MYLOGI("do_broadcast: %d\n", options.do_broadcast);
2198 MYLOGI("is_remote_mode: %d\n", options.is_remote_mode);
2199 MYLOGI("show_header_only: %d\n", options.show_header_only);
2200 MYLOGI("do_start_service: %d\n", options.do_start_service);
2201 MYLOGI("telephony_only: %d\n", options.telephony_only);
2202 MYLOGI("wifi_only: %d\n", options.wifi_only);
2203 MYLOGI("do_progress_updates: %d\n", options.do_progress_updates);
Nandana Dutt54dbd672019-01-11 12:58:05 +00002204 MYLOGI("fd: %d\n", options.bugreport_fd.get());
Nandana Dutt58d72e22018-11-16 10:30:48 +00002205 MYLOGI("extra_options: %s\n", options.extra_options.c_str());
2206 MYLOGI("args: %s\n", options.args.c_str());
2207 MYLOGI("notification_title: %s\n", options.notification_title.c_str());
2208 MYLOGI("notification_description: %s\n", options.notification_description.c_str());
2209}
2210
Nandana Dutt54dbd672019-01-11 12:58:05 +00002211void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode,
2212 const android::base::unique_fd& bugreport_fd_in,
2213 const android::base::unique_fd& screenshot_fd_in) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002214 // In the new API world, date is always added; output is always a zip file.
2215 // TODO(111441001): remove these options once they are obsolete.
2216 do_add_date = true;
2217 do_zip_file = true;
2218
Nandana Dutt54dbd672019-01-11 12:58:05 +00002219 // Duplicate the fds because the passed in fds don't outlive the binder transaction.
2220 bugreport_fd.reset(dup(bugreport_fd_in.get()));
2221 screenshot_fd.reset(dup(screenshot_fd_in.get()));
Nandana Dutt58d72e22018-11-16 10:30:48 +00002222
2223 extra_options = ModeToString(bugreport_mode);
2224 SetOptionsFromMode(bugreport_mode, this);
2225}
2226
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002227Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
2228 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002229 int c;
Nandana Dutt235864b2019-01-22 12:10:16 +00002230 while ((c = getopt(argc, argv, "dho:svqzpPBRSV:w")) != -1) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002231 switch (c) {
2232 // clang-format off
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002233 case 'd': do_add_date = true; break;
2234 case 'z': do_zip_file = true; break;
Nandana Dutt9a76d202019-01-21 15:56:48 +00002235 // o=use_outfile not supported anymore.
2236 // TODO(b/111441001): Remove when all callers have migrated.
2237 case 'o': break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002238 case 's': use_socket = true; break;
2239 case 'S': use_control_socket = true; break;
2240 case 'v': show_header_only = true; break;
2241 case 'q': do_vibrate = false; break;
2242 case 'p': do_fb = true; break;
2243 case 'P': do_progress_updates = true; break;
2244 case 'R': is_remote_mode = true; break;
2245 case 'B': do_broadcast = true; break;
2246 case 'V': break; // compatibility no-op
Nandana Dutt235864b2019-01-22 12:10:16 +00002247 case 'w':
2248 // This was already processed
2249 break;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002250 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002251 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002252 break;
2253 default:
2254 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002255 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002256 break;
2257 // clang-format on
2258 }
2259 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08002260
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002261 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002262 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002263 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002264 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002265 }
2266 }
2267
2268 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
2269 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002270
2271 SetOptionsFromProperties(this);
2272 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002273}
2274
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002275bool Dumpstate::DumpOptions::ValidateOptions() const {
Nandana Dutt54dbd672019-01-11 12:58:05 +00002276 if (bugreport_fd.get() != -1 && !do_zip_file) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002277 return false;
2278 }
2279
Nandana Dutt9a76d202019-01-21 15:56:48 +00002280 if ((do_zip_file || do_add_date || do_progress_updates || do_broadcast) && !OutputToFile()) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002281 return false;
2282 }
2283
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002284 if (use_control_socket && !do_zip_file) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002285 return false;
2286 }
2287
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002288 if (do_progress_updates && !do_broadcast) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002289 return false;
2290 }
2291
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002292 if (is_remote_mode && (do_progress_updates || !do_broadcast || !do_zip_file || !do_add_date)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002293 return false;
2294 }
2295 return true;
2296}
2297
Nandana Dutt197661d2018-11-16 16:40:21 +00002298void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
2299 options_ = std::move(options);
2300}
2301
Nandana Duttd2f5f082019-01-18 17:13:52 +00002302Dumpstate::RunStatus Dumpstate::Run(int32_t calling_uid, const std::string& calling_package) {
2303 Dumpstate::RunStatus status = RunInternal(calling_uid, calling_package);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002304 if (listener_ != nullptr) {
2305 switch (status) {
2306 case Dumpstate::RunStatus::OK:
Nandana Duttcc4ead82019-01-23 08:29:23 +00002307 listener_->onFinished();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002308 break;
2309 case Dumpstate::RunStatus::HELP:
2310 break;
2311 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002312 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_INVALID_INPUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002313 break;
2314 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002315 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_RUNTIME_ERROR);
2316 break;
2317 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2318 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_DENIED_CONSENT);
2319 break;
2320 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
2321 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_CONSENT_TIMED_OUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002322 break;
2323 }
2324 }
2325 return status;
2326}
2327
Nandana Dutt979388e2018-11-30 16:48:55 +00002328/*
2329 * Dumps relevant information to a bugreport based on the given options.
2330 *
2331 * The bugreport can be dumped to a file or streamed to a socket.
2332 *
2333 * How dumping to file works:
2334 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
2335 * stderr is redirected a log file.
2336 *
2337 * The temporary bugreport is then populated via printfs, dumping contents of files and
2338 * output of commands to stdout.
2339 *
2340 * If zipping, the temporary bugreport file is added to the zip archive. Else it's renamed to final
2341 * text file.
2342 *
2343 * If zipping, a bunch of other files and dumps also get added to the zip archive. The log file also
2344 * gets added to the archive.
2345 *
Nandana Dutt9a76d202019-01-21 15:56:48 +00002346 * Bugreports are first generated in a local directory and later copied to the caller's fd if
2347 * supplied.
Nandana Dutt979388e2018-11-30 16:48:55 +00002348 */
Nandana Duttd2f5f082019-01-18 17:13:52 +00002349Dumpstate::RunStatus Dumpstate::RunInternal(int32_t calling_uid,
2350 const std::string& calling_package) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002351 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00002352 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002353 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002354 return RunStatus::INVALID_INPUT;
2355 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002356 /* set as high priority, and protect from OOM killer */
2357 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002358
Felipe Lemed071c682016-10-20 16:48:00 -07002359 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002360 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002361 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002362 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002363 } else {
2364 /* fallback to kernels <= 2.6.35 */
2365 oom_adj = fopen("/proc/self/oom_adj", "we");
2366 if (oom_adj) {
2367 fputs("-17", oom_adj);
2368 fclose(oom_adj);
2369 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002370 }
2371
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002372 if (version_ == VERSION_DEFAULT) {
2373 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00002374 }
2375
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002376 if (version_ != VERSION_CURRENT && version_ != VERSION_SPLIT_ANR) {
Vishnu Nair64afc022018-02-01 15:29:34 -08002377 MYLOGE("invalid version requested ('%s'); suppported values are: ('%s', '%s', '%s')\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002378 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str(),
Vishnu Nair64afc022018-02-01 15:29:34 -08002379 VERSION_SPLIT_ANR.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002380 return RunStatus::INVALID_INPUT;
Felipe Lemed071c682016-10-20 16:48:00 -07002381 }
2382
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002383 if (options_->show_header_only) {
2384 PrintHeader();
2385 return RunStatus::OK;
Felipe Lemed071c682016-10-20 16:48:00 -07002386 }
2387
Nandana Duttd2f5f082019-01-18 17:13:52 +00002388 if (options_->bugreport_fd.get() != -1) {
2389 // If the output needs to be copied over to the caller's fd, get user consent.
2390 android::String16 package(calling_package.c_str());
2391 CheckUserConsent(calling_uid, package);
2392 }
2393
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002394 // Redirect output if needed
Nandana Dutt9a76d202019-01-21 15:56:48 +00002395 bool is_redirecting = options_->OutputToFile();
Felipe Leme7447d7c2016-11-03 18:12:22 -07002396
2397 // TODO: temporarily set progress until it's part of the Dumpstate constructor
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002398 std::string stats_path =
Nandana Dutt979388e2018-11-30 16:48:55 +00002399 is_redirecting
2400 ? android::base::StringPrintf("%s/dumpstate-stats.txt", bugreport_internal_dir_.c_str())
2401 : "";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002402 progress_.reset(new Progress(stats_path));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002403
Felipe Lemed071c682016-10-20 16:48:00 -07002404 /* gets the sequential id */
Felipe Leme7447d7c2016-11-03 18:12:22 -07002405 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002406 id_ = ++last_id;
Felipe Lemed071c682016-10-20 16:48:00 -07002407 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
2408
2409 MYLOGI("begin\n");
2410
Sahana Raof35ed432019-07-12 10:47:52 +01002411 if (acquire_wake_lock(PARTIAL_WAKE_LOCK, WAKE_LOCK_NAME) < 0) {
2412 MYLOGE("Failed to acquire wake lock: %s\n", strerror(errno));
2413 } else {
2414 // Wake lock will be released automatically on process death
2415 MYLOGD("Wake lock acquired.\n");
2416 }
2417
Felipe Leme6ae5c4f2017-01-10 14:13:22 -08002418 register_sig_handler();
Felipe Lemed071c682016-10-20 16:48:00 -07002419
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002420 // TODO(b/111441001): maybe skip if already started?
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002421 if (options_->do_start_service) {
Felipe Leme75876a22016-10-27 16:31:27 -07002422 MYLOGI("Starting 'dumpstate' service\n");
2423 android::status_t ret;
2424 if ((ret = android::os::DumpstateService::Start()) != android::OK) {
2425 MYLOGE("Unable to start DumpstateService: %d\n", ret);
2426 }
2427 }
2428
Felipe Lemef0292972016-11-22 13:57:05 -08002429 if (PropertiesHelper::IsDryRun()) {
Felipe Lemed071c682016-10-20 16:48:00 -07002430 MYLOGI("Running on dry-run mode (to disable it, call 'setprop dumpstate.dry_run false')\n");
2431 }
2432
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002433 MYLOGI("dumpstate info: id=%d, args='%s', extra_options= %s)\n", id_, options_->args.c_str(),
2434 options_->extra_options.c_str());
Felipe Lemed071c682016-10-20 16:48:00 -07002435
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002436 MYLOGI("bugreport format version: %s\n", version_.c_str());
Felipe Leme809d74e2016-02-02 12:57:00 -08002437
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002438 do_early_screenshot_ = options_->do_progress_updates;
Felipe Lemee338bf62015-12-07 14:03:50 -08002439
Christopher Ferrised9354f2014-10-01 17:35:01 -07002440 // If we are going to use a socket, do it as early as possible
2441 // to avoid timeouts from bugreport.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002442 if (options_->use_socket) {
Nandana Dutta344cb62019-02-22 15:12:35 +00002443 if (!redirect_to_socket(stdout, "dumpstate")) {
2444 return ERROR;
2445 }
Christopher Ferrised9354f2014-10-01 17:35:01 -07002446 }
2447
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002448 if (options_->use_control_socket) {
Felipe Leme2628e9e2016-04-12 16:36:51 -07002449 MYLOGD("Opening control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002450 control_socket_fd_ = open_socket("dumpstate");
Nandana Dutta344cb62019-02-22 15:12:35 +00002451 if (control_socket_fd_ == -1) {
2452 return ERROR;
2453 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002454 options_->do_progress_updates = 1;
Felipe Leme2628e9e2016-04-12 16:36:51 -07002455 }
2456
Felipe Leme71bbfc52015-11-23 14:14:51 -08002457 if (is_redirecting) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002458 PrepareToWriteToFile();
Felipe Leme1e9edc62015-12-21 16:02:13 -08002459
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002460 if (options_->do_progress_updates) {
2461 if (options_->do_broadcast) {
Felipe Lemedcd1f0d2016-08-04 12:48:50 -07002462 // clang-format off
2463 std::vector<std::string> am_args = {
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002464 "--receiver-permission", "android.permission.DUMP",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002465 "--es", "android.intent.extra.NAME", name_,
2466 "--ei", "android.intent.extra.ID", std::to_string(id_),
2467 "--ei", "android.intent.extra.PID", std::to_string(pid_),
2468 "--ei", "android.intent.extra.MAX", std::to_string(progress_->GetMax()),
Felipe Lemedcd1f0d2016-08-04 12:48:50 -07002469 };
2470 // clang-format on
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002471 SendBroadcast("com.android.internal.intent.action.BUGREPORT_STARTED", am_args);
Felipe Lemedcd1f0d2016-08-04 12:48:50 -07002472 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002473 if (options_->use_control_socket) {
2474 dprintf(control_socket_fd_, "BEGIN:%s\n", path_.c_str());
Felipe Lemeaabfcae2016-07-29 09:49:04 -07002475 }
Felipe Leme71bbfc52015-11-23 14:14:51 -08002476 }
2477 }
2478
Nick Kralevichf3599b32016-01-25 15:05:16 -08002479 /* read /proc/cmdline before dropping root */
2480 FILE *cmdline = fopen("/proc/cmdline", "re");
2481 if (cmdline) {
2482 fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
2483 fclose(cmdline);
2484 }
2485
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002486 if (options_->do_vibrate) {
Felipe Leme35b8cf12017-02-10 15:47:29 -08002487 Vibrate(150);
John Michelau1f794c42012-09-17 11:20:19 -05002488 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002489
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002490 if (options_->do_fb && do_early_screenshot_) {
Greg Kaiser3ddc3fa2019-05-23 16:14:52 -07002491 MYLOGI("taking early screenshot\n");
2492 TakeScreenshot();
Felipe Lemee338bf62015-12-07 14:03:50 -08002493 }
2494
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002495 if (options_->do_zip_file && zip_file != nullptr) {
2496 if (chown(path_.c_str(), AID_SHELL, AID_SHELL)) {
2497 MYLOGE("Unable to change ownership of zip file %s: %s\n", path_.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -07002498 strerror(errno));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002499 }
2500 }
2501
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002502 int dup_stdout_fd;
2503 int dup_stderr_fd;
Felipe Leme71bbfc52015-11-23 14:14:51 -08002504 if (is_redirecting) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002505 // Redirect stderr to log_path_ for debugging.
Vishnu Nair20cf5032018-01-05 13:15:49 -08002506 TEMP_FAILURE_RETRY(dup_stderr_fd = dup(fileno(stderr)));
Nandana Dutta344cb62019-02-22 15:12:35 +00002507 if (!redirect_to_file(stderr, const_cast<char*>(log_path_.c_str()))) {
2508 return ERROR;
2509 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002510 if (chown(log_path_.c_str(), AID_SHELL, AID_SHELL)) {
2511 MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n", log_path_.c_str(),
2512 strerror(errno));
Felipe Leme6fe9db62016-02-12 09:04:16 -08002513 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002514
2515 // Redirect stdout to tmp_path_. This is the main bugreport entry and will be
2516 // moved into zip file later, if zipping.
Vishnu Nair20cf5032018-01-05 13:15:49 -08002517 TEMP_FAILURE_RETRY(dup_stdout_fd = dup(fileno(stdout)));
Nandana Dutt979388e2018-11-30 16:48:55 +00002518 // TODO: why not write to a file instead of stdout to overcome this problem?
Felipe Leme6e01fa62015-11-11 19:35:14 -08002519 /* TODO: rather than generating a text file now and zipping it later,
2520 it would be more efficient to redirect stdout to the zip entry
2521 directly, but the libziparchive doesn't support that option yet. */
Nandana Dutta344cb62019-02-22 15:12:35 +00002522 if (!redirect_to_file(stdout, const_cast<char*>(tmp_path_.c_str()))) {
2523 return ERROR;
2524 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002525 if (chown(tmp_path_.c_str(), AID_SHELL, AID_SHELL)) {
Felipe Leme6fe9db62016-02-12 09:04:16 -08002526 MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002527 tmp_path_.c_str(), strerror(errno));
Felipe Leme6fe9db62016-02-12 09:04:16 -08002528 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002529 }
Felipe Lemed8b94e52016-12-08 10:21:44 -08002530
2531 // Don't buffer stdout
2532 setvbuf(stdout, nullptr, _IONBF, 0);
2533
Felipe Leme608385d2016-02-01 10:35:38 -08002534 // NOTE: there should be no stdout output until now, otherwise it would break the header.
2535 // In particular, DurationReport objects should be created passing 'title, NULL', so their
Felipe Lemecbce55d2016-02-08 09:53:18 -08002536 // duration is logged into MYLOG instead.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002537 PrintHeader();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002538
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002539 if (options_->telephony_only) {
Jayachandran Ca94c7172017-06-10 15:08:12 -07002540 DumpstateTelephonyOnly();
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002541 DumpstateBoard();
2542 } else if (options_->wifi_only) {
mukesh agrawal253dad42018-01-23 21:59:59 -08002543 DumpstateWifiOnly();
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002544 } else {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002545 // Dump state for the default case. This also drops root.
Nandana Duttbbdb5b42019-03-12 10:52:56 +00002546 RunStatus s = DumpstateDefault();
2547 if (s != RunStatus::OK) {
2548 if (s == RunStatus::USER_CONSENT_TIMED_OUT) {
2549 HandleUserConsentDenied();
2550 }
2551 return s;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002552 }
Zhengyin Qian068ecc72016-08-10 16:48:14 -07002553 }
Felipe Leme71a74ac2016-03-17 15:43:25 -07002554
Felipe Leme55b42a62015-11-10 17:39:08 -08002555 /* close output if needed */
Felipe Leme71bbfc52015-11-23 14:14:51 -08002556 if (is_redirecting) {
Vishnu Nair20cf5032018-01-05 13:15:49 -08002557 TEMP_FAILURE_RETRY(dup2(dup_stdout_fd, fileno(stdout)));
Colin Crossf45fa6b2012-03-26 12:38:26 -07002558 }
2559
Nandana Duttd2f5f082019-01-18 17:13:52 +00002560 // Rename, and/or zip the (now complete) .tmp file within the internal directory.
Nandana Dutt9a76d202019-01-21 15:56:48 +00002561 if (options_->OutputToFile()) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002562 FinalizeFile();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002563 }
2564
Nandana Duttd2f5f082019-01-18 17:13:52 +00002565 // Share the final file with the caller if the user has consented.
2566 Dumpstate::RunStatus status = Dumpstate::RunStatus::OK;
2567 if (options_->bugreport_fd.get() != -1) {
2568 status = CopyBugreportIfUserConsented();
2569 if (status != Dumpstate::RunStatus::OK &&
2570 status != Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2571 // Do an early return if there were errors. We make an exception for consent
2572 // timing out because it's possible the user got distracted. In this case the
2573 // bugreport is not shared but made available for manual retrieval.
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002574 MYLOGI("User denied consent. Returning\n");
Nandana Duttd2f5f082019-01-18 17:13:52 +00002575 return status;
2576 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002577 if (options_->do_fb && options_->screenshot_fd.get() != -1) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00002578 bool copy_succeeded = android::os::CopyFileToFd(screenshot_path_,
2579 options_->screenshot_fd.get());
2580 if (copy_succeeded) {
2581 android::os::UnlinkAndLogOnError(screenshot_path_);
2582 }
2583 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002584 if (status == Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2585 MYLOGI(
2586 "Did not receive user consent yet."
2587 " Will not copy the bugreport artifacts to caller.\n");
Abhijeet Kaur57627412019-04-17 16:00:09 +01002588 const String16 incidentcompanion("incidentcompanion");
2589 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
2590 if (ics != nullptr) {
2591 MYLOGD("Canceling user consent request via incidentcompanion service\n");
2592 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
2593 consent_callback_.get());
2594 } else {
2595 MYLOGD("Unable to cancel user consent; incidentcompanion service unavailable\n");
2596 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002597 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00002598 }
2599
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002600 /* vibrate a few but shortly times to let user know it's finished */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002601 if (options_->do_vibrate) {
Takuya Ogawa47f644e2017-12-20 18:09:09 +09002602 for (int i = 0; i < 3; i++) {
2603 Vibrate(75);
2604 usleep((75 + 50) * 1000);
2605 }
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002606 }
2607
Jeff Brown1dc94e32014-09-11 14:15:27 -07002608 /* tell activity manager we're done */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002609 if (options_->do_broadcast) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002610 SendBugreportFinishedBroadcast();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002611 // Note that listener_ is notified in Run();
Jeff Sharkey27f9e6d2013-03-13 15:45:50 -07002612 }
2613
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002614 MYLOGD("Final progress: %d/%d (estimated %d)\n", progress_->Get(), progress_->GetMax(),
2615 progress_->GetInitialMax());
2616 progress_->Save();
2617 MYLOGI("done (id %d)\n", id_);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002618
Felipe Leme107a05f2016-03-08 15:11:15 -08002619 if (is_redirecting) {
Vishnu Nair20cf5032018-01-05 13:15:49 -08002620 TEMP_FAILURE_RETRY(dup2(dup_stderr_fd, fileno(stderr)));
Felipe Leme107a05f2016-03-08 15:11:15 -08002621 }
2622
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002623 if (options_->use_control_socket && control_socket_fd_ != -1) {
Felipe Lemee844a9d2016-09-21 15:01:39 -07002624 MYLOGD("Closing control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002625 close(control_socket_fd_);
Felipe Leme2628e9e2016-04-12 16:36:51 -07002626 }
2627
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002628 tombstone_data_.clear();
2629 anr_data_.clear();
Narayan Kamath6b9516c2017-10-27 11:15:51 +01002630
Nandana Duttd2f5f082019-01-18 17:13:52 +00002631 return (consent_callback_ != nullptr &&
2632 consent_callback_->getResult() == UserConsentResult::UNAVAILABLE)
2633 ? USER_CONSENT_TIMED_OUT
2634 : RunStatus::OK;
2635}
2636
2637void Dumpstate::CheckUserConsent(int32_t calling_uid, const android::String16& calling_package) {
2638 consent_callback_ = new ConsentCallback();
2639 const String16 incidentcompanion("incidentcompanion");
2640 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
2641 if (ics != nullptr) {
2642 MYLOGD("Checking user consent via incidentcompanion service\n");
2643 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
2644 calling_uid, calling_package, 0x1 /* FLAG_CONFIRMATION_DIALOG */,
2645 consent_callback_.get());
2646 } else {
2647 MYLOGD("Unable to check user consent; incidentcompanion service unavailable\n");
2648 }
2649}
2650
Nandana Duttbbdb5b42019-03-12 10:52:56 +00002651bool Dumpstate::IsUserConsentDenied() const {
2652 return ds.consent_callback_ != nullptr &&
2653 ds.consent_callback_->getResult() == UserConsentResult::DENIED;
2654}
2655
Nandana Duttd2f5f082019-01-18 17:13:52 +00002656void Dumpstate::CleanupFiles() {
2657 android::os::UnlinkAndLogOnError(tmp_path_);
2658 android::os::UnlinkAndLogOnError(screenshot_path_);
2659 android::os::UnlinkAndLogOnError(path_);
2660}
2661
2662Dumpstate::RunStatus Dumpstate::HandleUserConsentDenied() {
2663 MYLOGD("User denied consent; deleting files and returning\n");
2664 CleanupFiles();
2665 return USER_CONSENT_DENIED;
2666}
2667
2668Dumpstate::RunStatus Dumpstate::CopyBugreportIfUserConsented() {
2669 // If the caller has asked to copy the bugreport over to their directory, we need explicit
2670 // user consent.
2671 UserConsentResult consent_result = consent_callback_->getResult();
2672 if (consent_result == UserConsentResult::UNAVAILABLE) {
2673 // User has not responded yet.
2674 uint64_t elapsed_ms = consent_callback_->getElapsedTimeMs();
2675 if (elapsed_ms < USER_CONSENT_TIMEOUT_MS) {
2676 uint delay_seconds = (USER_CONSENT_TIMEOUT_MS - elapsed_ms) / 1000;
2677 MYLOGD("Did not receive user consent yet; going to wait for %d seconds", delay_seconds);
2678 sleep(delay_seconds);
2679 }
2680 consent_result = consent_callback_->getResult();
2681 }
2682 if (consent_result == UserConsentResult::DENIED) {
2683 // User has explicitly denied sharing with the app. To be safe delete the
2684 // internal bugreport & tmp files.
2685 return HandleUserConsentDenied();
2686 }
2687 if (consent_result == UserConsentResult::APPROVED) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00002688 bool copy_succeeded = android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
2689 if (copy_succeeded) {
2690 android::os::UnlinkAndLogOnError(path_);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002691 }
2692 return copy_succeeded ? Dumpstate::RunStatus::OK : Dumpstate::RunStatus::ERROR;
2693 } else if (consent_result == UserConsentResult::UNAVAILABLE) {
2694 // consent_result is still UNAVAILABLE. The user has likely not responded yet.
2695 // Since we do not have user consent to share the bugreport it does not get
2696 // copied over to the calling app but remains in the internal directory from
2697 // where the user can manually pull it.
2698 return Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT;
2699 }
2700 // Unknown result; must be a programming error.
2701 MYLOGE("Unknown user consent result:%d\n", consent_result);
2702 return Dumpstate::RunStatus::ERROR;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002703}
2704
Nandana Duttf02564e2019-02-15 15:24:24 +00002705Dumpstate::RunStatus Dumpstate::ParseCommandlineAndRun(int argc, char* argv[]) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002706 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
2707 Dumpstate::RunStatus status = options->Initialize(argc, argv);
2708 if (status == Dumpstate::RunStatus::OK) {
Nandana Duttf02564e2019-02-15 15:24:24 +00002709 SetOptions(std::move(options));
Nandana Duttd2f5f082019-01-18 17:13:52 +00002710 // When directly running dumpstate binary, the output is not expected to be written
2711 // to any external file descriptor.
Nandana Duttf02564e2019-02-15 15:24:24 +00002712 assert(options_->bugreport_fd.get() == -1);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002713
2714 // calling_uid and calling_package are for user consent to share the bugreport with
2715 // an app; they are irrelvant here because bugreport is only written to a local
2716 // directory, and not shared.
Nandana Duttf02564e2019-02-15 15:24:24 +00002717 status = Run(-1 /* calling_uid */, "" /* calling_package */);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002718 }
Nandana Duttf02564e2019-02-15 15:24:24 +00002719 return status;
2720}
2721
2722/* Main entry point for dumpstate binary. */
2723int run_main(int argc, char* argv[]) {
2724 Dumpstate::RunStatus status = ds.ParseCommandlineAndRun(argc, argv);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002725
2726 switch (status) {
2727 case Dumpstate::RunStatus::OK:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002728 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002729 case Dumpstate::RunStatus::HELP:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002730 ShowUsage();
2731 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002732 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002733 fprintf(stderr, "Invalid combination of args\n");
2734 ShowUsage();
2735 exit(1);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002736 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002737 FALLTHROUGH_INTENDED;
2738 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2739 FALLTHROUGH_INTENDED;
2740 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002741 exit(2);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002742 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002743}