blob: 733b71eb56ad9e7c8ccee9a2ea55f26835a545fd [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>
Hunter Knepshield8540faf2020-02-04 19:47:20 -080067#include <android/hardware/dumpstate/1.1/IDumpstateDevice.h>
68#include <android/hardware/dumpstate/1.1/types.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080069#include <android/hidl/manager/1.0/IServiceManager.h>
Nandana Duttd2f5f082019-01-18 17:13:52 +000070#include <android/os/IIncidentCompanion.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010071#include <binder/IServiceManager.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080072#include <cutils/native_handle.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070073#include <cutils/properties.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010074#include <cutils/sockets.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000075#include <debuggerd/client.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080076#include <dumpsys.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000077#include <dumputils/dump_utils.h>
Sahana Raof35ed432019-07-12 10:47:52 +010078#include <hardware_legacy/power.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080079#include <hidl/ServiceManagement.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010080#include <log/log.h>
Felipe Leme75876a22016-10-27 16:31:27 -070081#include <openssl/sha.h>
Mark Salyzyn6c3d90f2016-09-27 14:55:27 -070082#include <private/android_filesystem_config.h>
83#include <private/android_logger.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080084#include <serviceutils/PriorityDumper.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070085#include <utils/StrongPointer.h>
Felipe Lemef0292972016-11-22 13:57:05 -080086#include "DumpstateInternal.h"
Felipe Leme75876a22016-10-27 16:31:27 -070087#include "DumpstateService.h"
Colin Crossf45fa6b2012-03-26 12:38:26 -070088#include "dumpstate.h"
Felipe Leme6e01fa62015-11-11 19:35:14 -080089
Hunter Knepshield8540faf2020-02-04 19:47:20 -080090using IDumpstateDevice_1_0 = ::android::hardware::dumpstate::V1_0::IDumpstateDevice;
91using IDumpstateDevice_1_1 = ::android::hardware::dumpstate::V1_1::IDumpstateDevice;
92using ::android::hardware::dumpstate::V1_1::DumpstateMode;
93using ::android::hardware::dumpstate::V1_1::DumpstateStatus;
94using ::android::hardware::dumpstate::V1_1::toString;
Vishnu Naire97d6122018-01-18 13:58:56 -080095using ::std::literals::chrono_literals::operator""ms;
96using ::std::literals::chrono_literals::operator""s;
Steven Morelandcb7ef822016-11-29 13:20:37 -080097
Felipe Leme47e9be22016-12-21 15:37:07 -080098// TODO: remove once moved to namespace
Vishnu Naire97d6122018-01-18 13:58:56 -080099using android::defaultServiceManager;
100using android::Dumpsys;
101using android::INVALID_OPERATION;
102using android::IServiceManager;
103using android::OK;
104using android::sp;
105using android::status_t;
106using android::String16;
107using android::String8;
108using android::TIMED_OUT;
109using android::UNKNOWN_ERROR;
110using android::Vector;
Nandana Dutt979388e2018-11-30 16:48:55 +0000111using android::base::StringPrintf;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000112using android::os::IDumpstateListener;
Felipe Leme47e9be22016-12-21 15:37:07 -0800113using android::os::dumpstate::CommandOptions;
114using android::os::dumpstate::DumpFileToFd;
Vishnu Naire97d6122018-01-18 13:58:56 -0800115using android::os::dumpstate::PropertiesHelper;
Felipe Leme47e9be22016-12-21 15:37:07 -0800116
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100117// Keep in sync with
118// frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
119static const int TRACE_DUMP_TIMEOUT_MS = 10000; // 10 seconds
120
121/* Most simple commands have 10 as timeout, so 5 is a good estimate */
122static const int32_t WEIGHT_FILE = 5;
123
124// TODO: temporary variables and functions used during C++ refactoring
125static Dumpstate& ds = Dumpstate::GetInstance();
126static int RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Nandana Dutt8d945c02019-08-14 13:30:07 +0100127 const CommandOptions& options = CommandOptions::DEFAULT,
128 bool verbose_duration = false) {
129 return ds.RunCommand(title, full_command, options, verbose_duration);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100130}
131
132// Reasonable value for max stats.
133static const int STATS_MAX_N_RUNS = 1000;
134static const long STATS_MAX_AVERAGE = 100000;
135
136CommandOptions Dumpstate::DEFAULT_DUMPSYS = CommandOptions::WithTimeout(30).Build();
137
Nandana Duttd2f5f082019-01-18 17:13:52 +0000138typedef Dumpstate::ConsentCallback::ConsentResult UserConsentResult;
139
Colin Crossf45fa6b2012-03-26 12:38:26 -0700140/* read before root is shed */
141static char cmdline_buf[16384] = "(unknown)";
Yi Kong19d5c002018-07-20 13:39:55 -0700142static const char *dump_traces_path = nullptr;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000143static const uint64_t USER_CONSENT_TIMEOUT_MS = 30 * 1000;
Hunter Knepshield70610fa2020-01-03 15:27:33 -0800144// Because telephony reports are significantly faster to collect (< 10 seconds vs. > 2 minutes),
145// it's often the case that they time out far too quickly for consent with such a hefty dialog for
146// the user to read. For telephony reports only, we increase the default timeout to 2 minutes to
147// roughly match full reports' durations.
148static const uint64_t TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS = 2 * 60 * 1000;
Colin Crossf45fa6b2012-03-26 12:38:26 -0700149
Felipe Leme1d486fe2016-10-14 18:06:47 -0700150// TODO: variables and functions below should be part of dumpstate object
151
Felipe Leme635ca312016-01-05 14:23:02 -0800152static std::set<std::string> mount_points;
153void add_mountinfo();
Felipe Leme78f2c862015-12-21 09:55:22 -0800154
Todd Poynor2a83daa2013-11-22 15:44:22 -0800155#define PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops"
Mark Salyzyn7d0a7622016-06-24 14:06:15 -0700156#define ALT_PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops-0"
Wei Wang509bb5d2017-06-09 14:42:12 -0700157#define BLK_DEV_SYS_DIR "/sys/block"
Todd Poynor2a83daa2013-11-22 15:44:22 -0800158
Felipe Lemee82a27d2016-01-05 13:35:44 -0800159#define RECOVERY_DIR "/cache/recovery"
Mark Salyzynd6ab0112016-03-25 12:56:39 -0700160#define RECOVERY_DATA_DIR "/data/misc/recovery"
Tianjie Xu75d53362018-04-11 16:42:28 -0700161#define UPDATE_ENGINE_LOG_DIR "/data/misc/update_engine_log"
Mark Salyzyn4d42dea2016-04-01 10:03:14 -0700162#define LOGPERSIST_DATA_DIR "/data/misc/logd"
Jerry Changa1df8a92020-01-02 16:03:39 +0800163#define PREREBOOT_DATA_DIR "/data/misc/prereboot"
David Brazdild2991962016-06-03 14:40:44 +0100164#define PROFILE_DATA_DIR_CUR "/data/misc/profiles/cur"
165#define PROFILE_DATA_DIR_REF "/data/misc/profiles/ref"
Benedict Wong8f9d8a42019-01-03 16:19:38 -0800166#define XFRM_STAT_PROC_FILE "/proc/net/xfrm_stat"
Erik Kline08165202016-05-30 11:55:44 +0900167#define WLUTIL "/vendor/xbin/wlutil"
Vishnu Nair36b4cdb2017-11-17 10:27:05 -0800168#define WMTRACE_DATA_DIR "/data/misc/wmtrace"
Yifan Hong3945e1b2019-10-29 12:59:23 -0700169#define OTA_METADATA_DIR "/metadata/ota"
Yifan Hong0efa7972020-02-03 16:45:02 -0800170#define SNAPSHOTCTL_LOG_DIR "/data/misc/snapshotctl_log"
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +0900171#define LINKERCONFIG_DIR "/linkerconfig"
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700172
Narayan Kamath8f788292017-05-25 13:20:39 +0100173// TODO(narayan): Since this information has to be kept in sync
174// with tombstoned, we should just put it in a common header.
175//
176// File: system/core/debuggerd/tombstoned/tombstoned.cpp
Narayan Kamathbd863722017-06-01 18:50:12 +0100177static const std::string TOMBSTONE_DIR = "/data/tombstones/";
178static const std::string TOMBSTONE_FILE_PREFIX = "tombstone_";
179static const std::string ANR_DIR = "/data/anr/";
180static const std::string ANR_FILE_PREFIX = "anr_";
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700181
Felipe Lemee844a9d2016-09-21 15:01:39 -0700182// TODO: temporary variables and functions used during C++ refactoring
Nandana Dutt979388e2018-11-30 16:48:55 +0000183
Nandana Dutt5c390032019-03-12 10:52:56 +0000184#define RETURN_IF_USER_DENIED_CONSENT() \
185 if (ds.IsUserConsentDenied()) { \
186 MYLOGE("Returning early as user denied consent to share bugreport with calling app."); \
187 return Dumpstate::RunStatus::USER_CONSENT_DENIED; \
188 }
189
190// Runs func_ptr, but checks user consent before and after running it. Returns USER_CONSENT_DENIED
191// if consent is found to be denied.
192#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(func_ptr, ...) \
193 RETURN_IF_USER_DENIED_CONSENT(); \
194 func_ptr(__VA_ARGS__); \
195 RETURN_IF_USER_DENIED_CONSENT();
196
Sahana Raof35ed432019-07-12 10:47:52 +0100197static const char* WAKE_LOCK_NAME = "dumpstate_wakelock";
198
Nandana Dutt979388e2018-11-30 16:48:55 +0000199namespace android {
200namespace os {
201namespace {
202
203static int Open(std::string path, int flags, mode_t mode = 0) {
204 int fd = TEMP_FAILURE_RETRY(open(path.c_str(), flags, mode));
205 if (fd == -1) {
206 MYLOGE("open(%s, %s)\n", path.c_str(), strerror(errno));
207 }
208 return fd;
209}
210
Nandana Dutt979388e2018-11-30 16:48:55 +0000211
212static int OpenForRead(std::string path) {
213 return Open(path, O_RDONLY | O_CLOEXEC | O_NOFOLLOW);
214}
215
216bool CopyFile(int in_fd, int out_fd) {
217 char buf[4096];
218 ssize_t byte_count;
219 while ((byte_count = TEMP_FAILURE_RETRY(read(in_fd, buf, sizeof(buf)))) > 0) {
220 if (!android::base::WriteFully(out_fd, buf, byte_count)) {
221 return false;
222 }
223 }
224 return (byte_count != -1);
225}
226
227static bool CopyFileToFd(const std::string& input_file, int out_fd) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000228 MYLOGD("Going to copy file (%s) to %d\n", input_file.c_str(), out_fd);
Nandana Dutt979388e2018-11-30 16:48:55 +0000229
230 // Obtain a handle to the source file.
231 android::base::unique_fd in_fd(OpenForRead(input_file));
232 if (out_fd != -1 && in_fd.get() != -1) {
233 if (CopyFile(in_fd.get(), out_fd)) {
234 return true;
235 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000236 MYLOGE("Failed to copy file: %s\n", strerror(errno));
Nandana Dutt979388e2018-11-30 16:48:55 +0000237 }
238 return false;
239}
240
Nandana Duttd2f5f082019-01-18 17:13:52 +0000241static bool UnlinkAndLogOnError(const std::string& file) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000242 if (unlink(file.c_str())) {
243 MYLOGE("Failed to unlink file (%s): %s\n", file.c_str(), strerror(errno));
Nandana Duttd2f5f082019-01-18 17:13:52 +0000244 return false;
245 }
246 return true;
247}
Nandana Dutt979388e2018-11-30 16:48:55 +0000248
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +0000249
Nikita Ioffea325a572019-05-16 19:49:47 +0100250int64_t GetModuleMetadataVersion() {
251 auto binder = defaultServiceManager()->getService(android::String16("package_native"));
252 if (binder == nullptr) {
253 MYLOGE("Failed to retrieve package_native service");
254 return 0L;
255 }
256 auto package_service = android::interface_cast<content::pm::IPackageManagerNative>(binder);
257 std::string package_name;
258 auto status = package_service->getModuleMetadataPackageName(&package_name);
259 if (!status.isOk()) {
260 MYLOGE("Failed to retrieve module metadata package name: %s", status.toString8().c_str());
261 return 0L;
262 }
Nandana Duttdb379fa2019-10-09 16:54:41 +0100263 MYLOGD("Module metadata package name: %s\n", package_name.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100264 int64_t version_code;
265 status = package_service->getVersionCodeForPackage(android::String16(package_name.c_str()),
266 &version_code);
267 if (!status.isOk()) {
268 MYLOGE("Failed to retrieve module metadata version: %s", status.toString8().c_str());
269 return 0L;
270 }
271 return version_code;
272}
273
Nandana Dutt979388e2018-11-30 16:48:55 +0000274} // namespace
275} // namespace os
276} // namespace android
277
Felipe Leme678727a2016-09-21 17:22:11 -0700278static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
Felipe Lemebda15a02016-11-16 17:48:25 -0800279 const CommandOptions& options = Dumpstate::DEFAULT_DUMPSYS,
Vishnu Nair6921f802017-11-22 09:17:23 -0800280 long dumpsysTimeoutMs = 0) {
281 return ds.RunDumpsys(title, dumpsysArgs, options, dumpsysTimeoutMs);
Felipe Leme678727a2016-09-21 17:22:11 -0700282}
283static int DumpFile(const std::string& title, const std::string& path) {
284 return ds.DumpFile(title, path);
285}
Felipe Lemee82a27d2016-01-05 13:35:44 -0800286
Felipe Lemee844a9d2016-09-21 15:01:39 -0700287// Relative directory (inside the zip) for all files copied as-is into the bugreport.
288static const std::string ZIP_ROOT_DIR = "FS";
289
Vishnu Naire97d6122018-01-18 13:58:56 -0800290static const std::string kProtoPath = "proto/";
291static const std::string kProtoExt = ".proto";
Jie Song9fbfad02017-06-20 16:29:42 -0700292static const std::string kDumpstateBoardFiles[] = {
293 "dumpstate_board.txt",
Felipe Leme95d6ca52017-08-01 16:35:56 -0700294 "dumpstate_board.bin"
Jie Song9fbfad02017-06-20 16:29:42 -0700295};
296static const int NUM_OF_DUMPS = arraysize(kDumpstateBoardFiles);
297
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700298static constexpr char PROPERTY_LAST_ID[] = "dumpstate.last_id";
Felipe Lemed071c682016-10-20 16:48:00 -0700299static constexpr char PROPERTY_VERSION[] = "dumpstate.version";
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700300
Felipe Lemef0292972016-11-22 13:57:05 -0800301static const CommandOptions AS_ROOT_20 = CommandOptions::WithTimeout(20).AsRoot().Build();
302
Narayan Kamath8f788292017-05-25 13:20:39 +0100303/*
Narayan Kamathbd863722017-06-01 18:50:12 +0100304 * Returns a vector of dump fds under |dir_path| with a given |file_prefix|.
305 * The returned vector is sorted by the mtimes of the dumps. If |limit_by_mtime|
306 * is set, the vector only contains files that were written in the last 30 minutes.
Narayan Kamath8f788292017-05-25 13:20:39 +0100307 */
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700308static std::vector<DumpData> GetDumpFds(const std::string& dir_path,
309 const std::string& file_prefix,
Elliott Hughesdb6d2112019-09-26 15:24:51 -0700310 bool limit_by_mtime) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100311 const time_t thirty_minutes_ago = ds.now_ - 60 * 30;
312
Narayan Kamathbd863722017-06-01 18:50:12 +0100313 std::unique_ptr<DIR, decltype(&closedir)> dump_dir(opendir(dir_path.c_str()), closedir);
Narayan Kamath8f788292017-05-25 13:20:39 +0100314
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700315 if (dump_dir == nullptr) {
316 MYLOGW("Unable to open directory %s: %s\n", dir_path.c_str(), strerror(errno));
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700317 return std::vector<DumpData>();
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700318 }
319
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700320 std::vector<DumpData> dump_data;
Narayan Kamathbd863722017-06-01 18:50:12 +0100321 struct dirent* entry = nullptr;
322 while ((entry = readdir(dump_dir.get()))) {
323 if (entry->d_type != DT_REG) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100324 continue;
325 }
326
Narayan Kamathbd863722017-06-01 18:50:12 +0100327 const std::string base_name(entry->d_name);
328 if (base_name.find(file_prefix) != 0) {
329 continue;
330 }
331
332 const std::string abs_path = dir_path + base_name;
333 android::base::unique_fd fd(
334 TEMP_FAILURE_RETRY(open(abs_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW | O_NONBLOCK)));
335 if (fd == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700336 MYLOGW("Unable to open dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamathbd863722017-06-01 18:50:12 +0100337 break;
338 }
339
340 struct stat st = {};
341 if (fstat(fd, &st) == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700342 MYLOGW("Unable to stat dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamath8f788292017-05-25 13:20:39 +0100343 continue;
344 }
345
Narayan Kamath3f31b632018-02-22 19:42:36 +0000346 if (limit_by_mtime && st.st_mtime < thirty_minutes_ago) {
Narayan Kamathbd863722017-06-01 18:50:12 +0100347 MYLOGI("Excluding stale dump file: %s\n", abs_path.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100348 continue;
349 }
350
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700351 dump_data.emplace_back(DumpData{abs_path, std::move(fd), st.st_mtime});
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700352 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100353
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700354 return dump_data;
Narayan Kamath8f788292017-05-25 13:20:39 +0100355}
356
Narayan Kamathbd863722017-06-01 18:50:12 +0100357static bool AddDumps(const std::vector<DumpData>::const_iterator start,
358 const std::vector<DumpData>::const_iterator end,
359 const char* type_name, const bool add_to_zip) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100360 bool dumped = false;
Narayan Kamathbd863722017-06-01 18:50:12 +0100361 for (auto it = start; it != end; ++it) {
362 const std::string& name = it->name;
363 const int fd = it->fd;
Narayan Kamath8f788292017-05-25 13:20:39 +0100364 dumped = true;
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100365
366 // Seek to the beginning of the file before dumping any data. A given
367 // DumpData entry might be dumped multiple times in the report.
368 //
369 // For example, the most recent ANR entry is dumped to the body of the
370 // main entry and it also shows up as a separate entry in the bugreport
371 // ZIP file.
372 if (lseek(fd, 0, SEEK_SET) != static_cast<off_t>(0)) {
373 MYLOGE("Unable to add %s to zip file, lseek failed: %s\n", name.c_str(),
374 strerror(errno));
375 }
376
Narayan Kamath8f788292017-05-25 13:20:39 +0100377 if (ds.IsZipping() && add_to_zip) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800378 if (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + name, fd, /* timeout = */ 0ms) != OK) {
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100379 MYLOGE("Unable to add %s to zip file, addZipEntryFromFd failed\n", name.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100380 }
381 } else {
382 dump_file_from_fd(type_name, name.c_str(), fd);
383 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100384 }
385
386 return dumped;
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700387}
388
Felipe Leme635ca312016-01-05 14:23:02 -0800389// for_each_pid() callback to get mount info about a process.
Felipe Leme4c2d6632016-09-28 14:32:00 -0700390void do_mountinfo(int pid, const char* name __attribute__((unused))) {
Felipe Leme635ca312016-01-05 14:23:02 -0800391 char path[PATH_MAX];
392
393 // Gets the the content of the /proc/PID/ns/mnt link, so only unique mount points
394 // are added.
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700395 snprintf(path, sizeof(path), "/proc/%d/ns/mnt", pid);
Felipe Leme635ca312016-01-05 14:23:02 -0800396 char linkname[PATH_MAX];
397 ssize_t r = readlink(path, linkname, PATH_MAX);
398 if (r == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800399 MYLOGE("Unable to read link for %s: %s\n", path, strerror(errno));
Felipe Leme635ca312016-01-05 14:23:02 -0800400 return;
401 }
402 linkname[r] = '\0';
403
404 if (mount_points.find(linkname) == mount_points.end()) {
405 // First time this mount point was found: add it
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700406 snprintf(path, sizeof(path), "/proc/%d/mountinfo", pid);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700407 if (ds.AddZipEntry(ZIP_ROOT_DIR + path, path)) {
Felipe Leme635ca312016-01-05 14:23:02 -0800408 mount_points.insert(linkname);
409 } else {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800410 MYLOGE("Unable to add mountinfo %s to zip file\n", path);
Felipe Leme635ca312016-01-05 14:23:02 -0800411 }
412 }
413}
414
415void add_mountinfo() {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700416 if (!ds.IsZipping()) return;
Felipe Leme678727a2016-09-21 17:22:11 -0700417 std::string title = "MOUNT INFO";
Felipe Leme635ca312016-01-05 14:23:02 -0800418 mount_points.clear();
Felipe Leme46b85da2016-11-21 17:40:45 -0800419 DurationReporter duration_reporter(title, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700420 for_each_pid(do_mountinfo, nullptr);
421 MYLOGD("%s: %d entries added to zip file\n", title.c_str(), (int)mount_points.size());
Felipe Leme635ca312016-01-05 14:23:02 -0800422}
423
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700424static void dump_dev_files(const char *title, const char *driverpath, const char *filename)
425{
426 DIR *d;
427 struct dirent *de;
428 char path[PATH_MAX];
429
430 d = opendir(driverpath);
Yi Kong19d5c002018-07-20 13:39:55 -0700431 if (d == nullptr) {
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700432 return;
433 }
434
435 while ((de = readdir(d))) {
436 if (de->d_type != DT_LNK) {
437 continue;
438 }
439 snprintf(path, sizeof(path), "%s/%s/%s", driverpath, de->d_name, filename);
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700440 DumpFile(title, path);
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700441 }
442
443 closedir(d);
444}
445
Mark Salyzyn326842f2015-04-30 09:49:41 -0700446static bool skip_not_stat(const char *path) {
447 static const char stat[] = "/stat";
448 size_t len = strlen(path);
449 if (path[len - 1] == '/') { /* Directory? */
450 return false;
451 }
452 return strcmp(path + len - sizeof(stat) + 1, stat); /* .../stat? */
453}
454
Felipe Leme4c2d6632016-09-28 14:32:00 -0700455static bool skip_none(const char* path __attribute__((unused))) {
Felipe Lemee82a27d2016-01-05 13:35:44 -0800456 return false;
457}
458
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700459unsigned long worst_write_perf = 20000; /* in KB/s */
Mark Salyzyn326842f2015-04-30 09:49:41 -0700460
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800461//
462// stat offsets
463// Name units description
464// ---- ----- -----------
465// read I/Os requests number of read I/Os processed
466#define __STAT_READ_IOS 0
467// read merges requests number of read I/Os merged with in-queue I/O
468#define __STAT_READ_MERGES 1
469// read sectors sectors number of sectors read
470#define __STAT_READ_SECTORS 2
471// read ticks milliseconds total wait time for read requests
472#define __STAT_READ_TICKS 3
473// write I/Os requests number of write I/Os processed
474#define __STAT_WRITE_IOS 4
475// write merges requests number of write I/Os merged with in-queue I/O
476#define __STAT_WRITE_MERGES 5
477// write sectors sectors number of sectors written
478#define __STAT_WRITE_SECTORS 6
479// write ticks milliseconds total wait time for write requests
480#define __STAT_WRITE_TICKS 7
481// in_flight requests number of I/Os currently in flight
482#define __STAT_IN_FLIGHT 8
483// io_ticks milliseconds total time this block device has been active
484#define __STAT_IO_TICKS 9
485// time_in_queue milliseconds total wait time for all requests
486#define __STAT_IN_QUEUE 10
487#define __STAT_NUMBER_FIELD 11
488//
489// read I/Os, write I/Os
490// =====================
491//
492// These values increment when an I/O request completes.
493//
494// read merges, write merges
495// =========================
496//
497// These values increment when an I/O request is merged with an
498// already-queued I/O request.
499//
500// read sectors, write sectors
501// ===========================
502//
503// These values count the number of sectors read from or written to this
504// block device. The "sectors" in question are the standard UNIX 512-byte
505// sectors, not any device- or filesystem-specific block size. The
506// counters are incremented when the I/O completes.
507#define SECTOR_SIZE 512
508//
509// read ticks, write ticks
510// =======================
511//
512// These values count the number of milliseconds that I/O requests have
513// waited on this block device. If there are multiple I/O requests waiting,
514// these values will increase at a rate greater than 1000/second; for
515// example, if 60 read requests wait for an average of 30 ms, the read_ticks
516// field will increase by 60*30 = 1800.
517//
518// in_flight
519// =========
520//
521// This value counts the number of I/O requests that have been issued to
522// the device driver but have not yet completed. It does not include I/O
523// requests that are in the queue but not yet issued to the device driver.
524//
525// io_ticks
526// ========
527//
528// This value counts the number of milliseconds during which the device has
529// had I/O requests queued.
530//
531// time_in_queue
532// =============
533//
534// This value counts the number of milliseconds that I/O requests have waited
535// on this block device. If there are multiple I/O requests waiting, this
536// value will increase as the product of the number of milliseconds times the
537// number of requests waiting (see "read ticks" above for an example).
538#define S_TO_MS 1000
539//
540
Mark Salyzyn326842f2015-04-30 09:49:41 -0700541static int dump_stat_from_fd(const char *title __unused, const char *path, int fd) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800542 unsigned long long fields[__STAT_NUMBER_FIELD];
Mark Salyzyn326842f2015-04-30 09:49:41 -0700543 bool z;
Yi Kong19d5c002018-07-20 13:39:55 -0700544 char *cp, *buffer = nullptr;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700545 size_t i = 0;
Josh Gao7c4258c2018-06-25 13:40:08 -0700546 FILE *fp = fdopen(dup(fd), "rb");
Mark Salyzyn326842f2015-04-30 09:49:41 -0700547 getline(&buffer, &i, fp);
548 fclose(fp);
549 if (!buffer) {
550 return -errno;
551 }
552 i = strlen(buffer);
553 while ((i > 0) && (buffer[i - 1] == '\n')) {
554 buffer[--i] = '\0';
555 }
556 if (!*buffer) {
557 free(buffer);
558 return 0;
559 }
560 z = true;
561 for (cp = buffer, i = 0; i < (sizeof(fields) / sizeof(fields[0])); ++i) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800562 fields[i] = strtoull(cp, &cp, 10);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700563 if (fields[i] != 0) {
564 z = false;
565 }
566 }
567 if (z) { /* never accessed */
568 free(buffer);
569 return 0;
570 }
571
Wei Wang509bb5d2017-06-09 14:42:12 -0700572 if (!strncmp(path, BLK_DEV_SYS_DIR, sizeof(BLK_DEV_SYS_DIR) - 1)) {
573 path += sizeof(BLK_DEV_SYS_DIR) - 1;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700574 }
Wei Wang1dc1ef52017-06-12 11:28:37 -0700575
576 printf("%-30s:%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s\n%-30s:\t%s\n", "Block-Dev",
577 "R-IOs", "R-merg", "R-sect", "R-wait", "W-IOs", "W-merg", "W-sect",
578 "W-wait", "in-fli", "activ", "T-wait", path, buffer);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700579 free(buffer);
580
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800581 if (fields[__STAT_IO_TICKS]) {
582 unsigned long read_perf = 0;
583 unsigned long read_ios = 0;
584 if (fields[__STAT_READ_TICKS]) {
585 unsigned long long divisor = fields[__STAT_READ_TICKS]
586 * fields[__STAT_IO_TICKS];
587 read_perf = ((unsigned long long)SECTOR_SIZE
588 * fields[__STAT_READ_SECTORS]
589 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
590 / divisor;
591 read_ios = ((unsigned long long)S_TO_MS * fields[__STAT_READ_IOS]
592 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
593 / divisor;
594 }
595
596 unsigned long write_perf = 0;
597 unsigned long write_ios = 0;
598 if (fields[__STAT_WRITE_TICKS]) {
599 unsigned long long divisor = fields[__STAT_WRITE_TICKS]
600 * fields[__STAT_IO_TICKS];
601 write_perf = ((unsigned long long)SECTOR_SIZE
602 * fields[__STAT_WRITE_SECTORS]
603 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
604 / divisor;
605 write_ios = ((unsigned long long)S_TO_MS * fields[__STAT_WRITE_IOS]
606 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
607 / divisor;
608 }
609
610 unsigned queue = (fields[__STAT_IN_QUEUE]
611 + (fields[__STAT_IO_TICKS] >> 1))
612 / fields[__STAT_IO_TICKS];
613
614 if (!write_perf && !write_ios) {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700615 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 -0800616 } else {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700617 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 -0800618 read_ios, write_perf, write_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800619 }
620
621 /* bugreport timeout factor adjustment */
622 if ((write_perf > 1) && (write_perf < worst_write_perf)) {
623 worst_write_perf = write_perf;
624 }
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700625 }
Mark Salyzyn326842f2015-04-30 09:49:41 -0700626 return 0;
627}
628
Yao Chenbe3bbc12018-01-17 16:31:10 -0800629static const long MINIMUM_LOGCAT_TIMEOUT_MS = 50000;
630
631/* timeout in ms to read a list of buffers */
632static unsigned long logcat_timeout(const std::vector<std::string>& buffers) {
633 unsigned long timeout_ms = 0;
634 for (const auto& buffer : buffers) {
635 log_id_t id = android_name_to_log_id(buffer.c_str());
636 unsigned long property_size = __android_logger_get_buffer_size(id);
637 /* Engineering margin is ten-fold our guess */
638 timeout_ms += 10 * (property_size + worst_write_perf) / worst_write_perf;
639 }
640 return timeout_ms > MINIMUM_LOGCAT_TIMEOUT_MS ? timeout_ms : MINIMUM_LOGCAT_TIMEOUT_MS;
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700641}
642
Nandana Duttd2f5f082019-01-18 17:13:52 +0000643Dumpstate::ConsentCallback::ConsentCallback() : result_(UNAVAILABLE), start_time_(Nanotime()) {
644}
645
646android::binder::Status Dumpstate::ConsentCallback::onReportApproved() {
647 std::lock_guard<std::mutex> lock(lock_);
648 result_ = APPROVED;
649 MYLOGD("User approved consent to share bugreport\n");
Paul Chang0d2aad72020-02-13 20:04:03 +0800650
651 // Maybe copy screenshot so calling app can display the screenshot to the user as soon as
652 // consent is granted.
653 if (ds.options_->is_screenshot_copied) {
654 return android::binder::Status::ok();
655 }
656
657 if (!ds.options_->do_screenshot || ds.options_->screenshot_fd.get() == -1 ||
658 !ds.do_early_screenshot_) {
659 return android::binder::Status::ok();
660 }
661
662 bool copy_succeeded = android::os::CopyFileToFd(ds.screenshot_path_,
663 ds.options_->screenshot_fd.get());
664 ds.options_->is_screenshot_copied = copy_succeeded;
665 if (copy_succeeded) {
666 android::os::UnlinkAndLogOnError(ds.screenshot_path_);
667 }
Nandana Duttd2f5f082019-01-18 17:13:52 +0000668 return android::binder::Status::ok();
669}
670
671android::binder::Status Dumpstate::ConsentCallback::onReportDenied() {
672 std::lock_guard<std::mutex> lock(lock_);
673 result_ = DENIED;
674 MYLOGW("User denied consent to share bugreport\n");
675 return android::binder::Status::ok();
676}
677
678UserConsentResult Dumpstate::ConsentCallback::getResult() {
679 std::lock_guard<std::mutex> lock(lock_);
680 return result_;
681}
682
683uint64_t Dumpstate::ConsentCallback::getElapsedTimeMs() const {
Hunter Knepshieldf0a39052020-01-03 14:53:04 -0800684 return (Nanotime() - start_time_) / NANOS_PER_MILLI;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000685}
686
Felipe Leme2b9b06c2016-10-14 09:13:06 -0700687void Dumpstate::PrintHeader() const {
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700688 std::string build, fingerprint, radio, bootloader, network;
689 char date[80];
Colin Crossf45fa6b2012-03-26 12:38:26 -0700690
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700691 build = android::base::GetProperty("ro.build.display.id", "(unknown)");
692 fingerprint = android::base::GetProperty("ro.build.fingerprint", "(unknown)");
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700693 radio = android::base::GetProperty("gsm.version.baseband", "(unknown)");
694 bootloader = android::base::GetProperty("ro.bootloader", "(unknown)");
695 network = android::base::GetProperty("gsm.operator.alpha", "(unknown)");
Felipe Lemebbaf3c12016-10-11 14:32:25 -0700696 strftime(date, sizeof(date), "%Y-%m-%d %H:%M:%S", localtime(&now_));
Colin Crossf45fa6b2012-03-26 12:38:26 -0700697
Felipe Lemed8b94e52016-12-08 10:21:44 -0800698 printf("========================================================\n");
699 printf("== dumpstate: %s\n", date);
700 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -0700701
Felipe Lemed8b94e52016-12-08 10:21:44 -0800702 printf("\n");
703 printf("Build: %s\n", build.c_str());
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700704 // NOTE: fingerprint entry format is important for other tools.
Felipe Lemed8b94e52016-12-08 10:21:44 -0800705 printf("Build fingerprint: '%s'\n", fingerprint.c_str());
706 printf("Bootloader: %s\n", bootloader.c_str());
707 printf("Radio: %s\n", radio.c_str());
708 printf("Network: %s\n", network.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100709 int64_t module_metadata_version = android::os::GetModuleMetadataVersion();
710 if (module_metadata_version != 0) {
711 printf("Module Metadata version: %" PRId64 "\n", module_metadata_version);
712 }
Colin Crossf45fa6b2012-03-26 12:38:26 -0700713
Felipe Lemed8b94e52016-12-08 10:21:44 -0800714 printf("Kernel: ");
Felipe Lemef0292972016-11-22 13:57:05 -0800715 DumpFileToFd(STDOUT_FILENO, "", "/proc/version");
Felipe Lemed8b94e52016-12-08 10:21:44 -0800716 printf("Command line: %s\n", strtok(cmdline_buf, "\n"));
Felipe Leme7709f8a2017-12-05 09:30:09 -0800717 printf("Uptime: ");
718 RunCommandToFd(STDOUT_FILENO, "", {"uptime", "-p"},
719 CommandOptions::WithTimeout(1).Always().Build());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800720 printf("Bugreport format version: %s\n", version_.c_str());
Abhijeet Kaure370d682019-10-01 16:49:30 +0100721 printf("Dumpstate info: id=%d pid=%d dry_run=%d args=%s bugreport_mode=%s\n", id_, pid_,
722 PropertiesHelper::IsDryRun(), options_->args.c_str(), options_->bugreport_mode.c_str());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800723 printf("\n");
Felipe Leme78f2c862015-12-21 09:55:22 -0800724}
725
Felipe Leme24b66ee2016-06-16 10:55:26 -0700726// List of file extensions that can cause a zip file attachment to be rejected by some email
727// service providers.
728static const std::set<std::string> PROBLEMATIC_FILE_EXTENSIONS = {
729 ".ade", ".adp", ".bat", ".chm", ".cmd", ".com", ".cpl", ".exe", ".hta", ".ins", ".isp",
730 ".jar", ".jse", ".lib", ".lnk", ".mde", ".msc", ".msp", ".mst", ".pif", ".scr", ".sct",
731 ".shb", ".sys", ".vb", ".vbe", ".vbs", ".vxd", ".wsc", ".wsf", ".wsh"
732};
733
Vishnu Naire97d6122018-01-18 13:58:56 -0800734status_t Dumpstate::AddZipEntryFromFd(const std::string& entry_name, int fd,
735 std::chrono::milliseconds timeout = 0ms) {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700736 if (!IsZipping()) {
737 MYLOGD("Not adding zip entry %s from fd because it's not a zipped bugreport\n",
738 entry_name.c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -0800739 return INVALID_OPERATION;
Felipe Leme111b9d02016-02-03 09:28:24 -0800740 }
Felipe Leme24b66ee2016-06-16 10:55:26 -0700741 std::string valid_name = entry_name;
742
743 // Rename extension if necessary.
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -0700744 size_t idx = entry_name.rfind('.');
Felipe Leme24b66ee2016-06-16 10:55:26 -0700745 if (idx != std::string::npos) {
746 std::string extension = entry_name.substr(idx);
747 std::transform(extension.begin(), extension.end(), extension.begin(), ::tolower);
748 if (PROBLEMATIC_FILE_EXTENSIONS.count(extension) != 0) {
749 valid_name = entry_name + ".renamed";
750 MYLOGI("Renaming entry %s to %s\n", entry_name.c_str(), valid_name.c_str());
751 }
752 }
753
Felipe Leme6fe9db62016-02-12 09:04:16 -0800754 // Logging statement below is useful to time how long each entry takes, but it's too verbose.
755 // MYLOGD("Adding zip entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700756 int32_t err = zip_writer_->StartEntryWithTime(valid_name.c_str(), ZipWriter::kCompress,
757 get_mtime(fd, ds.now_));
Felipe Leme1d486fe2016-10-14 18:06:47 -0700758 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700759 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", valid_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700760 ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800761 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800762 }
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000763 bool finished_entry = false;
764 auto finish_entry = [this, &finished_entry] {
765 if (!finished_entry) {
766 // This should only be called when we're going to return an earlier error,
767 // which would've been logged. This may imply the file is already corrupt
768 // and any further logging from FinishEntry is more likely to mislead than
769 // not.
770 this->zip_writer_->FinishEntry();
771 }
772 };
773 auto scope_guard = android::base::make_scope_guard(finish_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -0800774 auto start = std::chrono::steady_clock::now();
775 auto end = start + timeout;
776 struct pollfd pfd = {fd, POLLIN};
Felipe Lemee82a27d2016-01-05 13:35:44 -0800777
Felipe Leme770410d2016-01-26 17:07:14 -0800778 std::vector<uint8_t> buffer(65536);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800779 while (1) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800780 if (timeout.count() > 0) {
781 // lambda to recalculate the timeout.
782 auto time_left_ms = [end]() {
783 auto now = std::chrono::steady_clock::now();
784 auto diff = std::chrono::duration_cast<std::chrono::milliseconds>(end - now);
785 return std::max(diff.count(), 0LL);
786 };
787
788 int rc = TEMP_FAILURE_RETRY(poll(&pfd, 1, time_left_ms()));
789 if (rc < 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000790 MYLOGE("Error in poll while adding from fd to zip entry %s:%s\n",
791 entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800792 return -errno;
793 } else if (rc == 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000794 MYLOGE("Timed out adding from fd to zip entry %s:%s Timeout:%lldms\n",
Vishnu Naire97d6122018-01-18 13:58:56 -0800795 entry_name.c_str(), strerror(errno), timeout.count());
796 return TIMED_OUT;
797 }
798 }
799
Zach Riggle22200402016-08-18 01:01:24 -0400800 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800801 if (bytes_read == 0) {
802 break;
803 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800804 MYLOGE("read(%s): %s\n", entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800805 return -errno;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800806 }
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700807 err = zip_writer_->WriteBytes(buffer.data(), bytes_read);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800808 if (err) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700809 MYLOGE("zip_writer_->WriteBytes(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800810 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800811 }
812 }
813
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700814 err = zip_writer_->FinishEntry();
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000815 finished_entry = true;
Felipe Leme1d486fe2016-10-14 18:06:47 -0700816 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700817 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800818 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800819 }
820
Vishnu Naire97d6122018-01-18 13:58:56 -0800821 return OK;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800822}
823
Felipe Leme1d486fe2016-10-14 18:06:47 -0700824bool Dumpstate::AddZipEntry(const std::string& entry_name, const std::string& entry_path) {
825 android::base::unique_fd fd(
826 TEMP_FAILURE_RETRY(open(entry_path.c_str(), O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
Andreas Gampeaff68432016-07-18 18:01:27 -0700827 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800828 MYLOGE("open(%s): %s\n", entry_path.c_str(), strerror(errno));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800829 return false;
830 }
831
Vishnu Naire97d6122018-01-18 13:58:56 -0800832 return (AddZipEntryFromFd(entry_name, fd.get()) == OK);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800833}
834
835/* adds a file to the existing zipped bugreport */
Felipe Leme4c2d6632016-09-28 14:32:00 -0700836static int _add_file_from_fd(const char* title __attribute__((unused)), const char* path, int fd) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800837 return (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + path, fd) == OK) ? 0 : 1;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800838}
839
Felipe Leme1d486fe2016-10-14 18:06:47 -0700840void Dumpstate::AddDir(const std::string& dir, bool recursive) {
841 if (!IsZipping()) {
842 MYLOGD("Not adding dir %s because it's not a zipped bugreport\n", dir.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800843 return;
844 }
Felipe Leme678727a2016-09-21 17:22:11 -0700845 MYLOGD("Adding dir %s (recursive: %d)\n", dir.c_str(), recursive);
Felipe Leme46b85da2016-11-21 17:40:45 -0800846 DurationReporter duration_reporter(dir, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700847 dump_files("", dir.c_str(), recursive ? skip_none : is_dir, _add_file_from_fd);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800848}
849
Felipe Leme1d486fe2016-10-14 18:06:47 -0700850bool Dumpstate::AddTextZipEntry(const std::string& entry_name, const std::string& content) {
851 if (!IsZipping()) {
852 MYLOGD("Not adding text zip entry %s because it's not a zipped bugreport\n",
853 entry_name.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800854 return false;
855 }
Felipe Lemecbce55d2016-02-08 09:53:18 -0800856 MYLOGD("Adding zip text entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700857 int32_t err = zip_writer_->StartEntryWithTime(entry_name.c_str(), ZipWriter::kCompress, ds.now_);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700858 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700859 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700860 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800861 return false;
862 }
863
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700864 err = zip_writer_->WriteBytes(content.c_str(), content.length());
Felipe Leme1d486fe2016-10-14 18:06:47 -0700865 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700866 MYLOGE("zip_writer_->WriteBytes(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700867 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800868 return false;
869 }
870
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700871 err = zip_writer_->FinishEntry();
Felipe Leme1d486fe2016-10-14 18:06:47 -0700872 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700873 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800874 return false;
875 }
876
877 return true;
878}
879
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800880static void DoKmsg() {
881 struct stat st;
882 if (!stat(PSTORE_LAST_KMSG, &st)) {
883 /* Also TODO: Make console-ramoops CAP_SYSLOG protected. */
884 DumpFile("LAST KMSG", PSTORE_LAST_KMSG);
885 } else if (!stat(ALT_PSTORE_LAST_KMSG, &st)) {
886 DumpFile("LAST KMSG", ALT_PSTORE_LAST_KMSG);
887 } else {
888 /* TODO: Make last_kmsg CAP_SYSLOG protected. b/5555691 */
889 DumpFile("LAST KMSG", "/proc/last_kmsg");
890 }
891}
892
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800893static void DoKernelLogcat() {
Yao Chenbe3bbc12018-01-17 16:31:10 -0800894 unsigned long timeout_ms = logcat_timeout({"kernel"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800895 RunCommand(
896 "KERNEL LOG",
897 {"logcat", "-b", "kernel", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
898 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
899}
900
Nandana Duttdb379fa2019-10-09 16:54:41 +0100901static void DoSystemLogcat(time_t since) {
902 char since_str[80];
903 strftime(since_str, sizeof(since_str), "%Y-%m-%d %H:%M:%S.000", localtime(&since));
904
905 unsigned long timeout_ms = logcat_timeout({"main", "system", "crash"});
906 RunCommand("SYSTEM LOG",
907 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v", "-T",
908 since_str},
909 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
910}
911
Hunter Knepshield820f9bc2020-02-05 20:10:53 -0800912static void DoRadioLogcat() {
913 unsigned long timeout_ms = logcat_timeout({"radio"});
914 RunCommand(
915 "RADIO LOG",
916 {"logcat", "-b", "radio", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
917 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
918}
919
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800920static void DoLogcat() {
Vishnu Nair6921f802017-11-22 09:17:23 -0800921 unsigned long timeout_ms;
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800922 // DumpFile("EVENT LOG TAGS", "/etc/event-log-tags");
923 // calculate timeout
Yao Chenbe3bbc12018-01-17 16:31:10 -0800924 timeout_ms = logcat_timeout({"main", "system", "crash"});
Tony Makae737652017-03-30 17:47:09 +0100925 RunCommand("SYSTEM LOG",
Vishnu Nair6921f802017-11-22 09:17:23 -0800926 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
927 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -0800928 timeout_ms = logcat_timeout({"events"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800929 RunCommand(
930 "EVENT LOG",
931 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +0100932 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Yao Chenbe3bbc12018-01-17 16:31:10 -0800933 timeout_ms = logcat_timeout({"stats"});
934 RunCommand(
935 "STATS LOG",
936 {"logcat", "-b", "stats", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +0100937 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Hunter Knepshield820f9bc2020-02-05 20:10:53 -0800938 DoRadioLogcat();
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800939
940 RunCommand("LOG STATISTICS", {"logcat", "-b", "all", "-S"});
941
942 /* kernels must set CONFIG_PSTORE_PMSG, slice up pstore with device tree */
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800943 RunCommand("LAST LOGCAT", {"logcat", "-L", "-b", "all", "-v", "threadtime", "-v", "printable",
944 "-v", "uid", "-d", "*:v"});
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800945}
946
Mike Ma5c267872019-08-21 11:31:34 -0700947static void DumpIncidentReport() {
948 if (!ds.IsZipping()) {
949 MYLOGD("Not dumping incident report because it's not a zipped bugreport\n");
950 return;
951 }
952 DurationReporter duration_reporter("INCIDENT REPORT");
953 const std::string path = ds.bugreport_internal_dir_ + "/tmp_incident_report";
954 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
955 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
956 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
957 if (fd < 0) {
958 MYLOGE("Could not open %s to dump incident report.\n", path.c_str());
959 return;
960 }
961 RunCommandToFd(fd, "", {"incident", "-u"}, CommandOptions::WithTimeout(120).Build());
962 bool empty = 0 == lseek(fd, 0, SEEK_END);
963 if (!empty) {
964 // Use a different name from "incident.proto"
965 // /proto/incident.proto is reserved for incident service dump
966 // i.e. metadata for debugging.
967 ds.AddZipEntry(kProtoPath + "incident_report" + kProtoExt, path);
968 }
969 unlink(path.c_str());
970}
971
Sunny Goyal35949782019-11-19 15:54:36 -0800972static void DumpVisibleWindowViews() {
973 if (!ds.IsZipping()) {
974 MYLOGD("Not dumping visible views because it's not a zipped bugreport\n");
975 return;
976 }
977 DurationReporter duration_reporter("VISIBLE WINDOW VIEWS");
978 const std::string path = ds.bugreport_internal_dir_ + "/tmp_visible_window_views";
979 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
980 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
981 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
982 if (fd < 0) {
983 MYLOGE("Could not open %s to dump visible views.\n", path.c_str());
984 return;
985 }
986 RunCommandToFd(fd, "", {"cmd", "window", "dump-visible-window-views"},
987 CommandOptions::WithTimeout(120).Build());
988 bool empty = 0 == lseek(fd, 0, SEEK_END);
989 if (!empty) {
990 ds.AddZipEntry("visible_windows.zip", path);
991 } else {
992 MYLOGW("Failed to dump visible windows\n");
993 }
994 unlink(path.c_str());
995}
996
Jayachandran Ca94c7172017-06-10 15:08:12 -0700997static void DumpIpTablesAsRoot() {
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700998 RunCommand("IPTABLES", {"iptables", "-L", "-nvx"});
999 RunCommand("IP6TABLES", {"ip6tables", "-L", "-nvx"});
Erik Kline32af8c22016-09-28 17:26:26 +09001000 RunCommand("IPTABLES NAT", {"iptables", "-t", "nat", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001001 /* no ip6 nat */
Erik Kline32af8c22016-09-28 17:26:26 +09001002 RunCommand("IPTABLES MANGLE", {"iptables", "-t", "mangle", "-L", "-nvx"});
1003 RunCommand("IP6TABLES MANGLE", {"ip6tables", "-t", "mangle", "-L", "-nvx"});
1004 RunCommand("IPTABLES RAW", {"iptables", "-t", "raw", "-L", "-nvx"});
1005 RunCommand("IP6TABLES RAW", {"ip6tables", "-t", "raw", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001006}
1007
David Andersond9ba4752018-12-11 18:26:59 -08001008static void DumpDynamicPartitionInfo() {
1009 if (!::android::base::GetBoolProperty("ro.boot.dynamic_partitions", false)) {
1010 return;
1011 }
1012
1013 RunCommand("LPDUMP", {"lpdump", "--all"});
David Anderson6650ade2019-10-02 15:18:59 -07001014 RunCommand("DEVICE-MAPPER", {"gsid", "dump-device-mapper"});
David Andersond9ba4752018-12-11 18:26:59 -08001015}
1016
Narayan Kamath8f788292017-05-25 13:20:39 +01001017static void AddAnrTraceDir(const bool add_to_zip, const std::string& anr_traces_dir) {
1018 MYLOGD("AddAnrTraceDir(): dump_traces_file=%s, anr_traces_dir=%s\n", dump_traces_path,
1019 anr_traces_dir.c_str());
1020
1021 // If we're here, dump_traces_path will always be a temporary file
1022 // (created with mkostemp or similar) that contains dumps taken earlier
1023 // on in the process.
1024 if (dump_traces_path != nullptr) {
1025 if (add_to_zip) {
1026 ds.AddZipEntry(ZIP_ROOT_DIR + anr_traces_dir + "/traces-just-now.txt", dump_traces_path);
1027 } else {
1028 MYLOGD("Dumping current ANR traces (%s) to the main bugreport entry\n",
1029 dump_traces_path);
1030 ds.DumpFile("VM TRACES JUST NOW", dump_traces_path);
1031 }
1032
1033 const int ret = unlink(dump_traces_path);
1034 if (ret == -1) {
1035 MYLOGW("Error unlinking temporary trace path %s: %s\n", dump_traces_path,
1036 strerror(errno));
Felipe Lemee184f662016-10-27 10:04:47 -07001037 }
1038 }
1039
Narayan Kamathbd863722017-06-01 18:50:12 +01001040 // Add a specific message for the first ANR Dump.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001041 if (ds.anr_data_.size() > 0) {
1042 AddDumps(ds.anr_data_.begin(), ds.anr_data_.begin() + 1,
Narayan Kamathbd863722017-06-01 18:50:12 +01001043 "VM TRACES AT LAST ANR", add_to_zip);
1044
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001045 // The "last" ANR will always be included as separate entry in the zip file. In addition,
1046 // it will be present in the body of the main entry if |add_to_zip| == false.
1047 //
1048 // Historical ANRs are always included as separate entries in the bugreport zip file.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001049 AddDumps(ds.anr_data_.begin() + ((add_to_zip) ? 1 : 0), ds.anr_data_.end(),
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001050 "HISTORICAL ANR", true /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001051 } else {
Narayan Kamath8f788292017-05-25 13:20:39 +01001052 printf("*** NO ANRs to dump in %s\n\n", ANR_DIR.c_str());
1053 }
1054}
1055
1056static void AddAnrTraceFiles() {
1057 const bool add_to_zip = ds.IsZipping() && ds.version_ == VERSION_SPLIT_ANR;
1058
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001059 std::string anr_traces_dir = "/data/anr";
Narayan Kamath8f788292017-05-25 13:20:39 +01001060
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001061 AddAnrTraceDir(add_to_zip, anr_traces_dir);
Narayan Kamath8f788292017-05-25 13:20:39 +01001062
Makoto Onuki83ec63f2019-01-31 17:08:59 -08001063 RunCommand("ANR FILES", {"ls", "-lt", ANR_DIR});
1064
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001065 // Slow traces for slow operations.
Felipe Lemee184f662016-10-27 10:04:47 -07001066 struct stat st;
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001067 int i = 0;
1068 while (true) {
1069 const std::string slow_trace_path =
1070 anr_traces_dir + android::base::StringPrintf("slow%02d.txt", i);
1071 if (stat(slow_trace_path.c_str(), &st)) {
1072 // No traces file at this index, done with the files.
1073 break;
Felipe Lemee184f662016-10-27 10:04:47 -07001074 }
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001075 ds.DumpFile("VM TRACES WHEN SLOW", slow_trace_path.c_str());
1076 i++;
Felipe Lemee184f662016-10-27 10:04:47 -07001077 }
1078}
1079
Wei Wang509bb5d2017-06-09 14:42:12 -07001080static void DumpBlockStatFiles() {
1081 DurationReporter duration_reporter("DUMP BLOCK STAT");
Wei Wang509bb5d2017-06-09 14:42:12 -07001082
Wei Wang1dc1ef52017-06-12 11:28:37 -07001083 std::unique_ptr<DIR, std::function<int(DIR*)>> dirptr(opendir(BLK_DEV_SYS_DIR), closedir);
1084
1085 if (dirptr == nullptr) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001086 MYLOGE("Failed to open %s: %s\n", BLK_DEV_SYS_DIR, strerror(errno));
1087 return;
1088 }
1089
1090 printf("------ DUMP BLOCK STAT ------\n\n");
Wei Wang1dc1ef52017-06-12 11:28:37 -07001091 while (struct dirent *d = readdir(dirptr.get())) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001092 if ((d->d_name[0] == '.')
1093 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
1094 || (d->d_name[1] == '\0'))) {
1095 continue;
1096 }
1097 const std::string new_path =
1098 android::base::StringPrintf("%s/%s", BLK_DEV_SYS_DIR, d->d_name);
1099 printf("------ BLOCK STAT (%s) ------\n", new_path.c_str());
1100 dump_files("", new_path.c_str(), skip_not_stat, dump_stat_from_fd);
1101 printf("\n");
1102 }
Wei Wang1dc1ef52017-06-12 11:28:37 -07001103 return;
Wei Wang509bb5d2017-06-09 14:42:12 -07001104}
Jayachandran Ca94c7172017-06-10 15:08:12 -07001105
1106static void DumpPacketStats() {
1107 DumpFile("NETWORK DEV INFO", "/proc/net/dev");
1108 DumpFile("QTAGUID NETWORK INTERFACES INFO", "/proc/net/xt_qtaguid/iface_stat_all");
1109 DumpFile("QTAGUID NETWORK INTERFACES INFO (xt)", "/proc/net/xt_qtaguid/iface_stat_fmt");
1110 DumpFile("QTAGUID CTRL INFO", "/proc/net/xt_qtaguid/ctrl");
1111 DumpFile("QTAGUID STATS INFO", "/proc/net/xt_qtaguid/stats");
1112}
1113
1114static void DumpIpAddrAndRules() {
1115 /* The following have a tendency to get wedged when wifi drivers/fw goes belly-up. */
1116 RunCommand("NETWORK INTERFACES", {"ip", "link"});
1117 RunCommand("IPv4 ADDRESSES", {"ip", "-4", "addr", "show"});
1118 RunCommand("IPv6 ADDRESSES", {"ip", "-6", "addr", "show"});
1119 RunCommand("IP RULES", {"ip", "rule", "show"});
1120 RunCommand("IP RULES v6", {"ip", "-6", "rule", "show"});
1121}
1122
Nandana Dutt5c390032019-03-12 10:52:56 +00001123static Dumpstate::RunStatus RunDumpsysTextByPriority(const std::string& title, int priority,
1124 std::chrono::milliseconds timeout,
1125 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001126 auto start = std::chrono::steady_clock::now();
Vishnu Naire97d6122018-01-18 13:58:56 -08001127 sp<android::IServiceManager> sm = defaultServiceManager();
1128 Dumpsys dumpsys(sm.get());
Vishnu Naire97d6122018-01-18 13:58:56 -08001129 Vector<String16> args;
1130 Dumpsys::setServiceArgs(args, /* asProto = */ false, priority);
Vishnu Naire97d6122018-01-18 13:58:56 -08001131 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ false);
1132 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001133 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001134 std::string path(title);
1135 path.append(" - ").append(String8(service).c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -08001136 size_t bytes_written = 0;
Steven Moreland5a30d342019-10-08 13:53:28 -07001137 status_t status = dumpsys.startDumpThread(Dumpsys::Type::DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001138 if (status == OK) {
1139 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1140 std::chrono::duration<double> elapsed_seconds;
1141 status = dumpsys.writeDump(STDOUT_FILENO, service, service_timeout,
1142 /* as_proto = */ false, elapsed_seconds, bytes_written);
Vishnu Naire97d6122018-01-18 13:58:56 -08001143 dumpsys.writeDumpFooter(STDOUT_FILENO, service, elapsed_seconds);
1144 bool dump_complete = (status == OK);
1145 dumpsys.stopDumpThread(dump_complete);
1146 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001147
1148 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1149 std::chrono::steady_clock::now() - start);
1150 if (elapsed_duration > timeout) {
1151 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1152 elapsed_duration.count());
1153 break;
1154 }
1155 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001156 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001157}
1158
Vishnu Nair64afc022018-02-01 15:29:34 -08001159static void RunDumpsysText(const std::string& title, int priority,
1160 std::chrono::milliseconds timeout,
1161 std::chrono::milliseconds service_timeout) {
1162 DurationReporter duration_reporter(title);
1163 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1164 fsync(STDOUT_FILENO);
1165 RunDumpsysTextByPriority(title, priority, timeout, service_timeout);
1166}
1167
1168/* Dump all services registered with Normal or Default priority. */
Nandana Dutt5c390032019-03-12 10:52:56 +00001169static Dumpstate::RunStatus RunDumpsysTextNormalPriority(const std::string& title,
1170 std::chrono::milliseconds timeout,
1171 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001172 DurationReporter duration_reporter(title);
1173 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1174 fsync(STDOUT_FILENO);
1175 RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_NORMAL, timeout,
1176 service_timeout);
Nandana Dutt5c390032019-03-12 10:52:56 +00001177
1178 RETURN_IF_USER_DENIED_CONSENT();
1179
1180 return RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_DEFAULT, timeout,
1181 service_timeout);
Vishnu Nair64afc022018-02-01 15:29:34 -08001182}
1183
Nandana Dutt5c390032019-03-12 10:52:56 +00001184static Dumpstate::RunStatus RunDumpsysProto(const std::string& title, int priority,
1185 std::chrono::milliseconds timeout,
1186 std::chrono::milliseconds service_timeout) {
Luis Hector Chavez1e27b082018-03-22 15:36:42 -07001187 if (!ds.IsZipping()) {
1188 MYLOGD("Not dumping %s because it's not a zipped bugreport\n", title.c_str());
Nandana Dutt5c390032019-03-12 10:52:56 +00001189 return Dumpstate::RunStatus::OK;
Luis Hector Chavez1e27b082018-03-22 15:36:42 -07001190 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001191 sp<android::IServiceManager> sm = defaultServiceManager();
1192 Dumpsys dumpsys(sm.get());
1193 Vector<String16> args;
1194 Dumpsys::setServiceArgs(args, /* asProto = */ true, priority);
1195 DurationReporter duration_reporter(title);
1196
1197 auto start = std::chrono::steady_clock::now();
1198 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ true);
1199 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001200 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001201 std::string path(kProtoPath);
1202 path.append(String8(service).c_str());
1203 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL) {
1204 path.append("_CRITICAL");
1205 } else if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH) {
1206 path.append("_HIGH");
1207 }
1208 path.append(kProtoExt);
Steven Moreland5a30d342019-10-08 13:53:28 -07001209 status_t status = dumpsys.startDumpThread(Dumpsys::Type::DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001210 if (status == OK) {
1211 status = ds.AddZipEntryFromFd(path, dumpsys.getDumpFd(), service_timeout);
1212 bool dumpTerminated = (status == OK);
1213 dumpsys.stopDumpThread(dumpTerminated);
1214 }
1215 ZipWriter::FileEntry file_entry;
1216 ds.zip_writer_->GetLastEntry(&file_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -08001217
1218 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1219 std::chrono::steady_clock::now() - start);
1220 if (elapsed_duration > timeout) {
1221 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1222 elapsed_duration.count());
1223 break;
1224 }
1225 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001226 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001227}
1228
Nandana Dutta7db6342018-11-21 14:53:34 +00001229// Runs dumpsys on services that must dump first and will take less than 100ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001230static Dumpstate::RunStatus RunDumpsysCritical() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001231 RunDumpsysText("DUMPSYS CRITICAL", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1232 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Nandana Dutt5c390032019-03-12 10:52:56 +00001233
1234 RETURN_IF_USER_DENIED_CONSENT();
1235
1236 return RunDumpsysProto("DUMPSYS CRITICAL PROTO", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1237 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Vishnu Nair780b1282017-10-10 13:57:24 -07001238}
1239
1240// Runs dumpsys on services that must dump first but can take up to 250ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001241static Dumpstate::RunStatus RunDumpsysHigh() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001242 // TODO meminfo takes ~10s, connectivity takes ~5sec to dump. They are both
1243 // high priority. Reduce timeout once they are able to dump in a shorter time or
1244 // moved to a parallel task.
1245 RunDumpsysText("DUMPSYS HIGH", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1246 /* timeout= */ 90s, /* service_timeout= */ 30s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001247
1248 RETURN_IF_USER_DENIED_CONSENT();
1249
1250 return RunDumpsysProto("DUMPSYS HIGH PROTO", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1251 /* timeout= */ 5s, /* service_timeout= */ 1s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001252}
1253
1254// Runs dumpsys on services that must dump but can take up to 10s to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001255static Dumpstate::RunStatus RunDumpsysNormal() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001256 RunDumpsysTextNormalPriority("DUMPSYS", /* timeout= */ 90s, /* service_timeout= */ 10s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001257
1258 RETURN_IF_USER_DENIED_CONSENT();
1259
1260 return RunDumpsysProto("DUMPSYS PROTO", IServiceManager::DUMP_FLAG_PRIORITY_NORMAL,
1261 /* timeout= */ 90s, /* service_timeout= */ 10s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001262}
1263
Steven Moreland44cd9482018-01-04 16:24:13 -08001264static void DumpHals() {
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001265 if (!ds.IsZipping()) {
1266 RunCommand("HARDWARE HALS", {"lshal", "-lVSietrpc", "--types=b,c,l,z", "--debug"},
1267 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build());
1268 return;
1269 }
1270 DurationReporter duration_reporter("DUMP HALS");
1271 RunCommand("HARDWARE HALS", {"lshal", "-lVSietrpc", "--types=b,c,l,z"},
Greg Kaiser3dfeda32019-05-16 10:32:51 -07001272 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build());
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001273
Steven Moreland44cd9482018-01-04 16:24:13 -08001274 using android::hidl::manager::V1_0::IServiceManager;
1275 using android::hardware::defaultServiceManager;
1276
1277 sp<IServiceManager> sm = defaultServiceManager();
1278 if (sm == nullptr) {
1279 MYLOGE("Could not retrieve hwservicemanager to dump hals.\n");
1280 return;
1281 }
1282
1283 auto ret = sm->list([&](const auto& interfaces) {
1284 for (const std::string& interface : interfaces) {
1285 std::string cleanName = interface;
1286 std::replace_if(cleanName.begin(),
1287 cleanName.end(),
1288 [](char c) {
1289 return !isalnum(c) &&
1290 std::string("@-_:.").find(c) == std::string::npos;
1291 }, '_');
Nandana Dutt979388e2018-11-30 16:48:55 +00001292 const std::string path = ds.bugreport_internal_dir_ + "/lshal_debug_" + cleanName;
Steven Moreland44cd9482018-01-04 16:24:13 -08001293
1294 {
1295 auto fd = android::base::unique_fd(
1296 TEMP_FAILURE_RETRY(open(path.c_str(),
1297 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1298 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1299 if (fd < 0) {
1300 MYLOGE("Could not open %s to dump additional hal information.\n", path.c_str());
1301 continue;
1302 }
1303 RunCommandToFd(fd,
1304 "",
Steven Morelandc81cd3c2018-01-18 14:36:26 -08001305 {"lshal", "debug", "-E", interface},
Steven Moreland44cd9482018-01-04 16:24:13 -08001306 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
1307
1308 bool empty = 0 == lseek(fd, 0, SEEK_END);
1309 if (!empty) {
1310 ds.AddZipEntry("lshal-debug/" + cleanName + ".txt", path);
1311 }
1312 }
1313
1314 unlink(path.c_str());
1315 }
1316 });
1317
1318 if (!ret.isOk()) {
1319 MYLOGE("Could not list hals from hwservicemanager.\n");
1320 }
1321}
1322
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001323static void DumpExternalFragmentationInfo() {
1324 struct stat st;
1325 if (stat("/proc/buddyinfo", &st) != 0) {
1326 MYLOGE("Unable to dump external fragmentation info\n");
1327 return;
1328 }
1329
1330 printf("------ EXTERNAL FRAGMENTATION INFO ------\n");
1331 std::ifstream ifs("/proc/buddyinfo");
1332 auto unusable_index_regex = std::regex{"Node\\s+([0-9]+),\\s+zone\\s+(\\S+)\\s+(.*)"};
1333 for (std::string line; std::getline(ifs, line);) {
1334 std::smatch match_results;
1335 if (std::regex_match(line, match_results, unusable_index_regex)) {
1336 std::stringstream free_pages(std::string{match_results[3]});
1337 std::vector<int> free_pages_per_order(std::istream_iterator<int>{free_pages},
1338 std::istream_iterator<int>());
1339
1340 int total_free_pages = 0;
1341 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1342 total_free_pages += (free_pages_per_order[i] * std::pow(2, i));
1343 }
1344
1345 printf("Node %s, zone %8s", match_results[1].str().c_str(),
1346 match_results[2].str().c_str());
1347
1348 int usable_free_pages = total_free_pages;
1349 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1350 auto unusable_index = (total_free_pages - usable_free_pages) /
1351 static_cast<double>(total_free_pages);
1352 printf(" %5.3f", unusable_index);
1353 usable_free_pages -= (free_pages_per_order[i] * std::pow(2, i));
1354 }
1355
1356 printf("\n");
1357 }
1358 }
1359 printf("\n");
1360}
1361
Nandana Dutt5c390032019-03-12 10:52:56 +00001362// Dumps various things. Returns early with status USER_CONSENT_DENIED if user denies consent
1363// via the consent they are shown. Ignores other errors that occur while running various
1364// commands. The consent checking is currently done around long running tasks, which happen to
1365// be distributed fairly evenly throughout the function.
1366static Dumpstate::RunStatus dumpstate() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001367 DurationReporter duration_reporter("DUMPSTATE");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001368
Nandana Dutt5c390032019-03-12 10:52:56 +00001369 // Dump various things. Note that anything that takes "long" (i.e. several seconds) should
1370 // check intermittently (if it's intrerruptable like a foreach on pids) and/or should be wrapped
1371 // in a consent check (via RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK).
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -07001372 dump_dev_files("TRUSTY VERSION", "/sys/bus/platform/drivers/trusty", "trusty_version");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001373 RunCommand("UPTIME", {"uptime"});
Wei Wang509bb5d2017-06-09 14:42:12 -07001374 DumpBlockStatFiles();
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001375 DumpFile("MEMORY INFO", "/proc/meminfo");
1376 RunCommand("CPU INFO", {"top", "-b", "-n", "1", "-H", "-s", "6", "-o",
Felipe Leme30dbfa12016-09-02 12:43:26 -07001377 "pid,tid,user,pr,ni,%cpu,s,virt,res,pcy,cmd,name"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001378
1379 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "PROCRANK", {"procrank"}, AS_ROOT_20);
1380
Sunny Goyal35949782019-11-19 15:54:36 -08001381 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpVisibleWindowViews);
1382
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001383 DumpFile("VIRTUAL MEMORY STATS", "/proc/vmstat");
1384 DumpFile("VMALLOC INFO", "/proc/vmallocinfo");
1385 DumpFile("SLAB INFO", "/proc/slabinfo");
1386 DumpFile("ZONEINFO", "/proc/zoneinfo");
1387 DumpFile("PAGETYPEINFO", "/proc/pagetypeinfo");
1388 DumpFile("BUDDYINFO", "/proc/buddyinfo");
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001389 DumpExternalFragmentationInfo();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001390
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001391 DumpFile("KERNEL WAKE SOURCES", "/d/wakeup_sources");
1392 DumpFile("KERNEL CPUFREQ", "/sys/devices/system/cpu/cpu0/cpufreq/stats/time_in_state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001393
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001394 RunCommand("PROCESSES AND THREADS",
Yohei Yukawa591a72d2017-10-05 21:36:35 -07001395 {"ps", "-A", "-T", "-Z", "-O", "pri,nice,rtprio,sched,pcy,time"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001396
1397 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "LIBRANK", {"librank"},
1398 CommandOptions::AS_ROOT);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001399
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001400 DumpHals();
Steven Moreland81b429e2017-01-31 19:50:46 -08001401
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001402 RunCommand("PRINTENV", {"printenv"});
Elliott Hughes21b7c8d2016-10-28 08:53:02 -07001403 RunCommand("NETSTAT", {"netstat", "-nW"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001404 struct stat s;
1405 if (stat("/proc/modules", &s) != 0) {
1406 MYLOGD("Skipping 'lsmod' because /proc/modules does not exist\n");
1407 } else {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001408 RunCommand("LSMOD", {"lsmod"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001409 }
Michal Karpinski4db754f2015-12-11 18:04:32 +00001410
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001411 if (__android_logger_property_get_bool(
1412 "ro.logd.kernel", BOOL_DEFAULT_TRUE | BOOL_DEFAULT_FLAG_ENG | BOOL_DEFAULT_FLAG_SVELTE)) {
1413 DoKernelLogcat();
1414 } else {
1415 do_dmesg();
1416 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001417
Felipe Lemef0292972016-11-22 13:57:05 -08001418 RunCommand("LIST OF OPEN FILES", {"lsof"}, CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001419
1420 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(for_each_pid, do_showmap, "SMAPS OF ALL PROCESSES");
1421
Jeff Brown1dc94e32014-09-11 14:15:27 -07001422 for_each_tid(show_wchan, "BLOCKED PROCESS WAIT-CHANNELS");
Mark Salyzyna297c322016-02-05 15:33:17 -08001423 for_each_pid(show_showtime, "PROCESS TIMES (pid cmd user system iowait+percentage)");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001424
Ajay Panicker2ff8e872017-04-27 14:04:32 -07001425 /* Dump Bluetooth HCI logs */
1426 ds.AddDir("/data/misc/bluetooth/logs", true);
Ajay Panickerd886ec42016-09-14 12:26:46 -07001427
Paul Chang0d2aad72020-02-13 20:04:03 +08001428 if (ds.options_->do_screenshot && !ds.do_early_screenshot_) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001429 MYLOGI("taking late screenshot\n");
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001430 ds.TakeScreenshot();
Jeff Sharkey5a930032013-03-19 15:05:19 -07001431 }
1432
Felipe Lemee184f662016-10-27 10:04:47 -07001433 AddAnrTraceFiles();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001434
Narayan Kamath8f788292017-05-25 13:20:39 +01001435 // NOTE: tombstones are always added as separate entries in the zip archive
1436 // and are not interspersed with the main report.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001437 const bool tombstones_dumped = AddDumps(ds.tombstone_data_.begin(), ds.tombstone_data_.end(),
Narayan Kamathbd863722017-06-01 18:50:12 +01001438 "TOMBSTONE", true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001439 if (!tombstones_dumped) {
1440 printf("*** NO TOMBSTONES to dump in %s\n\n", TOMBSTONE_DIR.c_str());
Christopher Ferris7dc7f322014-07-22 16:08:19 -07001441 }
1442
Jayachandran Ca94c7172017-06-10 15:08:12 -07001443 DumpPacketStats();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001444
Chenbo Feng276a3b62018-08-07 11:44:49 -07001445 RunDumpsys("EBPF MAP STATS", {"netd", "trafficcontroller"});
1446
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001447 DoKmsg();
Mark Salyzyn2262c162014-12-16 09:09:26 -08001448
Jayachandran Ca94c7172017-06-10 15:08:12 -07001449 DumpIpAddrAndRules();
Sreeram Ramachandran2b3bba32014-07-08 15:40:55 -07001450
1451 dump_route_tables();
1452
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001453 RunCommand("ARP CACHE", {"ip", "-4", "neigh", "show"});
1454 RunCommand("IPv6 ND CACHE", {"ip", "-6", "neigh", "show"});
1455 RunCommand("MULTICAST ADDRESSES", {"ip", "maddr"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001456
Nandana Dutt5c390032019-03-12 10:52:56 +00001457 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysHigh);
Lorenzo Colitti6afc38c2015-09-09 22:59:25 +09001458
Elliott Hughes23ccc622017-02-28 10:14:22 -08001459 RunCommand("SYSTEM PROPERTIES", {"getprop"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001460
Jin Qianf334d662017-10-10 14:41:37 -07001461 RunCommand("STORAGED IO INFO", {"storaged", "-u", "-p"});
ynwangf649a6e2016-07-17 21:56:00 -07001462
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001463 RunCommand("FILESYSTEMS & FREE SPACE", {"df"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001464
Colin Crossf45fa6b2012-03-26 12:38:26 -07001465 /* Binder state is expensive to look at as it uses a lot of memory. */
Hridya Valsaraju920ba712020-02-09 16:27:01 -08001466 std::string binder_logs_dir = access("/dev/binderfs/binder_logs", R_OK) ?
1467 "/sys/kernel/debug/binder" : "/dev/binderfs/binder_logs";
1468
1469 DumpFile("BINDER FAILED TRANSACTION LOG", binder_logs_dir + "/failed_transaction_log");
1470 DumpFile("BINDER TRANSACTION LOG", binder_logs_dir + "/transaction_log");
1471 DumpFile("BINDER TRANSACTIONS", binder_logs_dir + "/transactions");
1472 DumpFile("BINDER STATS", binder_logs_dir + "/stats");
1473 DumpFile("BINDER STATE", binder_logs_dir + "/state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001474
Vishnu Nair36b4cdb2017-11-17 10:27:05 -08001475 /* Add window and surface trace files. */
1476 if (!PropertiesHelper::IsUserBuild()) {
1477 ds.AddDir(WMTRACE_DATA_DIR, false);
1478 }
1479
Yifan Hongd90cc652020-02-08 16:52:02 -08001480 ds.AddDir(SNAPSHOTCTL_LOG_DIR, false);
1481
Nandana Dutt5c390032019-03-12 10:52:56 +00001482 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(ds.DumpstateBoard);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001483
Steven Moreland7440ddb2016-12-15 16:13:39 -08001484 /* Migrate the ril_dumpstate to a device specific dumpstate? */
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001485 int rilDumpstateTimeout = android::base::GetIntProperty("ril.dumpstate.timeout", 0);
1486 if (rilDumpstateTimeout > 0) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001487 // su does not exist on user builds, so try running without it.
1488 // This way any implementations of vril-dump that do not require
1489 // root can run on user builds.
1490 CommandOptions::CommandOptionsBuilder options =
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001491 CommandOptions::WithTimeout(rilDumpstateTimeout);
Felipe Lemef0292972016-11-22 13:57:05 -08001492 if (!PropertiesHelper::IsUserBuild()) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001493 options.AsRoot();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001494 }
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001495 RunCommand("DUMP VENDOR RIL LOGS", {"vril-dump"}, options.Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -07001496 }
1497
Felipe Lemed8b94e52016-12-08 10:21:44 -08001498 printf("========================================================\n");
1499 printf("== Android Framework Services\n");
1500 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001501
Nandana Dutt5c390032019-03-12 10:52:56 +00001502 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysNormal);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001503
Felipe Lemed8b94e52016-12-08 10:21:44 -08001504 printf("========================================================\n");
1505 printf("== Checkins\n");
1506 printf("========================================================\n");
Dianne Hackborn02bea972013-06-26 18:59:09 -07001507
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001508 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001509
1510 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsys, "CHECKIN MEMINFO", {"meminfo", "--checkin"});
1511
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001512 RunDumpsys("CHECKIN NETSTATS", {"netstats", "--checkin"});
1513 RunDumpsys("CHECKIN PROCSTATS", {"procstats", "-c"});
1514 RunDumpsys("CHECKIN USAGESTATS", {"usagestats", "-c"});
1515 RunDumpsys("CHECKIN PACKAGE", {"package", "--checkin"});
Dianne Hackborn02bea972013-06-26 18:59:09 -07001516
Felipe Lemed8b94e52016-12-08 10:21:44 -08001517 printf("========================================================\n");
1518 printf("== Running Application Activities\n");
1519 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001520
Makoto Onuki60780982018-04-16 15:34:00 -07001521 // The following dumpsys internally collects output from running apps, so it can take a long
1522 // time. So let's extend the timeout.
1523
1524 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
1525
1526 RunDumpsys("APP ACTIVITIES", {"activity", "-v", "all"}, DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001527
Felipe Lemed8b94e52016-12-08 10:21:44 -08001528 printf("========================================================\n");
Makoto Onuki60780982018-04-16 15:34:00 -07001529 printf("== Running Application Services (platform)\n");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001530 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001531
Vishnu Nairc6e6ea72018-07-02 14:20:06 -07001532 RunDumpsys("APP SERVICES PLATFORM", {"activity", "service", "all-platform-non-critical"},
Makoto Onuki60780982018-04-16 15:34:00 -07001533 DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001534
Felipe Lemed8b94e52016-12-08 10:21:44 -08001535 printf("========================================================\n");
Makoto Onuki60780982018-04-16 15:34:00 -07001536 printf("== Running Application Services (non-platform)\n");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001537 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001538
Makoto Onuki60780982018-04-16 15:34:00 -07001539 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1540 DUMPSYS_COMPONENTS_OPTIONS);
1541
1542 printf("========================================================\n");
1543 printf("== Running Application Providers (platform)\n");
1544 printf("========================================================\n");
1545
1546 RunDumpsys("APP PROVIDERS PLATFORM", {"activity", "provider", "all-platform"},
1547 DUMPSYS_COMPONENTS_OPTIONS);
1548
1549 printf("========================================================\n");
1550 printf("== Running Application Providers (non-platform)\n");
1551 printf("========================================================\n");
1552
1553 RunDumpsys("APP PROVIDERS NON-PLATFORM", {"activity", "provider", "all-non-platform"},
1554 DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001555
Adrian Roos8b397ab2017-04-04 16:35:44 -07001556 printf("========================================================\n");
1557 printf("== Dropbox crashes\n");
1558 printf("========================================================\n");
1559
1560 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1561 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1562
Felipe Lemed8b94e52016-12-08 10:21:44 -08001563 printf("========================================================\n");
1564 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1565 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1566 printf("========================================================\n");
1567 printf("== dumpstate: done (id %d)\n", ds.id_);
1568 printf("========================================================\n");
Bookatz38472142018-09-28 10:20:24 -07001569
1570 printf("========================================================\n");
1571 printf("== Obtaining statsd metadata\n");
1572 printf("========================================================\n");
1573 // This differs from the usual dumpsys stats, which is the stats report data.
1574 RunDumpsys("STATSDSTATS", {"stats", "--metadata"});
Mike Ma5c267872019-08-21 11:31:34 -07001575
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +09001576 // Add linker configuration directory
1577 ds.AddDir(LINKERCONFIG_DIR, true);
1578
Mike Ma5c267872019-08-21 11:31:34 -07001579 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpIncidentReport);
1580
Nandana Dutt5c390032019-03-12 10:52:56 +00001581 return Dumpstate::RunStatus::OK;
Colin Crossf45fa6b2012-03-26 12:38:26 -07001582}
1583
Nandana Dutt5c390032019-03-12 10:52:56 +00001584/*
1585 * Dumps state for the default case; drops root after it's no longer necessary.
1586 *
1587 * Returns RunStatus::OK if everything went fine.
1588 * Returns RunStatus::ERROR if there was an error.
1589 * Returns RunStatus::USER_DENIED_CONSENT if user explicitly denied consent to sharing the bugreport
1590 * with the caller.
1591 */
Jichao Lie89d9c12019-11-21 19:02:51 -08001592Dumpstate::RunStatus Dumpstate::DumpstateDefaultAfterCritical() {
Nandana Duttdb379fa2019-10-09 16:54:41 +01001593 // Capture first logcat early on; useful to take a snapshot before dumpstate logs take over the
1594 // buffer.
1595 DoLogcat();
1596 // Capture timestamp after first logcat to use in next logcat
1597 time_t logcat_ts = time(nullptr);
1598
Nandana Dutt4be45d12018-09-26 15:04:23 +01001599 /* collect stack traces from Dalvik and native processes (needs root) */
Nandana Duttcf419a72019-03-14 10:40:17 +00001600 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(ds.DumpTraces, &dump_traces_path);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001601
1602 /* Run some operations that require root. */
1603 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX, !ds.IsZipping());
1604 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX, !ds.IsZipping());
1605
1606 ds.AddDir(RECOVERY_DIR, true);
1607 ds.AddDir(RECOVERY_DATA_DIR, true);
1608 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
1609 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1610 if (!PropertiesHelper::IsUserBuild()) {
1611 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1612 ds.AddDir(PROFILE_DATA_DIR_REF, true);
1613 }
Jerry Changa1df8a92020-01-02 16:03:39 +08001614 ds.AddDir(PREREBOOT_DATA_DIR, false);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001615 add_mountinfo();
1616 DumpIpTablesAsRoot();
David Andersond9ba4752018-12-11 18:26:59 -08001617 DumpDynamicPartitionInfo();
Yifan Hong3945e1b2019-10-29 12:59:23 -07001618 ds.AddDir(OTA_METADATA_DIR, true);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001619
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001620 // Capture any IPSec policies in play. No keys are exposed here.
Nandana Dutt4be45d12018-09-26 15:04:23 +01001621 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1622
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001623 // Dump IPsec stats. No keys are exposed here.
1624 DumpFile("XFRM STATS", XFRM_STAT_PROC_FILE);
1625
Nandana Dutt4be45d12018-09-26 15:04:23 +01001626 // Run ss as root so we can see socket marks.
1627 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
1628
1629 // Run iotop as root to show top 100 IO threads
1630 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
1631
Erick Reyese68df822019-02-11 14:46:36 -08001632 // Gather shared memory buffer info if the product implements it
1633 struct stat st;
1634 if (!stat("/product/bin/dmabuf_dump", &st)) {
1635 RunCommand("Dmabuf dump", {"/product/bin/dmabuf_dump"});
1636 }
1637
Minchan Kim22c6a1e2019-09-30 15:58:10 -07001638 DumpFile("PSI cpu", "/proc/pressure/cpu");
1639 DumpFile("PSI memory", "/proc/pressure/memory");
1640 DumpFile("PSI io", "/proc/pressure/io");
1641
Nandana Dutt4be45d12018-09-26 15:04:23 +01001642 if (!DropRootUser()) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001643 return Dumpstate::RunStatus::ERROR;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001644 }
1645
Nandana Dutt5c390032019-03-12 10:52:56 +00001646 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttdb379fa2019-10-09 16:54:41 +01001647 Dumpstate::RunStatus status = dumpstate();
1648 // Capture logcat since the last time we did it.
1649 DoSystemLogcat(logcat_ts);
1650 return status;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001651}
1652
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001653// This method collects common dumpsys for telephony and wifi. Typically, wifi
1654// reports are fine to include all information, but telephony reports on user
1655// builds need to strip some content (see DumpstateTelephonyOnly).
1656static void DumpstateRadioCommon(bool include_sensitive_info = true) {
Jayachandran Ca94c7172017-06-10 15:08:12 -07001657 DumpIpTablesAsRoot();
1658
Jayachandran Cb4389d92019-07-08 09:46:05 -07001659 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1660
Jayachandran Ca94c7172017-06-10 15:08:12 -07001661 if (!DropRootUser()) {
1662 return;
1663 }
1664
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001665 // We need to be picky about some stuff for telephony reports on user builds.
1666 if (!include_sensitive_info) {
1667 // Only dump the radio log buffer (other buffers and dumps contain too much unrelated info).
1668 DoRadioLogcat();
1669 } else {
1670 // Contains various system properties and process startup info.
1671 do_dmesg();
1672 // Logs other than the radio buffer may contain package/component names and potential PII.
1673 DoLogcat();
1674 // Too broad for connectivity problems.
1675 DoKmsg();
1676 // Contains unrelated hardware info (camera, NFC, biometrics, ...).
1677 DumpHals();
1678 }
1679
Jayachandran Ca94c7172017-06-10 15:08:12 -07001680 DumpPacketStats();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001681 DumpIpAddrAndRules();
1682 dump_route_tables();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001683 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
1684 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08001685}
1686
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001687// We use "telephony" here for legacy reasons, though this now really means "connectivity" (cellular
1688// + wifi + networking). This method collects dumpsys for connectivity debugging only. General rules
1689// for what can be included on user builds: all reported information MUST directly relate to
1690// connectivity debugging or customer support and MUST NOT contain unrelated personally identifiable
1691// information. This information MUST NOT identify user-installed packages (UIDs are OK, package
1692// names are not), and MUST NOT contain logs of user application traffic.
1693// TODO(b/148168577) rename this and other related fields/methods to "connectivity" instead.
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08001694static void DumpstateTelephonyOnly(const std::string& calling_package) {
mukesh agrawal253dad42018-01-23 21:59:59 -08001695 DurationReporter duration_reporter("DUMPSTATE");
Jichao Lie89d9c12019-11-21 19:02:51 -08001696
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001697 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08001698
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001699 const bool include_sensitive_info = !PropertiesHelper::IsUserBuild();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001700
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001701 DumpstateRadioCommon(include_sensitive_info);
1702
1703 if (include_sensitive_info) {
1704 // Contains too much unrelated PII, and given the unstructured nature of sysprops, we can't
1705 // really cherrypick all of the connectivity-related ones. Apps generally have no business
1706 // reading these anyway, and there should be APIs to supply the info in a more app-friendly
1707 // way.
1708 RunCommand("SYSTEM PROPERTIES", {"getprop"});
1709 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07001710
1711 printf("========================================================\n");
1712 printf("== Android Framework Services\n");
1713 printf("========================================================\n");
1714
Vishnu Nair652cc802017-11-30 15:18:30 -08001715 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1716 SEC_TO_MSEC(10));
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08001717 if (include_sensitive_info) {
1718 // Carrier apps' services will be dumped below in dumpsys activity service all-non-platform.
1719 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
1720 SEC_TO_MSEC(10));
1721 } else {
1722 // If the caller is a carrier app and has a carrier service, dump it here since we aren't
1723 // running dumpsys activity service all-non-platform below. Due to the increased output, we
1724 // give a higher timeout as well.
1725 RunDumpsys("DUMPSYS", {"carrier_config", "--requesting-package", calling_package},
1726 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(30));
1727 }
1728 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001729 RunDumpsys("DUMPSYS", {"netpolicy"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
1730 RunDumpsys("DUMPSYS", {"network_management"}, CommandOptions::WithTimeout(90).Build(),
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07001731 SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001732 if (include_sensitive_info) {
1733 // Contains raw IP addresses, omit from reports on user builds.
1734 RunDumpsys("DUMPSYS", {"netd"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
1735 // Contains raw destination IP/MAC addresses, omit from reports on user builds.
1736 RunDumpsys("DUMPSYS", {"connmetrics"}, CommandOptions::WithTimeout(90).Build(),
1737 SEC_TO_MSEC(10));
1738 // Contains package/component names, omit from reports on user builds.
1739 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
1740 SEC_TO_MSEC(10));
1741 // Contains package names, but should be relatively simple to remove them (also contains
1742 // UIDs already), omit from reports on user builds.
1743 RunDumpsys("BATTERYSTATS", {"deviceidle"}, CommandOptions::WithTimeout(90).Build(),
1744 SEC_TO_MSEC(10));
1745 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07001746
1747 printf("========================================================\n");
1748 printf("== Running Application Services\n");
1749 printf("========================================================\n");
1750
1751 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
1752
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001753 if (include_sensitive_info) {
1754 printf("========================================================\n");
1755 printf("== Running Application Services (non-platform)\n");
1756 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001757
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001758 // Contains package/component names and potential PII, omit from reports on user builds.
1759 // To get dumps of the active CarrierService(s) on user builds, we supply an argument to the
1760 // carrier_config dumpsys instead.
1761 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1762 DUMPSYS_COMPONENTS_OPTIONS);
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001763
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001764 printf("========================================================\n");
1765 printf("== Checkins\n");
1766 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07001767
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001768 // Contains package/component names, omit from reports on user builds.
1769 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
1770 }
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07001771
1772 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07001773 printf("== dumpstate: done (id %d)\n", ds.id_);
1774 printf("========================================================\n");
1775}
1776
mukesh agrawal253dad42018-01-23 21:59:59 -08001777// This method collects dumpsys for wifi debugging only
1778static void DumpstateWifiOnly() {
1779 DurationReporter duration_reporter("DUMPSTATE");
1780
1781 DumpstateRadioCommon();
1782
1783 printf("========================================================\n");
1784 printf("== Android Framework Services\n");
1785 printf("========================================================\n");
1786
1787 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1788 SEC_TO_MSEC(10));
1789 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
1790 SEC_TO_MSEC(10));
1791
1792 printf("========================================================\n");
1793 printf("== dumpstate: done (id %d)\n", ds.id_);
1794 printf("========================================================\n");
1795}
1796
Nandana Duttcf419a72019-03-14 10:40:17 +00001797Dumpstate::RunStatus Dumpstate::DumpTraces(const char** path) {
Nandana Duttfaafd522019-03-11 09:23:09 +00001798 DurationReporter duration_reporter("DUMP TRACES");
1799
1800 const std::string temp_file_pattern = "/data/anr/dumptrace_XXXXXX";
1801 const size_t buf_size = temp_file_pattern.length() + 1;
1802 std::unique_ptr<char[]> file_name_buf(new char[buf_size]);
1803 memcpy(file_name_buf.get(), temp_file_pattern.c_str(), buf_size);
1804
1805 // Create a new, empty file to receive all trace dumps.
1806 //
1807 // TODO: This can be simplified once we remove support for the old style
1808 // dumps. We can have a file descriptor passed in to dump_traces instead
1809 // of creating a file, closing it and then reopening it again.
1810 android::base::unique_fd fd(mkostemp(file_name_buf.get(), O_APPEND | O_CLOEXEC));
1811 if (fd < 0) {
1812 MYLOGE("mkostemp on pattern %s: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001813 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001814 }
1815
1816 // Nobody should have access to this temporary file except dumpstate, but we
1817 // temporarily grant 'read' to 'others' here because this file is created
1818 // when tombstoned is still running as root, but dumped after dropping. This
1819 // can go away once support for old style dumping has.
1820 const int chmod_ret = fchmod(fd, 0666);
1821 if (chmod_ret < 0) {
1822 MYLOGE("fchmod on %s failed: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001823 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001824 }
1825
1826 std::unique_ptr<DIR, decltype(&closedir)> proc(opendir("/proc"), closedir);
1827 if (proc.get() == nullptr) {
1828 MYLOGE("opendir /proc failed: %s\n", strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001829 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001830 }
1831
1832 // Number of times process dumping has timed out. If we encounter too many
1833 // failures, we'll give up.
1834 int timeout_failures = 0;
1835 bool dalvik_found = false;
1836
1837 const std::set<int> hal_pids = get_interesting_hal_pids();
1838
1839 struct dirent* d;
1840 while ((d = readdir(proc.get()))) {
Nandana Duttcf419a72019-03-14 10:40:17 +00001841 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttfaafd522019-03-11 09:23:09 +00001842 int pid = atoi(d->d_name);
1843 if (pid <= 0) {
1844 continue;
1845 }
1846
1847 const std::string link_name = android::base::StringPrintf("/proc/%d/exe", pid);
1848 std::string exe;
1849 if (!android::base::Readlink(link_name, &exe)) {
1850 continue;
1851 }
1852
1853 bool is_java_process;
1854 if (exe == "/system/bin/app_process32" || exe == "/system/bin/app_process64") {
1855 // Don't bother dumping backtraces for the zygote.
1856 if (IsZygote(pid)) {
1857 continue;
1858 }
1859
1860 dalvik_found = true;
1861 is_java_process = true;
1862 } else if (should_dump_native_traces(exe.c_str()) || hal_pids.find(pid) != hal_pids.end()) {
1863 is_java_process = false;
1864 } else {
1865 // Probably a native process we don't care about, continue.
1866 continue;
1867 }
1868
1869 // If 3 backtrace dumps fail in a row, consider debuggerd dead.
1870 if (timeout_failures == 3) {
1871 dprintf(fd, "ERROR: Too many stack dump failures, exiting.\n");
1872 break;
1873 }
1874
1875 const uint64_t start = Nanotime();
1876 const int ret = dump_backtrace_to_file_timeout(
1877 pid, is_java_process ? kDebuggerdJavaBacktrace : kDebuggerdNativeBacktrace,
1878 is_java_process ? 5 : 20, fd);
1879
1880 if (ret == -1) {
1881 // For consistency, the header and footer to this message match those
1882 // dumped by debuggerd in the success case.
1883 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
1884 dprintf(fd, "Dump failed, likely due to a timeout.\n");
1885 dprintf(fd, "---- end %d ----", pid);
1886 timeout_failures++;
1887 continue;
1888 }
1889
1890 // We've successfully dumped stack traces, reset the failure count
1891 // and write a summary of the elapsed time to the file and continue with the
1892 // next process.
1893 timeout_failures = 0;
1894
1895 dprintf(fd, "[dump %s stack %d: %.3fs elapsed]\n", is_java_process ? "dalvik" : "native",
1896 pid, (float)(Nanotime() - start) / NANOS_PER_SEC);
1897 }
1898
1899 if (!dalvik_found) {
1900 MYLOGE("Warning: no Dalvik processes found to dump stacks\n");
1901 }
1902
Nandana Duttcf419a72019-03-14 10:40:17 +00001903 *path = file_name_buf.release();
1904 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001905}
1906
Felipe Leme6f674ae2016-11-18 17:10:33 -08001907void Dumpstate::DumpstateBoard() {
1908 DurationReporter duration_reporter("dumpstate_board()");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001909 printf("========================================================\n");
1910 printf("== Board\n");
1911 printf("========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001912
Felipe Leme6f674ae2016-11-18 17:10:33 -08001913 if (!IsZipping()) {
Steven Moreland7440ddb2016-12-15 16:13:39 -08001914 MYLOGD("Not dumping board info because it's not a zipped bugreport\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001915 return;
1916 }
1917
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001918 std::vector<std::string> paths;
1919 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07001920 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00001921 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
1922 kDumpstateBoardFiles[i].c_str()));
Nandana Dutt16d1aee2019-02-15 16:13:53 +00001923 remover.emplace_back(android::base::make_scope_guard(
1924 std::bind([](std::string path) { android::os::UnlinkAndLogOnError(path); }, paths[i])));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001925 }
Jie Song9fbfad02017-06-20 16:29:42 -07001926
Hunter Knepshield8540faf2020-02-04 19:47:20 -08001927 sp<IDumpstateDevice_1_0> dumpstate_device_1_0(IDumpstateDevice_1_0::getService());
1928 if (dumpstate_device_1_0 == nullptr) {
Wei Wang587eac92018-04-05 12:17:20 -07001929 MYLOGE("No IDumpstateDevice implementation\n");
1930 return;
1931 }
1932
1933 using ScopedNativeHandle =
1934 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
1935 ScopedNativeHandle handle(native_handle_create(static_cast<int>(paths.size()), 0),
1936 [](native_handle_t* handle) {
1937 native_handle_close(handle);
1938 native_handle_delete(handle);
1939 });
1940 if (handle == nullptr) {
1941 MYLOGE("Could not create native_handle\n");
1942 return;
1943 }
1944
Nandana Dutt5c390032019-03-12 10:52:56 +00001945 // TODO(128270426): Check for consent in between?
Wei Wang587eac92018-04-05 12:17:20 -07001946 for (size_t i = 0; i < paths.size(); i++) {
1947 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
1948
1949 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
1950 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1951 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1952 if (fd < 0) {
1953 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
1954 return;
1955 }
1956 handle.get()->data[i] = fd.release();
1957 }
1958
Hunter Knepshield8540faf2020-02-04 19:47:20 -08001959 // Given that bugreport is required to diagnose failures, it's better to set an arbitrary amount
1960 // of timeout for IDumpstateDevice than to block the rest of bugreport. In the timeout case, we
1961 // will kill the HAL and grab whatever it dumped in time.
1962 constexpr size_t timeout_sec = 30;
1963 // Prefer version 1.1 if available. New devices launching with R are no longer allowed to
1964 // implement just 1.0.
1965 const char* descriptor_to_kill;
1966 using DumpstateBoardTask = std::packaged_task<bool()>;
1967 DumpstateBoardTask dumpstate_board_task;
1968 sp<IDumpstateDevice_1_1> dumpstate_device_1_1(
1969 IDumpstateDevice_1_1::castFrom(dumpstate_device_1_0));
1970 if (dumpstate_device_1_1 != nullptr) {
1971 MYLOGI("Using IDumpstateDevice v1.1");
1972 descriptor_to_kill = IDumpstateDevice_1_1::descriptor;
1973 dumpstate_board_task = DumpstateBoardTask([this, dumpstate_device_1_1, &handle]() -> bool {
1974 ::android::hardware::Return<DumpstateStatus> status =
1975 dumpstate_device_1_1->dumpstateBoard_1_1(handle.get(), options_->dumpstate_hal_mode,
1976 SEC_TO_MSEC(timeout_sec));
1977 if (!status.isOk()) {
1978 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
1979 return false;
1980 } else if (status != DumpstateStatus::OK) {
1981 MYLOGE("dumpstateBoard failed with DumpstateStatus::%s\n", toString(status).c_str());
1982 return false;
1983 }
1984 return true;
1985 });
1986 } else {
1987 MYLOGI("Using IDumpstateDevice v1.0");
1988 descriptor_to_kill = IDumpstateDevice_1_0::descriptor;
1989 dumpstate_board_task = DumpstateBoardTask([dumpstate_device_1_0, &handle]() -> bool {
1990 ::android::hardware::Return<void> status =
1991 dumpstate_device_1_0->dumpstateBoard(handle.get());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001992 if (!status.isOk()) {
1993 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
Wei Wang587eac92018-04-05 12:17:20 -07001994 return false;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001995 }
Wei Wang587eac92018-04-05 12:17:20 -07001996 return true;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001997 });
Hunter Knepshield8540faf2020-02-04 19:47:20 -08001998 }
1999 auto result = dumpstate_board_task.get_future();
2000 std::thread(std::move(dumpstate_board_task)).detach();
Wei Wang587eac92018-04-05 12:17:20 -07002001
Wei Wang587eac92018-04-05 12:17:20 -07002002 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2003 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate vendor HAL\n", timeout_sec);
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002004 if (!android::base::SetProperty(
2005 "ctl.interface_restart",
2006 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
Wei Wang587eac92018-04-05 12:17:20 -07002007 MYLOGE("Couldn't restart dumpstate HAL\n");
2008 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002009 }
Wei Wang587eac92018-04-05 12:17:20 -07002010 // Wait some time for init to kill dumpstate vendor HAL
2011 constexpr size_t killing_timeout_sec = 10;
2012 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2013 MYLOGE("killing dumpstateBoard timed out after %zus, continue and "
2014 "there might be racing in content\n", killing_timeout_sec);
2015 }
2016
2017 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
2018 for (size_t i = 0; i < paths.size(); i++) {
2019 struct stat s;
2020 if (fstat(handle.get()->data[i], &s) == -1) {
2021 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(),
2022 strerror(errno));
2023 file_sizes[i] = -1;
2024 continue;
2025 }
2026 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002027 }
2028
2029 for (size_t i = 0; i < paths.size(); i++) {
2030 if (file_sizes[i] == -1) {
2031 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002032 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002033 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07002034 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002035 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002036 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002037 AddZipEntry(kDumpstateBoardFiles[i], paths[i]);
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002038 printf("*** See %s entry ***\n", kDumpstateBoardFiles[i].c_str());
Jie Song9fbfad02017-06-20 16:29:42 -07002039 }
Felipe Leme6f674ae2016-11-18 17:10:33 -08002040}
2041
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002042static void ShowUsage() {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002043 fprintf(stderr,
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01002044 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-d] [-p] "
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002045 "[-z] [-s] [-S] [-q] [-P] [-R] [-V version]\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002046 " -h: display this help message\n"
2047 " -b: play sound file instead of vibrate, at beginning of job\n"
2048 " -e: play sound file instead of vibrate, at end of job\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01002049 " -d: append date to filename\n"
2050 " -p: capture screenshot to filename.png\n"
2051 " -z: generate zipped file\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002052 " -s: write output to control socket (for init)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01002053 " -S: write file location to control socket (for init; requires -z)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002054 " -q: disable vibrate\n"
Abhijeet Kaure370d682019-10-01 16:49:30 +01002055 " -P: send broadcast when started and do progress updates\n"
2056 " -R: take bugreport in remote mode (requires -z and -d, shouldn't be used with -P)\n"
Nandana Dutt235864b2019-01-22 12:10:16 +00002057 " -w: start binder service and make it wait for a call to startBugreport\n"
Felipe Lemed071c682016-10-20 16:48:00 -07002058 " -v: prints the dumpstate header and exit\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002059}
2060
Wei Liuf87959e2016-08-26 14:51:42 -07002061static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07002062 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07002063}
2064
Felipe Leme1d486fe2016-10-14 18:06:47 -07002065bool Dumpstate::FinishZipFile() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07002066 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07002067 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07002068 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002069 // Final timestamp
2070 char date[80];
2071 time_t the_real_now_please_stand_up = time(nullptr);
2072 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002073 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07002074 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002075
Felipe Leme9a523ae2016-10-20 15:10:33 -07002076 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002077 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08002078 return false;
2079 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07002080 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002081 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08002082 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08002083 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08002084
Felipe Leme0f3fb202016-06-10 17:10:53 -07002085 // Add log file (which contains stderr output) to zip...
2086 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07002087 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07002088 MYLOGE("Failed to add dumpstate log to .zip file\n");
2089 return false;
2090 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002091 // TODO: Should truncate the existing file.
2092 // ... and re-open it for further logging.
Nandana Dutta344cb62019-02-22 15:12:35 +00002093 if (!redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()))) {
2094 return false;
2095 }
Felipe Leme0f3fb202016-06-10 17:10:53 -07002096 fprintf(stderr, "\n");
2097
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002098 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07002099 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002100 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002101 return false;
2102 }
2103
Felipe Leme1d486fe2016-10-14 18:06:47 -07002104 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
2105 ds.zip_file.reset(nullptr);
2106
Felipe Lemee9d2c542016-11-15 11:48:26 -08002107 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002108 android::os::UnlinkAndLogOnError(tmp_path_);
Felipe Lemec4eee562016-04-21 15:42:55 -07002109
Felipe Leme1e9edc62015-12-21 16:02:13 -08002110 return true;
2111}
Felipe Leme6e01fa62015-11-11 19:35:14 -08002112
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002113static void SendBroadcast(const std::string& action, const std::vector<std::string>& args) {
2114 // clang-format off
2115 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user", "0",
2116 "--receiver-foreground", "--receiver-include-background", "-a", action};
2117 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08002118
2119 am.insert(am.end(), args.begin(), args.end());
2120
Felipe Leme8d2410e2017-02-08 09:46:08 -08002121 RunCommand("", am,
2122 CommandOptions::WithTimeout(20)
2123 .Log("Sending broadcast: '%s'\n")
2124 .Always()
2125 .DropRoot()
2126 .RedirectStderr()
2127 .Build());
2128}
2129
Felipe Leme35b8cf12017-02-10 15:47:29 -08002130static void Vibrate(int duration_ms) {
2131 // clang-format off
Chris Fries0c3de872019-09-14 15:49:41 +00002132 RunCommand("", {"cmd", "vibrator", "vibrate", "-f", std::to_string(duration_ms), "dumpstate"},
Felipe Leme35b8cf12017-02-10 15:47:29 -08002133 CommandOptions::WithTimeout(10)
2134 .Log("Vibrate: '%s'\n")
2135 .Always()
2136 .Build());
2137 // clang-format on
2138}
2139
Nandana Dutt979388e2018-11-30 16:48:55 +00002140static void MaybeResolveSymlink(std::string* path) {
2141 std::string resolved_path;
2142 if (android::base::Readlink(*path, &resolved_path)) {
2143 *path = resolved_path;
2144 }
2145}
2146
Nandana Dutt4be45d12018-09-26 15:04:23 +01002147/*
2148 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
2149 * if we are writing zip files and adds the version file.
2150 */
2151static void PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002152 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
2153
Nandana Dutt4be45d12018-09-26 15:04:23 +01002154 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
2155 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002156 ds.base_name_ = StringPrintf("bugreport-%s-%s", device_name.c_str(), build_id.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002157 if (ds.options_->do_add_date) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002158 char date[80];
2159 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
2160 ds.name_ = date;
2161 } else {
2162 ds.name_ = "undated";
2163 }
2164
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002165 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002166 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002167 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002168 ds.base_name_ += "-wifi";
2169 }
2170
Paul Chang0d2aad72020-02-13 20:04:03 +08002171 if (ds.options_->do_screenshot) {
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002172 ds.screenshot_path_ = ds.GetPath(ds.CalledByApi() ? "-tmp.png" : ".png");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002173 }
2174 ds.tmp_path_ = ds.GetPath(".tmp");
2175 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
2176
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002177 std::string destination = ds.CalledByApi()
Nandana Dutt54dbd672019-01-11 12:58:05 +00002178 ? StringPrintf("[fd:%d]", ds.options_->bugreport_fd.get())
Nandana Dutt9a76d202019-01-21 15:56:48 +00002179 : ds.bugreport_internal_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01002180 MYLOGD(
Nandana Dutt235c6672019-11-14 15:22:32 +00002181 "Bugreport dir: [%s] "
2182 "Base name: [%s] "
2183 "Suffix: [%s] "
2184 "Log path: [%s] "
2185 "Temporary path: [%s] "
2186 "Screenshot path: [%s]\n",
Nandana Dutt9a76d202019-01-21 15:56:48 +00002187 destination.c_str(), ds.base_name_.c_str(), ds.name_.c_str(), ds.log_path_.c_str(),
2188 ds.tmp_path_.c_str(), ds.screenshot_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002189
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002190 if (ds.options_->do_zip_file) {
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002191 ds.path_ = ds.GetPath(ds.CalledByApi() ? "-tmp.zip" : ".zip");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002192 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
2193 create_parent_dirs(ds.path_.c_str());
2194 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
2195 if (ds.zip_file == nullptr) {
2196 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
2197 } else {
2198 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
2199 }
2200 ds.AddTextZipEntry("version.txt", ds.version_);
2201 }
2202}
2203
2204/*
Abhijeet Kaure370d682019-10-01 16:49:30 +01002205 * Finalizes writing to the file by zipping the tmp file to the final location,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002206 * printing zipped file status, etc.
2207 */
2208static void FinalizeFile() {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002209 bool do_text_file = true;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002210 if (ds.options_->do_zip_file) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002211 if (!ds.FinishZipFile()) {
2212 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
2213 do_text_file = true;
2214 } else {
2215 do_text_file = false;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002216 }
2217 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002218 if (ds.options_->use_control_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002219 if (do_text_file) {
2220 dprintf(ds.control_socket_fd_,
2221 "FAIL:could not create zip file, check %s "
2222 "for more details\n",
2223 ds.log_path_.c_str());
2224 } else {
2225 dprintf(ds.control_socket_fd_, "OK:%s\n", ds.path_.c_str());
2226 }
2227 }
2228}
2229
Nandana Dutt4be45d12018-09-26 15:04:23 +01002230
Nandana Dutt58d72e22018-11-16 10:30:48 +00002231static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2232 switch (mode) {
2233 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2234 return "BUGREPORT_FULL";
2235 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2236 return "BUGREPORT_INTERACTIVE";
2237 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2238 return "BUGREPORT_REMOTE";
2239 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2240 return "BUGREPORT_WEAR";
2241 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2242 return "BUGREPORT_TELEPHONY";
2243 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2244 return "BUGREPORT_WIFI";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002245 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2246 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002247 }
2248}
2249
Paul Changf59c2b72020-03-10 02:08:55 +08002250static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options,
2251 bool is_screenshot_requested) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002252 // Modify com.android.shell.BugreportProgressService#isDefaultScreenshotRequired as well for
2253 // default system screenshots.
Abhijeet Kaure370d682019-10-01 16:49:30 +01002254 options->bugreport_mode = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002255 switch (mode) {
2256 case Dumpstate::BugreportMode::BUGREPORT_FULL:
Paul Changf59c2b72020-03-10 02:08:55 +08002257 options->do_screenshot = is_screenshot_requested;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002258 options->dumpstate_hal_mode = DumpstateMode::FULL;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002259 break;
2260 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002261 // Currently, the dumpstate binder is only used by Shell to update progress.
2262 options->do_start_service = true;
2263 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002264 options->do_screenshot = is_screenshot_requested;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002265 options->dumpstate_hal_mode = DumpstateMode::INTERACTIVE;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002266 break;
2267 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002268 options->do_vibrate = false;
2269 options->is_remote_mode = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002270 options->do_screenshot = false;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002271 options->dumpstate_hal_mode = DumpstateMode::REMOTE;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002272 break;
2273 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002274 options->do_start_service = true;
2275 options->do_progress_updates = true;
2276 options->do_zip_file = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002277 options->do_screenshot = is_screenshot_requested;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002278 options->dumpstate_hal_mode = DumpstateMode::WEAR;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002279 break;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002280 // TODO(b/148168577) rename TELEPHONY everywhere to CONNECTIVITY.
Nandana Dutt58d72e22018-11-16 10:30:48 +00002281 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002282 options->telephony_only = true;
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002283 options->do_progress_updates = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002284 options->do_screenshot = false;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002285 options->dumpstate_hal_mode = DumpstateMode::CONNECTIVITY;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002286 break;
2287 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002288 options->wifi_only = true;
2289 options->do_zip_file = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002290 options->do_screenshot = false;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002291 options->dumpstate_hal_mode = DumpstateMode::WIFI;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002292 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002293 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2294 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002295 }
2296}
2297
Nandana Dutt58d72e22018-11-16 10:30:48 +00002298static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
Nandana Dutt235c6672019-11-14 15:22:32 +00002299 MYLOGI(
Paul Chang0d2aad72020-02-13 20:04:03 +08002300 "do_zip_file: %d do_vibrate: %d use_socket: %d use_control_socket: %d do_screenshot: %d "
Nandana Dutt235c6672019-11-14 15:22:32 +00002301 "is_remote_mode: %d show_header_only: %d do_start_service: %d telephony_only: %d "
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002302 "wifi_only: %d do_progress_updates: %d fd: %d bugreport_mode: %s dumpstate_hal_mode: %s "
2303 "args: %s\n",
Nandana Dutt235c6672019-11-14 15:22:32 +00002304 options.do_zip_file, options.do_vibrate, options.use_socket, options.use_control_socket,
Paul Chang0d2aad72020-02-13 20:04:03 +08002305 options.do_screenshot, options.is_remote_mode, options.show_header_only,
2306 options.do_start_service,
Nandana Dutt235c6672019-11-14 15:22:32 +00002307 options.telephony_only, options.wifi_only, options.do_progress_updates,
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002308 options.bugreport_fd.get(), options.bugreport_mode.c_str(),
2309 toString(options.dumpstate_hal_mode).c_str(), options.args.c_str());
Nandana Dutt58d72e22018-11-16 10:30:48 +00002310}
2311
Nandana Dutt54dbd672019-01-11 12:58:05 +00002312void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode,
2313 const android::base::unique_fd& bugreport_fd_in,
Paul Changf59c2b72020-03-10 02:08:55 +08002314 const android::base::unique_fd& screenshot_fd_in,
2315 bool is_screenshot_requested) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002316 // In the new API world, date is always added; output is always a zip file.
2317 // TODO(111441001): remove these options once they are obsolete.
2318 do_add_date = true;
2319 do_zip_file = true;
2320
Nandana Dutt54dbd672019-01-11 12:58:05 +00002321 // Duplicate the fds because the passed in fds don't outlive the binder transaction.
2322 bugreport_fd.reset(dup(bugreport_fd_in.get()));
2323 screenshot_fd.reset(dup(screenshot_fd_in.get()));
Nandana Dutt58d72e22018-11-16 10:30:48 +00002324
Paul Changf59c2b72020-03-10 02:08:55 +08002325 SetOptionsFromMode(bugreport_mode, this, is_screenshot_requested);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002326}
2327
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002328Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
2329 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002330 int c;
Nandana Dutt235864b2019-01-22 12:10:16 +00002331 while ((c = getopt(argc, argv, "dho:svqzpPBRSV:w")) != -1) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002332 switch (c) {
2333 // clang-format off
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002334 case 'd': do_add_date = true; break;
2335 case 'z': do_zip_file = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002336 case 's': use_socket = true; break;
2337 case 'S': use_control_socket = true; break;
2338 case 'v': show_header_only = true; break;
2339 case 'q': do_vibrate = false; break;
Paul Chang0d2aad72020-02-13 20:04:03 +08002340 case 'p': do_screenshot = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002341 case 'P': do_progress_updates = true; break;
2342 case 'R': is_remote_mode = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002343 case 'V': break; // compatibility no-op
Nandana Dutt235864b2019-01-22 12:10:16 +00002344 case 'w':
2345 // This was already processed
2346 break;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002347 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002348 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002349 break;
2350 default:
2351 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002352 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002353 break;
2354 // clang-format on
2355 }
2356 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08002357
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002358 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002359 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002360 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002361 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002362 }
2363 }
2364
2365 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
2366 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002367
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002368 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002369}
2370
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002371bool Dumpstate::DumpOptions::ValidateOptions() const {
Nandana Dutt54dbd672019-01-11 12:58:05 +00002372 if (bugreport_fd.get() != -1 && !do_zip_file) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002373 return false;
2374 }
2375
Abhijeet Kaure370d682019-10-01 16:49:30 +01002376 if ((do_zip_file || do_add_date || do_progress_updates) && !OutputToFile()) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002377 return false;
2378 }
2379
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002380 if (use_control_socket && !do_zip_file) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002381 return false;
2382 }
2383
Abhijeet Kaure370d682019-10-01 16:49:30 +01002384 if (is_remote_mode && (do_progress_updates || !do_zip_file || !do_add_date)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002385 return false;
2386 }
2387 return true;
2388}
2389
Nandana Dutt197661d2018-11-16 16:40:21 +00002390void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
2391 options_ = std::move(options);
2392}
2393
Nandana Duttd2f5f082019-01-18 17:13:52 +00002394Dumpstate::RunStatus Dumpstate::Run(int32_t calling_uid, const std::string& calling_package) {
2395 Dumpstate::RunStatus status = RunInternal(calling_uid, calling_package);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002396 if (listener_ != nullptr) {
2397 switch (status) {
2398 case Dumpstate::RunStatus::OK:
Nandana Duttcc4ead82019-01-23 08:29:23 +00002399 listener_->onFinished();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002400 break;
2401 case Dumpstate::RunStatus::HELP:
2402 break;
2403 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002404 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_INVALID_INPUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002405 break;
2406 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002407 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_RUNTIME_ERROR);
2408 break;
2409 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2410 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_DENIED_CONSENT);
2411 break;
2412 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
2413 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_CONSENT_TIMED_OUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002414 break;
2415 }
2416 }
2417 return status;
2418}
2419
Nandana Dutt979388e2018-11-30 16:48:55 +00002420/*
2421 * Dumps relevant information to a bugreport based on the given options.
2422 *
2423 * The bugreport can be dumped to a file or streamed to a socket.
2424 *
2425 * How dumping to file works:
2426 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
2427 * stderr is redirected a log file.
2428 *
2429 * The temporary bugreport is then populated via printfs, dumping contents of files and
2430 * output of commands to stdout.
2431 *
2432 * If zipping, the temporary bugreport file is added to the zip archive. Else it's renamed to final
2433 * text file.
2434 *
2435 * If zipping, a bunch of other files and dumps also get added to the zip archive. The log file also
2436 * gets added to the archive.
2437 *
Nandana Dutt9a76d202019-01-21 15:56:48 +00002438 * Bugreports are first generated in a local directory and later copied to the caller's fd if
2439 * supplied.
Nandana Dutt979388e2018-11-30 16:48:55 +00002440 */
Nandana Duttd2f5f082019-01-18 17:13:52 +00002441Dumpstate::RunStatus Dumpstate::RunInternal(int32_t calling_uid,
2442 const std::string& calling_package) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002443 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00002444 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002445 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002446 return RunStatus::INVALID_INPUT;
2447 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002448 /* set as high priority, and protect from OOM killer */
2449 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002450
Felipe Lemed071c682016-10-20 16:48:00 -07002451 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002452 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002453 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002454 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002455 } else {
2456 /* fallback to kernels <= 2.6.35 */
2457 oom_adj = fopen("/proc/self/oom_adj", "we");
2458 if (oom_adj) {
2459 fputs("-17", oom_adj);
2460 fclose(oom_adj);
2461 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002462 }
2463
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002464 if (version_ == VERSION_DEFAULT) {
2465 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00002466 }
2467
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002468 if (version_ != VERSION_CURRENT && version_ != VERSION_SPLIT_ANR) {
Vishnu Nair64afc022018-02-01 15:29:34 -08002469 MYLOGE("invalid version requested ('%s'); suppported values are: ('%s', '%s', '%s')\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002470 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str(),
Vishnu Nair64afc022018-02-01 15:29:34 -08002471 VERSION_SPLIT_ANR.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002472 return RunStatus::INVALID_INPUT;
Felipe Lemed071c682016-10-20 16:48:00 -07002473 }
2474
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002475 if (options_->show_header_only) {
2476 PrintHeader();
2477 return RunStatus::OK;
Felipe Lemed071c682016-10-20 16:48:00 -07002478 }
2479
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002480 MYLOGD("dumpstate calling_uid = %d ; calling package = %s \n",
2481 calling_uid, calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00002482
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002483 // Redirect output if needed
Nandana Dutt9a76d202019-01-21 15:56:48 +00002484 bool is_redirecting = options_->OutputToFile();
Felipe Leme7447d7c2016-11-03 18:12:22 -07002485
2486 // TODO: temporarily set progress until it's part of the Dumpstate constructor
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002487 std::string stats_path =
Nandana Dutt979388e2018-11-30 16:48:55 +00002488 is_redirecting
2489 ? android::base::StringPrintf("%s/dumpstate-stats.txt", bugreport_internal_dir_.c_str())
2490 : "";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002491 progress_.reset(new Progress(stats_path));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002492
Felipe Lemed071c682016-10-20 16:48:00 -07002493 /* gets the sequential id */
Felipe Leme7447d7c2016-11-03 18:12:22 -07002494 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002495 id_ = ++last_id;
Felipe Lemed071c682016-10-20 16:48:00 -07002496 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
2497
Sahana Raof35ed432019-07-12 10:47:52 +01002498 if (acquire_wake_lock(PARTIAL_WAKE_LOCK, WAKE_LOCK_NAME) < 0) {
2499 MYLOGE("Failed to acquire wake lock: %s\n", strerror(errno));
2500 } else {
2501 // Wake lock will be released automatically on process death
2502 MYLOGD("Wake lock acquired.\n");
2503 }
2504
Felipe Leme6ae5c4f2017-01-10 14:13:22 -08002505 register_sig_handler();
Felipe Lemed071c682016-10-20 16:48:00 -07002506
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002507 // TODO(b/111441001): maybe skip if already started?
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002508 if (options_->do_start_service) {
Felipe Leme75876a22016-10-27 16:31:27 -07002509 MYLOGI("Starting 'dumpstate' service\n");
2510 android::status_t ret;
2511 if ((ret = android::os::DumpstateService::Start()) != android::OK) {
2512 MYLOGE("Unable to start DumpstateService: %d\n", ret);
2513 }
2514 }
2515
Felipe Lemef0292972016-11-22 13:57:05 -08002516 if (PropertiesHelper::IsDryRun()) {
Felipe Lemed071c682016-10-20 16:48:00 -07002517 MYLOGI("Running on dry-run mode (to disable it, call 'setprop dumpstate.dry_run false')\n");
2518 }
2519
Nandana Dutt235c6672019-11-14 15:22:32 +00002520 MYLOGI("dumpstate info: id=%d, args='%s', bugreport_mode= %s bugreport format version: %s\n",
2521 id_, options_->args.c_str(), options_->bugreport_mode.c_str(), version_.c_str());
Felipe Leme809d74e2016-02-02 12:57:00 -08002522
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002523 do_early_screenshot_ = options_->do_progress_updates;
Felipe Lemee338bf62015-12-07 14:03:50 -08002524
Christopher Ferrised9354f2014-10-01 17:35:01 -07002525 // If we are going to use a socket, do it as early as possible
2526 // to avoid timeouts from bugreport.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002527 if (options_->use_socket) {
Nandana Dutta344cb62019-02-22 15:12:35 +00002528 if (!redirect_to_socket(stdout, "dumpstate")) {
2529 return ERROR;
2530 }
Christopher Ferrised9354f2014-10-01 17:35:01 -07002531 }
2532
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002533 if (options_->use_control_socket) {
Felipe Leme2628e9e2016-04-12 16:36:51 -07002534 MYLOGD("Opening control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002535 control_socket_fd_ = open_socket("dumpstate");
Nandana Dutta344cb62019-02-22 15:12:35 +00002536 if (control_socket_fd_ == -1) {
2537 return ERROR;
2538 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002539 options_->do_progress_updates = 1;
Felipe Leme2628e9e2016-04-12 16:36:51 -07002540 }
2541
Felipe Leme71bbfc52015-11-23 14:14:51 -08002542 if (is_redirecting) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002543 PrepareToWriteToFile();
Felipe Leme1e9edc62015-12-21 16:02:13 -08002544
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002545 if (options_->do_progress_updates) {
Abhijeet Kaure370d682019-10-01 16:49:30 +01002546 // clang-format off
2547 std::vector<std::string> am_args = {
2548 "--receiver-permission", "android.permission.DUMP",
2549 };
2550 // clang-format on
2551 // Send STARTED broadcast for apps that listen to bugreport generation events
2552 SendBroadcast("com.android.internal.intent.action.BUGREPORT_STARTED", am_args);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002553 if (options_->use_control_socket) {
2554 dprintf(control_socket_fd_, "BEGIN:%s\n", path_.c_str());
Felipe Lemeaabfcae2016-07-29 09:49:04 -07002555 }
Felipe Leme71bbfc52015-11-23 14:14:51 -08002556 }
2557 }
2558
Nick Kralevichf3599b32016-01-25 15:05:16 -08002559 /* read /proc/cmdline before dropping root */
2560 FILE *cmdline = fopen("/proc/cmdline", "re");
2561 if (cmdline) {
2562 fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
2563 fclose(cmdline);
2564 }
2565
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002566 if (options_->do_vibrate) {
Felipe Leme35b8cf12017-02-10 15:47:29 -08002567 Vibrate(150);
John Michelau1f794c42012-09-17 11:20:19 -05002568 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002569
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002570 if (options_->do_zip_file && zip_file != nullptr) {
2571 if (chown(path_.c_str(), AID_SHELL, AID_SHELL)) {
2572 MYLOGE("Unable to change ownership of zip file %s: %s\n", path_.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -07002573 strerror(errno));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002574 }
2575 }
2576
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002577 int dup_stdout_fd;
2578 int dup_stderr_fd;
Felipe Leme71bbfc52015-11-23 14:14:51 -08002579 if (is_redirecting) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002580 // Redirect stderr to log_path_ for debugging.
Vishnu Nair20cf5032018-01-05 13:15:49 -08002581 TEMP_FAILURE_RETRY(dup_stderr_fd = dup(fileno(stderr)));
Nandana Dutta344cb62019-02-22 15:12:35 +00002582 if (!redirect_to_file(stderr, const_cast<char*>(log_path_.c_str()))) {
2583 return ERROR;
2584 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002585 if (chown(log_path_.c_str(), AID_SHELL, AID_SHELL)) {
2586 MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n", log_path_.c_str(),
2587 strerror(errno));
Felipe Leme6fe9db62016-02-12 09:04:16 -08002588 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002589
2590 // Redirect stdout to tmp_path_. This is the main bugreport entry and will be
2591 // moved into zip file later, if zipping.
Vishnu Nair20cf5032018-01-05 13:15:49 -08002592 TEMP_FAILURE_RETRY(dup_stdout_fd = dup(fileno(stdout)));
Nandana Dutt979388e2018-11-30 16:48:55 +00002593 // TODO: why not write to a file instead of stdout to overcome this problem?
Felipe Leme6e01fa62015-11-11 19:35:14 -08002594 /* TODO: rather than generating a text file now and zipping it later,
2595 it would be more efficient to redirect stdout to the zip entry
2596 directly, but the libziparchive doesn't support that option yet. */
Nandana Dutta344cb62019-02-22 15:12:35 +00002597 if (!redirect_to_file(stdout, const_cast<char*>(tmp_path_.c_str()))) {
2598 return ERROR;
2599 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002600 if (chown(tmp_path_.c_str(), AID_SHELL, AID_SHELL)) {
Felipe Leme6fe9db62016-02-12 09:04:16 -08002601 MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002602 tmp_path_.c_str(), strerror(errno));
Felipe Leme6fe9db62016-02-12 09:04:16 -08002603 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002604 }
Felipe Lemed8b94e52016-12-08 10:21:44 -08002605
2606 // Don't buffer stdout
2607 setvbuf(stdout, nullptr, _IONBF, 0);
2608
Felipe Leme608385d2016-02-01 10:35:38 -08002609 // NOTE: there should be no stdout output until now, otherwise it would break the header.
2610 // In particular, DurationReport objects should be created passing 'title, NULL', so their
Felipe Lemecbce55d2016-02-08 09:53:18 -08002611 // duration is logged into MYLOG instead.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002612 PrintHeader();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002613
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002614 if (options_->telephony_only) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002615 MaybeTakeEarlyScreenshot();
Jichao Lie89d9c12019-11-21 19:02:51 -08002616 MaybeCheckUserConsent(calling_uid, calling_package);
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08002617 DumpstateTelephonyOnly(calling_package);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002618 DumpstateBoard();
2619 } else if (options_->wifi_only) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002620 MaybeTakeEarlyScreenshot();
Jichao Lie89d9c12019-11-21 19:02:51 -08002621 MaybeCheckUserConsent(calling_uid, calling_package);
mukesh agrawal253dad42018-01-23 21:59:59 -08002622 DumpstateWifiOnly();
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002623 } else {
Paul Chang0d2aad72020-02-13 20:04:03 +08002624 // Invoke critical dumpsys first to preserve system state, before doing anything else.
Jichao Lie89d9c12019-11-21 19:02:51 -08002625 RunDumpsysCritical();
2626
Paul Chang0d2aad72020-02-13 20:04:03 +08002627 // Take screenshot and get consent only after critical dumpsys has finished.
2628 MaybeTakeEarlyScreenshot();
Jichao Lie89d9c12019-11-21 19:02:51 -08002629 MaybeCheckUserConsent(calling_uid, calling_package);
2630
Nandana Dutt4be45d12018-09-26 15:04:23 +01002631 // Dump state for the default case. This also drops root.
Jichao Lie89d9c12019-11-21 19:02:51 -08002632 RunStatus s = DumpstateDefaultAfterCritical();
Nandana Dutt5c390032019-03-12 10:52:56 +00002633 if (s != RunStatus::OK) {
Nandana Duttaac6f582019-07-26 14:32:47 +01002634 if (s == RunStatus::USER_CONSENT_DENIED) {
Nandana Dutt5c390032019-03-12 10:52:56 +00002635 HandleUserConsentDenied();
2636 }
2637 return s;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002638 }
Zhengyin Qian068ecc72016-08-10 16:48:14 -07002639 }
Felipe Leme71a74ac2016-03-17 15:43:25 -07002640
Felipe Leme55b42a62015-11-10 17:39:08 -08002641 /* close output if needed */
Felipe Leme71bbfc52015-11-23 14:14:51 -08002642 if (is_redirecting) {
Vishnu Nair20cf5032018-01-05 13:15:49 -08002643 TEMP_FAILURE_RETRY(dup2(dup_stdout_fd, fileno(stdout)));
Colin Crossf45fa6b2012-03-26 12:38:26 -07002644 }
2645
Abhijeet Kaure370d682019-10-01 16:49:30 +01002646 // Zip the (now complete) .tmp file within the internal directory.
Nandana Dutt9a76d202019-01-21 15:56:48 +00002647 if (options_->OutputToFile()) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002648 FinalizeFile();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002649 }
2650
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002651 // Share the final file with the caller if the user has consented or Shell is the caller.
Nandana Duttd2f5f082019-01-18 17:13:52 +00002652 Dumpstate::RunStatus status = Dumpstate::RunStatus::OK;
Abhijeet Kaure370d682019-10-01 16:49:30 +01002653 if (CalledByApi()) {
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002654 status = CopyBugreportIfUserConsented(calling_uid);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002655 if (status != Dumpstate::RunStatus::OK &&
2656 status != Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2657 // Do an early return if there were errors. We make an exception for consent
2658 // timing out because it's possible the user got distracted. In this case the
2659 // bugreport is not shared but made available for manual retrieval.
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002660 MYLOGI("User denied consent. Returning\n");
Nandana Duttd2f5f082019-01-18 17:13:52 +00002661 return status;
2662 }
Paul Chang0d2aad72020-02-13 20:04:03 +08002663 if (options_->do_screenshot &&
2664 options_->screenshot_fd.get() != -1 &&
2665 !options_->is_screenshot_copied) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00002666 bool copy_succeeded = android::os::CopyFileToFd(screenshot_path_,
2667 options_->screenshot_fd.get());
2668 if (copy_succeeded) {
2669 android::os::UnlinkAndLogOnError(screenshot_path_);
2670 }
2671 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002672 if (status == Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2673 MYLOGI(
2674 "Did not receive user consent yet."
2675 " Will not copy the bugreport artifacts to caller.\n");
Abhijeet Kaur57627412019-04-17 16:00:09 +01002676 const String16 incidentcompanion("incidentcompanion");
2677 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
2678 if (ics != nullptr) {
2679 MYLOGD("Canceling user consent request via incidentcompanion service\n");
2680 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
2681 consent_callback_.get());
2682 } else {
2683 MYLOGD("Unable to cancel user consent; incidentcompanion service unavailable\n");
2684 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002685 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00002686 }
2687
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002688 /* vibrate a few but shortly times to let user know it's finished */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002689 if (options_->do_vibrate) {
Takuya Ogawa47f644e2017-12-20 18:09:09 +09002690 for (int i = 0; i < 3; i++) {
2691 Vibrate(75);
2692 usleep((75 + 50) * 1000);
2693 }
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002694 }
2695
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002696 MYLOGD("Final progress: %d/%d (estimated %d)\n", progress_->Get(), progress_->GetMax(),
2697 progress_->GetInitialMax());
2698 progress_->Save();
2699 MYLOGI("done (id %d)\n", id_);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002700
Felipe Leme107a05f2016-03-08 15:11:15 -08002701 if (is_redirecting) {
Vishnu Nair20cf5032018-01-05 13:15:49 -08002702 TEMP_FAILURE_RETRY(dup2(dup_stderr_fd, fileno(stderr)));
Felipe Leme107a05f2016-03-08 15:11:15 -08002703 }
2704
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002705 if (options_->use_control_socket && control_socket_fd_ != -1) {
Felipe Lemee844a9d2016-09-21 15:01:39 -07002706 MYLOGD("Closing control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002707 close(control_socket_fd_);
Felipe Leme2628e9e2016-04-12 16:36:51 -07002708 }
2709
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002710 tombstone_data_.clear();
2711 anr_data_.clear();
Narayan Kamath6b9516c2017-10-27 11:15:51 +01002712
Nandana Duttd2f5f082019-01-18 17:13:52 +00002713 return (consent_callback_ != nullptr &&
2714 consent_callback_->getResult() == UserConsentResult::UNAVAILABLE)
2715 ? USER_CONSENT_TIMED_OUT
2716 : RunStatus::OK;
2717}
2718
Paul Chang0d2aad72020-02-13 20:04:03 +08002719void Dumpstate::MaybeTakeEarlyScreenshot() {
2720 if (!options_->do_screenshot || !do_early_screenshot_) {
2721 return;
2722 }
2723
2724 TakeScreenshot();
2725}
2726
Jichao Lie89d9c12019-11-21 19:02:51 -08002727void Dumpstate::MaybeCheckUserConsent(int32_t calling_uid, const std::string& calling_package) {
2728 if (calling_uid == AID_SHELL || !CalledByApi()) {
2729 // No need to get consent for shell triggered dumpstates, or not through
2730 // bugreporting API (i.e. no fd to copy back).
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002731 return;
2732 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00002733 consent_callback_ = new ConsentCallback();
2734 const String16 incidentcompanion("incidentcompanion");
2735 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
Jichao Lie89d9c12019-11-21 19:02:51 -08002736 android::String16 package(calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00002737 if (ics != nullptr) {
2738 MYLOGD("Checking user consent via incidentcompanion service\n");
2739 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
Jichao Lie89d9c12019-11-21 19:02:51 -08002740 calling_uid, package, String16(), String16(),
Joe Onorato1c36d752019-03-17 18:26:43 -07002741 0x1 /* FLAG_CONFIRMATION_DIALOG */, consent_callback_.get());
Nandana Duttd2f5f082019-01-18 17:13:52 +00002742 } else {
2743 MYLOGD("Unable to check user consent; incidentcompanion service unavailable\n");
2744 }
2745}
2746
Nandana Dutt5c390032019-03-12 10:52:56 +00002747bool Dumpstate::IsUserConsentDenied() const {
2748 return ds.consent_callback_ != nullptr &&
2749 ds.consent_callback_->getResult() == UserConsentResult::DENIED;
2750}
2751
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002752bool Dumpstate::CalledByApi() const {
2753 return ds.options_->bugreport_fd.get() != -1 ? true : false;
2754}
2755
Nandana Duttd2f5f082019-01-18 17:13:52 +00002756void Dumpstate::CleanupFiles() {
2757 android::os::UnlinkAndLogOnError(tmp_path_);
2758 android::os::UnlinkAndLogOnError(screenshot_path_);
2759 android::os::UnlinkAndLogOnError(path_);
2760}
2761
2762Dumpstate::RunStatus Dumpstate::HandleUserConsentDenied() {
2763 MYLOGD("User denied consent; deleting files and returning\n");
2764 CleanupFiles();
2765 return USER_CONSENT_DENIED;
2766}
2767
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002768Dumpstate::RunStatus Dumpstate::CopyBugreportIfUserConsented(int32_t calling_uid) {
Nandana Duttd2f5f082019-01-18 17:13:52 +00002769 // If the caller has asked to copy the bugreport over to their directory, we need explicit
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002770 // user consent (unless the caller is Shell).
2771 UserConsentResult consent_result;
2772 if (calling_uid == AID_SHELL) {
2773 consent_result = UserConsentResult::APPROVED;
2774 } else {
2775 consent_result = consent_callback_->getResult();
2776 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00002777 if (consent_result == UserConsentResult::UNAVAILABLE) {
2778 // User has not responded yet.
2779 uint64_t elapsed_ms = consent_callback_->getElapsedTimeMs();
Hunter Knepshield70610fa2020-01-03 15:27:33 -08002780 // Telephony is a fast report type, particularly on user builds where information may be
2781 // more aggressively limited. To give the user time to read the consent dialog, increase the
2782 // timeout.
2783 uint64_t timeout_ms = options_->telephony_only ? TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS
2784 : USER_CONSENT_TIMEOUT_MS;
2785 if (elapsed_ms < timeout_ms) {
2786 uint delay_seconds = (timeout_ms - elapsed_ms) / 1000;
Nandana Duttd2f5f082019-01-18 17:13:52 +00002787 MYLOGD("Did not receive user consent yet; going to wait for %d seconds", delay_seconds);
2788 sleep(delay_seconds);
2789 }
2790 consent_result = consent_callback_->getResult();
2791 }
2792 if (consent_result == UserConsentResult::DENIED) {
2793 // User has explicitly denied sharing with the app. To be safe delete the
2794 // internal bugreport & tmp files.
2795 return HandleUserConsentDenied();
2796 }
2797 if (consent_result == UserConsentResult::APPROVED) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00002798 bool copy_succeeded = android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
2799 if (copy_succeeded) {
2800 android::os::UnlinkAndLogOnError(path_);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002801 }
2802 return copy_succeeded ? Dumpstate::RunStatus::OK : Dumpstate::RunStatus::ERROR;
2803 } else if (consent_result == UserConsentResult::UNAVAILABLE) {
2804 // consent_result is still UNAVAILABLE. The user has likely not responded yet.
2805 // Since we do not have user consent to share the bugreport it does not get
2806 // copied over to the calling app but remains in the internal directory from
2807 // where the user can manually pull it.
2808 return Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT;
2809 }
2810 // Unknown result; must be a programming error.
2811 MYLOGE("Unknown user consent result:%d\n", consent_result);
2812 return Dumpstate::RunStatus::ERROR;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002813}
2814
Nandana Duttf02564e2019-02-15 15:24:24 +00002815Dumpstate::RunStatus Dumpstate::ParseCommandlineAndRun(int argc, char* argv[]) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002816 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
2817 Dumpstate::RunStatus status = options->Initialize(argc, argv);
2818 if (status == Dumpstate::RunStatus::OK) {
Nandana Duttf02564e2019-02-15 15:24:24 +00002819 SetOptions(std::move(options));
Nandana Duttd2f5f082019-01-18 17:13:52 +00002820 // When directly running dumpstate binary, the output is not expected to be written
2821 // to any external file descriptor.
Nandana Duttf02564e2019-02-15 15:24:24 +00002822 assert(options_->bugreport_fd.get() == -1);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002823
2824 // calling_uid and calling_package are for user consent to share the bugreport with
2825 // an app; they are irrelvant here because bugreport is only written to a local
2826 // directory, and not shared.
Nandana Duttf02564e2019-02-15 15:24:24 +00002827 status = Run(-1 /* calling_uid */, "" /* calling_package */);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002828 }
Nandana Duttf02564e2019-02-15 15:24:24 +00002829 return status;
2830}
2831
2832/* Main entry point for dumpstate binary. */
2833int run_main(int argc, char* argv[]) {
2834 Dumpstate::RunStatus status = ds.ParseCommandlineAndRun(argc, argv);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002835
2836 switch (status) {
2837 case Dumpstate::RunStatus::OK:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002838 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002839 case Dumpstate::RunStatus::HELP:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002840 ShowUsage();
2841 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002842 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002843 fprintf(stderr, "Invalid combination of args\n");
2844 ShowUsage();
2845 exit(1);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002846 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002847 FALLTHROUGH_INTENDED;
2848 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2849 FALLTHROUGH_INTENDED;
2850 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002851 exit(2);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002852 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002853}
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002854
2855// TODO(111441001): Default DumpOptions to sensible values.
2856Dumpstate::Dumpstate(const std::string& version)
2857 : pid_(getpid()),
2858 options_(new Dumpstate::DumpOptions()),
Nandana Dutt402a8392019-06-14 14:25:13 +01002859 last_reported_percent_progress_(0),
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002860 version_(version),
2861 now_(time(nullptr)) {
2862}
2863
2864Dumpstate& Dumpstate::GetInstance() {
2865 static Dumpstate singleton_(android::base::GetProperty("dumpstate.version", VERSION_CURRENT));
2866 return singleton_;
2867}
2868
Nandana Dutt8d945c02019-08-14 13:30:07 +01002869DurationReporter::DurationReporter(const std::string& title, bool logcat_only, bool verbose)
2870 : title_(title), logcat_only_(logcat_only), verbose_(verbose) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002871 if (!title_.empty()) {
2872 started_ = Nanotime();
2873 }
2874}
2875
2876DurationReporter::~DurationReporter() {
2877 if (!title_.empty()) {
2878 float elapsed = (float)(Nanotime() - started_) / NANOS_PER_SEC;
chenqiwuaf8b2d92019-12-12 18:53:51 +08002879 if (elapsed >= .5f || verbose_) {
2880 MYLOGD("Duration of '%s': %.2fs\n", title_.c_str(), elapsed);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002881 }
chenqiwuaf8b2d92019-12-12 18:53:51 +08002882 if (!logcat_only_) {
2883 // Use "Yoda grammar" to make it easier to grep|sort sections.
2884 printf("------ %.3fs was the duration of '%s' ------\n", elapsed, title_.c_str());
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002885 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002886 }
2887}
2888
2889const int32_t Progress::kDefaultMax = 5000;
2890
2891Progress::Progress(const std::string& path) : Progress(Progress::kDefaultMax, 1.1, path) {
2892}
2893
2894Progress::Progress(int32_t initial_max, int32_t progress, float growth_factor)
2895 : Progress(initial_max, growth_factor, "") {
2896 progress_ = progress;
2897}
2898
2899Progress::Progress(int32_t initial_max, float growth_factor, const std::string& path)
2900 : initial_max_(initial_max),
2901 progress_(0),
2902 max_(initial_max),
2903 growth_factor_(growth_factor),
2904 n_runs_(0),
2905 average_max_(0),
2906 path_(path) {
2907 if (!path_.empty()) {
2908 Load();
2909 }
2910}
2911
2912void Progress::Load() {
2913 MYLOGD("Loading stats from %s\n", path_.c_str());
2914 std::string content;
2915 if (!android::base::ReadFileToString(path_, &content)) {
2916 MYLOGI("Could not read stats from %s; using max of %d\n", path_.c_str(), max_);
2917 return;
2918 }
2919 if (content.empty()) {
2920 MYLOGE("No stats (empty file) on %s; using max of %d\n", path_.c_str(), max_);
2921 return;
2922 }
2923 std::vector<std::string> lines = android::base::Split(content, "\n");
2924
2925 if (lines.size() < 1) {
2926 MYLOGE("Invalid stats on file %s: not enough lines (%d). Using max of %d\n", path_.c_str(),
2927 (int)lines.size(), max_);
2928 return;
2929 }
2930 char* ptr;
2931 n_runs_ = strtol(lines[0].c_str(), &ptr, 10);
2932 average_max_ = strtol(ptr, nullptr, 10);
2933 if (n_runs_ <= 0 || average_max_ <= 0 || n_runs_ > STATS_MAX_N_RUNS ||
2934 average_max_ > STATS_MAX_AVERAGE) {
2935 MYLOGE("Invalid stats line on file %s: %s\n", path_.c_str(), lines[0].c_str());
2936 initial_max_ = Progress::kDefaultMax;
2937 } else {
2938 initial_max_ = average_max_;
2939 }
2940 max_ = initial_max_;
2941
2942 MYLOGI("Average max progress: %d in %d runs; estimated max: %d\n", average_max_, n_runs_, max_);
2943}
2944
2945void Progress::Save() {
2946 int32_t total = n_runs_ * average_max_ + progress_;
2947 int32_t runs = n_runs_ + 1;
2948 int32_t average = floor(((float)total) / runs);
2949 MYLOGI("Saving stats (total=%d, runs=%d, average=%d) on %s\n", total, runs, average,
2950 path_.c_str());
2951 if (path_.empty()) {
2952 return;
2953 }
2954
2955 std::string content = android::base::StringPrintf("%d %d\n", runs, average);
2956 if (!android::base::WriteStringToFile(content, path_)) {
2957 MYLOGE("Could not save stats on %s\n", path_.c_str());
2958 }
2959}
2960
2961int32_t Progress::Get() const {
2962 return progress_;
2963}
2964
2965bool Progress::Inc(int32_t delta_sec) {
2966 bool changed = false;
2967 if (delta_sec >= 0) {
2968 progress_ += delta_sec;
2969 if (progress_ > max_) {
2970 int32_t old_max = max_;
2971 max_ = floor((float)progress_ * growth_factor_);
2972 MYLOGD("Adjusting max progress from %d to %d\n", old_max, max_);
2973 changed = true;
2974 }
2975 }
2976 return changed;
2977}
2978
2979int32_t Progress::GetMax() const {
2980 return max_;
2981}
2982
2983int32_t Progress::GetInitialMax() const {
2984 return initial_max_;
2985}
2986
2987void Progress::Dump(int fd, const std::string& prefix) const {
2988 const char* pr = prefix.c_str();
2989 dprintf(fd, "%sprogress: %d\n", pr, progress_);
2990 dprintf(fd, "%smax: %d\n", pr, max_);
2991 dprintf(fd, "%sinitial_max: %d\n", pr, initial_max_);
2992 dprintf(fd, "%sgrowth_factor: %0.2f\n", pr, growth_factor_);
2993 dprintf(fd, "%spath: %s\n", pr, path_.c_str());
2994 dprintf(fd, "%sn_runs: %d\n", pr, n_runs_);
2995 dprintf(fd, "%saverage_max: %d\n", pr, average_max_);
2996}
2997
2998bool Dumpstate::IsZipping() const {
2999 return zip_writer_ != nullptr;
3000}
3001
3002std::string Dumpstate::GetPath(const std::string& suffix) const {
3003 return GetPath(bugreport_internal_dir_, suffix);
3004}
3005
3006std::string Dumpstate::GetPath(const std::string& directory, const std::string& suffix) const {
3007 return android::base::StringPrintf("%s/%s-%s%s", directory.c_str(), base_name_.c_str(),
3008 name_.c_str(), suffix.c_str());
3009}
3010
3011void Dumpstate::SetProgress(std::unique_ptr<Progress> progress) {
3012 progress_ = std::move(progress);
3013}
3014
3015void for_each_userid(void (*func)(int), const char *header) {
3016 std::string title = header == nullptr ? "for_each_userid" : android::base::StringPrintf(
3017 "for_each_userid(%s)", header);
3018 DurationReporter duration_reporter(title);
3019 if (PropertiesHelper::IsDryRun()) return;
3020
3021 DIR *d;
3022 struct dirent *de;
3023
3024 if (header) printf("\n------ %s ------\n", header);
3025 func(0);
3026
3027 if (!(d = opendir("/data/system/users"))) {
3028 printf("Failed to open /data/system/users (%s)\n", strerror(errno));
3029 return;
3030 }
3031
3032 while ((de = readdir(d))) {
3033 int userid;
3034 if (de->d_type != DT_DIR || !(userid = atoi(de->d_name))) {
3035 continue;
3036 }
3037 func(userid);
3038 }
3039
3040 closedir(d);
3041}
3042
3043static void __for_each_pid(void (*helper)(int, const char *, void *), const char *header, void *arg) {
3044 DIR *d;
3045 struct dirent *de;
3046
3047 if (!(d = opendir("/proc"))) {
3048 printf("Failed to open /proc (%s)\n", strerror(errno));
3049 return;
3050 }
3051
3052 if (header) printf("\n------ %s ------\n", header);
3053 while ((de = readdir(d))) {
3054 if (ds.IsUserConsentDenied()) {
3055 MYLOGE(
3056 "Returning early because user denied consent to share bugreport with calling app.");
3057 closedir(d);
3058 return;
3059 }
3060 int pid;
3061 int fd;
3062 char cmdpath[255];
3063 char cmdline[255];
3064
3065 if (!(pid = atoi(de->d_name))) {
3066 continue;
3067 }
3068
3069 memset(cmdline, 0, sizeof(cmdline));
3070
3071 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/cmdline", pid);
3072 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3073 TEMP_FAILURE_RETRY(read(fd, cmdline, sizeof(cmdline) - 2));
3074 close(fd);
3075 if (cmdline[0]) {
3076 helper(pid, cmdline, arg);
3077 continue;
3078 }
3079 }
3080
3081 // if no cmdline, a kernel thread has comm
3082 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/comm", pid);
3083 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3084 TEMP_FAILURE_RETRY(read(fd, cmdline + 1, sizeof(cmdline) - 4));
3085 close(fd);
3086 if (cmdline[1]) {
3087 cmdline[0] = '[';
3088 size_t len = strcspn(cmdline, "\f\b\r\n");
3089 cmdline[len] = ']';
3090 cmdline[len+1] = '\0';
3091 }
3092 }
3093 if (!cmdline[0]) {
3094 strcpy(cmdline, "N/A");
3095 }
3096 helper(pid, cmdline, arg);
3097 }
3098
3099 closedir(d);
3100}
3101
3102static void for_each_pid_helper(int pid, const char *cmdline, void *arg) {
3103 for_each_pid_func *func = (for_each_pid_func*) arg;
3104 func(pid, cmdline);
3105}
3106
3107void for_each_pid(for_each_pid_func func, const char *header) {
3108 std::string title = header == nullptr ? "for_each_pid"
3109 : android::base::StringPrintf("for_each_pid(%s)", header);
3110 DurationReporter duration_reporter(title);
3111 if (PropertiesHelper::IsDryRun()) return;
3112
3113 __for_each_pid(for_each_pid_helper, header, (void *) func);
3114}
3115
3116static void for_each_tid_helper(int pid, const char *cmdline, void *arg) {
3117 DIR *d;
3118 struct dirent *de;
3119 char taskpath[255];
3120 for_each_tid_func *func = (for_each_tid_func *) arg;
3121
3122 snprintf(taskpath, sizeof(taskpath), "/proc/%d/task", pid);
3123
3124 if (!(d = opendir(taskpath))) {
3125 printf("Failed to open %s (%s)\n", taskpath, strerror(errno));
3126 return;
3127 }
3128
3129 func(pid, pid, cmdline);
3130
3131 while ((de = readdir(d))) {
3132 if (ds.IsUserConsentDenied()) {
3133 MYLOGE(
3134 "Returning early because user denied consent to share bugreport with calling app.");
3135 closedir(d);
3136 return;
3137 }
3138 int tid;
3139 int fd;
3140 char commpath[255];
3141 char comm[255];
3142
3143 if (!(tid = atoi(de->d_name))) {
3144 continue;
3145 }
3146
3147 if (tid == pid)
3148 continue;
3149
3150 snprintf(commpath, sizeof(commpath), "/proc/%d/comm", tid);
3151 memset(comm, 0, sizeof(comm));
3152 if ((fd = TEMP_FAILURE_RETRY(open(commpath, O_RDONLY | O_CLOEXEC))) < 0) {
3153 strcpy(comm, "N/A");
3154 } else {
3155 char *c;
3156 TEMP_FAILURE_RETRY(read(fd, comm, sizeof(comm) - 2));
3157 close(fd);
3158
3159 c = strrchr(comm, '\n');
3160 if (c) {
3161 *c = '\0';
3162 }
3163 }
3164 func(pid, tid, comm);
3165 }
3166
3167 closedir(d);
3168}
3169
3170void for_each_tid(for_each_tid_func func, const char *header) {
3171 std::string title = header == nullptr ? "for_each_tid"
3172 : android::base::StringPrintf("for_each_tid(%s)", header);
3173 DurationReporter duration_reporter(title);
3174
3175 if (PropertiesHelper::IsDryRun()) return;
3176
3177 __for_each_pid(for_each_tid_helper, header, (void *) func);
3178}
3179
3180void show_wchan(int pid, int tid, const char *name) {
3181 if (PropertiesHelper::IsDryRun()) return;
3182
3183 char path[255];
3184 char buffer[255];
3185 int fd, ret, save_errno;
3186 char name_buffer[255];
3187
3188 memset(buffer, 0, sizeof(buffer));
3189
3190 snprintf(path, sizeof(path), "/proc/%d/wchan", tid);
3191 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3192 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3193 return;
3194 }
3195
3196 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3197 save_errno = errno;
3198 close(fd);
3199
3200 if (ret < 0) {
3201 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3202 return;
3203 }
3204
3205 snprintf(name_buffer, sizeof(name_buffer), "%*s%s",
3206 pid == tid ? 0 : 3, "", name);
3207
3208 printf("%-7d %-32s %s\n", tid, name_buffer, buffer);
3209
3210 return;
3211}
3212
3213// print time in centiseconds
3214static void snprcent(char *buffer, size_t len, size_t spc,
3215 unsigned long long time) {
3216 static long hz; // cache discovered hz
3217
3218 if (hz <= 0) {
3219 hz = sysconf(_SC_CLK_TCK);
3220 if (hz <= 0) {
3221 hz = 1000;
3222 }
3223 }
3224
3225 // convert to centiseconds
3226 time = (time * 100 + (hz / 2)) / hz;
3227
3228 char str[16];
3229
3230 snprintf(str, sizeof(str), " %llu.%02u",
3231 time / 100, (unsigned)(time % 100));
3232 size_t offset = strlen(buffer);
3233 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3234 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3235}
3236
3237// print permille as a percent
3238static void snprdec(char *buffer, size_t len, size_t spc, unsigned permille) {
3239 char str[16];
3240
3241 snprintf(str, sizeof(str), " %u.%u%%", permille / 10, permille % 10);
3242 size_t offset = strlen(buffer);
3243 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3244 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3245}
3246
3247void show_showtime(int pid, const char *name) {
3248 if (PropertiesHelper::IsDryRun()) return;
3249
3250 char path[255];
3251 char buffer[1023];
3252 int fd, ret, save_errno;
3253
3254 memset(buffer, 0, sizeof(buffer));
3255
3256 snprintf(path, sizeof(path), "/proc/%d/stat", pid);
3257 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3258 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3259 return;
3260 }
3261
3262 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3263 save_errno = errno;
3264 close(fd);
3265
3266 if (ret < 0) {
3267 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3268 return;
3269 }
3270
3271 // field 14 is utime
3272 // field 15 is stime
3273 // field 42 is iotime
3274 unsigned long long utime = 0, stime = 0, iotime = 0;
3275 if (sscanf(buffer,
3276 "%*u %*s %*s %*d %*d %*d %*d %*d %*d %*d %*d "
3277 "%*d %*d %llu %llu %*d %*d %*d %*d %*d %*d "
3278 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %*d "
3279 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %llu ",
3280 &utime, &stime, &iotime) != 3) {
3281 return;
3282 }
3283
3284 unsigned long long total = utime + stime;
3285 if (!total) {
3286 return;
3287 }
3288
3289 unsigned permille = (iotime * 1000 + (total / 2)) / total;
3290 if (permille > 1000) {
3291 permille = 1000;
3292 }
3293
3294 // try to beautify and stabilize columns at <80 characters
3295 snprintf(buffer, sizeof(buffer), "%-6d%s", pid, name);
3296 if ((name[0] != '[') || utime) {
3297 snprcent(buffer, sizeof(buffer), 57, utime);
3298 }
3299 snprcent(buffer, sizeof(buffer), 65, stime);
3300 if ((name[0] != '[') || iotime) {
3301 snprcent(buffer, sizeof(buffer), 73, iotime);
3302 }
3303 if (iotime) {
3304 snprdec(buffer, sizeof(buffer), 79, permille);
3305 }
3306 puts(buffer); // adds a trailing newline
3307
3308 return;
3309}
3310
3311void do_dmesg() {
3312 const char *title = "KERNEL LOG (dmesg)";
3313 DurationReporter duration_reporter(title);
3314 printf("------ %s ------\n", title);
3315
3316 if (PropertiesHelper::IsDryRun()) return;
3317
3318 /* Get size of kernel buffer */
3319 int size = klogctl(KLOG_SIZE_BUFFER, nullptr, 0);
3320 if (size <= 0) {
3321 printf("Unexpected klogctl return value: %d\n\n", size);
3322 return;
3323 }
3324 char *buf = (char *) malloc(size + 1);
3325 if (buf == nullptr) {
3326 printf("memory allocation failed\n\n");
3327 return;
3328 }
3329 int retval = klogctl(KLOG_READ_ALL, buf, size);
3330 if (retval < 0) {
3331 printf("klogctl failure\n\n");
3332 free(buf);
3333 return;
3334 }
3335 buf[retval] = '\0';
3336 printf("%s\n\n", buf);
3337 free(buf);
3338 return;
3339}
3340
3341void do_showmap(int pid, const char *name) {
3342 char title[255];
3343 char arg[255];
3344
3345 snprintf(title, sizeof(title), "SHOW MAP %d (%s)", pid, name);
3346 snprintf(arg, sizeof(arg), "%d", pid);
3347 RunCommand(title, {"showmap", "-q", arg}, CommandOptions::AS_ROOT);
3348}
3349
3350int Dumpstate::DumpFile(const std::string& title, const std::string& path) {
3351 DurationReporter duration_reporter(title);
3352
3353 int status = DumpFileToFd(STDOUT_FILENO, title, path);
3354
3355 UpdateProgress(WEIGHT_FILE);
3356
3357 return status;
3358}
3359
3360int read_file_as_long(const char *path, long int *output) {
3361 int fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC));
3362 if (fd < 0) {
3363 int err = errno;
3364 MYLOGE("Error opening file descriptor for %s: %s\n", path, strerror(err));
3365 return -1;
3366 }
3367 char buffer[50];
3368 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3369 if (bytes_read == -1) {
3370 MYLOGE("Error reading file %s: %s\n", path, strerror(errno));
3371 return -2;
3372 }
3373 if (bytes_read == 0) {
3374 MYLOGE("File %s is empty\n", path);
3375 return -3;
3376 }
3377 *output = atoi(buffer);
3378 return 0;
3379}
3380
3381/* calls skip to gate calling dump_from_fd recursively
3382 * in the specified directory. dump_from_fd defaults to
3383 * dump_file_from_fd above when set to NULL. skip defaults
3384 * to false when set to NULL. dump_from_fd will always be
3385 * called with title NULL.
3386 */
3387int dump_files(const std::string& title, const char* dir, bool (*skip)(const char* path),
3388 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
3389 DurationReporter duration_reporter(title);
3390 DIR *dirp;
3391 struct dirent *d;
3392 char *newpath = nullptr;
3393 const char *slash = "/";
3394 int retval = 0;
3395
3396 if (!title.empty()) {
3397 printf("------ %s (%s) ------\n", title.c_str(), dir);
3398 }
3399 if (PropertiesHelper::IsDryRun()) return 0;
3400
3401 if (dir[strlen(dir) - 1] == '/') {
3402 ++slash;
3403 }
3404 dirp = opendir(dir);
3405 if (dirp == nullptr) {
3406 retval = -errno;
3407 MYLOGE("%s: %s\n", dir, strerror(errno));
3408 return retval;
3409 }
3410
3411 if (!dump_from_fd) {
3412 dump_from_fd = dump_file_from_fd;
3413 }
3414 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
3415 if ((d->d_name[0] == '.')
3416 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
3417 || (d->d_name[1] == '\0'))) {
3418 continue;
3419 }
3420 asprintf(&newpath, "%s%s%s%s", dir, slash, d->d_name,
3421 (d->d_type == DT_DIR) ? "/" : "");
3422 if (!newpath) {
3423 retval = -errno;
3424 continue;
3425 }
3426 if (skip && (*skip)(newpath)) {
3427 continue;
3428 }
3429 if (d->d_type == DT_DIR) {
3430 int ret = dump_files("", newpath, skip, dump_from_fd);
3431 if (ret < 0) {
3432 retval = ret;
3433 }
3434 continue;
3435 }
3436 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(newpath, O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
3437 if (fd.get() < 0) {
3438 retval = -1;
3439 printf("*** %s: %s\n", newpath, strerror(errno));
3440 continue;
3441 }
3442 (*dump_from_fd)(nullptr, newpath, fd.get());
3443 }
3444 closedir(dirp);
3445 if (!title.empty()) {
3446 printf("\n");
3447 }
3448 return retval;
3449}
3450
3451/* fd must have been opened with the flag O_NONBLOCK. With this flag set,
3452 * it's possible to avoid issues where opening the file itself can get
3453 * stuck.
3454 */
3455int dump_file_from_fd(const char *title, const char *path, int fd) {
3456 if (PropertiesHelper::IsDryRun()) return 0;
3457
3458 int flags = fcntl(fd, F_GETFL);
3459 if (flags == -1) {
3460 printf("*** %s: failed to get flags on fd %d: %s\n", path, fd, strerror(errno));
3461 return -1;
3462 } else if (!(flags & O_NONBLOCK)) {
3463 printf("*** %s: fd must have O_NONBLOCK set.\n", path);
3464 return -1;
3465 }
3466 return DumpFileFromFdToFd(title, path, fd, STDOUT_FILENO, PropertiesHelper::IsDryRun());
3467}
3468
3469int Dumpstate::RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Nandana Dutt8d945c02019-08-14 13:30:07 +01003470 const CommandOptions& options, bool verbose_duration) {
3471 DurationReporter duration_reporter(title, false /* logcat_only */, verbose_duration);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003472
3473 int status = RunCommandToFd(STDOUT_FILENO, title, full_command, options);
3474
3475 /* TODO: for now we're simplifying the progress calculation by using the
3476 * timeout as the weight. It's a good approximation for most cases, except when calling dumpsys,
3477 * where its weight should be much higher proportionally to its timeout.
3478 * Ideally, it should use a options.EstimatedDuration() instead...*/
3479 UpdateProgress(options.Timeout());
3480
3481 return status;
3482}
3483
3484void Dumpstate::RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsys_args,
3485 const CommandOptions& options, long dumpsysTimeoutMs) {
3486 long timeout_ms = dumpsysTimeoutMs > 0 ? dumpsysTimeoutMs : options.TimeoutInMs();
3487 std::vector<std::string> dumpsys = {"/system/bin/dumpsys", "-T", std::to_string(timeout_ms)};
3488 dumpsys.insert(dumpsys.end(), dumpsys_args.begin(), dumpsys_args.end());
3489 RunCommand(title, dumpsys, options);
3490}
3491
3492int open_socket(const char *service) {
3493 int s = android_get_control_socket(service);
3494 if (s < 0) {
3495 MYLOGE("android_get_control_socket(%s): %s\n", service, strerror(errno));
3496 return -1;
3497 }
3498 fcntl(s, F_SETFD, FD_CLOEXEC);
3499
3500 // Set backlog to 0 to make sure that queue size will be minimum.
3501 // In Linux, because the minimum queue will be 1, connect() will be blocked
3502 // if the other clients already called connect() and the connection request was not accepted.
3503 if (listen(s, 0) < 0) {
3504 MYLOGE("listen(control socket): %s\n", strerror(errno));
3505 return -1;
3506 }
3507
3508 struct sockaddr addr;
3509 socklen_t alen = sizeof(addr);
Abhijeet Kaur2113cae2019-09-13 09:24:15 +01003510 int fd = accept4(s, &addr, &alen, SOCK_CLOEXEC);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003511
3512 // Close socket just after accept(), to make sure that connect() by client will get error
3513 // when the socket is used by the other services.
3514 // There is still a race condition possibility between accept and close, but there is no way
3515 // to close-on-accept atomically.
3516 // See detail; b/123306389#comment25
3517 close(s);
3518
3519 if (fd < 0) {
3520 MYLOGE("accept(control socket): %s\n", strerror(errno));
3521 return -1;
3522 }
3523
3524 return fd;
3525}
3526
3527/* redirect output to a service control socket */
3528bool redirect_to_socket(FILE* redirect, const char* service) {
3529 int fd = open_socket(service);
3530 if (fd == -1) {
3531 return false;
3532 }
3533 fflush(redirect);
3534 // TODO: handle dup2 failure
3535 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
3536 close(fd);
3537 return true;
3538}
3539
3540// TODO: should call is_valid_output_file and/or be merged into it.
3541void create_parent_dirs(const char *path) {
3542 char *chp = const_cast<char *> (path);
3543
3544 /* skip initial slash */
3545 if (chp[0] == '/')
3546 chp++;
3547
3548 /* create leading directories, if necessary */
3549 struct stat dir_stat;
3550 while (chp && chp[0]) {
3551 chp = strchr(chp, '/');
3552 if (chp) {
3553 *chp = 0;
3554 if (stat(path, &dir_stat) == -1 || !S_ISDIR(dir_stat.st_mode)) {
3555 MYLOGI("Creating directory %s\n", path);
3556 if (mkdir(path, 0770)) { /* drwxrwx--- */
3557 MYLOGE("Unable to create directory %s: %s\n", path, strerror(errno));
3558 } else if (chown(path, AID_SHELL, AID_SHELL)) {
3559 MYLOGE("Unable to change ownership of dir %s: %s\n", path, strerror(errno));
3560 }
3561 }
3562 *chp++ = '/';
3563 }
3564 }
3565}
3566
3567bool _redirect_to_file(FILE* redirect, char* path, int truncate_flag) {
3568 create_parent_dirs(path);
3569
3570 int fd = TEMP_FAILURE_RETRY(open(path,
3571 O_WRONLY | O_CREAT | truncate_flag | O_CLOEXEC | O_NOFOLLOW,
3572 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH));
3573 if (fd < 0) {
3574 MYLOGE("%s: %s\n", path, strerror(errno));
3575 return false;
3576 }
3577
3578 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
3579 close(fd);
3580 return true;
3581}
3582
3583bool redirect_to_file(FILE* redirect, char* path) {
3584 return _redirect_to_file(redirect, path, O_TRUNC);
3585}
3586
3587bool redirect_to_existing_file(FILE* redirect, char* path) {
3588 return _redirect_to_file(redirect, path, O_APPEND);
3589}
3590
3591void dump_route_tables() {
3592 DurationReporter duration_reporter("DUMP ROUTE TABLES");
3593 if (PropertiesHelper::IsDryRun()) return;
3594 const char* const RT_TABLES_PATH = "/data/misc/net/rt_tables";
3595 ds.DumpFile("RT_TABLES", RT_TABLES_PATH);
3596 FILE* fp = fopen(RT_TABLES_PATH, "re");
3597 if (!fp) {
3598 printf("*** %s: %s\n", RT_TABLES_PATH, strerror(errno));
3599 return;
3600 }
3601 char table[16];
3602 // Each line has an integer (the table number), a space, and a string (the table name). We only
3603 // need the table number. It's a 32-bit unsigned number, so max 10 chars. Skip the table name.
3604 // Add a fixed max limit so this doesn't go awry.
3605 for (int i = 0; i < 64 && fscanf(fp, " %10s %*s", table) == 1; ++i) {
3606 RunCommand("ROUTE TABLE IPv4", {"ip", "-4", "route", "show", "table", table});
3607 RunCommand("ROUTE TABLE IPv6", {"ip", "-6", "route", "show", "table", table});
3608 }
3609 fclose(fp);
3610}
3611
3612// TODO: make this function thread safe if sections are generated in parallel.
3613void Dumpstate::UpdateProgress(int32_t delta_sec) {
3614 if (progress_ == nullptr) {
3615 MYLOGE("UpdateProgress: progress_ not set\n");
3616 return;
3617 }
3618
3619 // Always update progess so stats can be tuned...
Nandana Dutt402a8392019-06-14 14:25:13 +01003620 progress_->Inc(delta_sec);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003621
3622 // ...but only notifiy listeners when necessary.
3623 if (!options_->do_progress_updates) return;
3624
3625 int progress = progress_->Get();
3626 int max = progress_->GetMax();
Nandana Dutt402a8392019-06-14 14:25:13 +01003627 int percent = 100 * progress / max;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003628
Nandana Dutt402a8392019-06-14 14:25:13 +01003629 if (last_reported_percent_progress_ > 0 && percent <= last_reported_percent_progress_) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003630 return;
3631 }
Nandana Dutt402a8392019-06-14 14:25:13 +01003632 last_reported_percent_progress_ = percent;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003633
3634 if (control_socket_fd_ >= 0) {
3635 dprintf(control_socket_fd_, "PROGRESS:%d/%d\n", progress, max);
3636 fsync(control_socket_fd_);
3637 }
3638
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003639 if (listener_ != nullptr) {
Nandana Dutt235c6672019-11-14 15:22:32 +00003640 if (percent % 10 == 0) {
3641 // We don't want to spam logcat, so only log multiples of 10.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01003642 MYLOGD("Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003643 } else {
3644 // stderr is ignored on normal invocations, but useful when calling
3645 // /system/bin/dumpstate directly for debuggging.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01003646 fprintf(stderr, "Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003647 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003648
3649 listener_->onProgress(percent);
3650 }
3651}
3652
3653void Dumpstate::TakeScreenshot(const std::string& path) {
3654 const std::string& real_path = path.empty() ? screenshot_path_ : path;
3655 int status =
3656 RunCommand("", {"/system/bin/screencap", "-p", real_path},
3657 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3658 if (status == 0) {
3659 MYLOGD("Screenshot saved on %s\n", real_path.c_str());
3660 } else {
3661 MYLOGE("Failed to take screenshot on %s\n", real_path.c_str());
3662 }
Paul Chang0d2aad72020-02-13 20:04:03 +08003663 if (listener_ != nullptr) {
3664 // Show a visual indication to indicate screenshot is taken via
3665 // IDumpstateListener.onScreenshotTaken()
3666 listener_->onScreenshotTaken(status == 0);
3667 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003668}
3669
3670bool is_dir(const char* pathname) {
3671 struct stat info;
3672 if (stat(pathname, &info) == -1) {
3673 return false;
3674 }
3675 return S_ISDIR(info.st_mode);
3676}
3677
3678time_t get_mtime(int fd, time_t default_mtime) {
3679 struct stat info;
3680 if (fstat(fd, &info) == -1) {
3681 return default_mtime;
3682 }
3683 return info.st_mtime;
3684}