blob: 70154e8db3d90368f2d8ca35c6e838f750962f7b [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"
Erik Kline08165202016-05-30 11:55:44 +0900111#define WLUTIL "/vendor/xbin/wlutil"
Vishnu Nair36b4cdb2017-11-17 10:27:05 -0800112#define WMTRACE_DATA_DIR "/data/misc/wmtrace"
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700113
Narayan Kamath8f788292017-05-25 13:20:39 +0100114// TODO(narayan): Since this information has to be kept in sync
115// with tombstoned, we should just put it in a common header.
116//
117// File: system/core/debuggerd/tombstoned/tombstoned.cpp
Narayan Kamathbd863722017-06-01 18:50:12 +0100118static const std::string TOMBSTONE_DIR = "/data/tombstones/";
119static const std::string TOMBSTONE_FILE_PREFIX = "tombstone_";
120static const std::string ANR_DIR = "/data/anr/";
121static const std::string ANR_FILE_PREFIX = "anr_";
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700122
Felipe Lemee844a9d2016-09-21 15:01:39 -0700123// TODO: temporary variables and functions used during C++ refactoring
124static Dumpstate& ds = Dumpstate::GetInstance();
Nandana Dutt979388e2018-11-30 16:48:55 +0000125
126namespace android {
127namespace os {
128namespace {
129
130static int Open(std::string path, int flags, mode_t mode = 0) {
131 int fd = TEMP_FAILURE_RETRY(open(path.c_str(), flags, mode));
132 if (fd == -1) {
133 MYLOGE("open(%s, %s)\n", path.c_str(), strerror(errno));
134 }
135 return fd;
136}
137
138static int OpenForWrite(std::string path) {
139 return Open(path, O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
140 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH);
141}
142
143static int OpenForRead(std::string path) {
144 return Open(path, O_RDONLY | O_CLOEXEC | O_NOFOLLOW);
145}
146
147bool CopyFile(int in_fd, int out_fd) {
148 char buf[4096];
149 ssize_t byte_count;
150 while ((byte_count = TEMP_FAILURE_RETRY(read(in_fd, buf, sizeof(buf)))) > 0) {
151 if (!android::base::WriteFully(out_fd, buf, byte_count)) {
152 return false;
153 }
154 }
155 return (byte_count != -1);
156}
157
158static bool CopyFileToFd(const std::string& input_file, int out_fd) {
159 MYLOGD("Going to copy bugreport file (%s) to %d\n", ds.path_.c_str(), out_fd);
160
161 // Obtain a handle to the source file.
162 android::base::unique_fd in_fd(OpenForRead(input_file));
163 if (out_fd != -1 && in_fd.get() != -1) {
164 if (CopyFile(in_fd.get(), out_fd)) {
165 return true;
166 }
167 MYLOGE("Failed to copy zip file: %s\n", strerror(errno));
168 }
169 return false;
170}
171
172static bool CopyFileToFile(const std::string& input_file, const std::string& output_file) {
173 if (input_file == output_file) {
174 MYLOGD("Skipping copying bugreport file since the destination is the same (%s)\n",
175 output_file.c_str());
176 return false;
177 }
178
179 MYLOGD("Going to copy bugreport file (%s) to %s\n", input_file.c_str(), output_file.c_str());
180 android::base::unique_fd out_fd(OpenForWrite(output_file));
181 return CopyFileToFd(input_file, out_fd.get());
182}
183
184} // namespace
185} // namespace os
186} // namespace android
187
Felipe Leme678727a2016-09-21 17:22:11 -0700188static int RunCommand(const std::string& title, const std::vector<std::string>& fullCommand,
189 const CommandOptions& options = CommandOptions::DEFAULT) {
190 return ds.RunCommand(title, fullCommand, options);
191}
192static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
Felipe Lemebda15a02016-11-16 17:48:25 -0800193 const CommandOptions& options = Dumpstate::DEFAULT_DUMPSYS,
Vishnu Nair6921f802017-11-22 09:17:23 -0800194 long dumpsysTimeoutMs = 0) {
195 return ds.RunDumpsys(title, dumpsysArgs, options, dumpsysTimeoutMs);
Felipe Leme678727a2016-09-21 17:22:11 -0700196}
197static int DumpFile(const std::string& title, const std::string& path) {
198 return ds.DumpFile(title, path);
199}
Felipe Lemee82a27d2016-01-05 13:35:44 -0800200
Felipe Lemee844a9d2016-09-21 15:01:39 -0700201// Relative directory (inside the zip) for all files copied as-is into the bugreport.
202static const std::string ZIP_ROOT_DIR = "FS";
203
Vishnu Naire97d6122018-01-18 13:58:56 -0800204static const std::string kProtoPath = "proto/";
205static const std::string kProtoExt = ".proto";
Jie Song9fbfad02017-06-20 16:29:42 -0700206static const std::string kDumpstateBoardFiles[] = {
207 "dumpstate_board.txt",
Felipe Leme95d6ca52017-08-01 16:35:56 -0700208 "dumpstate_board.bin"
Jie Song9fbfad02017-06-20 16:29:42 -0700209};
210static const int NUM_OF_DUMPS = arraysize(kDumpstateBoardFiles);
211
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700212static constexpr char PROPERTY_EXTRA_OPTIONS[] = "dumpstate.options";
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700213static constexpr char PROPERTY_LAST_ID[] = "dumpstate.last_id";
Felipe Lemed071c682016-10-20 16:48:00 -0700214static constexpr char PROPERTY_VERSION[] = "dumpstate.version";
Naveen Kallab53a1c92017-03-16 18:17:25 -0700215static constexpr char PROPERTY_EXTRA_TITLE[] = "dumpstate.options.title";
216static constexpr char PROPERTY_EXTRA_DESCRIPTION[] = "dumpstate.options.description";
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700217
Felipe Lemef0292972016-11-22 13:57:05 -0800218static const CommandOptions AS_ROOT_20 = CommandOptions::WithTimeout(20).AsRoot().Build();
219
Narayan Kamath8f788292017-05-25 13:20:39 +0100220/*
Narayan Kamathbd863722017-06-01 18:50:12 +0100221 * Returns a vector of dump fds under |dir_path| with a given |file_prefix|.
222 * The returned vector is sorted by the mtimes of the dumps. If |limit_by_mtime|
223 * is set, the vector only contains files that were written in the last 30 minutes.
Andreas Gamped0d76952017-08-22 13:08:37 -0700224 * If |limit_by_count| is set, the vector only contains the ten latest files.
Narayan Kamath8f788292017-05-25 13:20:39 +0100225 */
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700226static std::vector<DumpData> GetDumpFds(const std::string& dir_path,
227 const std::string& file_prefix,
228 bool limit_by_mtime,
229 bool limit_by_count = true) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100230 const time_t thirty_minutes_ago = ds.now_ - 60 * 30;
231
Narayan Kamathbd863722017-06-01 18:50:12 +0100232 std::unique_ptr<DIR, decltype(&closedir)> dump_dir(opendir(dir_path.c_str()), closedir);
Narayan Kamath8f788292017-05-25 13:20:39 +0100233
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700234 if (dump_dir == nullptr) {
235 MYLOGW("Unable to open directory %s: %s\n", dir_path.c_str(), strerror(errno));
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700236 return std::vector<DumpData>();
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700237 }
238
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700239 std::vector<DumpData> dump_data;
Narayan Kamathbd863722017-06-01 18:50:12 +0100240 struct dirent* entry = nullptr;
241 while ((entry = readdir(dump_dir.get()))) {
242 if (entry->d_type != DT_REG) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100243 continue;
244 }
245
Narayan Kamathbd863722017-06-01 18:50:12 +0100246 const std::string base_name(entry->d_name);
247 if (base_name.find(file_prefix) != 0) {
248 continue;
249 }
250
251 const std::string abs_path = dir_path + base_name;
252 android::base::unique_fd fd(
253 TEMP_FAILURE_RETRY(open(abs_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW | O_NONBLOCK)));
254 if (fd == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700255 MYLOGW("Unable to open dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamathbd863722017-06-01 18:50:12 +0100256 break;
257 }
258
259 struct stat st = {};
260 if (fstat(fd, &st) == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700261 MYLOGW("Unable to stat dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamath8f788292017-05-25 13:20:39 +0100262 continue;
263 }
264
Narayan Kamath3f31b632018-02-22 19:42:36 +0000265 if (limit_by_mtime && st.st_mtime < thirty_minutes_ago) {
Narayan Kamathbd863722017-06-01 18:50:12 +0100266 MYLOGI("Excluding stale dump file: %s\n", abs_path.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100267 continue;
268 }
269
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700270 dump_data.emplace_back(DumpData{abs_path, std::move(fd), st.st_mtime});
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700271 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100272
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700273 // Sort in descending modification time so that we only keep the newest
274 // reports if |limit_by_count| is true.
275 std::sort(dump_data.begin(), dump_data.end(),
276 [](const DumpData& d1, const DumpData& d2) { return d1.mtime > d2.mtime; });
Narayan Kamath8f788292017-05-25 13:20:39 +0100277
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700278 if (limit_by_count && dump_data.size() > 10) {
279 dump_data.erase(dump_data.begin() + 10, dump_data.end());
Andreas Gamped0d76952017-08-22 13:08:37 -0700280 }
281
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700282 return dump_data;
Narayan Kamath8f788292017-05-25 13:20:39 +0100283}
284
Narayan Kamathbd863722017-06-01 18:50:12 +0100285static bool AddDumps(const std::vector<DumpData>::const_iterator start,
286 const std::vector<DumpData>::const_iterator end,
287 const char* type_name, const bool add_to_zip) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100288 bool dumped = false;
Narayan Kamathbd863722017-06-01 18:50:12 +0100289 for (auto it = start; it != end; ++it) {
290 const std::string& name = it->name;
291 const int fd = it->fd;
Narayan Kamath8f788292017-05-25 13:20:39 +0100292 dumped = true;
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100293
294 // Seek to the beginning of the file before dumping any data. A given
295 // DumpData entry might be dumped multiple times in the report.
296 //
297 // For example, the most recent ANR entry is dumped to the body of the
298 // main entry and it also shows up as a separate entry in the bugreport
299 // ZIP file.
300 if (lseek(fd, 0, SEEK_SET) != static_cast<off_t>(0)) {
301 MYLOGE("Unable to add %s to zip file, lseek failed: %s\n", name.c_str(),
302 strerror(errno));
303 }
304
Narayan Kamath8f788292017-05-25 13:20:39 +0100305 if (ds.IsZipping() && add_to_zip) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800306 if (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + name, fd, /* timeout = */ 0ms) != OK) {
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100307 MYLOGE("Unable to add %s to zip file, addZipEntryFromFd failed\n", name.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100308 }
309 } else {
310 dump_file_from_fd(type_name, name.c_str(), fd);
311 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100312 }
313
314 return dumped;
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700315}
316
Felipe Leme635ca312016-01-05 14:23:02 -0800317// for_each_pid() callback to get mount info about a process.
Felipe Leme4c2d6632016-09-28 14:32:00 -0700318void do_mountinfo(int pid, const char* name __attribute__((unused))) {
Felipe Leme635ca312016-01-05 14:23:02 -0800319 char path[PATH_MAX];
320
321 // Gets the the content of the /proc/PID/ns/mnt link, so only unique mount points
322 // are added.
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700323 snprintf(path, sizeof(path), "/proc/%d/ns/mnt", pid);
Felipe Leme635ca312016-01-05 14:23:02 -0800324 char linkname[PATH_MAX];
325 ssize_t r = readlink(path, linkname, PATH_MAX);
326 if (r == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800327 MYLOGE("Unable to read link for %s: %s\n", path, strerror(errno));
Felipe Leme635ca312016-01-05 14:23:02 -0800328 return;
329 }
330 linkname[r] = '\0';
331
332 if (mount_points.find(linkname) == mount_points.end()) {
333 // First time this mount point was found: add it
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700334 snprintf(path, sizeof(path), "/proc/%d/mountinfo", pid);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700335 if (ds.AddZipEntry(ZIP_ROOT_DIR + path, path)) {
Felipe Leme635ca312016-01-05 14:23:02 -0800336 mount_points.insert(linkname);
337 } else {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800338 MYLOGE("Unable to add mountinfo %s to zip file\n", path);
Felipe Leme635ca312016-01-05 14:23:02 -0800339 }
340 }
341}
342
343void add_mountinfo() {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700344 if (!ds.IsZipping()) return;
Felipe Leme678727a2016-09-21 17:22:11 -0700345 std::string title = "MOUNT INFO";
Felipe Leme635ca312016-01-05 14:23:02 -0800346 mount_points.clear();
Felipe Leme46b85da2016-11-21 17:40:45 -0800347 DurationReporter duration_reporter(title, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700348 for_each_pid(do_mountinfo, nullptr);
349 MYLOGD("%s: %d entries added to zip file\n", title.c_str(), (int)mount_points.size());
Felipe Leme635ca312016-01-05 14:23:02 -0800350}
351
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700352static void dump_dev_files(const char *title, const char *driverpath, const char *filename)
353{
354 DIR *d;
355 struct dirent *de;
356 char path[PATH_MAX];
357
358 d = opendir(driverpath);
Yi Kong19d5c002018-07-20 13:39:55 -0700359 if (d == nullptr) {
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700360 return;
361 }
362
363 while ((de = readdir(d))) {
364 if (de->d_type != DT_LNK) {
365 continue;
366 }
367 snprintf(path, sizeof(path), "%s/%s/%s", driverpath, de->d_name, filename);
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700368 DumpFile(title, path);
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700369 }
370
371 closedir(d);
372}
373
Zhengyin Qian068ecc72016-08-10 16:48:14 -0700374
Zhengyin Qian068ecc72016-08-10 16:48:14 -0700375
376// dump anrd's trace and add to the zip file.
377// 1. check if anrd is running on this device.
378// 2. send a SIGUSR1 to its pid which will dump anrd's trace.
379// 3. wait until the trace generation completes and add to the zip file.
380static bool dump_anrd_trace() {
381 unsigned int pid;
382 char buf[50], path[PATH_MAX];
383 struct dirent *trace;
384 struct stat st;
385 DIR *trace_dir;
Zhengyin Qianafc38fe2016-09-08 16:50:09 -0700386 int retry = 5;
387 long max_ctime = 0, old_mtime;
Zhengyin Qian068ecc72016-08-10 16:48:14 -0700388 long long cur_size = 0;
389 const char *trace_path = "/data/misc/anrd/";
390
Felipe Leme1d486fe2016-10-14 18:06:47 -0700391 if (!ds.IsZipping()) {
392 MYLOGE("Not dumping anrd trace because it's not a zipped bugreport\n");
Zhengyin Qian068ecc72016-08-10 16:48:14 -0700393 return false;
394 }
395
396 // find anrd's pid if it is running.
Dan Willemsen4a0a8342018-05-04 13:05:01 -0700397 pid = GetPidByName("/system/bin/anrd");
Zhengyin Qian068ecc72016-08-10 16:48:14 -0700398
399 if (pid > 0) {
Zhengyin Qianafc38fe2016-09-08 16:50:09 -0700400 if (stat(trace_path, &st) == 0) {
401 old_mtime = st.st_mtime;
402 } else {
403 MYLOGE("Failed to find: %s\n", trace_path);
404 return false;
405 }
406
Zhengyin Qian068ecc72016-08-10 16:48:14 -0700407 // send SIGUSR1 to the anrd to generate a trace.
408 sprintf(buf, "%u", pid);
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700409 if (RunCommand("ANRD_DUMP", {"kill", "-SIGUSR1", buf},
Felipe Leme30dbfa12016-09-02 12:43:26 -0700410 CommandOptions::WithTimeout(1).Build())) {
Zhengyin Qian068ecc72016-08-10 16:48:14 -0700411 MYLOGE("anrd signal timed out. Please manually collect trace\n");
412 return false;
413 }
414
Zhengyin Qianafc38fe2016-09-08 16:50:09 -0700415 while (retry-- > 0 && old_mtime == st.st_mtime) {
416 sleep(1);
417 stat(trace_path, &st);
418 }
419
420 if (retry < 0 && old_mtime == st.st_mtime) {
421 MYLOGE("Failed to stat %s or trace creation timeout\n", trace_path);
422 return false;
423 }
424
Zhengyin Qian068ecc72016-08-10 16:48:14 -0700425 // identify the trace file by its creation time.
426 if (!(trace_dir = opendir(trace_path))) {
427 MYLOGE("Can't open trace file under %s\n", trace_path);
428 }
429 while ((trace = readdir(trace_dir))) {
430 if (strcmp(trace->d_name, ".") == 0
431 || strcmp(trace->d_name, "..") == 0) {
432 continue;
433 }
434 sprintf(path, "%s%s", trace_path, trace->d_name);
435 if (stat(path, &st) == 0) {
436 if (st.st_ctime > max_ctime) {
437 max_ctime = st.st_ctime;
438 sprintf(buf, "%s", trace->d_name);
439 }
440 }
441 }
442 closedir(trace_dir);
443
444 // Wait until the dump completes by checking the size of the trace.
445 if (max_ctime > 0) {
446 sprintf(path, "%s%s", trace_path, buf);
447 while(true) {
448 sleep(1);
449 if (stat(path, &st) == 0) {
450 if (st.st_size == cur_size) {
451 break;
452 } else if (st.st_size > cur_size) {
453 cur_size = st.st_size;
454 } else {
455 return false;
456 }
457 } else {
458 MYLOGE("Cant stat() %s anymore\n", path);
459 return false;
460 }
461 }
462 // Add to the zip file.
Felipe Leme1d486fe2016-10-14 18:06:47 -0700463 if (!ds.AddZipEntry("anrd_trace.txt", path)) {
Zhengyin Qian068ecc72016-08-10 16:48:14 -0700464 MYLOGE("Unable to add anrd_trace file %s to zip file\n", path);
465 } else {
466 if (remove(path)) {
467 MYLOGE("Error removing anrd_trace file %s: %s", path, strerror(errno));
468 }
469 return true;
470 }
471 } else {
472 MYLOGE("Can't stats any trace file under %s\n", trace_path);
473 }
474 }
475 return false;
476}
477
Felipe Lemeefd7e272016-05-18 09:27:16 -0700478static void dump_systrace() {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700479 if (!ds.IsZipping()) {
480 MYLOGD("Not dumping systrace because it's not a zipped bugreport\n");
Felipe Leme71a74ac2016-03-17 15:43:25 -0700481 return;
482 }
Felipe Lemebbaf3c12016-10-11 14:32:25 -0700483 std::string systrace_path = ds.GetPath("-systrace.txt");
Felipe Leme14e034a2016-03-30 18:51:03 -0700484 if (systrace_path.empty()) {
485 MYLOGE("Not dumping systrace because path is empty\n");
486 return;
487 }
Felipe Leme71a74ac2016-03-17 15:43:25 -0700488 const char* path = "/sys/kernel/debug/tracing/tracing_on";
489 long int is_tracing;
490 if (read_file_as_long(path, &is_tracing)) {
491 return; // error already logged
492 }
493 if (is_tracing <= 0) {
494 MYLOGD("Skipping systrace because '%s' content is '%ld'\n", path, is_tracing);
495 return;
496 }
497
Felipe Leme14e034a2016-03-30 18:51:03 -0700498 MYLOGD("Running '/system/bin/atrace --async_dump -o %s', which can take several minutes",
499 systrace_path.c_str());
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700500 if (RunCommand("SYSTRACE", {"/system/bin/atrace", "--async_dump", "-o", systrace_path},
Felipe Leme30dbfa12016-09-02 12:43:26 -0700501 CommandOptions::WithTimeout(120).Build())) {
Felipe Leme14e034a2016-03-30 18:51:03 -0700502 MYLOGE("systrace timed out, its zip entry will be incomplete\n");
Felipe Lemec7fe8fe2016-09-21 18:13:20 -0700503 // TODO: RunCommand tries to kill the process, but atrace doesn't die
Felipe Leme30dbfa12016-09-02 12:43:26 -0700504 // peacefully; ideally, we should call strace to stop itself, but there is no such option
505 // yet (just a --async_stop, which stops and dump
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700506 // if (RunCommand("SYSTRACE", {"/system/bin/atrace", "--kill"})) {
Felipe Leme30dbfa12016-09-02 12:43:26 -0700507 // MYLOGE("could not stop systrace ");
508 // }
Felipe Leme14e034a2016-03-30 18:51:03 -0700509 }
Felipe Leme1d486fe2016-10-14 18:06:47 -0700510 if (!ds.AddZipEntry("systrace.txt", systrace_path)) {
Felipe Leme14e034a2016-03-30 18:51:03 -0700511 MYLOGE("Unable to add systrace file %s to zip file\n", systrace_path.c_str());
Felipe Leme71a74ac2016-03-17 15:43:25 -0700512 } else {
Felipe Leme14e034a2016-03-30 18:51:03 -0700513 if (remove(systrace_path.c_str())) {
514 MYLOGE("Error removing systrace file %s: %s", systrace_path.c_str(), strerror(errno));
515 }
Felipe Leme71a74ac2016-03-17 15:43:25 -0700516 }
517}
518
Mark Salyzyn326842f2015-04-30 09:49:41 -0700519static bool skip_not_stat(const char *path) {
520 static const char stat[] = "/stat";
521 size_t len = strlen(path);
522 if (path[len - 1] == '/') { /* Directory? */
523 return false;
524 }
525 return strcmp(path + len - sizeof(stat) + 1, stat); /* .../stat? */
526}
527
Felipe Leme4c2d6632016-09-28 14:32:00 -0700528static bool skip_none(const char* path __attribute__((unused))) {
Felipe Lemee82a27d2016-01-05 13:35:44 -0800529 return false;
530}
531
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700532unsigned long worst_write_perf = 20000; /* in KB/s */
Mark Salyzyn326842f2015-04-30 09:49:41 -0700533
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800534//
535// stat offsets
536// Name units description
537// ---- ----- -----------
538// read I/Os requests number of read I/Os processed
539#define __STAT_READ_IOS 0
540// read merges requests number of read I/Os merged with in-queue I/O
541#define __STAT_READ_MERGES 1
542// read sectors sectors number of sectors read
543#define __STAT_READ_SECTORS 2
544// read ticks milliseconds total wait time for read requests
545#define __STAT_READ_TICKS 3
546// write I/Os requests number of write I/Os processed
547#define __STAT_WRITE_IOS 4
548// write merges requests number of write I/Os merged with in-queue I/O
549#define __STAT_WRITE_MERGES 5
550// write sectors sectors number of sectors written
551#define __STAT_WRITE_SECTORS 6
552// write ticks milliseconds total wait time for write requests
553#define __STAT_WRITE_TICKS 7
554// in_flight requests number of I/Os currently in flight
555#define __STAT_IN_FLIGHT 8
556// io_ticks milliseconds total time this block device has been active
557#define __STAT_IO_TICKS 9
558// time_in_queue milliseconds total wait time for all requests
559#define __STAT_IN_QUEUE 10
560#define __STAT_NUMBER_FIELD 11
561//
562// read I/Os, write I/Os
563// =====================
564//
565// These values increment when an I/O request completes.
566//
567// read merges, write merges
568// =========================
569//
570// These values increment when an I/O request is merged with an
571// already-queued I/O request.
572//
573// read sectors, write sectors
574// ===========================
575//
576// These values count the number of sectors read from or written to this
577// block device. The "sectors" in question are the standard UNIX 512-byte
578// sectors, not any device- or filesystem-specific block size. The
579// counters are incremented when the I/O completes.
580#define SECTOR_SIZE 512
581//
582// read ticks, write ticks
583// =======================
584//
585// These values count the number of milliseconds that I/O requests have
586// waited on this block device. If there are multiple I/O requests waiting,
587// these values will increase at a rate greater than 1000/second; for
588// example, if 60 read requests wait for an average of 30 ms, the read_ticks
589// field will increase by 60*30 = 1800.
590//
591// in_flight
592// =========
593//
594// This value counts the number of I/O requests that have been issued to
595// the device driver but have not yet completed. It does not include I/O
596// requests that are in the queue but not yet issued to the device driver.
597//
598// io_ticks
599// ========
600//
601// This value counts the number of milliseconds during which the device has
602// had I/O requests queued.
603//
604// time_in_queue
605// =============
606//
607// This value counts the number of milliseconds that I/O requests have waited
608// on this block device. If there are multiple I/O requests waiting, this
609// value will increase as the product of the number of milliseconds times the
610// number of requests waiting (see "read ticks" above for an example).
611#define S_TO_MS 1000
612//
613
Mark Salyzyn326842f2015-04-30 09:49:41 -0700614static int dump_stat_from_fd(const char *title __unused, const char *path, int fd) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800615 unsigned long long fields[__STAT_NUMBER_FIELD];
Mark Salyzyn326842f2015-04-30 09:49:41 -0700616 bool z;
Yi Kong19d5c002018-07-20 13:39:55 -0700617 char *cp, *buffer = nullptr;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700618 size_t i = 0;
Josh Gao7c4258c2018-06-25 13:40:08 -0700619 FILE *fp = fdopen(dup(fd), "rb");
Mark Salyzyn326842f2015-04-30 09:49:41 -0700620 getline(&buffer, &i, fp);
621 fclose(fp);
622 if (!buffer) {
623 return -errno;
624 }
625 i = strlen(buffer);
626 while ((i > 0) && (buffer[i - 1] == '\n')) {
627 buffer[--i] = '\0';
628 }
629 if (!*buffer) {
630 free(buffer);
631 return 0;
632 }
633 z = true;
634 for (cp = buffer, i = 0; i < (sizeof(fields) / sizeof(fields[0])); ++i) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800635 fields[i] = strtoull(cp, &cp, 10);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700636 if (fields[i] != 0) {
637 z = false;
638 }
639 }
640 if (z) { /* never accessed */
641 free(buffer);
642 return 0;
643 }
644
Wei Wang509bb5d2017-06-09 14:42:12 -0700645 if (!strncmp(path, BLK_DEV_SYS_DIR, sizeof(BLK_DEV_SYS_DIR) - 1)) {
646 path += sizeof(BLK_DEV_SYS_DIR) - 1;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700647 }
Wei Wang1dc1ef52017-06-12 11:28:37 -0700648
649 printf("%-30s:%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s\n%-30s:\t%s\n", "Block-Dev",
650 "R-IOs", "R-merg", "R-sect", "R-wait", "W-IOs", "W-merg", "W-sect",
651 "W-wait", "in-fli", "activ", "T-wait", path, buffer);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700652 free(buffer);
653
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800654 if (fields[__STAT_IO_TICKS]) {
655 unsigned long read_perf = 0;
656 unsigned long read_ios = 0;
657 if (fields[__STAT_READ_TICKS]) {
658 unsigned long long divisor = fields[__STAT_READ_TICKS]
659 * fields[__STAT_IO_TICKS];
660 read_perf = ((unsigned long long)SECTOR_SIZE
661 * fields[__STAT_READ_SECTORS]
662 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
663 / divisor;
664 read_ios = ((unsigned long long)S_TO_MS * fields[__STAT_READ_IOS]
665 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
666 / divisor;
667 }
668
669 unsigned long write_perf = 0;
670 unsigned long write_ios = 0;
671 if (fields[__STAT_WRITE_TICKS]) {
672 unsigned long long divisor = fields[__STAT_WRITE_TICKS]
673 * fields[__STAT_IO_TICKS];
674 write_perf = ((unsigned long long)SECTOR_SIZE
675 * fields[__STAT_WRITE_SECTORS]
676 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
677 / divisor;
678 write_ios = ((unsigned long long)S_TO_MS * fields[__STAT_WRITE_IOS]
679 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
680 / divisor;
681 }
682
683 unsigned queue = (fields[__STAT_IN_QUEUE]
684 + (fields[__STAT_IO_TICKS] >> 1))
685 / fields[__STAT_IO_TICKS];
686
687 if (!write_perf && !write_ios) {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700688 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 -0800689 } else {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700690 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 -0800691 read_ios, write_perf, write_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800692 }
693
694 /* bugreport timeout factor adjustment */
695 if ((write_perf > 1) && (write_perf < worst_write_perf)) {
696 worst_write_perf = write_perf;
697 }
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700698 }
Mark Salyzyn326842f2015-04-30 09:49:41 -0700699 return 0;
700}
701
Yao Chenbe3bbc12018-01-17 16:31:10 -0800702static const long MINIMUM_LOGCAT_TIMEOUT_MS = 50000;
703
704/* timeout in ms to read a list of buffers */
705static unsigned long logcat_timeout(const std::vector<std::string>& buffers) {
706 unsigned long timeout_ms = 0;
707 for (const auto& buffer : buffers) {
708 log_id_t id = android_name_to_log_id(buffer.c_str());
709 unsigned long property_size = __android_logger_get_buffer_size(id);
710 /* Engineering margin is ten-fold our guess */
711 timeout_ms += 10 * (property_size + worst_write_perf) / worst_write_perf;
712 }
713 return timeout_ms > MINIMUM_LOGCAT_TIMEOUT_MS ? timeout_ms : MINIMUM_LOGCAT_TIMEOUT_MS;
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700714}
715
Felipe Leme2b9b06c2016-10-14 09:13:06 -0700716void Dumpstate::PrintHeader() const {
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700717 std::string build, fingerprint, radio, bootloader, network;
718 char date[80];
Colin Crossf45fa6b2012-03-26 12:38:26 -0700719
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700720 build = android::base::GetProperty("ro.build.display.id", "(unknown)");
721 fingerprint = android::base::GetProperty("ro.build.fingerprint", "(unknown)");
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700722 radio = android::base::GetProperty("gsm.version.baseband", "(unknown)");
723 bootloader = android::base::GetProperty("ro.bootloader", "(unknown)");
724 network = android::base::GetProperty("gsm.operator.alpha", "(unknown)");
Felipe Lemebbaf3c12016-10-11 14:32:25 -0700725 strftime(date, sizeof(date), "%Y-%m-%d %H:%M:%S", localtime(&now_));
Colin Crossf45fa6b2012-03-26 12:38:26 -0700726
Felipe Lemed8b94e52016-12-08 10:21:44 -0800727 printf("========================================================\n");
728 printf("== dumpstate: %s\n", date);
729 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -0700730
Felipe Lemed8b94e52016-12-08 10:21:44 -0800731 printf("\n");
732 printf("Build: %s\n", build.c_str());
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700733 // NOTE: fingerprint entry format is important for other tools.
Felipe Lemed8b94e52016-12-08 10:21:44 -0800734 printf("Build fingerprint: '%s'\n", fingerprint.c_str());
735 printf("Bootloader: %s\n", bootloader.c_str());
736 printf("Radio: %s\n", radio.c_str());
737 printf("Network: %s\n", network.c_str());
Colin Crossf45fa6b2012-03-26 12:38:26 -0700738
Felipe Lemed8b94e52016-12-08 10:21:44 -0800739 printf("Kernel: ");
Felipe Lemef0292972016-11-22 13:57:05 -0800740 DumpFileToFd(STDOUT_FILENO, "", "/proc/version");
Felipe Lemed8b94e52016-12-08 10:21:44 -0800741 printf("Command line: %s\n", strtok(cmdline_buf, "\n"));
Felipe Leme7709f8a2017-12-05 09:30:09 -0800742 printf("Uptime: ");
743 RunCommandToFd(STDOUT_FILENO, "", {"uptime", "-p"},
744 CommandOptions::WithTimeout(1).Always().Build());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800745 printf("Bugreport format version: %s\n", version_.c_str());
746 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 +0100747 PropertiesHelper::IsDryRun(), options_->args.c_str(), options_->extra_options.c_str());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800748 printf("\n");
Felipe Leme78f2c862015-12-21 09:55:22 -0800749}
750
Felipe Leme24b66ee2016-06-16 10:55:26 -0700751// List of file extensions that can cause a zip file attachment to be rejected by some email
752// service providers.
753static const std::set<std::string> PROBLEMATIC_FILE_EXTENSIONS = {
754 ".ade", ".adp", ".bat", ".chm", ".cmd", ".com", ".cpl", ".exe", ".hta", ".ins", ".isp",
755 ".jar", ".jse", ".lib", ".lnk", ".mde", ".msc", ".msp", ".mst", ".pif", ".scr", ".sct",
756 ".shb", ".sys", ".vb", ".vbe", ".vbs", ".vxd", ".wsc", ".wsf", ".wsh"
757};
758
Vishnu Naire97d6122018-01-18 13:58:56 -0800759status_t Dumpstate::AddZipEntryFromFd(const std::string& entry_name, int fd,
760 std::chrono::milliseconds timeout = 0ms) {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700761 if (!IsZipping()) {
762 MYLOGD("Not adding zip entry %s from fd because it's not a zipped bugreport\n",
763 entry_name.c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -0800764 return INVALID_OPERATION;
Felipe Leme111b9d02016-02-03 09:28:24 -0800765 }
Felipe Leme24b66ee2016-06-16 10:55:26 -0700766 std::string valid_name = entry_name;
767
768 // Rename extension if necessary.
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -0700769 size_t idx = entry_name.rfind('.');
Felipe Leme24b66ee2016-06-16 10:55:26 -0700770 if (idx != std::string::npos) {
771 std::string extension = entry_name.substr(idx);
772 std::transform(extension.begin(), extension.end(), extension.begin(), ::tolower);
773 if (PROBLEMATIC_FILE_EXTENSIONS.count(extension) != 0) {
774 valid_name = entry_name + ".renamed";
775 MYLOGI("Renaming entry %s to %s\n", entry_name.c_str(), valid_name.c_str());
776 }
777 }
778
Felipe Leme6fe9db62016-02-12 09:04:16 -0800779 // Logging statement below is useful to time how long each entry takes, but it's too verbose.
780 // MYLOGD("Adding zip entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700781 int32_t err = zip_writer_->StartEntryWithTime(valid_name.c_str(), ZipWriter::kCompress,
782 get_mtime(fd, ds.now_));
Felipe Leme1d486fe2016-10-14 18:06:47 -0700783 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700784 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", valid_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700785 ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800786 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800787 }
Vishnu Naire97d6122018-01-18 13:58:56 -0800788 auto start = std::chrono::steady_clock::now();
789 auto end = start + timeout;
790 struct pollfd pfd = {fd, POLLIN};
Felipe Lemee82a27d2016-01-05 13:35:44 -0800791
Felipe Leme770410d2016-01-26 17:07:14 -0800792 std::vector<uint8_t> buffer(65536);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800793 while (1) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800794 if (timeout.count() > 0) {
795 // lambda to recalculate the timeout.
796 auto time_left_ms = [end]() {
797 auto now = std::chrono::steady_clock::now();
798 auto diff = std::chrono::duration_cast<std::chrono::milliseconds>(end - now);
799 return std::max(diff.count(), 0LL);
800 };
801
802 int rc = TEMP_FAILURE_RETRY(poll(&pfd, 1, time_left_ms()));
803 if (rc < 0) {
804 MYLOGE("Error in poll while adding from fd to zip entry %s:%s", entry_name.c_str(),
805 strerror(errno));
806 return -errno;
807 } else if (rc == 0) {
808 MYLOGE("Timed out adding from fd to zip entry %s:%s Timeout:%lldms",
809 entry_name.c_str(), strerror(errno), timeout.count());
810 return TIMED_OUT;
811 }
812 }
813
Zach Riggle22200402016-08-18 01:01:24 -0400814 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800815 if (bytes_read == 0) {
816 break;
817 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800818 MYLOGE("read(%s): %s\n", entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800819 return -errno;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800820 }
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700821 err = zip_writer_->WriteBytes(buffer.data(), bytes_read);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800822 if (err) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700823 MYLOGE("zip_writer_->WriteBytes(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800824 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800825 }
826 }
827
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700828 err = zip_writer_->FinishEntry();
Felipe Leme1d486fe2016-10-14 18:06:47 -0700829 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700830 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800831 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800832 }
833
Vishnu Naire97d6122018-01-18 13:58:56 -0800834 return OK;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800835}
836
Felipe Leme1d486fe2016-10-14 18:06:47 -0700837bool Dumpstate::AddZipEntry(const std::string& entry_name, const std::string& entry_path) {
838 android::base::unique_fd fd(
839 TEMP_FAILURE_RETRY(open(entry_path.c_str(), O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
Andreas Gampeaff68432016-07-18 18:01:27 -0700840 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800841 MYLOGE("open(%s): %s\n", entry_path.c_str(), strerror(errno));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800842 return false;
843 }
844
Vishnu Naire97d6122018-01-18 13:58:56 -0800845 return (AddZipEntryFromFd(entry_name, fd.get()) == OK);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800846}
847
848/* adds a file to the existing zipped bugreport */
Felipe Leme4c2d6632016-09-28 14:32:00 -0700849static int _add_file_from_fd(const char* title __attribute__((unused)), const char* path, int fd) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800850 return (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + path, fd) == OK) ? 0 : 1;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800851}
852
Felipe Leme1d486fe2016-10-14 18:06:47 -0700853void Dumpstate::AddDir(const std::string& dir, bool recursive) {
854 if (!IsZipping()) {
855 MYLOGD("Not adding dir %s because it's not a zipped bugreport\n", dir.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800856 return;
857 }
Felipe Leme678727a2016-09-21 17:22:11 -0700858 MYLOGD("Adding dir %s (recursive: %d)\n", dir.c_str(), recursive);
Felipe Leme46b85da2016-11-21 17:40:45 -0800859 DurationReporter duration_reporter(dir, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700860 dump_files("", dir.c_str(), recursive ? skip_none : is_dir, _add_file_from_fd);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800861}
862
Felipe Leme1d486fe2016-10-14 18:06:47 -0700863bool Dumpstate::AddTextZipEntry(const std::string& entry_name, const std::string& content) {
864 if (!IsZipping()) {
865 MYLOGD("Not adding text zip entry %s because it's not a zipped bugreport\n",
866 entry_name.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800867 return false;
868 }
Felipe Lemecbce55d2016-02-08 09:53:18 -0800869 MYLOGD("Adding zip text entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700870 int32_t err = zip_writer_->StartEntryWithTime(entry_name.c_str(), ZipWriter::kCompress, ds.now_);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700871 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700872 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700873 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800874 return false;
875 }
876
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700877 err = zip_writer_->WriteBytes(content.c_str(), content.length());
Felipe Leme1d486fe2016-10-14 18:06:47 -0700878 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700879 MYLOGE("zip_writer_->WriteBytes(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700880 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800881 return false;
882 }
883
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700884 err = zip_writer_->FinishEntry();
Felipe Leme1d486fe2016-10-14 18:06:47 -0700885 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700886 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800887 return false;
888 }
889
890 return true;
891}
892
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800893static void DoKmsg() {
894 struct stat st;
895 if (!stat(PSTORE_LAST_KMSG, &st)) {
896 /* Also TODO: Make console-ramoops CAP_SYSLOG protected. */
897 DumpFile("LAST KMSG", PSTORE_LAST_KMSG);
898 } else if (!stat(ALT_PSTORE_LAST_KMSG, &st)) {
899 DumpFile("LAST KMSG", ALT_PSTORE_LAST_KMSG);
900 } else {
901 /* TODO: Make last_kmsg CAP_SYSLOG protected. b/5555691 */
902 DumpFile("LAST KMSG", "/proc/last_kmsg");
903 }
904}
905
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800906static void DoKernelLogcat() {
Yao Chenbe3bbc12018-01-17 16:31:10 -0800907 unsigned long timeout_ms = logcat_timeout({"kernel"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800908 RunCommand(
909 "KERNEL LOG",
910 {"logcat", "-b", "kernel", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
911 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
912}
913
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800914static void DoLogcat() {
Vishnu Nair6921f802017-11-22 09:17:23 -0800915 unsigned long timeout_ms;
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800916 // DumpFile("EVENT LOG TAGS", "/etc/event-log-tags");
917 // calculate timeout
Yao Chenbe3bbc12018-01-17 16:31:10 -0800918 timeout_ms = logcat_timeout({"main", "system", "crash"});
Tony Makae737652017-03-30 17:47:09 +0100919 RunCommand("SYSTEM LOG",
Vishnu Nair6921f802017-11-22 09:17:23 -0800920 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
921 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -0800922 timeout_ms = logcat_timeout({"events"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800923 RunCommand(
924 "EVENT LOG",
925 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
926 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -0800927 timeout_ms = logcat_timeout({"stats"});
928 RunCommand(
929 "STATS LOG",
930 {"logcat", "-b", "stats", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
931 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
932 timeout_ms = logcat_timeout({"radio"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800933 RunCommand(
934 "RADIO LOG",
935 {"logcat", "-b", "radio", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
936 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800937
938 RunCommand("LOG STATISTICS", {"logcat", "-b", "all", "-S"});
939
940 /* kernels must set CONFIG_PSTORE_PMSG, slice up pstore with device tree */
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800941 RunCommand("LAST LOGCAT", {"logcat", "-L", "-b", "all", "-v", "threadtime", "-v", "printable",
942 "-v", "uid", "-d", "*:v"});
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800943}
944
Jayachandran Ca94c7172017-06-10 15:08:12 -0700945static void DumpIpTablesAsRoot() {
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700946 RunCommand("IPTABLES", {"iptables", "-L", "-nvx"});
947 RunCommand("IP6TABLES", {"ip6tables", "-L", "-nvx"});
Erik Kline32af8c22016-09-28 17:26:26 +0900948 RunCommand("IPTABLES NAT", {"iptables", "-t", "nat", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -0700949 /* no ip6 nat */
Erik Kline32af8c22016-09-28 17:26:26 +0900950 RunCommand("IPTABLES MANGLE", {"iptables", "-t", "mangle", "-L", "-nvx"});
951 RunCommand("IP6TABLES MANGLE", {"ip6tables", "-t", "mangle", "-L", "-nvx"});
952 RunCommand("IPTABLES RAW", {"iptables", "-t", "raw", "-L", "-nvx"});
953 RunCommand("IP6TABLES RAW", {"ip6tables", "-t", "raw", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -0700954}
955
Narayan Kamath8f788292017-05-25 13:20:39 +0100956static void AddAnrTraceDir(const bool add_to_zip, const std::string& anr_traces_dir) {
957 MYLOGD("AddAnrTraceDir(): dump_traces_file=%s, anr_traces_dir=%s\n", dump_traces_path,
958 anr_traces_dir.c_str());
959
960 // If we're here, dump_traces_path will always be a temporary file
961 // (created with mkostemp or similar) that contains dumps taken earlier
962 // on in the process.
963 if (dump_traces_path != nullptr) {
964 if (add_to_zip) {
965 ds.AddZipEntry(ZIP_ROOT_DIR + anr_traces_dir + "/traces-just-now.txt", dump_traces_path);
966 } else {
967 MYLOGD("Dumping current ANR traces (%s) to the main bugreport entry\n",
968 dump_traces_path);
969 ds.DumpFile("VM TRACES JUST NOW", dump_traces_path);
970 }
971
972 const int ret = unlink(dump_traces_path);
973 if (ret == -1) {
974 MYLOGW("Error unlinking temporary trace path %s: %s\n", dump_traces_path,
975 strerror(errno));
Felipe Lemee184f662016-10-27 10:04:47 -0700976 }
977 }
978
Narayan Kamathbd863722017-06-01 18:50:12 +0100979 // Add a specific message for the first ANR Dump.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700980 if (ds.anr_data_.size() > 0) {
981 AddDumps(ds.anr_data_.begin(), ds.anr_data_.begin() + 1,
Narayan Kamathbd863722017-06-01 18:50:12 +0100982 "VM TRACES AT LAST ANR", add_to_zip);
983
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100984 // The "last" ANR will always be included as separate entry in the zip file. In addition,
985 // it will be present in the body of the main entry if |add_to_zip| == false.
986 //
987 // Historical ANRs are always included as separate entries in the bugreport zip file.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700988 AddDumps(ds.anr_data_.begin() + ((add_to_zip) ? 1 : 0), ds.anr_data_.end(),
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100989 "HISTORICAL ANR", true /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +0100990 } else {
Narayan Kamath8f788292017-05-25 13:20:39 +0100991 printf("*** NO ANRs to dump in %s\n\n", ANR_DIR.c_str());
992 }
993}
994
995static void AddAnrTraceFiles() {
996 const bool add_to_zip = ds.IsZipping() && ds.version_ == VERSION_SPLIT_ANR;
997
Elliott Hughes69fe5ec2018-03-23 11:04:25 -0700998 std::string anr_traces_dir = "/data/anr";
Narayan Kamath8f788292017-05-25 13:20:39 +0100999
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001000 AddAnrTraceDir(add_to_zip, anr_traces_dir);
Narayan Kamath8f788292017-05-25 13:20:39 +01001001
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001002 // Slow traces for slow operations.
Felipe Lemee184f662016-10-27 10:04:47 -07001003 struct stat st;
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001004 int i = 0;
1005 while (true) {
1006 const std::string slow_trace_path =
1007 anr_traces_dir + android::base::StringPrintf("slow%02d.txt", i);
1008 if (stat(slow_trace_path.c_str(), &st)) {
1009 // No traces file at this index, done with the files.
1010 break;
Felipe Lemee184f662016-10-27 10:04:47 -07001011 }
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001012 ds.DumpFile("VM TRACES WHEN SLOW", slow_trace_path.c_str());
1013 i++;
Felipe Lemee184f662016-10-27 10:04:47 -07001014 }
1015}
1016
Wei Wang509bb5d2017-06-09 14:42:12 -07001017static void DumpBlockStatFiles() {
1018 DurationReporter duration_reporter("DUMP BLOCK STAT");
Wei Wang509bb5d2017-06-09 14:42:12 -07001019
Wei Wang1dc1ef52017-06-12 11:28:37 -07001020 std::unique_ptr<DIR, std::function<int(DIR*)>> dirptr(opendir(BLK_DEV_SYS_DIR), closedir);
1021
1022 if (dirptr == nullptr) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001023 MYLOGE("Failed to open %s: %s\n", BLK_DEV_SYS_DIR, strerror(errno));
1024 return;
1025 }
1026
1027 printf("------ DUMP BLOCK STAT ------\n\n");
Wei Wang1dc1ef52017-06-12 11:28:37 -07001028 while (struct dirent *d = readdir(dirptr.get())) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001029 if ((d->d_name[0] == '.')
1030 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
1031 || (d->d_name[1] == '\0'))) {
1032 continue;
1033 }
1034 const std::string new_path =
1035 android::base::StringPrintf("%s/%s", BLK_DEV_SYS_DIR, d->d_name);
1036 printf("------ BLOCK STAT (%s) ------\n", new_path.c_str());
1037 dump_files("", new_path.c_str(), skip_not_stat, dump_stat_from_fd);
1038 printf("\n");
1039 }
Wei Wang1dc1ef52017-06-12 11:28:37 -07001040 return;
Wei Wang509bb5d2017-06-09 14:42:12 -07001041}
Jayachandran Ca94c7172017-06-10 15:08:12 -07001042
1043static void DumpPacketStats() {
1044 DumpFile("NETWORK DEV INFO", "/proc/net/dev");
1045 DumpFile("QTAGUID NETWORK INTERFACES INFO", "/proc/net/xt_qtaguid/iface_stat_all");
1046 DumpFile("QTAGUID NETWORK INTERFACES INFO (xt)", "/proc/net/xt_qtaguid/iface_stat_fmt");
1047 DumpFile("QTAGUID CTRL INFO", "/proc/net/xt_qtaguid/ctrl");
1048 DumpFile("QTAGUID STATS INFO", "/proc/net/xt_qtaguid/stats");
1049}
1050
1051static void DumpIpAddrAndRules() {
1052 /* The following have a tendency to get wedged when wifi drivers/fw goes belly-up. */
1053 RunCommand("NETWORK INTERFACES", {"ip", "link"});
1054 RunCommand("IPv4 ADDRESSES", {"ip", "-4", "addr", "show"});
1055 RunCommand("IPv6 ADDRESSES", {"ip", "-6", "addr", "show"});
1056 RunCommand("IP RULES", {"ip", "rule", "show"});
1057 RunCommand("IP RULES v6", {"ip", "-6", "rule", "show"});
1058}
1059
Vishnu Nair64afc022018-02-01 15:29:34 -08001060static void RunDumpsysTextByPriority(const std::string& title, int priority,
1061 std::chrono::milliseconds timeout,
1062 std::chrono::milliseconds service_timeout) {
1063 auto start = std::chrono::steady_clock::now();
Vishnu Naire97d6122018-01-18 13:58:56 -08001064 sp<android::IServiceManager> sm = defaultServiceManager();
1065 Dumpsys dumpsys(sm.get());
Vishnu Naire97d6122018-01-18 13:58:56 -08001066 Vector<String16> args;
1067 Dumpsys::setServiceArgs(args, /* asProto = */ false, priority);
Vishnu Naire97d6122018-01-18 13:58:56 -08001068 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ false);
1069 for (const String16& service : services) {
1070 std::string path(title);
1071 path.append(" - ").append(String8(service).c_str());
1072 DumpstateSectionReporter section_reporter(path, ds.listener_, ds.report_section_);
1073 size_t bytes_written = 0;
1074 status_t status = dumpsys.startDumpThread(service, args);
1075 if (status == OK) {
1076 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1077 std::chrono::duration<double> elapsed_seconds;
1078 status = dumpsys.writeDump(STDOUT_FILENO, service, service_timeout,
1079 /* as_proto = */ false, elapsed_seconds, bytes_written);
1080 section_reporter.setSize(bytes_written);
1081 dumpsys.writeDumpFooter(STDOUT_FILENO, service, elapsed_seconds);
1082 bool dump_complete = (status == OK);
1083 dumpsys.stopDumpThread(dump_complete);
1084 }
1085 section_reporter.setStatus(status);
1086
1087 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1088 std::chrono::steady_clock::now() - start);
1089 if (elapsed_duration > timeout) {
1090 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1091 elapsed_duration.count());
1092 break;
1093 }
1094 }
1095}
1096
Vishnu Nair64afc022018-02-01 15:29:34 -08001097static void RunDumpsysText(const std::string& title, int priority,
1098 std::chrono::milliseconds timeout,
1099 std::chrono::milliseconds service_timeout) {
1100 DurationReporter duration_reporter(title);
1101 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1102 fsync(STDOUT_FILENO);
1103 RunDumpsysTextByPriority(title, priority, timeout, service_timeout);
1104}
1105
1106/* Dump all services registered with Normal or Default priority. */
1107static void RunDumpsysTextNormalPriority(const std::string& title,
1108 std::chrono::milliseconds timeout,
1109 std::chrono::milliseconds service_timeout) {
1110 DurationReporter duration_reporter(title);
1111 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1112 fsync(STDOUT_FILENO);
1113 RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_NORMAL, timeout,
1114 service_timeout);
1115 RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_DEFAULT, timeout,
1116 service_timeout);
1117}
1118
1119static void RunDumpsysProto(const std::string& title, int priority,
1120 std::chrono::milliseconds timeout,
1121 std::chrono::milliseconds service_timeout) {
Luis Hector Chavez1e27b082018-03-22 15:36:42 -07001122 if (!ds.IsZipping()) {
1123 MYLOGD("Not dumping %s because it's not a zipped bugreport\n", title.c_str());
1124 return;
1125 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001126 sp<android::IServiceManager> sm = defaultServiceManager();
1127 Dumpsys dumpsys(sm.get());
1128 Vector<String16> args;
1129 Dumpsys::setServiceArgs(args, /* asProto = */ true, priority);
1130 DurationReporter duration_reporter(title);
1131
1132 auto start = std::chrono::steady_clock::now();
1133 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ true);
1134 for (const String16& service : services) {
1135 std::string path(kProtoPath);
1136 path.append(String8(service).c_str());
1137 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL) {
1138 path.append("_CRITICAL");
1139 } else if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH) {
1140 path.append("_HIGH");
1141 }
1142 path.append(kProtoExt);
1143 DumpstateSectionReporter section_reporter(path, ds.listener_, ds.report_section_);
1144 status_t status = dumpsys.startDumpThread(service, args);
1145 if (status == OK) {
1146 status = ds.AddZipEntryFromFd(path, dumpsys.getDumpFd(), service_timeout);
1147 bool dumpTerminated = (status == OK);
1148 dumpsys.stopDumpThread(dumpTerminated);
1149 }
1150 ZipWriter::FileEntry file_entry;
1151 ds.zip_writer_->GetLastEntry(&file_entry);
1152 section_reporter.setSize(file_entry.compressed_size);
1153 section_reporter.setStatus(status);
1154
1155 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1156 std::chrono::steady_clock::now() - start);
1157 if (elapsed_duration > timeout) {
1158 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1159 elapsed_duration.count());
1160 break;
1161 }
1162 }
1163}
1164
Nandana Dutta7db6342018-11-21 14:53:34 +00001165// Runs dumpsys on services that must dump first and will take less than 100ms to dump.
Vishnu Nair780b1282017-10-10 13:57:24 -07001166static void RunDumpsysCritical() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001167 RunDumpsysText("DUMPSYS CRITICAL", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1168 /* timeout= */ 5s, /* service_timeout= */ 500ms);
1169 RunDumpsysProto("DUMPSYS CRITICAL PROTO", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1170 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Vishnu Nair780b1282017-10-10 13:57:24 -07001171}
1172
1173// Runs dumpsys on services that must dump first but can take up to 250ms to dump.
1174static void RunDumpsysHigh() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001175 // TODO meminfo takes ~10s, connectivity takes ~5sec to dump. They are both
1176 // high priority. Reduce timeout once they are able to dump in a shorter time or
1177 // moved to a parallel task.
1178 RunDumpsysText("DUMPSYS HIGH", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1179 /* timeout= */ 90s, /* service_timeout= */ 30s);
1180 RunDumpsysProto("DUMPSYS HIGH PROTO", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1181 /* timeout= */ 5s, /* service_timeout= */ 1s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001182}
1183
1184// Runs dumpsys on services that must dump but can take up to 10s to dump.
1185static void RunDumpsysNormal() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001186 RunDumpsysTextNormalPriority("DUMPSYS", /* timeout= */ 90s, /* service_timeout= */ 10s);
1187 RunDumpsysProto("DUMPSYS PROTO", IServiceManager::DUMP_FLAG_PRIORITY_NORMAL,
1188 /* timeout= */ 90s, /* service_timeout= */ 10s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001189}
1190
Steven Moreland44cd9482018-01-04 16:24:13 -08001191static void DumpHals() {
Steven Moreland44cd9482018-01-04 16:24:13 -08001192 using android::hidl::manager::V1_0::IServiceManager;
1193 using android::hardware::defaultServiceManager;
1194
1195 sp<IServiceManager> sm = defaultServiceManager();
1196 if (sm == nullptr) {
1197 MYLOGE("Could not retrieve hwservicemanager to dump hals.\n");
1198 return;
1199 }
1200
1201 auto ret = sm->list([&](const auto& interfaces) {
1202 for (const std::string& interface : interfaces) {
1203 std::string cleanName = interface;
1204 std::replace_if(cleanName.begin(),
1205 cleanName.end(),
1206 [](char c) {
1207 return !isalnum(c) &&
1208 std::string("@-_:.").find(c) == std::string::npos;
1209 }, '_');
Nandana Dutt979388e2018-11-30 16:48:55 +00001210 const std::string path = ds.bugreport_internal_dir_ + "/lshal_debug_" + cleanName;
Steven Moreland44cd9482018-01-04 16:24:13 -08001211
1212 {
1213 auto fd = android::base::unique_fd(
1214 TEMP_FAILURE_RETRY(open(path.c_str(),
1215 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1216 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1217 if (fd < 0) {
1218 MYLOGE("Could not open %s to dump additional hal information.\n", path.c_str());
1219 continue;
1220 }
1221 RunCommandToFd(fd,
1222 "",
Steven Morelandc81cd3c2018-01-18 14:36:26 -08001223 {"lshal", "debug", "-E", interface},
Steven Moreland44cd9482018-01-04 16:24:13 -08001224 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
1225
1226 bool empty = 0 == lseek(fd, 0, SEEK_END);
1227 if (!empty) {
1228 ds.AddZipEntry("lshal-debug/" + cleanName + ".txt", path);
1229 }
1230 }
1231
1232 unlink(path.c_str());
1233 }
1234 });
1235
1236 if (!ret.isOk()) {
1237 MYLOGE("Could not list hals from hwservicemanager.\n");
1238 }
1239}
1240
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001241static void dumpstate() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001242 DurationReporter duration_reporter("DUMPSTATE");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001243
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -07001244 dump_dev_files("TRUSTY VERSION", "/sys/bus/platform/drivers/trusty", "trusty_version");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001245 RunCommand("UPTIME", {"uptime"});
Wei Wang509bb5d2017-06-09 14:42:12 -07001246 DumpBlockStatFiles();
Mark Salyzyn8c8130e2015-12-09 11:21:28 -08001247 dump_emmc_ecsd("/d/mmc0/mmc0:0001/ext_csd");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001248 DumpFile("MEMORY INFO", "/proc/meminfo");
1249 RunCommand("CPU INFO", {"top", "-b", "-n", "1", "-H", "-s", "6", "-o",
Felipe Leme30dbfa12016-09-02 12:43:26 -07001250 "pid,tid,user,pr,ni,%cpu,s,virt,res,pcy,cmd,name"});
Felipe Lemef0292972016-11-22 13:57:05 -08001251 RunCommand("PROCRANK", {"procrank"}, AS_ROOT_20);
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001252 DumpFile("VIRTUAL MEMORY STATS", "/proc/vmstat");
1253 DumpFile("VMALLOC INFO", "/proc/vmallocinfo");
1254 DumpFile("SLAB INFO", "/proc/slabinfo");
1255 DumpFile("ZONEINFO", "/proc/zoneinfo");
1256 DumpFile("PAGETYPEINFO", "/proc/pagetypeinfo");
1257 DumpFile("BUDDYINFO", "/proc/buddyinfo");
1258 DumpFile("FRAGMENTATION INFO", "/d/extfrag/unusable_index");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001259
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001260 DumpFile("KERNEL WAKE SOURCES", "/d/wakeup_sources");
1261 DumpFile("KERNEL CPUFREQ", "/sys/devices/system/cpu/cpu0/cpufreq/stats/time_in_state");
1262 DumpFile("KERNEL SYNC", "/d/sync");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001263
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001264 RunCommand("PROCESSES AND THREADS",
Yohei Yukawa591a72d2017-10-05 21:36:35 -07001265 {"ps", "-A", "-T", "-Z", "-O", "pri,nice,rtprio,sched,pcy,time"});
Felipe Lemef0292972016-11-22 13:57:05 -08001266 RunCommand("LIBRANK", {"librank"}, CommandOptions::AS_ROOT);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001267
Andreas Huber69ec3ac2017-03-23 09:47:51 -07001268 if (ds.IsZipping()) {
Yifan Hong90e8d8d2018-06-28 13:14:39 -07001269 RunCommand("HARDWARE HALS", {"lshal", "-lVSietrpc", "--types=b,c,l,z"},
1270 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
Steven Moreland44cd9482018-01-04 16:24:13 -08001271 DumpHals();
Andreas Huber69ec3ac2017-03-23 09:47:51 -07001272 } else {
Yifan Hong90e8d8d2018-06-28 13:14:39 -07001273 RunCommand("HARDWARE HALS", {"lshal", "-lVSietrpc", "--types=b,c,l,z", "--debug"},
1274 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build());
Andreas Huber69ec3ac2017-03-23 09:47:51 -07001275 }
Steven Moreland81b429e2017-01-31 19:50:46 -08001276
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001277 RunCommand("PRINTENV", {"printenv"});
Elliott Hughes21b7c8d2016-10-28 08:53:02 -07001278 RunCommand("NETSTAT", {"netstat", "-nW"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001279 struct stat s;
1280 if (stat("/proc/modules", &s) != 0) {
1281 MYLOGD("Skipping 'lsmod' because /proc/modules does not exist\n");
1282 } else {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001283 RunCommand("LSMOD", {"lsmod"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001284 }
Michal Karpinski4db754f2015-12-11 18:04:32 +00001285
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001286 if (__android_logger_property_get_bool(
1287 "ro.logd.kernel", BOOL_DEFAULT_TRUE | BOOL_DEFAULT_FLAG_ENG | BOOL_DEFAULT_FLAG_SVELTE)) {
1288 DoKernelLogcat();
1289 } else {
1290 do_dmesg();
1291 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001292
Felipe Lemef0292972016-11-22 13:57:05 -08001293 RunCommand("LIST OF OPEN FILES", {"lsof"}, CommandOptions::AS_ROOT);
Jeff Brown1dc94e32014-09-11 14:15:27 -07001294 for_each_pid(do_showmap, "SMAPS OF ALL PROCESSES");
1295 for_each_tid(show_wchan, "BLOCKED PROCESS WAIT-CHANNELS");
Mark Salyzyna297c322016-02-05 15:33:17 -08001296 for_each_pid(show_showtime, "PROCESS TIMES (pid cmd user system iowait+percentage)");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001297
Ajay Panicker2ff8e872017-04-27 14:04:32 -07001298 /* Dump Bluetooth HCI logs */
1299 ds.AddDir("/data/misc/bluetooth/logs", true);
Ajay Panickerd886ec42016-09-14 12:26:46 -07001300
Felipe Leme9a523ae2016-10-20 15:10:33 -07001301 if (!ds.do_early_screenshot_) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001302 MYLOGI("taking late screenshot\n");
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001303 ds.TakeScreenshot();
Jeff Sharkey5a930032013-03-19 15:05:19 -07001304 }
1305
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001306 DoLogcat();
Mark Salyzynecc07632015-07-30 14:57:09 -07001307
Felipe Lemee184f662016-10-27 10:04:47 -07001308 AddAnrTraceFiles();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001309
Narayan Kamath8f788292017-05-25 13:20:39 +01001310 // NOTE: tombstones are always added as separate entries in the zip archive
1311 // and are not interspersed with the main report.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001312 const bool tombstones_dumped = AddDumps(ds.tombstone_data_.begin(), ds.tombstone_data_.end(),
Narayan Kamathbd863722017-06-01 18:50:12 +01001313 "TOMBSTONE", true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001314 if (!tombstones_dumped) {
1315 printf("*** NO TOMBSTONES to dump in %s\n\n", TOMBSTONE_DIR.c_str());
Christopher Ferris7dc7f322014-07-22 16:08:19 -07001316 }
1317
Jayachandran Ca94c7172017-06-10 15:08:12 -07001318 DumpPacketStats();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001319
Chenbo Feng276a3b62018-08-07 11:44:49 -07001320 RunDumpsys("EBPF MAP STATS", {"netd", "trafficcontroller"});
1321
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001322 DoKmsg();
Mark Salyzyn2262c162014-12-16 09:09:26 -08001323
Jayachandran Ca94c7172017-06-10 15:08:12 -07001324 DumpIpAddrAndRules();
Sreeram Ramachandran2b3bba32014-07-08 15:40:55 -07001325
1326 dump_route_tables();
1327
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001328 RunCommand("ARP CACHE", {"ip", "-4", "neigh", "show"});
1329 RunCommand("IPv6 ND CACHE", {"ip", "-6", "neigh", "show"});
1330 RunCommand("MULTICAST ADDRESSES", {"ip", "maddr"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001331
Vishnu Nair780b1282017-10-10 13:57:24 -07001332 RunDumpsysHigh();
Lorenzo Colitti6afc38c2015-09-09 22:59:25 +09001333
Elliott Hughes23ccc622017-02-28 10:14:22 -08001334 RunCommand("SYSTEM PROPERTIES", {"getprop"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001335
Jin Qianf334d662017-10-10 14:41:37 -07001336 RunCommand("STORAGED IO INFO", {"storaged", "-u", "-p"});
ynwangf649a6e2016-07-17 21:56:00 -07001337
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001338 RunCommand("FILESYSTEMS & FREE SPACE", {"df"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001339
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001340 RunCommand("LAST RADIO LOG", {"parse_radio_log", "/proc/last_radio_log"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001341
Colin Crossf45fa6b2012-03-26 12:38:26 -07001342 /* Binder state is expensive to look at as it uses a lot of memory. */
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001343 DumpFile("BINDER FAILED TRANSACTION LOG", "/sys/kernel/debug/binder/failed_transaction_log");
1344 DumpFile("BINDER TRANSACTION LOG", "/sys/kernel/debug/binder/transaction_log");
1345 DumpFile("BINDER TRANSACTIONS", "/sys/kernel/debug/binder/transactions");
1346 DumpFile("BINDER STATS", "/sys/kernel/debug/binder/stats");
1347 DumpFile("BINDER STATE", "/sys/kernel/debug/binder/state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001348
Vishnu Nair36b4cdb2017-11-17 10:27:05 -08001349 /* Add window and surface trace files. */
1350 if (!PropertiesHelper::IsUserBuild()) {
1351 ds.AddDir(WMTRACE_DATA_DIR, false);
1352 }
1353
Felipe Leme6f674ae2016-11-18 17:10:33 -08001354 ds.DumpstateBoard();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001355
Steven Moreland7440ddb2016-12-15 16:13:39 -08001356 /* Migrate the ril_dumpstate to a device specific dumpstate? */
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001357 int rilDumpstateTimeout = android::base::GetIntProperty("ril.dumpstate.timeout", 0);
1358 if (rilDumpstateTimeout > 0) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001359 // su does not exist on user builds, so try running without it.
1360 // This way any implementations of vril-dump that do not require
1361 // root can run on user builds.
1362 CommandOptions::CommandOptionsBuilder options =
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001363 CommandOptions::WithTimeout(rilDumpstateTimeout);
Felipe Lemef0292972016-11-22 13:57:05 -08001364 if (!PropertiesHelper::IsUserBuild()) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001365 options.AsRoot();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001366 }
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001367 RunCommand("DUMP VENDOR RIL LOGS", {"vril-dump"}, options.Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -07001368 }
1369
Felipe Lemed8b94e52016-12-08 10:21:44 -08001370 printf("========================================================\n");
1371 printf("== Android Framework Services\n");
1372 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001373
Vishnu Nair780b1282017-10-10 13:57:24 -07001374 RunDumpsysNormal();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001375
Felipe Lemed8b94e52016-12-08 10:21:44 -08001376 printf("========================================================\n");
1377 printf("== Checkins\n");
1378 printf("========================================================\n");
Dianne Hackborn02bea972013-06-26 18:59:09 -07001379
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001380 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
1381 RunDumpsys("CHECKIN MEMINFO", {"meminfo", "--checkin"});
1382 RunDumpsys("CHECKIN NETSTATS", {"netstats", "--checkin"});
1383 RunDumpsys("CHECKIN PROCSTATS", {"procstats", "-c"});
1384 RunDumpsys("CHECKIN USAGESTATS", {"usagestats", "-c"});
1385 RunDumpsys("CHECKIN PACKAGE", {"package", "--checkin"});
Dianne Hackborn02bea972013-06-26 18:59:09 -07001386
Felipe Lemed8b94e52016-12-08 10:21:44 -08001387 printf("========================================================\n");
1388 printf("== Running Application Activities\n");
1389 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001390
Makoto Onuki60780982018-04-16 15:34:00 -07001391 // The following dumpsys internally collects output from running apps, so it can take a long
1392 // time. So let's extend the timeout.
1393
1394 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
1395
1396 RunDumpsys("APP ACTIVITIES", {"activity", "-v", "all"}, DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001397
Felipe Lemed8b94e52016-12-08 10:21:44 -08001398 printf("========================================================\n");
Makoto Onuki60780982018-04-16 15:34:00 -07001399 printf("== Running Application Services (platform)\n");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001400 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001401
Vishnu Nairc6e6ea72018-07-02 14:20:06 -07001402 RunDumpsys("APP SERVICES PLATFORM", {"activity", "service", "all-platform-non-critical"},
Makoto Onuki60780982018-04-16 15:34:00 -07001403 DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001404
Felipe Lemed8b94e52016-12-08 10:21:44 -08001405 printf("========================================================\n");
Makoto Onuki60780982018-04-16 15:34:00 -07001406 printf("== Running Application Services (non-platform)\n");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001407 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001408
Makoto Onuki60780982018-04-16 15:34:00 -07001409 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1410 DUMPSYS_COMPONENTS_OPTIONS);
1411
1412 printf("========================================================\n");
1413 printf("== Running Application Providers (platform)\n");
1414 printf("========================================================\n");
1415
1416 RunDumpsys("APP PROVIDERS PLATFORM", {"activity", "provider", "all-platform"},
1417 DUMPSYS_COMPONENTS_OPTIONS);
1418
1419 printf("========================================================\n");
1420 printf("== Running Application Providers (non-platform)\n");
1421 printf("========================================================\n");
1422
1423 RunDumpsys("APP PROVIDERS NON-PLATFORM", {"activity", "provider", "all-non-platform"},
1424 DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001425
Adrian Roos8b397ab2017-04-04 16:35:44 -07001426 printf("========================================================\n");
1427 printf("== Dropbox crashes\n");
1428 printf("========================================================\n");
1429
1430 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1431 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1432
Felipe Lemed8b94e52016-12-08 10:21:44 -08001433 printf("========================================================\n");
1434 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1435 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1436 printf("========================================================\n");
1437 printf("== dumpstate: done (id %d)\n", ds.id_);
1438 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001439}
1440
Nandana Dutt4be45d12018-09-26 15:04:23 +01001441/* Dumps state for the default case. Returns true if everything went fine. */
1442static bool DumpstateDefault() {
1443 // Dumps systrace right away, otherwise it will be filled with unnecessary events.
1444 // First try to dump anrd trace if the daemon is running. Otherwise, dump
1445 // the raw trace.
1446 if (!dump_anrd_trace()) {
1447 dump_systrace();
1448 }
1449
1450 // Invoking the following dumpsys calls before dump_traces() to try and
1451 // keep the system stats as close to its initial state as possible.
1452 RunDumpsysCritical();
1453
1454 /* collect stack traces from Dalvik and native processes (needs root) */
1455 dump_traces_path = dump_traces();
1456
1457 /* Run some operations that require root. */
1458 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX, !ds.IsZipping());
1459 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX, !ds.IsZipping());
1460
1461 ds.AddDir(RECOVERY_DIR, true);
1462 ds.AddDir(RECOVERY_DATA_DIR, true);
1463 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
1464 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1465 if (!PropertiesHelper::IsUserBuild()) {
1466 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1467 ds.AddDir(PROFILE_DATA_DIR_REF, true);
1468 }
1469 add_mountinfo();
1470 DumpIpTablesAsRoot();
1471
1472 // Capture any IPSec policies in play. No keys are exposed here.
1473 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1474
1475 // Run ss as root so we can see socket marks.
1476 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
1477
1478 // Run iotop as root to show top 100 IO threads
1479 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
1480
1481 if (!DropRootUser()) {
1482 return false;
1483 }
1484
1485 dumpstate();
1486 return true;
1487}
1488
mukesh agrawal253dad42018-01-23 21:59:59 -08001489// This method collects common dumpsys for telephony and wifi
1490static void DumpstateRadioCommon() {
Jayachandran Ca94c7172017-06-10 15:08:12 -07001491 DumpIpTablesAsRoot();
1492
1493 if (!DropRootUser()) {
1494 return;
1495 }
1496
1497 do_dmesg();
1498 DoLogcat();
1499 DumpPacketStats();
1500 DoKmsg();
1501 DumpIpAddrAndRules();
1502 dump_route_tables();
1503
1504 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
1505 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08001506}
1507
1508// This method collects dumpsys for telephony debugging only
1509static void DumpstateTelephonyOnly() {
1510 DurationReporter duration_reporter("DUMPSTATE");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001511 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08001512
1513 DumpstateRadioCommon();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001514
1515 RunCommand("SYSTEM PROPERTIES", {"getprop"});
1516
1517 printf("========================================================\n");
1518 printf("== Android Framework Services\n");
1519 printf("========================================================\n");
1520
Vishnu Nair652cc802017-11-30 15:18:30 -08001521 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1522 SEC_TO_MSEC(10));
1523 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
1524 SEC_TO_MSEC(10));
Amruth Ramachandrand25a9142018-04-02 16:16:09 -07001525 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
1526 SEC_TO_MSEC(10));
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07001527 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
1528 SEC_TO_MSEC(10));
Jayachandran Ca94c7172017-06-10 15:08:12 -07001529
1530 printf("========================================================\n");
1531 printf("== Running Application Services\n");
1532 printf("========================================================\n");
1533
1534 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
1535
1536 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001537 printf("== Running Application Services (non-platform)\n");
1538 printf("========================================================\n");
1539
1540 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1541 DUMPSYS_COMPONENTS_OPTIONS);
1542
1543 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07001544 printf("== Checkins\n");
1545 printf("========================================================\n");
1546
1547 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
1548
1549 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07001550 printf("== dumpstate: done (id %d)\n", ds.id_);
1551 printf("========================================================\n");
1552}
1553
mukesh agrawal253dad42018-01-23 21:59:59 -08001554// This method collects dumpsys for wifi debugging only
1555static void DumpstateWifiOnly() {
1556 DurationReporter duration_reporter("DUMPSTATE");
1557
1558 DumpstateRadioCommon();
1559
1560 printf("========================================================\n");
1561 printf("== Android Framework Services\n");
1562 printf("========================================================\n");
1563
1564 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1565 SEC_TO_MSEC(10));
1566 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
1567 SEC_TO_MSEC(10));
1568
Roger Wang70399032019-01-08 16:10:37 +08001569 if (ds.IsZipping()) {
1570 RunCommand("HARDWARE HALS", {"lshal", "-lVSietrpc", "--types=b,c,l,z"},
1571 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
1572 DumpHals();
1573 } else {
1574 RunCommand("HARDWARE HALS", {"lshal", "-lVSietrpc", "--types=b,c,l,z", "--debug"},
1575 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build());
1576 }
1577
mukesh agrawal253dad42018-01-23 21:59:59 -08001578 printf("========================================================\n");
1579 printf("== dumpstate: done (id %d)\n", ds.id_);
1580 printf("========================================================\n");
1581}
1582
Felipe Leme6f674ae2016-11-18 17:10:33 -08001583void Dumpstate::DumpstateBoard() {
1584 DurationReporter duration_reporter("dumpstate_board()");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001585 printf("========================================================\n");
1586 printf("== Board\n");
1587 printf("========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001588
Felipe Leme6f674ae2016-11-18 17:10:33 -08001589 if (!IsZipping()) {
Steven Moreland7440ddb2016-12-15 16:13:39 -08001590 MYLOGD("Not dumping board info because it's not a zipped bugreport\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001591 return;
1592 }
1593
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001594 std::vector<std::string> paths;
1595 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07001596 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00001597 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
1598 kDumpstateBoardFiles[i].c_str()));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001599 remover.emplace_back(android::base::make_scope_guard(std::bind(
1600 [](std::string path) {
1601 if (remove(path.c_str()) != 0 && errno != ENOENT) {
1602 MYLOGE("Could not remove(%s): %s\n", path.c_str(), strerror(errno));
1603 }
1604 },
1605 paths[i])));
1606 }
Jie Song9fbfad02017-06-20 16:29:42 -07001607
Wei Wang587eac92018-04-05 12:17:20 -07001608 sp<IDumpstateDevice> dumpstate_device(IDumpstateDevice::getService());
1609 if (dumpstate_device == nullptr) {
1610 MYLOGE("No IDumpstateDevice implementation\n");
1611 return;
1612 }
1613
1614 using ScopedNativeHandle =
1615 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
1616 ScopedNativeHandle handle(native_handle_create(static_cast<int>(paths.size()), 0),
1617 [](native_handle_t* handle) {
1618 native_handle_close(handle);
1619 native_handle_delete(handle);
1620 });
1621 if (handle == nullptr) {
1622 MYLOGE("Could not create native_handle\n");
1623 return;
1624 }
1625
1626 for (size_t i = 0; i < paths.size(); i++) {
1627 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
1628
1629 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
1630 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1631 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1632 if (fd < 0) {
1633 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
1634 return;
1635 }
1636 handle.get()->data[i] = fd.release();
1637 }
1638
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001639 // Given that bugreport is required to diagnose failures, it's better to
Wei Wang587eac92018-04-05 12:17:20 -07001640 // set an arbitrary amount of timeout for IDumpstateDevice than to block the
1641 // rest of bugreport. In the timeout case, we will kill dumpstate board HAL
1642 // and grab whatever dumped
1643 std::packaged_task<bool()>
1644 dumpstate_task([paths, dumpstate_device, &handle]() -> bool {
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001645 android::hardware::Return<void> status = dumpstate_device->dumpstateBoard(handle.get());
1646 if (!status.isOk()) {
1647 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
Wei Wang587eac92018-04-05 12:17:20 -07001648 return false;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001649 }
Wei Wang587eac92018-04-05 12:17:20 -07001650 return true;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001651 });
Wei Wang587eac92018-04-05 12:17:20 -07001652
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001653 auto result = dumpstate_task.get_future();
1654 std::thread(std::move(dumpstate_task)).detach();
Wei Wang587eac92018-04-05 12:17:20 -07001655
1656 constexpr size_t timeout_sec = 30;
1657 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
1658 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate vendor HAL\n", timeout_sec);
1659 if (!android::base::SetProperty("ctl.interface_restart",
1660 android::base::StringPrintf("%s/default",
1661 IDumpstateDevice::descriptor))) {
1662 MYLOGE("Couldn't restart dumpstate HAL\n");
1663 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001664 }
Wei Wang587eac92018-04-05 12:17:20 -07001665 // Wait some time for init to kill dumpstate vendor HAL
1666 constexpr size_t killing_timeout_sec = 10;
1667 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
1668 MYLOGE("killing dumpstateBoard timed out after %zus, continue and "
1669 "there might be racing in content\n", killing_timeout_sec);
1670 }
1671
1672 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
1673 for (size_t i = 0; i < paths.size(); i++) {
1674 struct stat s;
1675 if (fstat(handle.get()->data[i], &s) == -1) {
1676 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(),
1677 strerror(errno));
1678 file_sizes[i] = -1;
1679 continue;
1680 }
1681 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001682 }
1683
1684 for (size_t i = 0; i < paths.size(); i++) {
1685 if (file_sizes[i] == -1) {
1686 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07001687 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001688 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07001689 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001690 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07001691 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001692 AddZipEntry(kDumpstateBoardFiles[i], paths[i]);
Jie Song9fbfad02017-06-20 16:29:42 -07001693 }
1694
Felipe Lemed8b94e52016-12-08 10:21:44 -08001695 printf("*** See dumpstate-board.txt entry ***\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001696}
1697
Nandana Dutt5fb117b2018-09-27 09:23:36 +01001698static void ShowUsageAndExit(int exit_code = 1) {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001699 fprintf(stderr,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001700 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-o file] [-d] [-p] "
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001701 "[-z]] [-s] [-S] [-q] [-B] [-P] [-R] [-V version]\n"
1702 " -h: display this help message\n"
1703 " -b: play sound file instead of vibrate, at beginning of job\n"
1704 " -e: play sound file instead of vibrate, at end of job\n"
1705 " -o: write to file (instead of stdout)\n"
1706 " -d: append date to filename (requires -o)\n"
1707 " -p: capture screenshot to filename.png (requires -o)\n"
1708 " -z: generate zipped file (requires -o)\n"
1709 " -s: write output to control socket (for init)\n"
Takuya Ogawa47f644e2017-12-20 18:09:09 +09001710 " -S: write file location to control socket (for init; requires -o and -z)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001711 " -q: disable vibrate\n"
1712 " -B: send broadcast when finished (requires -o)\n"
1713 " -P: send broadcast when started and update system properties on "
1714 "progress (requires -o and -B)\n"
1715 " -R: take bugreport in remote mode (requires -o, -z, -d and -B, "
1716 "shouldn't be used with -P)\n"
Felipe Lemed071c682016-10-20 16:48:00 -07001717 " -v: prints the dumpstate header and exit\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01001718 exit(exit_code);
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001719}
1720
1721static void ExitOnInvalidArgs() {
1722 fprintf(stderr, "invalid combination of args\n");
1723 ShowUsageAndExit();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001724}
1725
Wei Liuf87959e2016-08-26 14:51:42 -07001726static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07001727 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07001728}
1729
Felipe Leme1d486fe2016-10-14 18:06:47 -07001730bool Dumpstate::FinishZipFile() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001731 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07001732 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07001733 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07001734 // Final timestamp
1735 char date[80];
1736 time_t the_real_now_please_stand_up = time(nullptr);
1737 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07001738 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001739 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07001740
Felipe Leme9a523ae2016-10-20 15:10:33 -07001741 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001742 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08001743 return false;
1744 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07001745 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001746 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08001747 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08001748 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08001749
Felipe Leme0f3fb202016-06-10 17:10:53 -07001750 // Add log file (which contains stderr output) to zip...
1751 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07001752 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07001753 MYLOGE("Failed to add dumpstate log to .zip file\n");
1754 return false;
1755 }
Nandana Dutt979388e2018-11-30 16:48:55 +00001756 // TODO: Should truncate the existing file.
1757 // ... and re-open it for further logging.
Felipe Leme9a523ae2016-10-20 15:10:33 -07001758 redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()));
Felipe Leme0f3fb202016-06-10 17:10:53 -07001759 fprintf(stderr, "\n");
1760
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07001761 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07001762 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07001763 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08001764 return false;
1765 }
1766
Felipe Leme1d486fe2016-10-14 18:06:47 -07001767 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
1768 ds.zip_file.reset(nullptr);
1769
Felipe Lemee9d2c542016-11-15 11:48:26 -08001770 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
1771 if (remove(tmp_path_.c_str()) != 0) {
1772 MYLOGE("Failed to remove temporary file (%s): %s\n", tmp_path_.c_str(), strerror(errno));
Felipe Lemec4eee562016-04-21 15:42:55 -07001773 }
1774
Felipe Leme1e9edc62015-12-21 16:02:13 -08001775 return true;
1776}
Felipe Leme6e01fa62015-11-11 19:35:14 -08001777
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -07001778static std::string SHA256_file_hash(const std::string& filepath) {
Andreas Gampe27cd7b22016-07-18 18:24:05 -07001779 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(filepath.c_str(), O_RDONLY | O_NONBLOCK
1780 | O_CLOEXEC | O_NOFOLLOW)));
Andreas Gampeaff68432016-07-18 18:01:27 -07001781 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001782 MYLOGE("open(%s): %s\n", filepath.c_str(), strerror(errno));
Yi Kong19d5c002018-07-20 13:39:55 -07001783 return nullptr;
Michal Karpinski4db754f2015-12-11 18:04:32 +00001784 }
1785
1786 SHA256_CTX ctx;
Elliott Hughesc4dc1412016-04-12 16:28:31 -07001787 SHA256_Init(&ctx);
Michal Karpinski4db754f2015-12-11 18:04:32 +00001788
1789 std::vector<uint8_t> buffer(65536);
1790 while (1) {
1791 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd.get(), buffer.data(), buffer.size()));
1792 if (bytes_read == 0) {
1793 break;
1794 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001795 MYLOGE("read(%s): %s\n", filepath.c_str(), strerror(errno));
Yi Kong19d5c002018-07-20 13:39:55 -07001796 return nullptr;
Michal Karpinski4db754f2015-12-11 18:04:32 +00001797 }
1798
Elliott Hughesc4dc1412016-04-12 16:28:31 -07001799 SHA256_Update(&ctx, buffer.data(), bytes_read);
Michal Karpinski4db754f2015-12-11 18:04:32 +00001800 }
1801
Elliott Hughesc4dc1412016-04-12 16:28:31 -07001802 uint8_t hash[SHA256_DIGEST_LENGTH];
1803 SHA256_Final(hash, &ctx);
1804
1805 char hash_buffer[SHA256_DIGEST_LENGTH * 2 + 1];
1806 for(size_t i = 0; i < SHA256_DIGEST_LENGTH; i++) {
Michal Karpinskicbbdf732016-01-07 20:45:02 +00001807 sprintf(hash_buffer + (i * 2), "%02x", hash[i]);
Michal Karpinski4db754f2015-12-11 18:04:32 +00001808 }
1809 hash_buffer[sizeof(hash_buffer) - 1] = 0;
1810 return std::string(hash_buffer);
1811}
1812
Felipe Lemea4ef1f02017-02-15 17:27:40 -08001813static void SendBroadcast(const std::string& action, const std::vector<std::string>& args) {
1814 // clang-format off
1815 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user", "0",
1816 "--receiver-foreground", "--receiver-include-background", "-a", action};
1817 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08001818
1819 am.insert(am.end(), args.begin(), args.end());
1820
Felipe Leme8d2410e2017-02-08 09:46:08 -08001821 RunCommand("", am,
1822 CommandOptions::WithTimeout(20)
1823 .Log("Sending broadcast: '%s'\n")
1824 .Always()
1825 .DropRoot()
1826 .RedirectStderr()
1827 .Build());
1828}
1829
Felipe Leme35b8cf12017-02-10 15:47:29 -08001830static void Vibrate(int duration_ms) {
1831 // clang-format off
1832 RunCommand("", {"cmd", "vibrator", "vibrate", std::to_string(duration_ms), "dumpstate"},
1833 CommandOptions::WithTimeout(10)
1834 .Log("Vibrate: '%s'\n")
1835 .Always()
1836 .Build());
1837 // clang-format on
1838}
1839
Nandana Dutt979388e2018-11-30 16:48:55 +00001840static void MaybeResolveSymlink(std::string* path) {
1841 std::string resolved_path;
1842 if (android::base::Readlink(*path, &resolved_path)) {
1843 *path = resolved_path;
1844 }
1845}
1846
Nandana Dutt4be45d12018-09-26 15:04:23 +01001847/*
1848 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
1849 * if we are writing zip files and adds the version file.
1850 */
1851static void PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00001852 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
1853
1854 std::string base_name_part1 = "bugreport";
1855 if (!ds.options_->use_outfile.empty()) {
1856 ds.bugreport_dir_ = dirname(ds.options_->use_outfile.c_str());
1857 base_name_part1 = basename(ds.options_->use_outfile.c_str());
1858 }
1859
Nandana Dutt4be45d12018-09-26 15:04:23 +01001860 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
1861 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01001862 ds.base_name_ =
Nandana Dutt979388e2018-11-30 16:48:55 +00001863 StringPrintf("%s-%s-%s", base_name_part1.c_str(), device_name.c_str(), build_id.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01001864 if (ds.options_->do_add_date) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01001865 char date[80];
1866 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
1867 ds.name_ = date;
1868 } else {
1869 ds.name_ = "undated";
1870 }
1871
Nandana Dutt5fb117b2018-09-27 09:23:36 +01001872 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01001873 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01001874 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01001875 ds.base_name_ += "-wifi";
1876 }
1877
Nandana Dutt5fb117b2018-09-27 09:23:36 +01001878 if (ds.options_->do_fb) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01001879 ds.screenshot_path_ = ds.GetPath(".png");
1880 }
1881 ds.tmp_path_ = ds.GetPath(".tmp");
1882 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
1883
Nandana Dutt979388e2018-11-30 16:48:55 +00001884 std::string destination = ds.options_->fd != -1 ? StringPrintf("[fd:%d]", ds.options_->fd)
1885 : ds.bugreport_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01001886 MYLOGD(
1887 "Bugreport dir: %s\n"
Nandana Dutt979388e2018-11-30 16:48:55 +00001888 "Internal Bugreport dir: %s\n"
Nandana Dutt4be45d12018-09-26 15:04:23 +01001889 "Base name: %s\n"
1890 "Suffix: %s\n"
1891 "Log path: %s\n"
1892 "Temporary path: %s\n"
1893 "Screenshot path: %s\n",
Nandana Dutt979388e2018-11-30 16:48:55 +00001894 destination.c_str(), ds.bugreport_internal_dir_.c_str(), ds.base_name_.c_str(),
1895 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 +01001896
Nandana Dutt5fb117b2018-09-27 09:23:36 +01001897 if (ds.options_->do_zip_file) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01001898 ds.path_ = ds.GetPath(".zip");
1899 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
1900 create_parent_dirs(ds.path_.c_str());
1901 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
1902 if (ds.zip_file == nullptr) {
1903 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
1904 } else {
1905 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
1906 }
1907 ds.AddTextZipEntry("version.txt", ds.version_);
1908 }
1909}
1910
1911/*
1912 * Finalizes writing to the file by renaming or zipping the tmp file to the final location,
1913 * printing zipped file status, etc.
1914 */
1915static void FinalizeFile() {
Nandana Dutt4be45d12018-09-26 15:04:23 +01001916 /* check if user changed the suffix using system properties */
1917 std::string name =
1918 android::base::GetProperty(android::base::StringPrintf("dumpstate.%d.name", ds.pid_), "");
1919 bool change_suffix = false;
1920 if (!name.empty()) {
1921 /* must whitelist which characters are allowed, otherwise it could cross directories */
1922 std::regex valid_regex("^[-_a-zA-Z0-9]+$");
1923 if (std::regex_match(name.c_str(), valid_regex)) {
1924 change_suffix = true;
1925 } else {
1926 MYLOGE("invalid suffix provided by user: %s\n", name.c_str());
1927 }
1928 }
1929 if (change_suffix) {
1930 MYLOGI("changing suffix from %s to %s\n", ds.name_.c_str(), name.c_str());
1931 ds.name_ = name;
1932 if (!ds.screenshot_path_.empty()) {
1933 std::string new_screenshot_path = ds.GetPath(".png");
1934 if (rename(ds.screenshot_path_.c_str(), new_screenshot_path.c_str())) {
1935 MYLOGE("rename(%s, %s): %s\n", ds.screenshot_path_.c_str(),
1936 new_screenshot_path.c_str(), strerror(errno));
1937 } else {
1938 ds.screenshot_path_ = new_screenshot_path;
1939 }
1940 }
1941 }
1942
1943 bool do_text_file = true;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01001944 if (ds.options_->do_zip_file) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01001945 if (!ds.FinishZipFile()) {
1946 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
1947 do_text_file = true;
1948 } else {
1949 do_text_file = false;
Nandana Dutt383d0c12018-11-30 15:54:56 +00001950 // If the user has changed the suffix, we need to change the zip file name.
1951 std::string new_path = ds.GetPath(".zip");
1952 if (ds.path_ != new_path) {
1953 MYLOGD("Renaming zip file from %s to %s\n", ds.path_.c_str(), new_path.c_str());
1954 if (rename(ds.path_.c_str(), new_path.c_str())) {
1955 MYLOGE("rename(%s, %s): %s\n", ds.path_.c_str(), new_path.c_str(),
1956 strerror(errno));
1957 } else {
1958 ds.path_ = new_path;
1959 }
1960 }
Nandana Dutt979388e2018-11-30 16:48:55 +00001961 // The zip file lives in an internal directory. Copy it over to output.
1962 bool copy_succeeded = false;
1963 if (ds.options_->fd != -1) {
1964 copy_succeeded = android::os::CopyFileToFd(ds.path_, ds.options_->fd);
1965 } else {
1966 ds.final_path_ = ds.GetPath(ds.bugreport_dir_, ".zip");
1967 copy_succeeded = android::os::CopyFileToFile(ds.path_, ds.final_path_);
1968 }
1969 if (copy_succeeded) {
1970 if (remove(ds.path_.c_str())) {
1971 MYLOGE("remove(%s): %s", ds.path_.c_str(), strerror(errno));
1972 }
1973 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001974 }
1975 }
1976 if (do_text_file) {
1977 ds.path_ = ds.GetPath(".txt");
1978 MYLOGD("Generating .txt bugreport at %s from %s\n", ds.path_.c_str(), ds.tmp_path_.c_str());
1979 if (rename(ds.tmp_path_.c_str(), ds.path_.c_str())) {
1980 MYLOGE("rename(%s, %s): %s\n", ds.tmp_path_.c_str(), ds.path_.c_str(), strerror(errno));
1981 ds.path_.clear();
1982 }
1983 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01001984 if (ds.options_->use_control_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01001985 if (do_text_file) {
1986 dprintf(ds.control_socket_fd_,
1987 "FAIL:could not create zip file, check %s "
1988 "for more details\n",
1989 ds.log_path_.c_str());
1990 } else {
1991 dprintf(ds.control_socket_fd_, "OK:%s\n", ds.path_.c_str());
1992 }
1993 }
1994}
1995
1996/* Broadcasts that we are done with the bugreport */
1997static void SendBugreportFinishedBroadcast() {
Nandana Dutt979388e2018-11-30 16:48:55 +00001998 // TODO(b/111441001): use callback instead of broadcast.
1999 if (!ds.final_path_.empty()) {
2000 MYLOGI("Final bugreport path: %s\n", ds.final_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002001 // clang-format off
2002
2003 std::vector<std::string> am_args = {
2004 "--receiver-permission", "android.permission.DUMP",
2005 "--ei", "android.intent.extra.ID", std::to_string(ds.id_),
2006 "--ei", "android.intent.extra.PID", std::to_string(ds.pid_),
2007 "--ei", "android.intent.extra.MAX", std::to_string(ds.progress_->GetMax()),
Nandana Dutt979388e2018-11-30 16:48:55 +00002008 "--es", "android.intent.extra.BUGREPORT", ds.final_path_,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002009 "--es", "android.intent.extra.DUMPSTATE_LOG", ds.log_path_
2010 };
2011 // clang-format on
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002012 if (ds.options_->do_fb) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002013 am_args.push_back("--es");
2014 am_args.push_back("android.intent.extra.SCREENSHOT");
2015 am_args.push_back(ds.screenshot_path_);
2016 }
Nandana Dutt15b89d72018-11-16 14:14:12 +00002017 if (!ds.options_->notification_title.empty()) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002018 am_args.push_back("--es");
2019 am_args.push_back("android.intent.extra.TITLE");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002020 am_args.push_back(ds.options_->notification_title);
2021 if (!ds.options_->notification_description.empty()) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002022 am_args.push_back("--es");
2023 am_args.push_back("android.intent.extra.DESCRIPTION");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002024 am_args.push_back(ds.options_->notification_description);
Nandana Dutt4be45d12018-09-26 15:04:23 +01002025 }
2026 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002027 if (ds.options_->is_remote_mode) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002028 am_args.push_back("--es");
2029 am_args.push_back("android.intent.extra.REMOTE_BUGREPORT_HASH");
Nandana Dutt979388e2018-11-30 16:48:55 +00002030 am_args.push_back(SHA256_file_hash(ds.final_path_));
Nandana Dutt4be45d12018-09-26 15:04:23 +01002031 SendBroadcast("com.android.internal.intent.action.REMOTE_BUGREPORT_FINISHED", am_args);
2032 } else {
2033 SendBroadcast("com.android.internal.intent.action.BUGREPORT_FINISHED", am_args);
2034 }
2035 } else {
2036 MYLOGE("Skipping finished broadcast because bugreport could not be generated\n");
2037 }
2038}
2039
Nandana Dutt58d72e22018-11-16 10:30:48 +00002040static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2041 switch (mode) {
2042 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2043 return "BUGREPORT_FULL";
2044 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2045 return "BUGREPORT_INTERACTIVE";
2046 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2047 return "BUGREPORT_REMOTE";
2048 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2049 return "BUGREPORT_WEAR";
2050 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2051 return "BUGREPORT_TELEPHONY";
2052 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2053 return "BUGREPORT_WIFI";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002054 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2055 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002056 }
2057}
2058
2059static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options) {
Abhijeet Kaur8ca245e2018-12-12 10:34:21 +00002060 options->extra_options = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002061 switch (mode) {
2062 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2063 options->do_broadcast = true;
2064 options->do_fb = true;
2065 break;
2066 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002067 // Currently, the dumpstate binder is only used by Shell to update progress.
2068 options->do_start_service = true;
2069 options->do_progress_updates = true;
2070 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002071 options->do_broadcast = true;
2072 break;
2073 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002074 options->do_vibrate = false;
2075 options->is_remote_mode = true;
2076 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002077 options->do_broadcast = true;
2078 break;
2079 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002080 options->do_start_service = true;
2081 options->do_progress_updates = true;
2082 options->do_zip_file = 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_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002087 options->telephony_only = true;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002088 options->do_fb = true;
2089 options->do_broadcast = true;
2090 break;
2091 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002092 options->wifi_only = true;
2093 options->do_zip_file = true;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002094 options->do_fb = true;
2095 options->do_broadcast = true;
2096 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002097 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2098 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002099 }
2100}
2101
2102static Dumpstate::BugreportMode getBugreportModeFromProperty() {
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002103 // If the system property is not set, it's assumed to be a default bugreport.
2104 Dumpstate::BugreportMode mode = Dumpstate::BugreportMode::BUGREPORT_DEFAULT;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002105
2106 std::string extra_options = android::base::GetProperty(PROPERTY_EXTRA_OPTIONS, "");
2107 if (!extra_options.empty()) {
2108 // Framework uses a system property to override some command-line args.
2109 // Currently, it contains the type of the requested bugreport.
2110 if (extra_options == "bugreportplus") {
2111 mode = Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002112 } else if (extra_options == "bugreportfull") {
2113 mode = Dumpstate::BugreportMode::BUGREPORT_FULL;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002114 } else if (extra_options == "bugreportremote") {
2115 mode = Dumpstate::BugreportMode::BUGREPORT_REMOTE;
2116 } else if (extra_options == "bugreportwear") {
2117 mode = Dumpstate::BugreportMode::BUGREPORT_WEAR;
2118 } else if (extra_options == "bugreporttelephony") {
2119 mode = Dumpstate::BugreportMode::BUGREPORT_TELEPHONY;
2120 } else if (extra_options == "bugreportwifi") {
2121 mode = Dumpstate::BugreportMode::BUGREPORT_WIFI;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002122 } else {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002123 MYLOGE("Unknown extra option: %s\n", extra_options.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002124 }
2125 // Reset the property
2126 android::base::SetProperty(PROPERTY_EXTRA_OPTIONS, "");
2127 }
Nandana Dutt58d72e22018-11-16 10:30:48 +00002128 return mode;
2129}
2130
2131// TODO: Move away from system properties when we have options passed via binder calls.
2132/* Sets runtime options from the system properties and then clears those properties. */
2133static void SetOptionsFromProperties(Dumpstate::DumpOptions* options) {
2134 Dumpstate::BugreportMode mode = getBugreportModeFromProperty();
2135 SetOptionsFromMode(mode, options);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002136
2137 options->notification_title = android::base::GetProperty(PROPERTY_EXTRA_TITLE, "");
2138 if (!options->notification_title.empty()) {
2139 // Reset the property
2140 android::base::SetProperty(PROPERTY_EXTRA_TITLE, "");
2141
Nandana Duttdd8cca32018-11-14 10:10:29 +00002142 options->notification_description =
2143 android::base::GetProperty(PROPERTY_EXTRA_DESCRIPTION, "");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002144 if (!options->notification_description.empty()) {
2145 // Reset the property
2146 android::base::SetProperty(PROPERTY_EXTRA_DESCRIPTION, "");
2147 }
2148 MYLOGD("notification (title: %s, description: %s)\n", options->notification_title.c_str(),
2149 options->notification_description.c_str());
2150 }
2151}
2152
Nandana Dutt58d72e22018-11-16 10:30:48 +00002153static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
2154 MYLOGI("do_zip_file: %d\n", options.do_zip_file);
2155 MYLOGI("do_add_date: %d\n", options.do_add_date);
2156 MYLOGI("do_vibrate: %d\n", options.do_vibrate);
2157 MYLOGI("use_socket: %d\n", options.use_socket);
2158 MYLOGI("use_control_socket: %d\n", options.use_control_socket);
2159 MYLOGI("do_fb: %d\n", options.do_fb);
2160 MYLOGI("do_broadcast: %d\n", options.do_broadcast);
2161 MYLOGI("is_remote_mode: %d\n", options.is_remote_mode);
2162 MYLOGI("show_header_only: %d\n", options.show_header_only);
2163 MYLOGI("do_start_service: %d\n", options.do_start_service);
2164 MYLOGI("telephony_only: %d\n", options.telephony_only);
2165 MYLOGI("wifi_only: %d\n", options.wifi_only);
2166 MYLOGI("do_progress_updates: %d\n", options.do_progress_updates);
Nandana Dutt979388e2018-11-30 16:48:55 +00002167 MYLOGI("fd: %d\n", options.fd);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002168 MYLOGI("use_outfile: %s\n", options.use_outfile.c_str());
2169 MYLOGI("extra_options: %s\n", options.extra_options.c_str());
2170 MYLOGI("args: %s\n", options.args.c_str());
2171 MYLOGI("notification_title: %s\n", options.notification_title.c_str());
2172 MYLOGI("notification_description: %s\n", options.notification_description.c_str());
2173}
2174
2175void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode) {
2176 // In the new API world, date is always added; output is always a zip file.
2177 // TODO(111441001): remove these options once they are obsolete.
2178 do_add_date = true;
2179 do_zip_file = true;
2180
2181 // STOPSHIP b/111441001: Remove hardcoded output file path; accept fd.
2182 use_outfile = "/data/user_de/0/com.android.shell/files/bugreports/bugreport";
2183
2184 extra_options = ModeToString(bugreport_mode);
2185 SetOptionsFromMode(bugreport_mode, this);
2186}
2187
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002188Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
2189 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002190 int c;
2191 while ((c = getopt(argc, argv, "dho:svqzpPBRSV:")) != -1) {
2192 switch (c) {
2193 // clang-format off
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002194 case 'd': do_add_date = true; break;
2195 case 'z': do_zip_file = true; break;
2196 case 'o': use_outfile = optarg; break;
2197 case 's': use_socket = true; break;
2198 case 'S': use_control_socket = true; break;
2199 case 'v': show_header_only = true; break;
2200 case 'q': do_vibrate = false; break;
2201 case 'p': do_fb = true; break;
2202 case 'P': do_progress_updates = true; break;
2203 case 'R': is_remote_mode = true; break;
2204 case 'B': do_broadcast = true; break;
2205 case 'V': break; // compatibility no-op
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002206 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002207 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002208 break;
2209 default:
2210 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002211 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002212 break;
2213 // clang-format on
2214 }
2215 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08002216
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002217 // TODO: use helper function to convert argv into a string
2218 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002219 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002220 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002221 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002222 }
2223 }
2224
2225 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
2226 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002227
2228 SetOptionsFromProperties(this);
2229 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002230}
2231
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002232bool Dumpstate::DumpOptions::ValidateOptions() const {
Nandana Dutt979388e2018-11-30 16:48:55 +00002233 if (fd != -1 && !do_zip_file) {
2234 return false;
2235 }
2236
2237 bool has_out_file_options = !use_outfile.empty() || fd != -1;
2238 if ((do_zip_file || do_add_date || do_progress_updates || do_broadcast) &&
2239 !has_out_file_options) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002240 return false;
2241 }
2242
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002243 if (use_control_socket && !do_zip_file) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002244 return false;
2245 }
2246
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002247 if (do_progress_updates && !do_broadcast) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002248 return false;
2249 }
2250
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002251 if (is_remote_mode && (do_progress_updates || !do_broadcast || !do_zip_file || !do_add_date)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002252 return false;
2253 }
2254 return true;
2255}
2256
Nandana Dutt197661d2018-11-16 16:40:21 +00002257void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
2258 options_ = std::move(options);
2259}
2260
Nandana Dutt979388e2018-11-30 16:48:55 +00002261/*
2262 * Dumps relevant information to a bugreport based on the given options.
2263 *
2264 * The bugreport can be dumped to a file or streamed to a socket.
2265 *
2266 * How dumping to file works:
2267 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
2268 * stderr is redirected a log file.
2269 *
2270 * The temporary bugreport is then populated via printfs, dumping contents of files and
2271 * output of commands to stdout.
2272 *
2273 * If zipping, the temporary bugreport file is added to the zip archive. Else it's renamed to final
2274 * text file.
2275 *
2276 * If zipping, a bunch of other files and dumps also get added to the zip archive. The log file also
2277 * gets added to the archive.
2278 *
2279 * Bugreports are first generated in a local directory and later copied to the caller's fd or
2280 * directory.
2281 */
Nandana Dutt197661d2018-11-16 16:40:21 +00002282Dumpstate::RunStatus Dumpstate::Run() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002283 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00002284 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002285 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002286 return RunStatus::INVALID_INPUT;
2287 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002288 /* set as high priority, and protect from OOM killer */
2289 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002290
Felipe Lemed071c682016-10-20 16:48:00 -07002291 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002292 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002293 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002294 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002295 } else {
2296 /* fallback to kernels <= 2.6.35 */
2297 oom_adj = fopen("/proc/self/oom_adj", "we");
2298 if (oom_adj) {
2299 fputs("-17", oom_adj);
2300 fclose(oom_adj);
2301 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002302 }
2303
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002304 if (version_ == VERSION_DEFAULT) {
2305 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00002306 }
2307
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002308 if (version_ != VERSION_CURRENT && version_ != VERSION_SPLIT_ANR) {
Vishnu Nair64afc022018-02-01 15:29:34 -08002309 MYLOGE("invalid version requested ('%s'); suppported values are: ('%s', '%s', '%s')\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002310 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str(),
Vishnu Nair64afc022018-02-01 15:29:34 -08002311 VERSION_SPLIT_ANR.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002312 return RunStatus::INVALID_INPUT;
Felipe Lemed071c682016-10-20 16:48:00 -07002313 }
2314
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002315 if (options_->show_header_only) {
2316 PrintHeader();
2317 return RunStatus::OK;
Felipe Lemed071c682016-10-20 16:48:00 -07002318 }
2319
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002320 // Redirect output if needed
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002321 bool is_redirecting = !options_->use_socket && !options_->use_outfile.empty();
Felipe Leme7447d7c2016-11-03 18:12:22 -07002322
2323 // TODO: temporarily set progress until it's part of the Dumpstate constructor
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002324 std::string stats_path =
Nandana Dutt979388e2018-11-30 16:48:55 +00002325 is_redirecting
2326 ? android::base::StringPrintf("%s/dumpstate-stats.txt", bugreport_internal_dir_.c_str())
2327 : "";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002328 progress_.reset(new Progress(stats_path));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002329
Felipe Lemed071c682016-10-20 16:48:00 -07002330 /* gets the sequential id */
Felipe Leme7447d7c2016-11-03 18:12:22 -07002331 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002332 id_ = ++last_id;
Felipe Lemed071c682016-10-20 16:48:00 -07002333 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
2334
2335 MYLOGI("begin\n");
2336
Felipe Leme6ae5c4f2017-01-10 14:13:22 -08002337 register_sig_handler();
Felipe Lemed071c682016-10-20 16:48:00 -07002338
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002339 if (options_->do_start_service) {
Felipe Leme75876a22016-10-27 16:31:27 -07002340 MYLOGI("Starting 'dumpstate' service\n");
2341 android::status_t ret;
2342 if ((ret = android::os::DumpstateService::Start()) != android::OK) {
2343 MYLOGE("Unable to start DumpstateService: %d\n", ret);
2344 }
2345 }
2346
Felipe Lemef0292972016-11-22 13:57:05 -08002347 if (PropertiesHelper::IsDryRun()) {
Felipe Lemed071c682016-10-20 16:48:00 -07002348 MYLOGI("Running on dry-run mode (to disable it, call 'setprop dumpstate.dry_run false')\n");
2349 }
2350
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002351 MYLOGI("dumpstate info: id=%d, args='%s', extra_options= %s)\n", id_, options_->args.c_str(),
2352 options_->extra_options.c_str());
Felipe Lemed071c682016-10-20 16:48:00 -07002353
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002354 MYLOGI("bugreport format version: %s\n", version_.c_str());
Felipe Leme809d74e2016-02-02 12:57:00 -08002355
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002356 do_early_screenshot_ = options_->do_progress_updates;
Felipe Lemee338bf62015-12-07 14:03:50 -08002357
Christopher Ferrised9354f2014-10-01 17:35:01 -07002358 // If we are going to use a socket, do it as early as possible
2359 // to avoid timeouts from bugreport.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002360 if (options_->use_socket) {
Christopher Ferrised9354f2014-10-01 17:35:01 -07002361 redirect_to_socket(stdout, "dumpstate");
2362 }
2363
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002364 if (options_->use_control_socket) {
Felipe Leme2628e9e2016-04-12 16:36:51 -07002365 MYLOGD("Opening control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002366 control_socket_fd_ = open_socket("dumpstate");
2367 options_->do_progress_updates = 1;
Felipe Leme2628e9e2016-04-12 16:36:51 -07002368 }
2369
Felipe Leme71bbfc52015-11-23 14:14:51 -08002370 if (is_redirecting) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002371 PrepareToWriteToFile();
Felipe Leme1e9edc62015-12-21 16:02:13 -08002372
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002373 if (options_->do_progress_updates) {
2374 if (options_->do_broadcast) {
Felipe Lemedcd1f0d2016-08-04 12:48:50 -07002375 // clang-format off
2376 std::vector<std::string> am_args = {
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002377 "--receiver-permission", "android.permission.DUMP",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002378 "--es", "android.intent.extra.NAME", name_,
2379 "--ei", "android.intent.extra.ID", std::to_string(id_),
2380 "--ei", "android.intent.extra.PID", std::to_string(pid_),
2381 "--ei", "android.intent.extra.MAX", std::to_string(progress_->GetMax()),
Felipe Lemedcd1f0d2016-08-04 12:48:50 -07002382 };
2383 // clang-format on
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002384 SendBroadcast("com.android.internal.intent.action.BUGREPORT_STARTED", am_args);
Felipe Lemedcd1f0d2016-08-04 12:48:50 -07002385 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002386 if (options_->use_control_socket) {
2387 dprintf(control_socket_fd_, "BEGIN:%s\n", path_.c_str());
Felipe Lemeaabfcae2016-07-29 09:49:04 -07002388 }
Felipe Leme71bbfc52015-11-23 14:14:51 -08002389 }
2390 }
2391
Nick Kralevichf3599b32016-01-25 15:05:16 -08002392 /* read /proc/cmdline before dropping root */
2393 FILE *cmdline = fopen("/proc/cmdline", "re");
2394 if (cmdline) {
2395 fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
2396 fclose(cmdline);
2397 }
2398
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002399 if (options_->do_vibrate) {
Felipe Leme35b8cf12017-02-10 15:47:29 -08002400 Vibrate(150);
John Michelau1f794c42012-09-17 11:20:19 -05002401 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002402
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002403 if (options_->do_fb && do_early_screenshot_) {
2404 if (screenshot_path_.empty()) {
Felipe Leme3634a1e2015-12-09 10:11:47 -08002405 // should not have happened
Felipe Lemecbce55d2016-02-08 09:53:18 -08002406 MYLOGE("INTERNAL ERROR: skipping early screenshot because path was not set\n");
Felipe Leme3634a1e2015-12-09 10:11:47 -08002407 } else {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002408 MYLOGI("taking early screenshot\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002409 TakeScreenshot();
Felipe Lemee338bf62015-12-07 14:03:50 -08002410 }
2411 }
2412
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002413 if (options_->do_zip_file && zip_file != nullptr) {
2414 if (chown(path_.c_str(), AID_SHELL, AID_SHELL)) {
2415 MYLOGE("Unable to change ownership of zip file %s: %s\n", path_.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -07002416 strerror(errno));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002417 }
2418 }
2419
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002420 int dup_stdout_fd;
2421 int dup_stderr_fd;
Felipe Leme71bbfc52015-11-23 14:14:51 -08002422 if (is_redirecting) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002423 // Redirect stderr to log_path_ for debugging.
Vishnu Nair20cf5032018-01-05 13:15:49 -08002424 TEMP_FAILURE_RETRY(dup_stderr_fd = dup(fileno(stderr)));
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002425 redirect_to_file(stderr, const_cast<char*>(log_path_.c_str()));
2426 if (chown(log_path_.c_str(), AID_SHELL, AID_SHELL)) {
2427 MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n", log_path_.c_str(),
2428 strerror(errno));
Felipe Leme6fe9db62016-02-12 09:04:16 -08002429 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002430
2431 // Redirect stdout to tmp_path_. This is the main bugreport entry and will be
2432 // moved into zip file later, if zipping.
Vishnu Nair20cf5032018-01-05 13:15:49 -08002433 TEMP_FAILURE_RETRY(dup_stdout_fd = dup(fileno(stdout)));
Nandana Dutt979388e2018-11-30 16:48:55 +00002434 // TODO: why not write to a file instead of stdout to overcome this problem?
Felipe Leme6e01fa62015-11-11 19:35:14 -08002435 /* TODO: rather than generating a text file now and zipping it later,
2436 it would be more efficient to redirect stdout to the zip entry
2437 directly, but the libziparchive doesn't support that option yet. */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002438 redirect_to_file(stdout, const_cast<char*>(tmp_path_.c_str()));
2439 if (chown(tmp_path_.c_str(), AID_SHELL, AID_SHELL)) {
Felipe Leme6fe9db62016-02-12 09:04:16 -08002440 MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002441 tmp_path_.c_str(), strerror(errno));
Felipe Leme6fe9db62016-02-12 09:04:16 -08002442 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002443 }
Felipe Lemed8b94e52016-12-08 10:21:44 -08002444
2445 // Don't buffer stdout
2446 setvbuf(stdout, nullptr, _IONBF, 0);
2447
Felipe Leme608385d2016-02-01 10:35:38 -08002448 // NOTE: there should be no stdout output until now, otherwise it would break the header.
2449 // In particular, DurationReport objects should be created passing 'title, NULL', so their
Felipe Lemecbce55d2016-02-08 09:53:18 -08002450 // duration is logged into MYLOG instead.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002451 PrintHeader();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002452
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002453 if (options_->telephony_only) {
Jayachandran Ca94c7172017-06-10 15:08:12 -07002454 DumpstateTelephonyOnly();
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002455 DumpstateBoard();
2456 } else if (options_->wifi_only) {
mukesh agrawal253dad42018-01-23 21:59:59 -08002457 DumpstateWifiOnly();
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002458 } else {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002459 // Dump state for the default case. This also drops root.
2460 if (!DumpstateDefault()) {
2461 // Something went wrong.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002462 return RunStatus::ERROR;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002463 }
Zhengyin Qian068ecc72016-08-10 16:48:14 -07002464 }
Felipe Leme71a74ac2016-03-17 15:43:25 -07002465
Felipe Leme55b42a62015-11-10 17:39:08 -08002466 /* close output if needed */
Felipe Leme71bbfc52015-11-23 14:14:51 -08002467 if (is_redirecting) {
Vishnu Nair20cf5032018-01-05 13:15:49 -08002468 TEMP_FAILURE_RETRY(dup2(dup_stdout_fd, fileno(stdout)));
Colin Crossf45fa6b2012-03-26 12:38:26 -07002469 }
2470
Felipe Leme6e01fa62015-11-11 19:35:14 -08002471 /* rename or zip the (now complete) .tmp file to its final location */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002472 if (!options_->use_outfile.empty()) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002473 FinalizeFile();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002474 }
2475
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002476 /* vibrate a few but shortly times to let user know it's finished */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002477 if (options_->do_vibrate) {
Takuya Ogawa47f644e2017-12-20 18:09:09 +09002478 for (int i = 0; i < 3; i++) {
2479 Vibrate(75);
2480 usleep((75 + 50) * 1000);
2481 }
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002482 }
2483
Jeff Brown1dc94e32014-09-11 14:15:27 -07002484 /* tell activity manager we're done */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002485 if (options_->do_broadcast) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002486 SendBugreportFinishedBroadcast();
Jeff Sharkey27f9e6d2013-03-13 15:45:50 -07002487 }
2488
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002489 MYLOGD("Final progress: %d/%d (estimated %d)\n", progress_->Get(), progress_->GetMax(),
2490 progress_->GetInitialMax());
2491 progress_->Save();
2492 MYLOGI("done (id %d)\n", id_);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002493
Felipe Leme107a05f2016-03-08 15:11:15 -08002494 if (is_redirecting) {
Vishnu Nair20cf5032018-01-05 13:15:49 -08002495 TEMP_FAILURE_RETRY(dup2(dup_stderr_fd, fileno(stderr)));
Felipe Leme107a05f2016-03-08 15:11:15 -08002496 }
2497
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002498 if (options_->use_control_socket && control_socket_fd_ != -1) {
Felipe Lemee844a9d2016-09-21 15:01:39 -07002499 MYLOGD("Closing control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002500 close(control_socket_fd_);
Felipe Leme2628e9e2016-04-12 16:36:51 -07002501 }
2502
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002503 tombstone_data_.clear();
2504 anr_data_.clear();
Narayan Kamath6b9516c2017-10-27 11:15:51 +01002505
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002506 return RunStatus::OK;
2507}
2508
Nandana Dutt979388e2018-11-30 16:48:55 +00002509/* Main entry point for dumpstate binary. */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002510int run_main(int argc, char* argv[]) {
2511 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
2512 Dumpstate::RunStatus status = options->Initialize(argc, argv);
2513 if (status == Dumpstate::RunStatus::OK) {
Nandana Dutt197661d2018-11-16 16:40:21 +00002514 ds.SetOptions(std::move(options));
2515 status = ds.Run();
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002516 }
2517
2518 switch (status) {
2519 case Dumpstate::RunStatus::OK:
2520 return 0;
Nandana Dutt979388e2018-11-30 16:48:55 +00002521 // TODO(b/111441001): Exit directly in the following cases.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002522 case Dumpstate::RunStatus::HELP:
2523 ShowUsageAndExit(0 /* exit code */);
2524 break;
2525 case Dumpstate::RunStatus::INVALID_INPUT:
2526 ExitOnInvalidArgs();
2527 break;
2528 case Dumpstate::RunStatus::ERROR:
2529 exit(-1);
2530 break;
2531 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002532 return 0;
2533}