blob: 1884b33fe39e476cafc36c7d41724b0006f99375 [file] [log] [blame]
Colin Crossf45fa6b2012-03-26 12:38:26 -07001/*
2 * Copyright (C) 2008 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
Felipe Lemef0292972016-11-22 13:57:05 -080016
Mark Salyzyn6c3d90f2016-09-27 14:55:27 -070017#define LOG_TAG "dumpstate"
Colin Crossf45fa6b2012-03-26 12:38:26 -070018
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -070019#include <dirent.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070020#include <errno.h>
21#include <fcntl.h>
Felipe Lemead5f6c42015-11-30 14:26:46 -080022#include <libgen.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070023#include <limits.h>
Mark Salyzyn8f37aa52015-06-12 12:28:24 -070024#include <stdbool.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070025#include <stdio.h>
26#include <stdlib.h>
27#include <string.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080028#include <sys/poll.h>
Christopher Ferris7dc7f322014-07-22 16:08:19 -070029#include <sys/prctl.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070030#include <sys/resource.h>
31#include <sys/stat.h>
32#include <sys/time.h>
33#include <sys/wait.h>
34#include <unistd.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070035
36#include <chrono>
37#include <functional>
38#include <future>
Narayan Kamath8f788292017-05-25 13:20:39 +010039#include <memory>
40#include <regex>
41#include <set>
42#include <string>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070043#include <utility>
Narayan Kamath8f788292017-05-25 13:20:39 +010044#include <vector>
Colin Crossf45fa6b2012-03-26 12:38:26 -070045
Felipe Leme96c2bbb2016-09-26 09:21:21 -070046#include <android-base/file.h>
47#include <android-base/properties.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070048#include <android-base/scopeguard.h>
Elliott Hughes9dc117c2015-12-07 14:21:50 -080049#include <android-base/stringprintf.h>
Naveen Kalla058e1e82016-10-19 21:38:44 -070050#include <android-base/strings.h>
Andreas Gampeaff68432016-07-18 18:01:27 -070051#include <android-base/unique_fd.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080052#include <android/hardware/dumpstate/1.0/IDumpstateDevice.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080053#include <android/hidl/manager/1.0/IServiceManager.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080054#include <cutils/native_handle.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070055#include <cutils/properties.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080056#include <dumpsys.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080057#include <hidl/ServiceManagement.h>
Felipe Leme75876a22016-10-27 16:31:27 -070058#include <openssl/sha.h>
Mark Salyzyn6c3d90f2016-09-27 14:55:27 -070059#include <private/android_filesystem_config.h>
60#include <private/android_logger.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080061#include <serviceutils/PriorityDumper.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070062#include <utils/StrongPointer.h>
Felipe Lemef0292972016-11-22 13:57:05 -080063#include "DumpstateInternal.h"
Vishnu Naire97d6122018-01-18 13:58:56 -080064#include "DumpstateSectionReporter.h"
Felipe Leme75876a22016-10-27 16:31:27 -070065#include "DumpstateService.h"
Colin Crossf45fa6b2012-03-26 12:38:26 -070066#include "dumpstate.h"
Felipe Leme6e01fa62015-11-11 19:35:14 -080067
Steven Morelandcb7ef822016-11-29 13:20:37 -080068using ::android::hardware::dumpstate::V1_0::IDumpstateDevice;
Vishnu Naire97d6122018-01-18 13:58:56 -080069using ::std::literals::chrono_literals::operator""ms;
70using ::std::literals::chrono_literals::operator""s;
Steven Morelandcb7ef822016-11-29 13:20:37 -080071
Felipe Leme47e9be22016-12-21 15:37:07 -080072// TODO: remove once moved to namespace
Vishnu Naire97d6122018-01-18 13:58:56 -080073using android::defaultServiceManager;
74using android::Dumpsys;
75using android::INVALID_OPERATION;
76using android::IServiceManager;
77using android::OK;
78using android::sp;
79using android::status_t;
80using android::String16;
81using android::String8;
82using android::TIMED_OUT;
83using android::UNKNOWN_ERROR;
84using android::Vector;
Nandana Dutt979388e2018-11-30 16:48:55 +000085using android::base::StringPrintf;
Felipe Leme47e9be22016-12-21 15:37:07 -080086using android::os::dumpstate::CommandOptions;
87using android::os::dumpstate::DumpFileToFd;
Vishnu Naire97d6122018-01-18 13:58:56 -080088using android::os::dumpstate::DumpstateSectionReporter;
Felipe Leme47e9be22016-12-21 15:37:07 -080089using android::os::dumpstate::GetPidByName;
Vishnu Naire97d6122018-01-18 13:58:56 -080090using android::os::dumpstate::PropertiesHelper;
Felipe Leme47e9be22016-12-21 15:37:07 -080091
Colin Crossf45fa6b2012-03-26 12:38:26 -070092/* read before root is shed */
93static char cmdline_buf[16384] = "(unknown)";
Yi Kong19d5c002018-07-20 13:39:55 -070094static const char *dump_traces_path = nullptr;
Colin Crossf45fa6b2012-03-26 12:38:26 -070095
Felipe Leme1d486fe2016-10-14 18:06:47 -070096// TODO: variables and functions below should be part of dumpstate object
97
Felipe Leme635ca312016-01-05 14:23:02 -080098static std::set<std::string> mount_points;
99void add_mountinfo();
Felipe Leme78f2c862015-12-21 09:55:22 -0800100
Todd Poynor2a83daa2013-11-22 15:44:22 -0800101#define PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops"
Mark Salyzyn7d0a7622016-06-24 14:06:15 -0700102#define ALT_PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops-0"
Wei Wang509bb5d2017-06-09 14:42:12 -0700103#define BLK_DEV_SYS_DIR "/sys/block"
Todd Poynor2a83daa2013-11-22 15:44:22 -0800104
Felipe Lemee82a27d2016-01-05 13:35:44 -0800105#define RECOVERY_DIR "/cache/recovery"
Mark Salyzynd6ab0112016-03-25 12:56:39 -0700106#define RECOVERY_DATA_DIR "/data/misc/recovery"
Tianjie Xu75d53362018-04-11 16:42:28 -0700107#define UPDATE_ENGINE_LOG_DIR "/data/misc/update_engine_log"
Mark Salyzyn4d42dea2016-04-01 10:03:14 -0700108#define LOGPERSIST_DATA_DIR "/data/misc/logd"
David Brazdild2991962016-06-03 14:40:44 +0100109#define PROFILE_DATA_DIR_CUR "/data/misc/profiles/cur"
110#define PROFILE_DATA_DIR_REF "/data/misc/profiles/ref"
Benedict Wong8f9d8a42019-01-03 16:19:38 -0800111#define XFRM_STAT_PROC_FILE "/proc/net/xfrm_stat"
Erik Kline08165202016-05-30 11:55:44 +0900112#define WLUTIL "/vendor/xbin/wlutil"
Vishnu Nair36b4cdb2017-11-17 10:27:05 -0800113#define WMTRACE_DATA_DIR "/data/misc/wmtrace"
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700114
Narayan Kamath8f788292017-05-25 13:20:39 +0100115// TODO(narayan): Since this information has to be kept in sync
116// with tombstoned, we should just put it in a common header.
117//
118// File: system/core/debuggerd/tombstoned/tombstoned.cpp
Narayan Kamathbd863722017-06-01 18:50:12 +0100119static const std::string TOMBSTONE_DIR = "/data/tombstones/";
120static const std::string TOMBSTONE_FILE_PREFIX = "tombstone_";
121static const std::string ANR_DIR = "/data/anr/";
122static const std::string ANR_FILE_PREFIX = "anr_";
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700123
Felipe Lemee844a9d2016-09-21 15:01:39 -0700124// TODO: temporary variables and functions used during C++ refactoring
125static Dumpstate& ds = Dumpstate::GetInstance();
Nandana Dutt979388e2018-11-30 16:48:55 +0000126
127namespace android {
128namespace os {
129namespace {
130
131static int Open(std::string path, int flags, mode_t mode = 0) {
132 int fd = TEMP_FAILURE_RETRY(open(path.c_str(), flags, mode));
133 if (fd == -1) {
134 MYLOGE("open(%s, %s)\n", path.c_str(), strerror(errno));
135 }
136 return fd;
137}
138
139static int OpenForWrite(std::string path) {
140 return Open(path, O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
141 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH);
142}
143
144static int OpenForRead(std::string path) {
145 return Open(path, O_RDONLY | O_CLOEXEC | O_NOFOLLOW);
146}
147
148bool CopyFile(int in_fd, int out_fd) {
149 char buf[4096];
150 ssize_t byte_count;
151 while ((byte_count = TEMP_FAILURE_RETRY(read(in_fd, buf, sizeof(buf)))) > 0) {
152 if (!android::base::WriteFully(out_fd, buf, byte_count)) {
153 return false;
154 }
155 }
156 return (byte_count != -1);
157}
158
159static bool CopyFileToFd(const std::string& input_file, int out_fd) {
160 MYLOGD("Going to copy bugreport file (%s) to %d\n", ds.path_.c_str(), out_fd);
161
162 // Obtain a handle to the source file.
163 android::base::unique_fd in_fd(OpenForRead(input_file));
164 if (out_fd != -1 && in_fd.get() != -1) {
165 if (CopyFile(in_fd.get(), out_fd)) {
166 return true;
167 }
168 MYLOGE("Failed to copy zip file: %s\n", strerror(errno));
169 }
170 return false;
171}
172
173static bool CopyFileToFile(const std::string& input_file, const std::string& output_file) {
174 if (input_file == output_file) {
175 MYLOGD("Skipping copying bugreport file since the destination is the same (%s)\n",
176 output_file.c_str());
177 return false;
178 }
179
180 MYLOGD("Going to copy bugreport file (%s) to %s\n", input_file.c_str(), output_file.c_str());
181 android::base::unique_fd out_fd(OpenForWrite(output_file));
182 return CopyFileToFd(input_file, out_fd.get());
183}
184
185} // namespace
186} // namespace os
187} // namespace android
188
Felipe Leme678727a2016-09-21 17:22:11 -0700189static int RunCommand(const std::string& title, const std::vector<std::string>& fullCommand,
190 const CommandOptions& options = CommandOptions::DEFAULT) {
191 return ds.RunCommand(title, fullCommand, options);
192}
193static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
Felipe Lemebda15a02016-11-16 17:48:25 -0800194 const CommandOptions& options = Dumpstate::DEFAULT_DUMPSYS,
Vishnu Nair6921f802017-11-22 09:17:23 -0800195 long dumpsysTimeoutMs = 0) {
196 return ds.RunDumpsys(title, dumpsysArgs, options, dumpsysTimeoutMs);
Felipe Leme678727a2016-09-21 17:22:11 -0700197}
198static int DumpFile(const std::string& title, const std::string& path) {
199 return ds.DumpFile(title, path);
200}
Felipe Lemee82a27d2016-01-05 13:35:44 -0800201
Felipe Lemee844a9d2016-09-21 15:01:39 -0700202// Relative directory (inside the zip) for all files copied as-is into the bugreport.
203static const std::string ZIP_ROOT_DIR = "FS";
204
Vishnu Naire97d6122018-01-18 13:58:56 -0800205static const std::string kProtoPath = "proto/";
206static const std::string kProtoExt = ".proto";
Jie Song9fbfad02017-06-20 16:29:42 -0700207static const std::string kDumpstateBoardFiles[] = {
208 "dumpstate_board.txt",
Felipe Leme95d6ca52017-08-01 16:35:56 -0700209 "dumpstate_board.bin"
Jie Song9fbfad02017-06-20 16:29:42 -0700210};
211static const int NUM_OF_DUMPS = arraysize(kDumpstateBoardFiles);
212
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700213static constexpr char PROPERTY_EXTRA_OPTIONS[] = "dumpstate.options";
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700214static constexpr char PROPERTY_LAST_ID[] = "dumpstate.last_id";
Felipe Lemed071c682016-10-20 16:48:00 -0700215static constexpr char PROPERTY_VERSION[] = "dumpstate.version";
Naveen Kallab53a1c92017-03-16 18:17:25 -0700216static constexpr char PROPERTY_EXTRA_TITLE[] = "dumpstate.options.title";
217static constexpr char PROPERTY_EXTRA_DESCRIPTION[] = "dumpstate.options.description";
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700218
Felipe Lemef0292972016-11-22 13:57:05 -0800219static const CommandOptions AS_ROOT_20 = CommandOptions::WithTimeout(20).AsRoot().Build();
220
Narayan Kamath8f788292017-05-25 13:20:39 +0100221/*
Narayan Kamathbd863722017-06-01 18:50:12 +0100222 * Returns a vector of dump fds under |dir_path| with a given |file_prefix|.
223 * The returned vector is sorted by the mtimes of the dumps. If |limit_by_mtime|
224 * is set, the vector only contains files that were written in the last 30 minutes.
Andreas Gamped0d76952017-08-22 13:08:37 -0700225 * If |limit_by_count| is set, the vector only contains the ten latest files.
Narayan Kamath8f788292017-05-25 13:20:39 +0100226 */
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700227static std::vector<DumpData> GetDumpFds(const std::string& dir_path,
228 const std::string& file_prefix,
229 bool limit_by_mtime,
230 bool limit_by_count = true) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100231 const time_t thirty_minutes_ago = ds.now_ - 60 * 30;
232
Narayan Kamathbd863722017-06-01 18:50:12 +0100233 std::unique_ptr<DIR, decltype(&closedir)> dump_dir(opendir(dir_path.c_str()), closedir);
Narayan Kamath8f788292017-05-25 13:20:39 +0100234
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700235 if (dump_dir == nullptr) {
236 MYLOGW("Unable to open directory %s: %s\n", dir_path.c_str(), strerror(errno));
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700237 return std::vector<DumpData>();
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700238 }
239
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700240 std::vector<DumpData> dump_data;
Narayan Kamathbd863722017-06-01 18:50:12 +0100241 struct dirent* entry = nullptr;
242 while ((entry = readdir(dump_dir.get()))) {
243 if (entry->d_type != DT_REG) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100244 continue;
245 }
246
Narayan Kamathbd863722017-06-01 18:50:12 +0100247 const std::string base_name(entry->d_name);
248 if (base_name.find(file_prefix) != 0) {
249 continue;
250 }
251
252 const std::string abs_path = dir_path + base_name;
253 android::base::unique_fd fd(
254 TEMP_FAILURE_RETRY(open(abs_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW | O_NONBLOCK)));
255 if (fd == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700256 MYLOGW("Unable to open dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamathbd863722017-06-01 18:50:12 +0100257 break;
258 }
259
260 struct stat st = {};
261 if (fstat(fd, &st) == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700262 MYLOGW("Unable to stat dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamath8f788292017-05-25 13:20:39 +0100263 continue;
264 }
265
Narayan Kamath3f31b632018-02-22 19:42:36 +0000266 if (limit_by_mtime && st.st_mtime < thirty_minutes_ago) {
Narayan Kamathbd863722017-06-01 18:50:12 +0100267 MYLOGI("Excluding stale dump file: %s\n", abs_path.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100268 continue;
269 }
270
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700271 dump_data.emplace_back(DumpData{abs_path, std::move(fd), st.st_mtime});
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700272 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100273
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700274 // Sort in descending modification time so that we only keep the newest
275 // reports if |limit_by_count| is true.
276 std::sort(dump_data.begin(), dump_data.end(),
277 [](const DumpData& d1, const DumpData& d2) { return d1.mtime > d2.mtime; });
Narayan Kamath8f788292017-05-25 13:20:39 +0100278
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700279 if (limit_by_count && dump_data.size() > 10) {
280 dump_data.erase(dump_data.begin() + 10, dump_data.end());
Andreas Gamped0d76952017-08-22 13:08:37 -0700281 }
282
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700283 return dump_data;
Narayan Kamath8f788292017-05-25 13:20:39 +0100284}
285
Narayan Kamathbd863722017-06-01 18:50:12 +0100286static bool AddDumps(const std::vector<DumpData>::const_iterator start,
287 const std::vector<DumpData>::const_iterator end,
288 const char* type_name, const bool add_to_zip) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100289 bool dumped = false;
Narayan Kamathbd863722017-06-01 18:50:12 +0100290 for (auto it = start; it != end; ++it) {
291 const std::string& name = it->name;
292 const int fd = it->fd;
Narayan Kamath8f788292017-05-25 13:20:39 +0100293 dumped = true;
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100294
295 // Seek to the beginning of the file before dumping any data. A given
296 // DumpData entry might be dumped multiple times in the report.
297 //
298 // For example, the most recent ANR entry is dumped to the body of the
299 // main entry and it also shows up as a separate entry in the bugreport
300 // ZIP file.
301 if (lseek(fd, 0, SEEK_SET) != static_cast<off_t>(0)) {
302 MYLOGE("Unable to add %s to zip file, lseek failed: %s\n", name.c_str(),
303 strerror(errno));
304 }
305
Narayan Kamath8f788292017-05-25 13:20:39 +0100306 if (ds.IsZipping() && add_to_zip) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800307 if (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + name, fd, /* timeout = */ 0ms) != OK) {
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100308 MYLOGE("Unable to add %s to zip file, addZipEntryFromFd failed\n", name.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100309 }
310 } else {
311 dump_file_from_fd(type_name, name.c_str(), fd);
312 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100313 }
314
315 return dumped;
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700316}
317
Felipe Leme635ca312016-01-05 14:23:02 -0800318// for_each_pid() callback to get mount info about a process.
Felipe Leme4c2d6632016-09-28 14:32:00 -0700319void do_mountinfo(int pid, const char* name __attribute__((unused))) {
Felipe Leme635ca312016-01-05 14:23:02 -0800320 char path[PATH_MAX];
321
322 // Gets the the content of the /proc/PID/ns/mnt link, so only unique mount points
323 // are added.
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700324 snprintf(path, sizeof(path), "/proc/%d/ns/mnt", pid);
Felipe Leme635ca312016-01-05 14:23:02 -0800325 char linkname[PATH_MAX];
326 ssize_t r = readlink(path, linkname, PATH_MAX);
327 if (r == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800328 MYLOGE("Unable to read link for %s: %s\n", path, strerror(errno));
Felipe Leme635ca312016-01-05 14:23:02 -0800329 return;
330 }
331 linkname[r] = '\0';
332
333 if (mount_points.find(linkname) == mount_points.end()) {
334 // First time this mount point was found: add it
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700335 snprintf(path, sizeof(path), "/proc/%d/mountinfo", pid);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700336 if (ds.AddZipEntry(ZIP_ROOT_DIR + path, path)) {
Felipe Leme635ca312016-01-05 14:23:02 -0800337 mount_points.insert(linkname);
338 } else {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800339 MYLOGE("Unable to add mountinfo %s to zip file\n", path);
Felipe Leme635ca312016-01-05 14:23:02 -0800340 }
341 }
342}
343
344void add_mountinfo() {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700345 if (!ds.IsZipping()) return;
Felipe Leme678727a2016-09-21 17:22:11 -0700346 std::string title = "MOUNT INFO";
Felipe Leme635ca312016-01-05 14:23:02 -0800347 mount_points.clear();
Felipe Leme46b85da2016-11-21 17:40:45 -0800348 DurationReporter duration_reporter(title, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700349 for_each_pid(do_mountinfo, nullptr);
350 MYLOGD("%s: %d entries added to zip file\n", title.c_str(), (int)mount_points.size());
Felipe Leme635ca312016-01-05 14:23:02 -0800351}
352
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700353static void dump_dev_files(const char *title, const char *driverpath, const char *filename)
354{
355 DIR *d;
356 struct dirent *de;
357 char path[PATH_MAX];
358
359 d = opendir(driverpath);
Yi Kong19d5c002018-07-20 13:39:55 -0700360 if (d == nullptr) {
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700361 return;
362 }
363
364 while ((de = readdir(d))) {
365 if (de->d_type != DT_LNK) {
366 continue;
367 }
368 snprintf(path, sizeof(path), "%s/%s/%s", driverpath, de->d_name, filename);
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700369 DumpFile(title, path);
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700370 }
371
372 closedir(d);
373}
374
Zhengyin Qian068ecc72016-08-10 16:48:14 -0700375
Zhengyin Qian068ecc72016-08-10 16:48:14 -0700376
377// dump anrd's trace and add to the zip file.
378// 1. check if anrd is running on this device.
379// 2. send a SIGUSR1 to its pid which will dump anrd's trace.
380// 3. wait until the trace generation completes and add to the zip file.
381static bool dump_anrd_trace() {
382 unsigned int pid;
383 char buf[50], path[PATH_MAX];
384 struct dirent *trace;
385 struct stat st;
386 DIR *trace_dir;
Zhengyin Qianafc38fe2016-09-08 16:50:09 -0700387 int retry = 5;
388 long max_ctime = 0, old_mtime;
Zhengyin Qian068ecc72016-08-10 16:48:14 -0700389 long long cur_size = 0;
390 const char *trace_path = "/data/misc/anrd/";
391
Felipe Leme1d486fe2016-10-14 18:06:47 -0700392 if (!ds.IsZipping()) {
393 MYLOGE("Not dumping anrd trace because it's not a zipped bugreport\n");
Zhengyin Qian068ecc72016-08-10 16:48:14 -0700394 return false;
395 }
396
397 // find anrd's pid if it is running.
Dan Willemsen4a0a8342018-05-04 13:05:01 -0700398 pid = GetPidByName("/system/bin/anrd");
Zhengyin Qian068ecc72016-08-10 16:48:14 -0700399
400 if (pid > 0) {
Zhengyin Qianafc38fe2016-09-08 16:50:09 -0700401 if (stat(trace_path, &st) == 0) {
402 old_mtime = st.st_mtime;
403 } else {
404 MYLOGE("Failed to find: %s\n", trace_path);
405 return false;
406 }
407
Zhengyin Qian068ecc72016-08-10 16:48:14 -0700408 // send SIGUSR1 to the anrd to generate a trace.
409 sprintf(buf, "%u", pid);
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700410 if (RunCommand("ANRD_DUMP", {"kill", "-SIGUSR1", buf},
Felipe Leme30dbfa12016-09-02 12:43:26 -0700411 CommandOptions::WithTimeout(1).Build())) {
Zhengyin Qian068ecc72016-08-10 16:48:14 -0700412 MYLOGE("anrd signal timed out. Please manually collect trace\n");
413 return false;
414 }
415
Zhengyin Qianafc38fe2016-09-08 16:50:09 -0700416 while (retry-- > 0 && old_mtime == st.st_mtime) {
417 sleep(1);
418 stat(trace_path, &st);
419 }
420
421 if (retry < 0 && old_mtime == st.st_mtime) {
422 MYLOGE("Failed to stat %s or trace creation timeout\n", trace_path);
423 return false;
424 }
425
Zhengyin Qian068ecc72016-08-10 16:48:14 -0700426 // identify the trace file by its creation time.
427 if (!(trace_dir = opendir(trace_path))) {
428 MYLOGE("Can't open trace file under %s\n", trace_path);
429 }
430 while ((trace = readdir(trace_dir))) {
431 if (strcmp(trace->d_name, ".") == 0
432 || strcmp(trace->d_name, "..") == 0) {
433 continue;
434 }
435 sprintf(path, "%s%s", trace_path, trace->d_name);
436 if (stat(path, &st) == 0) {
437 if (st.st_ctime > max_ctime) {
438 max_ctime = st.st_ctime;
439 sprintf(buf, "%s", trace->d_name);
440 }
441 }
442 }
443 closedir(trace_dir);
444
445 // Wait until the dump completes by checking the size of the trace.
446 if (max_ctime > 0) {
447 sprintf(path, "%s%s", trace_path, buf);
448 while(true) {
449 sleep(1);
450 if (stat(path, &st) == 0) {
451 if (st.st_size == cur_size) {
452 break;
453 } else if (st.st_size > cur_size) {
454 cur_size = st.st_size;
455 } else {
456 return false;
457 }
458 } else {
459 MYLOGE("Cant stat() %s anymore\n", path);
460 return false;
461 }
462 }
463 // Add to the zip file.
Felipe Leme1d486fe2016-10-14 18:06:47 -0700464 if (!ds.AddZipEntry("anrd_trace.txt", path)) {
Zhengyin Qian068ecc72016-08-10 16:48:14 -0700465 MYLOGE("Unable to add anrd_trace file %s to zip file\n", path);
466 } else {
467 if (remove(path)) {
468 MYLOGE("Error removing anrd_trace file %s: %s", path, strerror(errno));
469 }
470 return true;
471 }
472 } else {
473 MYLOGE("Can't stats any trace file under %s\n", trace_path);
474 }
475 }
476 return false;
477}
478
Felipe Lemeefd7e272016-05-18 09:27:16 -0700479static void dump_systrace() {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700480 if (!ds.IsZipping()) {
481 MYLOGD("Not dumping systrace because it's not a zipped bugreport\n");
Felipe Leme71a74ac2016-03-17 15:43:25 -0700482 return;
483 }
Felipe Lemebbaf3c12016-10-11 14:32:25 -0700484 std::string systrace_path = ds.GetPath("-systrace.txt");
Felipe Leme14e034a2016-03-30 18:51:03 -0700485 if (systrace_path.empty()) {
486 MYLOGE("Not dumping systrace because path is empty\n");
487 return;
488 }
Felipe Leme71a74ac2016-03-17 15:43:25 -0700489 const char* path = "/sys/kernel/debug/tracing/tracing_on";
490 long int is_tracing;
491 if (read_file_as_long(path, &is_tracing)) {
492 return; // error already logged
493 }
494 if (is_tracing <= 0) {
495 MYLOGD("Skipping systrace because '%s' content is '%ld'\n", path, is_tracing);
496 return;
497 }
498
Felipe Leme14e034a2016-03-30 18:51:03 -0700499 MYLOGD("Running '/system/bin/atrace --async_dump -o %s', which can take several minutes",
500 systrace_path.c_str());
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700501 if (RunCommand("SYSTRACE", {"/system/bin/atrace", "--async_dump", "-o", systrace_path},
Felipe Leme30dbfa12016-09-02 12:43:26 -0700502 CommandOptions::WithTimeout(120).Build())) {
Felipe Leme14e034a2016-03-30 18:51:03 -0700503 MYLOGE("systrace timed out, its zip entry will be incomplete\n");
Felipe Lemec7fe8fe2016-09-21 18:13:20 -0700504 // TODO: RunCommand tries to kill the process, but atrace doesn't die
Felipe Leme30dbfa12016-09-02 12:43:26 -0700505 // peacefully; ideally, we should call strace to stop itself, but there is no such option
506 // yet (just a --async_stop, which stops and dump
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700507 // if (RunCommand("SYSTRACE", {"/system/bin/atrace", "--kill"})) {
Felipe Leme30dbfa12016-09-02 12:43:26 -0700508 // MYLOGE("could not stop systrace ");
509 // }
Felipe Leme14e034a2016-03-30 18:51:03 -0700510 }
Felipe Leme1d486fe2016-10-14 18:06:47 -0700511 if (!ds.AddZipEntry("systrace.txt", systrace_path)) {
Felipe Leme14e034a2016-03-30 18:51:03 -0700512 MYLOGE("Unable to add systrace file %s to zip file\n", systrace_path.c_str());
Felipe Leme71a74ac2016-03-17 15:43:25 -0700513 } else {
Felipe Leme14e034a2016-03-30 18:51:03 -0700514 if (remove(systrace_path.c_str())) {
515 MYLOGE("Error removing systrace file %s: %s", systrace_path.c_str(), strerror(errno));
516 }
Felipe Leme71a74ac2016-03-17 15:43:25 -0700517 }
518}
519
Mark Salyzyn326842f2015-04-30 09:49:41 -0700520static bool skip_not_stat(const char *path) {
521 static const char stat[] = "/stat";
522 size_t len = strlen(path);
523 if (path[len - 1] == '/') { /* Directory? */
524 return false;
525 }
526 return strcmp(path + len - sizeof(stat) + 1, stat); /* .../stat? */
527}
528
Felipe Leme4c2d6632016-09-28 14:32:00 -0700529static bool skip_none(const char* path __attribute__((unused))) {
Felipe Lemee82a27d2016-01-05 13:35:44 -0800530 return false;
531}
532
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700533unsigned long worst_write_perf = 20000; /* in KB/s */
Mark Salyzyn326842f2015-04-30 09:49:41 -0700534
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800535//
536// stat offsets
537// Name units description
538// ---- ----- -----------
539// read I/Os requests number of read I/Os processed
540#define __STAT_READ_IOS 0
541// read merges requests number of read I/Os merged with in-queue I/O
542#define __STAT_READ_MERGES 1
543// read sectors sectors number of sectors read
544#define __STAT_READ_SECTORS 2
545// read ticks milliseconds total wait time for read requests
546#define __STAT_READ_TICKS 3
547// write I/Os requests number of write I/Os processed
548#define __STAT_WRITE_IOS 4
549// write merges requests number of write I/Os merged with in-queue I/O
550#define __STAT_WRITE_MERGES 5
551// write sectors sectors number of sectors written
552#define __STAT_WRITE_SECTORS 6
553// write ticks milliseconds total wait time for write requests
554#define __STAT_WRITE_TICKS 7
555// in_flight requests number of I/Os currently in flight
556#define __STAT_IN_FLIGHT 8
557// io_ticks milliseconds total time this block device has been active
558#define __STAT_IO_TICKS 9
559// time_in_queue milliseconds total wait time for all requests
560#define __STAT_IN_QUEUE 10
561#define __STAT_NUMBER_FIELD 11
562//
563// read I/Os, write I/Os
564// =====================
565//
566// These values increment when an I/O request completes.
567//
568// read merges, write merges
569// =========================
570//
571// These values increment when an I/O request is merged with an
572// already-queued I/O request.
573//
574// read sectors, write sectors
575// ===========================
576//
577// These values count the number of sectors read from or written to this
578// block device. The "sectors" in question are the standard UNIX 512-byte
579// sectors, not any device- or filesystem-specific block size. The
580// counters are incremented when the I/O completes.
581#define SECTOR_SIZE 512
582//
583// read ticks, write ticks
584// =======================
585//
586// These values count the number of milliseconds that I/O requests have
587// waited on this block device. If there are multiple I/O requests waiting,
588// these values will increase at a rate greater than 1000/second; for
589// example, if 60 read requests wait for an average of 30 ms, the read_ticks
590// field will increase by 60*30 = 1800.
591//
592// in_flight
593// =========
594//
595// This value counts the number of I/O requests that have been issued to
596// the device driver but have not yet completed. It does not include I/O
597// requests that are in the queue but not yet issued to the device driver.
598//
599// io_ticks
600// ========
601//
602// This value counts the number of milliseconds during which the device has
603// had I/O requests queued.
604//
605// time_in_queue
606// =============
607//
608// This value counts the number of milliseconds that I/O requests have waited
609// on this block device. If there are multiple I/O requests waiting, this
610// value will increase as the product of the number of milliseconds times the
611// number of requests waiting (see "read ticks" above for an example).
612#define S_TO_MS 1000
613//
614
Mark Salyzyn326842f2015-04-30 09:49:41 -0700615static int dump_stat_from_fd(const char *title __unused, const char *path, int fd) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800616 unsigned long long fields[__STAT_NUMBER_FIELD];
Mark Salyzyn326842f2015-04-30 09:49:41 -0700617 bool z;
Yi Kong19d5c002018-07-20 13:39:55 -0700618 char *cp, *buffer = nullptr;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700619 size_t i = 0;
Josh Gao7c4258c2018-06-25 13:40:08 -0700620 FILE *fp = fdopen(dup(fd), "rb");
Mark Salyzyn326842f2015-04-30 09:49:41 -0700621 getline(&buffer, &i, fp);
622 fclose(fp);
623 if (!buffer) {
624 return -errno;
625 }
626 i = strlen(buffer);
627 while ((i > 0) && (buffer[i - 1] == '\n')) {
628 buffer[--i] = '\0';
629 }
630 if (!*buffer) {
631 free(buffer);
632 return 0;
633 }
634 z = true;
635 for (cp = buffer, i = 0; i < (sizeof(fields) / sizeof(fields[0])); ++i) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800636 fields[i] = strtoull(cp, &cp, 10);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700637 if (fields[i] != 0) {
638 z = false;
639 }
640 }
641 if (z) { /* never accessed */
642 free(buffer);
643 return 0;
644 }
645
Wei Wang509bb5d2017-06-09 14:42:12 -0700646 if (!strncmp(path, BLK_DEV_SYS_DIR, sizeof(BLK_DEV_SYS_DIR) - 1)) {
647 path += sizeof(BLK_DEV_SYS_DIR) - 1;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700648 }
Wei Wang1dc1ef52017-06-12 11:28:37 -0700649
650 printf("%-30s:%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s\n%-30s:\t%s\n", "Block-Dev",
651 "R-IOs", "R-merg", "R-sect", "R-wait", "W-IOs", "W-merg", "W-sect",
652 "W-wait", "in-fli", "activ", "T-wait", path, buffer);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700653 free(buffer);
654
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800655 if (fields[__STAT_IO_TICKS]) {
656 unsigned long read_perf = 0;
657 unsigned long read_ios = 0;
658 if (fields[__STAT_READ_TICKS]) {
659 unsigned long long divisor = fields[__STAT_READ_TICKS]
660 * fields[__STAT_IO_TICKS];
661 read_perf = ((unsigned long long)SECTOR_SIZE
662 * fields[__STAT_READ_SECTORS]
663 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
664 / divisor;
665 read_ios = ((unsigned long long)S_TO_MS * fields[__STAT_READ_IOS]
666 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
667 / divisor;
668 }
669
670 unsigned long write_perf = 0;
671 unsigned long write_ios = 0;
672 if (fields[__STAT_WRITE_TICKS]) {
673 unsigned long long divisor = fields[__STAT_WRITE_TICKS]
674 * fields[__STAT_IO_TICKS];
675 write_perf = ((unsigned long long)SECTOR_SIZE
676 * fields[__STAT_WRITE_SECTORS]
677 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
678 / divisor;
679 write_ios = ((unsigned long long)S_TO_MS * fields[__STAT_WRITE_IOS]
680 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
681 / divisor;
682 }
683
684 unsigned queue = (fields[__STAT_IN_QUEUE]
685 + (fields[__STAT_IO_TICKS] >> 1))
686 / fields[__STAT_IO_TICKS];
687
688 if (!write_perf && !write_ios) {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700689 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 -0800690 } else {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700691 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 -0800692 read_ios, write_perf, write_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800693 }
694
695 /* bugreport timeout factor adjustment */
696 if ((write_perf > 1) && (write_perf < worst_write_perf)) {
697 worst_write_perf = write_perf;
698 }
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700699 }
Mark Salyzyn326842f2015-04-30 09:49:41 -0700700 return 0;
701}
702
Yao Chenbe3bbc12018-01-17 16:31:10 -0800703static const long MINIMUM_LOGCAT_TIMEOUT_MS = 50000;
704
705/* timeout in ms to read a list of buffers */
706static unsigned long logcat_timeout(const std::vector<std::string>& buffers) {
707 unsigned long timeout_ms = 0;
708 for (const auto& buffer : buffers) {
709 log_id_t id = android_name_to_log_id(buffer.c_str());
710 unsigned long property_size = __android_logger_get_buffer_size(id);
711 /* Engineering margin is ten-fold our guess */
712 timeout_ms += 10 * (property_size + worst_write_perf) / worst_write_perf;
713 }
714 return timeout_ms > MINIMUM_LOGCAT_TIMEOUT_MS ? timeout_ms : MINIMUM_LOGCAT_TIMEOUT_MS;
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700715}
716
Felipe Leme2b9b06c2016-10-14 09:13:06 -0700717void Dumpstate::PrintHeader() const {
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700718 std::string build, fingerprint, radio, bootloader, network;
719 char date[80];
Colin Crossf45fa6b2012-03-26 12:38:26 -0700720
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700721 build = android::base::GetProperty("ro.build.display.id", "(unknown)");
722 fingerprint = android::base::GetProperty("ro.build.fingerprint", "(unknown)");
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700723 radio = android::base::GetProperty("gsm.version.baseband", "(unknown)");
724 bootloader = android::base::GetProperty("ro.bootloader", "(unknown)");
725 network = android::base::GetProperty("gsm.operator.alpha", "(unknown)");
Felipe Lemebbaf3c12016-10-11 14:32:25 -0700726 strftime(date, sizeof(date), "%Y-%m-%d %H:%M:%S", localtime(&now_));
Colin Crossf45fa6b2012-03-26 12:38:26 -0700727
Felipe Lemed8b94e52016-12-08 10:21:44 -0800728 printf("========================================================\n");
729 printf("== dumpstate: %s\n", date);
730 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -0700731
Felipe Lemed8b94e52016-12-08 10:21:44 -0800732 printf("\n");
733 printf("Build: %s\n", build.c_str());
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700734 // NOTE: fingerprint entry format is important for other tools.
Felipe Lemed8b94e52016-12-08 10:21:44 -0800735 printf("Build fingerprint: '%s'\n", fingerprint.c_str());
736 printf("Bootloader: %s\n", bootloader.c_str());
737 printf("Radio: %s\n", radio.c_str());
738 printf("Network: %s\n", network.c_str());
Colin Crossf45fa6b2012-03-26 12:38:26 -0700739
Felipe Lemed8b94e52016-12-08 10:21:44 -0800740 printf("Kernel: ");
Felipe Lemef0292972016-11-22 13:57:05 -0800741 DumpFileToFd(STDOUT_FILENO, "", "/proc/version");
Felipe Lemed8b94e52016-12-08 10:21:44 -0800742 printf("Command line: %s\n", strtok(cmdline_buf, "\n"));
Felipe Leme7709f8a2017-12-05 09:30:09 -0800743 printf("Uptime: ");
744 RunCommandToFd(STDOUT_FILENO, "", {"uptime", "-p"},
745 CommandOptions::WithTimeout(1).Always().Build());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800746 printf("Bugreport format version: %s\n", version_.c_str());
747 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 +0100748 PropertiesHelper::IsDryRun(), options_->args.c_str(), options_->extra_options.c_str());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800749 printf("\n");
Felipe Leme78f2c862015-12-21 09:55:22 -0800750}
751
Felipe Leme24b66ee2016-06-16 10:55:26 -0700752// List of file extensions that can cause a zip file attachment to be rejected by some email
753// service providers.
754static const std::set<std::string> PROBLEMATIC_FILE_EXTENSIONS = {
755 ".ade", ".adp", ".bat", ".chm", ".cmd", ".com", ".cpl", ".exe", ".hta", ".ins", ".isp",
756 ".jar", ".jse", ".lib", ".lnk", ".mde", ".msc", ".msp", ".mst", ".pif", ".scr", ".sct",
757 ".shb", ".sys", ".vb", ".vbe", ".vbs", ".vxd", ".wsc", ".wsf", ".wsh"
758};
759
Vishnu Naire97d6122018-01-18 13:58:56 -0800760status_t Dumpstate::AddZipEntryFromFd(const std::string& entry_name, int fd,
761 std::chrono::milliseconds timeout = 0ms) {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700762 if (!IsZipping()) {
763 MYLOGD("Not adding zip entry %s from fd because it's not a zipped bugreport\n",
764 entry_name.c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -0800765 return INVALID_OPERATION;
Felipe Leme111b9d02016-02-03 09:28:24 -0800766 }
Felipe Leme24b66ee2016-06-16 10:55:26 -0700767 std::string valid_name = entry_name;
768
769 // Rename extension if necessary.
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -0700770 size_t idx = entry_name.rfind('.');
Felipe Leme24b66ee2016-06-16 10:55:26 -0700771 if (idx != std::string::npos) {
772 std::string extension = entry_name.substr(idx);
773 std::transform(extension.begin(), extension.end(), extension.begin(), ::tolower);
774 if (PROBLEMATIC_FILE_EXTENSIONS.count(extension) != 0) {
775 valid_name = entry_name + ".renamed";
776 MYLOGI("Renaming entry %s to %s\n", entry_name.c_str(), valid_name.c_str());
777 }
778 }
779
Felipe Leme6fe9db62016-02-12 09:04:16 -0800780 // Logging statement below is useful to time how long each entry takes, but it's too verbose.
781 // MYLOGD("Adding zip entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700782 int32_t err = zip_writer_->StartEntryWithTime(valid_name.c_str(), ZipWriter::kCompress,
783 get_mtime(fd, ds.now_));
Felipe Leme1d486fe2016-10-14 18:06:47 -0700784 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700785 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", valid_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700786 ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800787 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800788 }
Vishnu Naire97d6122018-01-18 13:58:56 -0800789 auto start = std::chrono::steady_clock::now();
790 auto end = start + timeout;
791 struct pollfd pfd = {fd, POLLIN};
Felipe Lemee82a27d2016-01-05 13:35:44 -0800792
Felipe Leme770410d2016-01-26 17:07:14 -0800793 std::vector<uint8_t> buffer(65536);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800794 while (1) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800795 if (timeout.count() > 0) {
796 // lambda to recalculate the timeout.
797 auto time_left_ms = [end]() {
798 auto now = std::chrono::steady_clock::now();
799 auto diff = std::chrono::duration_cast<std::chrono::milliseconds>(end - now);
800 return std::max(diff.count(), 0LL);
801 };
802
803 int rc = TEMP_FAILURE_RETRY(poll(&pfd, 1, time_left_ms()));
804 if (rc < 0) {
805 MYLOGE("Error in poll while adding from fd to zip entry %s:%s", entry_name.c_str(),
806 strerror(errno));
807 return -errno;
808 } else if (rc == 0) {
809 MYLOGE("Timed out adding from fd to zip entry %s:%s Timeout:%lldms",
810 entry_name.c_str(), strerror(errno), timeout.count());
811 return TIMED_OUT;
812 }
813 }
814
Zach Riggle22200402016-08-18 01:01:24 -0400815 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800816 if (bytes_read == 0) {
817 break;
818 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800819 MYLOGE("read(%s): %s\n", entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800820 return -errno;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800821 }
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700822 err = zip_writer_->WriteBytes(buffer.data(), bytes_read);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800823 if (err) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700824 MYLOGE("zip_writer_->WriteBytes(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800825 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800826 }
827 }
828
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700829 err = zip_writer_->FinishEntry();
Felipe Leme1d486fe2016-10-14 18:06:47 -0700830 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700831 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800832 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800833 }
834
Vishnu Naire97d6122018-01-18 13:58:56 -0800835 return OK;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800836}
837
Felipe Leme1d486fe2016-10-14 18:06:47 -0700838bool Dumpstate::AddZipEntry(const std::string& entry_name, const std::string& entry_path) {
839 android::base::unique_fd fd(
840 TEMP_FAILURE_RETRY(open(entry_path.c_str(), O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
Andreas Gampeaff68432016-07-18 18:01:27 -0700841 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800842 MYLOGE("open(%s): %s\n", entry_path.c_str(), strerror(errno));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800843 return false;
844 }
845
Vishnu Naire97d6122018-01-18 13:58:56 -0800846 return (AddZipEntryFromFd(entry_name, fd.get()) == OK);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800847}
848
849/* adds a file to the existing zipped bugreport */
Felipe Leme4c2d6632016-09-28 14:32:00 -0700850static int _add_file_from_fd(const char* title __attribute__((unused)), const char* path, int fd) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800851 return (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + path, fd) == OK) ? 0 : 1;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800852}
853
Felipe Leme1d486fe2016-10-14 18:06:47 -0700854void Dumpstate::AddDir(const std::string& dir, bool recursive) {
855 if (!IsZipping()) {
856 MYLOGD("Not adding dir %s because it's not a zipped bugreport\n", dir.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800857 return;
858 }
Felipe Leme678727a2016-09-21 17:22:11 -0700859 MYLOGD("Adding dir %s (recursive: %d)\n", dir.c_str(), recursive);
Felipe Leme46b85da2016-11-21 17:40:45 -0800860 DurationReporter duration_reporter(dir, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700861 dump_files("", dir.c_str(), recursive ? skip_none : is_dir, _add_file_from_fd);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800862}
863
Felipe Leme1d486fe2016-10-14 18:06:47 -0700864bool Dumpstate::AddTextZipEntry(const std::string& entry_name, const std::string& content) {
865 if (!IsZipping()) {
866 MYLOGD("Not adding text zip entry %s because it's not a zipped bugreport\n",
867 entry_name.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800868 return false;
869 }
Felipe Lemecbce55d2016-02-08 09:53:18 -0800870 MYLOGD("Adding zip text entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700871 int32_t err = zip_writer_->StartEntryWithTime(entry_name.c_str(), ZipWriter::kCompress, ds.now_);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700872 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700873 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700874 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800875 return false;
876 }
877
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700878 err = zip_writer_->WriteBytes(content.c_str(), content.length());
Felipe Leme1d486fe2016-10-14 18:06:47 -0700879 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700880 MYLOGE("zip_writer_->WriteBytes(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700881 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800882 return false;
883 }
884
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700885 err = zip_writer_->FinishEntry();
Felipe Leme1d486fe2016-10-14 18:06:47 -0700886 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700887 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800888 return false;
889 }
890
891 return true;
892}
893
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800894static void DoKmsg() {
895 struct stat st;
896 if (!stat(PSTORE_LAST_KMSG, &st)) {
897 /* Also TODO: Make console-ramoops CAP_SYSLOG protected. */
898 DumpFile("LAST KMSG", PSTORE_LAST_KMSG);
899 } else if (!stat(ALT_PSTORE_LAST_KMSG, &st)) {
900 DumpFile("LAST KMSG", ALT_PSTORE_LAST_KMSG);
901 } else {
902 /* TODO: Make last_kmsg CAP_SYSLOG protected. b/5555691 */
903 DumpFile("LAST KMSG", "/proc/last_kmsg");
904 }
905}
906
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800907static void DoKernelLogcat() {
Yao Chenbe3bbc12018-01-17 16:31:10 -0800908 unsigned long timeout_ms = logcat_timeout({"kernel"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800909 RunCommand(
910 "KERNEL LOG",
911 {"logcat", "-b", "kernel", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
912 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
913}
914
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800915static void DoLogcat() {
Vishnu Nair6921f802017-11-22 09:17:23 -0800916 unsigned long timeout_ms;
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800917 // DumpFile("EVENT LOG TAGS", "/etc/event-log-tags");
918 // calculate timeout
Yao Chenbe3bbc12018-01-17 16:31:10 -0800919 timeout_ms = logcat_timeout({"main", "system", "crash"});
Tony Makae737652017-03-30 17:47:09 +0100920 RunCommand("SYSTEM LOG",
Vishnu Nair6921f802017-11-22 09:17:23 -0800921 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
922 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -0800923 timeout_ms = logcat_timeout({"events"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800924 RunCommand(
925 "EVENT LOG",
926 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
927 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -0800928 timeout_ms = logcat_timeout({"stats"});
929 RunCommand(
930 "STATS LOG",
931 {"logcat", "-b", "stats", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
932 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
933 timeout_ms = logcat_timeout({"radio"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800934 RunCommand(
935 "RADIO LOG",
936 {"logcat", "-b", "radio", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
937 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800938
939 RunCommand("LOG STATISTICS", {"logcat", "-b", "all", "-S"});
940
941 /* kernels must set CONFIG_PSTORE_PMSG, slice up pstore with device tree */
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800942 RunCommand("LAST LOGCAT", {"logcat", "-L", "-b", "all", "-v", "threadtime", "-v", "printable",
943 "-v", "uid", "-d", "*:v"});
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800944}
945
Jayachandran Ca94c7172017-06-10 15:08:12 -0700946static void DumpIpTablesAsRoot() {
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700947 RunCommand("IPTABLES", {"iptables", "-L", "-nvx"});
948 RunCommand("IP6TABLES", {"ip6tables", "-L", "-nvx"});
Erik Kline32af8c22016-09-28 17:26:26 +0900949 RunCommand("IPTABLES NAT", {"iptables", "-t", "nat", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -0700950 /* no ip6 nat */
Erik Kline32af8c22016-09-28 17:26:26 +0900951 RunCommand("IPTABLES MANGLE", {"iptables", "-t", "mangle", "-L", "-nvx"});
952 RunCommand("IP6TABLES MANGLE", {"ip6tables", "-t", "mangle", "-L", "-nvx"});
953 RunCommand("IPTABLES RAW", {"iptables", "-t", "raw", "-L", "-nvx"});
954 RunCommand("IP6TABLES RAW", {"ip6tables", "-t", "raw", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -0700955}
956
Narayan Kamath8f788292017-05-25 13:20:39 +0100957static void AddAnrTraceDir(const bool add_to_zip, const std::string& anr_traces_dir) {
958 MYLOGD("AddAnrTraceDir(): dump_traces_file=%s, anr_traces_dir=%s\n", dump_traces_path,
959 anr_traces_dir.c_str());
960
961 // If we're here, dump_traces_path will always be a temporary file
962 // (created with mkostemp or similar) that contains dumps taken earlier
963 // on in the process.
964 if (dump_traces_path != nullptr) {
965 if (add_to_zip) {
966 ds.AddZipEntry(ZIP_ROOT_DIR + anr_traces_dir + "/traces-just-now.txt", dump_traces_path);
967 } else {
968 MYLOGD("Dumping current ANR traces (%s) to the main bugreport entry\n",
969 dump_traces_path);
970 ds.DumpFile("VM TRACES JUST NOW", dump_traces_path);
971 }
972
973 const int ret = unlink(dump_traces_path);
974 if (ret == -1) {
975 MYLOGW("Error unlinking temporary trace path %s: %s\n", dump_traces_path,
976 strerror(errno));
Felipe Lemee184f662016-10-27 10:04:47 -0700977 }
978 }
979
Narayan Kamathbd863722017-06-01 18:50:12 +0100980 // Add a specific message for the first ANR Dump.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700981 if (ds.anr_data_.size() > 0) {
982 AddDumps(ds.anr_data_.begin(), ds.anr_data_.begin() + 1,
Narayan Kamathbd863722017-06-01 18:50:12 +0100983 "VM TRACES AT LAST ANR", add_to_zip);
984
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100985 // The "last" ANR will always be included as separate entry in the zip file. In addition,
986 // it will be present in the body of the main entry if |add_to_zip| == false.
987 //
988 // Historical ANRs are always included as separate entries in the bugreport zip file.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700989 AddDumps(ds.anr_data_.begin() + ((add_to_zip) ? 1 : 0), ds.anr_data_.end(),
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100990 "HISTORICAL ANR", true /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +0100991 } else {
Narayan Kamath8f788292017-05-25 13:20:39 +0100992 printf("*** NO ANRs to dump in %s\n\n", ANR_DIR.c_str());
993 }
994}
995
996static void AddAnrTraceFiles() {
997 const bool add_to_zip = ds.IsZipping() && ds.version_ == VERSION_SPLIT_ANR;
998
Elliott Hughes69fe5ec2018-03-23 11:04:25 -0700999 std::string anr_traces_dir = "/data/anr";
Narayan Kamath8f788292017-05-25 13:20:39 +01001000
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001001 AddAnrTraceDir(add_to_zip, anr_traces_dir);
Narayan Kamath8f788292017-05-25 13:20:39 +01001002
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001003 // Slow traces for slow operations.
Felipe Lemee184f662016-10-27 10:04:47 -07001004 struct stat st;
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001005 int i = 0;
1006 while (true) {
1007 const std::string slow_trace_path =
1008 anr_traces_dir + android::base::StringPrintf("slow%02d.txt", i);
1009 if (stat(slow_trace_path.c_str(), &st)) {
1010 // No traces file at this index, done with the files.
1011 break;
Felipe Lemee184f662016-10-27 10:04:47 -07001012 }
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001013 ds.DumpFile("VM TRACES WHEN SLOW", slow_trace_path.c_str());
1014 i++;
Felipe Lemee184f662016-10-27 10:04:47 -07001015 }
1016}
1017
Wei Wang509bb5d2017-06-09 14:42:12 -07001018static void DumpBlockStatFiles() {
1019 DurationReporter duration_reporter("DUMP BLOCK STAT");
Wei Wang509bb5d2017-06-09 14:42:12 -07001020
Wei Wang1dc1ef52017-06-12 11:28:37 -07001021 std::unique_ptr<DIR, std::function<int(DIR*)>> dirptr(opendir(BLK_DEV_SYS_DIR), closedir);
1022
1023 if (dirptr == nullptr) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001024 MYLOGE("Failed to open %s: %s\n", BLK_DEV_SYS_DIR, strerror(errno));
1025 return;
1026 }
1027
1028 printf("------ DUMP BLOCK STAT ------\n\n");
Wei Wang1dc1ef52017-06-12 11:28:37 -07001029 while (struct dirent *d = readdir(dirptr.get())) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001030 if ((d->d_name[0] == '.')
1031 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
1032 || (d->d_name[1] == '\0'))) {
1033 continue;
1034 }
1035 const std::string new_path =
1036 android::base::StringPrintf("%s/%s", BLK_DEV_SYS_DIR, d->d_name);
1037 printf("------ BLOCK STAT (%s) ------\n", new_path.c_str());
1038 dump_files("", new_path.c_str(), skip_not_stat, dump_stat_from_fd);
1039 printf("\n");
1040 }
Wei Wang1dc1ef52017-06-12 11:28:37 -07001041 return;
Wei Wang509bb5d2017-06-09 14:42:12 -07001042}
Jayachandran Ca94c7172017-06-10 15:08:12 -07001043
1044static void DumpPacketStats() {
1045 DumpFile("NETWORK DEV INFO", "/proc/net/dev");
1046 DumpFile("QTAGUID NETWORK INTERFACES INFO", "/proc/net/xt_qtaguid/iface_stat_all");
1047 DumpFile("QTAGUID NETWORK INTERFACES INFO (xt)", "/proc/net/xt_qtaguid/iface_stat_fmt");
1048 DumpFile("QTAGUID CTRL INFO", "/proc/net/xt_qtaguid/ctrl");
1049 DumpFile("QTAGUID STATS INFO", "/proc/net/xt_qtaguid/stats");
1050}
1051
1052static void DumpIpAddrAndRules() {
1053 /* The following have a tendency to get wedged when wifi drivers/fw goes belly-up. */
1054 RunCommand("NETWORK INTERFACES", {"ip", "link"});
1055 RunCommand("IPv4 ADDRESSES", {"ip", "-4", "addr", "show"});
1056 RunCommand("IPv6 ADDRESSES", {"ip", "-6", "addr", "show"});
1057 RunCommand("IP RULES", {"ip", "rule", "show"});
1058 RunCommand("IP RULES v6", {"ip", "-6", "rule", "show"});
1059}
1060
Vishnu Nair64afc022018-02-01 15:29:34 -08001061static void RunDumpsysTextByPriority(const std::string& title, int priority,
1062 std::chrono::milliseconds timeout,
1063 std::chrono::milliseconds service_timeout) {
1064 auto start = std::chrono::steady_clock::now();
Vishnu Naire97d6122018-01-18 13:58:56 -08001065 sp<android::IServiceManager> sm = defaultServiceManager();
1066 Dumpsys dumpsys(sm.get());
Vishnu Naire97d6122018-01-18 13:58:56 -08001067 Vector<String16> args;
1068 Dumpsys::setServiceArgs(args, /* asProto = */ false, priority);
Vishnu Naire97d6122018-01-18 13:58:56 -08001069 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ false);
1070 for (const String16& service : services) {
1071 std::string path(title);
1072 path.append(" - ").append(String8(service).c_str());
1073 DumpstateSectionReporter section_reporter(path, ds.listener_, ds.report_section_);
1074 size_t bytes_written = 0;
1075 status_t status = dumpsys.startDumpThread(service, args);
1076 if (status == OK) {
1077 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1078 std::chrono::duration<double> elapsed_seconds;
1079 status = dumpsys.writeDump(STDOUT_FILENO, service, service_timeout,
1080 /* as_proto = */ false, elapsed_seconds, bytes_written);
1081 section_reporter.setSize(bytes_written);
1082 dumpsys.writeDumpFooter(STDOUT_FILENO, service, elapsed_seconds);
1083 bool dump_complete = (status == OK);
1084 dumpsys.stopDumpThread(dump_complete);
1085 }
1086 section_reporter.setStatus(status);
1087
1088 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1089 std::chrono::steady_clock::now() - start);
1090 if (elapsed_duration > timeout) {
1091 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1092 elapsed_duration.count());
1093 break;
1094 }
1095 }
1096}
1097
Vishnu Nair64afc022018-02-01 15:29:34 -08001098static void RunDumpsysText(const std::string& title, int priority,
1099 std::chrono::milliseconds timeout,
1100 std::chrono::milliseconds service_timeout) {
1101 DurationReporter duration_reporter(title);
1102 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1103 fsync(STDOUT_FILENO);
1104 RunDumpsysTextByPriority(title, priority, timeout, service_timeout);
1105}
1106
1107/* Dump all services registered with Normal or Default priority. */
1108static void RunDumpsysTextNormalPriority(const std::string& title,
1109 std::chrono::milliseconds timeout,
1110 std::chrono::milliseconds service_timeout) {
1111 DurationReporter duration_reporter(title);
1112 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1113 fsync(STDOUT_FILENO);
1114 RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_NORMAL, timeout,
1115 service_timeout);
1116 RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_DEFAULT, timeout,
1117 service_timeout);
1118}
1119
1120static void RunDumpsysProto(const std::string& title, int priority,
1121 std::chrono::milliseconds timeout,
1122 std::chrono::milliseconds service_timeout) {
Luis Hector Chavez1e27b082018-03-22 15:36:42 -07001123 if (!ds.IsZipping()) {
1124 MYLOGD("Not dumping %s because it's not a zipped bugreport\n", title.c_str());
1125 return;
1126 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001127 sp<android::IServiceManager> sm = defaultServiceManager();
1128 Dumpsys dumpsys(sm.get());
1129 Vector<String16> args;
1130 Dumpsys::setServiceArgs(args, /* asProto = */ true, priority);
1131 DurationReporter duration_reporter(title);
1132
1133 auto start = std::chrono::steady_clock::now();
1134 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ true);
1135 for (const String16& service : services) {
1136 std::string path(kProtoPath);
1137 path.append(String8(service).c_str());
1138 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL) {
1139 path.append("_CRITICAL");
1140 } else if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH) {
1141 path.append("_HIGH");
1142 }
1143 path.append(kProtoExt);
1144 DumpstateSectionReporter section_reporter(path, ds.listener_, ds.report_section_);
1145 status_t status = dumpsys.startDumpThread(service, args);
1146 if (status == OK) {
1147 status = ds.AddZipEntryFromFd(path, dumpsys.getDumpFd(), service_timeout);
1148 bool dumpTerminated = (status == OK);
1149 dumpsys.stopDumpThread(dumpTerminated);
1150 }
1151 ZipWriter::FileEntry file_entry;
1152 ds.zip_writer_->GetLastEntry(&file_entry);
1153 section_reporter.setSize(file_entry.compressed_size);
1154 section_reporter.setStatus(status);
1155
1156 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1157 std::chrono::steady_clock::now() - start);
1158 if (elapsed_duration > timeout) {
1159 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1160 elapsed_duration.count());
1161 break;
1162 }
1163 }
1164}
1165
Nandana Dutta7db6342018-11-21 14:53:34 +00001166// Runs dumpsys on services that must dump first and will take less than 100ms to dump.
Vishnu Nair780b1282017-10-10 13:57:24 -07001167static void RunDumpsysCritical() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001168 RunDumpsysText("DUMPSYS CRITICAL", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1169 /* timeout= */ 5s, /* service_timeout= */ 500ms);
1170 RunDumpsysProto("DUMPSYS CRITICAL PROTO", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1171 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Vishnu Nair780b1282017-10-10 13:57:24 -07001172}
1173
1174// Runs dumpsys on services that must dump first but can take up to 250ms to dump.
1175static void RunDumpsysHigh() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001176 // TODO meminfo takes ~10s, connectivity takes ~5sec to dump. They are both
1177 // high priority. Reduce timeout once they are able to dump in a shorter time or
1178 // moved to a parallel task.
1179 RunDumpsysText("DUMPSYS HIGH", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1180 /* timeout= */ 90s, /* service_timeout= */ 30s);
1181 RunDumpsysProto("DUMPSYS HIGH PROTO", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1182 /* timeout= */ 5s, /* service_timeout= */ 1s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001183}
1184
1185// Runs dumpsys on services that must dump but can take up to 10s to dump.
1186static void RunDumpsysNormal() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001187 RunDumpsysTextNormalPriority("DUMPSYS", /* timeout= */ 90s, /* service_timeout= */ 10s);
1188 RunDumpsysProto("DUMPSYS PROTO", IServiceManager::DUMP_FLAG_PRIORITY_NORMAL,
1189 /* timeout= */ 90s, /* service_timeout= */ 10s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001190}
1191
Steven Moreland44cd9482018-01-04 16:24:13 -08001192static void DumpHals() {
Steven Moreland44cd9482018-01-04 16:24:13 -08001193 using android::hidl::manager::V1_0::IServiceManager;
1194 using android::hardware::defaultServiceManager;
1195
1196 sp<IServiceManager> sm = defaultServiceManager();
1197 if (sm == nullptr) {
1198 MYLOGE("Could not retrieve hwservicemanager to dump hals.\n");
1199 return;
1200 }
1201
1202 auto ret = sm->list([&](const auto& interfaces) {
1203 for (const std::string& interface : interfaces) {
1204 std::string cleanName = interface;
1205 std::replace_if(cleanName.begin(),
1206 cleanName.end(),
1207 [](char c) {
1208 return !isalnum(c) &&
1209 std::string("@-_:.").find(c) == std::string::npos;
1210 }, '_');
Nandana Dutt979388e2018-11-30 16:48:55 +00001211 const std::string path = ds.bugreport_internal_dir_ + "/lshal_debug_" + cleanName;
Steven Moreland44cd9482018-01-04 16:24:13 -08001212
1213 {
1214 auto fd = android::base::unique_fd(
1215 TEMP_FAILURE_RETRY(open(path.c_str(),
1216 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1217 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1218 if (fd < 0) {
1219 MYLOGE("Could not open %s to dump additional hal information.\n", path.c_str());
1220 continue;
1221 }
1222 RunCommandToFd(fd,
1223 "",
Steven Morelandc81cd3c2018-01-18 14:36:26 -08001224 {"lshal", "debug", "-E", interface},
Steven Moreland44cd9482018-01-04 16:24:13 -08001225 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
1226
1227 bool empty = 0 == lseek(fd, 0, SEEK_END);
1228 if (!empty) {
1229 ds.AddZipEntry("lshal-debug/" + cleanName + ".txt", path);
1230 }
1231 }
1232
1233 unlink(path.c_str());
1234 }
1235 });
1236
1237 if (!ret.isOk()) {
1238 MYLOGE("Could not list hals from hwservicemanager.\n");
1239 }
1240}
1241
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001242static void dumpstate() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001243 DurationReporter duration_reporter("DUMPSTATE");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001244
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -07001245 dump_dev_files("TRUSTY VERSION", "/sys/bus/platform/drivers/trusty", "trusty_version");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001246 RunCommand("UPTIME", {"uptime"});
Wei Wang509bb5d2017-06-09 14:42:12 -07001247 DumpBlockStatFiles();
Mark Salyzyn8c8130e2015-12-09 11:21:28 -08001248 dump_emmc_ecsd("/d/mmc0/mmc0:0001/ext_csd");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001249 DumpFile("MEMORY INFO", "/proc/meminfo");
1250 RunCommand("CPU INFO", {"top", "-b", "-n", "1", "-H", "-s", "6", "-o",
Felipe Leme30dbfa12016-09-02 12:43:26 -07001251 "pid,tid,user,pr,ni,%cpu,s,virt,res,pcy,cmd,name"});
Felipe Lemef0292972016-11-22 13:57:05 -08001252 RunCommand("PROCRANK", {"procrank"}, AS_ROOT_20);
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001253 DumpFile("VIRTUAL MEMORY STATS", "/proc/vmstat");
1254 DumpFile("VMALLOC INFO", "/proc/vmallocinfo");
1255 DumpFile("SLAB INFO", "/proc/slabinfo");
1256 DumpFile("ZONEINFO", "/proc/zoneinfo");
1257 DumpFile("PAGETYPEINFO", "/proc/pagetypeinfo");
1258 DumpFile("BUDDYINFO", "/proc/buddyinfo");
1259 DumpFile("FRAGMENTATION INFO", "/d/extfrag/unusable_index");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001260
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001261 DumpFile("KERNEL WAKE SOURCES", "/d/wakeup_sources");
1262 DumpFile("KERNEL CPUFREQ", "/sys/devices/system/cpu/cpu0/cpufreq/stats/time_in_state");
1263 DumpFile("KERNEL SYNC", "/d/sync");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001264
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001265 RunCommand("PROCESSES AND THREADS",
Yohei Yukawa591a72d2017-10-05 21:36:35 -07001266 {"ps", "-A", "-T", "-Z", "-O", "pri,nice,rtprio,sched,pcy,time"});
Felipe Lemef0292972016-11-22 13:57:05 -08001267 RunCommand("LIBRANK", {"librank"}, CommandOptions::AS_ROOT);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001268
Andreas Huber69ec3ac2017-03-23 09:47:51 -07001269 if (ds.IsZipping()) {
Yifan Hong90e8d8d2018-06-28 13:14:39 -07001270 RunCommand("HARDWARE HALS", {"lshal", "-lVSietrpc", "--types=b,c,l,z"},
1271 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
Steven Moreland44cd9482018-01-04 16:24:13 -08001272 DumpHals();
Andreas Huber69ec3ac2017-03-23 09:47:51 -07001273 } else {
Yifan Hong90e8d8d2018-06-28 13:14:39 -07001274 RunCommand("HARDWARE HALS", {"lshal", "-lVSietrpc", "--types=b,c,l,z", "--debug"},
1275 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build());
Andreas Huber69ec3ac2017-03-23 09:47:51 -07001276 }
Steven Moreland81b429e2017-01-31 19:50:46 -08001277
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001278 RunCommand("PRINTENV", {"printenv"});
Elliott Hughes21b7c8d2016-10-28 08:53:02 -07001279 RunCommand("NETSTAT", {"netstat", "-nW"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001280 struct stat s;
1281 if (stat("/proc/modules", &s) != 0) {
1282 MYLOGD("Skipping 'lsmod' because /proc/modules does not exist\n");
1283 } else {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001284 RunCommand("LSMOD", {"lsmod"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001285 }
Michal Karpinski4db754f2015-12-11 18:04:32 +00001286
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001287 if (__android_logger_property_get_bool(
1288 "ro.logd.kernel", BOOL_DEFAULT_TRUE | BOOL_DEFAULT_FLAG_ENG | BOOL_DEFAULT_FLAG_SVELTE)) {
1289 DoKernelLogcat();
1290 } else {
1291 do_dmesg();
1292 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001293
Felipe Lemef0292972016-11-22 13:57:05 -08001294 RunCommand("LIST OF OPEN FILES", {"lsof"}, CommandOptions::AS_ROOT);
Jeff Brown1dc94e32014-09-11 14:15:27 -07001295 for_each_pid(do_showmap, "SMAPS OF ALL PROCESSES");
1296 for_each_tid(show_wchan, "BLOCKED PROCESS WAIT-CHANNELS");
Mark Salyzyna297c322016-02-05 15:33:17 -08001297 for_each_pid(show_showtime, "PROCESS TIMES (pid cmd user system iowait+percentage)");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001298
Ajay Panicker2ff8e872017-04-27 14:04:32 -07001299 /* Dump Bluetooth HCI logs */
1300 ds.AddDir("/data/misc/bluetooth/logs", true);
Ajay Panickerd886ec42016-09-14 12:26:46 -07001301
Felipe Leme9a523ae2016-10-20 15:10:33 -07001302 if (!ds.do_early_screenshot_) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001303 MYLOGI("taking late screenshot\n");
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001304 ds.TakeScreenshot();
Jeff Sharkey5a930032013-03-19 15:05:19 -07001305 }
1306
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001307 DoLogcat();
Mark Salyzynecc07632015-07-30 14:57:09 -07001308
Felipe Lemee184f662016-10-27 10:04:47 -07001309 AddAnrTraceFiles();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001310
Narayan Kamath8f788292017-05-25 13:20:39 +01001311 // NOTE: tombstones are always added as separate entries in the zip archive
1312 // and are not interspersed with the main report.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001313 const bool tombstones_dumped = AddDumps(ds.tombstone_data_.begin(), ds.tombstone_data_.end(),
Narayan Kamathbd863722017-06-01 18:50:12 +01001314 "TOMBSTONE", true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001315 if (!tombstones_dumped) {
1316 printf("*** NO TOMBSTONES to dump in %s\n\n", TOMBSTONE_DIR.c_str());
Christopher Ferris7dc7f322014-07-22 16:08:19 -07001317 }
1318
Jayachandran Ca94c7172017-06-10 15:08:12 -07001319 DumpPacketStats();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001320
Chenbo Feng276a3b62018-08-07 11:44:49 -07001321 RunDumpsys("EBPF MAP STATS", {"netd", "trafficcontroller"});
1322
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001323 DoKmsg();
Mark Salyzyn2262c162014-12-16 09:09:26 -08001324
Jayachandran Ca94c7172017-06-10 15:08:12 -07001325 DumpIpAddrAndRules();
Sreeram Ramachandran2b3bba32014-07-08 15:40:55 -07001326
1327 dump_route_tables();
1328
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001329 RunCommand("ARP CACHE", {"ip", "-4", "neigh", "show"});
1330 RunCommand("IPv6 ND CACHE", {"ip", "-6", "neigh", "show"});
1331 RunCommand("MULTICAST ADDRESSES", {"ip", "maddr"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001332
Vishnu Nair780b1282017-10-10 13:57:24 -07001333 RunDumpsysHigh();
Lorenzo Colitti6afc38c2015-09-09 22:59:25 +09001334
Elliott Hughes23ccc622017-02-28 10:14:22 -08001335 RunCommand("SYSTEM PROPERTIES", {"getprop"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001336
Jin Qianf334d662017-10-10 14:41:37 -07001337 RunCommand("STORAGED IO INFO", {"storaged", "-u", "-p"});
ynwangf649a6e2016-07-17 21:56:00 -07001338
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001339 RunCommand("FILESYSTEMS & FREE SPACE", {"df"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001340
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001341 RunCommand("LAST RADIO LOG", {"parse_radio_log", "/proc/last_radio_log"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001342
Colin Crossf45fa6b2012-03-26 12:38:26 -07001343 /* Binder state is expensive to look at as it uses a lot of memory. */
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001344 DumpFile("BINDER FAILED TRANSACTION LOG", "/sys/kernel/debug/binder/failed_transaction_log");
1345 DumpFile("BINDER TRANSACTION LOG", "/sys/kernel/debug/binder/transaction_log");
1346 DumpFile("BINDER TRANSACTIONS", "/sys/kernel/debug/binder/transactions");
1347 DumpFile("BINDER STATS", "/sys/kernel/debug/binder/stats");
1348 DumpFile("BINDER STATE", "/sys/kernel/debug/binder/state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001349
Vishnu Nair36b4cdb2017-11-17 10:27:05 -08001350 /* Add window and surface trace files. */
1351 if (!PropertiesHelper::IsUserBuild()) {
1352 ds.AddDir(WMTRACE_DATA_DIR, false);
1353 }
1354
Felipe Leme6f674ae2016-11-18 17:10:33 -08001355 ds.DumpstateBoard();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001356
Steven Moreland7440ddb2016-12-15 16:13:39 -08001357 /* Migrate the ril_dumpstate to a device specific dumpstate? */
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001358 int rilDumpstateTimeout = android::base::GetIntProperty("ril.dumpstate.timeout", 0);
1359 if (rilDumpstateTimeout > 0) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001360 // su does not exist on user builds, so try running without it.
1361 // This way any implementations of vril-dump that do not require
1362 // root can run on user builds.
1363 CommandOptions::CommandOptionsBuilder options =
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001364 CommandOptions::WithTimeout(rilDumpstateTimeout);
Felipe Lemef0292972016-11-22 13:57:05 -08001365 if (!PropertiesHelper::IsUserBuild()) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001366 options.AsRoot();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001367 }
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001368 RunCommand("DUMP VENDOR RIL LOGS", {"vril-dump"}, options.Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -07001369 }
1370
Felipe Lemed8b94e52016-12-08 10:21:44 -08001371 printf("========================================================\n");
1372 printf("== Android Framework Services\n");
1373 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001374
Vishnu Nair780b1282017-10-10 13:57:24 -07001375 RunDumpsysNormal();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001376
Felipe Lemed8b94e52016-12-08 10:21:44 -08001377 printf("========================================================\n");
1378 printf("== Checkins\n");
1379 printf("========================================================\n");
Dianne Hackborn02bea972013-06-26 18:59:09 -07001380
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001381 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
1382 RunDumpsys("CHECKIN MEMINFO", {"meminfo", "--checkin"});
1383 RunDumpsys("CHECKIN NETSTATS", {"netstats", "--checkin"});
1384 RunDumpsys("CHECKIN PROCSTATS", {"procstats", "-c"});
1385 RunDumpsys("CHECKIN USAGESTATS", {"usagestats", "-c"});
1386 RunDumpsys("CHECKIN PACKAGE", {"package", "--checkin"});
Dianne Hackborn02bea972013-06-26 18:59:09 -07001387
Felipe Lemed8b94e52016-12-08 10:21:44 -08001388 printf("========================================================\n");
1389 printf("== Running Application Activities\n");
1390 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001391
Makoto Onuki60780982018-04-16 15:34:00 -07001392 // The following dumpsys internally collects output from running apps, so it can take a long
1393 // time. So let's extend the timeout.
1394
1395 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
1396
1397 RunDumpsys("APP ACTIVITIES", {"activity", "-v", "all"}, DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001398
Felipe Lemed8b94e52016-12-08 10:21:44 -08001399 printf("========================================================\n");
Makoto Onuki60780982018-04-16 15:34:00 -07001400 printf("== Running Application Services (platform)\n");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001401 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001402
Vishnu Nairc6e6ea72018-07-02 14:20:06 -07001403 RunDumpsys("APP SERVICES PLATFORM", {"activity", "service", "all-platform-non-critical"},
Makoto Onuki60780982018-04-16 15:34:00 -07001404 DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001405
Felipe Lemed8b94e52016-12-08 10:21:44 -08001406 printf("========================================================\n");
Makoto Onuki60780982018-04-16 15:34:00 -07001407 printf("== Running Application Services (non-platform)\n");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001408 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001409
Makoto Onuki60780982018-04-16 15:34:00 -07001410 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1411 DUMPSYS_COMPONENTS_OPTIONS);
1412
1413 printf("========================================================\n");
1414 printf("== Running Application Providers (platform)\n");
1415 printf("========================================================\n");
1416
1417 RunDumpsys("APP PROVIDERS PLATFORM", {"activity", "provider", "all-platform"},
1418 DUMPSYS_COMPONENTS_OPTIONS);
1419
1420 printf("========================================================\n");
1421 printf("== Running Application Providers (non-platform)\n");
1422 printf("========================================================\n");
1423
1424 RunDumpsys("APP PROVIDERS NON-PLATFORM", {"activity", "provider", "all-non-platform"},
1425 DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001426
Adrian Roos8b397ab2017-04-04 16:35:44 -07001427 printf("========================================================\n");
1428 printf("== Dropbox crashes\n");
1429 printf("========================================================\n");
1430
1431 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1432 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1433
Felipe Lemed8b94e52016-12-08 10:21:44 -08001434 printf("========================================================\n");
1435 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1436 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1437 printf("========================================================\n");
1438 printf("== dumpstate: done (id %d)\n", ds.id_);
1439 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001440}
1441
Nandana Dutt4be45d12018-09-26 15:04:23 +01001442/* Dumps state for the default case. Returns true if everything went fine. */
1443static bool DumpstateDefault() {
1444 // Dumps systrace right away, otherwise it will be filled with unnecessary events.
1445 // First try to dump anrd trace if the daemon is running. Otherwise, dump
1446 // the raw trace.
1447 if (!dump_anrd_trace()) {
1448 dump_systrace();
1449 }
1450
1451 // Invoking the following dumpsys calls before dump_traces() to try and
1452 // keep the system stats as close to its initial state as possible.
1453 RunDumpsysCritical();
1454
1455 /* collect stack traces from Dalvik and native processes (needs root) */
1456 dump_traces_path = dump_traces();
1457
1458 /* Run some operations that require root. */
1459 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX, !ds.IsZipping());
1460 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX, !ds.IsZipping());
1461
1462 ds.AddDir(RECOVERY_DIR, true);
1463 ds.AddDir(RECOVERY_DATA_DIR, true);
1464 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
1465 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1466 if (!PropertiesHelper::IsUserBuild()) {
1467 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1468 ds.AddDir(PROFILE_DATA_DIR_REF, true);
1469 }
1470 add_mountinfo();
1471 DumpIpTablesAsRoot();
1472
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001473 // Capture any IPSec policies in play. No keys are exposed here.
Nandana Dutt4be45d12018-09-26 15:04:23 +01001474 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1475
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001476 // Dump IPsec stats. No keys are exposed here.
1477 DumpFile("XFRM STATS", XFRM_STAT_PROC_FILE);
1478
Nandana Dutt4be45d12018-09-26 15:04:23 +01001479 // Run ss as root so we can see socket marks.
1480 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
1481
1482 // Run iotop as root to show top 100 IO threads
1483 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
1484
1485 if (!DropRootUser()) {
1486 return false;
1487 }
1488
1489 dumpstate();
1490 return true;
1491}
1492
mukesh agrawal253dad42018-01-23 21:59:59 -08001493// This method collects common dumpsys for telephony and wifi
1494static void DumpstateRadioCommon() {
Jayachandran Ca94c7172017-06-10 15:08:12 -07001495 DumpIpTablesAsRoot();
1496
1497 if (!DropRootUser()) {
1498 return;
1499 }
1500
1501 do_dmesg();
1502 DoLogcat();
1503 DumpPacketStats();
1504 DoKmsg();
1505 DumpIpAddrAndRules();
1506 dump_route_tables();
1507
1508 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
1509 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08001510}
1511
1512// This method collects dumpsys for telephony debugging only
1513static void DumpstateTelephonyOnly() {
1514 DurationReporter duration_reporter("DUMPSTATE");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001515 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08001516
1517 DumpstateRadioCommon();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001518
1519 RunCommand("SYSTEM PROPERTIES", {"getprop"});
1520
1521 printf("========================================================\n");
1522 printf("== Android Framework Services\n");
1523 printf("========================================================\n");
1524
Vishnu Nair652cc802017-11-30 15:18:30 -08001525 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1526 SEC_TO_MSEC(10));
1527 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
1528 SEC_TO_MSEC(10));
Amruth Ramachandrand25a9142018-04-02 16:16:09 -07001529 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
1530 SEC_TO_MSEC(10));
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07001531 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
1532 SEC_TO_MSEC(10));
Jayachandran Ca94c7172017-06-10 15:08:12 -07001533
1534 printf("========================================================\n");
1535 printf("== Running Application Services\n");
1536 printf("========================================================\n");
1537
1538 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
1539
1540 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001541 printf("== Running Application Services (non-platform)\n");
1542 printf("========================================================\n");
1543
1544 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1545 DUMPSYS_COMPONENTS_OPTIONS);
1546
1547 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07001548 printf("== Checkins\n");
1549 printf("========================================================\n");
1550
1551 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
1552
1553 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07001554 printf("== dumpstate: done (id %d)\n", ds.id_);
1555 printf("========================================================\n");
1556}
1557
mukesh agrawal253dad42018-01-23 21:59:59 -08001558// This method collects dumpsys for wifi debugging only
1559static void DumpstateWifiOnly() {
1560 DurationReporter duration_reporter("DUMPSTATE");
1561
1562 DumpstateRadioCommon();
1563
1564 printf("========================================================\n");
1565 printf("== Android Framework Services\n");
1566 printf("========================================================\n");
1567
1568 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1569 SEC_TO_MSEC(10));
1570 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
1571 SEC_TO_MSEC(10));
1572
1573 printf("========================================================\n");
1574 printf("== dumpstate: done (id %d)\n", ds.id_);
1575 printf("========================================================\n");
1576}
1577
Felipe Leme6f674ae2016-11-18 17:10:33 -08001578void Dumpstate::DumpstateBoard() {
1579 DurationReporter duration_reporter("dumpstate_board()");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001580 printf("========================================================\n");
1581 printf("== Board\n");
1582 printf("========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001583
Felipe Leme6f674ae2016-11-18 17:10:33 -08001584 if (!IsZipping()) {
Steven Moreland7440ddb2016-12-15 16:13:39 -08001585 MYLOGD("Not dumping board info because it's not a zipped bugreport\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001586 return;
1587 }
1588
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001589 std::vector<std::string> paths;
1590 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07001591 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00001592 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
1593 kDumpstateBoardFiles[i].c_str()));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001594 remover.emplace_back(android::base::make_scope_guard(std::bind(
1595 [](std::string path) {
1596 if (remove(path.c_str()) != 0 && errno != ENOENT) {
1597 MYLOGE("Could not remove(%s): %s\n", path.c_str(), strerror(errno));
1598 }
1599 },
1600 paths[i])));
1601 }
Jie Song9fbfad02017-06-20 16:29:42 -07001602
Wei Wang587eac92018-04-05 12:17:20 -07001603 sp<IDumpstateDevice> dumpstate_device(IDumpstateDevice::getService());
1604 if (dumpstate_device == nullptr) {
1605 MYLOGE("No IDumpstateDevice implementation\n");
1606 return;
1607 }
1608
1609 using ScopedNativeHandle =
1610 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
1611 ScopedNativeHandle handle(native_handle_create(static_cast<int>(paths.size()), 0),
1612 [](native_handle_t* handle) {
1613 native_handle_close(handle);
1614 native_handle_delete(handle);
1615 });
1616 if (handle == nullptr) {
1617 MYLOGE("Could not create native_handle\n");
1618 return;
1619 }
1620
1621 for (size_t i = 0; i < paths.size(); i++) {
1622 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
1623
1624 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
1625 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1626 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1627 if (fd < 0) {
1628 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
1629 return;
1630 }
1631 handle.get()->data[i] = fd.release();
1632 }
1633
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001634 // Given that bugreport is required to diagnose failures, it's better to
Wei Wang587eac92018-04-05 12:17:20 -07001635 // set an arbitrary amount of timeout for IDumpstateDevice than to block the
1636 // rest of bugreport. In the timeout case, we will kill dumpstate board HAL
1637 // and grab whatever dumped
1638 std::packaged_task<bool()>
1639 dumpstate_task([paths, dumpstate_device, &handle]() -> bool {
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001640 android::hardware::Return<void> status = dumpstate_device->dumpstateBoard(handle.get());
1641 if (!status.isOk()) {
1642 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
Wei Wang587eac92018-04-05 12:17:20 -07001643 return false;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001644 }
Wei Wang587eac92018-04-05 12:17:20 -07001645 return true;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001646 });
Wei Wang587eac92018-04-05 12:17:20 -07001647
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001648 auto result = dumpstate_task.get_future();
1649 std::thread(std::move(dumpstate_task)).detach();
Wei Wang587eac92018-04-05 12:17:20 -07001650
1651 constexpr size_t timeout_sec = 30;
1652 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
1653 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate vendor HAL\n", timeout_sec);
1654 if (!android::base::SetProperty("ctl.interface_restart",
1655 android::base::StringPrintf("%s/default",
1656 IDumpstateDevice::descriptor))) {
1657 MYLOGE("Couldn't restart dumpstate HAL\n");
1658 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001659 }
Wei Wang587eac92018-04-05 12:17:20 -07001660 // Wait some time for init to kill dumpstate vendor HAL
1661 constexpr size_t killing_timeout_sec = 10;
1662 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
1663 MYLOGE("killing dumpstateBoard timed out after %zus, continue and "
1664 "there might be racing in content\n", killing_timeout_sec);
1665 }
1666
1667 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
1668 for (size_t i = 0; i < paths.size(); i++) {
1669 struct stat s;
1670 if (fstat(handle.get()->data[i], &s) == -1) {
1671 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(),
1672 strerror(errno));
1673 file_sizes[i] = -1;
1674 continue;
1675 }
1676 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001677 }
1678
1679 for (size_t i = 0; i < paths.size(); i++) {
1680 if (file_sizes[i] == -1) {
1681 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07001682 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001683 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07001684 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001685 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07001686 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001687 AddZipEntry(kDumpstateBoardFiles[i], paths[i]);
Jie Song9fbfad02017-06-20 16:29:42 -07001688 }
1689
Felipe Lemed8b94e52016-12-08 10:21:44 -08001690 printf("*** See dumpstate-board.txt entry ***\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001691}
1692
Nandana Dutt5fb117b2018-09-27 09:23:36 +01001693static void ShowUsageAndExit(int exit_code = 1) {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001694 fprintf(stderr,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001695 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-o file] [-d] [-p] "
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001696 "[-z]] [-s] [-S] [-q] [-B] [-P] [-R] [-V version]\n"
1697 " -h: display this help message\n"
1698 " -b: play sound file instead of vibrate, at beginning of job\n"
1699 " -e: play sound file instead of vibrate, at end of job\n"
1700 " -o: write to file (instead of stdout)\n"
1701 " -d: append date to filename (requires -o)\n"
1702 " -p: capture screenshot to filename.png (requires -o)\n"
1703 " -z: generate zipped file (requires -o)\n"
1704 " -s: write output to control socket (for init)\n"
Takuya Ogawa47f644e2017-12-20 18:09:09 +09001705 " -S: write file location to control socket (for init; requires -o and -z)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001706 " -q: disable vibrate\n"
1707 " -B: send broadcast when finished (requires -o)\n"
1708 " -P: send broadcast when started and update system properties on "
1709 "progress (requires -o and -B)\n"
1710 " -R: take bugreport in remote mode (requires -o, -z, -d and -B, "
1711 "shouldn't be used with -P)\n"
Felipe Lemed071c682016-10-20 16:48:00 -07001712 " -v: prints the dumpstate header and exit\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01001713 exit(exit_code);
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001714}
1715
1716static void ExitOnInvalidArgs() {
1717 fprintf(stderr, "invalid combination of args\n");
1718 ShowUsageAndExit();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001719}
1720
Wei Liuf87959e2016-08-26 14:51:42 -07001721static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07001722 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07001723}
1724
Felipe Leme1d486fe2016-10-14 18:06:47 -07001725bool Dumpstate::FinishZipFile() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001726 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07001727 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07001728 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07001729 // Final timestamp
1730 char date[80];
1731 time_t the_real_now_please_stand_up = time(nullptr);
1732 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07001733 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001734 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07001735
Felipe Leme9a523ae2016-10-20 15:10:33 -07001736 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001737 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08001738 return false;
1739 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07001740 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001741 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08001742 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08001743 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08001744
Felipe Leme0f3fb202016-06-10 17:10:53 -07001745 // Add log file (which contains stderr output) to zip...
1746 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07001747 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07001748 MYLOGE("Failed to add dumpstate log to .zip file\n");
1749 return false;
1750 }
Nandana Dutt979388e2018-11-30 16:48:55 +00001751 // TODO: Should truncate the existing file.
1752 // ... and re-open it for further logging.
Felipe Leme9a523ae2016-10-20 15:10:33 -07001753 redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()));
Felipe Leme0f3fb202016-06-10 17:10:53 -07001754 fprintf(stderr, "\n");
1755
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07001756 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07001757 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07001758 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08001759 return false;
1760 }
1761
Felipe Leme1d486fe2016-10-14 18:06:47 -07001762 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
1763 ds.zip_file.reset(nullptr);
1764
Felipe Lemee9d2c542016-11-15 11:48:26 -08001765 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
1766 if (remove(tmp_path_.c_str()) != 0) {
1767 MYLOGE("Failed to remove temporary file (%s): %s\n", tmp_path_.c_str(), strerror(errno));
Felipe Lemec4eee562016-04-21 15:42:55 -07001768 }
1769
Felipe Leme1e9edc62015-12-21 16:02:13 -08001770 return true;
1771}
Felipe Leme6e01fa62015-11-11 19:35:14 -08001772
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -07001773static std::string SHA256_file_hash(const std::string& filepath) {
Andreas Gampe27cd7b22016-07-18 18:24:05 -07001774 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(filepath.c_str(), O_RDONLY | O_NONBLOCK
1775 | O_CLOEXEC | O_NOFOLLOW)));
Andreas Gampeaff68432016-07-18 18:01:27 -07001776 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001777 MYLOGE("open(%s): %s\n", filepath.c_str(), strerror(errno));
Yi Kong19d5c002018-07-20 13:39:55 -07001778 return nullptr;
Michal Karpinski4db754f2015-12-11 18:04:32 +00001779 }
1780
1781 SHA256_CTX ctx;
Elliott Hughesc4dc1412016-04-12 16:28:31 -07001782 SHA256_Init(&ctx);
Michal Karpinski4db754f2015-12-11 18:04:32 +00001783
1784 std::vector<uint8_t> buffer(65536);
1785 while (1) {
1786 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd.get(), buffer.data(), buffer.size()));
1787 if (bytes_read == 0) {
1788 break;
1789 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001790 MYLOGE("read(%s): %s\n", filepath.c_str(), strerror(errno));
Yi Kong19d5c002018-07-20 13:39:55 -07001791 return nullptr;
Michal Karpinski4db754f2015-12-11 18:04:32 +00001792 }
1793
Elliott Hughesc4dc1412016-04-12 16:28:31 -07001794 SHA256_Update(&ctx, buffer.data(), bytes_read);
Michal Karpinski4db754f2015-12-11 18:04:32 +00001795 }
1796
Elliott Hughesc4dc1412016-04-12 16:28:31 -07001797 uint8_t hash[SHA256_DIGEST_LENGTH];
1798 SHA256_Final(hash, &ctx);
1799
1800 char hash_buffer[SHA256_DIGEST_LENGTH * 2 + 1];
1801 for(size_t i = 0; i < SHA256_DIGEST_LENGTH; i++) {
Michal Karpinskicbbdf732016-01-07 20:45:02 +00001802 sprintf(hash_buffer + (i * 2), "%02x", hash[i]);
Michal Karpinski4db754f2015-12-11 18:04:32 +00001803 }
1804 hash_buffer[sizeof(hash_buffer) - 1] = 0;
1805 return std::string(hash_buffer);
1806}
1807
Felipe Lemea4ef1f02017-02-15 17:27:40 -08001808static void SendBroadcast(const std::string& action, const std::vector<std::string>& args) {
1809 // clang-format off
1810 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user", "0",
1811 "--receiver-foreground", "--receiver-include-background", "-a", action};
1812 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08001813
1814 am.insert(am.end(), args.begin(), args.end());
1815
Felipe Leme8d2410e2017-02-08 09:46:08 -08001816 RunCommand("", am,
1817 CommandOptions::WithTimeout(20)
1818 .Log("Sending broadcast: '%s'\n")
1819 .Always()
1820 .DropRoot()
1821 .RedirectStderr()
1822 .Build());
1823}
1824
Felipe Leme35b8cf12017-02-10 15:47:29 -08001825static void Vibrate(int duration_ms) {
1826 // clang-format off
1827 RunCommand("", {"cmd", "vibrator", "vibrate", std::to_string(duration_ms), "dumpstate"},
1828 CommandOptions::WithTimeout(10)
1829 .Log("Vibrate: '%s'\n")
1830 .Always()
1831 .Build());
1832 // clang-format on
1833}
1834
Nandana Dutt979388e2018-11-30 16:48:55 +00001835static void MaybeResolveSymlink(std::string* path) {
1836 std::string resolved_path;
1837 if (android::base::Readlink(*path, &resolved_path)) {
1838 *path = resolved_path;
1839 }
1840}
1841
Nandana Dutt4be45d12018-09-26 15:04:23 +01001842/*
1843 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
1844 * if we are writing zip files and adds the version file.
1845 */
1846static void PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00001847 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
1848
1849 std::string base_name_part1 = "bugreport";
1850 if (!ds.options_->use_outfile.empty()) {
1851 ds.bugreport_dir_ = dirname(ds.options_->use_outfile.c_str());
1852 base_name_part1 = basename(ds.options_->use_outfile.c_str());
1853 }
1854
Nandana Dutt4be45d12018-09-26 15:04:23 +01001855 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
1856 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01001857 ds.base_name_ =
Nandana Dutt979388e2018-11-30 16:48:55 +00001858 StringPrintf("%s-%s-%s", base_name_part1.c_str(), device_name.c_str(), build_id.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01001859 if (ds.options_->do_add_date) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01001860 char date[80];
1861 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
1862 ds.name_ = date;
1863 } else {
1864 ds.name_ = "undated";
1865 }
1866
Nandana Dutt5fb117b2018-09-27 09:23:36 +01001867 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01001868 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01001869 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01001870 ds.base_name_ += "-wifi";
1871 }
1872
Nandana Dutt5fb117b2018-09-27 09:23:36 +01001873 if (ds.options_->do_fb) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01001874 ds.screenshot_path_ = ds.GetPath(".png");
1875 }
1876 ds.tmp_path_ = ds.GetPath(".tmp");
1877 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
1878
Nandana Dutt979388e2018-11-30 16:48:55 +00001879 std::string destination = ds.options_->fd != -1 ? StringPrintf("[fd:%d]", ds.options_->fd)
1880 : ds.bugreport_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01001881 MYLOGD(
1882 "Bugreport dir: %s\n"
Nandana Dutt979388e2018-11-30 16:48:55 +00001883 "Internal Bugreport dir: %s\n"
Nandana Dutt4be45d12018-09-26 15:04:23 +01001884 "Base name: %s\n"
1885 "Suffix: %s\n"
1886 "Log path: %s\n"
1887 "Temporary path: %s\n"
1888 "Screenshot path: %s\n",
Nandana Dutt979388e2018-11-30 16:48:55 +00001889 destination.c_str(), ds.bugreport_internal_dir_.c_str(), ds.base_name_.c_str(),
1890 ds.name_.c_str(), ds.log_path_.c_str(), ds.tmp_path_.c_str(), ds.screenshot_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01001891
Nandana Dutt5fb117b2018-09-27 09:23:36 +01001892 if (ds.options_->do_zip_file) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01001893 ds.path_ = ds.GetPath(".zip");
1894 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
1895 create_parent_dirs(ds.path_.c_str());
1896 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
1897 if (ds.zip_file == nullptr) {
1898 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
1899 } else {
1900 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
1901 }
1902 ds.AddTextZipEntry("version.txt", ds.version_);
1903 }
1904}
1905
1906/*
1907 * Finalizes writing to the file by renaming or zipping the tmp file to the final location,
1908 * printing zipped file status, etc.
1909 */
1910static void FinalizeFile() {
Nandana Dutt4be45d12018-09-26 15:04:23 +01001911 /* check if user changed the suffix using system properties */
1912 std::string name =
1913 android::base::GetProperty(android::base::StringPrintf("dumpstate.%d.name", ds.pid_), "");
1914 bool change_suffix = false;
1915 if (!name.empty()) {
1916 /* must whitelist which characters are allowed, otherwise it could cross directories */
1917 std::regex valid_regex("^[-_a-zA-Z0-9]+$");
1918 if (std::regex_match(name.c_str(), valid_regex)) {
1919 change_suffix = true;
1920 } else {
1921 MYLOGE("invalid suffix provided by user: %s\n", name.c_str());
1922 }
1923 }
1924 if (change_suffix) {
1925 MYLOGI("changing suffix from %s to %s\n", ds.name_.c_str(), name.c_str());
1926 ds.name_ = name;
1927 if (!ds.screenshot_path_.empty()) {
1928 std::string new_screenshot_path = ds.GetPath(".png");
1929 if (rename(ds.screenshot_path_.c_str(), new_screenshot_path.c_str())) {
1930 MYLOGE("rename(%s, %s): %s\n", ds.screenshot_path_.c_str(),
1931 new_screenshot_path.c_str(), strerror(errno));
1932 } else {
1933 ds.screenshot_path_ = new_screenshot_path;
1934 }
1935 }
1936 }
1937
1938 bool do_text_file = true;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01001939 if (ds.options_->do_zip_file) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01001940 if (!ds.FinishZipFile()) {
1941 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
1942 do_text_file = true;
1943 } else {
1944 do_text_file = false;
Nandana Dutt383d0c12018-11-30 15:54:56 +00001945 // If the user has changed the suffix, we need to change the zip file name.
1946 std::string new_path = ds.GetPath(".zip");
1947 if (ds.path_ != new_path) {
1948 MYLOGD("Renaming zip file from %s to %s\n", ds.path_.c_str(), new_path.c_str());
1949 if (rename(ds.path_.c_str(), new_path.c_str())) {
1950 MYLOGE("rename(%s, %s): %s\n", ds.path_.c_str(), new_path.c_str(),
1951 strerror(errno));
1952 } else {
1953 ds.path_ = new_path;
1954 }
1955 }
Nandana Dutt979388e2018-11-30 16:48:55 +00001956 // The zip file lives in an internal directory. Copy it over to output.
1957 bool copy_succeeded = false;
1958 if (ds.options_->fd != -1) {
1959 copy_succeeded = android::os::CopyFileToFd(ds.path_, ds.options_->fd);
1960 } else {
1961 ds.final_path_ = ds.GetPath(ds.bugreport_dir_, ".zip");
1962 copy_succeeded = android::os::CopyFileToFile(ds.path_, ds.final_path_);
1963 }
1964 if (copy_succeeded) {
1965 if (remove(ds.path_.c_str())) {
1966 MYLOGE("remove(%s): %s", ds.path_.c_str(), strerror(errno));
1967 }
1968 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001969 }
1970 }
1971 if (do_text_file) {
1972 ds.path_ = ds.GetPath(".txt");
1973 MYLOGD("Generating .txt bugreport at %s from %s\n", ds.path_.c_str(), ds.tmp_path_.c_str());
1974 if (rename(ds.tmp_path_.c_str(), ds.path_.c_str())) {
1975 MYLOGE("rename(%s, %s): %s\n", ds.tmp_path_.c_str(), ds.path_.c_str(), strerror(errno));
1976 ds.path_.clear();
1977 }
1978 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01001979 if (ds.options_->use_control_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01001980 if (do_text_file) {
1981 dprintf(ds.control_socket_fd_,
1982 "FAIL:could not create zip file, check %s "
1983 "for more details\n",
1984 ds.log_path_.c_str());
1985 } else {
1986 dprintf(ds.control_socket_fd_, "OK:%s\n", ds.path_.c_str());
1987 }
1988 }
1989}
1990
1991/* Broadcasts that we are done with the bugreport */
1992static void SendBugreportFinishedBroadcast() {
Nandana Dutt979388e2018-11-30 16:48:55 +00001993 // TODO(b/111441001): use callback instead of broadcast.
1994 if (!ds.final_path_.empty()) {
1995 MYLOGI("Final bugreport path: %s\n", ds.final_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01001996 // clang-format off
1997
1998 std::vector<std::string> am_args = {
1999 "--receiver-permission", "android.permission.DUMP",
2000 "--ei", "android.intent.extra.ID", std::to_string(ds.id_),
2001 "--ei", "android.intent.extra.PID", std::to_string(ds.pid_),
2002 "--ei", "android.intent.extra.MAX", std::to_string(ds.progress_->GetMax()),
Nandana Dutt979388e2018-11-30 16:48:55 +00002003 "--es", "android.intent.extra.BUGREPORT", ds.final_path_,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002004 "--es", "android.intent.extra.DUMPSTATE_LOG", ds.log_path_
2005 };
2006 // clang-format on
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002007 if (ds.options_->do_fb) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002008 am_args.push_back("--es");
2009 am_args.push_back("android.intent.extra.SCREENSHOT");
2010 am_args.push_back(ds.screenshot_path_);
2011 }
Nandana Dutt15b89d72018-11-16 14:14:12 +00002012 if (!ds.options_->notification_title.empty()) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002013 am_args.push_back("--es");
2014 am_args.push_back("android.intent.extra.TITLE");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002015 am_args.push_back(ds.options_->notification_title);
2016 if (!ds.options_->notification_description.empty()) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002017 am_args.push_back("--es");
2018 am_args.push_back("android.intent.extra.DESCRIPTION");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002019 am_args.push_back(ds.options_->notification_description);
Nandana Dutt4be45d12018-09-26 15:04:23 +01002020 }
2021 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002022 if (ds.options_->is_remote_mode) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002023 am_args.push_back("--es");
2024 am_args.push_back("android.intent.extra.REMOTE_BUGREPORT_HASH");
Nandana Dutt979388e2018-11-30 16:48:55 +00002025 am_args.push_back(SHA256_file_hash(ds.final_path_));
Nandana Dutt4be45d12018-09-26 15:04:23 +01002026 SendBroadcast("com.android.internal.intent.action.REMOTE_BUGREPORT_FINISHED", am_args);
2027 } else {
2028 SendBroadcast("com.android.internal.intent.action.BUGREPORT_FINISHED", am_args);
2029 }
2030 } else {
2031 MYLOGE("Skipping finished broadcast because bugreport could not be generated\n");
2032 }
2033}
2034
Nandana Dutt58d72e22018-11-16 10:30:48 +00002035static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2036 switch (mode) {
2037 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2038 return "BUGREPORT_FULL";
2039 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2040 return "BUGREPORT_INTERACTIVE";
2041 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2042 return "BUGREPORT_REMOTE";
2043 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2044 return "BUGREPORT_WEAR";
2045 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2046 return "BUGREPORT_TELEPHONY";
2047 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2048 return "BUGREPORT_WIFI";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002049 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2050 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002051 }
2052}
2053
2054static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options) {
Abhijeet Kaur8ca245e2018-12-12 10:34:21 +00002055 options->extra_options = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002056 switch (mode) {
2057 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2058 options->do_broadcast = true;
2059 options->do_fb = true;
2060 break;
2061 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002062 // Currently, the dumpstate binder is only used by Shell to update progress.
2063 options->do_start_service = true;
2064 options->do_progress_updates = true;
2065 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002066 options->do_broadcast = true;
2067 break;
2068 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002069 options->do_vibrate = false;
2070 options->is_remote_mode = true;
2071 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002072 options->do_broadcast = true;
2073 break;
2074 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002075 options->do_start_service = true;
2076 options->do_progress_updates = true;
2077 options->do_zip_file = true;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002078 options->do_fb = true;
2079 options->do_broadcast = true;
2080 break;
2081 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002082 options->telephony_only = true;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002083 options->do_fb = true;
2084 options->do_broadcast = true;
2085 break;
2086 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002087 options->wifi_only = true;
2088 options->do_zip_file = true;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002089 options->do_fb = true;
2090 options->do_broadcast = true;
2091 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002092 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2093 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002094 }
2095}
2096
2097static Dumpstate::BugreportMode getBugreportModeFromProperty() {
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002098 // If the system property is not set, it's assumed to be a default bugreport.
2099 Dumpstate::BugreportMode mode = Dumpstate::BugreportMode::BUGREPORT_DEFAULT;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002100
2101 std::string extra_options = android::base::GetProperty(PROPERTY_EXTRA_OPTIONS, "");
2102 if (!extra_options.empty()) {
2103 // Framework uses a system property to override some command-line args.
2104 // Currently, it contains the type of the requested bugreport.
2105 if (extra_options == "bugreportplus") {
2106 mode = Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002107 } else if (extra_options == "bugreportfull") {
2108 mode = Dumpstate::BugreportMode::BUGREPORT_FULL;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002109 } else if (extra_options == "bugreportremote") {
2110 mode = Dumpstate::BugreportMode::BUGREPORT_REMOTE;
2111 } else if (extra_options == "bugreportwear") {
2112 mode = Dumpstate::BugreportMode::BUGREPORT_WEAR;
2113 } else if (extra_options == "bugreporttelephony") {
2114 mode = Dumpstate::BugreportMode::BUGREPORT_TELEPHONY;
2115 } else if (extra_options == "bugreportwifi") {
2116 mode = Dumpstate::BugreportMode::BUGREPORT_WIFI;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002117 } else {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002118 MYLOGE("Unknown extra option: %s\n", extra_options.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002119 }
2120 // Reset the property
2121 android::base::SetProperty(PROPERTY_EXTRA_OPTIONS, "");
2122 }
Nandana Dutt58d72e22018-11-16 10:30:48 +00002123 return mode;
2124}
2125
2126// TODO: Move away from system properties when we have options passed via binder calls.
2127/* Sets runtime options from the system properties and then clears those properties. */
2128static void SetOptionsFromProperties(Dumpstate::DumpOptions* options) {
2129 Dumpstate::BugreportMode mode = getBugreportModeFromProperty();
2130 SetOptionsFromMode(mode, options);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002131
2132 options->notification_title = android::base::GetProperty(PROPERTY_EXTRA_TITLE, "");
2133 if (!options->notification_title.empty()) {
2134 // Reset the property
2135 android::base::SetProperty(PROPERTY_EXTRA_TITLE, "");
2136
Nandana Duttdd8cca32018-11-14 10:10:29 +00002137 options->notification_description =
2138 android::base::GetProperty(PROPERTY_EXTRA_DESCRIPTION, "");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002139 if (!options->notification_description.empty()) {
2140 // Reset the property
2141 android::base::SetProperty(PROPERTY_EXTRA_DESCRIPTION, "");
2142 }
2143 MYLOGD("notification (title: %s, description: %s)\n", options->notification_title.c_str(),
2144 options->notification_description.c_str());
2145 }
2146}
2147
Nandana Dutt58d72e22018-11-16 10:30:48 +00002148static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
2149 MYLOGI("do_zip_file: %d\n", options.do_zip_file);
2150 MYLOGI("do_add_date: %d\n", options.do_add_date);
2151 MYLOGI("do_vibrate: %d\n", options.do_vibrate);
2152 MYLOGI("use_socket: %d\n", options.use_socket);
2153 MYLOGI("use_control_socket: %d\n", options.use_control_socket);
2154 MYLOGI("do_fb: %d\n", options.do_fb);
2155 MYLOGI("do_broadcast: %d\n", options.do_broadcast);
2156 MYLOGI("is_remote_mode: %d\n", options.is_remote_mode);
2157 MYLOGI("show_header_only: %d\n", options.show_header_only);
2158 MYLOGI("do_start_service: %d\n", options.do_start_service);
2159 MYLOGI("telephony_only: %d\n", options.telephony_only);
2160 MYLOGI("wifi_only: %d\n", options.wifi_only);
2161 MYLOGI("do_progress_updates: %d\n", options.do_progress_updates);
Nandana Dutt979388e2018-11-30 16:48:55 +00002162 MYLOGI("fd: %d\n", options.fd);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002163 MYLOGI("use_outfile: %s\n", options.use_outfile.c_str());
2164 MYLOGI("extra_options: %s\n", options.extra_options.c_str());
2165 MYLOGI("args: %s\n", options.args.c_str());
2166 MYLOGI("notification_title: %s\n", options.notification_title.c_str());
2167 MYLOGI("notification_description: %s\n", options.notification_description.c_str());
2168}
2169
2170void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode) {
2171 // In the new API world, date is always added; output is always a zip file.
2172 // TODO(111441001): remove these options once they are obsolete.
2173 do_add_date = true;
2174 do_zip_file = true;
2175
2176 // STOPSHIP b/111441001: Remove hardcoded output file path; accept fd.
2177 use_outfile = "/data/user_de/0/com.android.shell/files/bugreports/bugreport";
2178
2179 extra_options = ModeToString(bugreport_mode);
2180 SetOptionsFromMode(bugreport_mode, this);
2181}
2182
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002183Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
2184 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002185 int c;
2186 while ((c = getopt(argc, argv, "dho:svqzpPBRSV:")) != -1) {
2187 switch (c) {
2188 // clang-format off
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002189 case 'd': do_add_date = true; break;
2190 case 'z': do_zip_file = true; break;
2191 case 'o': use_outfile = optarg; break;
2192 case 's': use_socket = true; break;
2193 case 'S': use_control_socket = true; break;
2194 case 'v': show_header_only = true; break;
2195 case 'q': do_vibrate = false; break;
2196 case 'p': do_fb = true; break;
2197 case 'P': do_progress_updates = true; break;
2198 case 'R': is_remote_mode = true; break;
2199 case 'B': do_broadcast = true; break;
2200 case 'V': break; // compatibility no-op
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002201 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002202 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002203 break;
2204 default:
2205 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002206 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002207 break;
2208 // clang-format on
2209 }
2210 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08002211
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002212 // TODO: use helper function to convert argv into a string
2213 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002214 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002215 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002216 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002217 }
2218 }
2219
2220 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
2221 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002222
2223 SetOptionsFromProperties(this);
2224 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002225}
2226
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002227bool Dumpstate::DumpOptions::ValidateOptions() const {
Nandana Dutt979388e2018-11-30 16:48:55 +00002228 if (fd != -1 && !do_zip_file) {
2229 return false;
2230 }
2231
2232 bool has_out_file_options = !use_outfile.empty() || fd != -1;
2233 if ((do_zip_file || do_add_date || do_progress_updates || do_broadcast) &&
2234 !has_out_file_options) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002235 return false;
2236 }
2237
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002238 if (use_control_socket && !do_zip_file) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002239 return false;
2240 }
2241
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002242 if (do_progress_updates && !do_broadcast) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002243 return false;
2244 }
2245
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002246 if (is_remote_mode && (do_progress_updates || !do_broadcast || !do_zip_file || !do_add_date)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002247 return false;
2248 }
2249 return true;
2250}
2251
Nandana Dutt197661d2018-11-16 16:40:21 +00002252void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
2253 options_ = std::move(options);
2254}
2255
Nandana Dutt979388e2018-11-30 16:48:55 +00002256/*
2257 * Dumps relevant information to a bugreport based on the given options.
2258 *
2259 * The bugreport can be dumped to a file or streamed to a socket.
2260 *
2261 * How dumping to file works:
2262 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
2263 * stderr is redirected a log file.
2264 *
2265 * The temporary bugreport is then populated via printfs, dumping contents of files and
2266 * output of commands to stdout.
2267 *
2268 * If zipping, the temporary bugreport file is added to the zip archive. Else it's renamed to final
2269 * text file.
2270 *
2271 * If zipping, a bunch of other files and dumps also get added to the zip archive. The log file also
2272 * gets added to the archive.
2273 *
2274 * Bugreports are first generated in a local directory and later copied to the caller's fd or
2275 * directory.
2276 */
Nandana Dutt197661d2018-11-16 16:40:21 +00002277Dumpstate::RunStatus Dumpstate::Run() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002278 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00002279 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002280 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002281 return RunStatus::INVALID_INPUT;
2282 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002283 /* set as high priority, and protect from OOM killer */
2284 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002285
Felipe Lemed071c682016-10-20 16:48:00 -07002286 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002287 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002288 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002289 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002290 } else {
2291 /* fallback to kernels <= 2.6.35 */
2292 oom_adj = fopen("/proc/self/oom_adj", "we");
2293 if (oom_adj) {
2294 fputs("-17", oom_adj);
2295 fclose(oom_adj);
2296 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002297 }
2298
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002299 if (version_ == VERSION_DEFAULT) {
2300 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00002301 }
2302
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002303 if (version_ != VERSION_CURRENT && version_ != VERSION_SPLIT_ANR) {
Vishnu Nair64afc022018-02-01 15:29:34 -08002304 MYLOGE("invalid version requested ('%s'); suppported values are: ('%s', '%s', '%s')\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002305 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str(),
Vishnu Nair64afc022018-02-01 15:29:34 -08002306 VERSION_SPLIT_ANR.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002307 return RunStatus::INVALID_INPUT;
Felipe Lemed071c682016-10-20 16:48:00 -07002308 }
2309
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002310 if (options_->show_header_only) {
2311 PrintHeader();
2312 return RunStatus::OK;
Felipe Lemed071c682016-10-20 16:48:00 -07002313 }
2314
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002315 // Redirect output if needed
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002316 bool is_redirecting = !options_->use_socket && !options_->use_outfile.empty();
Felipe Leme7447d7c2016-11-03 18:12:22 -07002317
2318 // TODO: temporarily set progress until it's part of the Dumpstate constructor
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002319 std::string stats_path =
Nandana Dutt979388e2018-11-30 16:48:55 +00002320 is_redirecting
2321 ? android::base::StringPrintf("%s/dumpstate-stats.txt", bugreport_internal_dir_.c_str())
2322 : "";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002323 progress_.reset(new Progress(stats_path));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002324
Felipe Lemed071c682016-10-20 16:48:00 -07002325 /* gets the sequential id */
Felipe Leme7447d7c2016-11-03 18:12:22 -07002326 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002327 id_ = ++last_id;
Felipe Lemed071c682016-10-20 16:48:00 -07002328 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
2329
2330 MYLOGI("begin\n");
2331
Felipe Leme6ae5c4f2017-01-10 14:13:22 -08002332 register_sig_handler();
Felipe Lemed071c682016-10-20 16:48:00 -07002333
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002334 if (options_->do_start_service) {
Felipe Leme75876a22016-10-27 16:31:27 -07002335 MYLOGI("Starting 'dumpstate' service\n");
2336 android::status_t ret;
2337 if ((ret = android::os::DumpstateService::Start()) != android::OK) {
2338 MYLOGE("Unable to start DumpstateService: %d\n", ret);
2339 }
2340 }
2341
Felipe Lemef0292972016-11-22 13:57:05 -08002342 if (PropertiesHelper::IsDryRun()) {
Felipe Lemed071c682016-10-20 16:48:00 -07002343 MYLOGI("Running on dry-run mode (to disable it, call 'setprop dumpstate.dry_run false')\n");
2344 }
2345
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002346 MYLOGI("dumpstate info: id=%d, args='%s', extra_options= %s)\n", id_, options_->args.c_str(),
2347 options_->extra_options.c_str());
Felipe Lemed071c682016-10-20 16:48:00 -07002348
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002349 MYLOGI("bugreport format version: %s\n", version_.c_str());
Felipe Leme809d74e2016-02-02 12:57:00 -08002350
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002351 do_early_screenshot_ = options_->do_progress_updates;
Felipe Lemee338bf62015-12-07 14:03:50 -08002352
Christopher Ferrised9354f2014-10-01 17:35:01 -07002353 // If we are going to use a socket, do it as early as possible
2354 // to avoid timeouts from bugreport.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002355 if (options_->use_socket) {
Christopher Ferrised9354f2014-10-01 17:35:01 -07002356 redirect_to_socket(stdout, "dumpstate");
2357 }
2358
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002359 if (options_->use_control_socket) {
Felipe Leme2628e9e2016-04-12 16:36:51 -07002360 MYLOGD("Opening control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002361 control_socket_fd_ = open_socket("dumpstate");
2362 options_->do_progress_updates = 1;
Felipe Leme2628e9e2016-04-12 16:36:51 -07002363 }
2364
Felipe Leme71bbfc52015-11-23 14:14:51 -08002365 if (is_redirecting) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002366 PrepareToWriteToFile();
Felipe Leme1e9edc62015-12-21 16:02:13 -08002367
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002368 if (options_->do_progress_updates) {
2369 if (options_->do_broadcast) {
Felipe Lemedcd1f0d2016-08-04 12:48:50 -07002370 // clang-format off
2371 std::vector<std::string> am_args = {
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002372 "--receiver-permission", "android.permission.DUMP",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002373 "--es", "android.intent.extra.NAME", name_,
2374 "--ei", "android.intent.extra.ID", std::to_string(id_),
2375 "--ei", "android.intent.extra.PID", std::to_string(pid_),
2376 "--ei", "android.intent.extra.MAX", std::to_string(progress_->GetMax()),
Felipe Lemedcd1f0d2016-08-04 12:48:50 -07002377 };
2378 // clang-format on
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002379 SendBroadcast("com.android.internal.intent.action.BUGREPORT_STARTED", am_args);
Felipe Lemedcd1f0d2016-08-04 12:48:50 -07002380 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002381 if (options_->use_control_socket) {
2382 dprintf(control_socket_fd_, "BEGIN:%s\n", path_.c_str());
Felipe Lemeaabfcae2016-07-29 09:49:04 -07002383 }
Felipe Leme71bbfc52015-11-23 14:14:51 -08002384 }
2385 }
2386
Nick Kralevichf3599b32016-01-25 15:05:16 -08002387 /* read /proc/cmdline before dropping root */
2388 FILE *cmdline = fopen("/proc/cmdline", "re");
2389 if (cmdline) {
2390 fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
2391 fclose(cmdline);
2392 }
2393
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002394 if (options_->do_vibrate) {
Felipe Leme35b8cf12017-02-10 15:47:29 -08002395 Vibrate(150);
John Michelau1f794c42012-09-17 11:20:19 -05002396 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002397
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002398 if (options_->do_fb && do_early_screenshot_) {
2399 if (screenshot_path_.empty()) {
Felipe Leme3634a1e2015-12-09 10:11:47 -08002400 // should not have happened
Felipe Lemecbce55d2016-02-08 09:53:18 -08002401 MYLOGE("INTERNAL ERROR: skipping early screenshot because path was not set\n");
Felipe Leme3634a1e2015-12-09 10:11:47 -08002402 } else {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002403 MYLOGI("taking early screenshot\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002404 TakeScreenshot();
Felipe Lemee338bf62015-12-07 14:03:50 -08002405 }
2406 }
2407
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002408 if (options_->do_zip_file && zip_file != nullptr) {
2409 if (chown(path_.c_str(), AID_SHELL, AID_SHELL)) {
2410 MYLOGE("Unable to change ownership of zip file %s: %s\n", path_.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -07002411 strerror(errno));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002412 }
2413 }
2414
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002415 int dup_stdout_fd;
2416 int dup_stderr_fd;
Felipe Leme71bbfc52015-11-23 14:14:51 -08002417 if (is_redirecting) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002418 // Redirect stderr to log_path_ for debugging.
Vishnu Nair20cf5032018-01-05 13:15:49 -08002419 TEMP_FAILURE_RETRY(dup_stderr_fd = dup(fileno(stderr)));
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002420 redirect_to_file(stderr, const_cast<char*>(log_path_.c_str()));
2421 if (chown(log_path_.c_str(), AID_SHELL, AID_SHELL)) {
2422 MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n", log_path_.c_str(),
2423 strerror(errno));
Felipe Leme6fe9db62016-02-12 09:04:16 -08002424 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002425
2426 // Redirect stdout to tmp_path_. This is the main bugreport entry and will be
2427 // moved into zip file later, if zipping.
Vishnu Nair20cf5032018-01-05 13:15:49 -08002428 TEMP_FAILURE_RETRY(dup_stdout_fd = dup(fileno(stdout)));
Nandana Dutt979388e2018-11-30 16:48:55 +00002429 // TODO: why not write to a file instead of stdout to overcome this problem?
Felipe Leme6e01fa62015-11-11 19:35:14 -08002430 /* TODO: rather than generating a text file now and zipping it later,
2431 it would be more efficient to redirect stdout to the zip entry
2432 directly, but the libziparchive doesn't support that option yet. */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002433 redirect_to_file(stdout, const_cast<char*>(tmp_path_.c_str()));
2434 if (chown(tmp_path_.c_str(), AID_SHELL, AID_SHELL)) {
Felipe Leme6fe9db62016-02-12 09:04:16 -08002435 MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002436 tmp_path_.c_str(), strerror(errno));
Felipe Leme6fe9db62016-02-12 09:04:16 -08002437 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002438 }
Felipe Lemed8b94e52016-12-08 10:21:44 -08002439
2440 // Don't buffer stdout
2441 setvbuf(stdout, nullptr, _IONBF, 0);
2442
Felipe Leme608385d2016-02-01 10:35:38 -08002443 // NOTE: there should be no stdout output until now, otherwise it would break the header.
2444 // In particular, DurationReport objects should be created passing 'title, NULL', so their
Felipe Lemecbce55d2016-02-08 09:53:18 -08002445 // duration is logged into MYLOG instead.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002446 PrintHeader();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002447
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002448 if (options_->telephony_only) {
Jayachandran Ca94c7172017-06-10 15:08:12 -07002449 DumpstateTelephonyOnly();
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002450 DumpstateBoard();
2451 } else if (options_->wifi_only) {
mukesh agrawal253dad42018-01-23 21:59:59 -08002452 DumpstateWifiOnly();
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002453 } else {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002454 // Dump state for the default case. This also drops root.
2455 if (!DumpstateDefault()) {
2456 // Something went wrong.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002457 return RunStatus::ERROR;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002458 }
Zhengyin Qian068ecc72016-08-10 16:48:14 -07002459 }
Felipe Leme71a74ac2016-03-17 15:43:25 -07002460
Felipe Leme55b42a62015-11-10 17:39:08 -08002461 /* close output if needed */
Felipe Leme71bbfc52015-11-23 14:14:51 -08002462 if (is_redirecting) {
Vishnu Nair20cf5032018-01-05 13:15:49 -08002463 TEMP_FAILURE_RETRY(dup2(dup_stdout_fd, fileno(stdout)));
Colin Crossf45fa6b2012-03-26 12:38:26 -07002464 }
2465
Felipe Leme6e01fa62015-11-11 19:35:14 -08002466 /* rename or zip the (now complete) .tmp file to its final location */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002467 if (!options_->use_outfile.empty()) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002468 FinalizeFile();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002469 }
2470
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002471 /* vibrate a few but shortly times to let user know it's finished */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002472 if (options_->do_vibrate) {
Takuya Ogawa47f644e2017-12-20 18:09:09 +09002473 for (int i = 0; i < 3; i++) {
2474 Vibrate(75);
2475 usleep((75 + 50) * 1000);
2476 }
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002477 }
2478
Jeff Brown1dc94e32014-09-11 14:15:27 -07002479 /* tell activity manager we're done */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002480 if (options_->do_broadcast) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002481 SendBugreportFinishedBroadcast();
Jeff Sharkey27f9e6d2013-03-13 15:45:50 -07002482 }
2483
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002484 MYLOGD("Final progress: %d/%d (estimated %d)\n", progress_->Get(), progress_->GetMax(),
2485 progress_->GetInitialMax());
2486 progress_->Save();
2487 MYLOGI("done (id %d)\n", id_);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002488
Felipe Leme107a05f2016-03-08 15:11:15 -08002489 if (is_redirecting) {
Vishnu Nair20cf5032018-01-05 13:15:49 -08002490 TEMP_FAILURE_RETRY(dup2(dup_stderr_fd, fileno(stderr)));
Felipe Leme107a05f2016-03-08 15:11:15 -08002491 }
2492
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002493 if (options_->use_control_socket && control_socket_fd_ != -1) {
Felipe Lemee844a9d2016-09-21 15:01:39 -07002494 MYLOGD("Closing control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002495 close(control_socket_fd_);
Felipe Leme2628e9e2016-04-12 16:36:51 -07002496 }
2497
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002498 tombstone_data_.clear();
2499 anr_data_.clear();
Narayan Kamath6b9516c2017-10-27 11:15:51 +01002500
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002501 return RunStatus::OK;
2502}
2503
Nandana Dutt979388e2018-11-30 16:48:55 +00002504/* Main entry point for dumpstate binary. */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002505int run_main(int argc, char* argv[]) {
2506 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
2507 Dumpstate::RunStatus status = options->Initialize(argc, argv);
2508 if (status == Dumpstate::RunStatus::OK) {
Nandana Dutt197661d2018-11-16 16:40:21 +00002509 ds.SetOptions(std::move(options));
2510 status = ds.Run();
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002511 }
2512
2513 switch (status) {
2514 case Dumpstate::RunStatus::OK:
2515 return 0;
Nandana Dutt979388e2018-11-30 16:48:55 +00002516 // TODO(b/111441001): Exit directly in the following cases.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002517 case Dumpstate::RunStatus::HELP:
2518 ShowUsageAndExit(0 /* exit code */);
2519 break;
2520 case Dumpstate::RunStatus::INVALID_INPUT:
2521 ExitOnInvalidArgs();
2522 break;
2523 case Dumpstate::RunStatus::ERROR:
2524 exit(-1);
2525 break;
2526 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002527 return 0;
2528}