blob: 0b9dadaa326d692ef8aca27b2752b564ebb300bd [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>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010024#include <math.h>
25#include <poll.h>
Mark Salyzyn8f37aa52015-06-12 12:28:24 -070026#include <stdbool.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070027#include <stdio.h>
28#include <stdlib.h>
29#include <string.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080030#include <sys/poll.h>
Christopher Ferris7dc7f322014-07-22 16:08:19 -070031#include <sys/prctl.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070032#include <sys/resource.h>
33#include <sys/stat.h>
34#include <sys/time.h>
35#include <sys/wait.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010036#include <signal.h>
37#include <stdarg.h>
38#include <string.h>
39#include <sys/capability.h>
40#include <sys/inotify.h>
41#include <sys/klog.h>
42#include <time.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070043#include <unistd.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070044
45#include <chrono>
Hridya Valsarajuac582cd2019-08-05 15:39:54 -070046#include <cmath>
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +000047#include <fstream>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070048#include <functional>
49#include <future>
Narayan Kamath8f788292017-05-25 13:20:39 +010050#include <memory>
Hridya Valsarajuac582cd2019-08-05 15:39:54 -070051#include <numeric>
Narayan Kamath8f788292017-05-25 13:20:39 +010052#include <regex>
53#include <set>
54#include <string>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070055#include <utility>
Narayan Kamath8f788292017-05-25 13:20:39 +010056#include <vector>
Colin Crossf45fa6b2012-03-26 12:38:26 -070057
Felipe Leme96c2bbb2016-09-26 09:21:21 -070058#include <android-base/file.h>
59#include <android-base/properties.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070060#include <android-base/scopeguard.h>
Elliott Hughes9dc117c2015-12-07 14:21:50 -080061#include <android-base/stringprintf.h>
Naveen Kalla058e1e82016-10-19 21:38:44 -070062#include <android-base/strings.h>
Andreas Gampeaff68432016-07-18 18:01:27 -070063#include <android-base/unique_fd.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080064#include <android/hardware/dumpstate/1.0/IDumpstateDevice.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080065#include <android/hidl/manager/1.0/IServiceManager.h>
Nandana Duttd2f5f082019-01-18 17:13:52 +000066#include <android/os/IIncidentCompanion.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080067#include <cutils/native_handle.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070068#include <cutils/properties.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010069#include <cutils/sockets.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000070#include <debuggerd/client.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080071#include <dumpsys.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000072#include <dumputils/dump_utils.h>
Sahana Raof35ed432019-07-12 10:47:52 +010073#include <hardware_legacy/power.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080074#include <hidl/ServiceManagement.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010075#include <log/log.h>
Felipe Leme75876a22016-10-27 16:31:27 -070076#include <openssl/sha.h>
Mark Salyzyn6c3d90f2016-09-27 14:55:27 -070077#include <private/android_filesystem_config.h>
78#include <private/android_logger.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080079#include <serviceutils/PriorityDumper.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070080#include <utils/StrongPointer.h>
Felipe Lemef0292972016-11-22 13:57:05 -080081#include "DumpstateInternal.h"
Felipe Leme75876a22016-10-27 16:31:27 -070082#include "DumpstateService.h"
Colin Crossf45fa6b2012-03-26 12:38:26 -070083#include "dumpstate.h"
Felipe Leme6e01fa62015-11-11 19:35:14 -080084
Steven Morelandcb7ef822016-11-29 13:20:37 -080085using ::android::hardware::dumpstate::V1_0::IDumpstateDevice;
Vishnu Naire97d6122018-01-18 13:58:56 -080086using ::std::literals::chrono_literals::operator""ms;
87using ::std::literals::chrono_literals::operator""s;
Steven Morelandcb7ef822016-11-29 13:20:37 -080088
Felipe Leme47e9be22016-12-21 15:37:07 -080089// TODO: remove once moved to namespace
Vishnu Naire97d6122018-01-18 13:58:56 -080090using android::defaultServiceManager;
91using android::Dumpsys;
92using android::INVALID_OPERATION;
93using android::IServiceManager;
94using android::OK;
95using android::sp;
96using android::status_t;
97using android::String16;
98using android::String8;
99using android::TIMED_OUT;
100using android::UNKNOWN_ERROR;
101using android::Vector;
Nandana Dutt979388e2018-11-30 16:48:55 +0000102using android::base::StringPrintf;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000103using android::os::IDumpstateListener;
Felipe Leme47e9be22016-12-21 15:37:07 -0800104using android::os::dumpstate::CommandOptions;
105using android::os::dumpstate::DumpFileToFd;
Vishnu Naire97d6122018-01-18 13:58:56 -0800106using android::os::dumpstate::PropertiesHelper;
Felipe Leme47e9be22016-12-21 15:37:07 -0800107
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100108// Keep in sync with
109// frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
110static const int TRACE_DUMP_TIMEOUT_MS = 10000; // 10 seconds
111
112/* Most simple commands have 10 as timeout, so 5 is a good estimate */
113static const int32_t WEIGHT_FILE = 5;
114
115// TODO: temporary variables and functions used during C++ refactoring
116static Dumpstate& ds = Dumpstate::GetInstance();
117static int RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Nandana Dutt8d945c02019-08-14 13:30:07 +0100118 const CommandOptions& options = CommandOptions::DEFAULT,
119 bool verbose_duration = false) {
120 return ds.RunCommand(title, full_command, options, verbose_duration);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100121}
122
123// Reasonable value for max stats.
124static const int STATS_MAX_N_RUNS = 1000;
125static const long STATS_MAX_AVERAGE = 100000;
126
127CommandOptions Dumpstate::DEFAULT_DUMPSYS = CommandOptions::WithTimeout(30).Build();
128
Nandana Duttd2f5f082019-01-18 17:13:52 +0000129typedef Dumpstate::ConsentCallback::ConsentResult UserConsentResult;
130
Colin Crossf45fa6b2012-03-26 12:38:26 -0700131/* read before root is shed */
132static char cmdline_buf[16384] = "(unknown)";
Yi Kong19d5c002018-07-20 13:39:55 -0700133static const char *dump_traces_path = nullptr;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000134static const uint64_t USER_CONSENT_TIMEOUT_MS = 30 * 1000;
Colin Crossf45fa6b2012-03-26 12:38:26 -0700135
Felipe Leme1d486fe2016-10-14 18:06:47 -0700136// TODO: variables and functions below should be part of dumpstate object
137
Felipe Leme635ca312016-01-05 14:23:02 -0800138static std::set<std::string> mount_points;
139void add_mountinfo();
Felipe Leme78f2c862015-12-21 09:55:22 -0800140
Todd Poynor2a83daa2013-11-22 15:44:22 -0800141#define PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops"
Mark Salyzyn7d0a7622016-06-24 14:06:15 -0700142#define ALT_PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops-0"
Wei Wang509bb5d2017-06-09 14:42:12 -0700143#define BLK_DEV_SYS_DIR "/sys/block"
Todd Poynor2a83daa2013-11-22 15:44:22 -0800144
Felipe Lemee82a27d2016-01-05 13:35:44 -0800145#define RECOVERY_DIR "/cache/recovery"
Mark Salyzynd6ab0112016-03-25 12:56:39 -0700146#define RECOVERY_DATA_DIR "/data/misc/recovery"
Tianjie Xu75d53362018-04-11 16:42:28 -0700147#define UPDATE_ENGINE_LOG_DIR "/data/misc/update_engine_log"
Mark Salyzyn4d42dea2016-04-01 10:03:14 -0700148#define LOGPERSIST_DATA_DIR "/data/misc/logd"
David Brazdild2991962016-06-03 14:40:44 +0100149#define PROFILE_DATA_DIR_CUR "/data/misc/profiles/cur"
150#define PROFILE_DATA_DIR_REF "/data/misc/profiles/ref"
Benedict Wong8f9d8a42019-01-03 16:19:38 -0800151#define XFRM_STAT_PROC_FILE "/proc/net/xfrm_stat"
Erik Kline08165202016-05-30 11:55:44 +0900152#define WLUTIL "/vendor/xbin/wlutil"
Vishnu Nair36b4cdb2017-11-17 10:27:05 -0800153#define WMTRACE_DATA_DIR "/data/misc/wmtrace"
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700154
Narayan Kamath8f788292017-05-25 13:20:39 +0100155// TODO(narayan): Since this information has to be kept in sync
156// with tombstoned, we should just put it in a common header.
157//
158// File: system/core/debuggerd/tombstoned/tombstoned.cpp
Narayan Kamathbd863722017-06-01 18:50:12 +0100159static const std::string TOMBSTONE_DIR = "/data/tombstones/";
160static const std::string TOMBSTONE_FILE_PREFIX = "tombstone_";
161static const std::string ANR_DIR = "/data/anr/";
162static const std::string ANR_FILE_PREFIX = "anr_";
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700163
Felipe Lemee844a9d2016-09-21 15:01:39 -0700164// TODO: temporary variables and functions used during C++ refactoring
Nandana Dutt979388e2018-11-30 16:48:55 +0000165
Nandana Duttbbdb5b42019-03-12 10:52:56 +0000166#define RETURN_IF_USER_DENIED_CONSENT() \
167 if (ds.IsUserConsentDenied()) { \
168 MYLOGE("Returning early as user denied consent to share bugreport with calling app."); \
169 return Dumpstate::RunStatus::USER_CONSENT_DENIED; \
170 }
171
172// Runs func_ptr, but checks user consent before and after running it. Returns USER_CONSENT_DENIED
173// if consent is found to be denied.
174#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(func_ptr, ...) \
175 RETURN_IF_USER_DENIED_CONSENT(); \
176 func_ptr(__VA_ARGS__); \
177 RETURN_IF_USER_DENIED_CONSENT();
178
Sahana Raof35ed432019-07-12 10:47:52 +0100179static const char* WAKE_LOCK_NAME = "dumpstate_wakelock";
180
Nandana Dutt979388e2018-11-30 16:48:55 +0000181namespace android {
182namespace os {
183namespace {
184
185static int Open(std::string path, int flags, mode_t mode = 0) {
186 int fd = TEMP_FAILURE_RETRY(open(path.c_str(), flags, mode));
187 if (fd == -1) {
188 MYLOGE("open(%s, %s)\n", path.c_str(), strerror(errno));
189 }
190 return fd;
191}
192
Nandana Dutt979388e2018-11-30 16:48:55 +0000193
194static int OpenForRead(std::string path) {
195 return Open(path, O_RDONLY | O_CLOEXEC | O_NOFOLLOW);
196}
197
198bool CopyFile(int in_fd, int out_fd) {
199 char buf[4096];
200 ssize_t byte_count;
201 while ((byte_count = TEMP_FAILURE_RETRY(read(in_fd, buf, sizeof(buf)))) > 0) {
202 if (!android::base::WriteFully(out_fd, buf, byte_count)) {
203 return false;
204 }
205 }
206 return (byte_count != -1);
207}
208
209static bool CopyFileToFd(const std::string& input_file, int out_fd) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000210 MYLOGD("Going to copy file (%s) to %d\n", input_file.c_str(), out_fd);
Nandana Dutt979388e2018-11-30 16:48:55 +0000211
212 // Obtain a handle to the source file.
213 android::base::unique_fd in_fd(OpenForRead(input_file));
214 if (out_fd != -1 && in_fd.get() != -1) {
215 if (CopyFile(in_fd.get(), out_fd)) {
216 return true;
217 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000218 MYLOGE("Failed to copy file: %s\n", strerror(errno));
Nandana Dutt979388e2018-11-30 16:48:55 +0000219 }
220 return false;
221}
222
Nandana Duttd2f5f082019-01-18 17:13:52 +0000223static bool UnlinkAndLogOnError(const std::string& file) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000224 if (unlink(file.c_str())) {
225 MYLOGE("Failed to unlink file (%s): %s\n", file.c_str(), strerror(errno));
Nandana Duttd2f5f082019-01-18 17:13:52 +0000226 return false;
227 }
228 return true;
229}
Nandana Dutt979388e2018-11-30 16:48:55 +0000230
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +0000231static bool IsFileEmpty(const std::string& file_path) {
232 std::ifstream file(file_path, std::ios::binary | std::ios::ate);
233 if(file.bad()) {
234 MYLOGE("Cannot open file: %s\n", file_path.c_str());
235 return true;
236 }
237 return file.tellg() <= 0;
238}
239
Nandana Dutt979388e2018-11-30 16:48:55 +0000240} // namespace
241} // namespace os
242} // namespace android
243
Felipe Leme678727a2016-09-21 17:22:11 -0700244static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
Felipe Lemebda15a02016-11-16 17:48:25 -0800245 const CommandOptions& options = Dumpstate::DEFAULT_DUMPSYS,
Vishnu Nair6921f802017-11-22 09:17:23 -0800246 long dumpsysTimeoutMs = 0) {
247 return ds.RunDumpsys(title, dumpsysArgs, options, dumpsysTimeoutMs);
Felipe Leme678727a2016-09-21 17:22:11 -0700248}
249static int DumpFile(const std::string& title, const std::string& path) {
250 return ds.DumpFile(title, path);
251}
Felipe Lemee82a27d2016-01-05 13:35:44 -0800252
Felipe Lemee844a9d2016-09-21 15:01:39 -0700253// Relative directory (inside the zip) for all files copied as-is into the bugreport.
254static const std::string ZIP_ROOT_DIR = "FS";
255
Vishnu Naire97d6122018-01-18 13:58:56 -0800256static const std::string kProtoPath = "proto/";
257static const std::string kProtoExt = ".proto";
Jie Song9fbfad02017-06-20 16:29:42 -0700258static const std::string kDumpstateBoardFiles[] = {
259 "dumpstate_board.txt",
Felipe Leme95d6ca52017-08-01 16:35:56 -0700260 "dumpstate_board.bin"
Jie Song9fbfad02017-06-20 16:29:42 -0700261};
262static const int NUM_OF_DUMPS = arraysize(kDumpstateBoardFiles);
263
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700264static constexpr char PROPERTY_EXTRA_OPTIONS[] = "dumpstate.options";
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700265static constexpr char PROPERTY_LAST_ID[] = "dumpstate.last_id";
Felipe Lemed071c682016-10-20 16:48:00 -0700266static constexpr char PROPERTY_VERSION[] = "dumpstate.version";
Naveen Kallab53a1c92017-03-16 18:17:25 -0700267static constexpr char PROPERTY_EXTRA_TITLE[] = "dumpstate.options.title";
268static constexpr char PROPERTY_EXTRA_DESCRIPTION[] = "dumpstate.options.description";
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700269
Felipe Lemef0292972016-11-22 13:57:05 -0800270static const CommandOptions AS_ROOT_20 = CommandOptions::WithTimeout(20).AsRoot().Build();
271
Narayan Kamath8f788292017-05-25 13:20:39 +0100272/*
Narayan Kamathbd863722017-06-01 18:50:12 +0100273 * Returns a vector of dump fds under |dir_path| with a given |file_prefix|.
274 * The returned vector is sorted by the mtimes of the dumps. If |limit_by_mtime|
275 * is set, the vector only contains files that were written in the last 30 minutes.
Andreas Gamped0d76952017-08-22 13:08:37 -0700276 * If |limit_by_count| is set, the vector only contains the ten latest files.
Narayan Kamath8f788292017-05-25 13:20:39 +0100277 */
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700278static std::vector<DumpData> GetDumpFds(const std::string& dir_path,
279 const std::string& file_prefix,
280 bool limit_by_mtime,
281 bool limit_by_count = true) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100282 const time_t thirty_minutes_ago = ds.now_ - 60 * 30;
283
Narayan Kamathbd863722017-06-01 18:50:12 +0100284 std::unique_ptr<DIR, decltype(&closedir)> dump_dir(opendir(dir_path.c_str()), closedir);
Narayan Kamath8f788292017-05-25 13:20:39 +0100285
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700286 if (dump_dir == nullptr) {
287 MYLOGW("Unable to open directory %s: %s\n", dir_path.c_str(), strerror(errno));
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700288 return std::vector<DumpData>();
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700289 }
290
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700291 std::vector<DumpData> dump_data;
Narayan Kamathbd863722017-06-01 18:50:12 +0100292 struct dirent* entry = nullptr;
293 while ((entry = readdir(dump_dir.get()))) {
294 if (entry->d_type != DT_REG) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100295 continue;
296 }
297
Narayan Kamathbd863722017-06-01 18:50:12 +0100298 const std::string base_name(entry->d_name);
299 if (base_name.find(file_prefix) != 0) {
300 continue;
301 }
302
303 const std::string abs_path = dir_path + base_name;
304 android::base::unique_fd fd(
305 TEMP_FAILURE_RETRY(open(abs_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW | O_NONBLOCK)));
306 if (fd == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700307 MYLOGW("Unable to open dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamathbd863722017-06-01 18:50:12 +0100308 break;
309 }
310
311 struct stat st = {};
312 if (fstat(fd, &st) == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700313 MYLOGW("Unable to stat dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamath8f788292017-05-25 13:20:39 +0100314 continue;
315 }
316
Narayan Kamath3f31b632018-02-22 19:42:36 +0000317 if (limit_by_mtime && st.st_mtime < thirty_minutes_ago) {
Narayan Kamathbd863722017-06-01 18:50:12 +0100318 MYLOGI("Excluding stale dump file: %s\n", abs_path.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100319 continue;
320 }
321
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700322 dump_data.emplace_back(DumpData{abs_path, std::move(fd), st.st_mtime});
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700323 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100324
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700325 // Sort in descending modification time so that we only keep the newest
326 // reports if |limit_by_count| is true.
327 std::sort(dump_data.begin(), dump_data.end(),
328 [](const DumpData& d1, const DumpData& d2) { return d1.mtime > d2.mtime; });
Narayan Kamath8f788292017-05-25 13:20:39 +0100329
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700330 if (limit_by_count && dump_data.size() > 10) {
331 dump_data.erase(dump_data.begin() + 10, dump_data.end());
Andreas Gamped0d76952017-08-22 13:08:37 -0700332 }
333
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700334 return dump_data;
Narayan Kamath8f788292017-05-25 13:20:39 +0100335}
336
Narayan Kamathbd863722017-06-01 18:50:12 +0100337static bool AddDumps(const std::vector<DumpData>::const_iterator start,
338 const std::vector<DumpData>::const_iterator end,
339 const char* type_name, const bool add_to_zip) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100340 bool dumped = false;
Narayan Kamathbd863722017-06-01 18:50:12 +0100341 for (auto it = start; it != end; ++it) {
342 const std::string& name = it->name;
343 const int fd = it->fd;
Narayan Kamath8f788292017-05-25 13:20:39 +0100344 dumped = true;
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100345
346 // Seek to the beginning of the file before dumping any data. A given
347 // DumpData entry might be dumped multiple times in the report.
348 //
349 // For example, the most recent ANR entry is dumped to the body of the
350 // main entry and it also shows up as a separate entry in the bugreport
351 // ZIP file.
352 if (lseek(fd, 0, SEEK_SET) != static_cast<off_t>(0)) {
353 MYLOGE("Unable to add %s to zip file, lseek failed: %s\n", name.c_str(),
354 strerror(errno));
355 }
356
Narayan Kamath8f788292017-05-25 13:20:39 +0100357 if (ds.IsZipping() && add_to_zip) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800358 if (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + name, fd, /* timeout = */ 0ms) != OK) {
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100359 MYLOGE("Unable to add %s to zip file, addZipEntryFromFd failed\n", name.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100360 }
361 } else {
362 dump_file_from_fd(type_name, name.c_str(), fd);
363 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100364 }
365
366 return dumped;
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700367}
368
Felipe Leme635ca312016-01-05 14:23:02 -0800369// for_each_pid() callback to get mount info about a process.
Felipe Leme4c2d6632016-09-28 14:32:00 -0700370void do_mountinfo(int pid, const char* name __attribute__((unused))) {
Felipe Leme635ca312016-01-05 14:23:02 -0800371 char path[PATH_MAX];
372
373 // Gets the the content of the /proc/PID/ns/mnt link, so only unique mount points
374 // are added.
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700375 snprintf(path, sizeof(path), "/proc/%d/ns/mnt", pid);
Felipe Leme635ca312016-01-05 14:23:02 -0800376 char linkname[PATH_MAX];
377 ssize_t r = readlink(path, linkname, PATH_MAX);
378 if (r == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800379 MYLOGE("Unable to read link for %s: %s\n", path, strerror(errno));
Felipe Leme635ca312016-01-05 14:23:02 -0800380 return;
381 }
382 linkname[r] = '\0';
383
384 if (mount_points.find(linkname) == mount_points.end()) {
385 // First time this mount point was found: add it
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700386 snprintf(path, sizeof(path), "/proc/%d/mountinfo", pid);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700387 if (ds.AddZipEntry(ZIP_ROOT_DIR + path, path)) {
Felipe Leme635ca312016-01-05 14:23:02 -0800388 mount_points.insert(linkname);
389 } else {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800390 MYLOGE("Unable to add mountinfo %s to zip file\n", path);
Felipe Leme635ca312016-01-05 14:23:02 -0800391 }
392 }
393}
394
395void add_mountinfo() {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700396 if (!ds.IsZipping()) return;
Felipe Leme678727a2016-09-21 17:22:11 -0700397 std::string title = "MOUNT INFO";
Felipe Leme635ca312016-01-05 14:23:02 -0800398 mount_points.clear();
Felipe Leme46b85da2016-11-21 17:40:45 -0800399 DurationReporter duration_reporter(title, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700400 for_each_pid(do_mountinfo, nullptr);
401 MYLOGD("%s: %d entries added to zip file\n", title.c_str(), (int)mount_points.size());
Felipe Leme635ca312016-01-05 14:23:02 -0800402}
403
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700404static void dump_dev_files(const char *title, const char *driverpath, const char *filename)
405{
406 DIR *d;
407 struct dirent *de;
408 char path[PATH_MAX];
409
410 d = opendir(driverpath);
Yi Kong19d5c002018-07-20 13:39:55 -0700411 if (d == nullptr) {
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700412 return;
413 }
414
415 while ((de = readdir(d))) {
416 if (de->d_type != DT_LNK) {
417 continue;
418 }
419 snprintf(path, sizeof(path), "%s/%s/%s", driverpath, de->d_name, filename);
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700420 DumpFile(title, path);
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700421 }
422
423 closedir(d);
424}
425
Mark Salyzyn326842f2015-04-30 09:49:41 -0700426static bool skip_not_stat(const char *path) {
427 static const char stat[] = "/stat";
428 size_t len = strlen(path);
429 if (path[len - 1] == '/') { /* Directory? */
430 return false;
431 }
432 return strcmp(path + len - sizeof(stat) + 1, stat); /* .../stat? */
433}
434
Felipe Leme4c2d6632016-09-28 14:32:00 -0700435static bool skip_none(const char* path __attribute__((unused))) {
Felipe Lemee82a27d2016-01-05 13:35:44 -0800436 return false;
437}
438
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700439unsigned long worst_write_perf = 20000; /* in KB/s */
Mark Salyzyn326842f2015-04-30 09:49:41 -0700440
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800441//
442// stat offsets
443// Name units description
444// ---- ----- -----------
445// read I/Os requests number of read I/Os processed
446#define __STAT_READ_IOS 0
447// read merges requests number of read I/Os merged with in-queue I/O
448#define __STAT_READ_MERGES 1
449// read sectors sectors number of sectors read
450#define __STAT_READ_SECTORS 2
451// read ticks milliseconds total wait time for read requests
452#define __STAT_READ_TICKS 3
453// write I/Os requests number of write I/Os processed
454#define __STAT_WRITE_IOS 4
455// write merges requests number of write I/Os merged with in-queue I/O
456#define __STAT_WRITE_MERGES 5
457// write sectors sectors number of sectors written
458#define __STAT_WRITE_SECTORS 6
459// write ticks milliseconds total wait time for write requests
460#define __STAT_WRITE_TICKS 7
461// in_flight requests number of I/Os currently in flight
462#define __STAT_IN_FLIGHT 8
463// io_ticks milliseconds total time this block device has been active
464#define __STAT_IO_TICKS 9
465// time_in_queue milliseconds total wait time for all requests
466#define __STAT_IN_QUEUE 10
467#define __STAT_NUMBER_FIELD 11
468//
469// read I/Os, write I/Os
470// =====================
471//
472// These values increment when an I/O request completes.
473//
474// read merges, write merges
475// =========================
476//
477// These values increment when an I/O request is merged with an
478// already-queued I/O request.
479//
480// read sectors, write sectors
481// ===========================
482//
483// These values count the number of sectors read from or written to this
484// block device. The "sectors" in question are the standard UNIX 512-byte
485// sectors, not any device- or filesystem-specific block size. The
486// counters are incremented when the I/O completes.
487#define SECTOR_SIZE 512
488//
489// read ticks, write ticks
490// =======================
491//
492// These values count the number of milliseconds that I/O requests have
493// waited on this block device. If there are multiple I/O requests waiting,
494// these values will increase at a rate greater than 1000/second; for
495// example, if 60 read requests wait for an average of 30 ms, the read_ticks
496// field will increase by 60*30 = 1800.
497//
498// in_flight
499// =========
500//
501// This value counts the number of I/O requests that have been issued to
502// the device driver but have not yet completed. It does not include I/O
503// requests that are in the queue but not yet issued to the device driver.
504//
505// io_ticks
506// ========
507//
508// This value counts the number of milliseconds during which the device has
509// had I/O requests queued.
510//
511// time_in_queue
512// =============
513//
514// This value counts the number of milliseconds that I/O requests have waited
515// on this block device. If there are multiple I/O requests waiting, this
516// value will increase as the product of the number of milliseconds times the
517// number of requests waiting (see "read ticks" above for an example).
518#define S_TO_MS 1000
519//
520
Mark Salyzyn326842f2015-04-30 09:49:41 -0700521static int dump_stat_from_fd(const char *title __unused, const char *path, int fd) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800522 unsigned long long fields[__STAT_NUMBER_FIELD];
Mark Salyzyn326842f2015-04-30 09:49:41 -0700523 bool z;
Yi Kong19d5c002018-07-20 13:39:55 -0700524 char *cp, *buffer = nullptr;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700525 size_t i = 0;
Josh Gao7c4258c2018-06-25 13:40:08 -0700526 FILE *fp = fdopen(dup(fd), "rb");
Mark Salyzyn326842f2015-04-30 09:49:41 -0700527 getline(&buffer, &i, fp);
528 fclose(fp);
529 if (!buffer) {
530 return -errno;
531 }
532 i = strlen(buffer);
533 while ((i > 0) && (buffer[i - 1] == '\n')) {
534 buffer[--i] = '\0';
535 }
536 if (!*buffer) {
537 free(buffer);
538 return 0;
539 }
540 z = true;
541 for (cp = buffer, i = 0; i < (sizeof(fields) / sizeof(fields[0])); ++i) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800542 fields[i] = strtoull(cp, &cp, 10);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700543 if (fields[i] != 0) {
544 z = false;
545 }
546 }
547 if (z) { /* never accessed */
548 free(buffer);
549 return 0;
550 }
551
Wei Wang509bb5d2017-06-09 14:42:12 -0700552 if (!strncmp(path, BLK_DEV_SYS_DIR, sizeof(BLK_DEV_SYS_DIR) - 1)) {
553 path += sizeof(BLK_DEV_SYS_DIR) - 1;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700554 }
Wei Wang1dc1ef52017-06-12 11:28:37 -0700555
556 printf("%-30s:%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s\n%-30s:\t%s\n", "Block-Dev",
557 "R-IOs", "R-merg", "R-sect", "R-wait", "W-IOs", "W-merg", "W-sect",
558 "W-wait", "in-fli", "activ", "T-wait", path, buffer);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700559 free(buffer);
560
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800561 if (fields[__STAT_IO_TICKS]) {
562 unsigned long read_perf = 0;
563 unsigned long read_ios = 0;
564 if (fields[__STAT_READ_TICKS]) {
565 unsigned long long divisor = fields[__STAT_READ_TICKS]
566 * fields[__STAT_IO_TICKS];
567 read_perf = ((unsigned long long)SECTOR_SIZE
568 * fields[__STAT_READ_SECTORS]
569 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
570 / divisor;
571 read_ios = ((unsigned long long)S_TO_MS * fields[__STAT_READ_IOS]
572 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
573 / divisor;
574 }
575
576 unsigned long write_perf = 0;
577 unsigned long write_ios = 0;
578 if (fields[__STAT_WRITE_TICKS]) {
579 unsigned long long divisor = fields[__STAT_WRITE_TICKS]
580 * fields[__STAT_IO_TICKS];
581 write_perf = ((unsigned long long)SECTOR_SIZE
582 * fields[__STAT_WRITE_SECTORS]
583 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
584 / divisor;
585 write_ios = ((unsigned long long)S_TO_MS * fields[__STAT_WRITE_IOS]
586 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
587 / divisor;
588 }
589
590 unsigned queue = (fields[__STAT_IN_QUEUE]
591 + (fields[__STAT_IO_TICKS] >> 1))
592 / fields[__STAT_IO_TICKS];
593
594 if (!write_perf && !write_ios) {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700595 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 -0800596 } else {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700597 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 -0800598 read_ios, write_perf, write_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800599 }
600
601 /* bugreport timeout factor adjustment */
602 if ((write_perf > 1) && (write_perf < worst_write_perf)) {
603 worst_write_perf = write_perf;
604 }
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700605 }
Mark Salyzyn326842f2015-04-30 09:49:41 -0700606 return 0;
607}
608
Yao Chenbe3bbc12018-01-17 16:31:10 -0800609static const long MINIMUM_LOGCAT_TIMEOUT_MS = 50000;
610
611/* timeout in ms to read a list of buffers */
612static unsigned long logcat_timeout(const std::vector<std::string>& buffers) {
613 unsigned long timeout_ms = 0;
614 for (const auto& buffer : buffers) {
615 log_id_t id = android_name_to_log_id(buffer.c_str());
616 unsigned long property_size = __android_logger_get_buffer_size(id);
617 /* Engineering margin is ten-fold our guess */
618 timeout_ms += 10 * (property_size + worst_write_perf) / worst_write_perf;
619 }
620 return timeout_ms > MINIMUM_LOGCAT_TIMEOUT_MS ? timeout_ms : MINIMUM_LOGCAT_TIMEOUT_MS;
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700621}
622
Nandana Duttd2f5f082019-01-18 17:13:52 +0000623Dumpstate::ConsentCallback::ConsentCallback() : result_(UNAVAILABLE), start_time_(Nanotime()) {
624}
625
626android::binder::Status Dumpstate::ConsentCallback::onReportApproved() {
627 std::lock_guard<std::mutex> lock(lock_);
628 result_ = APPROVED;
629 MYLOGD("User approved consent to share bugreport\n");
630 return android::binder::Status::ok();
631}
632
633android::binder::Status Dumpstate::ConsentCallback::onReportDenied() {
634 std::lock_guard<std::mutex> lock(lock_);
635 result_ = DENIED;
636 MYLOGW("User denied consent to share bugreport\n");
637 return android::binder::Status::ok();
638}
639
640UserConsentResult Dumpstate::ConsentCallback::getResult() {
641 std::lock_guard<std::mutex> lock(lock_);
642 return result_;
643}
644
645uint64_t Dumpstate::ConsentCallback::getElapsedTimeMs() const {
646 return Nanotime() - start_time_;
647}
648
Felipe Leme2b9b06c2016-10-14 09:13:06 -0700649void Dumpstate::PrintHeader() const {
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700650 std::string build, fingerprint, radio, bootloader, network;
651 char date[80];
Colin Crossf45fa6b2012-03-26 12:38:26 -0700652
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700653 build = android::base::GetProperty("ro.build.display.id", "(unknown)");
654 fingerprint = android::base::GetProperty("ro.build.fingerprint", "(unknown)");
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700655 radio = android::base::GetProperty("gsm.version.baseband", "(unknown)");
656 bootloader = android::base::GetProperty("ro.bootloader", "(unknown)");
657 network = android::base::GetProperty("gsm.operator.alpha", "(unknown)");
Felipe Lemebbaf3c12016-10-11 14:32:25 -0700658 strftime(date, sizeof(date), "%Y-%m-%d %H:%M:%S", localtime(&now_));
Colin Crossf45fa6b2012-03-26 12:38:26 -0700659
Felipe Lemed8b94e52016-12-08 10:21:44 -0800660 printf("========================================================\n");
661 printf("== dumpstate: %s\n", date);
662 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -0700663
Felipe Lemed8b94e52016-12-08 10:21:44 -0800664 printf("\n");
665 printf("Build: %s\n", build.c_str());
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700666 // NOTE: fingerprint entry format is important for other tools.
Felipe Lemed8b94e52016-12-08 10:21:44 -0800667 printf("Build fingerprint: '%s'\n", fingerprint.c_str());
668 printf("Bootloader: %s\n", bootloader.c_str());
669 printf("Radio: %s\n", radio.c_str());
670 printf("Network: %s\n", network.c_str());
Colin Crossf45fa6b2012-03-26 12:38:26 -0700671
Felipe Lemed8b94e52016-12-08 10:21:44 -0800672 printf("Kernel: ");
Felipe Lemef0292972016-11-22 13:57:05 -0800673 DumpFileToFd(STDOUT_FILENO, "", "/proc/version");
Felipe Lemed8b94e52016-12-08 10:21:44 -0800674 printf("Command line: %s\n", strtok(cmdline_buf, "\n"));
Felipe Leme7709f8a2017-12-05 09:30:09 -0800675 printf("Uptime: ");
676 RunCommandToFd(STDOUT_FILENO, "", {"uptime", "-p"},
677 CommandOptions::WithTimeout(1).Always().Build());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800678 printf("Bugreport format version: %s\n", version_.c_str());
679 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 +0100680 PropertiesHelper::IsDryRun(), options_->args.c_str(), options_->extra_options.c_str());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800681 printf("\n");
Felipe Leme78f2c862015-12-21 09:55:22 -0800682}
683
Felipe Leme24b66ee2016-06-16 10:55:26 -0700684// List of file extensions that can cause a zip file attachment to be rejected by some email
685// service providers.
686static const std::set<std::string> PROBLEMATIC_FILE_EXTENSIONS = {
687 ".ade", ".adp", ".bat", ".chm", ".cmd", ".com", ".cpl", ".exe", ".hta", ".ins", ".isp",
688 ".jar", ".jse", ".lib", ".lnk", ".mde", ".msc", ".msp", ".mst", ".pif", ".scr", ".sct",
689 ".shb", ".sys", ".vb", ".vbe", ".vbs", ".vxd", ".wsc", ".wsf", ".wsh"
690};
691
Vishnu Naire97d6122018-01-18 13:58:56 -0800692status_t Dumpstate::AddZipEntryFromFd(const std::string& entry_name, int fd,
693 std::chrono::milliseconds timeout = 0ms) {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700694 if (!IsZipping()) {
695 MYLOGD("Not adding zip entry %s from fd because it's not a zipped bugreport\n",
696 entry_name.c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -0800697 return INVALID_OPERATION;
Felipe Leme111b9d02016-02-03 09:28:24 -0800698 }
Felipe Leme24b66ee2016-06-16 10:55:26 -0700699 std::string valid_name = entry_name;
700
701 // Rename extension if necessary.
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -0700702 size_t idx = entry_name.rfind('.');
Felipe Leme24b66ee2016-06-16 10:55:26 -0700703 if (idx != std::string::npos) {
704 std::string extension = entry_name.substr(idx);
705 std::transform(extension.begin(), extension.end(), extension.begin(), ::tolower);
706 if (PROBLEMATIC_FILE_EXTENSIONS.count(extension) != 0) {
707 valid_name = entry_name + ".renamed";
708 MYLOGI("Renaming entry %s to %s\n", entry_name.c_str(), valid_name.c_str());
709 }
710 }
711
Felipe Leme6fe9db62016-02-12 09:04:16 -0800712 // Logging statement below is useful to time how long each entry takes, but it's too verbose.
713 // MYLOGD("Adding zip entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700714 int32_t err = zip_writer_->StartEntryWithTime(valid_name.c_str(), ZipWriter::kCompress,
715 get_mtime(fd, ds.now_));
Felipe Leme1d486fe2016-10-14 18:06:47 -0700716 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700717 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", valid_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700718 ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800719 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800720 }
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000721 bool finished_entry = false;
722 auto finish_entry = [this, &finished_entry] {
723 if (!finished_entry) {
724 // This should only be called when we're going to return an earlier error,
725 // which would've been logged. This may imply the file is already corrupt
726 // and any further logging from FinishEntry is more likely to mislead than
727 // not.
728 this->zip_writer_->FinishEntry();
729 }
730 };
731 auto scope_guard = android::base::make_scope_guard(finish_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -0800732 auto start = std::chrono::steady_clock::now();
733 auto end = start + timeout;
734 struct pollfd pfd = {fd, POLLIN};
Felipe Lemee82a27d2016-01-05 13:35:44 -0800735
Felipe Leme770410d2016-01-26 17:07:14 -0800736 std::vector<uint8_t> buffer(65536);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800737 while (1) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800738 if (timeout.count() > 0) {
739 // lambda to recalculate the timeout.
740 auto time_left_ms = [end]() {
741 auto now = std::chrono::steady_clock::now();
742 auto diff = std::chrono::duration_cast<std::chrono::milliseconds>(end - now);
743 return std::max(diff.count(), 0LL);
744 };
745
746 int rc = TEMP_FAILURE_RETRY(poll(&pfd, 1, time_left_ms()));
747 if (rc < 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000748 MYLOGE("Error in poll while adding from fd to zip entry %s:%s\n",
749 entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800750 return -errno;
751 } else if (rc == 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000752 MYLOGE("Timed out adding from fd to zip entry %s:%s Timeout:%lldms\n",
Vishnu Naire97d6122018-01-18 13:58:56 -0800753 entry_name.c_str(), strerror(errno), timeout.count());
754 return TIMED_OUT;
755 }
756 }
757
Zach Riggle22200402016-08-18 01:01:24 -0400758 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800759 if (bytes_read == 0) {
760 break;
761 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800762 MYLOGE("read(%s): %s\n", entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800763 return -errno;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800764 }
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700765 err = zip_writer_->WriteBytes(buffer.data(), bytes_read);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800766 if (err) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700767 MYLOGE("zip_writer_->WriteBytes(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800768 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800769 }
770 }
771
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700772 err = zip_writer_->FinishEntry();
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000773 finished_entry = true;
Felipe Leme1d486fe2016-10-14 18:06:47 -0700774 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700775 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800776 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800777 }
778
Vishnu Naire97d6122018-01-18 13:58:56 -0800779 return OK;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800780}
781
Felipe Leme1d486fe2016-10-14 18:06:47 -0700782bool Dumpstate::AddZipEntry(const std::string& entry_name, const std::string& entry_path) {
783 android::base::unique_fd fd(
784 TEMP_FAILURE_RETRY(open(entry_path.c_str(), O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
Andreas Gampeaff68432016-07-18 18:01:27 -0700785 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800786 MYLOGE("open(%s): %s\n", entry_path.c_str(), strerror(errno));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800787 return false;
788 }
789
Vishnu Naire97d6122018-01-18 13:58:56 -0800790 return (AddZipEntryFromFd(entry_name, fd.get()) == OK);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800791}
792
793/* adds a file to the existing zipped bugreport */
Felipe Leme4c2d6632016-09-28 14:32:00 -0700794static int _add_file_from_fd(const char* title __attribute__((unused)), const char* path, int fd) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800795 return (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + path, fd) == OK) ? 0 : 1;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800796}
797
Felipe Leme1d486fe2016-10-14 18:06:47 -0700798void Dumpstate::AddDir(const std::string& dir, bool recursive) {
799 if (!IsZipping()) {
800 MYLOGD("Not adding dir %s because it's not a zipped bugreport\n", dir.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800801 return;
802 }
Felipe Leme678727a2016-09-21 17:22:11 -0700803 MYLOGD("Adding dir %s (recursive: %d)\n", dir.c_str(), recursive);
Felipe Leme46b85da2016-11-21 17:40:45 -0800804 DurationReporter duration_reporter(dir, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700805 dump_files("", dir.c_str(), recursive ? skip_none : is_dir, _add_file_from_fd);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800806}
807
Felipe Leme1d486fe2016-10-14 18:06:47 -0700808bool Dumpstate::AddTextZipEntry(const std::string& entry_name, const std::string& content) {
809 if (!IsZipping()) {
810 MYLOGD("Not adding text zip entry %s because it's not a zipped bugreport\n",
811 entry_name.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800812 return false;
813 }
Felipe Lemecbce55d2016-02-08 09:53:18 -0800814 MYLOGD("Adding zip text entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700815 int32_t err = zip_writer_->StartEntryWithTime(entry_name.c_str(), ZipWriter::kCompress, ds.now_);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700816 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700817 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700818 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800819 return false;
820 }
821
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700822 err = zip_writer_->WriteBytes(content.c_str(), content.length());
Felipe Leme1d486fe2016-10-14 18:06:47 -0700823 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700824 MYLOGE("zip_writer_->WriteBytes(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700825 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800826 return false;
827 }
828
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700829 err = zip_writer_->FinishEntry();
Felipe Leme1d486fe2016-10-14 18:06:47 -0700830 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700831 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800832 return false;
833 }
834
835 return true;
836}
837
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800838static void DoKmsg() {
839 struct stat st;
840 if (!stat(PSTORE_LAST_KMSG, &st)) {
841 /* Also TODO: Make console-ramoops CAP_SYSLOG protected. */
842 DumpFile("LAST KMSG", PSTORE_LAST_KMSG);
843 } else if (!stat(ALT_PSTORE_LAST_KMSG, &st)) {
844 DumpFile("LAST KMSG", ALT_PSTORE_LAST_KMSG);
845 } else {
846 /* TODO: Make last_kmsg CAP_SYSLOG protected. b/5555691 */
847 DumpFile("LAST KMSG", "/proc/last_kmsg");
848 }
849}
850
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800851static void DoKernelLogcat() {
Yao Chenbe3bbc12018-01-17 16:31:10 -0800852 unsigned long timeout_ms = logcat_timeout({"kernel"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800853 RunCommand(
854 "KERNEL LOG",
855 {"logcat", "-b", "kernel", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
856 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
857}
858
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800859static void DoLogcat() {
Vishnu Nair6921f802017-11-22 09:17:23 -0800860 unsigned long timeout_ms;
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800861 // DumpFile("EVENT LOG TAGS", "/etc/event-log-tags");
862 // calculate timeout
Yao Chenbe3bbc12018-01-17 16:31:10 -0800863 timeout_ms = logcat_timeout({"main", "system", "crash"});
Tony Makae737652017-03-30 17:47:09 +0100864 RunCommand("SYSTEM LOG",
Vishnu Nair6921f802017-11-22 09:17:23 -0800865 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
866 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -0800867 timeout_ms = logcat_timeout({"events"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800868 RunCommand(
869 "EVENT LOG",
870 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +0100871 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Yao Chenbe3bbc12018-01-17 16:31:10 -0800872 timeout_ms = logcat_timeout({"stats"});
873 RunCommand(
874 "STATS LOG",
875 {"logcat", "-b", "stats", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +0100876 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Yao Chenbe3bbc12018-01-17 16:31:10 -0800877 timeout_ms = logcat_timeout({"radio"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800878 RunCommand(
879 "RADIO LOG",
880 {"logcat", "-b", "radio", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +0100881 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800882
883 RunCommand("LOG STATISTICS", {"logcat", "-b", "all", "-S"});
884
885 /* kernels must set CONFIG_PSTORE_PMSG, slice up pstore with device tree */
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800886 RunCommand("LAST LOGCAT", {"logcat", "-L", "-b", "all", "-v", "threadtime", "-v", "printable",
887 "-v", "uid", "-d", "*:v"});
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800888}
889
Jayachandran Ca94c7172017-06-10 15:08:12 -0700890static void DumpIpTablesAsRoot() {
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700891 RunCommand("IPTABLES", {"iptables", "-L", "-nvx"});
892 RunCommand("IP6TABLES", {"ip6tables", "-L", "-nvx"});
Erik Kline32af8c22016-09-28 17:26:26 +0900893 RunCommand("IPTABLES NAT", {"iptables", "-t", "nat", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -0700894 /* no ip6 nat */
Erik Kline32af8c22016-09-28 17:26:26 +0900895 RunCommand("IPTABLES MANGLE", {"iptables", "-t", "mangle", "-L", "-nvx"});
896 RunCommand("IP6TABLES MANGLE", {"ip6tables", "-t", "mangle", "-L", "-nvx"});
897 RunCommand("IPTABLES RAW", {"iptables", "-t", "raw", "-L", "-nvx"});
898 RunCommand("IP6TABLES RAW", {"ip6tables", "-t", "raw", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -0700899}
900
Narayan Kamath8f788292017-05-25 13:20:39 +0100901static void AddAnrTraceDir(const bool add_to_zip, const std::string& anr_traces_dir) {
902 MYLOGD("AddAnrTraceDir(): dump_traces_file=%s, anr_traces_dir=%s\n", dump_traces_path,
903 anr_traces_dir.c_str());
904
905 // If we're here, dump_traces_path will always be a temporary file
906 // (created with mkostemp or similar) that contains dumps taken earlier
907 // on in the process.
908 if (dump_traces_path != nullptr) {
909 if (add_to_zip) {
910 ds.AddZipEntry(ZIP_ROOT_DIR + anr_traces_dir + "/traces-just-now.txt", dump_traces_path);
911 } else {
912 MYLOGD("Dumping current ANR traces (%s) to the main bugreport entry\n",
913 dump_traces_path);
914 ds.DumpFile("VM TRACES JUST NOW", dump_traces_path);
915 }
916
917 const int ret = unlink(dump_traces_path);
918 if (ret == -1) {
919 MYLOGW("Error unlinking temporary trace path %s: %s\n", dump_traces_path,
920 strerror(errno));
Felipe Lemee184f662016-10-27 10:04:47 -0700921 }
922 }
923
Narayan Kamathbd863722017-06-01 18:50:12 +0100924 // Add a specific message for the first ANR Dump.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700925 if (ds.anr_data_.size() > 0) {
926 AddDumps(ds.anr_data_.begin(), ds.anr_data_.begin() + 1,
Narayan Kamathbd863722017-06-01 18:50:12 +0100927 "VM TRACES AT LAST ANR", add_to_zip);
928
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100929 // The "last" ANR will always be included as separate entry in the zip file. In addition,
930 // it will be present in the body of the main entry if |add_to_zip| == false.
931 //
932 // Historical ANRs are always included as separate entries in the bugreport zip file.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700933 AddDumps(ds.anr_data_.begin() + ((add_to_zip) ? 1 : 0), ds.anr_data_.end(),
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100934 "HISTORICAL ANR", true /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +0100935 } else {
Narayan Kamath8f788292017-05-25 13:20:39 +0100936 printf("*** NO ANRs to dump in %s\n\n", ANR_DIR.c_str());
937 }
938}
939
940static void AddAnrTraceFiles() {
941 const bool add_to_zip = ds.IsZipping() && ds.version_ == VERSION_SPLIT_ANR;
942
Elliott Hughes69fe5ec2018-03-23 11:04:25 -0700943 std::string anr_traces_dir = "/data/anr";
Narayan Kamath8f788292017-05-25 13:20:39 +0100944
Elliott Hughes69fe5ec2018-03-23 11:04:25 -0700945 AddAnrTraceDir(add_to_zip, anr_traces_dir);
Narayan Kamath8f788292017-05-25 13:20:39 +0100946
Makoto Onuki83ec63f2019-01-31 17:08:59 -0800947 RunCommand("ANR FILES", {"ls", "-lt", ANR_DIR});
948
Elliott Hughes69fe5ec2018-03-23 11:04:25 -0700949 // Slow traces for slow operations.
Felipe Lemee184f662016-10-27 10:04:47 -0700950 struct stat st;
Elliott Hughes69fe5ec2018-03-23 11:04:25 -0700951 int i = 0;
952 while (true) {
953 const std::string slow_trace_path =
954 anr_traces_dir + android::base::StringPrintf("slow%02d.txt", i);
955 if (stat(slow_trace_path.c_str(), &st)) {
956 // No traces file at this index, done with the files.
957 break;
Felipe Lemee184f662016-10-27 10:04:47 -0700958 }
Elliott Hughes69fe5ec2018-03-23 11:04:25 -0700959 ds.DumpFile("VM TRACES WHEN SLOW", slow_trace_path.c_str());
960 i++;
Felipe Lemee184f662016-10-27 10:04:47 -0700961 }
962}
963
Wei Wang509bb5d2017-06-09 14:42:12 -0700964static void DumpBlockStatFiles() {
965 DurationReporter duration_reporter("DUMP BLOCK STAT");
Wei Wang509bb5d2017-06-09 14:42:12 -0700966
Wei Wang1dc1ef52017-06-12 11:28:37 -0700967 std::unique_ptr<DIR, std::function<int(DIR*)>> dirptr(opendir(BLK_DEV_SYS_DIR), closedir);
968
969 if (dirptr == nullptr) {
Wei Wang509bb5d2017-06-09 14:42:12 -0700970 MYLOGE("Failed to open %s: %s\n", BLK_DEV_SYS_DIR, strerror(errno));
971 return;
972 }
973
974 printf("------ DUMP BLOCK STAT ------\n\n");
Wei Wang1dc1ef52017-06-12 11:28:37 -0700975 while (struct dirent *d = readdir(dirptr.get())) {
Wei Wang509bb5d2017-06-09 14:42:12 -0700976 if ((d->d_name[0] == '.')
977 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
978 || (d->d_name[1] == '\0'))) {
979 continue;
980 }
981 const std::string new_path =
982 android::base::StringPrintf("%s/%s", BLK_DEV_SYS_DIR, d->d_name);
983 printf("------ BLOCK STAT (%s) ------\n", new_path.c_str());
984 dump_files("", new_path.c_str(), skip_not_stat, dump_stat_from_fd);
985 printf("\n");
986 }
Wei Wang1dc1ef52017-06-12 11:28:37 -0700987 return;
Wei Wang509bb5d2017-06-09 14:42:12 -0700988}
Jayachandran Ca94c7172017-06-10 15:08:12 -0700989
990static void DumpPacketStats() {
991 DumpFile("NETWORK DEV INFO", "/proc/net/dev");
992 DumpFile("QTAGUID NETWORK INTERFACES INFO", "/proc/net/xt_qtaguid/iface_stat_all");
993 DumpFile("QTAGUID NETWORK INTERFACES INFO (xt)", "/proc/net/xt_qtaguid/iface_stat_fmt");
994 DumpFile("QTAGUID CTRL INFO", "/proc/net/xt_qtaguid/ctrl");
995 DumpFile("QTAGUID STATS INFO", "/proc/net/xt_qtaguid/stats");
996}
997
998static void DumpIpAddrAndRules() {
999 /* The following have a tendency to get wedged when wifi drivers/fw goes belly-up. */
1000 RunCommand("NETWORK INTERFACES", {"ip", "link"});
1001 RunCommand("IPv4 ADDRESSES", {"ip", "-4", "addr", "show"});
1002 RunCommand("IPv6 ADDRESSES", {"ip", "-6", "addr", "show"});
1003 RunCommand("IP RULES", {"ip", "rule", "show"});
1004 RunCommand("IP RULES v6", {"ip", "-6", "rule", "show"});
1005}
1006
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001007static Dumpstate::RunStatus RunDumpsysTextByPriority(const std::string& title, int priority,
1008 std::chrono::milliseconds timeout,
1009 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001010 auto start = std::chrono::steady_clock::now();
Vishnu Naire97d6122018-01-18 13:58:56 -08001011 sp<android::IServiceManager> sm = defaultServiceManager();
1012 Dumpsys dumpsys(sm.get());
Vishnu Naire97d6122018-01-18 13:58:56 -08001013 Vector<String16> args;
1014 Dumpsys::setServiceArgs(args, /* asProto = */ false, priority);
Vishnu Naire97d6122018-01-18 13:58:56 -08001015 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ false);
1016 for (const String16& service : services) {
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001017 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001018 std::string path(title);
1019 path.append(" - ").append(String8(service).c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -08001020 size_t bytes_written = 0;
1021 status_t status = dumpsys.startDumpThread(service, args);
1022 if (status == OK) {
1023 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1024 std::chrono::duration<double> elapsed_seconds;
1025 status = dumpsys.writeDump(STDOUT_FILENO, service, service_timeout,
1026 /* as_proto = */ false, elapsed_seconds, bytes_written);
Vishnu Naire97d6122018-01-18 13:58:56 -08001027 dumpsys.writeDumpFooter(STDOUT_FILENO, service, elapsed_seconds);
1028 bool dump_complete = (status == OK);
1029 dumpsys.stopDumpThread(dump_complete);
1030 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001031
1032 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1033 std::chrono::steady_clock::now() - start);
1034 if (elapsed_duration > timeout) {
1035 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1036 elapsed_duration.count());
1037 break;
1038 }
1039 }
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001040 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001041}
1042
Vishnu Nair64afc022018-02-01 15:29:34 -08001043static void RunDumpsysText(const std::string& title, int priority,
1044 std::chrono::milliseconds timeout,
1045 std::chrono::milliseconds service_timeout) {
1046 DurationReporter duration_reporter(title);
1047 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1048 fsync(STDOUT_FILENO);
1049 RunDumpsysTextByPriority(title, priority, timeout, service_timeout);
1050}
1051
1052/* Dump all services registered with Normal or Default priority. */
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001053static Dumpstate::RunStatus RunDumpsysTextNormalPriority(const std::string& title,
1054 std::chrono::milliseconds timeout,
1055 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001056 DurationReporter duration_reporter(title);
1057 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1058 fsync(STDOUT_FILENO);
1059 RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_NORMAL, timeout,
1060 service_timeout);
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001061
1062 RETURN_IF_USER_DENIED_CONSENT();
1063
1064 return RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_DEFAULT, timeout,
1065 service_timeout);
Vishnu Nair64afc022018-02-01 15:29:34 -08001066}
1067
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001068static Dumpstate::RunStatus RunDumpsysProto(const std::string& title, int priority,
1069 std::chrono::milliseconds timeout,
1070 std::chrono::milliseconds service_timeout) {
Luis Hector Chavez1e27b082018-03-22 15:36:42 -07001071 if (!ds.IsZipping()) {
1072 MYLOGD("Not dumping %s because it's not a zipped bugreport\n", title.c_str());
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001073 return Dumpstate::RunStatus::OK;
Luis Hector Chavez1e27b082018-03-22 15:36:42 -07001074 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001075 sp<android::IServiceManager> sm = defaultServiceManager();
1076 Dumpsys dumpsys(sm.get());
1077 Vector<String16> args;
1078 Dumpsys::setServiceArgs(args, /* asProto = */ true, priority);
1079 DurationReporter duration_reporter(title);
1080
1081 auto start = std::chrono::steady_clock::now();
1082 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ true);
1083 for (const String16& service : services) {
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001084 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001085 std::string path(kProtoPath);
1086 path.append(String8(service).c_str());
1087 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL) {
1088 path.append("_CRITICAL");
1089 } else if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH) {
1090 path.append("_HIGH");
1091 }
1092 path.append(kProtoExt);
Vishnu Naire97d6122018-01-18 13:58:56 -08001093 status_t status = dumpsys.startDumpThread(service, args);
1094 if (status == OK) {
1095 status = ds.AddZipEntryFromFd(path, dumpsys.getDumpFd(), service_timeout);
1096 bool dumpTerminated = (status == OK);
1097 dumpsys.stopDumpThread(dumpTerminated);
1098 }
1099 ZipWriter::FileEntry file_entry;
1100 ds.zip_writer_->GetLastEntry(&file_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -08001101
1102 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1103 std::chrono::steady_clock::now() - start);
1104 if (elapsed_duration > timeout) {
1105 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1106 elapsed_duration.count());
1107 break;
1108 }
1109 }
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001110 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001111}
1112
Nandana Dutta7db6342018-11-21 14:53:34 +00001113// Runs dumpsys on services that must dump first and will take less than 100ms to dump.
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001114static Dumpstate::RunStatus RunDumpsysCritical() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001115 RunDumpsysText("DUMPSYS CRITICAL", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1116 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001117
1118 RETURN_IF_USER_DENIED_CONSENT();
1119
1120 return RunDumpsysProto("DUMPSYS CRITICAL PROTO", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1121 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Vishnu Nair780b1282017-10-10 13:57:24 -07001122}
1123
1124// Runs dumpsys on services that must dump first but can take up to 250ms to dump.
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001125static Dumpstate::RunStatus RunDumpsysHigh() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001126 // TODO meminfo takes ~10s, connectivity takes ~5sec to dump. They are both
1127 // high priority. Reduce timeout once they are able to dump in a shorter time or
1128 // moved to a parallel task.
1129 RunDumpsysText("DUMPSYS HIGH", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1130 /* timeout= */ 90s, /* service_timeout= */ 30s);
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001131
1132 RETURN_IF_USER_DENIED_CONSENT();
1133
1134 return RunDumpsysProto("DUMPSYS HIGH PROTO", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1135 /* timeout= */ 5s, /* service_timeout= */ 1s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001136}
1137
1138// Runs dumpsys on services that must dump but can take up to 10s to dump.
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001139static Dumpstate::RunStatus RunDumpsysNormal() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001140 RunDumpsysTextNormalPriority("DUMPSYS", /* timeout= */ 90s, /* service_timeout= */ 10s);
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001141
1142 RETURN_IF_USER_DENIED_CONSENT();
1143
1144 return RunDumpsysProto("DUMPSYS PROTO", IServiceManager::DUMP_FLAG_PRIORITY_NORMAL,
1145 /* timeout= */ 90s, /* service_timeout= */ 10s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001146}
1147
Steven Moreland44cd9482018-01-04 16:24:13 -08001148static void DumpHals() {
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001149 if (!ds.IsZipping()) {
1150 RunCommand("HARDWARE HALS", {"lshal", "-lVSietrpc", "--types=b,c,l,z", "--debug"},
1151 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build());
1152 return;
1153 }
1154 DurationReporter duration_reporter("DUMP HALS");
1155 RunCommand("HARDWARE HALS", {"lshal", "-lVSietrpc", "--types=b,c,l,z"},
Greg Kaiser3dfeda32019-05-16 10:32:51 -07001156 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build());
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001157
Steven Moreland44cd9482018-01-04 16:24:13 -08001158 using android::hidl::manager::V1_0::IServiceManager;
1159 using android::hardware::defaultServiceManager;
1160
1161 sp<IServiceManager> sm = defaultServiceManager();
1162 if (sm == nullptr) {
1163 MYLOGE("Could not retrieve hwservicemanager to dump hals.\n");
1164 return;
1165 }
1166
1167 auto ret = sm->list([&](const auto& interfaces) {
1168 for (const std::string& interface : interfaces) {
1169 std::string cleanName = interface;
1170 std::replace_if(cleanName.begin(),
1171 cleanName.end(),
1172 [](char c) {
1173 return !isalnum(c) &&
1174 std::string("@-_:.").find(c) == std::string::npos;
1175 }, '_');
Nandana Dutt979388e2018-11-30 16:48:55 +00001176 const std::string path = ds.bugreport_internal_dir_ + "/lshal_debug_" + cleanName;
Steven Moreland44cd9482018-01-04 16:24:13 -08001177
1178 {
1179 auto fd = android::base::unique_fd(
1180 TEMP_FAILURE_RETRY(open(path.c_str(),
1181 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1182 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1183 if (fd < 0) {
1184 MYLOGE("Could not open %s to dump additional hal information.\n", path.c_str());
1185 continue;
1186 }
1187 RunCommandToFd(fd,
1188 "",
Steven Morelandc81cd3c2018-01-18 14:36:26 -08001189 {"lshal", "debug", "-E", interface},
Steven Moreland44cd9482018-01-04 16:24:13 -08001190 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
1191
1192 bool empty = 0 == lseek(fd, 0, SEEK_END);
1193 if (!empty) {
1194 ds.AddZipEntry("lshal-debug/" + cleanName + ".txt", path);
1195 }
1196 }
1197
1198 unlink(path.c_str());
1199 }
1200 });
1201
1202 if (!ret.isOk()) {
1203 MYLOGE("Could not list hals from hwservicemanager.\n");
1204 }
1205}
1206
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001207static void DumpExternalFragmentationInfo() {
1208 struct stat st;
1209 if (stat("/proc/buddyinfo", &st) != 0) {
1210 MYLOGE("Unable to dump external fragmentation info\n");
1211 return;
1212 }
1213
1214 printf("------ EXTERNAL FRAGMENTATION INFO ------\n");
1215 std::ifstream ifs("/proc/buddyinfo");
1216 auto unusable_index_regex = std::regex{"Node\\s+([0-9]+),\\s+zone\\s+(\\S+)\\s+(.*)"};
1217 for (std::string line; std::getline(ifs, line);) {
1218 std::smatch match_results;
1219 if (std::regex_match(line, match_results, unusable_index_regex)) {
1220 std::stringstream free_pages(std::string{match_results[3]});
1221 std::vector<int> free_pages_per_order(std::istream_iterator<int>{free_pages},
1222 std::istream_iterator<int>());
1223
1224 int total_free_pages = 0;
1225 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1226 total_free_pages += (free_pages_per_order[i] * std::pow(2, i));
1227 }
1228
1229 printf("Node %s, zone %8s", match_results[1].str().c_str(),
1230 match_results[2].str().c_str());
1231
1232 int usable_free_pages = total_free_pages;
1233 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1234 auto unusable_index = (total_free_pages - usable_free_pages) /
1235 static_cast<double>(total_free_pages);
1236 printf(" %5.3f", unusable_index);
1237 usable_free_pages -= (free_pages_per_order[i] * std::pow(2, i));
1238 }
1239
1240 printf("\n");
1241 }
1242 }
1243 printf("\n");
1244}
1245
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001246// Dumps various things. Returns early with status USER_CONSENT_DENIED if user denies consent
1247// via the consent they are shown. Ignores other errors that occur while running various
1248// commands. The consent checking is currently done around long running tasks, which happen to
1249// be distributed fairly evenly throughout the function.
1250static Dumpstate::RunStatus dumpstate() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001251 DurationReporter duration_reporter("DUMPSTATE");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001252
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001253 // Dump various things. Note that anything that takes "long" (i.e. several seconds) should
1254 // check intermittently (if it's intrerruptable like a foreach on pids) and/or should be wrapped
1255 // in a consent check (via RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK).
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -07001256 dump_dev_files("TRUSTY VERSION", "/sys/bus/platform/drivers/trusty", "trusty_version");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001257 RunCommand("UPTIME", {"uptime"});
Wei Wang509bb5d2017-06-09 14:42:12 -07001258 DumpBlockStatFiles();
Mark Salyzyn8c8130e2015-12-09 11:21:28 -08001259 dump_emmc_ecsd("/d/mmc0/mmc0:0001/ext_csd");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001260 DumpFile("MEMORY INFO", "/proc/meminfo");
1261 RunCommand("CPU INFO", {"top", "-b", "-n", "1", "-H", "-s", "6", "-o",
Felipe Leme30dbfa12016-09-02 12:43:26 -07001262 "pid,tid,user,pr,ni,%cpu,s,virt,res,pcy,cmd,name"});
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001263
1264 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "PROCRANK", {"procrank"}, AS_ROOT_20);
1265
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001266 DumpFile("VIRTUAL MEMORY STATS", "/proc/vmstat");
1267 DumpFile("VMALLOC INFO", "/proc/vmallocinfo");
1268 DumpFile("SLAB INFO", "/proc/slabinfo");
1269 DumpFile("ZONEINFO", "/proc/zoneinfo");
1270 DumpFile("PAGETYPEINFO", "/proc/pagetypeinfo");
1271 DumpFile("BUDDYINFO", "/proc/buddyinfo");
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001272 DumpExternalFragmentationInfo();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001273
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001274 DumpFile("KERNEL WAKE SOURCES", "/d/wakeup_sources");
1275 DumpFile("KERNEL CPUFREQ", "/sys/devices/system/cpu/cpu0/cpufreq/stats/time_in_state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001276
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001277 RunCommand("PROCESSES AND THREADS",
Yohei Yukawa591a72d2017-10-05 21:36:35 -07001278 {"ps", "-A", "-T", "-Z", "-O", "pri,nice,rtprio,sched,pcy,time"});
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001279
1280 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "LIBRANK", {"librank"},
1281 CommandOptions::AS_ROOT);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001282
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001283 DumpHals();
Steven Moreland81b429e2017-01-31 19:50:46 -08001284
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001285 RunCommand("PRINTENV", {"printenv"});
Elliott Hughes21b7c8d2016-10-28 08:53:02 -07001286 RunCommand("NETSTAT", {"netstat", "-nW"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001287 struct stat s;
1288 if (stat("/proc/modules", &s) != 0) {
1289 MYLOGD("Skipping 'lsmod' because /proc/modules does not exist\n");
1290 } else {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001291 RunCommand("LSMOD", {"lsmod"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001292 }
Michal Karpinski4db754f2015-12-11 18:04:32 +00001293
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001294 if (__android_logger_property_get_bool(
1295 "ro.logd.kernel", BOOL_DEFAULT_TRUE | BOOL_DEFAULT_FLAG_ENG | BOOL_DEFAULT_FLAG_SVELTE)) {
1296 DoKernelLogcat();
1297 } else {
1298 do_dmesg();
1299 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001300
Felipe Lemef0292972016-11-22 13:57:05 -08001301 RunCommand("LIST OF OPEN FILES", {"lsof"}, CommandOptions::AS_ROOT);
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001302
1303 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(for_each_pid, do_showmap, "SMAPS OF ALL PROCESSES");
1304
Jeff Brown1dc94e32014-09-11 14:15:27 -07001305 for_each_tid(show_wchan, "BLOCKED PROCESS WAIT-CHANNELS");
Mark Salyzyna297c322016-02-05 15:33:17 -08001306 for_each_pid(show_showtime, "PROCESS TIMES (pid cmd user system iowait+percentage)");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001307
Ajay Panicker2ff8e872017-04-27 14:04:32 -07001308 /* Dump Bluetooth HCI logs */
1309 ds.AddDir("/data/misc/bluetooth/logs", true);
Ajay Panickerd886ec42016-09-14 12:26:46 -07001310
Greg Kaiser3ddc3fa2019-05-23 16:14:52 -07001311 if (ds.options_->do_fb && !ds.do_early_screenshot_) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001312 MYLOGI("taking late screenshot\n");
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001313 ds.TakeScreenshot();
Jeff Sharkey5a930032013-03-19 15:05:19 -07001314 }
1315
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001316 DoLogcat();
Mark Salyzynecc07632015-07-30 14:57:09 -07001317
Felipe Lemee184f662016-10-27 10:04:47 -07001318 AddAnrTraceFiles();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001319
Narayan Kamath8f788292017-05-25 13:20:39 +01001320 // NOTE: tombstones are always added as separate entries in the zip archive
1321 // and are not interspersed with the main report.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001322 const bool tombstones_dumped = AddDumps(ds.tombstone_data_.begin(), ds.tombstone_data_.end(),
Narayan Kamathbd863722017-06-01 18:50:12 +01001323 "TOMBSTONE", true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001324 if (!tombstones_dumped) {
1325 printf("*** NO TOMBSTONES to dump in %s\n\n", TOMBSTONE_DIR.c_str());
Christopher Ferris7dc7f322014-07-22 16:08:19 -07001326 }
1327
Jayachandran Ca94c7172017-06-10 15:08:12 -07001328 DumpPacketStats();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001329
Chenbo Feng276a3b62018-08-07 11:44:49 -07001330 RunDumpsys("EBPF MAP STATS", {"netd", "trafficcontroller"});
1331
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001332 DoKmsg();
Mark Salyzyn2262c162014-12-16 09:09:26 -08001333
Jayachandran Ca94c7172017-06-10 15:08:12 -07001334 DumpIpAddrAndRules();
Sreeram Ramachandran2b3bba32014-07-08 15:40:55 -07001335
1336 dump_route_tables();
1337
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001338 RunCommand("ARP CACHE", {"ip", "-4", "neigh", "show"});
1339 RunCommand("IPv6 ND CACHE", {"ip", "-6", "neigh", "show"});
1340 RunCommand("MULTICAST ADDRESSES", {"ip", "maddr"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001341
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001342 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysHigh);
Lorenzo Colitti6afc38c2015-09-09 22:59:25 +09001343
Elliott Hughes23ccc622017-02-28 10:14:22 -08001344 RunCommand("SYSTEM PROPERTIES", {"getprop"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001345
Jin Qianf334d662017-10-10 14:41:37 -07001346 RunCommand("STORAGED IO INFO", {"storaged", "-u", "-p"});
ynwangf649a6e2016-07-17 21:56:00 -07001347
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001348 RunCommand("FILESYSTEMS & FREE SPACE", {"df"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001349
Colin Crossf45fa6b2012-03-26 12:38:26 -07001350 /* Binder state is expensive to look at as it uses a lot of memory. */
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001351 DumpFile("BINDER FAILED TRANSACTION LOG", "/sys/kernel/debug/binder/failed_transaction_log");
1352 DumpFile("BINDER TRANSACTION LOG", "/sys/kernel/debug/binder/transaction_log");
1353 DumpFile("BINDER TRANSACTIONS", "/sys/kernel/debug/binder/transactions");
1354 DumpFile("BINDER STATS", "/sys/kernel/debug/binder/stats");
1355 DumpFile("BINDER STATE", "/sys/kernel/debug/binder/state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001356
Vishnu Nair36b4cdb2017-11-17 10:27:05 -08001357 /* Add window and surface trace files. */
1358 if (!PropertiesHelper::IsUserBuild()) {
1359 ds.AddDir(WMTRACE_DATA_DIR, false);
1360 }
1361
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001362 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(ds.DumpstateBoard);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001363
Steven Moreland7440ddb2016-12-15 16:13:39 -08001364 /* Migrate the ril_dumpstate to a device specific dumpstate? */
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001365 int rilDumpstateTimeout = android::base::GetIntProperty("ril.dumpstate.timeout", 0);
1366 if (rilDumpstateTimeout > 0) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001367 // su does not exist on user builds, so try running without it.
1368 // This way any implementations of vril-dump that do not require
1369 // root can run on user builds.
1370 CommandOptions::CommandOptionsBuilder options =
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001371 CommandOptions::WithTimeout(rilDumpstateTimeout);
Felipe Lemef0292972016-11-22 13:57:05 -08001372 if (!PropertiesHelper::IsUserBuild()) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001373 options.AsRoot();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001374 }
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001375 RunCommand("DUMP VENDOR RIL LOGS", {"vril-dump"}, options.Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -07001376 }
1377
Felipe Lemed8b94e52016-12-08 10:21:44 -08001378 printf("========================================================\n");
1379 printf("== Android Framework Services\n");
1380 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001381
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001382 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysNormal);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001383
Felipe Lemed8b94e52016-12-08 10:21:44 -08001384 printf("========================================================\n");
1385 printf("== Checkins\n");
1386 printf("========================================================\n");
Dianne Hackborn02bea972013-06-26 18:59:09 -07001387
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001388 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001389
1390 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsys, "CHECKIN MEMINFO", {"meminfo", "--checkin"});
1391
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001392 RunDumpsys("CHECKIN NETSTATS", {"netstats", "--checkin"});
1393 RunDumpsys("CHECKIN PROCSTATS", {"procstats", "-c"});
1394 RunDumpsys("CHECKIN USAGESTATS", {"usagestats", "-c"});
1395 RunDumpsys("CHECKIN PACKAGE", {"package", "--checkin"});
Dianne Hackborn02bea972013-06-26 18:59:09 -07001396
Felipe Lemed8b94e52016-12-08 10:21:44 -08001397 printf("========================================================\n");
1398 printf("== Running Application Activities\n");
1399 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001400
Makoto Onuki60780982018-04-16 15:34:00 -07001401 // The following dumpsys internally collects output from running apps, so it can take a long
1402 // time. So let's extend the timeout.
1403
1404 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
1405
1406 RunDumpsys("APP ACTIVITIES", {"activity", "-v", "all"}, DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001407
Felipe Lemed8b94e52016-12-08 10:21:44 -08001408 printf("========================================================\n");
Makoto Onuki60780982018-04-16 15:34:00 -07001409 printf("== Running Application Services (platform)\n");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001410 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001411
Vishnu Nairc6e6ea72018-07-02 14:20:06 -07001412 RunDumpsys("APP SERVICES PLATFORM", {"activity", "service", "all-platform-non-critical"},
Makoto Onuki60780982018-04-16 15:34:00 -07001413 DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001414
Felipe Lemed8b94e52016-12-08 10:21:44 -08001415 printf("========================================================\n");
Makoto Onuki60780982018-04-16 15:34:00 -07001416 printf("== Running Application Services (non-platform)\n");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001417 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001418
Makoto Onuki60780982018-04-16 15:34:00 -07001419 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1420 DUMPSYS_COMPONENTS_OPTIONS);
1421
1422 printf("========================================================\n");
1423 printf("== Running Application Providers (platform)\n");
1424 printf("========================================================\n");
1425
1426 RunDumpsys("APP PROVIDERS PLATFORM", {"activity", "provider", "all-platform"},
1427 DUMPSYS_COMPONENTS_OPTIONS);
1428
1429 printf("========================================================\n");
1430 printf("== Running Application Providers (non-platform)\n");
1431 printf("========================================================\n");
1432
1433 RunDumpsys("APP PROVIDERS NON-PLATFORM", {"activity", "provider", "all-non-platform"},
1434 DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001435
Adrian Roos8b397ab2017-04-04 16:35:44 -07001436 printf("========================================================\n");
1437 printf("== Dropbox crashes\n");
1438 printf("========================================================\n");
1439
1440 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1441 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1442
Felipe Lemed8b94e52016-12-08 10:21:44 -08001443 printf("========================================================\n");
1444 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1445 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1446 printf("========================================================\n");
1447 printf("== dumpstate: done (id %d)\n", ds.id_);
1448 printf("========================================================\n");
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001449 return Dumpstate::RunStatus::OK;
Colin Crossf45fa6b2012-03-26 12:38:26 -07001450}
1451
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001452/*
1453 * Dumps state for the default case; drops root after it's no longer necessary.
1454 *
1455 * Returns RunStatus::OK if everything went fine.
1456 * Returns RunStatus::ERROR if there was an error.
1457 * Returns RunStatus::USER_DENIED_CONSENT if user explicitly denied consent to sharing the bugreport
1458 * with the caller.
1459 */
1460static Dumpstate::RunStatus DumpstateDefault() {
Nandana Duttcf419a72019-03-14 10:40:17 +00001461 // Invoking the following dumpsys calls before DumpTraces() to try and
Nandana Dutt4be45d12018-09-26 15:04:23 +01001462 // keep the system stats as close to its initial state as possible.
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001463 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysCritical);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001464
1465 /* collect stack traces from Dalvik and native processes (needs root) */
Nandana Duttcf419a72019-03-14 10:40:17 +00001466 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(ds.DumpTraces, &dump_traces_path);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001467
1468 /* Run some operations that require root. */
1469 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX, !ds.IsZipping());
1470 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX, !ds.IsZipping());
1471
1472 ds.AddDir(RECOVERY_DIR, true);
1473 ds.AddDir(RECOVERY_DATA_DIR, true);
1474 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
1475 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1476 if (!PropertiesHelper::IsUserBuild()) {
1477 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1478 ds.AddDir(PROFILE_DATA_DIR_REF, true);
1479 }
1480 add_mountinfo();
1481 DumpIpTablesAsRoot();
1482
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001483 // Capture any IPSec policies in play. No keys are exposed here.
Nandana Dutt4be45d12018-09-26 15:04:23 +01001484 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1485
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001486 // Dump IPsec stats. No keys are exposed here.
1487 DumpFile("XFRM STATS", XFRM_STAT_PROC_FILE);
1488
Nandana Dutt4be45d12018-09-26 15:04:23 +01001489 // Run ss as root so we can see socket marks.
1490 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
1491
1492 // Run iotop as root to show top 100 IO threads
1493 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
1494
Erick Reyese68df822019-02-11 14:46:36 -08001495 // Gather shared memory buffer info if the product implements it
1496 struct stat st;
1497 if (!stat("/product/bin/dmabuf_dump", &st)) {
1498 RunCommand("Dmabuf dump", {"/product/bin/dmabuf_dump"});
1499 }
1500
Nandana Dutt4be45d12018-09-26 15:04:23 +01001501 if (!DropRootUser()) {
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001502 return Dumpstate::RunStatus::ERROR;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001503 }
1504
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001505 RETURN_IF_USER_DENIED_CONSENT();
1506 return dumpstate();
Nandana Dutt4be45d12018-09-26 15:04:23 +01001507}
1508
mukesh agrawal253dad42018-01-23 21:59:59 -08001509// This method collects common dumpsys for telephony and wifi
1510static void DumpstateRadioCommon() {
Jayachandran Ca94c7172017-06-10 15:08:12 -07001511 DumpIpTablesAsRoot();
1512
1513 if (!DropRootUser()) {
1514 return;
1515 }
1516
1517 do_dmesg();
1518 DoLogcat();
1519 DumpPacketStats();
1520 DoKmsg();
1521 DumpIpAddrAndRules();
1522 dump_route_tables();
1523
1524 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
1525 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08001526}
1527
1528// This method collects dumpsys for telephony debugging only
1529static void DumpstateTelephonyOnly() {
1530 DurationReporter duration_reporter("DUMPSTATE");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001531 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08001532
1533 DumpstateRadioCommon();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001534
1535 RunCommand("SYSTEM PROPERTIES", {"getprop"});
1536
1537 printf("========================================================\n");
1538 printf("== Android Framework Services\n");
1539 printf("========================================================\n");
1540
Vishnu Nair652cc802017-11-30 15:18:30 -08001541 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1542 SEC_TO_MSEC(10));
Chiachang Wang85e0db32019-03-25 08:59:55 +08001543 RunDumpsys("DUMPSYS", {"connmetrics"}, CommandOptions::WithTimeout(90).Build(),
1544 SEC_TO_MSEC(10));
1545 RunDumpsys("DUMPSYS", {"netd"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Vishnu Nair652cc802017-11-30 15:18:30 -08001546 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
1547 SEC_TO_MSEC(10));
Amruth Ramachandrand25a9142018-04-02 16:16:09 -07001548 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
1549 SEC_TO_MSEC(10));
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07001550 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
1551 SEC_TO_MSEC(10));
Jayachandran Ca94c7172017-06-10 15:08:12 -07001552
1553 printf("========================================================\n");
1554 printf("== Running Application Services\n");
1555 printf("========================================================\n");
1556
1557 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
1558
1559 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001560 printf("== Running Application Services (non-platform)\n");
1561 printf("========================================================\n");
1562
1563 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1564 DUMPSYS_COMPONENTS_OPTIONS);
1565
1566 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07001567 printf("== Checkins\n");
1568 printf("========================================================\n");
1569
1570 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
1571
1572 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07001573 printf("== dumpstate: done (id %d)\n", ds.id_);
1574 printf("========================================================\n");
1575}
1576
mukesh agrawal253dad42018-01-23 21:59:59 -08001577// This method collects dumpsys for wifi debugging only
1578static void DumpstateWifiOnly() {
1579 DurationReporter duration_reporter("DUMPSTATE");
1580
1581 DumpstateRadioCommon();
1582
1583 printf("========================================================\n");
1584 printf("== Android Framework Services\n");
1585 printf("========================================================\n");
1586
1587 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1588 SEC_TO_MSEC(10));
1589 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
1590 SEC_TO_MSEC(10));
1591
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001592 DumpHals();
Roger Wang70399032019-01-08 16:10:37 +08001593
mukesh agrawal253dad42018-01-23 21:59:59 -08001594 printf("========================================================\n");
1595 printf("== dumpstate: done (id %d)\n", ds.id_);
1596 printf("========================================================\n");
1597}
1598
Nandana Duttcf419a72019-03-14 10:40:17 +00001599Dumpstate::RunStatus Dumpstate::DumpTraces(const char** path) {
Nandana Duttfaafd522019-03-11 09:23:09 +00001600 DurationReporter duration_reporter("DUMP TRACES");
1601
1602 const std::string temp_file_pattern = "/data/anr/dumptrace_XXXXXX";
1603 const size_t buf_size = temp_file_pattern.length() + 1;
1604 std::unique_ptr<char[]> file_name_buf(new char[buf_size]);
1605 memcpy(file_name_buf.get(), temp_file_pattern.c_str(), buf_size);
1606
1607 // Create a new, empty file to receive all trace dumps.
1608 //
1609 // TODO: This can be simplified once we remove support for the old style
1610 // dumps. We can have a file descriptor passed in to dump_traces instead
1611 // of creating a file, closing it and then reopening it again.
1612 android::base::unique_fd fd(mkostemp(file_name_buf.get(), O_APPEND | O_CLOEXEC));
1613 if (fd < 0) {
1614 MYLOGE("mkostemp on pattern %s: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001615 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001616 }
1617
1618 // Nobody should have access to this temporary file except dumpstate, but we
1619 // temporarily grant 'read' to 'others' here because this file is created
1620 // when tombstoned is still running as root, but dumped after dropping. This
1621 // can go away once support for old style dumping has.
1622 const int chmod_ret = fchmod(fd, 0666);
1623 if (chmod_ret < 0) {
1624 MYLOGE("fchmod on %s failed: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001625 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001626 }
1627
1628 std::unique_ptr<DIR, decltype(&closedir)> proc(opendir("/proc"), closedir);
1629 if (proc.get() == nullptr) {
1630 MYLOGE("opendir /proc failed: %s\n", strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001631 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001632 }
1633
1634 // Number of times process dumping has timed out. If we encounter too many
1635 // failures, we'll give up.
1636 int timeout_failures = 0;
1637 bool dalvik_found = false;
1638
1639 const std::set<int> hal_pids = get_interesting_hal_pids();
1640
1641 struct dirent* d;
1642 while ((d = readdir(proc.get()))) {
Nandana Duttcf419a72019-03-14 10:40:17 +00001643 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttfaafd522019-03-11 09:23:09 +00001644 int pid = atoi(d->d_name);
1645 if (pid <= 0) {
1646 continue;
1647 }
1648
1649 const std::string link_name = android::base::StringPrintf("/proc/%d/exe", pid);
1650 std::string exe;
1651 if (!android::base::Readlink(link_name, &exe)) {
1652 continue;
1653 }
1654
1655 bool is_java_process;
1656 if (exe == "/system/bin/app_process32" || exe == "/system/bin/app_process64") {
1657 // Don't bother dumping backtraces for the zygote.
1658 if (IsZygote(pid)) {
1659 continue;
1660 }
1661
1662 dalvik_found = true;
1663 is_java_process = true;
1664 } else if (should_dump_native_traces(exe.c_str()) || hal_pids.find(pid) != hal_pids.end()) {
1665 is_java_process = false;
1666 } else {
1667 // Probably a native process we don't care about, continue.
1668 continue;
1669 }
1670
1671 // If 3 backtrace dumps fail in a row, consider debuggerd dead.
1672 if (timeout_failures == 3) {
1673 dprintf(fd, "ERROR: Too many stack dump failures, exiting.\n");
1674 break;
1675 }
1676
1677 const uint64_t start = Nanotime();
1678 const int ret = dump_backtrace_to_file_timeout(
1679 pid, is_java_process ? kDebuggerdJavaBacktrace : kDebuggerdNativeBacktrace,
1680 is_java_process ? 5 : 20, fd);
1681
1682 if (ret == -1) {
1683 // For consistency, the header and footer to this message match those
1684 // dumped by debuggerd in the success case.
1685 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
1686 dprintf(fd, "Dump failed, likely due to a timeout.\n");
1687 dprintf(fd, "---- end %d ----", pid);
1688 timeout_failures++;
1689 continue;
1690 }
1691
1692 // We've successfully dumped stack traces, reset the failure count
1693 // and write a summary of the elapsed time to the file and continue with the
1694 // next process.
1695 timeout_failures = 0;
1696
1697 dprintf(fd, "[dump %s stack %d: %.3fs elapsed]\n", is_java_process ? "dalvik" : "native",
1698 pid, (float)(Nanotime() - start) / NANOS_PER_SEC);
1699 }
1700
1701 if (!dalvik_found) {
1702 MYLOGE("Warning: no Dalvik processes found to dump stacks\n");
1703 }
1704
Nandana Duttcf419a72019-03-14 10:40:17 +00001705 *path = file_name_buf.release();
1706 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001707}
1708
Felipe Leme6f674ae2016-11-18 17:10:33 -08001709void Dumpstate::DumpstateBoard() {
1710 DurationReporter duration_reporter("dumpstate_board()");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001711 printf("========================================================\n");
1712 printf("== Board\n");
1713 printf("========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001714
Felipe Leme6f674ae2016-11-18 17:10:33 -08001715 if (!IsZipping()) {
Steven Moreland7440ddb2016-12-15 16:13:39 -08001716 MYLOGD("Not dumping board info because it's not a zipped bugreport\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001717 return;
1718 }
1719
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001720 std::vector<std::string> paths;
1721 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07001722 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00001723 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
1724 kDumpstateBoardFiles[i].c_str()));
Nandana Dutt16d1aee2019-02-15 16:13:53 +00001725 remover.emplace_back(android::base::make_scope_guard(
1726 std::bind([](std::string path) { android::os::UnlinkAndLogOnError(path); }, paths[i])));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001727 }
Jie Song9fbfad02017-06-20 16:29:42 -07001728
Wei Wang587eac92018-04-05 12:17:20 -07001729 sp<IDumpstateDevice> dumpstate_device(IDumpstateDevice::getService());
1730 if (dumpstate_device == nullptr) {
1731 MYLOGE("No IDumpstateDevice implementation\n");
1732 return;
1733 }
1734
1735 using ScopedNativeHandle =
1736 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
1737 ScopedNativeHandle handle(native_handle_create(static_cast<int>(paths.size()), 0),
1738 [](native_handle_t* handle) {
1739 native_handle_close(handle);
1740 native_handle_delete(handle);
1741 });
1742 if (handle == nullptr) {
1743 MYLOGE("Could not create native_handle\n");
1744 return;
1745 }
1746
Nandana Duttbbdb5b42019-03-12 10:52:56 +00001747 // TODO(128270426): Check for consent in between?
Wei Wang587eac92018-04-05 12:17:20 -07001748 for (size_t i = 0; i < paths.size(); i++) {
1749 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
1750
1751 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
1752 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1753 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1754 if (fd < 0) {
1755 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
1756 return;
1757 }
1758 handle.get()->data[i] = fd.release();
1759 }
1760
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001761 // Given that bugreport is required to diagnose failures, it's better to
Wei Wang587eac92018-04-05 12:17:20 -07001762 // set an arbitrary amount of timeout for IDumpstateDevice than to block the
1763 // rest of bugreport. In the timeout case, we will kill dumpstate board HAL
1764 // and grab whatever dumped
1765 std::packaged_task<bool()>
1766 dumpstate_task([paths, dumpstate_device, &handle]() -> bool {
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001767 android::hardware::Return<void> status = dumpstate_device->dumpstateBoard(handle.get());
1768 if (!status.isOk()) {
1769 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
Wei Wang587eac92018-04-05 12:17:20 -07001770 return false;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001771 }
Wei Wang587eac92018-04-05 12:17:20 -07001772 return true;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001773 });
Wei Wang587eac92018-04-05 12:17:20 -07001774
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001775 auto result = dumpstate_task.get_future();
1776 std::thread(std::move(dumpstate_task)).detach();
Wei Wang587eac92018-04-05 12:17:20 -07001777
1778 constexpr size_t timeout_sec = 30;
1779 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
1780 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate vendor HAL\n", timeout_sec);
1781 if (!android::base::SetProperty("ctl.interface_restart",
1782 android::base::StringPrintf("%s/default",
1783 IDumpstateDevice::descriptor))) {
1784 MYLOGE("Couldn't restart dumpstate HAL\n");
1785 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001786 }
Wei Wang587eac92018-04-05 12:17:20 -07001787 // Wait some time for init to kill dumpstate vendor HAL
1788 constexpr size_t killing_timeout_sec = 10;
1789 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
1790 MYLOGE("killing dumpstateBoard timed out after %zus, continue and "
1791 "there might be racing in content\n", killing_timeout_sec);
1792 }
1793
1794 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
1795 for (size_t i = 0; i < paths.size(); i++) {
1796 struct stat s;
1797 if (fstat(handle.get()->data[i], &s) == -1) {
1798 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(),
1799 strerror(errno));
1800 file_sizes[i] = -1;
1801 continue;
1802 }
1803 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001804 }
1805
1806 for (size_t i = 0; i < paths.size(); i++) {
1807 if (file_sizes[i] == -1) {
1808 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07001809 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001810 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07001811 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001812 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07001813 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001814 AddZipEntry(kDumpstateBoardFiles[i], paths[i]);
Jie Song9fbfad02017-06-20 16:29:42 -07001815 }
1816
Felipe Lemed8b94e52016-12-08 10:21:44 -08001817 printf("*** See dumpstate-board.txt entry ***\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001818}
1819
Nandana Dutt12ae14a2019-01-09 10:35:53 +00001820static void ShowUsage() {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001821 fprintf(stderr,
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001822 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-d] [-p] "
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001823 "[-z]] [-s] [-S] [-q] [-B] [-P] [-R] [-V version]\n"
1824 " -h: display this help message\n"
1825 " -b: play sound file instead of vibrate, at beginning of job\n"
1826 " -e: play sound file instead of vibrate, at end of job\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001827 " -d: append date to filename\n"
1828 " -p: capture screenshot to filename.png\n"
1829 " -z: generate zipped file\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001830 " -s: write output to control socket (for init)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001831 " -S: write file location to control socket (for init; requires -z)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001832 " -q: disable vibrate\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001833 " -B: send broadcast when finished\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001834 " -P: send broadcast when started and update system properties on "
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001835 "progress (requires -B)\n"
1836 " -R: take bugreport in remote mode (requires -z, -d and -B, "
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001837 "shouldn't be used with -P)\n"
Nandana Dutt235864b2019-01-22 12:10:16 +00001838 " -w: start binder service and make it wait for a call to startBugreport\n"
Felipe Lemed071c682016-10-20 16:48:00 -07001839 " -v: prints the dumpstate header and exit\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001840}
1841
Wei Liuf87959e2016-08-26 14:51:42 -07001842static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07001843 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07001844}
1845
Felipe Leme1d486fe2016-10-14 18:06:47 -07001846bool Dumpstate::FinishZipFile() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001847 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07001848 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07001849 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07001850 // Final timestamp
1851 char date[80];
1852 time_t the_real_now_please_stand_up = time(nullptr);
1853 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07001854 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001855 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07001856
Felipe Leme9a523ae2016-10-20 15:10:33 -07001857 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001858 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08001859 return false;
1860 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07001861 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001862 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08001863 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08001864 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08001865
Felipe Leme0f3fb202016-06-10 17:10:53 -07001866 // Add log file (which contains stderr output) to zip...
1867 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07001868 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07001869 MYLOGE("Failed to add dumpstate log to .zip file\n");
1870 return false;
1871 }
Nandana Dutt979388e2018-11-30 16:48:55 +00001872 // TODO: Should truncate the existing file.
1873 // ... and re-open it for further logging.
Nandana Dutta344cb62019-02-22 15:12:35 +00001874 if (!redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()))) {
1875 return false;
1876 }
Felipe Leme0f3fb202016-06-10 17:10:53 -07001877 fprintf(stderr, "\n");
1878
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07001879 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07001880 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07001881 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08001882 return false;
1883 }
1884
Felipe Leme1d486fe2016-10-14 18:06:47 -07001885 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
1886 ds.zip_file.reset(nullptr);
1887
Felipe Lemee9d2c542016-11-15 11:48:26 -08001888 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
Nandana Dutt16d1aee2019-02-15 16:13:53 +00001889 android::os::UnlinkAndLogOnError(tmp_path_);
Felipe Lemec4eee562016-04-21 15:42:55 -07001890
Felipe Leme1e9edc62015-12-21 16:02:13 -08001891 return true;
1892}
Felipe Leme6e01fa62015-11-11 19:35:14 -08001893
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -07001894static std::string SHA256_file_hash(const std::string& filepath) {
Andreas Gampe27cd7b22016-07-18 18:24:05 -07001895 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(filepath.c_str(), O_RDONLY | O_NONBLOCK
1896 | O_CLOEXEC | O_NOFOLLOW)));
Andreas Gampeaff68432016-07-18 18:01:27 -07001897 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001898 MYLOGE("open(%s): %s\n", filepath.c_str(), strerror(errno));
Yi Kong19d5c002018-07-20 13:39:55 -07001899 return nullptr;
Michal Karpinski4db754f2015-12-11 18:04:32 +00001900 }
1901
1902 SHA256_CTX ctx;
Elliott Hughesc4dc1412016-04-12 16:28:31 -07001903 SHA256_Init(&ctx);
Michal Karpinski4db754f2015-12-11 18:04:32 +00001904
1905 std::vector<uint8_t> buffer(65536);
1906 while (1) {
1907 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd.get(), buffer.data(), buffer.size()));
1908 if (bytes_read == 0) {
1909 break;
1910 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001911 MYLOGE("read(%s): %s\n", filepath.c_str(), strerror(errno));
Yi Kong19d5c002018-07-20 13:39:55 -07001912 return nullptr;
Michal Karpinski4db754f2015-12-11 18:04:32 +00001913 }
1914
Elliott Hughesc4dc1412016-04-12 16:28:31 -07001915 SHA256_Update(&ctx, buffer.data(), bytes_read);
Michal Karpinski4db754f2015-12-11 18:04:32 +00001916 }
1917
Elliott Hughesc4dc1412016-04-12 16:28:31 -07001918 uint8_t hash[SHA256_DIGEST_LENGTH];
1919 SHA256_Final(hash, &ctx);
1920
1921 char hash_buffer[SHA256_DIGEST_LENGTH * 2 + 1];
1922 for(size_t i = 0; i < SHA256_DIGEST_LENGTH; i++) {
Michal Karpinskicbbdf732016-01-07 20:45:02 +00001923 sprintf(hash_buffer + (i * 2), "%02x", hash[i]);
Michal Karpinski4db754f2015-12-11 18:04:32 +00001924 }
1925 hash_buffer[sizeof(hash_buffer) - 1] = 0;
1926 return std::string(hash_buffer);
1927}
1928
Felipe Lemea4ef1f02017-02-15 17:27:40 -08001929static void SendBroadcast(const std::string& action, const std::vector<std::string>& args) {
1930 // clang-format off
1931 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user", "0",
1932 "--receiver-foreground", "--receiver-include-background", "-a", action};
1933 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08001934
1935 am.insert(am.end(), args.begin(), args.end());
1936
Felipe Leme8d2410e2017-02-08 09:46:08 -08001937 RunCommand("", am,
1938 CommandOptions::WithTimeout(20)
1939 .Log("Sending broadcast: '%s'\n")
1940 .Always()
1941 .DropRoot()
1942 .RedirectStderr()
1943 .Build());
1944}
1945
Felipe Leme35b8cf12017-02-10 15:47:29 -08001946static void Vibrate(int duration_ms) {
1947 // clang-format off
Chris Friese7e95fb2019-06-14 14:47:59 +00001948 RunCommand("", {"cmd", "vibrator", "vibrate", std::to_string(duration_ms), "dumpstate"},
Felipe Leme35b8cf12017-02-10 15:47:29 -08001949 CommandOptions::WithTimeout(10)
1950 .Log("Vibrate: '%s'\n")
1951 .Always()
1952 .Build());
1953 // clang-format on
1954}
1955
Nandana Dutt979388e2018-11-30 16:48:55 +00001956static void MaybeResolveSymlink(std::string* path) {
1957 std::string resolved_path;
1958 if (android::base::Readlink(*path, &resolved_path)) {
1959 *path = resolved_path;
1960 }
1961}
1962
Nandana Dutt4be45d12018-09-26 15:04:23 +01001963/*
1964 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
1965 * if we are writing zip files and adds the version file.
1966 */
1967static void PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00001968 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
1969
Nandana Dutt4be45d12018-09-26 15:04:23 +01001970 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
1971 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt9a76d202019-01-21 15:56:48 +00001972 ds.base_name_ = StringPrintf("bugreport-%s-%s", device_name.c_str(), build_id.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01001973 if (ds.options_->do_add_date) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01001974 char date[80];
1975 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
1976 ds.name_ = date;
1977 } else {
1978 ds.name_ = "undated";
1979 }
1980
Nandana Dutt5fb117b2018-09-27 09:23:36 +01001981 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01001982 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01001983 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01001984 ds.base_name_ += "-wifi";
1985 }
1986
Nandana Dutt5fb117b2018-09-27 09:23:36 +01001987 if (ds.options_->do_fb) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01001988 ds.screenshot_path_ = ds.GetPath(".png");
1989 }
1990 ds.tmp_path_ = ds.GetPath(".tmp");
1991 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
1992
Nandana Dutt54dbd672019-01-11 12:58:05 +00001993 std::string destination = ds.options_->bugreport_fd.get() != -1
1994 ? StringPrintf("[fd:%d]", ds.options_->bugreport_fd.get())
Nandana Dutt9a76d202019-01-21 15:56:48 +00001995 : ds.bugreport_internal_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01001996 MYLOGD(
1997 "Bugreport dir: %s\n"
1998 "Base name: %s\n"
1999 "Suffix: %s\n"
2000 "Log path: %s\n"
2001 "Temporary path: %s\n"
2002 "Screenshot path: %s\n",
Nandana Dutt9a76d202019-01-21 15:56:48 +00002003 destination.c_str(), ds.base_name_.c_str(), ds.name_.c_str(), ds.log_path_.c_str(),
2004 ds.tmp_path_.c_str(), ds.screenshot_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002005
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002006 if (ds.options_->do_zip_file) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002007 ds.path_ = ds.GetPath(".zip");
2008 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
2009 create_parent_dirs(ds.path_.c_str());
2010 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
2011 if (ds.zip_file == nullptr) {
2012 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
2013 } else {
2014 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
2015 }
2016 ds.AddTextZipEntry("version.txt", ds.version_);
2017 }
2018}
2019
2020/*
2021 * Finalizes writing to the file by renaming or zipping the tmp file to the final location,
2022 * printing zipped file status, etc.
2023 */
2024static void FinalizeFile() {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002025 /* check if user changed the suffix using system properties */
2026 std::string name =
2027 android::base::GetProperty(android::base::StringPrintf("dumpstate.%d.name", ds.pid_), "");
2028 bool change_suffix = false;
2029 if (!name.empty()) {
2030 /* must whitelist which characters are allowed, otherwise it could cross directories */
2031 std::regex valid_regex("^[-_a-zA-Z0-9]+$");
2032 if (std::regex_match(name.c_str(), valid_regex)) {
2033 change_suffix = true;
2034 } else {
2035 MYLOGE("invalid suffix provided by user: %s\n", name.c_str());
2036 }
2037 }
2038 if (change_suffix) {
2039 MYLOGI("changing suffix from %s to %s\n", ds.name_.c_str(), name.c_str());
2040 ds.name_ = name;
2041 if (!ds.screenshot_path_.empty()) {
2042 std::string new_screenshot_path = ds.GetPath(".png");
2043 if (rename(ds.screenshot_path_.c_str(), new_screenshot_path.c_str())) {
2044 MYLOGE("rename(%s, %s): %s\n", ds.screenshot_path_.c_str(),
2045 new_screenshot_path.c_str(), strerror(errno));
2046 } else {
2047 ds.screenshot_path_ = new_screenshot_path;
2048 }
2049 }
2050 }
2051
2052 bool do_text_file = true;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002053 if (ds.options_->do_zip_file) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002054 if (!ds.FinishZipFile()) {
2055 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
2056 do_text_file = true;
2057 } else {
2058 do_text_file = false;
Nandana Dutt383d0c12018-11-30 15:54:56 +00002059 // If the user has changed the suffix, we need to change the zip file name.
2060 std::string new_path = ds.GetPath(".zip");
2061 if (ds.path_ != new_path) {
2062 MYLOGD("Renaming zip file from %s to %s\n", ds.path_.c_str(), new_path.c_str());
2063 if (rename(ds.path_.c_str(), new_path.c_str())) {
2064 MYLOGE("rename(%s, %s): %s\n", ds.path_.c_str(), new_path.c_str(),
2065 strerror(errno));
2066 } else {
2067 ds.path_ = new_path;
2068 }
2069 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01002070 }
2071 }
2072 if (do_text_file) {
2073 ds.path_ = ds.GetPath(".txt");
2074 MYLOGD("Generating .txt bugreport at %s from %s\n", ds.path_.c_str(), ds.tmp_path_.c_str());
2075 if (rename(ds.tmp_path_.c_str(), ds.path_.c_str())) {
2076 MYLOGE("rename(%s, %s): %s\n", ds.tmp_path_.c_str(), ds.path_.c_str(), strerror(errno));
2077 ds.path_.clear();
2078 }
2079 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002080 if (ds.options_->use_control_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002081 if (do_text_file) {
2082 dprintf(ds.control_socket_fd_,
2083 "FAIL:could not create zip file, check %s "
2084 "for more details\n",
2085 ds.log_path_.c_str());
2086 } else {
2087 dprintf(ds.control_socket_fd_, "OK:%s\n", ds.path_.c_str());
2088 }
2089 }
2090}
2091
2092/* Broadcasts that we are done with the bugreport */
2093static void SendBugreportFinishedBroadcast() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002094 // TODO(b/111441001): use callback instead of broadcast.
Nandana Dutt9a76d202019-01-21 15:56:48 +00002095 if (!ds.path_.empty()) {
2096 MYLOGI("Final bugreport path: %s\n", ds.path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002097 // clang-format off
2098
2099 std::vector<std::string> am_args = {
2100 "--receiver-permission", "android.permission.DUMP",
2101 "--ei", "android.intent.extra.ID", std::to_string(ds.id_),
2102 "--ei", "android.intent.extra.PID", std::to_string(ds.pid_),
2103 "--ei", "android.intent.extra.MAX", std::to_string(ds.progress_->GetMax()),
Nandana Dutt9a76d202019-01-21 15:56:48 +00002104 "--es", "android.intent.extra.BUGREPORT", ds.path_,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002105 "--es", "android.intent.extra.DUMPSTATE_LOG", ds.log_path_
2106 };
2107 // clang-format on
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +00002108 if (ds.options_->do_fb && !android::os::IsFileEmpty(ds.screenshot_path_)) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002109 am_args.push_back("--es");
2110 am_args.push_back("android.intent.extra.SCREENSHOT");
2111 am_args.push_back(ds.screenshot_path_);
2112 }
Nandana Dutt15b89d72018-11-16 14:14:12 +00002113 if (!ds.options_->notification_title.empty()) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002114 am_args.push_back("--es");
2115 am_args.push_back("android.intent.extra.TITLE");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002116 am_args.push_back(ds.options_->notification_title);
2117 if (!ds.options_->notification_description.empty()) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002118 am_args.push_back("--es");
2119 am_args.push_back("android.intent.extra.DESCRIPTION");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002120 am_args.push_back(ds.options_->notification_description);
Nandana Dutt4be45d12018-09-26 15:04:23 +01002121 }
2122 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002123 if (ds.options_->is_remote_mode) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002124 am_args.push_back("--es");
2125 am_args.push_back("android.intent.extra.REMOTE_BUGREPORT_HASH");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002126 am_args.push_back(SHA256_file_hash(ds.path_));
Nandana Dutt4be45d12018-09-26 15:04:23 +01002127 SendBroadcast("com.android.internal.intent.action.REMOTE_BUGREPORT_FINISHED", am_args);
2128 } else {
2129 SendBroadcast("com.android.internal.intent.action.BUGREPORT_FINISHED", am_args);
2130 }
2131 } else {
2132 MYLOGE("Skipping finished broadcast because bugreport could not be generated\n");
2133 }
2134}
2135
Nandana Dutt58d72e22018-11-16 10:30:48 +00002136static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2137 switch (mode) {
2138 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2139 return "BUGREPORT_FULL";
2140 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2141 return "BUGREPORT_INTERACTIVE";
2142 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2143 return "BUGREPORT_REMOTE";
2144 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2145 return "BUGREPORT_WEAR";
2146 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2147 return "BUGREPORT_TELEPHONY";
2148 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2149 return "BUGREPORT_WIFI";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002150 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2151 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002152 }
2153}
2154
2155static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options) {
Abhijeet Kaur8ca245e2018-12-12 10:34:21 +00002156 options->extra_options = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002157 switch (mode) {
2158 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2159 options->do_broadcast = true;
2160 options->do_fb = true;
2161 break;
2162 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002163 // Currently, the dumpstate binder is only used by Shell to update progress.
2164 options->do_start_service = true;
2165 options->do_progress_updates = true;
2166 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002167 options->do_broadcast = true;
2168 break;
2169 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002170 options->do_vibrate = false;
2171 options->is_remote_mode = true;
2172 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002173 options->do_broadcast = true;
2174 break;
2175 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002176 options->do_start_service = true;
2177 options->do_progress_updates = true;
2178 options->do_zip_file = true;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002179 options->do_fb = true;
2180 options->do_broadcast = true;
2181 break;
2182 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002183 options->telephony_only = true;
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +00002184 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002185 options->do_broadcast = true;
2186 break;
2187 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002188 options->wifi_only = true;
2189 options->do_zip_file = true;
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +00002190 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002191 options->do_broadcast = true;
2192 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002193 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2194 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002195 }
2196}
2197
2198static Dumpstate::BugreportMode getBugreportModeFromProperty() {
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002199 // If the system property is not set, it's assumed to be a default bugreport.
2200 Dumpstate::BugreportMode mode = Dumpstate::BugreportMode::BUGREPORT_DEFAULT;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002201
2202 std::string extra_options = android::base::GetProperty(PROPERTY_EXTRA_OPTIONS, "");
2203 if (!extra_options.empty()) {
2204 // Framework uses a system property to override some command-line args.
2205 // Currently, it contains the type of the requested bugreport.
2206 if (extra_options == "bugreportplus") {
2207 mode = Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002208 } else if (extra_options == "bugreportfull") {
2209 mode = Dumpstate::BugreportMode::BUGREPORT_FULL;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002210 } else if (extra_options == "bugreportremote") {
2211 mode = Dumpstate::BugreportMode::BUGREPORT_REMOTE;
2212 } else if (extra_options == "bugreportwear") {
2213 mode = Dumpstate::BugreportMode::BUGREPORT_WEAR;
2214 } else if (extra_options == "bugreporttelephony") {
2215 mode = Dumpstate::BugreportMode::BUGREPORT_TELEPHONY;
2216 } else if (extra_options == "bugreportwifi") {
2217 mode = Dumpstate::BugreportMode::BUGREPORT_WIFI;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002218 } else {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002219 MYLOGE("Unknown extra option: %s\n", extra_options.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002220 }
2221 // Reset the property
2222 android::base::SetProperty(PROPERTY_EXTRA_OPTIONS, "");
2223 }
Nandana Dutt58d72e22018-11-16 10:30:48 +00002224 return mode;
2225}
2226
2227// TODO: Move away from system properties when we have options passed via binder calls.
2228/* Sets runtime options from the system properties and then clears those properties. */
2229static void SetOptionsFromProperties(Dumpstate::DumpOptions* options) {
2230 Dumpstate::BugreportMode mode = getBugreportModeFromProperty();
2231 SetOptionsFromMode(mode, options);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002232
2233 options->notification_title = android::base::GetProperty(PROPERTY_EXTRA_TITLE, "");
2234 if (!options->notification_title.empty()) {
2235 // Reset the property
2236 android::base::SetProperty(PROPERTY_EXTRA_TITLE, "");
2237
Nandana Duttdd8cca32018-11-14 10:10:29 +00002238 options->notification_description =
2239 android::base::GetProperty(PROPERTY_EXTRA_DESCRIPTION, "");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002240 if (!options->notification_description.empty()) {
2241 // Reset the property
2242 android::base::SetProperty(PROPERTY_EXTRA_DESCRIPTION, "");
2243 }
2244 MYLOGD("notification (title: %s, description: %s)\n", options->notification_title.c_str(),
2245 options->notification_description.c_str());
2246 }
2247}
2248
Nandana Dutt58d72e22018-11-16 10:30:48 +00002249static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
2250 MYLOGI("do_zip_file: %d\n", options.do_zip_file);
2251 MYLOGI("do_add_date: %d\n", options.do_add_date);
2252 MYLOGI("do_vibrate: %d\n", options.do_vibrate);
2253 MYLOGI("use_socket: %d\n", options.use_socket);
2254 MYLOGI("use_control_socket: %d\n", options.use_control_socket);
2255 MYLOGI("do_fb: %d\n", options.do_fb);
2256 MYLOGI("do_broadcast: %d\n", options.do_broadcast);
2257 MYLOGI("is_remote_mode: %d\n", options.is_remote_mode);
2258 MYLOGI("show_header_only: %d\n", options.show_header_only);
2259 MYLOGI("do_start_service: %d\n", options.do_start_service);
2260 MYLOGI("telephony_only: %d\n", options.telephony_only);
2261 MYLOGI("wifi_only: %d\n", options.wifi_only);
2262 MYLOGI("do_progress_updates: %d\n", options.do_progress_updates);
Nandana Dutt54dbd672019-01-11 12:58:05 +00002263 MYLOGI("fd: %d\n", options.bugreport_fd.get());
Nandana Dutt58d72e22018-11-16 10:30:48 +00002264 MYLOGI("extra_options: %s\n", options.extra_options.c_str());
2265 MYLOGI("args: %s\n", options.args.c_str());
2266 MYLOGI("notification_title: %s\n", options.notification_title.c_str());
2267 MYLOGI("notification_description: %s\n", options.notification_description.c_str());
2268}
2269
Nandana Dutt54dbd672019-01-11 12:58:05 +00002270void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode,
2271 const android::base::unique_fd& bugreport_fd_in,
2272 const android::base::unique_fd& screenshot_fd_in) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002273 // In the new API world, date is always added; output is always a zip file.
2274 // TODO(111441001): remove these options once they are obsolete.
2275 do_add_date = true;
2276 do_zip_file = true;
2277
Nandana Dutt54dbd672019-01-11 12:58:05 +00002278 // Duplicate the fds because the passed in fds don't outlive the binder transaction.
2279 bugreport_fd.reset(dup(bugreport_fd_in.get()));
2280 screenshot_fd.reset(dup(screenshot_fd_in.get()));
Nandana Dutt58d72e22018-11-16 10:30:48 +00002281
2282 extra_options = ModeToString(bugreport_mode);
2283 SetOptionsFromMode(bugreport_mode, this);
2284}
2285
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002286Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
2287 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002288 int c;
Nandana Dutt235864b2019-01-22 12:10:16 +00002289 while ((c = getopt(argc, argv, "dho:svqzpPBRSV:w")) != -1) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002290 switch (c) {
2291 // clang-format off
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002292 case 'd': do_add_date = true; break;
2293 case 'z': do_zip_file = true; break;
Nandana Dutt9a76d202019-01-21 15:56:48 +00002294 // o=use_outfile not supported anymore.
2295 // TODO(b/111441001): Remove when all callers have migrated.
2296 case 'o': break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002297 case 's': use_socket = true; break;
2298 case 'S': use_control_socket = true; break;
2299 case 'v': show_header_only = true; break;
2300 case 'q': do_vibrate = false; break;
2301 case 'p': do_fb = true; break;
2302 case 'P': do_progress_updates = true; break;
2303 case 'R': is_remote_mode = true; break;
2304 case 'B': do_broadcast = true; break;
2305 case 'V': break; // compatibility no-op
Nandana Dutt235864b2019-01-22 12:10:16 +00002306 case 'w':
2307 // This was already processed
2308 break;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002309 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002310 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002311 break;
2312 default:
2313 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002314 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002315 break;
2316 // clang-format on
2317 }
2318 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08002319
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002320 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002321 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002322 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002323 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002324 }
2325 }
2326
2327 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
2328 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002329
2330 SetOptionsFromProperties(this);
2331 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002332}
2333
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002334bool Dumpstate::DumpOptions::ValidateOptions() const {
Nandana Dutt54dbd672019-01-11 12:58:05 +00002335 if (bugreport_fd.get() != -1 && !do_zip_file) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002336 return false;
2337 }
2338
Nandana Dutt9a76d202019-01-21 15:56:48 +00002339 if ((do_zip_file || do_add_date || do_progress_updates || do_broadcast) && !OutputToFile()) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002340 return false;
2341 }
2342
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002343 if (use_control_socket && !do_zip_file) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002344 return false;
2345 }
2346
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002347 if (do_progress_updates && !do_broadcast) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002348 return false;
2349 }
2350
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002351 if (is_remote_mode && (do_progress_updates || !do_broadcast || !do_zip_file || !do_add_date)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002352 return false;
2353 }
2354 return true;
2355}
2356
Nandana Dutt197661d2018-11-16 16:40:21 +00002357void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
2358 options_ = std::move(options);
2359}
2360
Nandana Duttd2f5f082019-01-18 17:13:52 +00002361Dumpstate::RunStatus Dumpstate::Run(int32_t calling_uid, const std::string& calling_package) {
2362 Dumpstate::RunStatus status = RunInternal(calling_uid, calling_package);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002363 if (listener_ != nullptr) {
2364 switch (status) {
2365 case Dumpstate::RunStatus::OK:
Nandana Duttcc4ead82019-01-23 08:29:23 +00002366 listener_->onFinished();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002367 break;
2368 case Dumpstate::RunStatus::HELP:
2369 break;
2370 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002371 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_INVALID_INPUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002372 break;
2373 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002374 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_RUNTIME_ERROR);
2375 break;
2376 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2377 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_DENIED_CONSENT);
2378 break;
2379 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
2380 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_CONSENT_TIMED_OUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002381 break;
2382 }
2383 }
2384 return status;
2385}
2386
Nandana Dutt979388e2018-11-30 16:48:55 +00002387/*
2388 * Dumps relevant information to a bugreport based on the given options.
2389 *
2390 * The bugreport can be dumped to a file or streamed to a socket.
2391 *
2392 * How dumping to file works:
2393 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
2394 * stderr is redirected a log file.
2395 *
2396 * The temporary bugreport is then populated via printfs, dumping contents of files and
2397 * output of commands to stdout.
2398 *
2399 * If zipping, the temporary bugreport file is added to the zip archive. Else it's renamed to final
2400 * text file.
2401 *
2402 * If zipping, a bunch of other files and dumps also get added to the zip archive. The log file also
2403 * gets added to the archive.
2404 *
Nandana Dutt9a76d202019-01-21 15:56:48 +00002405 * Bugreports are first generated in a local directory and later copied to the caller's fd if
2406 * supplied.
Nandana Dutt979388e2018-11-30 16:48:55 +00002407 */
Nandana Duttd2f5f082019-01-18 17:13:52 +00002408Dumpstate::RunStatus Dumpstate::RunInternal(int32_t calling_uid,
2409 const std::string& calling_package) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002410 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00002411 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002412 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002413 return RunStatus::INVALID_INPUT;
2414 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002415 /* set as high priority, and protect from OOM killer */
2416 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002417
Felipe Lemed071c682016-10-20 16:48:00 -07002418 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002419 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002420 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002421 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002422 } else {
2423 /* fallback to kernels <= 2.6.35 */
2424 oom_adj = fopen("/proc/self/oom_adj", "we");
2425 if (oom_adj) {
2426 fputs("-17", oom_adj);
2427 fclose(oom_adj);
2428 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002429 }
2430
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002431 if (version_ == VERSION_DEFAULT) {
2432 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00002433 }
2434
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002435 if (version_ != VERSION_CURRENT && version_ != VERSION_SPLIT_ANR) {
Vishnu Nair64afc022018-02-01 15:29:34 -08002436 MYLOGE("invalid version requested ('%s'); suppported values are: ('%s', '%s', '%s')\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002437 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str(),
Vishnu Nair64afc022018-02-01 15:29:34 -08002438 VERSION_SPLIT_ANR.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002439 return RunStatus::INVALID_INPUT;
Felipe Lemed071c682016-10-20 16:48:00 -07002440 }
2441
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002442 if (options_->show_header_only) {
2443 PrintHeader();
2444 return RunStatus::OK;
Felipe Lemed071c682016-10-20 16:48:00 -07002445 }
2446
Nandana Duttd2f5f082019-01-18 17:13:52 +00002447 if (options_->bugreport_fd.get() != -1) {
2448 // If the output needs to be copied over to the caller's fd, get user consent.
2449 android::String16 package(calling_package.c_str());
2450 CheckUserConsent(calling_uid, package);
2451 }
2452
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002453 // Redirect output if needed
Nandana Dutt9a76d202019-01-21 15:56:48 +00002454 bool is_redirecting = options_->OutputToFile();
Felipe Leme7447d7c2016-11-03 18:12:22 -07002455
2456 // TODO: temporarily set progress until it's part of the Dumpstate constructor
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002457 std::string stats_path =
Nandana Dutt979388e2018-11-30 16:48:55 +00002458 is_redirecting
2459 ? android::base::StringPrintf("%s/dumpstate-stats.txt", bugreport_internal_dir_.c_str())
2460 : "";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002461 progress_.reset(new Progress(stats_path));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002462
Felipe Lemed071c682016-10-20 16:48:00 -07002463 /* gets the sequential id */
Felipe Leme7447d7c2016-11-03 18:12:22 -07002464 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002465 id_ = ++last_id;
Felipe Lemed071c682016-10-20 16:48:00 -07002466 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
2467
2468 MYLOGI("begin\n");
2469
Sahana Raof35ed432019-07-12 10:47:52 +01002470 if (acquire_wake_lock(PARTIAL_WAKE_LOCK, WAKE_LOCK_NAME) < 0) {
2471 MYLOGE("Failed to acquire wake lock: %s\n", strerror(errno));
2472 } else {
2473 // Wake lock will be released automatically on process death
2474 MYLOGD("Wake lock acquired.\n");
2475 }
2476
Felipe Leme6ae5c4f2017-01-10 14:13:22 -08002477 register_sig_handler();
Felipe Lemed071c682016-10-20 16:48:00 -07002478
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002479 // TODO(b/111441001): maybe skip if already started?
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002480 if (options_->do_start_service) {
Felipe Leme75876a22016-10-27 16:31:27 -07002481 MYLOGI("Starting 'dumpstate' service\n");
2482 android::status_t ret;
2483 if ((ret = android::os::DumpstateService::Start()) != android::OK) {
2484 MYLOGE("Unable to start DumpstateService: %d\n", ret);
2485 }
2486 }
2487
Felipe Lemef0292972016-11-22 13:57:05 -08002488 if (PropertiesHelper::IsDryRun()) {
Felipe Lemed071c682016-10-20 16:48:00 -07002489 MYLOGI("Running on dry-run mode (to disable it, call 'setprop dumpstate.dry_run false')\n");
2490 }
2491
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002492 MYLOGI("dumpstate info: id=%d, args='%s', extra_options= %s)\n", id_, options_->args.c_str(),
2493 options_->extra_options.c_str());
Felipe Lemed071c682016-10-20 16:48:00 -07002494
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002495 MYLOGI("bugreport format version: %s\n", version_.c_str());
Felipe Leme809d74e2016-02-02 12:57:00 -08002496
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002497 do_early_screenshot_ = options_->do_progress_updates;
Felipe Lemee338bf62015-12-07 14:03:50 -08002498
Christopher Ferrised9354f2014-10-01 17:35:01 -07002499 // If we are going to use a socket, do it as early as possible
2500 // to avoid timeouts from bugreport.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002501 if (options_->use_socket) {
Nandana Dutta344cb62019-02-22 15:12:35 +00002502 if (!redirect_to_socket(stdout, "dumpstate")) {
2503 return ERROR;
2504 }
Christopher Ferrised9354f2014-10-01 17:35:01 -07002505 }
2506
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002507 if (options_->use_control_socket) {
Felipe Leme2628e9e2016-04-12 16:36:51 -07002508 MYLOGD("Opening control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002509 control_socket_fd_ = open_socket("dumpstate");
Nandana Dutta344cb62019-02-22 15:12:35 +00002510 if (control_socket_fd_ == -1) {
2511 return ERROR;
2512 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002513 options_->do_progress_updates = 1;
Felipe Leme2628e9e2016-04-12 16:36:51 -07002514 }
2515
Felipe Leme71bbfc52015-11-23 14:14:51 -08002516 if (is_redirecting) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002517 PrepareToWriteToFile();
Felipe Leme1e9edc62015-12-21 16:02:13 -08002518
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002519 if (options_->do_progress_updates) {
2520 if (options_->do_broadcast) {
Felipe Lemedcd1f0d2016-08-04 12:48:50 -07002521 // clang-format off
2522 std::vector<std::string> am_args = {
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002523 "--receiver-permission", "android.permission.DUMP",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002524 "--es", "android.intent.extra.NAME", name_,
2525 "--ei", "android.intent.extra.ID", std::to_string(id_),
2526 "--ei", "android.intent.extra.PID", std::to_string(pid_),
2527 "--ei", "android.intent.extra.MAX", std::to_string(progress_->GetMax()),
Felipe Lemedcd1f0d2016-08-04 12:48:50 -07002528 };
2529 // clang-format on
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002530 SendBroadcast("com.android.internal.intent.action.BUGREPORT_STARTED", am_args);
Felipe Lemedcd1f0d2016-08-04 12:48:50 -07002531 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002532 if (options_->use_control_socket) {
2533 dprintf(control_socket_fd_, "BEGIN:%s\n", path_.c_str());
Felipe Lemeaabfcae2016-07-29 09:49:04 -07002534 }
Felipe Leme71bbfc52015-11-23 14:14:51 -08002535 }
2536 }
2537
Nick Kralevichf3599b32016-01-25 15:05:16 -08002538 /* read /proc/cmdline before dropping root */
2539 FILE *cmdline = fopen("/proc/cmdline", "re");
2540 if (cmdline) {
2541 fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
2542 fclose(cmdline);
2543 }
2544
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002545 if (options_->do_vibrate) {
Felipe Leme35b8cf12017-02-10 15:47:29 -08002546 Vibrate(150);
John Michelau1f794c42012-09-17 11:20:19 -05002547 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002548
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002549 if (options_->do_fb && do_early_screenshot_) {
Greg Kaiser3ddc3fa2019-05-23 16:14:52 -07002550 MYLOGI("taking early screenshot\n");
2551 TakeScreenshot();
Felipe Lemee338bf62015-12-07 14:03:50 -08002552 }
2553
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002554 if (options_->do_zip_file && zip_file != nullptr) {
2555 if (chown(path_.c_str(), AID_SHELL, AID_SHELL)) {
2556 MYLOGE("Unable to change ownership of zip file %s: %s\n", path_.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -07002557 strerror(errno));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002558 }
2559 }
2560
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002561 int dup_stdout_fd;
2562 int dup_stderr_fd;
Felipe Leme71bbfc52015-11-23 14:14:51 -08002563 if (is_redirecting) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002564 // Redirect stderr to log_path_ for debugging.
Vishnu Nair20cf5032018-01-05 13:15:49 -08002565 TEMP_FAILURE_RETRY(dup_stderr_fd = dup(fileno(stderr)));
Nandana Dutta344cb62019-02-22 15:12:35 +00002566 if (!redirect_to_file(stderr, const_cast<char*>(log_path_.c_str()))) {
2567 return ERROR;
2568 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002569 if (chown(log_path_.c_str(), AID_SHELL, AID_SHELL)) {
2570 MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n", log_path_.c_str(),
2571 strerror(errno));
Felipe Leme6fe9db62016-02-12 09:04:16 -08002572 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002573
2574 // Redirect stdout to tmp_path_. This is the main bugreport entry and will be
2575 // moved into zip file later, if zipping.
Vishnu Nair20cf5032018-01-05 13:15:49 -08002576 TEMP_FAILURE_RETRY(dup_stdout_fd = dup(fileno(stdout)));
Nandana Dutt979388e2018-11-30 16:48:55 +00002577 // TODO: why not write to a file instead of stdout to overcome this problem?
Felipe Leme6e01fa62015-11-11 19:35:14 -08002578 /* TODO: rather than generating a text file now and zipping it later,
2579 it would be more efficient to redirect stdout to the zip entry
2580 directly, but the libziparchive doesn't support that option yet. */
Nandana Dutta344cb62019-02-22 15:12:35 +00002581 if (!redirect_to_file(stdout, const_cast<char*>(tmp_path_.c_str()))) {
2582 return ERROR;
2583 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002584 if (chown(tmp_path_.c_str(), AID_SHELL, AID_SHELL)) {
Felipe Leme6fe9db62016-02-12 09:04:16 -08002585 MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002586 tmp_path_.c_str(), strerror(errno));
Felipe Leme6fe9db62016-02-12 09:04:16 -08002587 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002588 }
Felipe Lemed8b94e52016-12-08 10:21:44 -08002589
2590 // Don't buffer stdout
2591 setvbuf(stdout, nullptr, _IONBF, 0);
2592
Felipe Leme608385d2016-02-01 10:35:38 -08002593 // NOTE: there should be no stdout output until now, otherwise it would break the header.
2594 // In particular, DurationReport objects should be created passing 'title, NULL', so their
Felipe Lemecbce55d2016-02-08 09:53:18 -08002595 // duration is logged into MYLOG instead.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002596 PrintHeader();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002597
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002598 if (options_->telephony_only) {
Jayachandran Ca94c7172017-06-10 15:08:12 -07002599 DumpstateTelephonyOnly();
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002600 DumpstateBoard();
2601 } else if (options_->wifi_only) {
mukesh agrawal253dad42018-01-23 21:59:59 -08002602 DumpstateWifiOnly();
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002603 } else {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002604 // Dump state for the default case. This also drops root.
Nandana Duttbbdb5b42019-03-12 10:52:56 +00002605 RunStatus s = DumpstateDefault();
2606 if (s != RunStatus::OK) {
Nandana Duttaac6f582019-07-26 14:32:47 +01002607 if (s == RunStatus::USER_CONSENT_DENIED) {
Nandana Duttbbdb5b42019-03-12 10:52:56 +00002608 HandleUserConsentDenied();
2609 }
2610 return s;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002611 }
Zhengyin Qian068ecc72016-08-10 16:48:14 -07002612 }
Felipe Leme71a74ac2016-03-17 15:43:25 -07002613
Felipe Leme55b42a62015-11-10 17:39:08 -08002614 /* close output if needed */
Felipe Leme71bbfc52015-11-23 14:14:51 -08002615 if (is_redirecting) {
Vishnu Nair20cf5032018-01-05 13:15:49 -08002616 TEMP_FAILURE_RETRY(dup2(dup_stdout_fd, fileno(stdout)));
Colin Crossf45fa6b2012-03-26 12:38:26 -07002617 }
2618
Nandana Duttd2f5f082019-01-18 17:13:52 +00002619 // Rename, and/or zip the (now complete) .tmp file within the internal directory.
Nandana Dutt9a76d202019-01-21 15:56:48 +00002620 if (options_->OutputToFile()) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002621 FinalizeFile();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002622 }
2623
Nandana Duttd2f5f082019-01-18 17:13:52 +00002624 // Share the final file with the caller if the user has consented.
2625 Dumpstate::RunStatus status = Dumpstate::RunStatus::OK;
2626 if (options_->bugreport_fd.get() != -1) {
2627 status = CopyBugreportIfUserConsented();
2628 if (status != Dumpstate::RunStatus::OK &&
2629 status != Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2630 // Do an early return if there were errors. We make an exception for consent
2631 // timing out because it's possible the user got distracted. In this case the
2632 // bugreport is not shared but made available for manual retrieval.
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002633 MYLOGI("User denied consent. Returning\n");
Nandana Duttd2f5f082019-01-18 17:13:52 +00002634 return status;
2635 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002636 if (options_->do_fb && options_->screenshot_fd.get() != -1) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00002637 bool copy_succeeded = android::os::CopyFileToFd(screenshot_path_,
2638 options_->screenshot_fd.get());
2639 if (copy_succeeded) {
2640 android::os::UnlinkAndLogOnError(screenshot_path_);
2641 }
2642 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002643 if (status == Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2644 MYLOGI(
2645 "Did not receive user consent yet."
2646 " Will not copy the bugreport artifacts to caller.\n");
Abhijeet Kaur57627412019-04-17 16:00:09 +01002647 const String16 incidentcompanion("incidentcompanion");
2648 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
2649 if (ics != nullptr) {
2650 MYLOGD("Canceling user consent request via incidentcompanion service\n");
2651 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
2652 consent_callback_.get());
2653 } else {
2654 MYLOGD("Unable to cancel user consent; incidentcompanion service unavailable\n");
2655 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002656 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00002657 }
2658
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002659 /* vibrate a few but shortly times to let user know it's finished */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002660 if (options_->do_vibrate) {
Takuya Ogawa47f644e2017-12-20 18:09:09 +09002661 for (int i = 0; i < 3; i++) {
2662 Vibrate(75);
2663 usleep((75 + 50) * 1000);
2664 }
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002665 }
2666
Jeff Brown1dc94e32014-09-11 14:15:27 -07002667 /* tell activity manager we're done */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002668 if (options_->do_broadcast) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002669 SendBugreportFinishedBroadcast();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002670 // Note that listener_ is notified in Run();
Jeff Sharkey27f9e6d2013-03-13 15:45:50 -07002671 }
2672
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002673 MYLOGD("Final progress: %d/%d (estimated %d)\n", progress_->Get(), progress_->GetMax(),
2674 progress_->GetInitialMax());
2675 progress_->Save();
2676 MYLOGI("done (id %d)\n", id_);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002677
Felipe Leme107a05f2016-03-08 15:11:15 -08002678 if (is_redirecting) {
Vishnu Nair20cf5032018-01-05 13:15:49 -08002679 TEMP_FAILURE_RETRY(dup2(dup_stderr_fd, fileno(stderr)));
Felipe Leme107a05f2016-03-08 15:11:15 -08002680 }
2681
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002682 if (options_->use_control_socket && control_socket_fd_ != -1) {
Felipe Lemee844a9d2016-09-21 15:01:39 -07002683 MYLOGD("Closing control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002684 close(control_socket_fd_);
Felipe Leme2628e9e2016-04-12 16:36:51 -07002685 }
2686
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002687 tombstone_data_.clear();
2688 anr_data_.clear();
Narayan Kamath6b9516c2017-10-27 11:15:51 +01002689
Nandana Duttd2f5f082019-01-18 17:13:52 +00002690 return (consent_callback_ != nullptr &&
2691 consent_callback_->getResult() == UserConsentResult::UNAVAILABLE)
2692 ? USER_CONSENT_TIMED_OUT
2693 : RunStatus::OK;
2694}
2695
2696void Dumpstate::CheckUserConsent(int32_t calling_uid, const android::String16& calling_package) {
2697 consent_callback_ = new ConsentCallback();
2698 const String16 incidentcompanion("incidentcompanion");
2699 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
2700 if (ics != nullptr) {
2701 MYLOGD("Checking user consent via incidentcompanion service\n");
2702 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
2703 calling_uid, calling_package, 0x1 /* FLAG_CONFIRMATION_DIALOG */,
2704 consent_callback_.get());
2705 } else {
2706 MYLOGD("Unable to check user consent; incidentcompanion service unavailable\n");
2707 }
2708}
2709
Nandana Duttbbdb5b42019-03-12 10:52:56 +00002710bool Dumpstate::IsUserConsentDenied() const {
2711 return ds.consent_callback_ != nullptr &&
2712 ds.consent_callback_->getResult() == UserConsentResult::DENIED;
2713}
2714
Nandana Duttd2f5f082019-01-18 17:13:52 +00002715void Dumpstate::CleanupFiles() {
2716 android::os::UnlinkAndLogOnError(tmp_path_);
2717 android::os::UnlinkAndLogOnError(screenshot_path_);
2718 android::os::UnlinkAndLogOnError(path_);
2719}
2720
2721Dumpstate::RunStatus Dumpstate::HandleUserConsentDenied() {
2722 MYLOGD("User denied consent; deleting files and returning\n");
2723 CleanupFiles();
2724 return USER_CONSENT_DENIED;
2725}
2726
2727Dumpstate::RunStatus Dumpstate::CopyBugreportIfUserConsented() {
2728 // If the caller has asked to copy the bugreport over to their directory, we need explicit
2729 // user consent.
2730 UserConsentResult consent_result = consent_callback_->getResult();
2731 if (consent_result == UserConsentResult::UNAVAILABLE) {
2732 // User has not responded yet.
2733 uint64_t elapsed_ms = consent_callback_->getElapsedTimeMs();
2734 if (elapsed_ms < USER_CONSENT_TIMEOUT_MS) {
2735 uint delay_seconds = (USER_CONSENT_TIMEOUT_MS - elapsed_ms) / 1000;
2736 MYLOGD("Did not receive user consent yet; going to wait for %d seconds", delay_seconds);
2737 sleep(delay_seconds);
2738 }
2739 consent_result = consent_callback_->getResult();
2740 }
2741 if (consent_result == UserConsentResult::DENIED) {
2742 // User has explicitly denied sharing with the app. To be safe delete the
2743 // internal bugreport & tmp files.
2744 return HandleUserConsentDenied();
2745 }
2746 if (consent_result == UserConsentResult::APPROVED) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00002747 bool copy_succeeded = android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
2748 if (copy_succeeded) {
2749 android::os::UnlinkAndLogOnError(path_);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002750 }
2751 return copy_succeeded ? Dumpstate::RunStatus::OK : Dumpstate::RunStatus::ERROR;
2752 } else if (consent_result == UserConsentResult::UNAVAILABLE) {
2753 // consent_result is still UNAVAILABLE. The user has likely not responded yet.
2754 // Since we do not have user consent to share the bugreport it does not get
2755 // copied over to the calling app but remains in the internal directory from
2756 // where the user can manually pull it.
2757 return Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT;
2758 }
2759 // Unknown result; must be a programming error.
2760 MYLOGE("Unknown user consent result:%d\n", consent_result);
2761 return Dumpstate::RunStatus::ERROR;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002762}
2763
Nandana Duttf02564e2019-02-15 15:24:24 +00002764Dumpstate::RunStatus Dumpstate::ParseCommandlineAndRun(int argc, char* argv[]) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002765 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
2766 Dumpstate::RunStatus status = options->Initialize(argc, argv);
2767 if (status == Dumpstate::RunStatus::OK) {
Nandana Duttf02564e2019-02-15 15:24:24 +00002768 SetOptions(std::move(options));
Nandana Duttd2f5f082019-01-18 17:13:52 +00002769 // When directly running dumpstate binary, the output is not expected to be written
2770 // to any external file descriptor.
Nandana Duttf02564e2019-02-15 15:24:24 +00002771 assert(options_->bugreport_fd.get() == -1);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002772
2773 // calling_uid and calling_package are for user consent to share the bugreport with
2774 // an app; they are irrelvant here because bugreport is only written to a local
2775 // directory, and not shared.
Nandana Duttf02564e2019-02-15 15:24:24 +00002776 status = Run(-1 /* calling_uid */, "" /* calling_package */);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002777 }
Nandana Duttf02564e2019-02-15 15:24:24 +00002778 return status;
2779}
2780
2781/* Main entry point for dumpstate binary. */
2782int run_main(int argc, char* argv[]) {
2783 Dumpstate::RunStatus status = ds.ParseCommandlineAndRun(argc, argv);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002784
2785 switch (status) {
2786 case Dumpstate::RunStatus::OK:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002787 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002788 case Dumpstate::RunStatus::HELP:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002789 ShowUsage();
2790 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002791 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002792 fprintf(stderr, "Invalid combination of args\n");
2793 ShowUsage();
2794 exit(1);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002795 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002796 FALLTHROUGH_INTENDED;
2797 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2798 FALLTHROUGH_INTENDED;
2799 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002800 exit(2);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002801 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002802}
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002803
2804// TODO(111441001): Default DumpOptions to sensible values.
2805Dumpstate::Dumpstate(const std::string& version)
2806 : pid_(getpid()),
2807 options_(new Dumpstate::DumpOptions()),
Nandana Duttf02cd782019-06-14 14:25:13 +01002808 last_reported_percent_progress_(0),
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002809 version_(version),
2810 now_(time(nullptr)) {
2811}
2812
2813Dumpstate& Dumpstate::GetInstance() {
2814 static Dumpstate singleton_(android::base::GetProperty("dumpstate.version", VERSION_CURRENT));
2815 return singleton_;
2816}
2817
Nandana Dutt8d945c02019-08-14 13:30:07 +01002818DurationReporter::DurationReporter(const std::string& title, bool logcat_only, bool verbose)
2819 : title_(title), logcat_only_(logcat_only), verbose_(verbose) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002820 if (!title_.empty()) {
2821 started_ = Nanotime();
2822 }
2823}
2824
2825DurationReporter::~DurationReporter() {
2826 if (!title_.empty()) {
2827 float elapsed = (float)(Nanotime() - started_) / NANOS_PER_SEC;
Nandana Dutt8d945c02019-08-14 13:30:07 +01002828 if (elapsed < .5f && !verbose_) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002829 return;
2830 }
2831 MYLOGD("Duration of '%s': %.2fs\n", title_.c_str(), elapsed);
2832 if (logcat_only_) {
2833 return;
2834 }
2835 // Use "Yoda grammar" to make it easier to grep|sort sections.
2836 printf("------ %.3fs was the duration of '%s' ------\n", elapsed, title_.c_str());
2837 }
2838}
2839
2840const int32_t Progress::kDefaultMax = 5000;
2841
2842Progress::Progress(const std::string& path) : Progress(Progress::kDefaultMax, 1.1, path) {
2843}
2844
2845Progress::Progress(int32_t initial_max, int32_t progress, float growth_factor)
2846 : Progress(initial_max, growth_factor, "") {
2847 progress_ = progress;
2848}
2849
2850Progress::Progress(int32_t initial_max, float growth_factor, const std::string& path)
2851 : initial_max_(initial_max),
2852 progress_(0),
2853 max_(initial_max),
2854 growth_factor_(growth_factor),
2855 n_runs_(0),
2856 average_max_(0),
2857 path_(path) {
2858 if (!path_.empty()) {
2859 Load();
2860 }
2861}
2862
2863void Progress::Load() {
2864 MYLOGD("Loading stats from %s\n", path_.c_str());
2865 std::string content;
2866 if (!android::base::ReadFileToString(path_, &content)) {
2867 MYLOGI("Could not read stats from %s; using max of %d\n", path_.c_str(), max_);
2868 return;
2869 }
2870 if (content.empty()) {
2871 MYLOGE("No stats (empty file) on %s; using max of %d\n", path_.c_str(), max_);
2872 return;
2873 }
2874 std::vector<std::string> lines = android::base::Split(content, "\n");
2875
2876 if (lines.size() < 1) {
2877 MYLOGE("Invalid stats on file %s: not enough lines (%d). Using max of %d\n", path_.c_str(),
2878 (int)lines.size(), max_);
2879 return;
2880 }
2881 char* ptr;
2882 n_runs_ = strtol(lines[0].c_str(), &ptr, 10);
2883 average_max_ = strtol(ptr, nullptr, 10);
2884 if (n_runs_ <= 0 || average_max_ <= 0 || n_runs_ > STATS_MAX_N_RUNS ||
2885 average_max_ > STATS_MAX_AVERAGE) {
2886 MYLOGE("Invalid stats line on file %s: %s\n", path_.c_str(), lines[0].c_str());
2887 initial_max_ = Progress::kDefaultMax;
2888 } else {
2889 initial_max_ = average_max_;
2890 }
2891 max_ = initial_max_;
2892
2893 MYLOGI("Average max progress: %d in %d runs; estimated max: %d\n", average_max_, n_runs_, max_);
2894}
2895
2896void Progress::Save() {
2897 int32_t total = n_runs_ * average_max_ + progress_;
2898 int32_t runs = n_runs_ + 1;
2899 int32_t average = floor(((float)total) / runs);
2900 MYLOGI("Saving stats (total=%d, runs=%d, average=%d) on %s\n", total, runs, average,
2901 path_.c_str());
2902 if (path_.empty()) {
2903 return;
2904 }
2905
2906 std::string content = android::base::StringPrintf("%d %d\n", runs, average);
2907 if (!android::base::WriteStringToFile(content, path_)) {
2908 MYLOGE("Could not save stats on %s\n", path_.c_str());
2909 }
2910}
2911
2912int32_t Progress::Get() const {
2913 return progress_;
2914}
2915
2916bool Progress::Inc(int32_t delta_sec) {
2917 bool changed = false;
2918 if (delta_sec >= 0) {
2919 progress_ += delta_sec;
2920 if (progress_ > max_) {
2921 int32_t old_max = max_;
2922 max_ = floor((float)progress_ * growth_factor_);
2923 MYLOGD("Adjusting max progress from %d to %d\n", old_max, max_);
2924 changed = true;
2925 }
2926 }
2927 return changed;
2928}
2929
2930int32_t Progress::GetMax() const {
2931 return max_;
2932}
2933
2934int32_t Progress::GetInitialMax() const {
2935 return initial_max_;
2936}
2937
2938void Progress::Dump(int fd, const std::string& prefix) const {
2939 const char* pr = prefix.c_str();
2940 dprintf(fd, "%sprogress: %d\n", pr, progress_);
2941 dprintf(fd, "%smax: %d\n", pr, max_);
2942 dprintf(fd, "%sinitial_max: %d\n", pr, initial_max_);
2943 dprintf(fd, "%sgrowth_factor: %0.2f\n", pr, growth_factor_);
2944 dprintf(fd, "%spath: %s\n", pr, path_.c_str());
2945 dprintf(fd, "%sn_runs: %d\n", pr, n_runs_);
2946 dprintf(fd, "%saverage_max: %d\n", pr, average_max_);
2947}
2948
2949bool Dumpstate::IsZipping() const {
2950 return zip_writer_ != nullptr;
2951}
2952
2953std::string Dumpstate::GetPath(const std::string& suffix) const {
2954 return GetPath(bugreport_internal_dir_, suffix);
2955}
2956
2957std::string Dumpstate::GetPath(const std::string& directory, const std::string& suffix) const {
2958 return android::base::StringPrintf("%s/%s-%s%s", directory.c_str(), base_name_.c_str(),
2959 name_.c_str(), suffix.c_str());
2960}
2961
2962void Dumpstate::SetProgress(std::unique_ptr<Progress> progress) {
2963 progress_ = std::move(progress);
2964}
2965
2966void for_each_userid(void (*func)(int), const char *header) {
2967 std::string title = header == nullptr ? "for_each_userid" : android::base::StringPrintf(
2968 "for_each_userid(%s)", header);
2969 DurationReporter duration_reporter(title);
2970 if (PropertiesHelper::IsDryRun()) return;
2971
2972 DIR *d;
2973 struct dirent *de;
2974
2975 if (header) printf("\n------ %s ------\n", header);
2976 func(0);
2977
2978 if (!(d = opendir("/data/system/users"))) {
2979 printf("Failed to open /data/system/users (%s)\n", strerror(errno));
2980 return;
2981 }
2982
2983 while ((de = readdir(d))) {
2984 int userid;
2985 if (de->d_type != DT_DIR || !(userid = atoi(de->d_name))) {
2986 continue;
2987 }
2988 func(userid);
2989 }
2990
2991 closedir(d);
2992}
2993
2994static void __for_each_pid(void (*helper)(int, const char *, void *), const char *header, void *arg) {
2995 DIR *d;
2996 struct dirent *de;
2997
2998 if (!(d = opendir("/proc"))) {
2999 printf("Failed to open /proc (%s)\n", strerror(errno));
3000 return;
3001 }
3002
3003 if (header) printf("\n------ %s ------\n", header);
3004 while ((de = readdir(d))) {
3005 if (ds.IsUserConsentDenied()) {
3006 MYLOGE(
3007 "Returning early because user denied consent to share bugreport with calling app.");
3008 closedir(d);
3009 return;
3010 }
3011 int pid;
3012 int fd;
3013 char cmdpath[255];
3014 char cmdline[255];
3015
3016 if (!(pid = atoi(de->d_name))) {
3017 continue;
3018 }
3019
3020 memset(cmdline, 0, sizeof(cmdline));
3021
3022 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/cmdline", pid);
3023 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3024 TEMP_FAILURE_RETRY(read(fd, cmdline, sizeof(cmdline) - 2));
3025 close(fd);
3026 if (cmdline[0]) {
3027 helper(pid, cmdline, arg);
3028 continue;
3029 }
3030 }
3031
3032 // if no cmdline, a kernel thread has comm
3033 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/comm", pid);
3034 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3035 TEMP_FAILURE_RETRY(read(fd, cmdline + 1, sizeof(cmdline) - 4));
3036 close(fd);
3037 if (cmdline[1]) {
3038 cmdline[0] = '[';
3039 size_t len = strcspn(cmdline, "\f\b\r\n");
3040 cmdline[len] = ']';
3041 cmdline[len+1] = '\0';
3042 }
3043 }
3044 if (!cmdline[0]) {
3045 strcpy(cmdline, "N/A");
3046 }
3047 helper(pid, cmdline, arg);
3048 }
3049
3050 closedir(d);
3051}
3052
3053static void for_each_pid_helper(int pid, const char *cmdline, void *arg) {
3054 for_each_pid_func *func = (for_each_pid_func*) arg;
3055 func(pid, cmdline);
3056}
3057
3058void for_each_pid(for_each_pid_func func, const char *header) {
3059 std::string title = header == nullptr ? "for_each_pid"
3060 : android::base::StringPrintf("for_each_pid(%s)", header);
3061 DurationReporter duration_reporter(title);
3062 if (PropertiesHelper::IsDryRun()) return;
3063
3064 __for_each_pid(for_each_pid_helper, header, (void *) func);
3065}
3066
3067static void for_each_tid_helper(int pid, const char *cmdline, void *arg) {
3068 DIR *d;
3069 struct dirent *de;
3070 char taskpath[255];
3071 for_each_tid_func *func = (for_each_tid_func *) arg;
3072
3073 snprintf(taskpath, sizeof(taskpath), "/proc/%d/task", pid);
3074
3075 if (!(d = opendir(taskpath))) {
3076 printf("Failed to open %s (%s)\n", taskpath, strerror(errno));
3077 return;
3078 }
3079
3080 func(pid, pid, cmdline);
3081
3082 while ((de = readdir(d))) {
3083 if (ds.IsUserConsentDenied()) {
3084 MYLOGE(
3085 "Returning early because user denied consent to share bugreport with calling app.");
3086 closedir(d);
3087 return;
3088 }
3089 int tid;
3090 int fd;
3091 char commpath[255];
3092 char comm[255];
3093
3094 if (!(tid = atoi(de->d_name))) {
3095 continue;
3096 }
3097
3098 if (tid == pid)
3099 continue;
3100
3101 snprintf(commpath, sizeof(commpath), "/proc/%d/comm", tid);
3102 memset(comm, 0, sizeof(comm));
3103 if ((fd = TEMP_FAILURE_RETRY(open(commpath, O_RDONLY | O_CLOEXEC))) < 0) {
3104 strcpy(comm, "N/A");
3105 } else {
3106 char *c;
3107 TEMP_FAILURE_RETRY(read(fd, comm, sizeof(comm) - 2));
3108 close(fd);
3109
3110 c = strrchr(comm, '\n');
3111 if (c) {
3112 *c = '\0';
3113 }
3114 }
3115 func(pid, tid, comm);
3116 }
3117
3118 closedir(d);
3119}
3120
3121void for_each_tid(for_each_tid_func func, const char *header) {
3122 std::string title = header == nullptr ? "for_each_tid"
3123 : android::base::StringPrintf("for_each_tid(%s)", header);
3124 DurationReporter duration_reporter(title);
3125
3126 if (PropertiesHelper::IsDryRun()) return;
3127
3128 __for_each_pid(for_each_tid_helper, header, (void *) func);
3129}
3130
3131void show_wchan(int pid, int tid, const char *name) {
3132 if (PropertiesHelper::IsDryRun()) return;
3133
3134 char path[255];
3135 char buffer[255];
3136 int fd, ret, save_errno;
3137 char name_buffer[255];
3138
3139 memset(buffer, 0, sizeof(buffer));
3140
3141 snprintf(path, sizeof(path), "/proc/%d/wchan", tid);
3142 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3143 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3144 return;
3145 }
3146
3147 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3148 save_errno = errno;
3149 close(fd);
3150
3151 if (ret < 0) {
3152 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3153 return;
3154 }
3155
3156 snprintf(name_buffer, sizeof(name_buffer), "%*s%s",
3157 pid == tid ? 0 : 3, "", name);
3158
3159 printf("%-7d %-32s %s\n", tid, name_buffer, buffer);
3160
3161 return;
3162}
3163
3164// print time in centiseconds
3165static void snprcent(char *buffer, size_t len, size_t spc,
3166 unsigned long long time) {
3167 static long hz; // cache discovered hz
3168
3169 if (hz <= 0) {
3170 hz = sysconf(_SC_CLK_TCK);
3171 if (hz <= 0) {
3172 hz = 1000;
3173 }
3174 }
3175
3176 // convert to centiseconds
3177 time = (time * 100 + (hz / 2)) / hz;
3178
3179 char str[16];
3180
3181 snprintf(str, sizeof(str), " %llu.%02u",
3182 time / 100, (unsigned)(time % 100));
3183 size_t offset = strlen(buffer);
3184 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3185 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3186}
3187
3188// print permille as a percent
3189static void snprdec(char *buffer, size_t len, size_t spc, unsigned permille) {
3190 char str[16];
3191
3192 snprintf(str, sizeof(str), " %u.%u%%", permille / 10, permille % 10);
3193 size_t offset = strlen(buffer);
3194 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3195 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3196}
3197
3198void show_showtime(int pid, const char *name) {
3199 if (PropertiesHelper::IsDryRun()) return;
3200
3201 char path[255];
3202 char buffer[1023];
3203 int fd, ret, save_errno;
3204
3205 memset(buffer, 0, sizeof(buffer));
3206
3207 snprintf(path, sizeof(path), "/proc/%d/stat", pid);
3208 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3209 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3210 return;
3211 }
3212
3213 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3214 save_errno = errno;
3215 close(fd);
3216
3217 if (ret < 0) {
3218 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3219 return;
3220 }
3221
3222 // field 14 is utime
3223 // field 15 is stime
3224 // field 42 is iotime
3225 unsigned long long utime = 0, stime = 0, iotime = 0;
3226 if (sscanf(buffer,
3227 "%*u %*s %*s %*d %*d %*d %*d %*d %*d %*d %*d "
3228 "%*d %*d %llu %llu %*d %*d %*d %*d %*d %*d "
3229 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %*d "
3230 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %llu ",
3231 &utime, &stime, &iotime) != 3) {
3232 return;
3233 }
3234
3235 unsigned long long total = utime + stime;
3236 if (!total) {
3237 return;
3238 }
3239
3240 unsigned permille = (iotime * 1000 + (total / 2)) / total;
3241 if (permille > 1000) {
3242 permille = 1000;
3243 }
3244
3245 // try to beautify and stabilize columns at <80 characters
3246 snprintf(buffer, sizeof(buffer), "%-6d%s", pid, name);
3247 if ((name[0] != '[') || utime) {
3248 snprcent(buffer, sizeof(buffer), 57, utime);
3249 }
3250 snprcent(buffer, sizeof(buffer), 65, stime);
3251 if ((name[0] != '[') || iotime) {
3252 snprcent(buffer, sizeof(buffer), 73, iotime);
3253 }
3254 if (iotime) {
3255 snprdec(buffer, sizeof(buffer), 79, permille);
3256 }
3257 puts(buffer); // adds a trailing newline
3258
3259 return;
3260}
3261
3262void do_dmesg() {
3263 const char *title = "KERNEL LOG (dmesg)";
3264 DurationReporter duration_reporter(title);
3265 printf("------ %s ------\n", title);
3266
3267 if (PropertiesHelper::IsDryRun()) return;
3268
3269 /* Get size of kernel buffer */
3270 int size = klogctl(KLOG_SIZE_BUFFER, nullptr, 0);
3271 if (size <= 0) {
3272 printf("Unexpected klogctl return value: %d\n\n", size);
3273 return;
3274 }
3275 char *buf = (char *) malloc(size + 1);
3276 if (buf == nullptr) {
3277 printf("memory allocation failed\n\n");
3278 return;
3279 }
3280 int retval = klogctl(KLOG_READ_ALL, buf, size);
3281 if (retval < 0) {
3282 printf("klogctl failure\n\n");
3283 free(buf);
3284 return;
3285 }
3286 buf[retval] = '\0';
3287 printf("%s\n\n", buf);
3288 free(buf);
3289 return;
3290}
3291
3292void do_showmap(int pid, const char *name) {
3293 char title[255];
3294 char arg[255];
3295
3296 snprintf(title, sizeof(title), "SHOW MAP %d (%s)", pid, name);
3297 snprintf(arg, sizeof(arg), "%d", pid);
3298 RunCommand(title, {"showmap", "-q", arg}, CommandOptions::AS_ROOT);
3299}
3300
3301int Dumpstate::DumpFile(const std::string& title, const std::string& path) {
3302 DurationReporter duration_reporter(title);
3303
3304 int status = DumpFileToFd(STDOUT_FILENO, title, path);
3305
3306 UpdateProgress(WEIGHT_FILE);
3307
3308 return status;
3309}
3310
3311int read_file_as_long(const char *path, long int *output) {
3312 int fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC));
3313 if (fd < 0) {
3314 int err = errno;
3315 MYLOGE("Error opening file descriptor for %s: %s\n", path, strerror(err));
3316 return -1;
3317 }
3318 char buffer[50];
3319 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3320 if (bytes_read == -1) {
3321 MYLOGE("Error reading file %s: %s\n", path, strerror(errno));
3322 return -2;
3323 }
3324 if (bytes_read == 0) {
3325 MYLOGE("File %s is empty\n", path);
3326 return -3;
3327 }
3328 *output = atoi(buffer);
3329 return 0;
3330}
3331
3332/* calls skip to gate calling dump_from_fd recursively
3333 * in the specified directory. dump_from_fd defaults to
3334 * dump_file_from_fd above when set to NULL. skip defaults
3335 * to false when set to NULL. dump_from_fd will always be
3336 * called with title NULL.
3337 */
3338int dump_files(const std::string& title, const char* dir, bool (*skip)(const char* path),
3339 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
3340 DurationReporter duration_reporter(title);
3341 DIR *dirp;
3342 struct dirent *d;
3343 char *newpath = nullptr;
3344 const char *slash = "/";
3345 int retval = 0;
3346
3347 if (!title.empty()) {
3348 printf("------ %s (%s) ------\n", title.c_str(), dir);
3349 }
3350 if (PropertiesHelper::IsDryRun()) return 0;
3351
3352 if (dir[strlen(dir) - 1] == '/') {
3353 ++slash;
3354 }
3355 dirp = opendir(dir);
3356 if (dirp == nullptr) {
3357 retval = -errno;
3358 MYLOGE("%s: %s\n", dir, strerror(errno));
3359 return retval;
3360 }
3361
3362 if (!dump_from_fd) {
3363 dump_from_fd = dump_file_from_fd;
3364 }
3365 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
3366 if ((d->d_name[0] == '.')
3367 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
3368 || (d->d_name[1] == '\0'))) {
3369 continue;
3370 }
3371 asprintf(&newpath, "%s%s%s%s", dir, slash, d->d_name,
3372 (d->d_type == DT_DIR) ? "/" : "");
3373 if (!newpath) {
3374 retval = -errno;
3375 continue;
3376 }
3377 if (skip && (*skip)(newpath)) {
3378 continue;
3379 }
3380 if (d->d_type == DT_DIR) {
3381 int ret = dump_files("", newpath, skip, dump_from_fd);
3382 if (ret < 0) {
3383 retval = ret;
3384 }
3385 continue;
3386 }
3387 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(newpath, O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
3388 if (fd.get() < 0) {
3389 retval = -1;
3390 printf("*** %s: %s\n", newpath, strerror(errno));
3391 continue;
3392 }
3393 (*dump_from_fd)(nullptr, newpath, fd.get());
3394 }
3395 closedir(dirp);
3396 if (!title.empty()) {
3397 printf("\n");
3398 }
3399 return retval;
3400}
3401
3402/* fd must have been opened with the flag O_NONBLOCK. With this flag set,
3403 * it's possible to avoid issues where opening the file itself can get
3404 * stuck.
3405 */
3406int dump_file_from_fd(const char *title, const char *path, int fd) {
3407 if (PropertiesHelper::IsDryRun()) return 0;
3408
3409 int flags = fcntl(fd, F_GETFL);
3410 if (flags == -1) {
3411 printf("*** %s: failed to get flags on fd %d: %s\n", path, fd, strerror(errno));
3412 return -1;
3413 } else if (!(flags & O_NONBLOCK)) {
3414 printf("*** %s: fd must have O_NONBLOCK set.\n", path);
3415 return -1;
3416 }
3417 return DumpFileFromFdToFd(title, path, fd, STDOUT_FILENO, PropertiesHelper::IsDryRun());
3418}
3419
3420int Dumpstate::RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Nandana Dutt8d945c02019-08-14 13:30:07 +01003421 const CommandOptions& options, bool verbose_duration) {
3422 DurationReporter duration_reporter(title, false /* logcat_only */, verbose_duration);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003423
3424 int status = RunCommandToFd(STDOUT_FILENO, title, full_command, options);
3425
3426 /* TODO: for now we're simplifying the progress calculation by using the
3427 * timeout as the weight. It's a good approximation for most cases, except when calling dumpsys,
3428 * where its weight should be much higher proportionally to its timeout.
3429 * Ideally, it should use a options.EstimatedDuration() instead...*/
3430 UpdateProgress(options.Timeout());
3431
3432 return status;
3433}
3434
3435void Dumpstate::RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsys_args,
3436 const CommandOptions& options, long dumpsysTimeoutMs) {
3437 long timeout_ms = dumpsysTimeoutMs > 0 ? dumpsysTimeoutMs : options.TimeoutInMs();
3438 std::vector<std::string> dumpsys = {"/system/bin/dumpsys", "-T", std::to_string(timeout_ms)};
3439 dumpsys.insert(dumpsys.end(), dumpsys_args.begin(), dumpsys_args.end());
3440 RunCommand(title, dumpsys, options);
3441}
3442
3443int open_socket(const char *service) {
3444 int s = android_get_control_socket(service);
3445 if (s < 0) {
3446 MYLOGE("android_get_control_socket(%s): %s\n", service, strerror(errno));
3447 return -1;
3448 }
3449 fcntl(s, F_SETFD, FD_CLOEXEC);
3450
3451 // Set backlog to 0 to make sure that queue size will be minimum.
3452 // In Linux, because the minimum queue will be 1, connect() will be blocked
3453 // if the other clients already called connect() and the connection request was not accepted.
3454 if (listen(s, 0) < 0) {
3455 MYLOGE("listen(control socket): %s\n", strerror(errno));
3456 return -1;
3457 }
3458
3459 struct sockaddr addr;
3460 socklen_t alen = sizeof(addr);
3461 int fd = accept(s, &addr, &alen);
3462
3463 // Close socket just after accept(), to make sure that connect() by client will get error
3464 // when the socket is used by the other services.
3465 // There is still a race condition possibility between accept and close, but there is no way
3466 // to close-on-accept atomically.
3467 // See detail; b/123306389#comment25
3468 close(s);
3469
3470 if (fd < 0) {
3471 MYLOGE("accept(control socket): %s\n", strerror(errno));
3472 return -1;
3473 }
3474
3475 return fd;
3476}
3477
3478/* redirect output to a service control socket */
3479bool redirect_to_socket(FILE* redirect, const char* service) {
3480 int fd = open_socket(service);
3481 if (fd == -1) {
3482 return false;
3483 }
3484 fflush(redirect);
3485 // TODO: handle dup2 failure
3486 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
3487 close(fd);
3488 return true;
3489}
3490
3491// TODO: should call is_valid_output_file and/or be merged into it.
3492void create_parent_dirs(const char *path) {
3493 char *chp = const_cast<char *> (path);
3494
3495 /* skip initial slash */
3496 if (chp[0] == '/')
3497 chp++;
3498
3499 /* create leading directories, if necessary */
3500 struct stat dir_stat;
3501 while (chp && chp[0]) {
3502 chp = strchr(chp, '/');
3503 if (chp) {
3504 *chp = 0;
3505 if (stat(path, &dir_stat) == -1 || !S_ISDIR(dir_stat.st_mode)) {
3506 MYLOGI("Creating directory %s\n", path);
3507 if (mkdir(path, 0770)) { /* drwxrwx--- */
3508 MYLOGE("Unable to create directory %s: %s\n", path, strerror(errno));
3509 } else if (chown(path, AID_SHELL, AID_SHELL)) {
3510 MYLOGE("Unable to change ownership of dir %s: %s\n", path, strerror(errno));
3511 }
3512 }
3513 *chp++ = '/';
3514 }
3515 }
3516}
3517
3518bool _redirect_to_file(FILE* redirect, char* path, int truncate_flag) {
3519 create_parent_dirs(path);
3520
3521 int fd = TEMP_FAILURE_RETRY(open(path,
3522 O_WRONLY | O_CREAT | truncate_flag | O_CLOEXEC | O_NOFOLLOW,
3523 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH));
3524 if (fd < 0) {
3525 MYLOGE("%s: %s\n", path, strerror(errno));
3526 return false;
3527 }
3528
3529 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
3530 close(fd);
3531 return true;
3532}
3533
3534bool redirect_to_file(FILE* redirect, char* path) {
3535 return _redirect_to_file(redirect, path, O_TRUNC);
3536}
3537
3538bool redirect_to_existing_file(FILE* redirect, char* path) {
3539 return _redirect_to_file(redirect, path, O_APPEND);
3540}
3541
3542void dump_route_tables() {
3543 DurationReporter duration_reporter("DUMP ROUTE TABLES");
3544 if (PropertiesHelper::IsDryRun()) return;
3545 const char* const RT_TABLES_PATH = "/data/misc/net/rt_tables";
3546 ds.DumpFile("RT_TABLES", RT_TABLES_PATH);
3547 FILE* fp = fopen(RT_TABLES_PATH, "re");
3548 if (!fp) {
3549 printf("*** %s: %s\n", RT_TABLES_PATH, strerror(errno));
3550 return;
3551 }
3552 char table[16];
3553 // Each line has an integer (the table number), a space, and a string (the table name). We only
3554 // need the table number. It's a 32-bit unsigned number, so max 10 chars. Skip the table name.
3555 // Add a fixed max limit so this doesn't go awry.
3556 for (int i = 0; i < 64 && fscanf(fp, " %10s %*s", table) == 1; ++i) {
3557 RunCommand("ROUTE TABLE IPv4", {"ip", "-4", "route", "show", "table", table});
3558 RunCommand("ROUTE TABLE IPv6", {"ip", "-6", "route", "show", "table", table});
3559 }
3560 fclose(fp);
3561}
3562
3563// TODO: make this function thread safe if sections are generated in parallel.
3564void Dumpstate::UpdateProgress(int32_t delta_sec) {
3565 if (progress_ == nullptr) {
3566 MYLOGE("UpdateProgress: progress_ not set\n");
3567 return;
3568 }
3569
3570 // Always update progess so stats can be tuned...
Nandana Duttf02cd782019-06-14 14:25:13 +01003571 progress_->Inc(delta_sec);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003572
3573 // ...but only notifiy listeners when necessary.
3574 if (!options_->do_progress_updates) return;
3575
3576 int progress = progress_->Get();
3577 int max = progress_->GetMax();
Nandana Duttf02cd782019-06-14 14:25:13 +01003578 int percent = 100 * progress / max;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003579
Nandana Duttf02cd782019-06-14 14:25:13 +01003580 if (last_reported_percent_progress_ > 0 && percent <= last_reported_percent_progress_) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003581 return;
3582 }
Nandana Duttf02cd782019-06-14 14:25:13 +01003583 last_reported_percent_progress_ = percent;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003584
3585 if (control_socket_fd_ >= 0) {
3586 dprintf(control_socket_fd_, "PROGRESS:%d/%d\n", progress, max);
3587 fsync(control_socket_fd_);
3588 }
3589
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003590 if (listener_ != nullptr) {
3591 if (percent % 5 == 0) {
3592 // We don't want to spam logcat, so only log multiples of 5.
3593 MYLOGD("Setting progress (%s): %d/%d (%d%%)\n", listener_name_.c_str(), progress, max,
3594 percent);
3595 } else {
3596 // stderr is ignored on normal invocations, but useful when calling
3597 // /system/bin/dumpstate directly for debuggging.
3598 fprintf(stderr, "Setting progress (%s): %d/%d (%d%%)\n", listener_name_.c_str(),
3599 progress, max, percent);
3600 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003601
3602 listener_->onProgress(percent);
3603 }
3604}
3605
3606void Dumpstate::TakeScreenshot(const std::string& path) {
3607 const std::string& real_path = path.empty() ? screenshot_path_ : path;
3608 int status =
3609 RunCommand("", {"/system/bin/screencap", "-p", real_path},
3610 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3611 if (status == 0) {
3612 MYLOGD("Screenshot saved on %s\n", real_path.c_str());
3613 } else {
3614 MYLOGE("Failed to take screenshot on %s\n", real_path.c_str());
3615 }
3616}
3617
3618bool is_dir(const char* pathname) {
3619 struct stat info;
3620 if (stat(pathname, &info) == -1) {
3621 return false;
3622 }
3623 return S_ISDIR(info.st_mode);
3624}
3625
3626time_t get_mtime(int fd, time_t default_mtime) {
3627 struct stat info;
3628 if (fstat(fd, &info) == -1) {
3629 return default_mtime;
3630 }
3631 return info.st_mtime;
3632}
3633
3634void dump_emmc_ecsd(const char *ext_csd_path) {
3635 // List of interesting offsets
3636 struct hex {
3637 char str[2];
3638 };
3639 static const size_t EXT_CSD_REV = 192 * sizeof(hex);
3640 static const size_t EXT_PRE_EOL_INFO = 267 * sizeof(hex);
3641 static const size_t EXT_DEVICE_LIFE_TIME_EST_TYP_A = 268 * sizeof(hex);
3642 static const size_t EXT_DEVICE_LIFE_TIME_EST_TYP_B = 269 * sizeof(hex);
3643
3644 std::string buffer;
3645 if (!android::base::ReadFileToString(ext_csd_path, &buffer)) {
3646 return;
3647 }
3648
3649 printf("------ %s Extended CSD ------\n", ext_csd_path);
3650
3651 if (buffer.length() < (EXT_CSD_REV + sizeof(hex))) {
3652 printf("*** %s: truncated content %zu\n\n", ext_csd_path, buffer.length());
3653 return;
3654 }
3655
3656 int ext_csd_rev = 0;
3657 std::string sub = buffer.substr(EXT_CSD_REV, sizeof(hex));
3658 if (sscanf(sub.c_str(), "%2x", &ext_csd_rev) != 1) {
3659 printf("*** %s: EXT_CSD_REV parse error \"%s\"\n\n", ext_csd_path, sub.c_str());
3660 return;
3661 }
3662
3663 static const char *ver_str[] = {
3664 "4.0", "4.1", "4.2", "4.3", "Obsolete", "4.41", "4.5", "5.0"
3665 };
3666 printf("rev 1.%d (MMC %s)\n", ext_csd_rev,
3667 (ext_csd_rev < (int)(sizeof(ver_str) / sizeof(ver_str[0]))) ? ver_str[ext_csd_rev]
3668 : "Unknown");
3669 if (ext_csd_rev < 7) {
3670 printf("\n");
3671 return;
3672 }
3673
3674 if (buffer.length() < (EXT_PRE_EOL_INFO + sizeof(hex))) {
3675 printf("*** %s: truncated content %zu\n\n", ext_csd_path, buffer.length());
3676 return;
3677 }
3678
3679 int ext_pre_eol_info = 0;
3680 sub = buffer.substr(EXT_PRE_EOL_INFO, sizeof(hex));
3681 if (sscanf(sub.c_str(), "%2x", &ext_pre_eol_info) != 1) {
3682 printf("*** %s: PRE_EOL_INFO parse error \"%s\"\n\n", ext_csd_path, sub.c_str());
3683 return;
3684 }
3685
3686 static const char *eol_str[] = {
3687 "Undefined",
3688 "Normal",
3689 "Warning (consumed 80% of reserve)",
3690 "Urgent (consumed 90% of reserve)"
3691 };
3692 printf(
3693 "PRE_EOL_INFO %d (MMC %s)\n", ext_pre_eol_info,
3694 eol_str[(ext_pre_eol_info < (int)(sizeof(eol_str) / sizeof(eol_str[0]))) ? ext_pre_eol_info
3695 : 0]);
3696
3697 for (size_t lifetime = EXT_DEVICE_LIFE_TIME_EST_TYP_A;
3698 lifetime <= EXT_DEVICE_LIFE_TIME_EST_TYP_B;
3699 lifetime += sizeof(hex)) {
3700 int ext_device_life_time_est;
3701 static const char *est_str[] = {
3702 "Undefined",
3703 "0-10% of device lifetime used",
3704 "10-20% of device lifetime used",
3705 "20-30% of device lifetime used",
3706 "30-40% of device lifetime used",
3707 "40-50% of device lifetime used",
3708 "50-60% of device lifetime used",
3709 "60-70% of device lifetime used",
3710 "70-80% of device lifetime used",
3711 "80-90% of device lifetime used",
3712 "90-100% of device lifetime used",
3713 "Exceeded the maximum estimated device lifetime",
3714 };
3715
3716 if (buffer.length() < (lifetime + sizeof(hex))) {
3717 printf("*** %s: truncated content %zu\n", ext_csd_path, buffer.length());
3718 break;
3719 }
3720
3721 ext_device_life_time_est = 0;
3722 sub = buffer.substr(lifetime, sizeof(hex));
3723 if (sscanf(sub.c_str(), "%2x", &ext_device_life_time_est) != 1) {
3724 printf("*** %s: DEVICE_LIFE_TIME_EST_TYP_%c parse error \"%s\"\n", ext_csd_path,
3725 (unsigned)((lifetime - EXT_DEVICE_LIFE_TIME_EST_TYP_A) / sizeof(hex)) + 'A',
3726 sub.c_str());
3727 continue;
3728 }
3729 printf("DEVICE_LIFE_TIME_EST_TYP_%c %d (MMC %s)\n",
3730 (unsigned)((lifetime - EXT_DEVICE_LIFE_TIME_EST_TYP_A) / sizeof(hex)) + 'A',
3731 ext_device_life_time_est,
3732 est_str[(ext_device_life_time_est < (int)(sizeof(est_str) / sizeof(est_str[0])))
3733 ? ext_device_life_time_est
3734 : 0]);
3735 }
3736
3737 printf("\n");
3738}
3739