blob: 78c09f2b5af7b9e4bf9de35b6541fb139b8b1938 [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>
Nikita Ioffea325a572019-05-16 19:49:47 +010022#include <inttypes.h>
Felipe Lemead5f6c42015-11-30 14:26:46 -080023#include <libgen.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070024#include <limits.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010025#include <math.h>
26#include <poll.h>
Mark Salyzyn8f37aa52015-06-12 12:28:24 -070027#include <stdbool.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070028#include <stdio.h>
29#include <stdlib.h>
30#include <string.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080031#include <sys/poll.h>
Christopher Ferris7dc7f322014-07-22 16:08:19 -070032#include <sys/prctl.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070033#include <sys/resource.h>
34#include <sys/stat.h>
35#include <sys/time.h>
36#include <sys/wait.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010037#include <signal.h>
38#include <stdarg.h>
39#include <string.h>
40#include <sys/capability.h>
41#include <sys/inotify.h>
42#include <sys/klog.h>
43#include <time.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070044#include <unistd.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070045
46#include <chrono>
Hridya Valsarajuac582cd2019-08-05 15:39:54 -070047#include <cmath>
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +000048#include <fstream>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070049#include <functional>
50#include <future>
Narayan Kamath8f788292017-05-25 13:20:39 +010051#include <memory>
Hridya Valsarajuac582cd2019-08-05 15:39:54 -070052#include <numeric>
Narayan Kamath8f788292017-05-25 13:20:39 +010053#include <regex>
54#include <set>
55#include <string>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070056#include <utility>
Narayan Kamath8f788292017-05-25 13:20:39 +010057#include <vector>
Colin Crossf45fa6b2012-03-26 12:38:26 -070058
Felipe Leme96c2bbb2016-09-26 09:21:21 -070059#include <android-base/file.h>
60#include <android-base/properties.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070061#include <android-base/scopeguard.h>
Elliott Hughes9dc117c2015-12-07 14:21:50 -080062#include <android-base/stringprintf.h>
Naveen Kalla058e1e82016-10-19 21:38:44 -070063#include <android-base/strings.h>
Andreas Gampeaff68432016-07-18 18:01:27 -070064#include <android-base/unique_fd.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010065#include <android/content/pm/IPackageManagerNative.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080066#include <android/hardware/dumpstate/1.0/IDumpstateDevice.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080067#include <android/hidl/manager/1.0/IServiceManager.h>
Nandana Duttd2f5f082019-01-18 17:13:52 +000068#include <android/os/IIncidentCompanion.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010069#include <binder/IServiceManager.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080070#include <cutils/native_handle.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070071#include <cutils/properties.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010072#include <cutils/sockets.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000073#include <debuggerd/client.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080074#include <dumpsys.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000075#include <dumputils/dump_utils.h>
Sahana Raof35ed432019-07-12 10:47:52 +010076#include <hardware_legacy/power.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080077#include <hidl/ServiceManagement.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010078#include <log/log.h>
Tom Cherryf4472f32020-08-05 09:31:17 -070079#include <log/log_read.h>
Felipe Leme75876a22016-10-27 16:31:27 -070080#include <openssl/sha.h>
Mark Salyzyn6c3d90f2016-09-27 14:55:27 -070081#include <private/android_filesystem_config.h>
82#include <private/android_logger.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080083#include <serviceutils/PriorityDumper.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070084#include <utils/StrongPointer.h>
Felipe Lemef0292972016-11-22 13:57:05 -080085#include "DumpstateInternal.h"
Felipe Leme75876a22016-10-27 16:31:27 -070086#include "DumpstateService.h"
Colin Crossf45fa6b2012-03-26 12:38:26 -070087#include "dumpstate.h"
Felipe Leme6e01fa62015-11-11 19:35:14 -080088
Steven Morelandcb7ef822016-11-29 13:20:37 -080089using ::android::hardware::dumpstate::V1_0::IDumpstateDevice;
Vishnu Naire97d6122018-01-18 13:58:56 -080090using ::std::literals::chrono_literals::operator""ms;
91using ::std::literals::chrono_literals::operator""s;
Steven Morelandcb7ef822016-11-29 13:20:37 -080092
Felipe Leme47e9be22016-12-21 15:37:07 -080093// TODO: remove once moved to namespace
Vishnu Naire97d6122018-01-18 13:58:56 -080094using android::defaultServiceManager;
95using android::Dumpsys;
96using android::INVALID_OPERATION;
97using android::IServiceManager;
98using android::OK;
99using android::sp;
100using android::status_t;
101using android::String16;
102using android::String8;
103using android::TIMED_OUT;
104using android::UNKNOWN_ERROR;
105using android::Vector;
Nandana Dutt979388e2018-11-30 16:48:55 +0000106using android::base::StringPrintf;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000107using android::os::IDumpstateListener;
Felipe Leme47e9be22016-12-21 15:37:07 -0800108using android::os::dumpstate::CommandOptions;
109using android::os::dumpstate::DumpFileToFd;
Vishnu Naire97d6122018-01-18 13:58:56 -0800110using android::os::dumpstate::PropertiesHelper;
Felipe Leme47e9be22016-12-21 15:37:07 -0800111
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100112// Keep in sync with
113// frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
114static const int TRACE_DUMP_TIMEOUT_MS = 10000; // 10 seconds
115
116/* Most simple commands have 10 as timeout, so 5 is a good estimate */
117static const int32_t WEIGHT_FILE = 5;
118
119// TODO: temporary variables and functions used during C++ refactoring
120static Dumpstate& ds = Dumpstate::GetInstance();
121static int RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Nandana Dutt8d945c02019-08-14 13:30:07 +0100122 const CommandOptions& options = CommandOptions::DEFAULT,
123 bool verbose_duration = false) {
124 return ds.RunCommand(title, full_command, options, verbose_duration);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100125}
126
127// Reasonable value for max stats.
128static const int STATS_MAX_N_RUNS = 1000;
129static const long STATS_MAX_AVERAGE = 100000;
130
131CommandOptions Dumpstate::DEFAULT_DUMPSYS = CommandOptions::WithTimeout(30).Build();
132
Nandana Duttd2f5f082019-01-18 17:13:52 +0000133typedef Dumpstate::ConsentCallback::ConsentResult UserConsentResult;
134
Colin Crossf45fa6b2012-03-26 12:38:26 -0700135/* read before root is shed */
136static char cmdline_buf[16384] = "(unknown)";
Yi Kong19d5c002018-07-20 13:39:55 -0700137static const char *dump_traces_path = nullptr;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000138static const uint64_t USER_CONSENT_TIMEOUT_MS = 30 * 1000;
Hunter Knepshield70610fa2020-01-03 15:27:33 -0800139// Because telephony reports are significantly faster to collect (< 10 seconds vs. > 2 minutes),
140// it's often the case that they time out far too quickly for consent with such a hefty dialog for
141// the user to read. For telephony reports only, we increase the default timeout to 2 minutes to
142// roughly match full reports' durations.
143static const uint64_t TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS = 2 * 60 * 1000;
Colin Crossf45fa6b2012-03-26 12:38:26 -0700144
Felipe Leme1d486fe2016-10-14 18:06:47 -0700145// TODO: variables and functions below should be part of dumpstate object
146
Felipe Leme635ca312016-01-05 14:23:02 -0800147static std::set<std::string> mount_points;
148void add_mountinfo();
Felipe Leme78f2c862015-12-21 09:55:22 -0800149
Todd Poynor2a83daa2013-11-22 15:44:22 -0800150#define PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops"
Mark Salyzyn7d0a7622016-06-24 14:06:15 -0700151#define ALT_PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops-0"
Wei Wang509bb5d2017-06-09 14:42:12 -0700152#define BLK_DEV_SYS_DIR "/sys/block"
Todd Poynor2a83daa2013-11-22 15:44:22 -0800153
Felipe Lemee82a27d2016-01-05 13:35:44 -0800154#define RECOVERY_DIR "/cache/recovery"
Mark Salyzynd6ab0112016-03-25 12:56:39 -0700155#define RECOVERY_DATA_DIR "/data/misc/recovery"
Tianjie Xu75d53362018-04-11 16:42:28 -0700156#define UPDATE_ENGINE_LOG_DIR "/data/misc/update_engine_log"
Mark Salyzyn4d42dea2016-04-01 10:03:14 -0700157#define LOGPERSIST_DATA_DIR "/data/misc/logd"
Jerry Changa1df8a92020-01-02 16:03:39 +0800158#define PREREBOOT_DATA_DIR "/data/misc/prereboot"
David Brazdild2991962016-06-03 14:40:44 +0100159#define PROFILE_DATA_DIR_CUR "/data/misc/profiles/cur"
160#define PROFILE_DATA_DIR_REF "/data/misc/profiles/ref"
Benedict Wong8f9d8a42019-01-03 16:19:38 -0800161#define XFRM_STAT_PROC_FILE "/proc/net/xfrm_stat"
Erik Kline08165202016-05-30 11:55:44 +0900162#define WLUTIL "/vendor/xbin/wlutil"
Vishnu Nair36b4cdb2017-11-17 10:27:05 -0800163#define WMTRACE_DATA_DIR "/data/misc/wmtrace"
Yifan Hong3945e1b2019-10-29 12:59:23 -0700164#define OTA_METADATA_DIR "/metadata/ota"
Yifan Hong0efa7972020-02-03 16:45:02 -0800165#define SNAPSHOTCTL_LOG_DIR "/data/misc/snapshotctl_log"
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +0900166#define LINKERCONFIG_DIR "/linkerconfig"
Calin Juravle78a0d842020-04-28 15:31:12 -0700167#define PACKAGE_DEX_USE_LIST "/data/system/package-dex-usage.list"
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700168
Narayan Kamath8f788292017-05-25 13:20:39 +0100169// TODO(narayan): Since this information has to be kept in sync
170// with tombstoned, we should just put it in a common header.
171//
172// File: system/core/debuggerd/tombstoned/tombstoned.cpp
Narayan Kamathbd863722017-06-01 18:50:12 +0100173static const std::string TOMBSTONE_DIR = "/data/tombstones/";
174static const std::string TOMBSTONE_FILE_PREFIX = "tombstone_";
175static const std::string ANR_DIR = "/data/anr/";
176static const std::string ANR_FILE_PREFIX = "anr_";
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700177
Felipe Lemee844a9d2016-09-21 15:01:39 -0700178// TODO: temporary variables and functions used during C++ refactoring
Nandana Dutt979388e2018-11-30 16:48:55 +0000179
Nandana Dutt5c390032019-03-12 10:52:56 +0000180#define RETURN_IF_USER_DENIED_CONSENT() \
181 if (ds.IsUserConsentDenied()) { \
182 MYLOGE("Returning early as user denied consent to share bugreport with calling app."); \
183 return Dumpstate::RunStatus::USER_CONSENT_DENIED; \
184 }
185
186// Runs func_ptr, but checks user consent before and after running it. Returns USER_CONSENT_DENIED
187// if consent is found to be denied.
188#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(func_ptr, ...) \
189 RETURN_IF_USER_DENIED_CONSENT(); \
190 func_ptr(__VA_ARGS__); \
191 RETURN_IF_USER_DENIED_CONSENT();
192
Sahana Raof35ed432019-07-12 10:47:52 +0100193static const char* WAKE_LOCK_NAME = "dumpstate_wakelock";
194
Nandana Dutt979388e2018-11-30 16:48:55 +0000195namespace android {
196namespace os {
197namespace {
198
199static int Open(std::string path, int flags, mode_t mode = 0) {
200 int fd = TEMP_FAILURE_RETRY(open(path.c_str(), flags, mode));
201 if (fd == -1) {
202 MYLOGE("open(%s, %s)\n", path.c_str(), strerror(errno));
203 }
204 return fd;
205}
206
Nandana Dutt979388e2018-11-30 16:48:55 +0000207
208static int OpenForRead(std::string path) {
209 return Open(path, O_RDONLY | O_CLOEXEC | O_NOFOLLOW);
210}
211
212bool CopyFile(int in_fd, int out_fd) {
213 char buf[4096];
214 ssize_t byte_count;
215 while ((byte_count = TEMP_FAILURE_RETRY(read(in_fd, buf, sizeof(buf)))) > 0) {
216 if (!android::base::WriteFully(out_fd, buf, byte_count)) {
217 return false;
218 }
219 }
220 return (byte_count != -1);
221}
222
223static bool CopyFileToFd(const std::string& input_file, int out_fd) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000224 MYLOGD("Going to copy file (%s) to %d\n", input_file.c_str(), out_fd);
Nandana Dutt979388e2018-11-30 16:48:55 +0000225
226 // Obtain a handle to the source file.
227 android::base::unique_fd in_fd(OpenForRead(input_file));
228 if (out_fd != -1 && in_fd.get() != -1) {
229 if (CopyFile(in_fd.get(), out_fd)) {
230 return true;
231 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000232 MYLOGE("Failed to copy file: %s\n", strerror(errno));
Nandana Dutt979388e2018-11-30 16:48:55 +0000233 }
234 return false;
235}
236
Nandana Duttd2f5f082019-01-18 17:13:52 +0000237static bool UnlinkAndLogOnError(const std::string& file) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000238 if (unlink(file.c_str())) {
239 MYLOGE("Failed to unlink file (%s): %s\n", file.c_str(), strerror(errno));
Nandana Duttd2f5f082019-01-18 17:13:52 +0000240 return false;
241 }
242 return true;
243}
Nandana Dutt979388e2018-11-30 16:48:55 +0000244
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +0000245static bool IsFileEmpty(const std::string& file_path) {
246 std::ifstream file(file_path, std::ios::binary | std::ios::ate);
247 if(file.bad()) {
248 MYLOGE("Cannot open file: %s\n", file_path.c_str());
249 return true;
250 }
251 return file.tellg() <= 0;
252}
253
Nikita Ioffea325a572019-05-16 19:49:47 +0100254int64_t GetModuleMetadataVersion() {
255 auto binder = defaultServiceManager()->getService(android::String16("package_native"));
256 if (binder == nullptr) {
257 MYLOGE("Failed to retrieve package_native service");
258 return 0L;
259 }
260 auto package_service = android::interface_cast<content::pm::IPackageManagerNative>(binder);
261 std::string package_name;
262 auto status = package_service->getModuleMetadataPackageName(&package_name);
263 if (!status.isOk()) {
264 MYLOGE("Failed to retrieve module metadata package name: %s", status.toString8().c_str());
265 return 0L;
266 }
Nandana Duttdb379fa2019-10-09 16:54:41 +0100267 MYLOGD("Module metadata package name: %s\n", package_name.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100268 int64_t version_code;
269 status = package_service->getVersionCodeForPackage(android::String16(package_name.c_str()),
270 &version_code);
271 if (!status.isOk()) {
272 MYLOGE("Failed to retrieve module metadata version: %s", status.toString8().c_str());
273 return 0L;
274 }
275 return version_code;
276}
277
Nandana Dutt979388e2018-11-30 16:48:55 +0000278} // namespace
279} // namespace os
280} // namespace android
281
Felipe Leme678727a2016-09-21 17:22:11 -0700282static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
Felipe Lemebda15a02016-11-16 17:48:25 -0800283 const CommandOptions& options = Dumpstate::DEFAULT_DUMPSYS,
Vishnu Nair6921f802017-11-22 09:17:23 -0800284 long dumpsysTimeoutMs = 0) {
285 return ds.RunDumpsys(title, dumpsysArgs, options, dumpsysTimeoutMs);
Felipe Leme678727a2016-09-21 17:22:11 -0700286}
287static int DumpFile(const std::string& title, const std::string& path) {
288 return ds.DumpFile(title, path);
289}
Felipe Lemee82a27d2016-01-05 13:35:44 -0800290
Felipe Lemee844a9d2016-09-21 15:01:39 -0700291// Relative directory (inside the zip) for all files copied as-is into the bugreport.
292static const std::string ZIP_ROOT_DIR = "FS";
293
Vishnu Naire97d6122018-01-18 13:58:56 -0800294static const std::string kProtoPath = "proto/";
295static const std::string kProtoExt = ".proto";
Jie Song9fbfad02017-06-20 16:29:42 -0700296static const std::string kDumpstateBoardFiles[] = {
297 "dumpstate_board.txt",
Felipe Leme95d6ca52017-08-01 16:35:56 -0700298 "dumpstate_board.bin"
Jie Song9fbfad02017-06-20 16:29:42 -0700299};
300static const int NUM_OF_DUMPS = arraysize(kDumpstateBoardFiles);
301
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700302static constexpr char PROPERTY_EXTRA_OPTIONS[] = "dumpstate.options";
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700303static constexpr char PROPERTY_LAST_ID[] = "dumpstate.last_id";
Felipe Lemed071c682016-10-20 16:48:00 -0700304static constexpr char PROPERTY_VERSION[] = "dumpstate.version";
Naveen Kallab53a1c92017-03-16 18:17:25 -0700305static constexpr char PROPERTY_EXTRA_TITLE[] = "dumpstate.options.title";
306static constexpr char PROPERTY_EXTRA_DESCRIPTION[] = "dumpstate.options.description";
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700307
Felipe Lemef0292972016-11-22 13:57:05 -0800308static const CommandOptions AS_ROOT_20 = CommandOptions::WithTimeout(20).AsRoot().Build();
309
Narayan Kamath8f788292017-05-25 13:20:39 +0100310/*
Narayan Kamathbd863722017-06-01 18:50:12 +0100311 * Returns a vector of dump fds under |dir_path| with a given |file_prefix|.
312 * The returned vector is sorted by the mtimes of the dumps. If |limit_by_mtime|
313 * is set, the vector only contains files that were written in the last 30 minutes.
Narayan Kamath8f788292017-05-25 13:20:39 +0100314 */
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700315static std::vector<DumpData> GetDumpFds(const std::string& dir_path,
316 const std::string& file_prefix,
Elliott Hughesdb6d2112019-09-26 15:24:51 -0700317 bool limit_by_mtime) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100318 const time_t thirty_minutes_ago = ds.now_ - 60 * 30;
319
Narayan Kamathbd863722017-06-01 18:50:12 +0100320 std::unique_ptr<DIR, decltype(&closedir)> dump_dir(opendir(dir_path.c_str()), closedir);
Narayan Kamath8f788292017-05-25 13:20:39 +0100321
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700322 if (dump_dir == nullptr) {
323 MYLOGW("Unable to open directory %s: %s\n", dir_path.c_str(), strerror(errno));
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700324 return std::vector<DumpData>();
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700325 }
326
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700327 std::vector<DumpData> dump_data;
Narayan Kamathbd863722017-06-01 18:50:12 +0100328 struct dirent* entry = nullptr;
329 while ((entry = readdir(dump_dir.get()))) {
330 if (entry->d_type != DT_REG) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100331 continue;
332 }
333
Narayan Kamathbd863722017-06-01 18:50:12 +0100334 const std::string base_name(entry->d_name);
335 if (base_name.find(file_prefix) != 0) {
336 continue;
337 }
338
339 const std::string abs_path = dir_path + base_name;
340 android::base::unique_fd fd(
341 TEMP_FAILURE_RETRY(open(abs_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW | O_NONBLOCK)));
342 if (fd == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700343 MYLOGW("Unable to open dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamathbd863722017-06-01 18:50:12 +0100344 break;
345 }
346
347 struct stat st = {};
348 if (fstat(fd, &st) == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700349 MYLOGW("Unable to stat dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamath8f788292017-05-25 13:20:39 +0100350 continue;
351 }
352
Narayan Kamath3f31b632018-02-22 19:42:36 +0000353 if (limit_by_mtime && st.st_mtime < thirty_minutes_ago) {
Narayan Kamathbd863722017-06-01 18:50:12 +0100354 MYLOGI("Excluding stale dump file: %s\n", abs_path.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100355 continue;
356 }
357
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700358 dump_data.emplace_back(DumpData{abs_path, std::move(fd), st.st_mtime});
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700359 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100360
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700361 return dump_data;
Narayan Kamath8f788292017-05-25 13:20:39 +0100362}
363
Narayan Kamathbd863722017-06-01 18:50:12 +0100364static bool AddDumps(const std::vector<DumpData>::const_iterator start,
365 const std::vector<DumpData>::const_iterator end,
366 const char* type_name, const bool add_to_zip) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100367 bool dumped = false;
Narayan Kamathbd863722017-06-01 18:50:12 +0100368 for (auto it = start; it != end; ++it) {
369 const std::string& name = it->name;
370 const int fd = it->fd;
Narayan Kamath8f788292017-05-25 13:20:39 +0100371 dumped = true;
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100372
373 // Seek to the beginning of the file before dumping any data. A given
374 // DumpData entry might be dumped multiple times in the report.
375 //
376 // For example, the most recent ANR entry is dumped to the body of the
377 // main entry and it also shows up as a separate entry in the bugreport
378 // ZIP file.
379 if (lseek(fd, 0, SEEK_SET) != static_cast<off_t>(0)) {
380 MYLOGE("Unable to add %s to zip file, lseek failed: %s\n", name.c_str(),
381 strerror(errno));
382 }
383
Narayan Kamath8f788292017-05-25 13:20:39 +0100384 if (ds.IsZipping() && add_to_zip) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800385 if (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + name, fd, /* timeout = */ 0ms) != OK) {
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100386 MYLOGE("Unable to add %s to zip file, addZipEntryFromFd failed\n", name.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100387 }
388 } else {
389 dump_file_from_fd(type_name, name.c_str(), fd);
390 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100391 }
392
393 return dumped;
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700394}
395
Felipe Leme635ca312016-01-05 14:23:02 -0800396// for_each_pid() callback to get mount info about a process.
Felipe Leme4c2d6632016-09-28 14:32:00 -0700397void do_mountinfo(int pid, const char* name __attribute__((unused))) {
Felipe Leme635ca312016-01-05 14:23:02 -0800398 char path[PATH_MAX];
399
400 // Gets the the content of the /proc/PID/ns/mnt link, so only unique mount points
401 // are added.
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700402 snprintf(path, sizeof(path), "/proc/%d/ns/mnt", pid);
Felipe Leme635ca312016-01-05 14:23:02 -0800403 char linkname[PATH_MAX];
404 ssize_t r = readlink(path, linkname, PATH_MAX);
405 if (r == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800406 MYLOGE("Unable to read link for %s: %s\n", path, strerror(errno));
Felipe Leme635ca312016-01-05 14:23:02 -0800407 return;
408 }
409 linkname[r] = '\0';
410
411 if (mount_points.find(linkname) == mount_points.end()) {
412 // First time this mount point was found: add it
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700413 snprintf(path, sizeof(path), "/proc/%d/mountinfo", pid);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700414 if (ds.AddZipEntry(ZIP_ROOT_DIR + path, path)) {
Felipe Leme635ca312016-01-05 14:23:02 -0800415 mount_points.insert(linkname);
416 } else {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800417 MYLOGE("Unable to add mountinfo %s to zip file\n", path);
Felipe Leme635ca312016-01-05 14:23:02 -0800418 }
419 }
420}
421
422void add_mountinfo() {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700423 if (!ds.IsZipping()) return;
Felipe Leme678727a2016-09-21 17:22:11 -0700424 std::string title = "MOUNT INFO";
Felipe Leme635ca312016-01-05 14:23:02 -0800425 mount_points.clear();
Felipe Leme46b85da2016-11-21 17:40:45 -0800426 DurationReporter duration_reporter(title, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700427 for_each_pid(do_mountinfo, nullptr);
428 MYLOGD("%s: %d entries added to zip file\n", title.c_str(), (int)mount_points.size());
Felipe Leme635ca312016-01-05 14:23:02 -0800429}
430
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700431static void dump_dev_files(const char *title, const char *driverpath, const char *filename)
432{
433 DIR *d;
434 struct dirent *de;
435 char path[PATH_MAX];
436
437 d = opendir(driverpath);
Yi Kong19d5c002018-07-20 13:39:55 -0700438 if (d == nullptr) {
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700439 return;
440 }
441
442 while ((de = readdir(d))) {
443 if (de->d_type != DT_LNK) {
444 continue;
445 }
446 snprintf(path, sizeof(path), "%s/%s/%s", driverpath, de->d_name, filename);
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700447 DumpFile(title, path);
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700448 }
449
450 closedir(d);
451}
452
Mark Salyzyn326842f2015-04-30 09:49:41 -0700453static bool skip_not_stat(const char *path) {
454 static const char stat[] = "/stat";
455 size_t len = strlen(path);
456 if (path[len - 1] == '/') { /* Directory? */
457 return false;
458 }
459 return strcmp(path + len - sizeof(stat) + 1, stat); /* .../stat? */
460}
461
Felipe Leme4c2d6632016-09-28 14:32:00 -0700462static bool skip_none(const char* path __attribute__((unused))) {
Felipe Lemee82a27d2016-01-05 13:35:44 -0800463 return false;
464}
465
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700466unsigned long worst_write_perf = 20000; /* in KB/s */
Mark Salyzyn326842f2015-04-30 09:49:41 -0700467
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800468//
469// stat offsets
470// Name units description
471// ---- ----- -----------
472// read I/Os requests number of read I/Os processed
473#define __STAT_READ_IOS 0
474// read merges requests number of read I/Os merged with in-queue I/O
475#define __STAT_READ_MERGES 1
476// read sectors sectors number of sectors read
477#define __STAT_READ_SECTORS 2
478// read ticks milliseconds total wait time for read requests
479#define __STAT_READ_TICKS 3
480// write I/Os requests number of write I/Os processed
481#define __STAT_WRITE_IOS 4
482// write merges requests number of write I/Os merged with in-queue I/O
483#define __STAT_WRITE_MERGES 5
484// write sectors sectors number of sectors written
485#define __STAT_WRITE_SECTORS 6
486// write ticks milliseconds total wait time for write requests
487#define __STAT_WRITE_TICKS 7
488// in_flight requests number of I/Os currently in flight
489#define __STAT_IN_FLIGHT 8
490// io_ticks milliseconds total time this block device has been active
491#define __STAT_IO_TICKS 9
492// time_in_queue milliseconds total wait time for all requests
493#define __STAT_IN_QUEUE 10
494#define __STAT_NUMBER_FIELD 11
495//
496// read I/Os, write I/Os
497// =====================
498//
499// These values increment when an I/O request completes.
500//
501// read merges, write merges
502// =========================
503//
504// These values increment when an I/O request is merged with an
505// already-queued I/O request.
506//
507// read sectors, write sectors
508// ===========================
509//
510// These values count the number of sectors read from or written to this
511// block device. The "sectors" in question are the standard UNIX 512-byte
512// sectors, not any device- or filesystem-specific block size. The
513// counters are incremented when the I/O completes.
514#define SECTOR_SIZE 512
515//
516// read ticks, write ticks
517// =======================
518//
519// These values count the number of milliseconds that I/O requests have
520// waited on this block device. If there are multiple I/O requests waiting,
521// these values will increase at a rate greater than 1000/second; for
522// example, if 60 read requests wait for an average of 30 ms, the read_ticks
523// field will increase by 60*30 = 1800.
524//
525// in_flight
526// =========
527//
528// This value counts the number of I/O requests that have been issued to
529// the device driver but have not yet completed. It does not include I/O
530// requests that are in the queue but not yet issued to the device driver.
531//
532// io_ticks
533// ========
534//
535// This value counts the number of milliseconds during which the device has
536// had I/O requests queued.
537//
538// time_in_queue
539// =============
540//
541// This value counts the number of milliseconds that I/O requests have waited
542// on this block device. If there are multiple I/O requests waiting, this
543// value will increase as the product of the number of milliseconds times the
544// number of requests waiting (see "read ticks" above for an example).
545#define S_TO_MS 1000
546//
547
Mark Salyzyn326842f2015-04-30 09:49:41 -0700548static int dump_stat_from_fd(const char *title __unused, const char *path, int fd) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800549 unsigned long long fields[__STAT_NUMBER_FIELD];
Mark Salyzyn326842f2015-04-30 09:49:41 -0700550 bool z;
Yi Kong19d5c002018-07-20 13:39:55 -0700551 char *cp, *buffer = nullptr;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700552 size_t i = 0;
Josh Gao7c4258c2018-06-25 13:40:08 -0700553 FILE *fp = fdopen(dup(fd), "rb");
Mark Salyzyn326842f2015-04-30 09:49:41 -0700554 getline(&buffer, &i, fp);
555 fclose(fp);
556 if (!buffer) {
557 return -errno;
558 }
559 i = strlen(buffer);
560 while ((i > 0) && (buffer[i - 1] == '\n')) {
561 buffer[--i] = '\0';
562 }
563 if (!*buffer) {
564 free(buffer);
565 return 0;
566 }
567 z = true;
568 for (cp = buffer, i = 0; i < (sizeof(fields) / sizeof(fields[0])); ++i) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800569 fields[i] = strtoull(cp, &cp, 10);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700570 if (fields[i] != 0) {
571 z = false;
572 }
573 }
574 if (z) { /* never accessed */
575 free(buffer);
576 return 0;
577 }
578
Wei Wang509bb5d2017-06-09 14:42:12 -0700579 if (!strncmp(path, BLK_DEV_SYS_DIR, sizeof(BLK_DEV_SYS_DIR) - 1)) {
580 path += sizeof(BLK_DEV_SYS_DIR) - 1;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700581 }
Wei Wang1dc1ef52017-06-12 11:28:37 -0700582
583 printf("%-30s:%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s\n%-30s:\t%s\n", "Block-Dev",
584 "R-IOs", "R-merg", "R-sect", "R-wait", "W-IOs", "W-merg", "W-sect",
585 "W-wait", "in-fli", "activ", "T-wait", path, buffer);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700586 free(buffer);
587
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800588 if (fields[__STAT_IO_TICKS]) {
589 unsigned long read_perf = 0;
590 unsigned long read_ios = 0;
591 if (fields[__STAT_READ_TICKS]) {
592 unsigned long long divisor = fields[__STAT_READ_TICKS]
593 * fields[__STAT_IO_TICKS];
594 read_perf = ((unsigned long long)SECTOR_SIZE
595 * fields[__STAT_READ_SECTORS]
596 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
597 / divisor;
598 read_ios = ((unsigned long long)S_TO_MS * fields[__STAT_READ_IOS]
599 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
600 / divisor;
601 }
602
603 unsigned long write_perf = 0;
604 unsigned long write_ios = 0;
605 if (fields[__STAT_WRITE_TICKS]) {
606 unsigned long long divisor = fields[__STAT_WRITE_TICKS]
607 * fields[__STAT_IO_TICKS];
608 write_perf = ((unsigned long long)SECTOR_SIZE
609 * fields[__STAT_WRITE_SECTORS]
610 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
611 / divisor;
612 write_ios = ((unsigned long long)S_TO_MS * fields[__STAT_WRITE_IOS]
613 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
614 / divisor;
615 }
616
617 unsigned queue = (fields[__STAT_IN_QUEUE]
618 + (fields[__STAT_IO_TICKS] >> 1))
619 / fields[__STAT_IO_TICKS];
620
621 if (!write_perf && !write_ios) {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700622 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 -0800623 } else {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700624 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 -0800625 read_ios, write_perf, write_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800626 }
627
628 /* bugreport timeout factor adjustment */
629 if ((write_perf > 1) && (write_perf < worst_write_perf)) {
630 worst_write_perf = write_perf;
631 }
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700632 }
Mark Salyzyn326842f2015-04-30 09:49:41 -0700633 return 0;
634}
635
Yao Chenbe3bbc12018-01-17 16:31:10 -0800636static const long MINIMUM_LOGCAT_TIMEOUT_MS = 50000;
637
Tom Cherryf4472f32020-08-05 09:31:17 -0700638// Returns the actual readable size of the given buffer or -1 on error.
639static long logcat_buffer_readable_size(const std::string& buffer) {
640 std::unique_ptr<logger_list, decltype(&android_logger_list_free)> logger_list{
641 android_logger_list_alloc(0, 0, 0), &android_logger_list_free};
642 auto logger = android_logger_open(logger_list.get(), android_name_to_log_id(buffer.c_str()));
643
644 return android_logger_get_log_readable_size(logger);
645}
646
647// Returns timeout in ms to read a list of buffers.
Yao Chenbe3bbc12018-01-17 16:31:10 -0800648static unsigned long logcat_timeout(const std::vector<std::string>& buffers) {
649 unsigned long timeout_ms = 0;
650 for (const auto& buffer : buffers) {
Tom Cherryf4472f32020-08-05 09:31:17 -0700651 long readable_size = logcat_buffer_readable_size(buffer);
652 if (readable_size > 0) {
653 // Engineering margin is ten-fold our guess.
654 timeout_ms += 10 * (readable_size + worst_write_perf) / worst_write_perf;
655 }
Yao Chenbe3bbc12018-01-17 16:31:10 -0800656 }
657 return timeout_ms > MINIMUM_LOGCAT_TIMEOUT_MS ? timeout_ms : MINIMUM_LOGCAT_TIMEOUT_MS;
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700658}
659
Nandana Duttd2f5f082019-01-18 17:13:52 +0000660Dumpstate::ConsentCallback::ConsentCallback() : result_(UNAVAILABLE), start_time_(Nanotime()) {
661}
662
663android::binder::Status Dumpstate::ConsentCallback::onReportApproved() {
664 std::lock_guard<std::mutex> lock(lock_);
665 result_ = APPROVED;
666 MYLOGD("User approved consent to share bugreport\n");
667 return android::binder::Status::ok();
668}
669
670android::binder::Status Dumpstate::ConsentCallback::onReportDenied() {
671 std::lock_guard<std::mutex> lock(lock_);
672 result_ = DENIED;
673 MYLOGW("User denied consent to share bugreport\n");
674 return android::binder::Status::ok();
675}
676
677UserConsentResult Dumpstate::ConsentCallback::getResult() {
678 std::lock_guard<std::mutex> lock(lock_);
679 return result_;
680}
681
682uint64_t Dumpstate::ConsentCallback::getElapsedTimeMs() const {
Hunter Knepshieldf0a39052020-01-03 14:53:04 -0800683 return (Nanotime() - start_time_) / NANOS_PER_MILLI;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000684}
685
Felipe Leme2b9b06c2016-10-14 09:13:06 -0700686void Dumpstate::PrintHeader() const {
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700687 std::string build, fingerprint, radio, bootloader, network;
688 char date[80];
Colin Crossf45fa6b2012-03-26 12:38:26 -0700689
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700690 build = android::base::GetProperty("ro.build.display.id", "(unknown)");
691 fingerprint = android::base::GetProperty("ro.build.fingerprint", "(unknown)");
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700692 radio = android::base::GetProperty("gsm.version.baseband", "(unknown)");
693 bootloader = android::base::GetProperty("ro.bootloader", "(unknown)");
694 network = android::base::GetProperty("gsm.operator.alpha", "(unknown)");
Felipe Lemebbaf3c12016-10-11 14:32:25 -0700695 strftime(date, sizeof(date), "%Y-%m-%d %H:%M:%S", localtime(&now_));
Colin Crossf45fa6b2012-03-26 12:38:26 -0700696
Felipe Lemed8b94e52016-12-08 10:21:44 -0800697 printf("========================================================\n");
698 printf("== dumpstate: %s\n", date);
699 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -0700700
Felipe Lemed8b94e52016-12-08 10:21:44 -0800701 printf("\n");
702 printf("Build: %s\n", build.c_str());
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700703 // NOTE: fingerprint entry format is important for other tools.
Felipe Lemed8b94e52016-12-08 10:21:44 -0800704 printf("Build fingerprint: '%s'\n", fingerprint.c_str());
705 printf("Bootloader: %s\n", bootloader.c_str());
706 printf("Radio: %s\n", radio.c_str());
707 printf("Network: %s\n", network.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100708 int64_t module_metadata_version = android::os::GetModuleMetadataVersion();
709 if (module_metadata_version != 0) {
710 printf("Module Metadata version: %" PRId64 "\n", module_metadata_version);
711 }
Colin Crossf45fa6b2012-03-26 12:38:26 -0700712
Felipe Lemed8b94e52016-12-08 10:21:44 -0800713 printf("Kernel: ");
Felipe Lemef0292972016-11-22 13:57:05 -0800714 DumpFileToFd(STDOUT_FILENO, "", "/proc/version");
Felipe Lemed8b94e52016-12-08 10:21:44 -0800715 printf("Command line: %s\n", strtok(cmdline_buf, "\n"));
Felipe Leme7709f8a2017-12-05 09:30:09 -0800716 printf("Uptime: ");
717 RunCommandToFd(STDOUT_FILENO, "", {"uptime", "-p"},
718 CommandOptions::WithTimeout(1).Always().Build());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800719 printf("Bugreport format version: %s\n", version_.c_str());
720 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 +0100721 PropertiesHelper::IsDryRun(), options_->args.c_str(), options_->extra_options.c_str());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800722 printf("\n");
Felipe Leme78f2c862015-12-21 09:55:22 -0800723}
724
Felipe Leme24b66ee2016-06-16 10:55:26 -0700725// List of file extensions that can cause a zip file attachment to be rejected by some email
726// service providers.
727static const std::set<std::string> PROBLEMATIC_FILE_EXTENSIONS = {
728 ".ade", ".adp", ".bat", ".chm", ".cmd", ".com", ".cpl", ".exe", ".hta", ".ins", ".isp",
729 ".jar", ".jse", ".lib", ".lnk", ".mde", ".msc", ".msp", ".mst", ".pif", ".scr", ".sct",
730 ".shb", ".sys", ".vb", ".vbe", ".vbs", ".vxd", ".wsc", ".wsf", ".wsh"
731};
732
Vishnu Naire97d6122018-01-18 13:58:56 -0800733status_t Dumpstate::AddZipEntryFromFd(const std::string& entry_name, int fd,
734 std::chrono::milliseconds timeout = 0ms) {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700735 if (!IsZipping()) {
736 MYLOGD("Not adding zip entry %s from fd because it's not a zipped bugreport\n",
737 entry_name.c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -0800738 return INVALID_OPERATION;
Felipe Leme111b9d02016-02-03 09:28:24 -0800739 }
Felipe Leme24b66ee2016-06-16 10:55:26 -0700740 std::string valid_name = entry_name;
741
742 // Rename extension if necessary.
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -0700743 size_t idx = entry_name.rfind('.');
Felipe Leme24b66ee2016-06-16 10:55:26 -0700744 if (idx != std::string::npos) {
745 std::string extension = entry_name.substr(idx);
746 std::transform(extension.begin(), extension.end(), extension.begin(), ::tolower);
747 if (PROBLEMATIC_FILE_EXTENSIONS.count(extension) != 0) {
748 valid_name = entry_name + ".renamed";
749 MYLOGI("Renaming entry %s to %s\n", entry_name.c_str(), valid_name.c_str());
750 }
751 }
752
Felipe Leme6fe9db62016-02-12 09:04:16 -0800753 // Logging statement below is useful to time how long each entry takes, but it's too verbose.
754 // MYLOGD("Adding zip entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700755 int32_t err = zip_writer_->StartEntryWithTime(valid_name.c_str(), ZipWriter::kCompress,
756 get_mtime(fd, ds.now_));
Felipe Leme1d486fe2016-10-14 18:06:47 -0700757 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700758 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", valid_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700759 ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800760 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800761 }
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000762 bool finished_entry = false;
763 auto finish_entry = [this, &finished_entry] {
764 if (!finished_entry) {
765 // This should only be called when we're going to return an earlier error,
766 // which would've been logged. This may imply the file is already corrupt
767 // and any further logging from FinishEntry is more likely to mislead than
768 // not.
769 this->zip_writer_->FinishEntry();
770 }
771 };
772 auto scope_guard = android::base::make_scope_guard(finish_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -0800773 auto start = std::chrono::steady_clock::now();
774 auto end = start + timeout;
775 struct pollfd pfd = {fd, POLLIN};
Felipe Lemee82a27d2016-01-05 13:35:44 -0800776
Felipe Leme770410d2016-01-26 17:07:14 -0800777 std::vector<uint8_t> buffer(65536);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800778 while (1) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800779 if (timeout.count() > 0) {
780 // lambda to recalculate the timeout.
781 auto time_left_ms = [end]() {
782 auto now = std::chrono::steady_clock::now();
783 auto diff = std::chrono::duration_cast<std::chrono::milliseconds>(end - now);
784 return std::max(diff.count(), 0LL);
785 };
786
787 int rc = TEMP_FAILURE_RETRY(poll(&pfd, 1, time_left_ms()));
788 if (rc < 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000789 MYLOGE("Error in poll while adding from fd to zip entry %s:%s\n",
790 entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800791 return -errno;
792 } else if (rc == 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000793 MYLOGE("Timed out adding from fd to zip entry %s:%s Timeout:%lldms\n",
Vishnu Naire97d6122018-01-18 13:58:56 -0800794 entry_name.c_str(), strerror(errno), timeout.count());
795 return TIMED_OUT;
796 }
797 }
798
Zach Riggle22200402016-08-18 01:01:24 -0400799 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800800 if (bytes_read == 0) {
801 break;
802 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800803 MYLOGE("read(%s): %s\n", entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800804 return -errno;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800805 }
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700806 err = zip_writer_->WriteBytes(buffer.data(), bytes_read);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800807 if (err) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700808 MYLOGE("zip_writer_->WriteBytes(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800809 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800810 }
811 }
812
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700813 err = zip_writer_->FinishEntry();
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000814 finished_entry = true;
Felipe Leme1d486fe2016-10-14 18:06:47 -0700815 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700816 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800817 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800818 }
819
Vishnu Naire97d6122018-01-18 13:58:56 -0800820 return OK;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800821}
822
Felipe Leme1d486fe2016-10-14 18:06:47 -0700823bool Dumpstate::AddZipEntry(const std::string& entry_name, const std::string& entry_path) {
824 android::base::unique_fd fd(
825 TEMP_FAILURE_RETRY(open(entry_path.c_str(), O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
Andreas Gampeaff68432016-07-18 18:01:27 -0700826 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800827 MYLOGE("open(%s): %s\n", entry_path.c_str(), strerror(errno));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800828 return false;
829 }
830
Vishnu Naire97d6122018-01-18 13:58:56 -0800831 return (AddZipEntryFromFd(entry_name, fd.get()) == OK);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800832}
833
834/* adds a file to the existing zipped bugreport */
Felipe Leme4c2d6632016-09-28 14:32:00 -0700835static int _add_file_from_fd(const char* title __attribute__((unused)), const char* path, int fd) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800836 return (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + path, fd) == OK) ? 0 : 1;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800837}
838
Felipe Leme1d486fe2016-10-14 18:06:47 -0700839void Dumpstate::AddDir(const std::string& dir, bool recursive) {
840 if (!IsZipping()) {
841 MYLOGD("Not adding dir %s because it's not a zipped bugreport\n", dir.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800842 return;
843 }
Felipe Leme678727a2016-09-21 17:22:11 -0700844 MYLOGD("Adding dir %s (recursive: %d)\n", dir.c_str(), recursive);
Felipe Leme46b85da2016-11-21 17:40:45 -0800845 DurationReporter duration_reporter(dir, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700846 dump_files("", dir.c_str(), recursive ? skip_none : is_dir, _add_file_from_fd);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800847}
848
Felipe Leme1d486fe2016-10-14 18:06:47 -0700849bool Dumpstate::AddTextZipEntry(const std::string& entry_name, const std::string& content) {
850 if (!IsZipping()) {
851 MYLOGD("Not adding text zip entry %s because it's not a zipped bugreport\n",
852 entry_name.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800853 return false;
854 }
Felipe Lemecbce55d2016-02-08 09:53:18 -0800855 MYLOGD("Adding zip text entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700856 int32_t err = zip_writer_->StartEntryWithTime(entry_name.c_str(), ZipWriter::kCompress, ds.now_);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700857 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700858 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700859 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800860 return false;
861 }
862
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700863 err = zip_writer_->WriteBytes(content.c_str(), content.length());
Felipe Leme1d486fe2016-10-14 18:06:47 -0700864 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700865 MYLOGE("zip_writer_->WriteBytes(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700866 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800867 return false;
868 }
869
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700870 err = zip_writer_->FinishEntry();
Felipe Leme1d486fe2016-10-14 18:06:47 -0700871 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700872 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800873 return false;
874 }
875
876 return true;
877}
878
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800879static void DoKmsg() {
880 struct stat st;
881 if (!stat(PSTORE_LAST_KMSG, &st)) {
882 /* Also TODO: Make console-ramoops CAP_SYSLOG protected. */
883 DumpFile("LAST KMSG", PSTORE_LAST_KMSG);
884 } else if (!stat(ALT_PSTORE_LAST_KMSG, &st)) {
885 DumpFile("LAST KMSG", ALT_PSTORE_LAST_KMSG);
886 } else {
887 /* TODO: Make last_kmsg CAP_SYSLOG protected. b/5555691 */
888 DumpFile("LAST KMSG", "/proc/last_kmsg");
889 }
890}
891
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800892static void DoKernelLogcat() {
Yao Chenbe3bbc12018-01-17 16:31:10 -0800893 unsigned long timeout_ms = logcat_timeout({"kernel"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800894 RunCommand(
895 "KERNEL LOG",
896 {"logcat", "-b", "kernel", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
897 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
898}
899
Nandana Duttdb379fa2019-10-09 16:54:41 +0100900static void DoSystemLogcat(time_t since) {
901 char since_str[80];
902 strftime(since_str, sizeof(since_str), "%Y-%m-%d %H:%M:%S.000", localtime(&since));
903
904 unsigned long timeout_ms = logcat_timeout({"main", "system", "crash"});
905 RunCommand("SYSTEM LOG",
906 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v", "-T",
907 since_str},
908 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
909}
910
Hunter Knepshield820f9bc2020-02-05 20:10:53 -0800911static void DoRadioLogcat() {
912 unsigned long timeout_ms = logcat_timeout({"radio"});
913 RunCommand(
914 "RADIO LOG",
915 {"logcat", "-b", "radio", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
916 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
917}
918
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800919static void DoLogcat() {
Vishnu Nair6921f802017-11-22 09:17:23 -0800920 unsigned long timeout_ms;
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800921 // DumpFile("EVENT LOG TAGS", "/etc/event-log-tags");
922 // calculate timeout
Yao Chenbe3bbc12018-01-17 16:31:10 -0800923 timeout_ms = logcat_timeout({"main", "system", "crash"});
Tony Makae737652017-03-30 17:47:09 +0100924 RunCommand("SYSTEM LOG",
Vishnu Nair6921f802017-11-22 09:17:23 -0800925 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
926 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -0800927 timeout_ms = logcat_timeout({"events"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800928 RunCommand(
929 "EVENT LOG",
930 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +0100931 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Yao Chenbe3bbc12018-01-17 16:31:10 -0800932 timeout_ms = logcat_timeout({"stats"});
933 RunCommand(
934 "STATS LOG",
935 {"logcat", "-b", "stats", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +0100936 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Hunter Knepshield820f9bc2020-02-05 20:10:53 -0800937 DoRadioLogcat();
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800938
939 RunCommand("LOG STATISTICS", {"logcat", "-b", "all", "-S"});
940
941 /* kernels must set CONFIG_PSTORE_PMSG, slice up pstore with device tree */
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800942 RunCommand("LAST LOGCAT", {"logcat", "-L", "-b", "all", "-v", "threadtime", "-v", "printable",
943 "-v", "uid", "-d", "*:v"});
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800944}
945
Mike Ma5c267872019-08-21 11:31:34 -0700946static void DumpIncidentReport() {
947 if (!ds.IsZipping()) {
948 MYLOGD("Not dumping incident report because it's not a zipped bugreport\n");
949 return;
950 }
951 DurationReporter duration_reporter("INCIDENT REPORT");
952 const std::string path = ds.bugreport_internal_dir_ + "/tmp_incident_report";
953 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
954 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
955 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
956 if (fd < 0) {
957 MYLOGE("Could not open %s to dump incident report.\n", path.c_str());
958 return;
959 }
960 RunCommandToFd(fd, "", {"incident", "-u"}, CommandOptions::WithTimeout(120).Build());
961 bool empty = 0 == lseek(fd, 0, SEEK_END);
962 if (!empty) {
963 // Use a different name from "incident.proto"
964 // /proto/incident.proto is reserved for incident service dump
965 // i.e. metadata for debugging.
966 ds.AddZipEntry(kProtoPath + "incident_report" + kProtoExt, path);
967 }
968 unlink(path.c_str());
969}
970
Jayachandran Ca94c7172017-06-10 15:08:12 -0700971static void DumpIpTablesAsRoot() {
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700972 RunCommand("IPTABLES", {"iptables", "-L", "-nvx"});
973 RunCommand("IP6TABLES", {"ip6tables", "-L", "-nvx"});
Erik Kline32af8c22016-09-28 17:26:26 +0900974 RunCommand("IPTABLES NAT", {"iptables", "-t", "nat", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -0700975 /* no ip6 nat */
Erik Kline32af8c22016-09-28 17:26:26 +0900976 RunCommand("IPTABLES MANGLE", {"iptables", "-t", "mangle", "-L", "-nvx"});
977 RunCommand("IP6TABLES MANGLE", {"ip6tables", "-t", "mangle", "-L", "-nvx"});
978 RunCommand("IPTABLES RAW", {"iptables", "-t", "raw", "-L", "-nvx"});
979 RunCommand("IP6TABLES RAW", {"ip6tables", "-t", "raw", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -0700980}
981
David Andersond9ba4752018-12-11 18:26:59 -0800982static void DumpDynamicPartitionInfo() {
983 if (!::android::base::GetBoolProperty("ro.boot.dynamic_partitions", false)) {
984 return;
985 }
986
987 RunCommand("LPDUMP", {"lpdump", "--all"});
David Anderson6650ade2019-10-02 15:18:59 -0700988 RunCommand("DEVICE-MAPPER", {"gsid", "dump-device-mapper"});
David Andersond9ba4752018-12-11 18:26:59 -0800989}
990
Narayan Kamath8f788292017-05-25 13:20:39 +0100991static void AddAnrTraceDir(const bool add_to_zip, const std::string& anr_traces_dir) {
992 MYLOGD("AddAnrTraceDir(): dump_traces_file=%s, anr_traces_dir=%s\n", dump_traces_path,
993 anr_traces_dir.c_str());
994
995 // If we're here, dump_traces_path will always be a temporary file
996 // (created with mkostemp or similar) that contains dumps taken earlier
997 // on in the process.
998 if (dump_traces_path != nullptr) {
999 if (add_to_zip) {
1000 ds.AddZipEntry(ZIP_ROOT_DIR + anr_traces_dir + "/traces-just-now.txt", dump_traces_path);
1001 } else {
1002 MYLOGD("Dumping current ANR traces (%s) to the main bugreport entry\n",
1003 dump_traces_path);
1004 ds.DumpFile("VM TRACES JUST NOW", dump_traces_path);
1005 }
1006
1007 const int ret = unlink(dump_traces_path);
1008 if (ret == -1) {
1009 MYLOGW("Error unlinking temporary trace path %s: %s\n", dump_traces_path,
1010 strerror(errno));
Felipe Lemee184f662016-10-27 10:04:47 -07001011 }
1012 }
1013
Narayan Kamathbd863722017-06-01 18:50:12 +01001014 // Add a specific message for the first ANR Dump.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001015 if (ds.anr_data_.size() > 0) {
1016 AddDumps(ds.anr_data_.begin(), ds.anr_data_.begin() + 1,
Narayan Kamathbd863722017-06-01 18:50:12 +01001017 "VM TRACES AT LAST ANR", add_to_zip);
1018
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001019 // The "last" ANR will always be included as separate entry in the zip file. In addition,
1020 // it will be present in the body of the main entry if |add_to_zip| == false.
1021 //
1022 // Historical ANRs are always included as separate entries in the bugreport zip file.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001023 AddDumps(ds.anr_data_.begin() + ((add_to_zip) ? 1 : 0), ds.anr_data_.end(),
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001024 "HISTORICAL ANR", true /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001025 } else {
Narayan Kamath8f788292017-05-25 13:20:39 +01001026 printf("*** NO ANRs to dump in %s\n\n", ANR_DIR.c_str());
1027 }
1028}
1029
1030static void AddAnrTraceFiles() {
1031 const bool add_to_zip = ds.IsZipping() && ds.version_ == VERSION_SPLIT_ANR;
1032
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001033 std::string anr_traces_dir = "/data/anr";
Narayan Kamath8f788292017-05-25 13:20:39 +01001034
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001035 AddAnrTraceDir(add_to_zip, anr_traces_dir);
Narayan Kamath8f788292017-05-25 13:20:39 +01001036
Makoto Onuki83ec63f2019-01-31 17:08:59 -08001037 RunCommand("ANR FILES", {"ls", "-lt", ANR_DIR});
1038
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001039 // Slow traces for slow operations.
Felipe Lemee184f662016-10-27 10:04:47 -07001040 struct stat st;
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001041 int i = 0;
1042 while (true) {
1043 const std::string slow_trace_path =
1044 anr_traces_dir + android::base::StringPrintf("slow%02d.txt", i);
1045 if (stat(slow_trace_path.c_str(), &st)) {
1046 // No traces file at this index, done with the files.
1047 break;
Felipe Lemee184f662016-10-27 10:04:47 -07001048 }
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001049 ds.DumpFile("VM TRACES WHEN SLOW", slow_trace_path.c_str());
1050 i++;
Felipe Lemee184f662016-10-27 10:04:47 -07001051 }
1052}
1053
Wei Wang509bb5d2017-06-09 14:42:12 -07001054static void DumpBlockStatFiles() {
1055 DurationReporter duration_reporter("DUMP BLOCK STAT");
Wei Wang509bb5d2017-06-09 14:42:12 -07001056
Wei Wang1dc1ef52017-06-12 11:28:37 -07001057 std::unique_ptr<DIR, std::function<int(DIR*)>> dirptr(opendir(BLK_DEV_SYS_DIR), closedir);
1058
1059 if (dirptr == nullptr) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001060 MYLOGE("Failed to open %s: %s\n", BLK_DEV_SYS_DIR, strerror(errno));
1061 return;
1062 }
1063
1064 printf("------ DUMP BLOCK STAT ------\n\n");
Wei Wang1dc1ef52017-06-12 11:28:37 -07001065 while (struct dirent *d = readdir(dirptr.get())) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001066 if ((d->d_name[0] == '.')
1067 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
1068 || (d->d_name[1] == '\0'))) {
1069 continue;
1070 }
1071 const std::string new_path =
1072 android::base::StringPrintf("%s/%s", BLK_DEV_SYS_DIR, d->d_name);
1073 printf("------ BLOCK STAT (%s) ------\n", new_path.c_str());
1074 dump_files("", new_path.c_str(), skip_not_stat, dump_stat_from_fd);
1075 printf("\n");
1076 }
Wei Wang1dc1ef52017-06-12 11:28:37 -07001077 return;
Wei Wang509bb5d2017-06-09 14:42:12 -07001078}
Jayachandran Ca94c7172017-06-10 15:08:12 -07001079
1080static void DumpPacketStats() {
1081 DumpFile("NETWORK DEV INFO", "/proc/net/dev");
1082 DumpFile("QTAGUID NETWORK INTERFACES INFO", "/proc/net/xt_qtaguid/iface_stat_all");
1083 DumpFile("QTAGUID NETWORK INTERFACES INFO (xt)", "/proc/net/xt_qtaguid/iface_stat_fmt");
1084 DumpFile("QTAGUID CTRL INFO", "/proc/net/xt_qtaguid/ctrl");
1085 DumpFile("QTAGUID STATS INFO", "/proc/net/xt_qtaguid/stats");
1086}
1087
1088static void DumpIpAddrAndRules() {
1089 /* The following have a tendency to get wedged when wifi drivers/fw goes belly-up. */
1090 RunCommand("NETWORK INTERFACES", {"ip", "link"});
1091 RunCommand("IPv4 ADDRESSES", {"ip", "-4", "addr", "show"});
1092 RunCommand("IPv6 ADDRESSES", {"ip", "-6", "addr", "show"});
1093 RunCommand("IP RULES", {"ip", "rule", "show"});
1094 RunCommand("IP RULES v6", {"ip", "-6", "rule", "show"});
1095}
1096
Nandana Dutt5c390032019-03-12 10:52:56 +00001097static Dumpstate::RunStatus RunDumpsysTextByPriority(const std::string& title, int priority,
1098 std::chrono::milliseconds timeout,
1099 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001100 auto start = std::chrono::steady_clock::now();
Vishnu Naire97d6122018-01-18 13:58:56 -08001101 sp<android::IServiceManager> sm = defaultServiceManager();
1102 Dumpsys dumpsys(sm.get());
Vishnu Naire97d6122018-01-18 13:58:56 -08001103 Vector<String16> args;
1104 Dumpsys::setServiceArgs(args, /* asProto = */ false, priority);
Vishnu Naire97d6122018-01-18 13:58:56 -08001105 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ false);
1106 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001107 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001108 std::string path(title);
1109 path.append(" - ").append(String8(service).c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -08001110 size_t bytes_written = 0;
Steven Moreland5a30d342019-10-08 13:53:28 -07001111 status_t status = dumpsys.startDumpThread(Dumpsys::Type::DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001112 if (status == OK) {
1113 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1114 std::chrono::duration<double> elapsed_seconds;
1115 status = dumpsys.writeDump(STDOUT_FILENO, service, service_timeout,
1116 /* as_proto = */ false, elapsed_seconds, bytes_written);
Vishnu Naire97d6122018-01-18 13:58:56 -08001117 dumpsys.writeDumpFooter(STDOUT_FILENO, service, elapsed_seconds);
1118 bool dump_complete = (status == OK);
1119 dumpsys.stopDumpThread(dump_complete);
1120 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001121
1122 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1123 std::chrono::steady_clock::now() - start);
1124 if (elapsed_duration > timeout) {
1125 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1126 elapsed_duration.count());
1127 break;
1128 }
1129 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001130 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001131}
1132
Vishnu Nair64afc022018-02-01 15:29:34 -08001133static void RunDumpsysText(const std::string& title, int priority,
1134 std::chrono::milliseconds timeout,
1135 std::chrono::milliseconds service_timeout) {
1136 DurationReporter duration_reporter(title);
1137 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1138 fsync(STDOUT_FILENO);
1139 RunDumpsysTextByPriority(title, priority, timeout, service_timeout);
1140}
1141
1142/* Dump all services registered with Normal or Default priority. */
Nandana Dutt5c390032019-03-12 10:52:56 +00001143static Dumpstate::RunStatus RunDumpsysTextNormalPriority(const std::string& title,
1144 std::chrono::milliseconds timeout,
1145 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001146 DurationReporter duration_reporter(title);
1147 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1148 fsync(STDOUT_FILENO);
1149 RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_NORMAL, timeout,
1150 service_timeout);
Nandana Dutt5c390032019-03-12 10:52:56 +00001151
1152 RETURN_IF_USER_DENIED_CONSENT();
1153
1154 return RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_DEFAULT, timeout,
1155 service_timeout);
Vishnu Nair64afc022018-02-01 15:29:34 -08001156}
1157
Nandana Dutt5c390032019-03-12 10:52:56 +00001158static Dumpstate::RunStatus RunDumpsysProto(const std::string& title, int priority,
1159 std::chrono::milliseconds timeout,
1160 std::chrono::milliseconds service_timeout) {
Luis Hector Chavez1e27b082018-03-22 15:36:42 -07001161 if (!ds.IsZipping()) {
1162 MYLOGD("Not dumping %s because it's not a zipped bugreport\n", title.c_str());
Nandana Dutt5c390032019-03-12 10:52:56 +00001163 return Dumpstate::RunStatus::OK;
Luis Hector Chavez1e27b082018-03-22 15:36:42 -07001164 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001165 sp<android::IServiceManager> sm = defaultServiceManager();
1166 Dumpsys dumpsys(sm.get());
1167 Vector<String16> args;
1168 Dumpsys::setServiceArgs(args, /* asProto = */ true, priority);
1169 DurationReporter duration_reporter(title);
1170
1171 auto start = std::chrono::steady_clock::now();
1172 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ true);
1173 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001174 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001175 std::string path(kProtoPath);
1176 path.append(String8(service).c_str());
1177 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL) {
1178 path.append("_CRITICAL");
1179 } else if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH) {
1180 path.append("_HIGH");
1181 }
1182 path.append(kProtoExt);
Steven Moreland5a30d342019-10-08 13:53:28 -07001183 status_t status = dumpsys.startDumpThread(Dumpsys::Type::DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001184 if (status == OK) {
1185 status = ds.AddZipEntryFromFd(path, dumpsys.getDumpFd(), service_timeout);
1186 bool dumpTerminated = (status == OK);
1187 dumpsys.stopDumpThread(dumpTerminated);
1188 }
1189 ZipWriter::FileEntry file_entry;
1190 ds.zip_writer_->GetLastEntry(&file_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -08001191
1192 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1193 std::chrono::steady_clock::now() - start);
1194 if (elapsed_duration > timeout) {
1195 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1196 elapsed_duration.count());
1197 break;
1198 }
1199 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001200 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001201}
1202
Nandana Dutta7db6342018-11-21 14:53:34 +00001203// Runs dumpsys on services that must dump first and will take less than 100ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001204static Dumpstate::RunStatus RunDumpsysCritical() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001205 RunDumpsysText("DUMPSYS CRITICAL", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1206 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Nandana Dutt5c390032019-03-12 10:52:56 +00001207
1208 RETURN_IF_USER_DENIED_CONSENT();
1209
1210 return RunDumpsysProto("DUMPSYS CRITICAL PROTO", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1211 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Vishnu Nair780b1282017-10-10 13:57:24 -07001212}
1213
1214// Runs dumpsys on services that must dump first but can take up to 250ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001215static Dumpstate::RunStatus RunDumpsysHigh() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001216 // TODO meminfo takes ~10s, connectivity takes ~5sec to dump. They are both
1217 // high priority. Reduce timeout once they are able to dump in a shorter time or
1218 // moved to a parallel task.
1219 RunDumpsysText("DUMPSYS HIGH", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1220 /* timeout= */ 90s, /* service_timeout= */ 30s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001221
1222 RETURN_IF_USER_DENIED_CONSENT();
1223
1224 return RunDumpsysProto("DUMPSYS HIGH PROTO", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1225 /* timeout= */ 5s, /* service_timeout= */ 1s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001226}
1227
1228// Runs dumpsys on services that must dump but can take up to 10s to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001229static Dumpstate::RunStatus RunDumpsysNormal() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001230 RunDumpsysTextNormalPriority("DUMPSYS", /* timeout= */ 90s, /* service_timeout= */ 10s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001231
1232 RETURN_IF_USER_DENIED_CONSENT();
1233
1234 return RunDumpsysProto("DUMPSYS PROTO", IServiceManager::DUMP_FLAG_PRIORITY_NORMAL,
1235 /* timeout= */ 90s, /* service_timeout= */ 10s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001236}
1237
Steven Moreland44cd9482018-01-04 16:24:13 -08001238static void DumpHals() {
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001239 if (!ds.IsZipping()) {
1240 RunCommand("HARDWARE HALS", {"lshal", "-lVSietrpc", "--types=b,c,l,z", "--debug"},
1241 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build());
1242 return;
1243 }
1244 DurationReporter duration_reporter("DUMP HALS");
1245 RunCommand("HARDWARE HALS", {"lshal", "-lVSietrpc", "--types=b,c,l,z"},
Greg Kaiser3dfeda32019-05-16 10:32:51 -07001246 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build());
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001247
Steven Moreland44cd9482018-01-04 16:24:13 -08001248 using android::hidl::manager::V1_0::IServiceManager;
1249 using android::hardware::defaultServiceManager;
1250
1251 sp<IServiceManager> sm = defaultServiceManager();
1252 if (sm == nullptr) {
1253 MYLOGE("Could not retrieve hwservicemanager to dump hals.\n");
1254 return;
1255 }
1256
1257 auto ret = sm->list([&](const auto& interfaces) {
1258 for (const std::string& interface : interfaces) {
1259 std::string cleanName = interface;
1260 std::replace_if(cleanName.begin(),
1261 cleanName.end(),
1262 [](char c) {
1263 return !isalnum(c) &&
1264 std::string("@-_:.").find(c) == std::string::npos;
1265 }, '_');
Nandana Dutt979388e2018-11-30 16:48:55 +00001266 const std::string path = ds.bugreport_internal_dir_ + "/lshal_debug_" + cleanName;
Steven Moreland44cd9482018-01-04 16:24:13 -08001267
1268 {
1269 auto fd = android::base::unique_fd(
1270 TEMP_FAILURE_RETRY(open(path.c_str(),
1271 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1272 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1273 if (fd < 0) {
1274 MYLOGE("Could not open %s to dump additional hal information.\n", path.c_str());
1275 continue;
1276 }
1277 RunCommandToFd(fd,
1278 "",
Steven Morelandc81cd3c2018-01-18 14:36:26 -08001279 {"lshal", "debug", "-E", interface},
Steven Moreland44cd9482018-01-04 16:24:13 -08001280 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
1281
1282 bool empty = 0 == lseek(fd, 0, SEEK_END);
1283 if (!empty) {
1284 ds.AddZipEntry("lshal-debug/" + cleanName + ".txt", path);
1285 }
1286 }
1287
1288 unlink(path.c_str());
1289 }
1290 });
1291
1292 if (!ret.isOk()) {
1293 MYLOGE("Could not list hals from hwservicemanager.\n");
1294 }
1295}
1296
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001297static void DumpExternalFragmentationInfo() {
1298 struct stat st;
1299 if (stat("/proc/buddyinfo", &st) != 0) {
1300 MYLOGE("Unable to dump external fragmentation info\n");
1301 return;
1302 }
1303
1304 printf("------ EXTERNAL FRAGMENTATION INFO ------\n");
1305 std::ifstream ifs("/proc/buddyinfo");
1306 auto unusable_index_regex = std::regex{"Node\\s+([0-9]+),\\s+zone\\s+(\\S+)\\s+(.*)"};
1307 for (std::string line; std::getline(ifs, line);) {
1308 std::smatch match_results;
1309 if (std::regex_match(line, match_results, unusable_index_regex)) {
1310 std::stringstream free_pages(std::string{match_results[3]});
1311 std::vector<int> free_pages_per_order(std::istream_iterator<int>{free_pages},
1312 std::istream_iterator<int>());
1313
1314 int total_free_pages = 0;
1315 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1316 total_free_pages += (free_pages_per_order[i] * std::pow(2, i));
1317 }
1318
1319 printf("Node %s, zone %8s", match_results[1].str().c_str(),
1320 match_results[2].str().c_str());
1321
1322 int usable_free_pages = total_free_pages;
1323 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1324 auto unusable_index = (total_free_pages - usable_free_pages) /
1325 static_cast<double>(total_free_pages);
1326 printf(" %5.3f", unusable_index);
1327 usable_free_pages -= (free_pages_per_order[i] * std::pow(2, i));
1328 }
1329
1330 printf("\n");
1331 }
1332 }
1333 printf("\n");
1334}
1335
Nandana Dutt5c390032019-03-12 10:52:56 +00001336// Dumps various things. Returns early with status USER_CONSENT_DENIED if user denies consent
1337// via the consent they are shown. Ignores other errors that occur while running various
1338// commands. The consent checking is currently done around long running tasks, which happen to
1339// be distributed fairly evenly throughout the function.
1340static Dumpstate::RunStatus dumpstate() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001341 DurationReporter duration_reporter("DUMPSTATE");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001342
Nandana Dutt5c390032019-03-12 10:52:56 +00001343 // Dump various things. Note that anything that takes "long" (i.e. several seconds) should
1344 // check intermittently (if it's intrerruptable like a foreach on pids) and/or should be wrapped
1345 // in a consent check (via RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK).
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -07001346 dump_dev_files("TRUSTY VERSION", "/sys/bus/platform/drivers/trusty", "trusty_version");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001347 RunCommand("UPTIME", {"uptime"});
Wei Wang509bb5d2017-06-09 14:42:12 -07001348 DumpBlockStatFiles();
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001349 DumpFile("MEMORY INFO", "/proc/meminfo");
1350 RunCommand("CPU INFO", {"top", "-b", "-n", "1", "-H", "-s", "6", "-o",
Felipe Leme30dbfa12016-09-02 12:43:26 -07001351 "pid,tid,user,pr,ni,%cpu,s,virt,res,pcy,cmd,name"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001352
1353 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "PROCRANK", {"procrank"}, AS_ROOT_20);
1354
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001355 DumpFile("VIRTUAL MEMORY STATS", "/proc/vmstat");
1356 DumpFile("VMALLOC INFO", "/proc/vmallocinfo");
1357 DumpFile("SLAB INFO", "/proc/slabinfo");
1358 DumpFile("ZONEINFO", "/proc/zoneinfo");
1359 DumpFile("PAGETYPEINFO", "/proc/pagetypeinfo");
1360 DumpFile("BUDDYINFO", "/proc/buddyinfo");
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001361 DumpExternalFragmentationInfo();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001362
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001363 DumpFile("KERNEL WAKE SOURCES", "/d/wakeup_sources");
1364 DumpFile("KERNEL CPUFREQ", "/sys/devices/system/cpu/cpu0/cpufreq/stats/time_in_state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001365
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001366 RunCommand("PROCESSES AND THREADS",
Yohei Yukawa591a72d2017-10-05 21:36:35 -07001367 {"ps", "-A", "-T", "-Z", "-O", "pri,nice,rtprio,sched,pcy,time"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001368
1369 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "LIBRANK", {"librank"},
1370 CommandOptions::AS_ROOT);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001371
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001372 DumpHals();
Steven Moreland81b429e2017-01-31 19:50:46 -08001373
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001374 RunCommand("PRINTENV", {"printenv"});
Elliott Hughes21b7c8d2016-10-28 08:53:02 -07001375 RunCommand("NETSTAT", {"netstat", "-nW"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001376 struct stat s;
1377 if (stat("/proc/modules", &s) != 0) {
1378 MYLOGD("Skipping 'lsmod' because /proc/modules does not exist\n");
1379 } else {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001380 RunCommand("LSMOD", {"lsmod"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001381 }
Michal Karpinski4db754f2015-12-11 18:04:32 +00001382
Tom Cherryb87dbfa2020-07-28 11:28:53 -07001383 if (android::base::GetBoolProperty("ro.logd.kernel", false)) {
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001384 DoKernelLogcat();
1385 } else {
1386 do_dmesg();
1387 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001388
Felipe Lemef0292972016-11-22 13:57:05 -08001389 RunCommand("LIST OF OPEN FILES", {"lsof"}, CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001390
1391 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(for_each_pid, do_showmap, "SMAPS OF ALL PROCESSES");
1392
Jeff Brown1dc94e32014-09-11 14:15:27 -07001393 for_each_tid(show_wchan, "BLOCKED PROCESS WAIT-CHANNELS");
Mark Salyzyna297c322016-02-05 15:33:17 -08001394 for_each_pid(show_showtime, "PROCESS TIMES (pid cmd user system iowait+percentage)");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001395
Ajay Panicker2ff8e872017-04-27 14:04:32 -07001396 /* Dump Bluetooth HCI logs */
1397 ds.AddDir("/data/misc/bluetooth/logs", true);
Ajay Panickerd886ec42016-09-14 12:26:46 -07001398
Greg Kaiser3ddc3fa2019-05-23 16:14:52 -07001399 if (ds.options_->do_fb && !ds.do_early_screenshot_) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001400 MYLOGI("taking late screenshot\n");
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001401 ds.TakeScreenshot();
Jeff Sharkey5a930032013-03-19 15:05:19 -07001402 }
1403
Felipe Lemee184f662016-10-27 10:04:47 -07001404 AddAnrTraceFiles();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001405
Narayan Kamath8f788292017-05-25 13:20:39 +01001406 // NOTE: tombstones are always added as separate entries in the zip archive
1407 // and are not interspersed with the main report.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001408 const bool tombstones_dumped = AddDumps(ds.tombstone_data_.begin(), ds.tombstone_data_.end(),
Narayan Kamathbd863722017-06-01 18:50:12 +01001409 "TOMBSTONE", true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001410 if (!tombstones_dumped) {
1411 printf("*** NO TOMBSTONES to dump in %s\n\n", TOMBSTONE_DIR.c_str());
Christopher Ferris7dc7f322014-07-22 16:08:19 -07001412 }
1413
Jayachandran Ca94c7172017-06-10 15:08:12 -07001414 DumpPacketStats();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001415
Chenbo Feng276a3b62018-08-07 11:44:49 -07001416 RunDumpsys("EBPF MAP STATS", {"netd", "trafficcontroller"});
1417
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001418 DoKmsg();
Mark Salyzyn2262c162014-12-16 09:09:26 -08001419
Jayachandran Ca94c7172017-06-10 15:08:12 -07001420 DumpIpAddrAndRules();
Sreeram Ramachandran2b3bba32014-07-08 15:40:55 -07001421
1422 dump_route_tables();
1423
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001424 RunCommand("ARP CACHE", {"ip", "-4", "neigh", "show"});
1425 RunCommand("IPv6 ND CACHE", {"ip", "-6", "neigh", "show"});
1426 RunCommand("MULTICAST ADDRESSES", {"ip", "maddr"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001427
Nandana Dutt5c390032019-03-12 10:52:56 +00001428 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysHigh);
Lorenzo Colitti6afc38c2015-09-09 22:59:25 +09001429
Elliott Hughes23ccc622017-02-28 10:14:22 -08001430 RunCommand("SYSTEM PROPERTIES", {"getprop"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001431
Jin Qianf334d662017-10-10 14:41:37 -07001432 RunCommand("STORAGED IO INFO", {"storaged", "-u", "-p"});
ynwangf649a6e2016-07-17 21:56:00 -07001433
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001434 RunCommand("FILESYSTEMS & FREE SPACE", {"df"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001435
Colin Crossf45fa6b2012-03-26 12:38:26 -07001436 /* Binder state is expensive to look at as it uses a lot of memory. */
Hridya Valsaraju920ba712020-02-09 16:27:01 -08001437 std::string binder_logs_dir = access("/dev/binderfs/binder_logs", R_OK) ?
1438 "/sys/kernel/debug/binder" : "/dev/binderfs/binder_logs";
1439
1440 DumpFile("BINDER FAILED TRANSACTION LOG", binder_logs_dir + "/failed_transaction_log");
1441 DumpFile("BINDER TRANSACTION LOG", binder_logs_dir + "/transaction_log");
1442 DumpFile("BINDER TRANSACTIONS", binder_logs_dir + "/transactions");
1443 DumpFile("BINDER STATS", binder_logs_dir + "/stats");
1444 DumpFile("BINDER STATE", binder_logs_dir + "/state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001445
Vishnu Nair36b4cdb2017-11-17 10:27:05 -08001446 /* Add window and surface trace files. */
1447 if (!PropertiesHelper::IsUserBuild()) {
1448 ds.AddDir(WMTRACE_DATA_DIR, false);
1449 }
1450
Yifan Hongcba0a4f2020-02-08 16:52:02 -08001451 ds.AddDir(SNAPSHOTCTL_LOG_DIR, false);
1452
Nandana Dutt5c390032019-03-12 10:52:56 +00001453 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(ds.DumpstateBoard);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001454
Steven Moreland7440ddb2016-12-15 16:13:39 -08001455 /* Migrate the ril_dumpstate to a device specific dumpstate? */
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001456 int rilDumpstateTimeout = android::base::GetIntProperty("ril.dumpstate.timeout", 0);
1457 if (rilDumpstateTimeout > 0) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001458 // su does not exist on user builds, so try running without it.
1459 // This way any implementations of vril-dump that do not require
1460 // root can run on user builds.
1461 CommandOptions::CommandOptionsBuilder options =
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001462 CommandOptions::WithTimeout(rilDumpstateTimeout);
Felipe Lemef0292972016-11-22 13:57:05 -08001463 if (!PropertiesHelper::IsUserBuild()) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001464 options.AsRoot();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001465 }
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001466 RunCommand("DUMP VENDOR RIL LOGS", {"vril-dump"}, options.Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -07001467 }
1468
Felipe Lemed8b94e52016-12-08 10:21:44 -08001469 printf("========================================================\n");
1470 printf("== Android Framework Services\n");
1471 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001472
Nandana Dutt5c390032019-03-12 10:52:56 +00001473 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysNormal);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001474
Felipe Lemed8b94e52016-12-08 10:21:44 -08001475 printf("========================================================\n");
1476 printf("== Checkins\n");
1477 printf("========================================================\n");
Dianne Hackborn02bea972013-06-26 18:59:09 -07001478
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001479 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001480
1481 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsys, "CHECKIN MEMINFO", {"meminfo", "--checkin"});
1482
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001483 RunDumpsys("CHECKIN NETSTATS", {"netstats", "--checkin"});
1484 RunDumpsys("CHECKIN PROCSTATS", {"procstats", "-c"});
1485 RunDumpsys("CHECKIN USAGESTATS", {"usagestats", "-c"});
1486 RunDumpsys("CHECKIN PACKAGE", {"package", "--checkin"});
Dianne Hackborn02bea972013-06-26 18:59:09 -07001487
Felipe Lemed8b94e52016-12-08 10:21:44 -08001488 printf("========================================================\n");
1489 printf("== Running Application Activities\n");
1490 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001491
Makoto Onuki60780982018-04-16 15:34:00 -07001492 // The following dumpsys internally collects output from running apps, so it can take a long
1493 // time. So let's extend the timeout.
1494
1495 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
1496
1497 RunDumpsys("APP ACTIVITIES", {"activity", "-v", "all"}, DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001498
Felipe Lemed8b94e52016-12-08 10:21:44 -08001499 printf("========================================================\n");
Makoto Onuki60780982018-04-16 15:34:00 -07001500 printf("== Running Application Services (platform)\n");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001501 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001502
Vishnu Nairc6e6ea72018-07-02 14:20:06 -07001503 RunDumpsys("APP SERVICES PLATFORM", {"activity", "service", "all-platform-non-critical"},
Makoto Onuki60780982018-04-16 15:34:00 -07001504 DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001505
Felipe Lemed8b94e52016-12-08 10:21:44 -08001506 printf("========================================================\n");
Makoto Onuki60780982018-04-16 15:34:00 -07001507 printf("== Running Application Services (non-platform)\n");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001508 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001509
Makoto Onuki60780982018-04-16 15:34:00 -07001510 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1511 DUMPSYS_COMPONENTS_OPTIONS);
1512
1513 printf("========================================================\n");
1514 printf("== Running Application Providers (platform)\n");
1515 printf("========================================================\n");
1516
1517 RunDumpsys("APP PROVIDERS PLATFORM", {"activity", "provider", "all-platform"},
1518 DUMPSYS_COMPONENTS_OPTIONS);
1519
1520 printf("========================================================\n");
1521 printf("== Running Application Providers (non-platform)\n");
1522 printf("========================================================\n");
1523
1524 RunDumpsys("APP PROVIDERS NON-PLATFORM", {"activity", "provider", "all-non-platform"},
1525 DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001526
Adrian Roos8b397ab2017-04-04 16:35:44 -07001527 printf("========================================================\n");
1528 printf("== Dropbox crashes\n");
1529 printf("========================================================\n");
1530
1531 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1532 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1533
Felipe Lemed8b94e52016-12-08 10:21:44 -08001534 printf("========================================================\n");
1535 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1536 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1537 printf("========================================================\n");
1538 printf("== dumpstate: done (id %d)\n", ds.id_);
1539 printf("========================================================\n");
Bookatz38472142018-09-28 10:20:24 -07001540
1541 printf("========================================================\n");
1542 printf("== Obtaining statsd metadata\n");
1543 printf("========================================================\n");
1544 // This differs from the usual dumpsys stats, which is the stats report data.
1545 RunDumpsys("STATSDSTATS", {"stats", "--metadata"});
Mike Ma5c267872019-08-21 11:31:34 -07001546
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +09001547 // Add linker configuration directory
1548 ds.AddDir(LINKERCONFIG_DIR, true);
1549
Mike Ma5c267872019-08-21 11:31:34 -07001550 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpIncidentReport);
1551
Nandana Dutt5c390032019-03-12 10:52:56 +00001552 return Dumpstate::RunStatus::OK;
Colin Crossf45fa6b2012-03-26 12:38:26 -07001553}
1554
Nandana Dutt5c390032019-03-12 10:52:56 +00001555/*
1556 * Dumps state for the default case; drops root after it's no longer necessary.
1557 *
1558 * Returns RunStatus::OK if everything went fine.
1559 * Returns RunStatus::ERROR if there was an error.
1560 * Returns RunStatus::USER_DENIED_CONSENT if user explicitly denied consent to sharing the bugreport
1561 * with the caller.
1562 */
1563static Dumpstate::RunStatus DumpstateDefault() {
Nandana Duttcf419a72019-03-14 10:40:17 +00001564 // Invoking the following dumpsys calls before DumpTraces() to try and
Nandana Dutt4be45d12018-09-26 15:04:23 +01001565 // keep the system stats as close to its initial state as possible.
Nandana Dutt5c390032019-03-12 10:52:56 +00001566 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysCritical);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001567
Nandana Duttdb379fa2019-10-09 16:54:41 +01001568 // Capture first logcat early on; useful to take a snapshot before dumpstate logs take over the
1569 // buffer.
1570 DoLogcat();
1571 // Capture timestamp after first logcat to use in next logcat
1572 time_t logcat_ts = time(nullptr);
1573
Nandana Dutt4be45d12018-09-26 15:04:23 +01001574 /* collect stack traces from Dalvik and native processes (needs root) */
Nandana Duttcf419a72019-03-14 10:40:17 +00001575 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(ds.DumpTraces, &dump_traces_path);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001576
1577 /* Run some operations that require root. */
1578 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX, !ds.IsZipping());
1579 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX, !ds.IsZipping());
1580
1581 ds.AddDir(RECOVERY_DIR, true);
1582 ds.AddDir(RECOVERY_DATA_DIR, true);
1583 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
1584 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1585 if (!PropertiesHelper::IsUserBuild()) {
1586 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1587 ds.AddDir(PROFILE_DATA_DIR_REF, true);
Calin Juravle78a0d842020-04-28 15:31:12 -07001588 ds.AddZipEntry(ZIP_ROOT_DIR + PACKAGE_DEX_USE_LIST, PACKAGE_DEX_USE_LIST);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001589 }
Jerry Changa1df8a92020-01-02 16:03:39 +08001590 ds.AddDir(PREREBOOT_DATA_DIR, false);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001591 add_mountinfo();
1592 DumpIpTablesAsRoot();
David Andersond9ba4752018-12-11 18:26:59 -08001593 DumpDynamicPartitionInfo();
Yifan Hong3945e1b2019-10-29 12:59:23 -07001594 ds.AddDir(OTA_METADATA_DIR, true);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001595
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001596 // Capture any IPSec policies in play. No keys are exposed here.
Nandana Dutt4be45d12018-09-26 15:04:23 +01001597 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1598
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001599 // Dump IPsec stats. No keys are exposed here.
1600 DumpFile("XFRM STATS", XFRM_STAT_PROC_FILE);
1601
Nandana Dutt4be45d12018-09-26 15:04:23 +01001602 // Run ss as root so we can see socket marks.
1603 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
1604
1605 // Run iotop as root to show top 100 IO threads
1606 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
1607
Erick Reyese68df822019-02-11 14:46:36 -08001608 // Gather shared memory buffer info if the product implements it
1609 struct stat st;
1610 if (!stat("/product/bin/dmabuf_dump", &st)) {
1611 RunCommand("Dmabuf dump", {"/product/bin/dmabuf_dump"});
1612 }
1613
Minchan Kim22c6a1e2019-09-30 15:58:10 -07001614 DumpFile("PSI cpu", "/proc/pressure/cpu");
1615 DumpFile("PSI memory", "/proc/pressure/memory");
1616 DumpFile("PSI io", "/proc/pressure/io");
1617
Nandana Dutt4be45d12018-09-26 15:04:23 +01001618 if (!DropRootUser()) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001619 return Dumpstate::RunStatus::ERROR;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001620 }
1621
Nandana Dutt5c390032019-03-12 10:52:56 +00001622 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttdb379fa2019-10-09 16:54:41 +01001623 Dumpstate::RunStatus status = dumpstate();
1624 // Capture logcat since the last time we did it.
1625 DoSystemLogcat(logcat_ts);
1626 return status;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001627}
1628
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001629// This method collects common dumpsys for telephony and wifi. Typically, wifi
1630// reports are fine to include all information, but telephony reports on user
1631// builds need to strip some content (see DumpstateTelephonyOnly).
1632static void DumpstateRadioCommon(bool include_sensitive_info = true) {
Jayachandran Ca94c7172017-06-10 15:08:12 -07001633 DumpIpTablesAsRoot();
1634
Jayachandran C69968272019-07-08 09:46:05 -07001635 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1636
Jayachandran Ca94c7172017-06-10 15:08:12 -07001637 if (!DropRootUser()) {
1638 return;
1639 }
1640
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001641 // We need to be picky about some stuff for telephony reports on user builds.
1642 if (!include_sensitive_info) {
1643 // Only dump the radio log buffer (other buffers and dumps contain too much unrelated info).
1644 DoRadioLogcat();
1645 } else {
1646 // Contains various system properties and process startup info.
1647 do_dmesg();
1648 // Logs other than the radio buffer may contain package/component names and potential PII.
1649 DoLogcat();
1650 // Too broad for connectivity problems.
1651 DoKmsg();
1652 // Contains unrelated hardware info (camera, NFC, biometrics, ...).
1653 DumpHals();
1654 }
1655
Jayachandran Ca94c7172017-06-10 15:08:12 -07001656 DumpPacketStats();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001657 DumpIpAddrAndRules();
1658 dump_route_tables();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001659 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
1660 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08001661}
1662
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001663// We use "telephony" here for legacy reasons, though this now really means "connectivity" (cellular
1664// + wifi + networking). This method collects dumpsys for connectivity debugging only. General rules
1665// for what can be included on user builds: all reported information MUST directly relate to
1666// connectivity debugging or customer support and MUST NOT contain unrelated personally identifiable
1667// information. This information MUST NOT identify user-installed packages (UIDs are OK, package
1668// names are not), and MUST NOT contain logs of user application traffic.
1669// TODO(b/148168577) rename this and other related fields/methods to "connectivity" instead.
mukesh agrawal253dad42018-01-23 21:59:59 -08001670static void DumpstateTelephonyOnly() {
1671 DurationReporter duration_reporter("DUMPSTATE");
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001672
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001673 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08001674
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001675 const bool include_sensitive_info = !PropertiesHelper::IsUserBuild();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001676
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001677 DumpstateRadioCommon(include_sensitive_info);
1678
1679 if (include_sensitive_info) {
1680 // Contains too much unrelated PII, and given the unstructured nature of sysprops, we can't
1681 // really cherrypick all of the connectivity-related ones. Apps generally have no business
1682 // reading these anyway, and there should be APIs to supply the info in a more app-friendly
1683 // way.
1684 RunCommand("SYSTEM PROPERTIES", {"getprop"});
1685 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07001686
1687 printf("========================================================\n");
1688 printf("== Android Framework Services\n");
1689 printf("========================================================\n");
1690
Vishnu Nair652cc802017-11-30 15:18:30 -08001691 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1692 SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001693 // TODO(b/146521742) build out an argument to include bound services here for user builds
Vishnu Nair652cc802017-11-30 15:18:30 -08001694 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
1695 SEC_TO_MSEC(10));
Amruth Ramachandrand25a9142018-04-02 16:16:09 -07001696 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
1697 SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001698 RunDumpsys("DUMPSYS", {"netpolicy"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
1699 RunDumpsys("DUMPSYS", {"network_management"}, CommandOptions::WithTimeout(90).Build(),
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07001700 SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001701 if (include_sensitive_info) {
1702 // Contains raw IP addresses, omit from reports on user builds.
1703 RunDumpsys("DUMPSYS", {"netd"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
1704 // Contains raw destination IP/MAC addresses, omit from reports on user builds.
1705 RunDumpsys("DUMPSYS", {"connmetrics"}, CommandOptions::WithTimeout(90).Build(),
1706 SEC_TO_MSEC(10));
1707 // Contains package/component names, omit from reports on user builds.
1708 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
1709 SEC_TO_MSEC(10));
1710 // Contains package names, but should be relatively simple to remove them (also contains
1711 // UIDs already), omit from reports on user builds.
1712 RunDumpsys("BATTERYSTATS", {"deviceidle"}, CommandOptions::WithTimeout(90).Build(),
1713 SEC_TO_MSEC(10));
1714 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07001715
1716 printf("========================================================\n");
1717 printf("== Running Application Services\n");
1718 printf("========================================================\n");
1719
1720 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
1721
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001722 if (include_sensitive_info) {
1723 printf("========================================================\n");
1724 printf("== Running Application Services (non-platform)\n");
1725 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001726
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001727 // Contains package/component names and potential PII, omit from reports on user builds.
1728 // To get dumps of the active CarrierService(s) on user builds, we supply an argument to the
1729 // carrier_config dumpsys instead.
1730 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1731 DUMPSYS_COMPONENTS_OPTIONS);
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001732
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001733 printf("========================================================\n");
1734 printf("== Checkins\n");
1735 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07001736
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001737 // Contains package/component names, omit from reports on user builds.
1738 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
1739 }
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07001740
1741 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07001742 printf("== dumpstate: done (id %d)\n", ds.id_);
1743 printf("========================================================\n");
1744}
1745
mukesh agrawal253dad42018-01-23 21:59:59 -08001746// This method collects dumpsys for wifi debugging only
1747static void DumpstateWifiOnly() {
1748 DurationReporter duration_reporter("DUMPSTATE");
1749
1750 DumpstateRadioCommon();
1751
1752 printf("========================================================\n");
1753 printf("== Android Framework Services\n");
1754 printf("========================================================\n");
1755
1756 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1757 SEC_TO_MSEC(10));
1758 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
1759 SEC_TO_MSEC(10));
1760
1761 printf("========================================================\n");
1762 printf("== dumpstate: done (id %d)\n", ds.id_);
1763 printf("========================================================\n");
1764}
1765
Nandana Duttcf419a72019-03-14 10:40:17 +00001766Dumpstate::RunStatus Dumpstate::DumpTraces(const char** path) {
Nandana Duttfaafd522019-03-11 09:23:09 +00001767 DurationReporter duration_reporter("DUMP TRACES");
1768
1769 const std::string temp_file_pattern = "/data/anr/dumptrace_XXXXXX";
1770 const size_t buf_size = temp_file_pattern.length() + 1;
1771 std::unique_ptr<char[]> file_name_buf(new char[buf_size]);
1772 memcpy(file_name_buf.get(), temp_file_pattern.c_str(), buf_size);
1773
1774 // Create a new, empty file to receive all trace dumps.
1775 //
1776 // TODO: This can be simplified once we remove support for the old style
1777 // dumps. We can have a file descriptor passed in to dump_traces instead
1778 // of creating a file, closing it and then reopening it again.
1779 android::base::unique_fd fd(mkostemp(file_name_buf.get(), O_APPEND | O_CLOEXEC));
1780 if (fd < 0) {
1781 MYLOGE("mkostemp on pattern %s: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001782 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001783 }
1784
1785 // Nobody should have access to this temporary file except dumpstate, but we
1786 // temporarily grant 'read' to 'others' here because this file is created
1787 // when tombstoned is still running as root, but dumped after dropping. This
1788 // can go away once support for old style dumping has.
1789 const int chmod_ret = fchmod(fd, 0666);
1790 if (chmod_ret < 0) {
1791 MYLOGE("fchmod on %s failed: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001792 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001793 }
1794
1795 std::unique_ptr<DIR, decltype(&closedir)> proc(opendir("/proc"), closedir);
1796 if (proc.get() == nullptr) {
1797 MYLOGE("opendir /proc failed: %s\n", strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001798 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001799 }
1800
1801 // Number of times process dumping has timed out. If we encounter too many
1802 // failures, we'll give up.
1803 int timeout_failures = 0;
1804 bool dalvik_found = false;
1805
1806 const std::set<int> hal_pids = get_interesting_hal_pids();
1807
1808 struct dirent* d;
1809 while ((d = readdir(proc.get()))) {
Nandana Duttcf419a72019-03-14 10:40:17 +00001810 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttfaafd522019-03-11 09:23:09 +00001811 int pid = atoi(d->d_name);
1812 if (pid <= 0) {
1813 continue;
1814 }
1815
1816 const std::string link_name = android::base::StringPrintf("/proc/%d/exe", pid);
1817 std::string exe;
1818 if (!android::base::Readlink(link_name, &exe)) {
1819 continue;
1820 }
1821
1822 bool is_java_process;
1823 if (exe == "/system/bin/app_process32" || exe == "/system/bin/app_process64") {
1824 // Don't bother dumping backtraces for the zygote.
1825 if (IsZygote(pid)) {
1826 continue;
1827 }
1828
1829 dalvik_found = true;
1830 is_java_process = true;
1831 } else if (should_dump_native_traces(exe.c_str()) || hal_pids.find(pid) != hal_pids.end()) {
1832 is_java_process = false;
1833 } else {
1834 // Probably a native process we don't care about, continue.
1835 continue;
1836 }
1837
1838 // If 3 backtrace dumps fail in a row, consider debuggerd dead.
1839 if (timeout_failures == 3) {
1840 dprintf(fd, "ERROR: Too many stack dump failures, exiting.\n");
1841 break;
1842 }
1843
1844 const uint64_t start = Nanotime();
1845 const int ret = dump_backtrace_to_file_timeout(
1846 pid, is_java_process ? kDebuggerdJavaBacktrace : kDebuggerdNativeBacktrace,
1847 is_java_process ? 5 : 20, fd);
1848
1849 if (ret == -1) {
1850 // For consistency, the header and footer to this message match those
1851 // dumped by debuggerd in the success case.
1852 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
1853 dprintf(fd, "Dump failed, likely due to a timeout.\n");
1854 dprintf(fd, "---- end %d ----", pid);
1855 timeout_failures++;
1856 continue;
1857 }
1858
1859 // We've successfully dumped stack traces, reset the failure count
1860 // and write a summary of the elapsed time to the file and continue with the
1861 // next process.
1862 timeout_failures = 0;
1863
1864 dprintf(fd, "[dump %s stack %d: %.3fs elapsed]\n", is_java_process ? "dalvik" : "native",
1865 pid, (float)(Nanotime() - start) / NANOS_PER_SEC);
1866 }
1867
1868 if (!dalvik_found) {
1869 MYLOGE("Warning: no Dalvik processes found to dump stacks\n");
1870 }
1871
Nandana Duttcf419a72019-03-14 10:40:17 +00001872 *path = file_name_buf.release();
1873 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001874}
1875
Felipe Leme6f674ae2016-11-18 17:10:33 -08001876void Dumpstate::DumpstateBoard() {
1877 DurationReporter duration_reporter("dumpstate_board()");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001878 printf("========================================================\n");
1879 printf("== Board\n");
1880 printf("========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001881
Felipe Leme6f674ae2016-11-18 17:10:33 -08001882 if (!IsZipping()) {
Steven Moreland7440ddb2016-12-15 16:13:39 -08001883 MYLOGD("Not dumping board info because it's not a zipped bugreport\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001884 return;
1885 }
1886
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001887 std::vector<std::string> paths;
1888 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07001889 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00001890 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
1891 kDumpstateBoardFiles[i].c_str()));
Nandana Dutt16d1aee2019-02-15 16:13:53 +00001892 remover.emplace_back(android::base::make_scope_guard(
1893 std::bind([](std::string path) { android::os::UnlinkAndLogOnError(path); }, paths[i])));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001894 }
Jie Song9fbfad02017-06-20 16:29:42 -07001895
Wei Wang587eac92018-04-05 12:17:20 -07001896 sp<IDumpstateDevice> dumpstate_device(IDumpstateDevice::getService());
1897 if (dumpstate_device == nullptr) {
1898 MYLOGE("No IDumpstateDevice implementation\n");
1899 return;
1900 }
1901
1902 using ScopedNativeHandle =
1903 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
1904 ScopedNativeHandle handle(native_handle_create(static_cast<int>(paths.size()), 0),
1905 [](native_handle_t* handle) {
1906 native_handle_close(handle);
1907 native_handle_delete(handle);
1908 });
1909 if (handle == nullptr) {
1910 MYLOGE("Could not create native_handle\n");
1911 return;
1912 }
1913
Nandana Dutt5c390032019-03-12 10:52:56 +00001914 // TODO(128270426): Check for consent in between?
Wei Wang587eac92018-04-05 12:17:20 -07001915 for (size_t i = 0; i < paths.size(); i++) {
1916 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
1917
1918 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
1919 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1920 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1921 if (fd < 0) {
1922 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
1923 return;
1924 }
1925 handle.get()->data[i] = fd.release();
1926 }
1927
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001928 // Given that bugreport is required to diagnose failures, it's better to
Wei Wang587eac92018-04-05 12:17:20 -07001929 // set an arbitrary amount of timeout for IDumpstateDevice than to block the
1930 // rest of bugreport. In the timeout case, we will kill dumpstate board HAL
1931 // and grab whatever dumped
1932 std::packaged_task<bool()>
1933 dumpstate_task([paths, dumpstate_device, &handle]() -> bool {
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001934 android::hardware::Return<void> status = dumpstate_device->dumpstateBoard(handle.get());
1935 if (!status.isOk()) {
1936 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
Wei Wang587eac92018-04-05 12:17:20 -07001937 return false;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001938 }
Wei Wang587eac92018-04-05 12:17:20 -07001939 return true;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001940 });
Wei Wang587eac92018-04-05 12:17:20 -07001941
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001942 auto result = dumpstate_task.get_future();
1943 std::thread(std::move(dumpstate_task)).detach();
Wei Wang587eac92018-04-05 12:17:20 -07001944
1945 constexpr size_t timeout_sec = 30;
1946 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
1947 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate vendor HAL\n", timeout_sec);
1948 if (!android::base::SetProperty("ctl.interface_restart",
1949 android::base::StringPrintf("%s/default",
1950 IDumpstateDevice::descriptor))) {
1951 MYLOGE("Couldn't restart dumpstate HAL\n");
1952 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001953 }
Wei Wang587eac92018-04-05 12:17:20 -07001954 // Wait some time for init to kill dumpstate vendor HAL
1955 constexpr size_t killing_timeout_sec = 10;
1956 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
1957 MYLOGE("killing dumpstateBoard timed out after %zus, continue and "
1958 "there might be racing in content\n", killing_timeout_sec);
1959 }
1960
1961 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
1962 for (size_t i = 0; i < paths.size(); i++) {
1963 struct stat s;
1964 if (fstat(handle.get()->data[i], &s) == -1) {
1965 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(),
1966 strerror(errno));
1967 file_sizes[i] = -1;
1968 continue;
1969 }
1970 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001971 }
1972
1973 for (size_t i = 0; i < paths.size(); i++) {
1974 if (file_sizes[i] == -1) {
1975 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07001976 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001977 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07001978 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001979 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07001980 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001981 AddZipEntry(kDumpstateBoardFiles[i], paths[i]);
Jie Song9fbfad02017-06-20 16:29:42 -07001982 }
1983
Felipe Lemed8b94e52016-12-08 10:21:44 -08001984 printf("*** See dumpstate-board.txt entry ***\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001985}
1986
Nandana Dutt12ae14a2019-01-09 10:35:53 +00001987static void ShowUsage() {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001988 fprintf(stderr,
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001989 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-d] [-p] "
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001990 "[-z]] [-s] [-S] [-q] [-B] [-P] [-R] [-V version]\n"
1991 " -h: display this help message\n"
1992 " -b: play sound file instead of vibrate, at beginning of job\n"
1993 " -e: play sound file instead of vibrate, at end of job\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001994 " -d: append date to filename\n"
1995 " -p: capture screenshot to filename.png\n"
1996 " -z: generate zipped file\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001997 " -s: write output to control socket (for init)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001998 " -S: write file location to control socket (for init; requires -z)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001999 " -q: disable vibrate\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01002000 " -B: send broadcast when finished\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002001 " -P: send broadcast when started and update system properties on "
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01002002 "progress (requires -B)\n"
2003 " -R: take bugreport in remote mode (requires -z, -d and -B, "
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002004 "shouldn't be used with -P)\n"
Nandana Dutt235864b2019-01-22 12:10:16 +00002005 " -w: start binder service and make it wait for a call to startBugreport\n"
Felipe Lemed071c682016-10-20 16:48:00 -07002006 " -v: prints the dumpstate header and exit\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002007}
2008
Wei Liuf87959e2016-08-26 14:51:42 -07002009static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07002010 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07002011}
2012
Felipe Leme1d486fe2016-10-14 18:06:47 -07002013bool Dumpstate::FinishZipFile() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07002014 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07002015 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07002016 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002017 // Final timestamp
2018 char date[80];
2019 time_t the_real_now_please_stand_up = time(nullptr);
2020 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002021 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07002022 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002023
Felipe Leme9a523ae2016-10-20 15:10:33 -07002024 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002025 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08002026 return false;
2027 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07002028 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002029 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08002030 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08002031 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08002032
Felipe Leme0f3fb202016-06-10 17:10:53 -07002033 // Add log file (which contains stderr output) to zip...
2034 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07002035 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07002036 MYLOGE("Failed to add dumpstate log to .zip file\n");
2037 return false;
2038 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002039 // TODO: Should truncate the existing file.
2040 // ... and re-open it for further logging.
Nandana Dutta344cb62019-02-22 15:12:35 +00002041 if (!redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()))) {
2042 return false;
2043 }
Felipe Leme0f3fb202016-06-10 17:10:53 -07002044 fprintf(stderr, "\n");
2045
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002046 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07002047 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002048 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002049 return false;
2050 }
2051
Felipe Leme1d486fe2016-10-14 18:06:47 -07002052 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
2053 ds.zip_file.reset(nullptr);
2054
Felipe Lemee9d2c542016-11-15 11:48:26 -08002055 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002056 android::os::UnlinkAndLogOnError(tmp_path_);
Felipe Lemec4eee562016-04-21 15:42:55 -07002057
Felipe Leme1e9edc62015-12-21 16:02:13 -08002058 return true;
2059}
Felipe Leme6e01fa62015-11-11 19:35:14 -08002060
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -07002061static std::string SHA256_file_hash(const std::string& filepath) {
Andreas Gampe27cd7b22016-07-18 18:24:05 -07002062 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(filepath.c_str(), O_RDONLY | O_NONBLOCK
2063 | O_CLOEXEC | O_NOFOLLOW)));
Andreas Gampeaff68432016-07-18 18:01:27 -07002064 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002065 MYLOGE("open(%s): %s\n", filepath.c_str(), strerror(errno));
Yi Kong19d5c002018-07-20 13:39:55 -07002066 return nullptr;
Michal Karpinski4db754f2015-12-11 18:04:32 +00002067 }
2068
2069 SHA256_CTX ctx;
Elliott Hughesc4dc1412016-04-12 16:28:31 -07002070 SHA256_Init(&ctx);
Michal Karpinski4db754f2015-12-11 18:04:32 +00002071
2072 std::vector<uint8_t> buffer(65536);
2073 while (1) {
2074 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd.get(), buffer.data(), buffer.size()));
2075 if (bytes_read == 0) {
2076 break;
2077 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002078 MYLOGE("read(%s): %s\n", filepath.c_str(), strerror(errno));
Yi Kong19d5c002018-07-20 13:39:55 -07002079 return nullptr;
Michal Karpinski4db754f2015-12-11 18:04:32 +00002080 }
2081
Elliott Hughesc4dc1412016-04-12 16:28:31 -07002082 SHA256_Update(&ctx, buffer.data(), bytes_read);
Michal Karpinski4db754f2015-12-11 18:04:32 +00002083 }
2084
Elliott Hughesc4dc1412016-04-12 16:28:31 -07002085 uint8_t hash[SHA256_DIGEST_LENGTH];
2086 SHA256_Final(hash, &ctx);
2087
2088 char hash_buffer[SHA256_DIGEST_LENGTH * 2 + 1];
2089 for(size_t i = 0; i < SHA256_DIGEST_LENGTH; i++) {
Michal Karpinskicbbdf732016-01-07 20:45:02 +00002090 sprintf(hash_buffer + (i * 2), "%02x", hash[i]);
Michal Karpinski4db754f2015-12-11 18:04:32 +00002091 }
2092 hash_buffer[sizeof(hash_buffer) - 1] = 0;
2093 return std::string(hash_buffer);
2094}
2095
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002096static void SendBroadcast(const std::string& action, const std::vector<std::string>& args) {
2097 // clang-format off
2098 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user", "0",
2099 "--receiver-foreground", "--receiver-include-background", "-a", action};
2100 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08002101
2102 am.insert(am.end(), args.begin(), args.end());
2103
Felipe Leme8d2410e2017-02-08 09:46:08 -08002104 RunCommand("", am,
2105 CommandOptions::WithTimeout(20)
2106 .Log("Sending broadcast: '%s'\n")
2107 .Always()
2108 .DropRoot()
2109 .RedirectStderr()
2110 .Build());
2111}
2112
Felipe Leme35b8cf12017-02-10 15:47:29 -08002113static void Vibrate(int duration_ms) {
2114 // clang-format off
Chris Fries0c3de872019-09-14 15:49:41 +00002115 RunCommand("", {"cmd", "vibrator", "vibrate", "-f", std::to_string(duration_ms), "dumpstate"},
Felipe Leme35b8cf12017-02-10 15:47:29 -08002116 CommandOptions::WithTimeout(10)
2117 .Log("Vibrate: '%s'\n")
2118 .Always()
2119 .Build());
2120 // clang-format on
2121}
2122
Nandana Dutt979388e2018-11-30 16:48:55 +00002123static void MaybeResolveSymlink(std::string* path) {
2124 std::string resolved_path;
2125 if (android::base::Readlink(*path, &resolved_path)) {
2126 *path = resolved_path;
2127 }
2128}
2129
Nandana Dutt4be45d12018-09-26 15:04:23 +01002130/*
2131 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
2132 * if we are writing zip files and adds the version file.
2133 */
2134static void PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002135 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
2136
Nandana Dutt4be45d12018-09-26 15:04:23 +01002137 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
2138 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002139 ds.base_name_ = StringPrintf("bugreport-%s-%s", device_name.c_str(), build_id.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002140 if (ds.options_->do_add_date) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002141 char date[80];
2142 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
2143 ds.name_ = date;
2144 } else {
2145 ds.name_ = "undated";
2146 }
2147
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002148 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002149 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002150 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002151 ds.base_name_ += "-wifi";
2152 }
2153
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002154 if (ds.options_->do_fb) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002155 ds.screenshot_path_ = ds.GetPath(".png");
2156 }
2157 ds.tmp_path_ = ds.GetPath(".tmp");
2158 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
2159
Nandana Dutt54dbd672019-01-11 12:58:05 +00002160 std::string destination = ds.options_->bugreport_fd.get() != -1
2161 ? StringPrintf("[fd:%d]", ds.options_->bugreport_fd.get())
Nandana Dutt9a76d202019-01-21 15:56:48 +00002162 : ds.bugreport_internal_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01002163 MYLOGD(
2164 "Bugreport dir: %s\n"
2165 "Base name: %s\n"
2166 "Suffix: %s\n"
2167 "Log path: %s\n"
2168 "Temporary path: %s\n"
2169 "Screenshot path: %s\n",
Nandana Dutt9a76d202019-01-21 15:56:48 +00002170 destination.c_str(), ds.base_name_.c_str(), ds.name_.c_str(), ds.log_path_.c_str(),
2171 ds.tmp_path_.c_str(), ds.screenshot_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002172
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002173 if (ds.options_->do_zip_file) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002174 ds.path_ = ds.GetPath(".zip");
2175 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
2176 create_parent_dirs(ds.path_.c_str());
2177 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
2178 if (ds.zip_file == nullptr) {
2179 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
2180 } else {
2181 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
2182 }
2183 ds.AddTextZipEntry("version.txt", ds.version_);
2184 }
2185}
2186
2187/*
2188 * Finalizes writing to the file by renaming or zipping the tmp file to the final location,
2189 * printing zipped file status, etc.
2190 */
2191static void FinalizeFile() {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002192 /* check if user changed the suffix using system properties */
2193 std::string name =
2194 android::base::GetProperty(android::base::StringPrintf("dumpstate.%d.name", ds.pid_), "");
2195 bool change_suffix = false;
2196 if (!name.empty()) {
2197 /* must whitelist which characters are allowed, otherwise it could cross directories */
2198 std::regex valid_regex("^[-_a-zA-Z0-9]+$");
2199 if (std::regex_match(name.c_str(), valid_regex)) {
2200 change_suffix = true;
2201 } else {
2202 MYLOGE("invalid suffix provided by user: %s\n", name.c_str());
2203 }
2204 }
2205 if (change_suffix) {
2206 MYLOGI("changing suffix from %s to %s\n", ds.name_.c_str(), name.c_str());
2207 ds.name_ = name;
2208 if (!ds.screenshot_path_.empty()) {
2209 std::string new_screenshot_path = ds.GetPath(".png");
2210 if (rename(ds.screenshot_path_.c_str(), new_screenshot_path.c_str())) {
2211 MYLOGE("rename(%s, %s): %s\n", ds.screenshot_path_.c_str(),
2212 new_screenshot_path.c_str(), strerror(errno));
2213 } else {
2214 ds.screenshot_path_ = new_screenshot_path;
2215 }
2216 }
2217 }
2218
2219 bool do_text_file = true;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002220 if (ds.options_->do_zip_file) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002221 if (!ds.FinishZipFile()) {
2222 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
2223 do_text_file = true;
2224 } else {
2225 do_text_file = false;
Nandana Dutt383d0c12018-11-30 15:54:56 +00002226 // If the user has changed the suffix, we need to change the zip file name.
2227 std::string new_path = ds.GetPath(".zip");
2228 if (ds.path_ != new_path) {
2229 MYLOGD("Renaming zip file from %s to %s\n", ds.path_.c_str(), new_path.c_str());
2230 if (rename(ds.path_.c_str(), new_path.c_str())) {
2231 MYLOGE("rename(%s, %s): %s\n", ds.path_.c_str(), new_path.c_str(),
2232 strerror(errno));
2233 } else {
2234 ds.path_ = new_path;
2235 }
2236 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01002237 }
2238 }
2239 if (do_text_file) {
2240 ds.path_ = ds.GetPath(".txt");
2241 MYLOGD("Generating .txt bugreport at %s from %s\n", ds.path_.c_str(), ds.tmp_path_.c_str());
2242 if (rename(ds.tmp_path_.c_str(), ds.path_.c_str())) {
2243 MYLOGE("rename(%s, %s): %s\n", ds.tmp_path_.c_str(), ds.path_.c_str(), strerror(errno));
2244 ds.path_.clear();
2245 }
2246 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002247 if (ds.options_->use_control_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002248 if (do_text_file) {
2249 dprintf(ds.control_socket_fd_,
2250 "FAIL:could not create zip file, check %s "
2251 "for more details\n",
2252 ds.log_path_.c_str());
2253 } else {
2254 dprintf(ds.control_socket_fd_, "OK:%s\n", ds.path_.c_str());
2255 }
2256 }
2257}
2258
2259/* Broadcasts that we are done with the bugreport */
2260static void SendBugreportFinishedBroadcast() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002261 // TODO(b/111441001): use callback instead of broadcast.
Nandana Dutt9a76d202019-01-21 15:56:48 +00002262 if (!ds.path_.empty()) {
2263 MYLOGI("Final bugreport path: %s\n", ds.path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002264 // clang-format off
2265
2266 std::vector<std::string> am_args = {
2267 "--receiver-permission", "android.permission.DUMP",
2268 "--ei", "android.intent.extra.ID", std::to_string(ds.id_),
2269 "--ei", "android.intent.extra.PID", std::to_string(ds.pid_),
2270 "--ei", "android.intent.extra.MAX", std::to_string(ds.progress_->GetMax()),
Nandana Dutt9a76d202019-01-21 15:56:48 +00002271 "--es", "android.intent.extra.BUGREPORT", ds.path_,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002272 "--es", "android.intent.extra.DUMPSTATE_LOG", ds.log_path_
2273 };
2274 // clang-format on
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +00002275 if (ds.options_->do_fb && !android::os::IsFileEmpty(ds.screenshot_path_)) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002276 am_args.push_back("--es");
2277 am_args.push_back("android.intent.extra.SCREENSHOT");
2278 am_args.push_back(ds.screenshot_path_);
2279 }
Nandana Dutt15b89d72018-11-16 14:14:12 +00002280 if (!ds.options_->notification_title.empty()) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002281 am_args.push_back("--es");
2282 am_args.push_back("android.intent.extra.TITLE");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002283 am_args.push_back(ds.options_->notification_title);
2284 if (!ds.options_->notification_description.empty()) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002285 am_args.push_back("--es");
2286 am_args.push_back("android.intent.extra.DESCRIPTION");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002287 am_args.push_back(ds.options_->notification_description);
Nandana Dutt4be45d12018-09-26 15:04:23 +01002288 }
2289 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002290 if (ds.options_->is_remote_mode) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002291 am_args.push_back("--es");
2292 am_args.push_back("android.intent.extra.REMOTE_BUGREPORT_HASH");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002293 am_args.push_back(SHA256_file_hash(ds.path_));
Nandana Dutt4be45d12018-09-26 15:04:23 +01002294 SendBroadcast("com.android.internal.intent.action.REMOTE_BUGREPORT_FINISHED", am_args);
2295 } else {
2296 SendBroadcast("com.android.internal.intent.action.BUGREPORT_FINISHED", am_args);
2297 }
2298 } else {
2299 MYLOGE("Skipping finished broadcast because bugreport could not be generated\n");
2300 }
2301}
2302
Nandana Dutt58d72e22018-11-16 10:30:48 +00002303static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2304 switch (mode) {
2305 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2306 return "BUGREPORT_FULL";
2307 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2308 return "BUGREPORT_INTERACTIVE";
2309 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2310 return "BUGREPORT_REMOTE";
2311 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2312 return "BUGREPORT_WEAR";
2313 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2314 return "BUGREPORT_TELEPHONY";
2315 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2316 return "BUGREPORT_WIFI";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002317 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2318 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002319 }
2320}
2321
2322static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options) {
Abhijeet Kaur8ca245e2018-12-12 10:34:21 +00002323 options->extra_options = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002324 switch (mode) {
2325 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2326 options->do_broadcast = true;
2327 options->do_fb = true;
2328 break;
2329 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002330 // Currently, the dumpstate binder is only used by Shell to update progress.
2331 options->do_start_service = true;
2332 options->do_progress_updates = true;
2333 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002334 options->do_broadcast = true;
2335 break;
2336 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002337 options->do_vibrate = false;
2338 options->is_remote_mode = true;
2339 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002340 options->do_broadcast = true;
2341 break;
2342 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002343 options->do_start_service = true;
2344 options->do_progress_updates = true;
2345 options->do_zip_file = true;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002346 options->do_fb = true;
2347 options->do_broadcast = true;
2348 break;
2349 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002350 options->telephony_only = true;
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002351 options->do_progress_updates = true;
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +00002352 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002353 options->do_broadcast = true;
2354 break;
2355 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002356 options->wifi_only = true;
2357 options->do_zip_file = true;
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +00002358 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002359 options->do_broadcast = true;
2360 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002361 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2362 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002363 }
2364}
2365
2366static Dumpstate::BugreportMode getBugreportModeFromProperty() {
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002367 // If the system property is not set, it's assumed to be a default bugreport.
2368 Dumpstate::BugreportMode mode = Dumpstate::BugreportMode::BUGREPORT_DEFAULT;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002369
2370 std::string extra_options = android::base::GetProperty(PROPERTY_EXTRA_OPTIONS, "");
2371 if (!extra_options.empty()) {
2372 // Framework uses a system property to override some command-line args.
2373 // Currently, it contains the type of the requested bugreport.
2374 if (extra_options == "bugreportplus") {
2375 mode = Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002376 } else if (extra_options == "bugreportfull") {
2377 mode = Dumpstate::BugreportMode::BUGREPORT_FULL;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002378 } else if (extra_options == "bugreportremote") {
2379 mode = Dumpstate::BugreportMode::BUGREPORT_REMOTE;
2380 } else if (extra_options == "bugreportwear") {
2381 mode = Dumpstate::BugreportMode::BUGREPORT_WEAR;
2382 } else if (extra_options == "bugreporttelephony") {
2383 mode = Dumpstate::BugreportMode::BUGREPORT_TELEPHONY;
2384 } else if (extra_options == "bugreportwifi") {
2385 mode = Dumpstate::BugreportMode::BUGREPORT_WIFI;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002386 } else {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002387 MYLOGE("Unknown extra option: %s\n", extra_options.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002388 }
2389 // Reset the property
2390 android::base::SetProperty(PROPERTY_EXTRA_OPTIONS, "");
2391 }
Nandana Dutt58d72e22018-11-16 10:30:48 +00002392 return mode;
2393}
2394
2395// TODO: Move away from system properties when we have options passed via binder calls.
2396/* Sets runtime options from the system properties and then clears those properties. */
2397static void SetOptionsFromProperties(Dumpstate::DumpOptions* options) {
2398 Dumpstate::BugreportMode mode = getBugreportModeFromProperty();
2399 SetOptionsFromMode(mode, options);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002400
2401 options->notification_title = android::base::GetProperty(PROPERTY_EXTRA_TITLE, "");
2402 if (!options->notification_title.empty()) {
2403 // Reset the property
2404 android::base::SetProperty(PROPERTY_EXTRA_TITLE, "");
2405
Nandana Duttdd8cca32018-11-14 10:10:29 +00002406 options->notification_description =
2407 android::base::GetProperty(PROPERTY_EXTRA_DESCRIPTION, "");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002408 if (!options->notification_description.empty()) {
2409 // Reset the property
2410 android::base::SetProperty(PROPERTY_EXTRA_DESCRIPTION, "");
2411 }
2412 MYLOGD("notification (title: %s, description: %s)\n", options->notification_title.c_str(),
2413 options->notification_description.c_str());
2414 }
2415}
2416
Nandana Dutt58d72e22018-11-16 10:30:48 +00002417static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
2418 MYLOGI("do_zip_file: %d\n", options.do_zip_file);
2419 MYLOGI("do_add_date: %d\n", options.do_add_date);
2420 MYLOGI("do_vibrate: %d\n", options.do_vibrate);
2421 MYLOGI("use_socket: %d\n", options.use_socket);
2422 MYLOGI("use_control_socket: %d\n", options.use_control_socket);
2423 MYLOGI("do_fb: %d\n", options.do_fb);
2424 MYLOGI("do_broadcast: %d\n", options.do_broadcast);
2425 MYLOGI("is_remote_mode: %d\n", options.is_remote_mode);
2426 MYLOGI("show_header_only: %d\n", options.show_header_only);
2427 MYLOGI("do_start_service: %d\n", options.do_start_service);
2428 MYLOGI("telephony_only: %d\n", options.telephony_only);
2429 MYLOGI("wifi_only: %d\n", options.wifi_only);
2430 MYLOGI("do_progress_updates: %d\n", options.do_progress_updates);
Nandana Dutt54dbd672019-01-11 12:58:05 +00002431 MYLOGI("fd: %d\n", options.bugreport_fd.get());
Nandana Dutt58d72e22018-11-16 10:30:48 +00002432 MYLOGI("extra_options: %s\n", options.extra_options.c_str());
2433 MYLOGI("args: %s\n", options.args.c_str());
2434 MYLOGI("notification_title: %s\n", options.notification_title.c_str());
2435 MYLOGI("notification_description: %s\n", options.notification_description.c_str());
2436}
2437
Nandana Dutt54dbd672019-01-11 12:58:05 +00002438void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode,
2439 const android::base::unique_fd& bugreport_fd_in,
2440 const android::base::unique_fd& screenshot_fd_in) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002441 // In the new API world, date is always added; output is always a zip file.
2442 // TODO(111441001): remove these options once they are obsolete.
2443 do_add_date = true;
2444 do_zip_file = true;
2445
Nandana Dutt54dbd672019-01-11 12:58:05 +00002446 // Duplicate the fds because the passed in fds don't outlive the binder transaction.
2447 bugreport_fd.reset(dup(bugreport_fd_in.get()));
2448 screenshot_fd.reset(dup(screenshot_fd_in.get()));
Nandana Dutt58d72e22018-11-16 10:30:48 +00002449
2450 extra_options = ModeToString(bugreport_mode);
2451 SetOptionsFromMode(bugreport_mode, this);
2452}
2453
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002454Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
2455 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002456 int c;
Nandana Dutt235864b2019-01-22 12:10:16 +00002457 while ((c = getopt(argc, argv, "dho:svqzpPBRSV:w")) != -1) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002458 switch (c) {
2459 // clang-format off
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002460 case 'd': do_add_date = true; break;
2461 case 'z': do_zip_file = true; break;
Nandana Dutt9a76d202019-01-21 15:56:48 +00002462 // o=use_outfile not supported anymore.
2463 // TODO(b/111441001): Remove when all callers have migrated.
2464 case 'o': break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002465 case 's': use_socket = true; break;
2466 case 'S': use_control_socket = true; break;
2467 case 'v': show_header_only = true; break;
2468 case 'q': do_vibrate = false; break;
2469 case 'p': do_fb = true; break;
2470 case 'P': do_progress_updates = true; break;
2471 case 'R': is_remote_mode = true; break;
2472 case 'B': do_broadcast = true; break;
2473 case 'V': break; // compatibility no-op
Nandana Dutt235864b2019-01-22 12:10:16 +00002474 case 'w':
2475 // This was already processed
2476 break;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002477 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002478 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002479 break;
2480 default:
2481 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002482 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002483 break;
2484 // clang-format on
2485 }
2486 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08002487
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002488 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002489 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002490 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002491 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002492 }
2493 }
2494
2495 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
2496 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002497
2498 SetOptionsFromProperties(this);
2499 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002500}
2501
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002502bool Dumpstate::DumpOptions::ValidateOptions() const {
Nandana Dutt54dbd672019-01-11 12:58:05 +00002503 if (bugreport_fd.get() != -1 && !do_zip_file) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002504 return false;
2505 }
2506
Nandana Dutt9a76d202019-01-21 15:56:48 +00002507 if ((do_zip_file || do_add_date || do_progress_updates || do_broadcast) && !OutputToFile()) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002508 return false;
2509 }
2510
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002511 if (use_control_socket && !do_zip_file) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002512 return false;
2513 }
2514
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002515 if (do_progress_updates && !do_broadcast) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002516 return false;
2517 }
2518
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002519 if (is_remote_mode && (do_progress_updates || !do_broadcast || !do_zip_file || !do_add_date)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002520 return false;
2521 }
2522 return true;
2523}
2524
Nandana Dutt197661d2018-11-16 16:40:21 +00002525void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
2526 options_ = std::move(options);
2527}
2528
Nandana Duttd2f5f082019-01-18 17:13:52 +00002529Dumpstate::RunStatus Dumpstate::Run(int32_t calling_uid, const std::string& calling_package) {
2530 Dumpstate::RunStatus status = RunInternal(calling_uid, calling_package);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002531 if (listener_ != nullptr) {
2532 switch (status) {
2533 case Dumpstate::RunStatus::OK:
Nandana Duttcc4ead82019-01-23 08:29:23 +00002534 listener_->onFinished();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002535 break;
2536 case Dumpstate::RunStatus::HELP:
2537 break;
2538 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002539 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_INVALID_INPUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002540 break;
2541 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002542 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_RUNTIME_ERROR);
2543 break;
2544 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2545 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_DENIED_CONSENT);
2546 break;
2547 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
2548 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_CONSENT_TIMED_OUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002549 break;
2550 }
2551 }
2552 return status;
2553}
2554
Nandana Dutt979388e2018-11-30 16:48:55 +00002555/*
2556 * Dumps relevant information to a bugreport based on the given options.
2557 *
2558 * The bugreport can be dumped to a file or streamed to a socket.
2559 *
2560 * How dumping to file works:
2561 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
2562 * stderr is redirected a log file.
2563 *
2564 * The temporary bugreport is then populated via printfs, dumping contents of files and
2565 * output of commands to stdout.
2566 *
2567 * If zipping, the temporary bugreport file is added to the zip archive. Else it's renamed to final
2568 * text file.
2569 *
2570 * If zipping, a bunch of other files and dumps also get added to the zip archive. The log file also
2571 * gets added to the archive.
2572 *
Nandana Dutt9a76d202019-01-21 15:56:48 +00002573 * Bugreports are first generated in a local directory and later copied to the caller's fd if
2574 * supplied.
Nandana Dutt979388e2018-11-30 16:48:55 +00002575 */
Nandana Duttd2f5f082019-01-18 17:13:52 +00002576Dumpstate::RunStatus Dumpstate::RunInternal(int32_t calling_uid,
2577 const std::string& calling_package) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002578 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00002579 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002580 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002581 return RunStatus::INVALID_INPUT;
2582 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002583 /* set as high priority, and protect from OOM killer */
2584 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002585
Felipe Lemed071c682016-10-20 16:48:00 -07002586 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002587 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002588 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002589 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002590 } else {
2591 /* fallback to kernels <= 2.6.35 */
2592 oom_adj = fopen("/proc/self/oom_adj", "we");
2593 if (oom_adj) {
2594 fputs("-17", oom_adj);
2595 fclose(oom_adj);
2596 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002597 }
2598
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002599 if (version_ == VERSION_DEFAULT) {
2600 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00002601 }
2602
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002603 if (version_ != VERSION_CURRENT && version_ != VERSION_SPLIT_ANR) {
Vishnu Nair64afc022018-02-01 15:29:34 -08002604 MYLOGE("invalid version requested ('%s'); suppported values are: ('%s', '%s', '%s')\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002605 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str(),
Vishnu Nair64afc022018-02-01 15:29:34 -08002606 VERSION_SPLIT_ANR.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002607 return RunStatus::INVALID_INPUT;
Felipe Lemed071c682016-10-20 16:48:00 -07002608 }
2609
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002610 if (options_->show_header_only) {
2611 PrintHeader();
2612 return RunStatus::OK;
Felipe Lemed071c682016-10-20 16:48:00 -07002613 }
2614
Nandana Duttd2f5f082019-01-18 17:13:52 +00002615 if (options_->bugreport_fd.get() != -1) {
2616 // If the output needs to be copied over to the caller's fd, get user consent.
2617 android::String16 package(calling_package.c_str());
2618 CheckUserConsent(calling_uid, package);
2619 }
2620
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002621 // Redirect output if needed
Nandana Dutt9a76d202019-01-21 15:56:48 +00002622 bool is_redirecting = options_->OutputToFile();
Felipe Leme7447d7c2016-11-03 18:12:22 -07002623
2624 // TODO: temporarily set progress until it's part of the Dumpstate constructor
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002625 std::string stats_path =
Nandana Dutt979388e2018-11-30 16:48:55 +00002626 is_redirecting
2627 ? android::base::StringPrintf("%s/dumpstate-stats.txt", bugreport_internal_dir_.c_str())
2628 : "";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002629 progress_.reset(new Progress(stats_path));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002630
Felipe Lemed071c682016-10-20 16:48:00 -07002631 /* gets the sequential id */
Felipe Leme7447d7c2016-11-03 18:12:22 -07002632 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002633 id_ = ++last_id;
Felipe Lemed071c682016-10-20 16:48:00 -07002634 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
2635
2636 MYLOGI("begin\n");
2637
Sahana Raof35ed432019-07-12 10:47:52 +01002638 if (acquire_wake_lock(PARTIAL_WAKE_LOCK, WAKE_LOCK_NAME) < 0) {
2639 MYLOGE("Failed to acquire wake lock: %s\n", strerror(errno));
2640 } else {
2641 // Wake lock will be released automatically on process death
2642 MYLOGD("Wake lock acquired.\n");
2643 }
2644
Felipe Leme6ae5c4f2017-01-10 14:13:22 -08002645 register_sig_handler();
Felipe Lemed071c682016-10-20 16:48:00 -07002646
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002647 // TODO(b/111441001): maybe skip if already started?
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002648 if (options_->do_start_service) {
Felipe Leme75876a22016-10-27 16:31:27 -07002649 MYLOGI("Starting 'dumpstate' service\n");
2650 android::status_t ret;
2651 if ((ret = android::os::DumpstateService::Start()) != android::OK) {
2652 MYLOGE("Unable to start DumpstateService: %d\n", ret);
2653 }
2654 }
2655
Felipe Lemef0292972016-11-22 13:57:05 -08002656 if (PropertiesHelper::IsDryRun()) {
Felipe Lemed071c682016-10-20 16:48:00 -07002657 MYLOGI("Running on dry-run mode (to disable it, call 'setprop dumpstate.dry_run false')\n");
2658 }
2659
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002660 MYLOGI("dumpstate info: id=%d, args='%s', extra_options= %s)\n", id_, options_->args.c_str(),
2661 options_->extra_options.c_str());
Felipe Lemed071c682016-10-20 16:48:00 -07002662
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002663 MYLOGI("bugreport format version: %s\n", version_.c_str());
Felipe Leme809d74e2016-02-02 12:57:00 -08002664
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002665 do_early_screenshot_ = options_->do_progress_updates;
Felipe Lemee338bf62015-12-07 14:03:50 -08002666
Christopher Ferrised9354f2014-10-01 17:35:01 -07002667 // If we are going to use a socket, do it as early as possible
2668 // to avoid timeouts from bugreport.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002669 if (options_->use_socket) {
Nandana Dutta344cb62019-02-22 15:12:35 +00002670 if (!redirect_to_socket(stdout, "dumpstate")) {
2671 return ERROR;
2672 }
Christopher Ferrised9354f2014-10-01 17:35:01 -07002673 }
2674
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002675 if (options_->use_control_socket) {
Felipe Leme2628e9e2016-04-12 16:36:51 -07002676 MYLOGD("Opening control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002677 control_socket_fd_ = open_socket("dumpstate");
Nandana Dutta344cb62019-02-22 15:12:35 +00002678 if (control_socket_fd_ == -1) {
2679 return ERROR;
2680 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002681 options_->do_progress_updates = 1;
Felipe Leme2628e9e2016-04-12 16:36:51 -07002682 }
2683
Felipe Leme71bbfc52015-11-23 14:14:51 -08002684 if (is_redirecting) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002685 PrepareToWriteToFile();
Felipe Leme1e9edc62015-12-21 16:02:13 -08002686
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002687 if (options_->do_progress_updates) {
2688 if (options_->do_broadcast) {
Felipe Lemedcd1f0d2016-08-04 12:48:50 -07002689 // clang-format off
2690 std::vector<std::string> am_args = {
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002691 "--receiver-permission", "android.permission.DUMP",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002692 "--es", "android.intent.extra.NAME", name_,
2693 "--ei", "android.intent.extra.ID", std::to_string(id_),
2694 "--ei", "android.intent.extra.PID", std::to_string(pid_),
2695 "--ei", "android.intent.extra.MAX", std::to_string(progress_->GetMax()),
Felipe Lemedcd1f0d2016-08-04 12:48:50 -07002696 };
2697 // clang-format on
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002698 SendBroadcast("com.android.internal.intent.action.BUGREPORT_STARTED", am_args);
Felipe Lemedcd1f0d2016-08-04 12:48:50 -07002699 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002700 if (options_->use_control_socket) {
2701 dprintf(control_socket_fd_, "BEGIN:%s\n", path_.c_str());
Felipe Lemeaabfcae2016-07-29 09:49:04 -07002702 }
Felipe Leme71bbfc52015-11-23 14:14:51 -08002703 }
2704 }
2705
Nick Kralevichf3599b32016-01-25 15:05:16 -08002706 /* read /proc/cmdline before dropping root */
2707 FILE *cmdline = fopen("/proc/cmdline", "re");
2708 if (cmdline) {
2709 fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
2710 fclose(cmdline);
2711 }
2712
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002713 if (options_->do_vibrate) {
Felipe Leme35b8cf12017-02-10 15:47:29 -08002714 Vibrate(150);
John Michelau1f794c42012-09-17 11:20:19 -05002715 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002716
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002717 if (options_->do_fb && do_early_screenshot_) {
Greg Kaiser3ddc3fa2019-05-23 16:14:52 -07002718 MYLOGI("taking early screenshot\n");
2719 TakeScreenshot();
Felipe Lemee338bf62015-12-07 14:03:50 -08002720 }
2721
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002722 if (options_->do_zip_file && zip_file != nullptr) {
2723 if (chown(path_.c_str(), AID_SHELL, AID_SHELL)) {
2724 MYLOGE("Unable to change ownership of zip file %s: %s\n", path_.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -07002725 strerror(errno));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002726 }
2727 }
2728
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002729 int dup_stdout_fd;
2730 int dup_stderr_fd;
Felipe Leme71bbfc52015-11-23 14:14:51 -08002731 if (is_redirecting) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002732 // Redirect stderr to log_path_ for debugging.
Vishnu Nair20cf5032018-01-05 13:15:49 -08002733 TEMP_FAILURE_RETRY(dup_stderr_fd = dup(fileno(stderr)));
Nandana Dutta344cb62019-02-22 15:12:35 +00002734 if (!redirect_to_file(stderr, const_cast<char*>(log_path_.c_str()))) {
2735 return ERROR;
2736 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002737 if (chown(log_path_.c_str(), AID_SHELL, AID_SHELL)) {
2738 MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n", log_path_.c_str(),
2739 strerror(errno));
Felipe Leme6fe9db62016-02-12 09:04:16 -08002740 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002741
2742 // Redirect stdout to tmp_path_. This is the main bugreport entry and will be
2743 // moved into zip file later, if zipping.
Vishnu Nair20cf5032018-01-05 13:15:49 -08002744 TEMP_FAILURE_RETRY(dup_stdout_fd = dup(fileno(stdout)));
Nandana Dutt979388e2018-11-30 16:48:55 +00002745 // TODO: why not write to a file instead of stdout to overcome this problem?
Felipe Leme6e01fa62015-11-11 19:35:14 -08002746 /* TODO: rather than generating a text file now and zipping it later,
2747 it would be more efficient to redirect stdout to the zip entry
2748 directly, but the libziparchive doesn't support that option yet. */
Nandana Dutta344cb62019-02-22 15:12:35 +00002749 if (!redirect_to_file(stdout, const_cast<char*>(tmp_path_.c_str()))) {
2750 return ERROR;
2751 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002752 if (chown(tmp_path_.c_str(), AID_SHELL, AID_SHELL)) {
Felipe Leme6fe9db62016-02-12 09:04:16 -08002753 MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002754 tmp_path_.c_str(), strerror(errno));
Felipe Leme6fe9db62016-02-12 09:04:16 -08002755 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002756 }
Felipe Lemed8b94e52016-12-08 10:21:44 -08002757
2758 // Don't buffer stdout
2759 setvbuf(stdout, nullptr, _IONBF, 0);
2760
Felipe Leme608385d2016-02-01 10:35:38 -08002761 // NOTE: there should be no stdout output until now, otherwise it would break the header.
2762 // In particular, DurationReport objects should be created passing 'title, NULL', so their
Felipe Lemecbce55d2016-02-08 09:53:18 -08002763 // duration is logged into MYLOG instead.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002764 PrintHeader();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002765
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002766 if (options_->telephony_only) {
Jayachandran Ca94c7172017-06-10 15:08:12 -07002767 DumpstateTelephonyOnly();
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002768 DumpstateBoard();
2769 } else if (options_->wifi_only) {
mukesh agrawal253dad42018-01-23 21:59:59 -08002770 DumpstateWifiOnly();
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002771 } else {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002772 // Dump state for the default case. This also drops root.
Nandana Dutt5c390032019-03-12 10:52:56 +00002773 RunStatus s = DumpstateDefault();
2774 if (s != RunStatus::OK) {
Nandana Duttaac6f582019-07-26 14:32:47 +01002775 if (s == RunStatus::USER_CONSENT_DENIED) {
Nandana Dutt5c390032019-03-12 10:52:56 +00002776 HandleUserConsentDenied();
2777 }
2778 return s;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002779 }
Zhengyin Qian068ecc72016-08-10 16:48:14 -07002780 }
Felipe Leme71a74ac2016-03-17 15:43:25 -07002781
Felipe Leme55b42a62015-11-10 17:39:08 -08002782 /* close output if needed */
Felipe Leme71bbfc52015-11-23 14:14:51 -08002783 if (is_redirecting) {
Vishnu Nair20cf5032018-01-05 13:15:49 -08002784 TEMP_FAILURE_RETRY(dup2(dup_stdout_fd, fileno(stdout)));
Colin Crossf45fa6b2012-03-26 12:38:26 -07002785 }
2786
Nandana Duttd2f5f082019-01-18 17:13:52 +00002787 // Rename, and/or zip the (now complete) .tmp file within the internal directory.
Nandana Dutt9a76d202019-01-21 15:56:48 +00002788 if (options_->OutputToFile()) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002789 FinalizeFile();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002790 }
2791
Nandana Duttd2f5f082019-01-18 17:13:52 +00002792 // Share the final file with the caller if the user has consented.
2793 Dumpstate::RunStatus status = Dumpstate::RunStatus::OK;
2794 if (options_->bugreport_fd.get() != -1) {
2795 status = CopyBugreportIfUserConsented();
2796 if (status != Dumpstate::RunStatus::OK &&
2797 status != Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2798 // Do an early return if there were errors. We make an exception for consent
2799 // timing out because it's possible the user got distracted. In this case the
2800 // bugreport is not shared but made available for manual retrieval.
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002801 MYLOGI("User denied consent. Returning\n");
Nandana Duttd2f5f082019-01-18 17:13:52 +00002802 return status;
2803 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002804 if (options_->do_fb && options_->screenshot_fd.get() != -1) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00002805 bool copy_succeeded = android::os::CopyFileToFd(screenshot_path_,
2806 options_->screenshot_fd.get());
2807 if (copy_succeeded) {
2808 android::os::UnlinkAndLogOnError(screenshot_path_);
2809 }
2810 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002811 if (status == Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2812 MYLOGI(
2813 "Did not receive user consent yet."
2814 " Will not copy the bugreport artifacts to caller.\n");
Abhijeet Kaur57627412019-04-17 16:00:09 +01002815 const String16 incidentcompanion("incidentcompanion");
2816 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
2817 if (ics != nullptr) {
2818 MYLOGD("Canceling user consent request via incidentcompanion service\n");
2819 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
2820 consent_callback_.get());
2821 } else {
2822 MYLOGD("Unable to cancel user consent; incidentcompanion service unavailable\n");
2823 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002824 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00002825 }
2826
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002827 /* vibrate a few but shortly times to let user know it's finished */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002828 if (options_->do_vibrate) {
Takuya Ogawa47f644e2017-12-20 18:09:09 +09002829 for (int i = 0; i < 3; i++) {
2830 Vibrate(75);
2831 usleep((75 + 50) * 1000);
2832 }
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002833 }
2834
Jeff Brown1dc94e32014-09-11 14:15:27 -07002835 /* tell activity manager we're done */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002836 if (options_->do_broadcast) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002837 SendBugreportFinishedBroadcast();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002838 // Note that listener_ is notified in Run();
Jeff Sharkey27f9e6d2013-03-13 15:45:50 -07002839 }
2840
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002841 MYLOGD("Final progress: %d/%d (estimated %d)\n", progress_->Get(), progress_->GetMax(),
2842 progress_->GetInitialMax());
2843 progress_->Save();
2844 MYLOGI("done (id %d)\n", id_);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002845
Felipe Leme107a05f2016-03-08 15:11:15 -08002846 if (is_redirecting) {
Vishnu Nair20cf5032018-01-05 13:15:49 -08002847 TEMP_FAILURE_RETRY(dup2(dup_stderr_fd, fileno(stderr)));
Felipe Leme107a05f2016-03-08 15:11:15 -08002848 }
2849
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002850 if (options_->use_control_socket && control_socket_fd_ != -1) {
Felipe Lemee844a9d2016-09-21 15:01:39 -07002851 MYLOGD("Closing control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002852 close(control_socket_fd_);
Felipe Leme2628e9e2016-04-12 16:36:51 -07002853 }
2854
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002855 tombstone_data_.clear();
2856 anr_data_.clear();
Narayan Kamath6b9516c2017-10-27 11:15:51 +01002857
Nandana Duttd2f5f082019-01-18 17:13:52 +00002858 return (consent_callback_ != nullptr &&
2859 consent_callback_->getResult() == UserConsentResult::UNAVAILABLE)
2860 ? USER_CONSENT_TIMED_OUT
2861 : RunStatus::OK;
2862}
2863
2864void Dumpstate::CheckUserConsent(int32_t calling_uid, const android::String16& calling_package) {
2865 consent_callback_ = new ConsentCallback();
2866 const String16 incidentcompanion("incidentcompanion");
2867 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
2868 if (ics != nullptr) {
2869 MYLOGD("Checking user consent via incidentcompanion service\n");
2870 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
Joe Onorato1c36d752019-03-17 18:26:43 -07002871 calling_uid, calling_package, String16(), String16(),
2872 0x1 /* FLAG_CONFIRMATION_DIALOG */, consent_callback_.get());
Nandana Duttd2f5f082019-01-18 17:13:52 +00002873 } else {
2874 MYLOGD("Unable to check user consent; incidentcompanion service unavailable\n");
2875 }
2876}
2877
Nandana Dutt5c390032019-03-12 10:52:56 +00002878bool Dumpstate::IsUserConsentDenied() const {
2879 return ds.consent_callback_ != nullptr &&
2880 ds.consent_callback_->getResult() == UserConsentResult::DENIED;
2881}
2882
Nandana Duttd2f5f082019-01-18 17:13:52 +00002883void Dumpstate::CleanupFiles() {
2884 android::os::UnlinkAndLogOnError(tmp_path_);
2885 android::os::UnlinkAndLogOnError(screenshot_path_);
2886 android::os::UnlinkAndLogOnError(path_);
2887}
2888
2889Dumpstate::RunStatus Dumpstate::HandleUserConsentDenied() {
2890 MYLOGD("User denied consent; deleting files and returning\n");
2891 CleanupFiles();
2892 return USER_CONSENT_DENIED;
2893}
2894
2895Dumpstate::RunStatus Dumpstate::CopyBugreportIfUserConsented() {
2896 // If the caller has asked to copy the bugreport over to their directory, we need explicit
2897 // user consent.
2898 UserConsentResult consent_result = consent_callback_->getResult();
2899 if (consent_result == UserConsentResult::UNAVAILABLE) {
2900 // User has not responded yet.
2901 uint64_t elapsed_ms = consent_callback_->getElapsedTimeMs();
Hunter Knepshield70610fa2020-01-03 15:27:33 -08002902 // Telephony is a fast report type, particularly on user builds where information may be
2903 // more aggressively limited. To give the user time to read the consent dialog, increase the
2904 // timeout.
2905 uint64_t timeout_ms = options_->telephony_only ? TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS
2906 : USER_CONSENT_TIMEOUT_MS;
2907 if (elapsed_ms < timeout_ms) {
2908 uint delay_seconds = (timeout_ms - elapsed_ms) / 1000;
Nandana Duttd2f5f082019-01-18 17:13:52 +00002909 MYLOGD("Did not receive user consent yet; going to wait for %d seconds", delay_seconds);
2910 sleep(delay_seconds);
2911 }
2912 consent_result = consent_callback_->getResult();
2913 }
2914 if (consent_result == UserConsentResult::DENIED) {
2915 // User has explicitly denied sharing with the app. To be safe delete the
2916 // internal bugreport & tmp files.
2917 return HandleUserConsentDenied();
2918 }
2919 if (consent_result == UserConsentResult::APPROVED) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00002920 bool copy_succeeded = android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
2921 if (copy_succeeded) {
2922 android::os::UnlinkAndLogOnError(path_);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002923 }
2924 return copy_succeeded ? Dumpstate::RunStatus::OK : Dumpstate::RunStatus::ERROR;
2925 } else if (consent_result == UserConsentResult::UNAVAILABLE) {
2926 // consent_result is still UNAVAILABLE. The user has likely not responded yet.
2927 // Since we do not have user consent to share the bugreport it does not get
2928 // copied over to the calling app but remains in the internal directory from
2929 // where the user can manually pull it.
2930 return Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT;
2931 }
2932 // Unknown result; must be a programming error.
2933 MYLOGE("Unknown user consent result:%d\n", consent_result);
2934 return Dumpstate::RunStatus::ERROR;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002935}
2936
Nandana Duttf02564e2019-02-15 15:24:24 +00002937Dumpstate::RunStatus Dumpstate::ParseCommandlineAndRun(int argc, char* argv[]) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002938 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
2939 Dumpstate::RunStatus status = options->Initialize(argc, argv);
2940 if (status == Dumpstate::RunStatus::OK) {
Nandana Duttf02564e2019-02-15 15:24:24 +00002941 SetOptions(std::move(options));
Nandana Duttd2f5f082019-01-18 17:13:52 +00002942 // When directly running dumpstate binary, the output is not expected to be written
2943 // to any external file descriptor.
Nandana Duttf02564e2019-02-15 15:24:24 +00002944 assert(options_->bugreport_fd.get() == -1);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002945
2946 // calling_uid and calling_package are for user consent to share the bugreport with
2947 // an app; they are irrelvant here because bugreport is only written to a local
2948 // directory, and not shared.
Nandana Duttf02564e2019-02-15 15:24:24 +00002949 status = Run(-1 /* calling_uid */, "" /* calling_package */);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002950 }
Nandana Duttf02564e2019-02-15 15:24:24 +00002951 return status;
2952}
2953
2954/* Main entry point for dumpstate binary. */
2955int run_main(int argc, char* argv[]) {
2956 Dumpstate::RunStatus status = ds.ParseCommandlineAndRun(argc, argv);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002957
2958 switch (status) {
2959 case Dumpstate::RunStatus::OK:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002960 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002961 case Dumpstate::RunStatus::HELP:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002962 ShowUsage();
2963 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002964 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002965 fprintf(stderr, "Invalid combination of args\n");
2966 ShowUsage();
2967 exit(1);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002968 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002969 FALLTHROUGH_INTENDED;
2970 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2971 FALLTHROUGH_INTENDED;
2972 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002973 exit(2);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002974 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002975}
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002976
2977// TODO(111441001): Default DumpOptions to sensible values.
2978Dumpstate::Dumpstate(const std::string& version)
2979 : pid_(getpid()),
2980 options_(new Dumpstate::DumpOptions()),
Nandana Duttf02cd782019-06-14 14:25:13 +01002981 last_reported_percent_progress_(0),
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002982 version_(version),
2983 now_(time(nullptr)) {
2984}
2985
2986Dumpstate& Dumpstate::GetInstance() {
2987 static Dumpstate singleton_(android::base::GetProperty("dumpstate.version", VERSION_CURRENT));
2988 return singleton_;
2989}
2990
Nandana Dutt8d945c02019-08-14 13:30:07 +01002991DurationReporter::DurationReporter(const std::string& title, bool logcat_only, bool verbose)
2992 : title_(title), logcat_only_(logcat_only), verbose_(verbose) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002993 if (!title_.empty()) {
2994 started_ = Nanotime();
2995 }
2996}
2997
2998DurationReporter::~DurationReporter() {
2999 if (!title_.empty()) {
3000 float elapsed = (float)(Nanotime() - started_) / NANOS_PER_SEC;
chenqiwuaf8b2d92019-12-12 18:53:51 +08003001 if (elapsed >= .5f || verbose_) {
3002 MYLOGD("Duration of '%s': %.2fs\n", title_.c_str(), elapsed);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003003 }
chenqiwuaf8b2d92019-12-12 18:53:51 +08003004 if (!logcat_only_) {
3005 // Use "Yoda grammar" to make it easier to grep|sort sections.
3006 printf("------ %.3fs was the duration of '%s' ------\n", elapsed, title_.c_str());
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003007 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003008 }
3009}
3010
3011const int32_t Progress::kDefaultMax = 5000;
3012
3013Progress::Progress(const std::string& path) : Progress(Progress::kDefaultMax, 1.1, path) {
3014}
3015
3016Progress::Progress(int32_t initial_max, int32_t progress, float growth_factor)
3017 : Progress(initial_max, growth_factor, "") {
3018 progress_ = progress;
3019}
3020
3021Progress::Progress(int32_t initial_max, float growth_factor, const std::string& path)
3022 : initial_max_(initial_max),
3023 progress_(0),
3024 max_(initial_max),
3025 growth_factor_(growth_factor),
3026 n_runs_(0),
3027 average_max_(0),
3028 path_(path) {
3029 if (!path_.empty()) {
3030 Load();
3031 }
3032}
3033
3034void Progress::Load() {
3035 MYLOGD("Loading stats from %s\n", path_.c_str());
3036 std::string content;
3037 if (!android::base::ReadFileToString(path_, &content)) {
3038 MYLOGI("Could not read stats from %s; using max of %d\n", path_.c_str(), max_);
3039 return;
3040 }
3041 if (content.empty()) {
3042 MYLOGE("No stats (empty file) on %s; using max of %d\n", path_.c_str(), max_);
3043 return;
3044 }
3045 std::vector<std::string> lines = android::base::Split(content, "\n");
3046
3047 if (lines.size() < 1) {
3048 MYLOGE("Invalid stats on file %s: not enough lines (%d). Using max of %d\n", path_.c_str(),
3049 (int)lines.size(), max_);
3050 return;
3051 }
3052 char* ptr;
3053 n_runs_ = strtol(lines[0].c_str(), &ptr, 10);
3054 average_max_ = strtol(ptr, nullptr, 10);
3055 if (n_runs_ <= 0 || average_max_ <= 0 || n_runs_ > STATS_MAX_N_RUNS ||
3056 average_max_ > STATS_MAX_AVERAGE) {
3057 MYLOGE("Invalid stats line on file %s: %s\n", path_.c_str(), lines[0].c_str());
3058 initial_max_ = Progress::kDefaultMax;
3059 } else {
3060 initial_max_ = average_max_;
3061 }
3062 max_ = initial_max_;
3063
3064 MYLOGI("Average max progress: %d in %d runs; estimated max: %d\n", average_max_, n_runs_, max_);
3065}
3066
3067void Progress::Save() {
3068 int32_t total = n_runs_ * average_max_ + progress_;
3069 int32_t runs = n_runs_ + 1;
3070 int32_t average = floor(((float)total) / runs);
3071 MYLOGI("Saving stats (total=%d, runs=%d, average=%d) on %s\n", total, runs, average,
3072 path_.c_str());
3073 if (path_.empty()) {
3074 return;
3075 }
3076
3077 std::string content = android::base::StringPrintf("%d %d\n", runs, average);
3078 if (!android::base::WriteStringToFile(content, path_)) {
3079 MYLOGE("Could not save stats on %s\n", path_.c_str());
3080 }
3081}
3082
3083int32_t Progress::Get() const {
3084 return progress_;
3085}
3086
3087bool Progress::Inc(int32_t delta_sec) {
3088 bool changed = false;
3089 if (delta_sec >= 0) {
3090 progress_ += delta_sec;
3091 if (progress_ > max_) {
3092 int32_t old_max = max_;
3093 max_ = floor((float)progress_ * growth_factor_);
3094 MYLOGD("Adjusting max progress from %d to %d\n", old_max, max_);
3095 changed = true;
3096 }
3097 }
3098 return changed;
3099}
3100
3101int32_t Progress::GetMax() const {
3102 return max_;
3103}
3104
3105int32_t Progress::GetInitialMax() const {
3106 return initial_max_;
3107}
3108
3109void Progress::Dump(int fd, const std::string& prefix) const {
3110 const char* pr = prefix.c_str();
3111 dprintf(fd, "%sprogress: %d\n", pr, progress_);
3112 dprintf(fd, "%smax: %d\n", pr, max_);
3113 dprintf(fd, "%sinitial_max: %d\n", pr, initial_max_);
3114 dprintf(fd, "%sgrowth_factor: %0.2f\n", pr, growth_factor_);
3115 dprintf(fd, "%spath: %s\n", pr, path_.c_str());
3116 dprintf(fd, "%sn_runs: %d\n", pr, n_runs_);
3117 dprintf(fd, "%saverage_max: %d\n", pr, average_max_);
3118}
3119
3120bool Dumpstate::IsZipping() const {
3121 return zip_writer_ != nullptr;
3122}
3123
3124std::string Dumpstate::GetPath(const std::string& suffix) const {
3125 return GetPath(bugreport_internal_dir_, suffix);
3126}
3127
3128std::string Dumpstate::GetPath(const std::string& directory, const std::string& suffix) const {
3129 return android::base::StringPrintf("%s/%s-%s%s", directory.c_str(), base_name_.c_str(),
3130 name_.c_str(), suffix.c_str());
3131}
3132
3133void Dumpstate::SetProgress(std::unique_ptr<Progress> progress) {
3134 progress_ = std::move(progress);
3135}
3136
3137void for_each_userid(void (*func)(int), const char *header) {
3138 std::string title = header == nullptr ? "for_each_userid" : android::base::StringPrintf(
3139 "for_each_userid(%s)", header);
3140 DurationReporter duration_reporter(title);
3141 if (PropertiesHelper::IsDryRun()) return;
3142
3143 DIR *d;
3144 struct dirent *de;
3145
3146 if (header) printf("\n------ %s ------\n", header);
3147 func(0);
3148
3149 if (!(d = opendir("/data/system/users"))) {
3150 printf("Failed to open /data/system/users (%s)\n", strerror(errno));
3151 return;
3152 }
3153
3154 while ((de = readdir(d))) {
3155 int userid;
3156 if (de->d_type != DT_DIR || !(userid = atoi(de->d_name))) {
3157 continue;
3158 }
3159 func(userid);
3160 }
3161
3162 closedir(d);
3163}
3164
3165static void __for_each_pid(void (*helper)(int, const char *, void *), const char *header, void *arg) {
3166 DIR *d;
3167 struct dirent *de;
3168
3169 if (!(d = opendir("/proc"))) {
3170 printf("Failed to open /proc (%s)\n", strerror(errno));
3171 return;
3172 }
3173
3174 if (header) printf("\n------ %s ------\n", header);
3175 while ((de = readdir(d))) {
3176 if (ds.IsUserConsentDenied()) {
3177 MYLOGE(
3178 "Returning early because user denied consent to share bugreport with calling app.");
3179 closedir(d);
3180 return;
3181 }
3182 int pid;
3183 int fd;
3184 char cmdpath[255];
3185 char cmdline[255];
3186
3187 if (!(pid = atoi(de->d_name))) {
3188 continue;
3189 }
3190
3191 memset(cmdline, 0, sizeof(cmdline));
3192
3193 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/cmdline", pid);
3194 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3195 TEMP_FAILURE_RETRY(read(fd, cmdline, sizeof(cmdline) - 2));
3196 close(fd);
3197 if (cmdline[0]) {
3198 helper(pid, cmdline, arg);
3199 continue;
3200 }
3201 }
3202
3203 // if no cmdline, a kernel thread has comm
3204 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/comm", pid);
3205 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3206 TEMP_FAILURE_RETRY(read(fd, cmdline + 1, sizeof(cmdline) - 4));
3207 close(fd);
3208 if (cmdline[1]) {
3209 cmdline[0] = '[';
3210 size_t len = strcspn(cmdline, "\f\b\r\n");
3211 cmdline[len] = ']';
3212 cmdline[len+1] = '\0';
3213 }
3214 }
3215 if (!cmdline[0]) {
3216 strcpy(cmdline, "N/A");
3217 }
3218 helper(pid, cmdline, arg);
3219 }
3220
3221 closedir(d);
3222}
3223
3224static void for_each_pid_helper(int pid, const char *cmdline, void *arg) {
3225 for_each_pid_func *func = (for_each_pid_func*) arg;
3226 func(pid, cmdline);
3227}
3228
3229void for_each_pid(for_each_pid_func func, const char *header) {
3230 std::string title = header == nullptr ? "for_each_pid"
3231 : android::base::StringPrintf("for_each_pid(%s)", header);
3232 DurationReporter duration_reporter(title);
3233 if (PropertiesHelper::IsDryRun()) return;
3234
3235 __for_each_pid(for_each_pid_helper, header, (void *) func);
3236}
3237
3238static void for_each_tid_helper(int pid, const char *cmdline, void *arg) {
3239 DIR *d;
3240 struct dirent *de;
3241 char taskpath[255];
3242 for_each_tid_func *func = (for_each_tid_func *) arg;
3243
3244 snprintf(taskpath, sizeof(taskpath), "/proc/%d/task", pid);
3245
3246 if (!(d = opendir(taskpath))) {
3247 printf("Failed to open %s (%s)\n", taskpath, strerror(errno));
3248 return;
3249 }
3250
3251 func(pid, pid, cmdline);
3252
3253 while ((de = readdir(d))) {
3254 if (ds.IsUserConsentDenied()) {
3255 MYLOGE(
3256 "Returning early because user denied consent to share bugreport with calling app.");
3257 closedir(d);
3258 return;
3259 }
3260 int tid;
3261 int fd;
3262 char commpath[255];
3263 char comm[255];
3264
3265 if (!(tid = atoi(de->d_name))) {
3266 continue;
3267 }
3268
3269 if (tid == pid)
3270 continue;
3271
3272 snprintf(commpath, sizeof(commpath), "/proc/%d/comm", tid);
3273 memset(comm, 0, sizeof(comm));
3274 if ((fd = TEMP_FAILURE_RETRY(open(commpath, O_RDONLY | O_CLOEXEC))) < 0) {
3275 strcpy(comm, "N/A");
3276 } else {
3277 char *c;
3278 TEMP_FAILURE_RETRY(read(fd, comm, sizeof(comm) - 2));
3279 close(fd);
3280
3281 c = strrchr(comm, '\n');
3282 if (c) {
3283 *c = '\0';
3284 }
3285 }
3286 func(pid, tid, comm);
3287 }
3288
3289 closedir(d);
3290}
3291
3292void for_each_tid(for_each_tid_func func, const char *header) {
3293 std::string title = header == nullptr ? "for_each_tid"
3294 : android::base::StringPrintf("for_each_tid(%s)", header);
3295 DurationReporter duration_reporter(title);
3296
3297 if (PropertiesHelper::IsDryRun()) return;
3298
3299 __for_each_pid(for_each_tid_helper, header, (void *) func);
3300}
3301
3302void show_wchan(int pid, int tid, const char *name) {
3303 if (PropertiesHelper::IsDryRun()) return;
3304
3305 char path[255];
3306 char buffer[255];
3307 int fd, ret, save_errno;
3308 char name_buffer[255];
3309
3310 memset(buffer, 0, sizeof(buffer));
3311
3312 snprintf(path, sizeof(path), "/proc/%d/wchan", tid);
3313 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3314 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3315 return;
3316 }
3317
3318 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3319 save_errno = errno;
3320 close(fd);
3321
3322 if (ret < 0) {
3323 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3324 return;
3325 }
3326
3327 snprintf(name_buffer, sizeof(name_buffer), "%*s%s",
3328 pid == tid ? 0 : 3, "", name);
3329
3330 printf("%-7d %-32s %s\n", tid, name_buffer, buffer);
3331
3332 return;
3333}
3334
3335// print time in centiseconds
3336static void snprcent(char *buffer, size_t len, size_t spc,
3337 unsigned long long time) {
3338 static long hz; // cache discovered hz
3339
3340 if (hz <= 0) {
3341 hz = sysconf(_SC_CLK_TCK);
3342 if (hz <= 0) {
3343 hz = 1000;
3344 }
3345 }
3346
3347 // convert to centiseconds
3348 time = (time * 100 + (hz / 2)) / hz;
3349
3350 char str[16];
3351
3352 snprintf(str, sizeof(str), " %llu.%02u",
3353 time / 100, (unsigned)(time % 100));
3354 size_t offset = strlen(buffer);
3355 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3356 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3357}
3358
3359// print permille as a percent
3360static void snprdec(char *buffer, size_t len, size_t spc, unsigned permille) {
3361 char str[16];
3362
3363 snprintf(str, sizeof(str), " %u.%u%%", permille / 10, permille % 10);
3364 size_t offset = strlen(buffer);
3365 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3366 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3367}
3368
3369void show_showtime(int pid, const char *name) {
3370 if (PropertiesHelper::IsDryRun()) return;
3371
3372 char path[255];
3373 char buffer[1023];
3374 int fd, ret, save_errno;
3375
3376 memset(buffer, 0, sizeof(buffer));
3377
3378 snprintf(path, sizeof(path), "/proc/%d/stat", pid);
3379 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3380 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3381 return;
3382 }
3383
3384 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3385 save_errno = errno;
3386 close(fd);
3387
3388 if (ret < 0) {
3389 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3390 return;
3391 }
3392
3393 // field 14 is utime
3394 // field 15 is stime
3395 // field 42 is iotime
3396 unsigned long long utime = 0, stime = 0, iotime = 0;
3397 if (sscanf(buffer,
3398 "%*u %*s %*s %*d %*d %*d %*d %*d %*d %*d %*d "
3399 "%*d %*d %llu %llu %*d %*d %*d %*d %*d %*d "
3400 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %*d "
3401 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %llu ",
3402 &utime, &stime, &iotime) != 3) {
3403 return;
3404 }
3405
3406 unsigned long long total = utime + stime;
3407 if (!total) {
3408 return;
3409 }
3410
3411 unsigned permille = (iotime * 1000 + (total / 2)) / total;
3412 if (permille > 1000) {
3413 permille = 1000;
3414 }
3415
3416 // try to beautify and stabilize columns at <80 characters
3417 snprintf(buffer, sizeof(buffer), "%-6d%s", pid, name);
3418 if ((name[0] != '[') || utime) {
3419 snprcent(buffer, sizeof(buffer), 57, utime);
3420 }
3421 snprcent(buffer, sizeof(buffer), 65, stime);
3422 if ((name[0] != '[') || iotime) {
3423 snprcent(buffer, sizeof(buffer), 73, iotime);
3424 }
3425 if (iotime) {
3426 snprdec(buffer, sizeof(buffer), 79, permille);
3427 }
3428 puts(buffer); // adds a trailing newline
3429
3430 return;
3431}
3432
3433void do_dmesg() {
3434 const char *title = "KERNEL LOG (dmesg)";
3435 DurationReporter duration_reporter(title);
3436 printf("------ %s ------\n", title);
3437
3438 if (PropertiesHelper::IsDryRun()) return;
3439
3440 /* Get size of kernel buffer */
3441 int size = klogctl(KLOG_SIZE_BUFFER, nullptr, 0);
3442 if (size <= 0) {
3443 printf("Unexpected klogctl return value: %d\n\n", size);
3444 return;
3445 }
3446 char *buf = (char *) malloc(size + 1);
3447 if (buf == nullptr) {
3448 printf("memory allocation failed\n\n");
3449 return;
3450 }
3451 int retval = klogctl(KLOG_READ_ALL, buf, size);
3452 if (retval < 0) {
3453 printf("klogctl failure\n\n");
3454 free(buf);
3455 return;
3456 }
3457 buf[retval] = '\0';
3458 printf("%s\n\n", buf);
3459 free(buf);
3460 return;
3461}
3462
3463void do_showmap(int pid, const char *name) {
3464 char title[255];
3465 char arg[255];
3466
3467 snprintf(title, sizeof(title), "SHOW MAP %d (%s)", pid, name);
3468 snprintf(arg, sizeof(arg), "%d", pid);
3469 RunCommand(title, {"showmap", "-q", arg}, CommandOptions::AS_ROOT);
3470}
3471
3472int Dumpstate::DumpFile(const std::string& title, const std::string& path) {
3473 DurationReporter duration_reporter(title);
3474
3475 int status = DumpFileToFd(STDOUT_FILENO, title, path);
3476
3477 UpdateProgress(WEIGHT_FILE);
3478
3479 return status;
3480}
3481
3482int read_file_as_long(const char *path, long int *output) {
3483 int fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC));
3484 if (fd < 0) {
3485 int err = errno;
3486 MYLOGE("Error opening file descriptor for %s: %s\n", path, strerror(err));
3487 return -1;
3488 }
3489 char buffer[50];
3490 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3491 if (bytes_read == -1) {
3492 MYLOGE("Error reading file %s: %s\n", path, strerror(errno));
3493 return -2;
3494 }
3495 if (bytes_read == 0) {
3496 MYLOGE("File %s is empty\n", path);
3497 return -3;
3498 }
3499 *output = atoi(buffer);
3500 return 0;
3501}
3502
3503/* calls skip to gate calling dump_from_fd recursively
3504 * in the specified directory. dump_from_fd defaults to
3505 * dump_file_from_fd above when set to NULL. skip defaults
3506 * to false when set to NULL. dump_from_fd will always be
3507 * called with title NULL.
3508 */
3509int dump_files(const std::string& title, const char* dir, bool (*skip)(const char* path),
3510 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
3511 DurationReporter duration_reporter(title);
3512 DIR *dirp;
3513 struct dirent *d;
3514 char *newpath = nullptr;
3515 const char *slash = "/";
3516 int retval = 0;
3517
3518 if (!title.empty()) {
3519 printf("------ %s (%s) ------\n", title.c_str(), dir);
3520 }
3521 if (PropertiesHelper::IsDryRun()) return 0;
3522
3523 if (dir[strlen(dir) - 1] == '/') {
3524 ++slash;
3525 }
3526 dirp = opendir(dir);
3527 if (dirp == nullptr) {
3528 retval = -errno;
3529 MYLOGE("%s: %s\n", dir, strerror(errno));
3530 return retval;
3531 }
3532
3533 if (!dump_from_fd) {
3534 dump_from_fd = dump_file_from_fd;
3535 }
3536 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
3537 if ((d->d_name[0] == '.')
3538 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
3539 || (d->d_name[1] == '\0'))) {
3540 continue;
3541 }
3542 asprintf(&newpath, "%s%s%s%s", dir, slash, d->d_name,
3543 (d->d_type == DT_DIR) ? "/" : "");
3544 if (!newpath) {
3545 retval = -errno;
3546 continue;
3547 }
3548 if (skip && (*skip)(newpath)) {
3549 continue;
3550 }
3551 if (d->d_type == DT_DIR) {
3552 int ret = dump_files("", newpath, skip, dump_from_fd);
3553 if (ret < 0) {
3554 retval = ret;
3555 }
3556 continue;
3557 }
3558 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(newpath, O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
3559 if (fd.get() < 0) {
3560 retval = -1;
3561 printf("*** %s: %s\n", newpath, strerror(errno));
3562 continue;
3563 }
3564 (*dump_from_fd)(nullptr, newpath, fd.get());
3565 }
3566 closedir(dirp);
3567 if (!title.empty()) {
3568 printf("\n");
3569 }
3570 return retval;
3571}
3572
3573/* fd must have been opened with the flag O_NONBLOCK. With this flag set,
3574 * it's possible to avoid issues where opening the file itself can get
3575 * stuck.
3576 */
3577int dump_file_from_fd(const char *title, const char *path, int fd) {
3578 if (PropertiesHelper::IsDryRun()) return 0;
3579
3580 int flags = fcntl(fd, F_GETFL);
3581 if (flags == -1) {
3582 printf("*** %s: failed to get flags on fd %d: %s\n", path, fd, strerror(errno));
3583 return -1;
3584 } else if (!(flags & O_NONBLOCK)) {
3585 printf("*** %s: fd must have O_NONBLOCK set.\n", path);
3586 return -1;
3587 }
3588 return DumpFileFromFdToFd(title, path, fd, STDOUT_FILENO, PropertiesHelper::IsDryRun());
3589}
3590
3591int Dumpstate::RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Nandana Dutt8d945c02019-08-14 13:30:07 +01003592 const CommandOptions& options, bool verbose_duration) {
3593 DurationReporter duration_reporter(title, false /* logcat_only */, verbose_duration);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003594
3595 int status = RunCommandToFd(STDOUT_FILENO, title, full_command, options);
3596
3597 /* TODO: for now we're simplifying the progress calculation by using the
3598 * timeout as the weight. It's a good approximation for most cases, except when calling dumpsys,
3599 * where its weight should be much higher proportionally to its timeout.
3600 * Ideally, it should use a options.EstimatedDuration() instead...*/
3601 UpdateProgress(options.Timeout());
3602
3603 return status;
3604}
3605
3606void Dumpstate::RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsys_args,
3607 const CommandOptions& options, long dumpsysTimeoutMs) {
3608 long timeout_ms = dumpsysTimeoutMs > 0 ? dumpsysTimeoutMs : options.TimeoutInMs();
3609 std::vector<std::string> dumpsys = {"/system/bin/dumpsys", "-T", std::to_string(timeout_ms)};
3610 dumpsys.insert(dumpsys.end(), dumpsys_args.begin(), dumpsys_args.end());
3611 RunCommand(title, dumpsys, options);
3612}
3613
3614int open_socket(const char *service) {
3615 int s = android_get_control_socket(service);
3616 if (s < 0) {
3617 MYLOGE("android_get_control_socket(%s): %s\n", service, strerror(errno));
3618 return -1;
3619 }
3620 fcntl(s, F_SETFD, FD_CLOEXEC);
3621
3622 // Set backlog to 0 to make sure that queue size will be minimum.
3623 // In Linux, because the minimum queue will be 1, connect() will be blocked
3624 // if the other clients already called connect() and the connection request was not accepted.
3625 if (listen(s, 0) < 0) {
3626 MYLOGE("listen(control socket): %s\n", strerror(errno));
3627 return -1;
3628 }
3629
3630 struct sockaddr addr;
3631 socklen_t alen = sizeof(addr);
Abhijeet Kaur2113cae2019-09-13 09:24:15 +01003632 int fd = accept4(s, &addr, &alen, SOCK_CLOEXEC);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003633
3634 // Close socket just after accept(), to make sure that connect() by client will get error
3635 // when the socket is used by the other services.
3636 // There is still a race condition possibility between accept and close, but there is no way
3637 // to close-on-accept atomically.
3638 // See detail; b/123306389#comment25
3639 close(s);
3640
3641 if (fd < 0) {
3642 MYLOGE("accept(control socket): %s\n", strerror(errno));
3643 return -1;
3644 }
3645
3646 return fd;
3647}
3648
3649/* redirect output to a service control socket */
3650bool redirect_to_socket(FILE* redirect, const char* service) {
3651 int fd = open_socket(service);
3652 if (fd == -1) {
3653 return false;
3654 }
3655 fflush(redirect);
3656 // TODO: handle dup2 failure
3657 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
3658 close(fd);
3659 return true;
3660}
3661
3662// TODO: should call is_valid_output_file and/or be merged into it.
3663void create_parent_dirs(const char *path) {
3664 char *chp = const_cast<char *> (path);
3665
3666 /* skip initial slash */
3667 if (chp[0] == '/')
3668 chp++;
3669
3670 /* create leading directories, if necessary */
3671 struct stat dir_stat;
3672 while (chp && chp[0]) {
3673 chp = strchr(chp, '/');
3674 if (chp) {
3675 *chp = 0;
3676 if (stat(path, &dir_stat) == -1 || !S_ISDIR(dir_stat.st_mode)) {
3677 MYLOGI("Creating directory %s\n", path);
3678 if (mkdir(path, 0770)) { /* drwxrwx--- */
3679 MYLOGE("Unable to create directory %s: %s\n", path, strerror(errno));
3680 } else if (chown(path, AID_SHELL, AID_SHELL)) {
3681 MYLOGE("Unable to change ownership of dir %s: %s\n", path, strerror(errno));
3682 }
3683 }
3684 *chp++ = '/';
3685 }
3686 }
3687}
3688
3689bool _redirect_to_file(FILE* redirect, char* path, int truncate_flag) {
3690 create_parent_dirs(path);
3691
3692 int fd = TEMP_FAILURE_RETRY(open(path,
3693 O_WRONLY | O_CREAT | truncate_flag | O_CLOEXEC | O_NOFOLLOW,
3694 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH));
3695 if (fd < 0) {
3696 MYLOGE("%s: %s\n", path, strerror(errno));
3697 return false;
3698 }
3699
3700 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
3701 close(fd);
3702 return true;
3703}
3704
3705bool redirect_to_file(FILE* redirect, char* path) {
3706 return _redirect_to_file(redirect, path, O_TRUNC);
3707}
3708
3709bool redirect_to_existing_file(FILE* redirect, char* path) {
3710 return _redirect_to_file(redirect, path, O_APPEND);
3711}
3712
3713void dump_route_tables() {
3714 DurationReporter duration_reporter("DUMP ROUTE TABLES");
3715 if (PropertiesHelper::IsDryRun()) return;
3716 const char* const RT_TABLES_PATH = "/data/misc/net/rt_tables";
3717 ds.DumpFile("RT_TABLES", RT_TABLES_PATH);
3718 FILE* fp = fopen(RT_TABLES_PATH, "re");
3719 if (!fp) {
3720 printf("*** %s: %s\n", RT_TABLES_PATH, strerror(errno));
3721 return;
3722 }
3723 char table[16];
3724 // Each line has an integer (the table number), a space, and a string (the table name). We only
3725 // need the table number. It's a 32-bit unsigned number, so max 10 chars. Skip the table name.
3726 // Add a fixed max limit so this doesn't go awry.
3727 for (int i = 0; i < 64 && fscanf(fp, " %10s %*s", table) == 1; ++i) {
3728 RunCommand("ROUTE TABLE IPv4", {"ip", "-4", "route", "show", "table", table});
3729 RunCommand("ROUTE TABLE IPv6", {"ip", "-6", "route", "show", "table", table});
3730 }
3731 fclose(fp);
3732}
3733
3734// TODO: make this function thread safe if sections are generated in parallel.
3735void Dumpstate::UpdateProgress(int32_t delta_sec) {
3736 if (progress_ == nullptr) {
3737 MYLOGE("UpdateProgress: progress_ not set\n");
3738 return;
3739 }
3740
3741 // Always update progess so stats can be tuned...
Nandana Duttf02cd782019-06-14 14:25:13 +01003742 progress_->Inc(delta_sec);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003743
3744 // ...but only notifiy listeners when necessary.
3745 if (!options_->do_progress_updates) return;
3746
3747 int progress = progress_->Get();
3748 int max = progress_->GetMax();
Nandana Duttf02cd782019-06-14 14:25:13 +01003749 int percent = 100 * progress / max;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003750
Nandana Duttf02cd782019-06-14 14:25:13 +01003751 if (last_reported_percent_progress_ > 0 && percent <= last_reported_percent_progress_) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003752 return;
3753 }
Nandana Duttf02cd782019-06-14 14:25:13 +01003754 last_reported_percent_progress_ = percent;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003755
3756 if (control_socket_fd_ >= 0) {
3757 dprintf(control_socket_fd_, "PROGRESS:%d/%d\n", progress, max);
3758 fsync(control_socket_fd_);
3759 }
3760
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003761 if (listener_ != nullptr) {
3762 if (percent % 5 == 0) {
3763 // We don't want to spam logcat, so only log multiples of 5.
3764 MYLOGD("Setting progress (%s): %d/%d (%d%%)\n", listener_name_.c_str(), progress, max,
3765 percent);
3766 } else {
3767 // stderr is ignored on normal invocations, but useful when calling
3768 // /system/bin/dumpstate directly for debuggging.
3769 fprintf(stderr, "Setting progress (%s): %d/%d (%d%%)\n", listener_name_.c_str(),
3770 progress, max, percent);
3771 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003772
3773 listener_->onProgress(percent);
3774 }
3775}
3776
3777void Dumpstate::TakeScreenshot(const std::string& path) {
3778 const std::string& real_path = path.empty() ? screenshot_path_ : path;
3779 int status =
3780 RunCommand("", {"/system/bin/screencap", "-p", real_path},
3781 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3782 if (status == 0) {
3783 MYLOGD("Screenshot saved on %s\n", real_path.c_str());
3784 } else {
3785 MYLOGE("Failed to take screenshot on %s\n", real_path.c_str());
3786 }
3787}
3788
3789bool is_dir(const char* pathname) {
3790 struct stat info;
3791 if (stat(pathname, &info) == -1) {
3792 return false;
3793 }
3794 return S_ISDIR(info.st_mode);
3795}
3796
3797time_t get_mtime(int fd, time_t default_mtime) {
3798 struct stat info;
3799 if (fstat(fd, &info) == -1) {
3800 return default_mtime;
3801 }
3802 return info.st_mtime;
3803}