blob: 9ba4819ee8010fcfed92851f7536fb3409eb14d2 [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"
Calin Juravlef84d3692020-04-28 15:31:12 -0700172#define PACKAGE_DEX_USE_LIST "/data/system/package-dex-usage.list"
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700173
Narayan Kamath8f788292017-05-25 13:20:39 +0100174// TODO(narayan): Since this information has to be kept in sync
175// with tombstoned, we should just put it in a common header.
176//
177// File: system/core/debuggerd/tombstoned/tombstoned.cpp
Narayan Kamathbd863722017-06-01 18:50:12 +0100178static const std::string TOMBSTONE_DIR = "/data/tombstones/";
179static const std::string TOMBSTONE_FILE_PREFIX = "tombstone_";
180static const std::string ANR_DIR = "/data/anr/";
181static const std::string ANR_FILE_PREFIX = "anr_";
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700182
Felipe Lemee844a9d2016-09-21 15:01:39 -0700183// TODO: temporary variables and functions used during C++ refactoring
Nandana Dutt979388e2018-11-30 16:48:55 +0000184
Nandana Dutt5c390032019-03-12 10:52:56 +0000185#define RETURN_IF_USER_DENIED_CONSENT() \
186 if (ds.IsUserConsentDenied()) { \
187 MYLOGE("Returning early as user denied consent to share bugreport with calling app."); \
188 return Dumpstate::RunStatus::USER_CONSENT_DENIED; \
189 }
190
191// Runs func_ptr, but checks user consent before and after running it. Returns USER_CONSENT_DENIED
192// if consent is found to be denied.
193#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(func_ptr, ...) \
194 RETURN_IF_USER_DENIED_CONSENT(); \
195 func_ptr(__VA_ARGS__); \
196 RETURN_IF_USER_DENIED_CONSENT();
197
Sahana Raof35ed432019-07-12 10:47:52 +0100198static const char* WAKE_LOCK_NAME = "dumpstate_wakelock";
199
Nandana Dutt979388e2018-11-30 16:48:55 +0000200namespace android {
201namespace os {
202namespace {
203
204static int Open(std::string path, int flags, mode_t mode = 0) {
205 int fd = TEMP_FAILURE_RETRY(open(path.c_str(), flags, mode));
206 if (fd == -1) {
207 MYLOGE("open(%s, %s)\n", path.c_str(), strerror(errno));
208 }
209 return fd;
210}
211
Nandana Dutt979388e2018-11-30 16:48:55 +0000212
213static int OpenForRead(std::string path) {
214 return Open(path, O_RDONLY | O_CLOEXEC | O_NOFOLLOW);
215}
216
217bool CopyFile(int in_fd, int out_fd) {
218 char buf[4096];
219 ssize_t byte_count;
220 while ((byte_count = TEMP_FAILURE_RETRY(read(in_fd, buf, sizeof(buf)))) > 0) {
221 if (!android::base::WriteFully(out_fd, buf, byte_count)) {
222 return false;
223 }
224 }
225 return (byte_count != -1);
226}
227
228static bool CopyFileToFd(const std::string& input_file, int out_fd) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000229 MYLOGD("Going to copy file (%s) to %d\n", input_file.c_str(), out_fd);
Nandana Dutt979388e2018-11-30 16:48:55 +0000230
231 // Obtain a handle to the source file.
232 android::base::unique_fd in_fd(OpenForRead(input_file));
233 if (out_fd != -1 && in_fd.get() != -1) {
234 if (CopyFile(in_fd.get(), out_fd)) {
235 return true;
236 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000237 MYLOGE("Failed to copy file: %s\n", strerror(errno));
Nandana Dutt979388e2018-11-30 16:48:55 +0000238 }
239 return false;
240}
241
Nandana Duttd2f5f082019-01-18 17:13:52 +0000242static bool UnlinkAndLogOnError(const std::string& file) {
Nandana Dutt8ae16e62020-03-27 10:20:22 +0000243 if (file.empty()) {
244 return false;
245 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000246 if (unlink(file.c_str())) {
247 MYLOGE("Failed to unlink file (%s): %s\n", file.c_str(), strerror(errno));
Nandana Duttd2f5f082019-01-18 17:13:52 +0000248 return false;
249 }
250 return true;
251}
Nandana Dutt979388e2018-11-30 16:48:55 +0000252
Nikita Ioffea325a572019-05-16 19:49:47 +0100253int64_t GetModuleMetadataVersion() {
254 auto binder = defaultServiceManager()->getService(android::String16("package_native"));
255 if (binder == nullptr) {
256 MYLOGE("Failed to retrieve package_native service");
257 return 0L;
258 }
259 auto package_service = android::interface_cast<content::pm::IPackageManagerNative>(binder);
260 std::string package_name;
261 auto status = package_service->getModuleMetadataPackageName(&package_name);
262 if (!status.isOk()) {
263 MYLOGE("Failed to retrieve module metadata package name: %s", status.toString8().c_str());
264 return 0L;
265 }
Nandana Duttdb379fa2019-10-09 16:54:41 +0100266 MYLOGD("Module metadata package name: %s\n", package_name.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100267 int64_t version_code;
268 status = package_service->getVersionCodeForPackage(android::String16(package_name.c_str()),
269 &version_code);
270 if (!status.isOk()) {
271 MYLOGE("Failed to retrieve module metadata version: %s", status.toString8().c_str());
272 return 0L;
273 }
274 return version_code;
275}
276
Nandana Dutt979388e2018-11-30 16:48:55 +0000277} // namespace
278} // namespace os
279} // namespace android
280
Felipe Leme678727a2016-09-21 17:22:11 -0700281static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
Felipe Lemebda15a02016-11-16 17:48:25 -0800282 const CommandOptions& options = Dumpstate::DEFAULT_DUMPSYS,
Vishnu Nair6921f802017-11-22 09:17:23 -0800283 long dumpsysTimeoutMs = 0) {
284 return ds.RunDumpsys(title, dumpsysArgs, options, dumpsysTimeoutMs);
Felipe Leme678727a2016-09-21 17:22:11 -0700285}
286static int DumpFile(const std::string& title, const std::string& path) {
287 return ds.DumpFile(title, path);
288}
Felipe Lemee82a27d2016-01-05 13:35:44 -0800289
Felipe Lemee844a9d2016-09-21 15:01:39 -0700290// Relative directory (inside the zip) for all files copied as-is into the bugreport.
291static const std::string ZIP_ROOT_DIR = "FS";
292
Vishnu Naire97d6122018-01-18 13:58:56 -0800293static const std::string kProtoPath = "proto/";
294static const std::string kProtoExt = ".proto";
Jie Song9fbfad02017-06-20 16:29:42 -0700295static const std::string kDumpstateBoardFiles[] = {
296 "dumpstate_board.txt",
Felipe Leme95d6ca52017-08-01 16:35:56 -0700297 "dumpstate_board.bin"
Jie Song9fbfad02017-06-20 16:29:42 -0700298};
299static const int NUM_OF_DUMPS = arraysize(kDumpstateBoardFiles);
300
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700301static constexpr char PROPERTY_LAST_ID[] = "dumpstate.last_id";
Felipe Lemed071c682016-10-20 16:48:00 -0700302static constexpr char PROPERTY_VERSION[] = "dumpstate.version";
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700303
Felipe Lemef0292972016-11-22 13:57:05 -0800304static const CommandOptions AS_ROOT_20 = CommandOptions::WithTimeout(20).AsRoot().Build();
305
Narayan Kamath8f788292017-05-25 13:20:39 +0100306/*
Narayan Kamathbd863722017-06-01 18:50:12 +0100307 * Returns a vector of dump fds under |dir_path| with a given |file_prefix|.
308 * The returned vector is sorted by the mtimes of the dumps. If |limit_by_mtime|
309 * is set, the vector only contains files that were written in the last 30 minutes.
Narayan Kamath8f788292017-05-25 13:20:39 +0100310 */
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700311static std::vector<DumpData> GetDumpFds(const std::string& dir_path,
312 const std::string& file_prefix,
Elliott Hughesdb6d2112019-09-26 15:24:51 -0700313 bool limit_by_mtime) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100314 const time_t thirty_minutes_ago = ds.now_ - 60 * 30;
315
Narayan Kamathbd863722017-06-01 18:50:12 +0100316 std::unique_ptr<DIR, decltype(&closedir)> dump_dir(opendir(dir_path.c_str()), closedir);
Narayan Kamath8f788292017-05-25 13:20:39 +0100317
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700318 if (dump_dir == nullptr) {
319 MYLOGW("Unable to open directory %s: %s\n", dir_path.c_str(), strerror(errno));
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700320 return std::vector<DumpData>();
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700321 }
322
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700323 std::vector<DumpData> dump_data;
Narayan Kamathbd863722017-06-01 18:50:12 +0100324 struct dirent* entry = nullptr;
325 while ((entry = readdir(dump_dir.get()))) {
326 if (entry->d_type != DT_REG) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100327 continue;
328 }
329
Narayan Kamathbd863722017-06-01 18:50:12 +0100330 const std::string base_name(entry->d_name);
331 if (base_name.find(file_prefix) != 0) {
332 continue;
333 }
334
335 const std::string abs_path = dir_path + base_name;
336 android::base::unique_fd fd(
337 TEMP_FAILURE_RETRY(open(abs_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW | O_NONBLOCK)));
338 if (fd == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700339 MYLOGW("Unable to open dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamathbd863722017-06-01 18:50:12 +0100340 break;
341 }
342
343 struct stat st = {};
344 if (fstat(fd, &st) == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700345 MYLOGW("Unable to stat dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamath8f788292017-05-25 13:20:39 +0100346 continue;
347 }
348
Narayan Kamath3f31b632018-02-22 19:42:36 +0000349 if (limit_by_mtime && st.st_mtime < thirty_minutes_ago) {
Narayan Kamathbd863722017-06-01 18:50:12 +0100350 MYLOGI("Excluding stale dump file: %s\n", abs_path.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100351 continue;
352 }
353
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700354 dump_data.emplace_back(DumpData{abs_path, std::move(fd), st.st_mtime});
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700355 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100356
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700357 return dump_data;
Narayan Kamath8f788292017-05-25 13:20:39 +0100358}
359
Narayan Kamathbd863722017-06-01 18:50:12 +0100360static bool AddDumps(const std::vector<DumpData>::const_iterator start,
361 const std::vector<DumpData>::const_iterator end,
362 const char* type_name, const bool add_to_zip) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100363 bool dumped = false;
Narayan Kamathbd863722017-06-01 18:50:12 +0100364 for (auto it = start; it != end; ++it) {
365 const std::string& name = it->name;
366 const int fd = it->fd;
Narayan Kamath8f788292017-05-25 13:20:39 +0100367 dumped = true;
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100368
369 // Seek to the beginning of the file before dumping any data. A given
370 // DumpData entry might be dumped multiple times in the report.
371 //
372 // For example, the most recent ANR entry is dumped to the body of the
373 // main entry and it also shows up as a separate entry in the bugreport
374 // ZIP file.
375 if (lseek(fd, 0, SEEK_SET) != static_cast<off_t>(0)) {
376 MYLOGE("Unable to add %s to zip file, lseek failed: %s\n", name.c_str(),
377 strerror(errno));
378 }
379
Narayan Kamath8f788292017-05-25 13:20:39 +0100380 if (ds.IsZipping() && add_to_zip) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800381 if (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + name, fd, /* timeout = */ 0ms) != OK) {
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100382 MYLOGE("Unable to add %s to zip file, addZipEntryFromFd failed\n", name.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100383 }
384 } else {
385 dump_file_from_fd(type_name, name.c_str(), fd);
386 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100387 }
388
389 return dumped;
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700390}
391
Felipe Leme635ca312016-01-05 14:23:02 -0800392// for_each_pid() callback to get mount info about a process.
Felipe Leme4c2d6632016-09-28 14:32:00 -0700393void do_mountinfo(int pid, const char* name __attribute__((unused))) {
Felipe Leme635ca312016-01-05 14:23:02 -0800394 char path[PATH_MAX];
395
396 // Gets the the content of the /proc/PID/ns/mnt link, so only unique mount points
397 // are added.
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700398 snprintf(path, sizeof(path), "/proc/%d/ns/mnt", pid);
Felipe Leme635ca312016-01-05 14:23:02 -0800399 char linkname[PATH_MAX];
400 ssize_t r = readlink(path, linkname, PATH_MAX);
401 if (r == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800402 MYLOGE("Unable to read link for %s: %s\n", path, strerror(errno));
Felipe Leme635ca312016-01-05 14:23:02 -0800403 return;
404 }
405 linkname[r] = '\0';
406
407 if (mount_points.find(linkname) == mount_points.end()) {
408 // First time this mount point was found: add it
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700409 snprintf(path, sizeof(path), "/proc/%d/mountinfo", pid);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700410 if (ds.AddZipEntry(ZIP_ROOT_DIR + path, path)) {
Felipe Leme635ca312016-01-05 14:23:02 -0800411 mount_points.insert(linkname);
412 } else {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800413 MYLOGE("Unable to add mountinfo %s to zip file\n", path);
Felipe Leme635ca312016-01-05 14:23:02 -0800414 }
415 }
416}
417
418void add_mountinfo() {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700419 if (!ds.IsZipping()) return;
Felipe Leme678727a2016-09-21 17:22:11 -0700420 std::string title = "MOUNT INFO";
Felipe Leme635ca312016-01-05 14:23:02 -0800421 mount_points.clear();
Felipe Leme46b85da2016-11-21 17:40:45 -0800422 DurationReporter duration_reporter(title, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700423 for_each_pid(do_mountinfo, nullptr);
424 MYLOGD("%s: %d entries added to zip file\n", title.c_str(), (int)mount_points.size());
Felipe Leme635ca312016-01-05 14:23:02 -0800425}
426
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700427static void dump_dev_files(const char *title, const char *driverpath, const char *filename)
428{
429 DIR *d;
430 struct dirent *de;
431 char path[PATH_MAX];
432
433 d = opendir(driverpath);
Yi Kong19d5c002018-07-20 13:39:55 -0700434 if (d == nullptr) {
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700435 return;
436 }
437
438 while ((de = readdir(d))) {
439 if (de->d_type != DT_LNK) {
440 continue;
441 }
442 snprintf(path, sizeof(path), "%s/%s/%s", driverpath, de->d_name, filename);
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700443 DumpFile(title, path);
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700444 }
445
446 closedir(d);
447}
448
Mark Salyzyn326842f2015-04-30 09:49:41 -0700449static bool skip_not_stat(const char *path) {
450 static const char stat[] = "/stat";
451 size_t len = strlen(path);
452 if (path[len - 1] == '/') { /* Directory? */
453 return false;
454 }
455 return strcmp(path + len - sizeof(stat) + 1, stat); /* .../stat? */
456}
457
Felipe Leme4c2d6632016-09-28 14:32:00 -0700458static bool skip_none(const char* path __attribute__((unused))) {
Felipe Lemee82a27d2016-01-05 13:35:44 -0800459 return false;
460}
461
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700462unsigned long worst_write_perf = 20000; /* in KB/s */
Mark Salyzyn326842f2015-04-30 09:49:41 -0700463
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800464//
465// stat offsets
466// Name units description
467// ---- ----- -----------
468// read I/Os requests number of read I/Os processed
469#define __STAT_READ_IOS 0
470// read merges requests number of read I/Os merged with in-queue I/O
471#define __STAT_READ_MERGES 1
472// read sectors sectors number of sectors read
473#define __STAT_READ_SECTORS 2
474// read ticks milliseconds total wait time for read requests
475#define __STAT_READ_TICKS 3
476// write I/Os requests number of write I/Os processed
477#define __STAT_WRITE_IOS 4
478// write merges requests number of write I/Os merged with in-queue I/O
479#define __STAT_WRITE_MERGES 5
480// write sectors sectors number of sectors written
481#define __STAT_WRITE_SECTORS 6
482// write ticks milliseconds total wait time for write requests
483#define __STAT_WRITE_TICKS 7
484// in_flight requests number of I/Os currently in flight
485#define __STAT_IN_FLIGHT 8
486// io_ticks milliseconds total time this block device has been active
487#define __STAT_IO_TICKS 9
488// time_in_queue milliseconds total wait time for all requests
489#define __STAT_IN_QUEUE 10
490#define __STAT_NUMBER_FIELD 11
491//
492// read I/Os, write I/Os
493// =====================
494//
495// These values increment when an I/O request completes.
496//
497// read merges, write merges
498// =========================
499//
500// These values increment when an I/O request is merged with an
501// already-queued I/O request.
502//
503// read sectors, write sectors
504// ===========================
505//
506// These values count the number of sectors read from or written to this
507// block device. The "sectors" in question are the standard UNIX 512-byte
508// sectors, not any device- or filesystem-specific block size. The
509// counters are incremented when the I/O completes.
510#define SECTOR_SIZE 512
511//
512// read ticks, write ticks
513// =======================
514//
515// These values count the number of milliseconds that I/O requests have
516// waited on this block device. If there are multiple I/O requests waiting,
517// these values will increase at a rate greater than 1000/second; for
518// example, if 60 read requests wait for an average of 30 ms, the read_ticks
519// field will increase by 60*30 = 1800.
520//
521// in_flight
522// =========
523//
524// This value counts the number of I/O requests that have been issued to
525// the device driver but have not yet completed. It does not include I/O
526// requests that are in the queue but not yet issued to the device driver.
527//
528// io_ticks
529// ========
530//
531// This value counts the number of milliseconds during which the device has
532// had I/O requests queued.
533//
534// time_in_queue
535// =============
536//
537// This value counts the number of milliseconds that I/O requests have waited
538// on this block device. If there are multiple I/O requests waiting, this
539// value will increase as the product of the number of milliseconds times the
540// number of requests waiting (see "read ticks" above for an example).
541#define S_TO_MS 1000
542//
543
Mark Salyzyn326842f2015-04-30 09:49:41 -0700544static int dump_stat_from_fd(const char *title __unused, const char *path, int fd) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800545 unsigned long long fields[__STAT_NUMBER_FIELD];
Mark Salyzyn326842f2015-04-30 09:49:41 -0700546 bool z;
Yi Kong19d5c002018-07-20 13:39:55 -0700547 char *cp, *buffer = nullptr;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700548 size_t i = 0;
Josh Gao7c4258c2018-06-25 13:40:08 -0700549 FILE *fp = fdopen(dup(fd), "rb");
Mark Salyzyn326842f2015-04-30 09:49:41 -0700550 getline(&buffer, &i, fp);
551 fclose(fp);
552 if (!buffer) {
553 return -errno;
554 }
555 i = strlen(buffer);
556 while ((i > 0) && (buffer[i - 1] == '\n')) {
557 buffer[--i] = '\0';
558 }
559 if (!*buffer) {
560 free(buffer);
561 return 0;
562 }
563 z = true;
564 for (cp = buffer, i = 0; i < (sizeof(fields) / sizeof(fields[0])); ++i) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800565 fields[i] = strtoull(cp, &cp, 10);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700566 if (fields[i] != 0) {
567 z = false;
568 }
569 }
570 if (z) { /* never accessed */
571 free(buffer);
572 return 0;
573 }
574
Wei Wang509bb5d2017-06-09 14:42:12 -0700575 if (!strncmp(path, BLK_DEV_SYS_DIR, sizeof(BLK_DEV_SYS_DIR) - 1)) {
576 path += sizeof(BLK_DEV_SYS_DIR) - 1;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700577 }
Wei Wang1dc1ef52017-06-12 11:28:37 -0700578
579 printf("%-30s:%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s\n%-30s:\t%s\n", "Block-Dev",
580 "R-IOs", "R-merg", "R-sect", "R-wait", "W-IOs", "W-merg", "W-sect",
581 "W-wait", "in-fli", "activ", "T-wait", path, buffer);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700582 free(buffer);
583
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800584 if (fields[__STAT_IO_TICKS]) {
585 unsigned long read_perf = 0;
586 unsigned long read_ios = 0;
587 if (fields[__STAT_READ_TICKS]) {
588 unsigned long long divisor = fields[__STAT_READ_TICKS]
589 * fields[__STAT_IO_TICKS];
590 read_perf = ((unsigned long long)SECTOR_SIZE
591 * fields[__STAT_READ_SECTORS]
592 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
593 / divisor;
594 read_ios = ((unsigned long long)S_TO_MS * fields[__STAT_READ_IOS]
595 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
596 / divisor;
597 }
598
599 unsigned long write_perf = 0;
600 unsigned long write_ios = 0;
601 if (fields[__STAT_WRITE_TICKS]) {
602 unsigned long long divisor = fields[__STAT_WRITE_TICKS]
603 * fields[__STAT_IO_TICKS];
604 write_perf = ((unsigned long long)SECTOR_SIZE
605 * fields[__STAT_WRITE_SECTORS]
606 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
607 / divisor;
608 write_ios = ((unsigned long long)S_TO_MS * fields[__STAT_WRITE_IOS]
609 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
610 / divisor;
611 }
612
613 unsigned queue = (fields[__STAT_IN_QUEUE]
614 + (fields[__STAT_IO_TICKS] >> 1))
615 / fields[__STAT_IO_TICKS];
616
617 if (!write_perf && !write_ios) {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700618 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 -0800619 } else {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700620 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 -0800621 read_ios, write_perf, write_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800622 }
623
624 /* bugreport timeout factor adjustment */
625 if ((write_perf > 1) && (write_perf < worst_write_perf)) {
626 worst_write_perf = write_perf;
627 }
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700628 }
Mark Salyzyn326842f2015-04-30 09:49:41 -0700629 return 0;
630}
631
Yao Chenbe3bbc12018-01-17 16:31:10 -0800632static const long MINIMUM_LOGCAT_TIMEOUT_MS = 50000;
633
634/* timeout in ms to read a list of buffers */
635static unsigned long logcat_timeout(const std::vector<std::string>& buffers) {
636 unsigned long timeout_ms = 0;
637 for (const auto& buffer : buffers) {
638 log_id_t id = android_name_to_log_id(buffer.c_str());
639 unsigned long property_size = __android_logger_get_buffer_size(id);
640 /* Engineering margin is ten-fold our guess */
641 timeout_ms += 10 * (property_size + worst_write_perf) / worst_write_perf;
642 }
643 return timeout_ms > MINIMUM_LOGCAT_TIMEOUT_MS ? timeout_ms : MINIMUM_LOGCAT_TIMEOUT_MS;
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700644}
645
Nandana Duttd2f5f082019-01-18 17:13:52 +0000646Dumpstate::ConsentCallback::ConsentCallback() : result_(UNAVAILABLE), start_time_(Nanotime()) {
647}
648
649android::binder::Status Dumpstate::ConsentCallback::onReportApproved() {
650 std::lock_guard<std::mutex> lock(lock_);
651 result_ = APPROVED;
652 MYLOGD("User approved consent to share bugreport\n");
Paul Chang0d2aad72020-02-13 20:04:03 +0800653
654 // Maybe copy screenshot so calling app can display the screenshot to the user as soon as
655 // consent is granted.
656 if (ds.options_->is_screenshot_copied) {
657 return android::binder::Status::ok();
658 }
659
660 if (!ds.options_->do_screenshot || ds.options_->screenshot_fd.get() == -1 ||
661 !ds.do_early_screenshot_) {
662 return android::binder::Status::ok();
663 }
664
665 bool copy_succeeded = android::os::CopyFileToFd(ds.screenshot_path_,
666 ds.options_->screenshot_fd.get());
667 ds.options_->is_screenshot_copied = copy_succeeded;
668 if (copy_succeeded) {
669 android::os::UnlinkAndLogOnError(ds.screenshot_path_);
670 }
Nandana Duttd2f5f082019-01-18 17:13:52 +0000671 return android::binder::Status::ok();
672}
673
674android::binder::Status Dumpstate::ConsentCallback::onReportDenied() {
675 std::lock_guard<std::mutex> lock(lock_);
676 result_ = DENIED;
677 MYLOGW("User denied consent to share bugreport\n");
678 return android::binder::Status::ok();
679}
680
681UserConsentResult Dumpstate::ConsentCallback::getResult() {
682 std::lock_guard<std::mutex> lock(lock_);
683 return result_;
684}
685
686uint64_t Dumpstate::ConsentCallback::getElapsedTimeMs() const {
Hunter Knepshieldf0a39052020-01-03 14:53:04 -0800687 return (Nanotime() - start_time_) / NANOS_PER_MILLI;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000688}
689
Felipe Leme2b9b06c2016-10-14 09:13:06 -0700690void Dumpstate::PrintHeader() const {
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700691 std::string build, fingerprint, radio, bootloader, network;
692 char date[80];
Colin Crossf45fa6b2012-03-26 12:38:26 -0700693
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700694 build = android::base::GetProperty("ro.build.display.id", "(unknown)");
695 fingerprint = android::base::GetProperty("ro.build.fingerprint", "(unknown)");
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700696 radio = android::base::GetProperty("gsm.version.baseband", "(unknown)");
697 bootloader = android::base::GetProperty("ro.bootloader", "(unknown)");
698 network = android::base::GetProperty("gsm.operator.alpha", "(unknown)");
Felipe Lemebbaf3c12016-10-11 14:32:25 -0700699 strftime(date, sizeof(date), "%Y-%m-%d %H:%M:%S", localtime(&now_));
Colin Crossf45fa6b2012-03-26 12:38:26 -0700700
Felipe Lemed8b94e52016-12-08 10:21:44 -0800701 printf("========================================================\n");
702 printf("== dumpstate: %s\n", date);
703 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -0700704
Felipe Lemed8b94e52016-12-08 10:21:44 -0800705 printf("\n");
706 printf("Build: %s\n", build.c_str());
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700707 // NOTE: fingerprint entry format is important for other tools.
Felipe Lemed8b94e52016-12-08 10:21:44 -0800708 printf("Build fingerprint: '%s'\n", fingerprint.c_str());
709 printf("Bootloader: %s\n", bootloader.c_str());
710 printf("Radio: %s\n", radio.c_str());
711 printf("Network: %s\n", network.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100712 int64_t module_metadata_version = android::os::GetModuleMetadataVersion();
713 if (module_metadata_version != 0) {
714 printf("Module Metadata version: %" PRId64 "\n", module_metadata_version);
715 }
Colin Crossf45fa6b2012-03-26 12:38:26 -0700716
Felipe Lemed8b94e52016-12-08 10:21:44 -0800717 printf("Kernel: ");
Felipe Lemef0292972016-11-22 13:57:05 -0800718 DumpFileToFd(STDOUT_FILENO, "", "/proc/version");
Felipe Lemed8b94e52016-12-08 10:21:44 -0800719 printf("Command line: %s\n", strtok(cmdline_buf, "\n"));
Felipe Leme7709f8a2017-12-05 09:30:09 -0800720 printf("Uptime: ");
721 RunCommandToFd(STDOUT_FILENO, "", {"uptime", "-p"},
722 CommandOptions::WithTimeout(1).Always().Build());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800723 printf("Bugreport format version: %s\n", version_.c_str());
Abhijeet Kaure370d682019-10-01 16:49:30 +0100724 printf("Dumpstate info: id=%d pid=%d dry_run=%d args=%s bugreport_mode=%s\n", id_, pid_,
725 PropertiesHelper::IsDryRun(), options_->args.c_str(), options_->bugreport_mode.c_str());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800726 printf("\n");
Felipe Leme78f2c862015-12-21 09:55:22 -0800727}
728
Felipe Leme24b66ee2016-06-16 10:55:26 -0700729// List of file extensions that can cause a zip file attachment to be rejected by some email
730// service providers.
731static const std::set<std::string> PROBLEMATIC_FILE_EXTENSIONS = {
732 ".ade", ".adp", ".bat", ".chm", ".cmd", ".com", ".cpl", ".exe", ".hta", ".ins", ".isp",
733 ".jar", ".jse", ".lib", ".lnk", ".mde", ".msc", ".msp", ".mst", ".pif", ".scr", ".sct",
734 ".shb", ".sys", ".vb", ".vbe", ".vbs", ".vxd", ".wsc", ".wsf", ".wsh"
735};
736
Vishnu Naire97d6122018-01-18 13:58:56 -0800737status_t Dumpstate::AddZipEntryFromFd(const std::string& entry_name, int fd,
738 std::chrono::milliseconds timeout = 0ms) {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700739 if (!IsZipping()) {
740 MYLOGD("Not adding zip entry %s from fd because it's not a zipped bugreport\n",
741 entry_name.c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -0800742 return INVALID_OPERATION;
Felipe Leme111b9d02016-02-03 09:28:24 -0800743 }
Felipe Leme24b66ee2016-06-16 10:55:26 -0700744 std::string valid_name = entry_name;
745
746 // Rename extension if necessary.
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -0700747 size_t idx = entry_name.rfind('.');
Felipe Leme24b66ee2016-06-16 10:55:26 -0700748 if (idx != std::string::npos) {
749 std::string extension = entry_name.substr(idx);
750 std::transform(extension.begin(), extension.end(), extension.begin(), ::tolower);
751 if (PROBLEMATIC_FILE_EXTENSIONS.count(extension) != 0) {
752 valid_name = entry_name + ".renamed";
753 MYLOGI("Renaming entry %s to %s\n", entry_name.c_str(), valid_name.c_str());
754 }
755 }
756
Felipe Leme6fe9db62016-02-12 09:04:16 -0800757 // Logging statement below is useful to time how long each entry takes, but it's too verbose.
758 // MYLOGD("Adding zip entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700759 int32_t err = zip_writer_->StartEntryWithTime(valid_name.c_str(), ZipWriter::kCompress,
760 get_mtime(fd, ds.now_));
Felipe Leme1d486fe2016-10-14 18:06:47 -0700761 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700762 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", valid_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700763 ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800764 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800765 }
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000766 bool finished_entry = false;
767 auto finish_entry = [this, &finished_entry] {
768 if (!finished_entry) {
769 // This should only be called when we're going to return an earlier error,
770 // which would've been logged. This may imply the file is already corrupt
771 // and any further logging from FinishEntry is more likely to mislead than
772 // not.
773 this->zip_writer_->FinishEntry();
774 }
775 };
776 auto scope_guard = android::base::make_scope_guard(finish_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -0800777 auto start = std::chrono::steady_clock::now();
778 auto end = start + timeout;
779 struct pollfd pfd = {fd, POLLIN};
Felipe Lemee82a27d2016-01-05 13:35:44 -0800780
Felipe Leme770410d2016-01-26 17:07:14 -0800781 std::vector<uint8_t> buffer(65536);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800782 while (1) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800783 if (timeout.count() > 0) {
784 // lambda to recalculate the timeout.
785 auto time_left_ms = [end]() {
786 auto now = std::chrono::steady_clock::now();
787 auto diff = std::chrono::duration_cast<std::chrono::milliseconds>(end - now);
788 return std::max(diff.count(), 0LL);
789 };
790
791 int rc = TEMP_FAILURE_RETRY(poll(&pfd, 1, time_left_ms()));
792 if (rc < 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000793 MYLOGE("Error in poll while adding from fd to zip entry %s:%s\n",
794 entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800795 return -errno;
796 } else if (rc == 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000797 MYLOGE("Timed out adding from fd to zip entry %s:%s Timeout:%lldms\n",
Vishnu Naire97d6122018-01-18 13:58:56 -0800798 entry_name.c_str(), strerror(errno), timeout.count());
799 return TIMED_OUT;
800 }
801 }
802
Zach Riggle22200402016-08-18 01:01:24 -0400803 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800804 if (bytes_read == 0) {
805 break;
806 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800807 MYLOGE("read(%s): %s\n", entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800808 return -errno;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800809 }
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700810 err = zip_writer_->WriteBytes(buffer.data(), bytes_read);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800811 if (err) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700812 MYLOGE("zip_writer_->WriteBytes(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800813 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800814 }
815 }
816
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700817 err = zip_writer_->FinishEntry();
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000818 finished_entry = true;
Felipe Leme1d486fe2016-10-14 18:06:47 -0700819 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700820 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800821 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800822 }
823
Vishnu Naire97d6122018-01-18 13:58:56 -0800824 return OK;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800825}
826
Felipe Leme1d486fe2016-10-14 18:06:47 -0700827bool Dumpstate::AddZipEntry(const std::string& entry_name, const std::string& entry_path) {
828 android::base::unique_fd fd(
829 TEMP_FAILURE_RETRY(open(entry_path.c_str(), O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
Andreas Gampeaff68432016-07-18 18:01:27 -0700830 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800831 MYLOGE("open(%s): %s\n", entry_path.c_str(), strerror(errno));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800832 return false;
833 }
834
Vishnu Naire97d6122018-01-18 13:58:56 -0800835 return (AddZipEntryFromFd(entry_name, fd.get()) == OK);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800836}
837
838/* adds a file to the existing zipped bugreport */
Felipe Leme4c2d6632016-09-28 14:32:00 -0700839static int _add_file_from_fd(const char* title __attribute__((unused)), const char* path, int fd) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800840 return (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + path, fd) == OK) ? 0 : 1;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800841}
842
Felipe Leme1d486fe2016-10-14 18:06:47 -0700843void Dumpstate::AddDir(const std::string& dir, bool recursive) {
844 if (!IsZipping()) {
845 MYLOGD("Not adding dir %s because it's not a zipped bugreport\n", dir.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800846 return;
847 }
Felipe Leme678727a2016-09-21 17:22:11 -0700848 MYLOGD("Adding dir %s (recursive: %d)\n", dir.c_str(), recursive);
Felipe Leme46b85da2016-11-21 17:40:45 -0800849 DurationReporter duration_reporter(dir, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700850 dump_files("", dir.c_str(), recursive ? skip_none : is_dir, _add_file_from_fd);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800851}
852
Felipe Leme1d486fe2016-10-14 18:06:47 -0700853bool Dumpstate::AddTextZipEntry(const std::string& entry_name, const std::string& content) {
854 if (!IsZipping()) {
855 MYLOGD("Not adding text zip entry %s because it's not a zipped bugreport\n",
856 entry_name.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800857 return false;
858 }
Felipe Lemecbce55d2016-02-08 09:53:18 -0800859 MYLOGD("Adding zip text entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700860 int32_t err = zip_writer_->StartEntryWithTime(entry_name.c_str(), ZipWriter::kCompress, ds.now_);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700861 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700862 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700863 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800864 return false;
865 }
866
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700867 err = zip_writer_->WriteBytes(content.c_str(), content.length());
Felipe Leme1d486fe2016-10-14 18:06:47 -0700868 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700869 MYLOGE("zip_writer_->WriteBytes(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700870 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800871 return false;
872 }
873
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700874 err = zip_writer_->FinishEntry();
Felipe Leme1d486fe2016-10-14 18:06:47 -0700875 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700876 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800877 return false;
878 }
879
880 return true;
881}
882
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800883static void DoKmsg() {
884 struct stat st;
885 if (!stat(PSTORE_LAST_KMSG, &st)) {
886 /* Also TODO: Make console-ramoops CAP_SYSLOG protected. */
887 DumpFile("LAST KMSG", PSTORE_LAST_KMSG);
888 } else if (!stat(ALT_PSTORE_LAST_KMSG, &st)) {
889 DumpFile("LAST KMSG", ALT_PSTORE_LAST_KMSG);
890 } else {
891 /* TODO: Make last_kmsg CAP_SYSLOG protected. b/5555691 */
892 DumpFile("LAST KMSG", "/proc/last_kmsg");
893 }
894}
895
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800896static void DoKernelLogcat() {
Yao Chenbe3bbc12018-01-17 16:31:10 -0800897 unsigned long timeout_ms = logcat_timeout({"kernel"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800898 RunCommand(
899 "KERNEL LOG",
900 {"logcat", "-b", "kernel", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
901 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
902}
903
Nandana Duttdb379fa2019-10-09 16:54:41 +0100904static void DoSystemLogcat(time_t since) {
905 char since_str[80];
906 strftime(since_str, sizeof(since_str), "%Y-%m-%d %H:%M:%S.000", localtime(&since));
907
908 unsigned long timeout_ms = logcat_timeout({"main", "system", "crash"});
909 RunCommand("SYSTEM LOG",
910 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v", "-T",
911 since_str},
912 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
913}
914
Hunter Knepshield820f9bc2020-02-05 20:10:53 -0800915static void DoRadioLogcat() {
916 unsigned long timeout_ms = logcat_timeout({"radio"});
917 RunCommand(
918 "RADIO LOG",
919 {"logcat", "-b", "radio", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
920 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
921}
922
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800923static void DoLogcat() {
Vishnu Nair6921f802017-11-22 09:17:23 -0800924 unsigned long timeout_ms;
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800925 // DumpFile("EVENT LOG TAGS", "/etc/event-log-tags");
926 // calculate timeout
Yao Chenbe3bbc12018-01-17 16:31:10 -0800927 timeout_ms = logcat_timeout({"main", "system", "crash"});
Tony Makae737652017-03-30 17:47:09 +0100928 RunCommand("SYSTEM LOG",
Vishnu Nair6921f802017-11-22 09:17:23 -0800929 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
930 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -0800931 timeout_ms = logcat_timeout({"events"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800932 RunCommand(
933 "EVENT LOG",
934 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +0100935 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Yao Chenbe3bbc12018-01-17 16:31:10 -0800936 timeout_ms = logcat_timeout({"stats"});
937 RunCommand(
938 "STATS LOG",
939 {"logcat", "-b", "stats", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +0100940 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Hunter Knepshield820f9bc2020-02-05 20:10:53 -0800941 DoRadioLogcat();
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800942
943 RunCommand("LOG STATISTICS", {"logcat", "-b", "all", "-S"});
944
945 /* kernels must set CONFIG_PSTORE_PMSG, slice up pstore with device tree */
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800946 RunCommand("LAST LOGCAT", {"logcat", "-L", "-b", "all", "-v", "threadtime", "-v", "printable",
947 "-v", "uid", "-d", "*:v"});
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800948}
949
Mike Ma5c267872019-08-21 11:31:34 -0700950static void DumpIncidentReport() {
951 if (!ds.IsZipping()) {
952 MYLOGD("Not dumping incident report because it's not a zipped bugreport\n");
953 return;
954 }
955 DurationReporter duration_reporter("INCIDENT REPORT");
956 const std::string path = ds.bugreport_internal_dir_ + "/tmp_incident_report";
957 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
958 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
959 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
960 if (fd < 0) {
961 MYLOGE("Could not open %s to dump incident report.\n", path.c_str());
962 return;
963 }
964 RunCommandToFd(fd, "", {"incident", "-u"}, CommandOptions::WithTimeout(120).Build());
965 bool empty = 0 == lseek(fd, 0, SEEK_END);
966 if (!empty) {
967 // Use a different name from "incident.proto"
968 // /proto/incident.proto is reserved for incident service dump
969 // i.e. metadata for debugging.
970 ds.AddZipEntry(kProtoPath + "incident_report" + kProtoExt, path);
971 }
972 unlink(path.c_str());
973}
974
Sunny Goyal35949782019-11-19 15:54:36 -0800975static void DumpVisibleWindowViews() {
976 if (!ds.IsZipping()) {
977 MYLOGD("Not dumping visible views because it's not a zipped bugreport\n");
978 return;
979 }
980 DurationReporter duration_reporter("VISIBLE WINDOW VIEWS");
981 const std::string path = ds.bugreport_internal_dir_ + "/tmp_visible_window_views";
982 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
983 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
984 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
985 if (fd < 0) {
986 MYLOGE("Could not open %s to dump visible views.\n", path.c_str());
987 return;
988 }
989 RunCommandToFd(fd, "", {"cmd", "window", "dump-visible-window-views"},
990 CommandOptions::WithTimeout(120).Build());
991 bool empty = 0 == lseek(fd, 0, SEEK_END);
992 if (!empty) {
993 ds.AddZipEntry("visible_windows.zip", path);
994 } else {
995 MYLOGW("Failed to dump visible windows\n");
996 }
997 unlink(path.c_str());
998}
999
Jayachandran Ca94c7172017-06-10 15:08:12 -07001000static void DumpIpTablesAsRoot() {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001001 RunCommand("IPTABLES", {"iptables", "-L", "-nvx"});
1002 RunCommand("IP6TABLES", {"ip6tables", "-L", "-nvx"});
Erik Kline32af8c22016-09-28 17:26:26 +09001003 RunCommand("IPTABLES NAT", {"iptables", "-t", "nat", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001004 /* no ip6 nat */
Erik Kline32af8c22016-09-28 17:26:26 +09001005 RunCommand("IPTABLES MANGLE", {"iptables", "-t", "mangle", "-L", "-nvx"});
1006 RunCommand("IP6TABLES MANGLE", {"ip6tables", "-t", "mangle", "-L", "-nvx"});
1007 RunCommand("IPTABLES RAW", {"iptables", "-t", "raw", "-L", "-nvx"});
1008 RunCommand("IP6TABLES RAW", {"ip6tables", "-t", "raw", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001009}
1010
David Andersond9ba4752018-12-11 18:26:59 -08001011static void DumpDynamicPartitionInfo() {
1012 if (!::android::base::GetBoolProperty("ro.boot.dynamic_partitions", false)) {
1013 return;
1014 }
1015
1016 RunCommand("LPDUMP", {"lpdump", "--all"});
David Anderson6650ade2019-10-02 15:18:59 -07001017 RunCommand("DEVICE-MAPPER", {"gsid", "dump-device-mapper"});
David Andersond9ba4752018-12-11 18:26:59 -08001018}
1019
Narayan Kamath8f788292017-05-25 13:20:39 +01001020static void AddAnrTraceDir(const bool add_to_zip, const std::string& anr_traces_dir) {
1021 MYLOGD("AddAnrTraceDir(): dump_traces_file=%s, anr_traces_dir=%s\n", dump_traces_path,
1022 anr_traces_dir.c_str());
1023
1024 // If we're here, dump_traces_path will always be a temporary file
1025 // (created with mkostemp or similar) that contains dumps taken earlier
1026 // on in the process.
1027 if (dump_traces_path != nullptr) {
1028 if (add_to_zip) {
1029 ds.AddZipEntry(ZIP_ROOT_DIR + anr_traces_dir + "/traces-just-now.txt", dump_traces_path);
1030 } else {
1031 MYLOGD("Dumping current ANR traces (%s) to the main bugreport entry\n",
1032 dump_traces_path);
1033 ds.DumpFile("VM TRACES JUST NOW", dump_traces_path);
1034 }
1035
1036 const int ret = unlink(dump_traces_path);
1037 if (ret == -1) {
1038 MYLOGW("Error unlinking temporary trace path %s: %s\n", dump_traces_path,
1039 strerror(errno));
Felipe Lemee184f662016-10-27 10:04:47 -07001040 }
1041 }
1042
Narayan Kamathbd863722017-06-01 18:50:12 +01001043 // Add a specific message for the first ANR Dump.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001044 if (ds.anr_data_.size() > 0) {
1045 AddDumps(ds.anr_data_.begin(), ds.anr_data_.begin() + 1,
Narayan Kamathbd863722017-06-01 18:50:12 +01001046 "VM TRACES AT LAST ANR", add_to_zip);
1047
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001048 // The "last" ANR will always be included as separate entry in the zip file. In addition,
1049 // it will be present in the body of the main entry if |add_to_zip| == false.
1050 //
1051 // Historical ANRs are always included as separate entries in the bugreport zip file.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001052 AddDumps(ds.anr_data_.begin() + ((add_to_zip) ? 1 : 0), ds.anr_data_.end(),
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001053 "HISTORICAL ANR", true /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001054 } else {
Narayan Kamath8f788292017-05-25 13:20:39 +01001055 printf("*** NO ANRs to dump in %s\n\n", ANR_DIR.c_str());
1056 }
1057}
1058
1059static void AddAnrTraceFiles() {
1060 const bool add_to_zip = ds.IsZipping() && ds.version_ == VERSION_SPLIT_ANR;
1061
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001062 std::string anr_traces_dir = "/data/anr";
Narayan Kamath8f788292017-05-25 13:20:39 +01001063
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001064 AddAnrTraceDir(add_to_zip, anr_traces_dir);
Narayan Kamath8f788292017-05-25 13:20:39 +01001065
Makoto Onuki83ec63f2019-01-31 17:08:59 -08001066 RunCommand("ANR FILES", {"ls", "-lt", ANR_DIR});
1067
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001068 // Slow traces for slow operations.
Felipe Lemee184f662016-10-27 10:04:47 -07001069 struct stat st;
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001070 int i = 0;
1071 while (true) {
1072 const std::string slow_trace_path =
1073 anr_traces_dir + android::base::StringPrintf("slow%02d.txt", i);
1074 if (stat(slow_trace_path.c_str(), &st)) {
1075 // No traces file at this index, done with the files.
1076 break;
Felipe Lemee184f662016-10-27 10:04:47 -07001077 }
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001078 ds.DumpFile("VM TRACES WHEN SLOW", slow_trace_path.c_str());
1079 i++;
Felipe Lemee184f662016-10-27 10:04:47 -07001080 }
1081}
1082
Wei Wang509bb5d2017-06-09 14:42:12 -07001083static void DumpBlockStatFiles() {
1084 DurationReporter duration_reporter("DUMP BLOCK STAT");
Wei Wang509bb5d2017-06-09 14:42:12 -07001085
Wei Wang1dc1ef52017-06-12 11:28:37 -07001086 std::unique_ptr<DIR, std::function<int(DIR*)>> dirptr(opendir(BLK_DEV_SYS_DIR), closedir);
1087
1088 if (dirptr == nullptr) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001089 MYLOGE("Failed to open %s: %s\n", BLK_DEV_SYS_DIR, strerror(errno));
1090 return;
1091 }
1092
1093 printf("------ DUMP BLOCK STAT ------\n\n");
Wei Wang1dc1ef52017-06-12 11:28:37 -07001094 while (struct dirent *d = readdir(dirptr.get())) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001095 if ((d->d_name[0] == '.')
1096 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
1097 || (d->d_name[1] == '\0'))) {
1098 continue;
1099 }
1100 const std::string new_path =
1101 android::base::StringPrintf("%s/%s", BLK_DEV_SYS_DIR, d->d_name);
1102 printf("------ BLOCK STAT (%s) ------\n", new_path.c_str());
1103 dump_files("", new_path.c_str(), skip_not_stat, dump_stat_from_fd);
1104 printf("\n");
1105 }
Wei Wang1dc1ef52017-06-12 11:28:37 -07001106 return;
Wei Wang509bb5d2017-06-09 14:42:12 -07001107}
Jayachandran Ca94c7172017-06-10 15:08:12 -07001108
1109static void DumpPacketStats() {
1110 DumpFile("NETWORK DEV INFO", "/proc/net/dev");
1111 DumpFile("QTAGUID NETWORK INTERFACES INFO", "/proc/net/xt_qtaguid/iface_stat_all");
1112 DumpFile("QTAGUID NETWORK INTERFACES INFO (xt)", "/proc/net/xt_qtaguid/iface_stat_fmt");
1113 DumpFile("QTAGUID CTRL INFO", "/proc/net/xt_qtaguid/ctrl");
1114 DumpFile("QTAGUID STATS INFO", "/proc/net/xt_qtaguid/stats");
1115}
1116
1117static void DumpIpAddrAndRules() {
1118 /* The following have a tendency to get wedged when wifi drivers/fw goes belly-up. */
1119 RunCommand("NETWORK INTERFACES", {"ip", "link"});
1120 RunCommand("IPv4 ADDRESSES", {"ip", "-4", "addr", "show"});
1121 RunCommand("IPv6 ADDRESSES", {"ip", "-6", "addr", "show"});
1122 RunCommand("IP RULES", {"ip", "rule", "show"});
1123 RunCommand("IP RULES v6", {"ip", "-6", "rule", "show"});
1124}
1125
Nandana Dutt5c390032019-03-12 10:52:56 +00001126static Dumpstate::RunStatus RunDumpsysTextByPriority(const std::string& title, int priority,
1127 std::chrono::milliseconds timeout,
1128 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001129 auto start = std::chrono::steady_clock::now();
Vishnu Naire97d6122018-01-18 13:58:56 -08001130 sp<android::IServiceManager> sm = defaultServiceManager();
1131 Dumpsys dumpsys(sm.get());
Vishnu Naire97d6122018-01-18 13:58:56 -08001132 Vector<String16> args;
1133 Dumpsys::setServiceArgs(args, /* asProto = */ false, priority);
Vishnu Naire97d6122018-01-18 13:58:56 -08001134 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ false);
1135 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001136 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001137 std::string path(title);
1138 path.append(" - ").append(String8(service).c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -08001139 size_t bytes_written = 0;
Steven Moreland5a30d342019-10-08 13:53:28 -07001140 status_t status = dumpsys.startDumpThread(Dumpsys::Type::DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001141 if (status == OK) {
1142 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1143 std::chrono::duration<double> elapsed_seconds;
1144 status = dumpsys.writeDump(STDOUT_FILENO, service, service_timeout,
1145 /* as_proto = */ false, elapsed_seconds, bytes_written);
Vishnu Naire97d6122018-01-18 13:58:56 -08001146 dumpsys.writeDumpFooter(STDOUT_FILENO, service, elapsed_seconds);
1147 bool dump_complete = (status == OK);
1148 dumpsys.stopDumpThread(dump_complete);
1149 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001150
1151 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1152 std::chrono::steady_clock::now() - start);
1153 if (elapsed_duration > timeout) {
1154 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1155 elapsed_duration.count());
1156 break;
1157 }
1158 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001159 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001160}
1161
Vishnu Nair64afc022018-02-01 15:29:34 -08001162static void RunDumpsysText(const std::string& title, int priority,
1163 std::chrono::milliseconds timeout,
1164 std::chrono::milliseconds service_timeout) {
1165 DurationReporter duration_reporter(title);
1166 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1167 fsync(STDOUT_FILENO);
1168 RunDumpsysTextByPriority(title, priority, timeout, service_timeout);
1169}
1170
1171/* Dump all services registered with Normal or Default priority. */
Nandana Dutt5c390032019-03-12 10:52:56 +00001172static Dumpstate::RunStatus RunDumpsysTextNormalPriority(const std::string& title,
1173 std::chrono::milliseconds timeout,
1174 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001175 DurationReporter duration_reporter(title);
1176 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1177 fsync(STDOUT_FILENO);
1178 RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_NORMAL, timeout,
1179 service_timeout);
Nandana Dutt5c390032019-03-12 10:52:56 +00001180
1181 RETURN_IF_USER_DENIED_CONSENT();
1182
1183 return RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_DEFAULT, timeout,
1184 service_timeout);
Vishnu Nair64afc022018-02-01 15:29:34 -08001185}
1186
Nandana Dutt5c390032019-03-12 10:52:56 +00001187static Dumpstate::RunStatus RunDumpsysProto(const std::string& title, int priority,
1188 std::chrono::milliseconds timeout,
1189 std::chrono::milliseconds service_timeout) {
Luis Hector Chavez1e27b082018-03-22 15:36:42 -07001190 if (!ds.IsZipping()) {
1191 MYLOGD("Not dumping %s because it's not a zipped bugreport\n", title.c_str());
Nandana Dutt5c390032019-03-12 10:52:56 +00001192 return Dumpstate::RunStatus::OK;
Luis Hector Chavez1e27b082018-03-22 15:36:42 -07001193 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001194 sp<android::IServiceManager> sm = defaultServiceManager();
1195 Dumpsys dumpsys(sm.get());
1196 Vector<String16> args;
1197 Dumpsys::setServiceArgs(args, /* asProto = */ true, priority);
1198 DurationReporter duration_reporter(title);
1199
1200 auto start = std::chrono::steady_clock::now();
1201 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ true);
1202 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001203 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001204 std::string path(kProtoPath);
1205 path.append(String8(service).c_str());
1206 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL) {
1207 path.append("_CRITICAL");
1208 } else if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH) {
1209 path.append("_HIGH");
1210 }
1211 path.append(kProtoExt);
Steven Moreland5a30d342019-10-08 13:53:28 -07001212 status_t status = dumpsys.startDumpThread(Dumpsys::Type::DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001213 if (status == OK) {
1214 status = ds.AddZipEntryFromFd(path, dumpsys.getDumpFd(), service_timeout);
1215 bool dumpTerminated = (status == OK);
1216 dumpsys.stopDumpThread(dumpTerminated);
1217 }
1218 ZipWriter::FileEntry file_entry;
1219 ds.zip_writer_->GetLastEntry(&file_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -08001220
1221 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1222 std::chrono::steady_clock::now() - start);
1223 if (elapsed_duration > timeout) {
1224 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1225 elapsed_duration.count());
1226 break;
1227 }
1228 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001229 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001230}
1231
Nandana Dutta7db6342018-11-21 14:53:34 +00001232// Runs dumpsys on services that must dump first and will take less than 100ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001233static Dumpstate::RunStatus RunDumpsysCritical() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001234 RunDumpsysText("DUMPSYS CRITICAL", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1235 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Nandana Dutt5c390032019-03-12 10:52:56 +00001236
1237 RETURN_IF_USER_DENIED_CONSENT();
1238
1239 return RunDumpsysProto("DUMPSYS CRITICAL PROTO", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1240 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Vishnu Nair780b1282017-10-10 13:57:24 -07001241}
1242
1243// Runs dumpsys on services that must dump first but can take up to 250ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001244static Dumpstate::RunStatus RunDumpsysHigh() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001245 // TODO meminfo takes ~10s, connectivity takes ~5sec to dump. They are both
1246 // high priority. Reduce timeout once they are able to dump in a shorter time or
1247 // moved to a parallel task.
1248 RunDumpsysText("DUMPSYS HIGH", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1249 /* timeout= */ 90s, /* service_timeout= */ 30s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001250
1251 RETURN_IF_USER_DENIED_CONSENT();
1252
1253 return RunDumpsysProto("DUMPSYS HIGH PROTO", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1254 /* timeout= */ 5s, /* service_timeout= */ 1s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001255}
1256
1257// Runs dumpsys on services that must dump but can take up to 10s to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001258static Dumpstate::RunStatus RunDumpsysNormal() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001259 RunDumpsysTextNormalPriority("DUMPSYS", /* timeout= */ 90s, /* service_timeout= */ 10s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001260
1261 RETURN_IF_USER_DENIED_CONSENT();
1262
1263 return RunDumpsysProto("DUMPSYS PROTO", IServiceManager::DUMP_FLAG_PRIORITY_NORMAL,
1264 /* timeout= */ 90s, /* service_timeout= */ 10s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001265}
1266
Steven Moreland44cd9482018-01-04 16:24:13 -08001267static void DumpHals() {
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001268 if (!ds.IsZipping()) {
1269 RunCommand("HARDWARE HALS", {"lshal", "-lVSietrpc", "--types=b,c,l,z", "--debug"},
1270 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build());
1271 return;
1272 }
1273 DurationReporter duration_reporter("DUMP HALS");
1274 RunCommand("HARDWARE HALS", {"lshal", "-lVSietrpc", "--types=b,c,l,z"},
Greg Kaiser3dfeda32019-05-16 10:32:51 -07001275 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build());
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001276
Steven Moreland44cd9482018-01-04 16:24:13 -08001277 using android::hidl::manager::V1_0::IServiceManager;
1278 using android::hardware::defaultServiceManager;
1279
1280 sp<IServiceManager> sm = defaultServiceManager();
1281 if (sm == nullptr) {
1282 MYLOGE("Could not retrieve hwservicemanager to dump hals.\n");
1283 return;
1284 }
1285
1286 auto ret = sm->list([&](const auto& interfaces) {
1287 for (const std::string& interface : interfaces) {
1288 std::string cleanName = interface;
1289 std::replace_if(cleanName.begin(),
1290 cleanName.end(),
1291 [](char c) {
1292 return !isalnum(c) &&
1293 std::string("@-_:.").find(c) == std::string::npos;
1294 }, '_');
Nandana Dutt979388e2018-11-30 16:48:55 +00001295 const std::string path = ds.bugreport_internal_dir_ + "/lshal_debug_" + cleanName;
Steven Moreland44cd9482018-01-04 16:24:13 -08001296
1297 {
1298 auto fd = android::base::unique_fd(
1299 TEMP_FAILURE_RETRY(open(path.c_str(),
1300 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1301 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1302 if (fd < 0) {
1303 MYLOGE("Could not open %s to dump additional hal information.\n", path.c_str());
1304 continue;
1305 }
1306 RunCommandToFd(fd,
1307 "",
Steven Morelandc81cd3c2018-01-18 14:36:26 -08001308 {"lshal", "debug", "-E", interface},
Steven Moreland44cd9482018-01-04 16:24:13 -08001309 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
1310
1311 bool empty = 0 == lseek(fd, 0, SEEK_END);
1312 if (!empty) {
1313 ds.AddZipEntry("lshal-debug/" + cleanName + ".txt", path);
1314 }
1315 }
1316
1317 unlink(path.c_str());
1318 }
1319 });
1320
1321 if (!ret.isOk()) {
1322 MYLOGE("Could not list hals from hwservicemanager.\n");
1323 }
1324}
1325
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001326static void DumpExternalFragmentationInfo() {
1327 struct stat st;
1328 if (stat("/proc/buddyinfo", &st) != 0) {
1329 MYLOGE("Unable to dump external fragmentation info\n");
1330 return;
1331 }
1332
1333 printf("------ EXTERNAL FRAGMENTATION INFO ------\n");
1334 std::ifstream ifs("/proc/buddyinfo");
1335 auto unusable_index_regex = std::regex{"Node\\s+([0-9]+),\\s+zone\\s+(\\S+)\\s+(.*)"};
1336 for (std::string line; std::getline(ifs, line);) {
1337 std::smatch match_results;
1338 if (std::regex_match(line, match_results, unusable_index_regex)) {
1339 std::stringstream free_pages(std::string{match_results[3]});
1340 std::vector<int> free_pages_per_order(std::istream_iterator<int>{free_pages},
1341 std::istream_iterator<int>());
1342
1343 int total_free_pages = 0;
1344 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1345 total_free_pages += (free_pages_per_order[i] * std::pow(2, i));
1346 }
1347
1348 printf("Node %s, zone %8s", match_results[1].str().c_str(),
1349 match_results[2].str().c_str());
1350
1351 int usable_free_pages = total_free_pages;
1352 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1353 auto unusable_index = (total_free_pages - usable_free_pages) /
1354 static_cast<double>(total_free_pages);
1355 printf(" %5.3f", unusable_index);
1356 usable_free_pages -= (free_pages_per_order[i] * std::pow(2, i));
1357 }
1358
1359 printf("\n");
1360 }
1361 }
1362 printf("\n");
1363}
1364
Nandana Dutt5c390032019-03-12 10:52:56 +00001365// Dumps various things. Returns early with status USER_CONSENT_DENIED if user denies consent
1366// via the consent they are shown. Ignores other errors that occur while running various
1367// commands. The consent checking is currently done around long running tasks, which happen to
1368// be distributed fairly evenly throughout the function.
1369static Dumpstate::RunStatus dumpstate() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001370 DurationReporter duration_reporter("DUMPSTATE");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001371
Nandana Dutt5c390032019-03-12 10:52:56 +00001372 // Dump various things. Note that anything that takes "long" (i.e. several seconds) should
1373 // check intermittently (if it's intrerruptable like a foreach on pids) and/or should be wrapped
1374 // in a consent check (via RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK).
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -07001375 dump_dev_files("TRUSTY VERSION", "/sys/bus/platform/drivers/trusty", "trusty_version");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001376 RunCommand("UPTIME", {"uptime"});
Wei Wang509bb5d2017-06-09 14:42:12 -07001377 DumpBlockStatFiles();
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001378 DumpFile("MEMORY INFO", "/proc/meminfo");
1379 RunCommand("CPU INFO", {"top", "-b", "-n", "1", "-H", "-s", "6", "-o",
Felipe Leme30dbfa12016-09-02 12:43:26 -07001380 "pid,tid,user,pr,ni,%cpu,s,virt,res,pcy,cmd,name"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001381
1382 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "PROCRANK", {"procrank"}, AS_ROOT_20);
1383
Sunny Goyal35949782019-11-19 15:54:36 -08001384 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpVisibleWindowViews);
1385
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001386 DumpFile("VIRTUAL MEMORY STATS", "/proc/vmstat");
1387 DumpFile("VMALLOC INFO", "/proc/vmallocinfo");
1388 DumpFile("SLAB INFO", "/proc/slabinfo");
1389 DumpFile("ZONEINFO", "/proc/zoneinfo");
1390 DumpFile("PAGETYPEINFO", "/proc/pagetypeinfo");
1391 DumpFile("BUDDYINFO", "/proc/buddyinfo");
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001392 DumpExternalFragmentationInfo();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001393
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001394 DumpFile("KERNEL WAKE SOURCES", "/d/wakeup_sources");
1395 DumpFile("KERNEL CPUFREQ", "/sys/devices/system/cpu/cpu0/cpufreq/stats/time_in_state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001396
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001397 RunCommand("PROCESSES AND THREADS",
Yohei Yukawa591a72d2017-10-05 21:36:35 -07001398 {"ps", "-A", "-T", "-Z", "-O", "pri,nice,rtprio,sched,pcy,time"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001399
1400 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "LIBRANK", {"librank"},
1401 CommandOptions::AS_ROOT);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001402
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001403 DumpHals();
Steven Moreland81b429e2017-01-31 19:50:46 -08001404
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001405 RunCommand("PRINTENV", {"printenv"});
Elliott Hughes21b7c8d2016-10-28 08:53:02 -07001406 RunCommand("NETSTAT", {"netstat", "-nW"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001407 struct stat s;
1408 if (stat("/proc/modules", &s) != 0) {
1409 MYLOGD("Skipping 'lsmod' because /proc/modules does not exist\n");
1410 } else {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001411 RunCommand("LSMOD", {"lsmod"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001412 }
Michal Karpinski4db754f2015-12-11 18:04:32 +00001413
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001414 if (__android_logger_property_get_bool(
1415 "ro.logd.kernel", BOOL_DEFAULT_TRUE | BOOL_DEFAULT_FLAG_ENG | BOOL_DEFAULT_FLAG_SVELTE)) {
1416 DoKernelLogcat();
1417 } else {
1418 do_dmesg();
1419 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001420
Felipe Lemef0292972016-11-22 13:57:05 -08001421 RunCommand("LIST OF OPEN FILES", {"lsof"}, CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001422
1423 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(for_each_pid, do_showmap, "SMAPS OF ALL PROCESSES");
1424
Jeff Brown1dc94e32014-09-11 14:15:27 -07001425 for_each_tid(show_wchan, "BLOCKED PROCESS WAIT-CHANNELS");
Mark Salyzyna297c322016-02-05 15:33:17 -08001426 for_each_pid(show_showtime, "PROCESS TIMES (pid cmd user system iowait+percentage)");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001427
Ajay Panicker2ff8e872017-04-27 14:04:32 -07001428 /* Dump Bluetooth HCI logs */
1429 ds.AddDir("/data/misc/bluetooth/logs", true);
Ajay Panickerd886ec42016-09-14 12:26:46 -07001430
Paul Chang0d2aad72020-02-13 20:04:03 +08001431 if (ds.options_->do_screenshot && !ds.do_early_screenshot_) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001432 MYLOGI("taking late screenshot\n");
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001433 ds.TakeScreenshot();
Jeff Sharkey5a930032013-03-19 15:05:19 -07001434 }
1435
Felipe Lemee184f662016-10-27 10:04:47 -07001436 AddAnrTraceFiles();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001437
Narayan Kamath8f788292017-05-25 13:20:39 +01001438 // NOTE: tombstones are always added as separate entries in the zip archive
1439 // and are not interspersed with the main report.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001440 const bool tombstones_dumped = AddDumps(ds.tombstone_data_.begin(), ds.tombstone_data_.end(),
Narayan Kamathbd863722017-06-01 18:50:12 +01001441 "TOMBSTONE", true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001442 if (!tombstones_dumped) {
1443 printf("*** NO TOMBSTONES to dump in %s\n\n", TOMBSTONE_DIR.c_str());
Christopher Ferris7dc7f322014-07-22 16:08:19 -07001444 }
1445
Jayachandran Ca94c7172017-06-10 15:08:12 -07001446 DumpPacketStats();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001447
Chenbo Feng276a3b62018-08-07 11:44:49 -07001448 RunDumpsys("EBPF MAP STATS", {"netd", "trafficcontroller"});
1449
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001450 DoKmsg();
Mark Salyzyn2262c162014-12-16 09:09:26 -08001451
Jayachandran Ca94c7172017-06-10 15:08:12 -07001452 DumpIpAddrAndRules();
Sreeram Ramachandran2b3bba32014-07-08 15:40:55 -07001453
1454 dump_route_tables();
1455
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001456 RunCommand("ARP CACHE", {"ip", "-4", "neigh", "show"});
1457 RunCommand("IPv6 ND CACHE", {"ip", "-6", "neigh", "show"});
1458 RunCommand("MULTICAST ADDRESSES", {"ip", "maddr"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001459
Nandana Dutt5c390032019-03-12 10:52:56 +00001460 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysHigh);
Lorenzo Colitti6afc38c2015-09-09 22:59:25 +09001461
Elliott Hughes23ccc622017-02-28 10:14:22 -08001462 RunCommand("SYSTEM PROPERTIES", {"getprop"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001463
Jin Qianf334d662017-10-10 14:41:37 -07001464 RunCommand("STORAGED IO INFO", {"storaged", "-u", "-p"});
ynwangf649a6e2016-07-17 21:56:00 -07001465
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001466 RunCommand("FILESYSTEMS & FREE SPACE", {"df"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001467
Colin Crossf45fa6b2012-03-26 12:38:26 -07001468 /* Binder state is expensive to look at as it uses a lot of memory. */
Hridya Valsaraju920ba712020-02-09 16:27:01 -08001469 std::string binder_logs_dir = access("/dev/binderfs/binder_logs", R_OK) ?
1470 "/sys/kernel/debug/binder" : "/dev/binderfs/binder_logs";
1471
1472 DumpFile("BINDER FAILED TRANSACTION LOG", binder_logs_dir + "/failed_transaction_log");
1473 DumpFile("BINDER TRANSACTION LOG", binder_logs_dir + "/transaction_log");
1474 DumpFile("BINDER TRANSACTIONS", binder_logs_dir + "/transactions");
1475 DumpFile("BINDER STATS", binder_logs_dir + "/stats");
1476 DumpFile("BINDER STATE", binder_logs_dir + "/state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001477
Vishnu Nair36b4cdb2017-11-17 10:27:05 -08001478 /* Add window and surface trace files. */
1479 if (!PropertiesHelper::IsUserBuild()) {
1480 ds.AddDir(WMTRACE_DATA_DIR, false);
1481 }
1482
Yifan Hongd90cc652020-02-08 16:52:02 -08001483 ds.AddDir(SNAPSHOTCTL_LOG_DIR, false);
1484
Nandana Dutt5c390032019-03-12 10:52:56 +00001485 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(ds.DumpstateBoard);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001486
Steven Moreland7440ddb2016-12-15 16:13:39 -08001487 /* Migrate the ril_dumpstate to a device specific dumpstate? */
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001488 int rilDumpstateTimeout = android::base::GetIntProperty("ril.dumpstate.timeout", 0);
1489 if (rilDumpstateTimeout > 0) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001490 // su does not exist on user builds, so try running without it.
1491 // This way any implementations of vril-dump that do not require
1492 // root can run on user builds.
1493 CommandOptions::CommandOptionsBuilder options =
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001494 CommandOptions::WithTimeout(rilDumpstateTimeout);
Felipe Lemef0292972016-11-22 13:57:05 -08001495 if (!PropertiesHelper::IsUserBuild()) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001496 options.AsRoot();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001497 }
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001498 RunCommand("DUMP VENDOR RIL LOGS", {"vril-dump"}, options.Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -07001499 }
1500
Felipe Lemed8b94e52016-12-08 10:21:44 -08001501 printf("========================================================\n");
1502 printf("== Android Framework Services\n");
1503 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001504
Nandana Dutt5c390032019-03-12 10:52:56 +00001505 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysNormal);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001506
Felipe Lemed8b94e52016-12-08 10:21:44 -08001507 printf("========================================================\n");
1508 printf("== Checkins\n");
1509 printf("========================================================\n");
Dianne Hackborn02bea972013-06-26 18:59:09 -07001510
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001511 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001512
1513 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsys, "CHECKIN MEMINFO", {"meminfo", "--checkin"});
1514
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001515 RunDumpsys("CHECKIN NETSTATS", {"netstats", "--checkin"});
1516 RunDumpsys("CHECKIN PROCSTATS", {"procstats", "-c"});
1517 RunDumpsys("CHECKIN USAGESTATS", {"usagestats", "-c"});
1518 RunDumpsys("CHECKIN PACKAGE", {"package", "--checkin"});
Dianne Hackborn02bea972013-06-26 18:59:09 -07001519
Felipe Lemed8b94e52016-12-08 10:21:44 -08001520 printf("========================================================\n");
1521 printf("== Running Application Activities\n");
1522 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001523
Makoto Onuki60780982018-04-16 15:34:00 -07001524 // The following dumpsys internally collects output from running apps, so it can take a long
1525 // time. So let's extend the timeout.
1526
1527 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
1528
1529 RunDumpsys("APP ACTIVITIES", {"activity", "-v", "all"}, DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001530
Felipe Lemed8b94e52016-12-08 10:21:44 -08001531 printf("========================================================\n");
Makoto Onuki60780982018-04-16 15:34:00 -07001532 printf("== Running Application Services (platform)\n");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001533 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001534
Vishnu Nairc6e6ea72018-07-02 14:20:06 -07001535 RunDumpsys("APP SERVICES PLATFORM", {"activity", "service", "all-platform-non-critical"},
Makoto Onuki60780982018-04-16 15:34:00 -07001536 DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001537
Felipe Lemed8b94e52016-12-08 10:21:44 -08001538 printf("========================================================\n");
Makoto Onuki60780982018-04-16 15:34:00 -07001539 printf("== Running Application Services (non-platform)\n");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001540 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001541
Makoto Onuki60780982018-04-16 15:34:00 -07001542 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1543 DUMPSYS_COMPONENTS_OPTIONS);
1544
1545 printf("========================================================\n");
1546 printf("== Running Application Providers (platform)\n");
1547 printf("========================================================\n");
1548
1549 RunDumpsys("APP PROVIDERS PLATFORM", {"activity", "provider", "all-platform"},
1550 DUMPSYS_COMPONENTS_OPTIONS);
1551
1552 printf("========================================================\n");
1553 printf("== Running Application Providers (non-platform)\n");
1554 printf("========================================================\n");
1555
1556 RunDumpsys("APP PROVIDERS NON-PLATFORM", {"activity", "provider", "all-non-platform"},
1557 DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001558
Adrian Roos8b397ab2017-04-04 16:35:44 -07001559 printf("========================================================\n");
1560 printf("== Dropbox crashes\n");
1561 printf("========================================================\n");
1562
1563 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1564 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1565
Felipe Lemed8b94e52016-12-08 10:21:44 -08001566 printf("========================================================\n");
1567 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1568 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1569 printf("========================================================\n");
1570 printf("== dumpstate: done (id %d)\n", ds.id_);
1571 printf("========================================================\n");
Bookatz38472142018-09-28 10:20:24 -07001572
1573 printf("========================================================\n");
1574 printf("== Obtaining statsd metadata\n");
1575 printf("========================================================\n");
1576 // This differs from the usual dumpsys stats, which is the stats report data.
1577 RunDumpsys("STATSDSTATS", {"stats", "--metadata"});
Mike Ma5c267872019-08-21 11:31:34 -07001578
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +09001579 // Add linker configuration directory
1580 ds.AddDir(LINKERCONFIG_DIR, true);
1581
Mike Ma5c267872019-08-21 11:31:34 -07001582 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpIncidentReport);
1583
Nandana Dutt5c390032019-03-12 10:52:56 +00001584 return Dumpstate::RunStatus::OK;
Colin Crossf45fa6b2012-03-26 12:38:26 -07001585}
1586
Nandana Dutt5c390032019-03-12 10:52:56 +00001587/*
1588 * Dumps state for the default case; drops root after it's no longer necessary.
1589 *
1590 * Returns RunStatus::OK if everything went fine.
1591 * Returns RunStatus::ERROR if there was an error.
1592 * Returns RunStatus::USER_DENIED_CONSENT if user explicitly denied consent to sharing the bugreport
1593 * with the caller.
1594 */
Jichao Lie89d9c12019-11-21 19:02:51 -08001595Dumpstate::RunStatus Dumpstate::DumpstateDefaultAfterCritical() {
Nandana Duttdb379fa2019-10-09 16:54:41 +01001596 // Capture first logcat early on; useful to take a snapshot before dumpstate logs take over the
1597 // buffer.
1598 DoLogcat();
1599 // Capture timestamp after first logcat to use in next logcat
1600 time_t logcat_ts = time(nullptr);
1601
Nandana Dutt4be45d12018-09-26 15:04:23 +01001602 /* collect stack traces from Dalvik and native processes (needs root) */
Nandana Duttcf419a72019-03-14 10:40:17 +00001603 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(ds.DumpTraces, &dump_traces_path);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001604
1605 /* Run some operations that require root. */
1606 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX, !ds.IsZipping());
1607 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX, !ds.IsZipping());
1608
1609 ds.AddDir(RECOVERY_DIR, true);
1610 ds.AddDir(RECOVERY_DATA_DIR, true);
1611 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
1612 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1613 if (!PropertiesHelper::IsUserBuild()) {
1614 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1615 ds.AddDir(PROFILE_DATA_DIR_REF, true);
Calin Juravlef84d3692020-04-28 15:31:12 -07001616 ds.AddZipEntry(ZIP_ROOT_DIR + PACKAGE_DEX_USE_LIST, PACKAGE_DEX_USE_LIST);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001617 }
Jerry Changa1df8a92020-01-02 16:03:39 +08001618 ds.AddDir(PREREBOOT_DATA_DIR, false);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001619 add_mountinfo();
1620 DumpIpTablesAsRoot();
David Andersond9ba4752018-12-11 18:26:59 -08001621 DumpDynamicPartitionInfo();
Yifan Hong3945e1b2019-10-29 12:59:23 -07001622 ds.AddDir(OTA_METADATA_DIR, true);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001623
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001624 // Capture any IPSec policies in play. No keys are exposed here.
Nandana Dutt4be45d12018-09-26 15:04:23 +01001625 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1626
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001627 // Dump IPsec stats. No keys are exposed here.
1628 DumpFile("XFRM STATS", XFRM_STAT_PROC_FILE);
1629
Nandana Dutt4be45d12018-09-26 15:04:23 +01001630 // Run ss as root so we can see socket marks.
1631 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
1632
1633 // Run iotop as root to show top 100 IO threads
1634 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
1635
Erick Reyese68df822019-02-11 14:46:36 -08001636 // Gather shared memory buffer info if the product implements it
1637 struct stat st;
1638 if (!stat("/product/bin/dmabuf_dump", &st)) {
1639 RunCommand("Dmabuf dump", {"/product/bin/dmabuf_dump"});
1640 }
1641
Minchan Kim22c6a1e2019-09-30 15:58:10 -07001642 DumpFile("PSI cpu", "/proc/pressure/cpu");
1643 DumpFile("PSI memory", "/proc/pressure/memory");
1644 DumpFile("PSI io", "/proc/pressure/io");
1645
Nandana Dutt4be45d12018-09-26 15:04:23 +01001646 if (!DropRootUser()) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001647 return Dumpstate::RunStatus::ERROR;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001648 }
1649
Nandana Dutt5c390032019-03-12 10:52:56 +00001650 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttdb379fa2019-10-09 16:54:41 +01001651 Dumpstate::RunStatus status = dumpstate();
1652 // Capture logcat since the last time we did it.
1653 DoSystemLogcat(logcat_ts);
1654 return status;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001655}
1656
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001657// This method collects common dumpsys for telephony and wifi. Typically, wifi
1658// reports are fine to include all information, but telephony reports on user
1659// builds need to strip some content (see DumpstateTelephonyOnly).
1660static void DumpstateRadioCommon(bool include_sensitive_info = true) {
Jayachandran Ca94c7172017-06-10 15:08:12 -07001661 DumpIpTablesAsRoot();
1662
Jayachandran Cb4389d92019-07-08 09:46:05 -07001663 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1664
Jayachandran Ca94c7172017-06-10 15:08:12 -07001665 if (!DropRootUser()) {
1666 return;
1667 }
1668
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001669 // We need to be picky about some stuff for telephony reports on user builds.
1670 if (!include_sensitive_info) {
1671 // Only dump the radio log buffer (other buffers and dumps contain too much unrelated info).
1672 DoRadioLogcat();
1673 } else {
1674 // Contains various system properties and process startup info.
1675 do_dmesg();
1676 // Logs other than the radio buffer may contain package/component names and potential PII.
1677 DoLogcat();
1678 // Too broad for connectivity problems.
1679 DoKmsg();
1680 // Contains unrelated hardware info (camera, NFC, biometrics, ...).
1681 DumpHals();
1682 }
1683
Jayachandran Ca94c7172017-06-10 15:08:12 -07001684 DumpPacketStats();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001685 DumpIpAddrAndRules();
1686 dump_route_tables();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001687 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
1688 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08001689}
1690
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001691// We use "telephony" here for legacy reasons, though this now really means "connectivity" (cellular
1692// + wifi + networking). This method collects dumpsys for connectivity debugging only. General rules
1693// for what can be included on user builds: all reported information MUST directly relate to
1694// connectivity debugging or customer support and MUST NOT contain unrelated personally identifiable
1695// information. This information MUST NOT identify user-installed packages (UIDs are OK, package
1696// names are not), and MUST NOT contain logs of user application traffic.
1697// TODO(b/148168577) rename this and other related fields/methods to "connectivity" instead.
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08001698static void DumpstateTelephonyOnly(const std::string& calling_package) {
mukesh agrawal253dad42018-01-23 21:59:59 -08001699 DurationReporter duration_reporter("DUMPSTATE");
Jichao Lie89d9c12019-11-21 19:02:51 -08001700
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001701 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08001702
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001703 const bool include_sensitive_info = !PropertiesHelper::IsUserBuild();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001704
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001705 DumpstateRadioCommon(include_sensitive_info);
1706
1707 if (include_sensitive_info) {
1708 // Contains too much unrelated PII, and given the unstructured nature of sysprops, we can't
1709 // really cherrypick all of the connectivity-related ones. Apps generally have no business
1710 // reading these anyway, and there should be APIs to supply the info in a more app-friendly
1711 // way.
1712 RunCommand("SYSTEM PROPERTIES", {"getprop"});
1713 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07001714
1715 printf("========================================================\n");
1716 printf("== Android Framework Services\n");
1717 printf("========================================================\n");
1718
Vishnu Nair652cc802017-11-30 15:18:30 -08001719 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1720 SEC_TO_MSEC(10));
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08001721 if (include_sensitive_info) {
1722 // Carrier apps' services will be dumped below in dumpsys activity service all-non-platform.
1723 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
1724 SEC_TO_MSEC(10));
1725 } else {
1726 // If the caller is a carrier app and has a carrier service, dump it here since we aren't
1727 // running dumpsys activity service all-non-platform below. Due to the increased output, we
1728 // give a higher timeout as well.
1729 RunDumpsys("DUMPSYS", {"carrier_config", "--requesting-package", calling_package},
1730 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(30));
1731 }
1732 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001733 RunDumpsys("DUMPSYS", {"netpolicy"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
1734 RunDumpsys("DUMPSYS", {"network_management"}, CommandOptions::WithTimeout(90).Build(),
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07001735 SEC_TO_MSEC(10));
Hunter Knepshield0fe51b12020-03-05 16:58:20 -08001736 RunDumpsys("DUMPSYS", {"telephony.registry"}, CommandOptions::WithTimeout(90).Build(),
1737 SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001738 if (include_sensitive_info) {
1739 // Contains raw IP addresses, omit from reports on user builds.
1740 RunDumpsys("DUMPSYS", {"netd"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
1741 // Contains raw destination IP/MAC addresses, omit from reports on user builds.
1742 RunDumpsys("DUMPSYS", {"connmetrics"}, CommandOptions::WithTimeout(90).Build(),
1743 SEC_TO_MSEC(10));
1744 // Contains package/component names, omit from reports on user builds.
1745 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
1746 SEC_TO_MSEC(10));
1747 // Contains package names, but should be relatively simple to remove them (also contains
1748 // UIDs already), omit from reports on user builds.
1749 RunDumpsys("BATTERYSTATS", {"deviceidle"}, CommandOptions::WithTimeout(90).Build(),
1750 SEC_TO_MSEC(10));
1751 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07001752
1753 printf("========================================================\n");
1754 printf("== Running Application Services\n");
1755 printf("========================================================\n");
1756
1757 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
1758
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001759 if (include_sensitive_info) {
1760 printf("========================================================\n");
1761 printf("== Running Application Services (non-platform)\n");
1762 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001763
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001764 // Contains package/component names and potential PII, omit from reports on user builds.
1765 // To get dumps of the active CarrierService(s) on user builds, we supply an argument to the
1766 // carrier_config dumpsys instead.
1767 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1768 DUMPSYS_COMPONENTS_OPTIONS);
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001769
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001770 printf("========================================================\n");
1771 printf("== Checkins\n");
1772 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07001773
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001774 // Contains package/component names, omit from reports on user builds.
1775 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
1776 }
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07001777
1778 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07001779 printf("== dumpstate: done (id %d)\n", ds.id_);
1780 printf("========================================================\n");
1781}
1782
mukesh agrawal253dad42018-01-23 21:59:59 -08001783// This method collects dumpsys for wifi debugging only
1784static void DumpstateWifiOnly() {
1785 DurationReporter duration_reporter("DUMPSTATE");
1786
1787 DumpstateRadioCommon();
1788
1789 printf("========================================================\n");
1790 printf("== Android Framework Services\n");
1791 printf("========================================================\n");
1792
1793 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1794 SEC_TO_MSEC(10));
1795 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
1796 SEC_TO_MSEC(10));
1797
1798 printf("========================================================\n");
1799 printf("== dumpstate: done (id %d)\n", ds.id_);
1800 printf("========================================================\n");
1801}
1802
Nandana Duttcf419a72019-03-14 10:40:17 +00001803Dumpstate::RunStatus Dumpstate::DumpTraces(const char** path) {
Nandana Duttfaafd522019-03-11 09:23:09 +00001804 DurationReporter duration_reporter("DUMP TRACES");
1805
1806 const std::string temp_file_pattern = "/data/anr/dumptrace_XXXXXX";
1807 const size_t buf_size = temp_file_pattern.length() + 1;
1808 std::unique_ptr<char[]> file_name_buf(new char[buf_size]);
1809 memcpy(file_name_buf.get(), temp_file_pattern.c_str(), buf_size);
1810
1811 // Create a new, empty file to receive all trace dumps.
1812 //
1813 // TODO: This can be simplified once we remove support for the old style
1814 // dumps. We can have a file descriptor passed in to dump_traces instead
1815 // of creating a file, closing it and then reopening it again.
1816 android::base::unique_fd fd(mkostemp(file_name_buf.get(), O_APPEND | O_CLOEXEC));
1817 if (fd < 0) {
1818 MYLOGE("mkostemp on pattern %s: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001819 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001820 }
1821
1822 // Nobody should have access to this temporary file except dumpstate, but we
1823 // temporarily grant 'read' to 'others' here because this file is created
1824 // when tombstoned is still running as root, but dumped after dropping. This
1825 // can go away once support for old style dumping has.
1826 const int chmod_ret = fchmod(fd, 0666);
1827 if (chmod_ret < 0) {
1828 MYLOGE("fchmod on %s failed: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001829 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001830 }
1831
1832 std::unique_ptr<DIR, decltype(&closedir)> proc(opendir("/proc"), closedir);
1833 if (proc.get() == nullptr) {
1834 MYLOGE("opendir /proc failed: %s\n", strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001835 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001836 }
1837
1838 // Number of times process dumping has timed out. If we encounter too many
1839 // failures, we'll give up.
1840 int timeout_failures = 0;
1841 bool dalvik_found = false;
1842
1843 const std::set<int> hal_pids = get_interesting_hal_pids();
1844
1845 struct dirent* d;
1846 while ((d = readdir(proc.get()))) {
Nandana Duttcf419a72019-03-14 10:40:17 +00001847 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttfaafd522019-03-11 09:23:09 +00001848 int pid = atoi(d->d_name);
1849 if (pid <= 0) {
1850 continue;
1851 }
1852
1853 const std::string link_name = android::base::StringPrintf("/proc/%d/exe", pid);
1854 std::string exe;
1855 if (!android::base::Readlink(link_name, &exe)) {
1856 continue;
1857 }
1858
1859 bool is_java_process;
1860 if (exe == "/system/bin/app_process32" || exe == "/system/bin/app_process64") {
1861 // Don't bother dumping backtraces for the zygote.
1862 if (IsZygote(pid)) {
1863 continue;
1864 }
1865
1866 dalvik_found = true;
1867 is_java_process = true;
1868 } else if (should_dump_native_traces(exe.c_str()) || hal_pids.find(pid) != hal_pids.end()) {
1869 is_java_process = false;
1870 } else {
1871 // Probably a native process we don't care about, continue.
1872 continue;
1873 }
1874
1875 // If 3 backtrace dumps fail in a row, consider debuggerd dead.
1876 if (timeout_failures == 3) {
1877 dprintf(fd, "ERROR: Too many stack dump failures, exiting.\n");
1878 break;
1879 }
1880
1881 const uint64_t start = Nanotime();
1882 const int ret = dump_backtrace_to_file_timeout(
1883 pid, is_java_process ? kDebuggerdJavaBacktrace : kDebuggerdNativeBacktrace,
1884 is_java_process ? 5 : 20, fd);
1885
1886 if (ret == -1) {
1887 // For consistency, the header and footer to this message match those
1888 // dumped by debuggerd in the success case.
1889 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
1890 dprintf(fd, "Dump failed, likely due to a timeout.\n");
1891 dprintf(fd, "---- end %d ----", pid);
1892 timeout_failures++;
1893 continue;
1894 }
1895
1896 // We've successfully dumped stack traces, reset the failure count
1897 // and write a summary of the elapsed time to the file and continue with the
1898 // next process.
1899 timeout_failures = 0;
1900
1901 dprintf(fd, "[dump %s stack %d: %.3fs elapsed]\n", is_java_process ? "dalvik" : "native",
1902 pid, (float)(Nanotime() - start) / NANOS_PER_SEC);
1903 }
1904
1905 if (!dalvik_found) {
1906 MYLOGE("Warning: no Dalvik processes found to dump stacks\n");
1907 }
1908
Nandana Duttcf419a72019-03-14 10:40:17 +00001909 *path = file_name_buf.release();
1910 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001911}
1912
Felipe Leme6f674ae2016-11-18 17:10:33 -08001913void Dumpstate::DumpstateBoard() {
1914 DurationReporter duration_reporter("dumpstate_board()");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001915 printf("========================================================\n");
1916 printf("== Board\n");
1917 printf("========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001918
Felipe Leme6f674ae2016-11-18 17:10:33 -08001919 if (!IsZipping()) {
Steven Moreland7440ddb2016-12-15 16:13:39 -08001920 MYLOGD("Not dumping board info because it's not a zipped bugreport\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001921 return;
1922 }
1923
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001924 std::vector<std::string> paths;
1925 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07001926 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00001927 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
1928 kDumpstateBoardFiles[i].c_str()));
Nandana Dutt16d1aee2019-02-15 16:13:53 +00001929 remover.emplace_back(android::base::make_scope_guard(
1930 std::bind([](std::string path) { android::os::UnlinkAndLogOnError(path); }, paths[i])));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001931 }
Jie Song9fbfad02017-06-20 16:29:42 -07001932
Hunter Knepshield8540faf2020-02-04 19:47:20 -08001933 sp<IDumpstateDevice_1_0> dumpstate_device_1_0(IDumpstateDevice_1_0::getService());
1934 if (dumpstate_device_1_0 == nullptr) {
Wei Wang587eac92018-04-05 12:17:20 -07001935 MYLOGE("No IDumpstateDevice implementation\n");
1936 return;
1937 }
1938
1939 using ScopedNativeHandle =
1940 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
1941 ScopedNativeHandle handle(native_handle_create(static_cast<int>(paths.size()), 0),
1942 [](native_handle_t* handle) {
1943 native_handle_close(handle);
1944 native_handle_delete(handle);
1945 });
1946 if (handle == nullptr) {
1947 MYLOGE("Could not create native_handle\n");
1948 return;
1949 }
1950
Nandana Dutt5c390032019-03-12 10:52:56 +00001951 // TODO(128270426): Check for consent in between?
Wei Wang587eac92018-04-05 12:17:20 -07001952 for (size_t i = 0; i < paths.size(); i++) {
1953 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
1954
1955 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
1956 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1957 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1958 if (fd < 0) {
1959 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
1960 return;
1961 }
1962 handle.get()->data[i] = fd.release();
1963 }
1964
Hunter Knepshield8540faf2020-02-04 19:47:20 -08001965 // Given that bugreport is required to diagnose failures, it's better to set an arbitrary amount
1966 // of timeout for IDumpstateDevice than to block the rest of bugreport. In the timeout case, we
1967 // will kill the HAL and grab whatever it dumped in time.
1968 constexpr size_t timeout_sec = 30;
1969 // Prefer version 1.1 if available. New devices launching with R are no longer allowed to
1970 // implement just 1.0.
1971 const char* descriptor_to_kill;
1972 using DumpstateBoardTask = std::packaged_task<bool()>;
1973 DumpstateBoardTask dumpstate_board_task;
1974 sp<IDumpstateDevice_1_1> dumpstate_device_1_1(
1975 IDumpstateDevice_1_1::castFrom(dumpstate_device_1_0));
1976 if (dumpstate_device_1_1 != nullptr) {
1977 MYLOGI("Using IDumpstateDevice v1.1");
1978 descriptor_to_kill = IDumpstateDevice_1_1::descriptor;
1979 dumpstate_board_task = DumpstateBoardTask([this, dumpstate_device_1_1, &handle]() -> bool {
1980 ::android::hardware::Return<DumpstateStatus> status =
1981 dumpstate_device_1_1->dumpstateBoard_1_1(handle.get(), options_->dumpstate_hal_mode,
1982 SEC_TO_MSEC(timeout_sec));
1983 if (!status.isOk()) {
1984 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
1985 return false;
1986 } else if (status != DumpstateStatus::OK) {
1987 MYLOGE("dumpstateBoard failed with DumpstateStatus::%s\n", toString(status).c_str());
1988 return false;
1989 }
1990 return true;
1991 });
1992 } else {
1993 MYLOGI("Using IDumpstateDevice v1.0");
1994 descriptor_to_kill = IDumpstateDevice_1_0::descriptor;
1995 dumpstate_board_task = DumpstateBoardTask([dumpstate_device_1_0, &handle]() -> bool {
1996 ::android::hardware::Return<void> status =
1997 dumpstate_device_1_0->dumpstateBoard(handle.get());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001998 if (!status.isOk()) {
1999 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
Wei Wang587eac92018-04-05 12:17:20 -07002000 return false;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002001 }
Wei Wang587eac92018-04-05 12:17:20 -07002002 return true;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002003 });
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002004 }
2005 auto result = dumpstate_board_task.get_future();
2006 std::thread(std::move(dumpstate_board_task)).detach();
Wei Wang587eac92018-04-05 12:17:20 -07002007
Wei Wang587eac92018-04-05 12:17:20 -07002008 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2009 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate vendor HAL\n", timeout_sec);
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002010 if (!android::base::SetProperty(
2011 "ctl.interface_restart",
2012 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
Wei Wang587eac92018-04-05 12:17:20 -07002013 MYLOGE("Couldn't restart dumpstate HAL\n");
2014 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002015 }
Wei Wang587eac92018-04-05 12:17:20 -07002016 // Wait some time for init to kill dumpstate vendor HAL
2017 constexpr size_t killing_timeout_sec = 10;
2018 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2019 MYLOGE("killing dumpstateBoard timed out after %zus, continue and "
2020 "there might be racing in content\n", killing_timeout_sec);
2021 }
2022
2023 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
2024 for (size_t i = 0; i < paths.size(); i++) {
2025 struct stat s;
2026 if (fstat(handle.get()->data[i], &s) == -1) {
2027 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(),
2028 strerror(errno));
2029 file_sizes[i] = -1;
2030 continue;
2031 }
2032 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002033 }
2034
2035 for (size_t i = 0; i < paths.size(); i++) {
2036 if (file_sizes[i] == -1) {
2037 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002038 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002039 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07002040 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002041 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002042 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002043 AddZipEntry(kDumpstateBoardFiles[i], paths[i]);
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002044 printf("*** See %s entry ***\n", kDumpstateBoardFiles[i].c_str());
Jie Song9fbfad02017-06-20 16:29:42 -07002045 }
Felipe Leme6f674ae2016-11-18 17:10:33 -08002046}
2047
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002048static void ShowUsage() {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002049 fprintf(stderr,
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01002050 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-d] [-p] "
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002051 "[-z] [-s] [-S] [-q] [-P] [-R] [-V version]\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002052 " -h: display this help message\n"
2053 " -b: play sound file instead of vibrate, at beginning of job\n"
2054 " -e: play sound file instead of vibrate, at end of job\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01002055 " -d: append date to filename\n"
2056 " -p: capture screenshot to filename.png\n"
2057 " -z: generate zipped file\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002058 " -s: write output to control socket (for init)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01002059 " -S: write file location to control socket (for init; requires -z)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002060 " -q: disable vibrate\n"
Abhijeet Kaure370d682019-10-01 16:49:30 +01002061 " -P: send broadcast when started and do progress updates\n"
2062 " -R: take bugreport in remote mode (requires -z and -d, shouldn't be used with -P)\n"
Nandana Dutt235864b2019-01-22 12:10:16 +00002063 " -w: start binder service and make it wait for a call to startBugreport\n"
Felipe Lemed071c682016-10-20 16:48:00 -07002064 " -v: prints the dumpstate header and exit\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002065}
2066
Wei Liuf87959e2016-08-26 14:51:42 -07002067static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07002068 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07002069}
2070
Felipe Leme1d486fe2016-10-14 18:06:47 -07002071bool Dumpstate::FinishZipFile() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07002072 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07002073 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07002074 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002075 // Final timestamp
2076 char date[80];
2077 time_t the_real_now_please_stand_up = time(nullptr);
2078 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002079 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07002080 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002081
Felipe Leme9a523ae2016-10-20 15:10:33 -07002082 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002083 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08002084 return false;
2085 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07002086 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002087 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08002088 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08002089 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08002090
Felipe Leme0f3fb202016-06-10 17:10:53 -07002091 // Add log file (which contains stderr output) to zip...
2092 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07002093 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07002094 MYLOGE("Failed to add dumpstate log to .zip file\n");
2095 return false;
2096 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002097 // TODO: Should truncate the existing file.
2098 // ... and re-open it for further logging.
Nandana Dutta344cb62019-02-22 15:12:35 +00002099 if (!redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()))) {
2100 return false;
2101 }
Felipe Leme0f3fb202016-06-10 17:10:53 -07002102 fprintf(stderr, "\n");
2103
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002104 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07002105 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002106 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002107 return false;
2108 }
2109
Felipe Leme1d486fe2016-10-14 18:06:47 -07002110 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
2111 ds.zip_file.reset(nullptr);
2112
Felipe Lemee9d2c542016-11-15 11:48:26 -08002113 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002114 android::os::UnlinkAndLogOnError(tmp_path_);
Felipe Lemec4eee562016-04-21 15:42:55 -07002115
Felipe Leme1e9edc62015-12-21 16:02:13 -08002116 return true;
2117}
Felipe Leme6e01fa62015-11-11 19:35:14 -08002118
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002119static void SendBroadcast(const std::string& action, const std::vector<std::string>& args) {
2120 // clang-format off
2121 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user", "0",
2122 "--receiver-foreground", "--receiver-include-background", "-a", action};
2123 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08002124
2125 am.insert(am.end(), args.begin(), args.end());
2126
Felipe Leme8d2410e2017-02-08 09:46:08 -08002127 RunCommand("", am,
2128 CommandOptions::WithTimeout(20)
2129 .Log("Sending broadcast: '%s'\n")
2130 .Always()
2131 .DropRoot()
2132 .RedirectStderr()
2133 .Build());
2134}
2135
Felipe Leme35b8cf12017-02-10 15:47:29 -08002136static void Vibrate(int duration_ms) {
2137 // clang-format off
Chris Fries0c3de872019-09-14 15:49:41 +00002138 RunCommand("", {"cmd", "vibrator", "vibrate", "-f", std::to_string(duration_ms), "dumpstate"},
Felipe Leme35b8cf12017-02-10 15:47:29 -08002139 CommandOptions::WithTimeout(10)
2140 .Log("Vibrate: '%s'\n")
2141 .Always()
2142 .Build());
2143 // clang-format on
2144}
2145
Nandana Dutt979388e2018-11-30 16:48:55 +00002146static void MaybeResolveSymlink(std::string* path) {
2147 std::string resolved_path;
2148 if (android::base::Readlink(*path, &resolved_path)) {
2149 *path = resolved_path;
2150 }
2151}
2152
Nandana Dutt4be45d12018-09-26 15:04:23 +01002153/*
2154 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
2155 * if we are writing zip files and adds the version file.
2156 */
2157static void PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002158 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
2159
Nandana Dutt4be45d12018-09-26 15:04:23 +01002160 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
2161 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002162 ds.base_name_ = StringPrintf("bugreport-%s-%s", device_name.c_str(), build_id.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002163 if (ds.options_->do_add_date) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002164 char date[80];
2165 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
2166 ds.name_ = date;
2167 } else {
2168 ds.name_ = "undated";
2169 }
2170
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002171 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002172 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002173 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002174 ds.base_name_ += "-wifi";
2175 }
2176
Paul Chang0d2aad72020-02-13 20:04:03 +08002177 if (ds.options_->do_screenshot) {
Nandana Dutt9d17b942020-03-26 10:02:59 +00002178 ds.screenshot_path_ = ds.GetPath(ds.CalledByApi() ? "-png.tmp" : ".png");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002179 }
2180 ds.tmp_path_ = ds.GetPath(".tmp");
2181 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
2182
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002183 std::string destination = ds.CalledByApi()
Nandana Dutt54dbd672019-01-11 12:58:05 +00002184 ? StringPrintf("[fd:%d]", ds.options_->bugreport_fd.get())
Nandana Dutt9a76d202019-01-21 15:56:48 +00002185 : ds.bugreport_internal_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01002186 MYLOGD(
Nandana Dutt235c6672019-11-14 15:22:32 +00002187 "Bugreport dir: [%s] "
2188 "Base name: [%s] "
2189 "Suffix: [%s] "
2190 "Log path: [%s] "
2191 "Temporary path: [%s] "
2192 "Screenshot path: [%s]\n",
Nandana Dutt9a76d202019-01-21 15:56:48 +00002193 destination.c_str(), ds.base_name_.c_str(), ds.name_.c_str(), ds.log_path_.c_str(),
2194 ds.tmp_path_.c_str(), ds.screenshot_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002195
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002196 if (ds.options_->do_zip_file) {
Nandana Dutt9d17b942020-03-26 10:02:59 +00002197 ds.path_ = ds.GetPath(ds.CalledByApi() ? "-zip.tmp" : ".zip");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002198 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
2199 create_parent_dirs(ds.path_.c_str());
2200 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
2201 if (ds.zip_file == nullptr) {
2202 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
2203 } else {
2204 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
2205 }
2206 ds.AddTextZipEntry("version.txt", ds.version_);
2207 }
2208}
2209
2210/*
Abhijeet Kaure370d682019-10-01 16:49:30 +01002211 * Finalizes writing to the file by zipping the tmp file to the final location,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002212 * printing zipped file status, etc.
2213 */
2214static void FinalizeFile() {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002215 bool do_text_file = true;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002216 if (ds.options_->do_zip_file) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002217 if (!ds.FinishZipFile()) {
2218 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
2219 do_text_file = true;
2220 } else {
2221 do_text_file = false;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002222 }
2223 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002224 if (ds.options_->use_control_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002225 if (do_text_file) {
2226 dprintf(ds.control_socket_fd_,
2227 "FAIL:could not create zip file, check %s "
2228 "for more details\n",
2229 ds.log_path_.c_str());
2230 } else {
2231 dprintf(ds.control_socket_fd_, "OK:%s\n", ds.path_.c_str());
2232 }
2233 }
2234}
2235
Nandana Dutt4be45d12018-09-26 15:04:23 +01002236
Nandana Dutt58d72e22018-11-16 10:30:48 +00002237static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2238 switch (mode) {
2239 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2240 return "BUGREPORT_FULL";
2241 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2242 return "BUGREPORT_INTERACTIVE";
2243 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2244 return "BUGREPORT_REMOTE";
2245 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2246 return "BUGREPORT_WEAR";
2247 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2248 return "BUGREPORT_TELEPHONY";
2249 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2250 return "BUGREPORT_WIFI";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002251 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2252 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002253 }
2254}
2255
Paul Changf59c2b72020-03-10 02:08:55 +08002256static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options,
2257 bool is_screenshot_requested) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002258 // Modify com.android.shell.BugreportProgressService#isDefaultScreenshotRequired as well for
2259 // default system screenshots.
Abhijeet Kaure370d682019-10-01 16:49:30 +01002260 options->bugreport_mode = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002261 switch (mode) {
2262 case Dumpstate::BugreportMode::BUGREPORT_FULL:
Paul Changf59c2b72020-03-10 02:08:55 +08002263 options->do_screenshot = is_screenshot_requested;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002264 options->dumpstate_hal_mode = DumpstateMode::FULL;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002265 break;
2266 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002267 // Currently, the dumpstate binder is only used by Shell to update progress.
2268 options->do_start_service = true;
2269 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002270 options->do_screenshot = is_screenshot_requested;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002271 options->dumpstate_hal_mode = DumpstateMode::INTERACTIVE;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002272 break;
2273 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002274 options->do_vibrate = false;
2275 options->is_remote_mode = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002276 options->do_screenshot = false;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002277 options->dumpstate_hal_mode = DumpstateMode::REMOTE;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002278 break;
2279 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002280 options->do_start_service = true;
2281 options->do_progress_updates = true;
2282 options->do_zip_file = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002283 options->do_screenshot = is_screenshot_requested;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002284 options->dumpstate_hal_mode = DumpstateMode::WEAR;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002285 break;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002286 // TODO(b/148168577) rename TELEPHONY everywhere to CONNECTIVITY.
Nandana Dutt58d72e22018-11-16 10:30:48 +00002287 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002288 options->telephony_only = true;
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002289 options->do_progress_updates = 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::CONNECTIVITY;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002292 break;
2293 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002294 options->wifi_only = true;
2295 options->do_zip_file = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002296 options->do_screenshot = false;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002297 options->dumpstate_hal_mode = DumpstateMode::WIFI;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002298 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002299 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2300 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002301 }
2302}
2303
Nandana Dutt58d72e22018-11-16 10:30:48 +00002304static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
Nandana Dutt235c6672019-11-14 15:22:32 +00002305 MYLOGI(
Paul Chang0d2aad72020-02-13 20:04:03 +08002306 "do_zip_file: %d do_vibrate: %d use_socket: %d use_control_socket: %d do_screenshot: %d "
Nandana Dutt235c6672019-11-14 15:22:32 +00002307 "is_remote_mode: %d show_header_only: %d do_start_service: %d telephony_only: %d "
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002308 "wifi_only: %d do_progress_updates: %d fd: %d bugreport_mode: %s dumpstate_hal_mode: %s "
2309 "args: %s\n",
Nandana Dutt235c6672019-11-14 15:22:32 +00002310 options.do_zip_file, options.do_vibrate, options.use_socket, options.use_control_socket,
Paul Chang0d2aad72020-02-13 20:04:03 +08002311 options.do_screenshot, options.is_remote_mode, options.show_header_only,
2312 options.do_start_service,
Nandana Dutt235c6672019-11-14 15:22:32 +00002313 options.telephony_only, options.wifi_only, options.do_progress_updates,
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002314 options.bugreport_fd.get(), options.bugreport_mode.c_str(),
2315 toString(options.dumpstate_hal_mode).c_str(), options.args.c_str());
Nandana Dutt58d72e22018-11-16 10:30:48 +00002316}
2317
Nandana Dutt54dbd672019-01-11 12:58:05 +00002318void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode,
2319 const android::base::unique_fd& bugreport_fd_in,
Paul Changf59c2b72020-03-10 02:08:55 +08002320 const android::base::unique_fd& screenshot_fd_in,
2321 bool is_screenshot_requested) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002322 // In the new API world, date is always added; output is always a zip file.
2323 // TODO(111441001): remove these options once they are obsolete.
2324 do_add_date = true;
2325 do_zip_file = true;
2326
Nandana Dutt54dbd672019-01-11 12:58:05 +00002327 // Duplicate the fds because the passed in fds don't outlive the binder transaction.
2328 bugreport_fd.reset(dup(bugreport_fd_in.get()));
2329 screenshot_fd.reset(dup(screenshot_fd_in.get()));
Nandana Dutt58d72e22018-11-16 10:30:48 +00002330
Paul Changf59c2b72020-03-10 02:08:55 +08002331 SetOptionsFromMode(bugreport_mode, this, is_screenshot_requested);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002332}
2333
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002334Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
2335 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002336 int c;
Nandana Dutt235864b2019-01-22 12:10:16 +00002337 while ((c = getopt(argc, argv, "dho:svqzpPBRSV:w")) != -1) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002338 switch (c) {
2339 // clang-format off
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002340 case 'd': do_add_date = true; break;
2341 case 'z': do_zip_file = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002342 case 's': use_socket = true; break;
2343 case 'S': use_control_socket = true; break;
2344 case 'v': show_header_only = true; break;
2345 case 'q': do_vibrate = false; break;
Paul Chang0d2aad72020-02-13 20:04:03 +08002346 case 'p': do_screenshot = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002347 case 'P': do_progress_updates = true; break;
2348 case 'R': is_remote_mode = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002349 case 'V': break; // compatibility no-op
Nandana Dutt235864b2019-01-22 12:10:16 +00002350 case 'w':
2351 // This was already processed
2352 break;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002353 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002354 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002355 break;
2356 default:
2357 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002358 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002359 break;
2360 // clang-format on
2361 }
2362 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08002363
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002364 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002365 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002366 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002367 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002368 }
2369 }
2370
2371 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
2372 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002373
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002374 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002375}
2376
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002377bool Dumpstate::DumpOptions::ValidateOptions() const {
Nandana Dutt54dbd672019-01-11 12:58:05 +00002378 if (bugreport_fd.get() != -1 && !do_zip_file) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002379 return false;
2380 }
2381
Abhijeet Kaure370d682019-10-01 16:49:30 +01002382 if ((do_zip_file || do_add_date || do_progress_updates) && !OutputToFile()) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002383 return false;
2384 }
2385
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002386 if (use_control_socket && !do_zip_file) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002387 return false;
2388 }
2389
Abhijeet Kaure370d682019-10-01 16:49:30 +01002390 if (is_remote_mode && (do_progress_updates || !do_zip_file || !do_add_date)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002391 return false;
2392 }
2393 return true;
2394}
2395
Nandana Dutt197661d2018-11-16 16:40:21 +00002396void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
2397 options_ = std::move(options);
2398}
2399
Abhijeet Kaura407fb82020-03-27 12:51:12 +00002400void Dumpstate::Initialize() {
2401 /* gets the sequential id */
2402 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
2403 id_ = ++last_id;
2404 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
2405}
2406
Nandana Duttd2f5f082019-01-18 17:13:52 +00002407Dumpstate::RunStatus Dumpstate::Run(int32_t calling_uid, const std::string& calling_package) {
2408 Dumpstate::RunStatus status = RunInternal(calling_uid, calling_package);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002409 if (listener_ != nullptr) {
2410 switch (status) {
2411 case Dumpstate::RunStatus::OK:
Nandana Duttcc4ead82019-01-23 08:29:23 +00002412 listener_->onFinished();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002413 break;
2414 case Dumpstate::RunStatus::HELP:
2415 break;
2416 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002417 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_INVALID_INPUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002418 break;
2419 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002420 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_RUNTIME_ERROR);
2421 break;
2422 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2423 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_DENIED_CONSENT);
2424 break;
2425 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
2426 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_CONSENT_TIMED_OUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002427 break;
2428 }
2429 }
2430 return status;
2431}
2432
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002433void Dumpstate::Cancel() {
2434 CleanupTmpFiles();
2435 android::os::UnlinkAndLogOnError(log_path_);
2436 for (int i = 0; i < NUM_OF_DUMPS; i++) {
2437 android::os::UnlinkAndLogOnError(ds.bugreport_internal_dir_ + "/" +
2438 kDumpstateBoardFiles[i]);
2439 }
2440 tombstone_data_.clear();
2441 anr_data_.clear();
2442}
2443
Nandana Dutt979388e2018-11-30 16:48:55 +00002444/*
2445 * Dumps relevant information to a bugreport based on the given options.
2446 *
2447 * The bugreport can be dumped to a file or streamed to a socket.
2448 *
2449 * How dumping to file works:
2450 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
2451 * stderr is redirected a log file.
2452 *
2453 * The temporary bugreport is then populated via printfs, dumping contents of files and
2454 * output of commands to stdout.
2455 *
2456 * If zipping, the temporary bugreport file is added to the zip archive. Else it's renamed to final
2457 * text file.
2458 *
2459 * If zipping, a bunch of other files and dumps also get added to the zip archive. The log file also
2460 * gets added to the archive.
2461 *
Nandana Dutt9a76d202019-01-21 15:56:48 +00002462 * Bugreports are first generated in a local directory and later copied to the caller's fd if
2463 * supplied.
Nandana Dutt979388e2018-11-30 16:48:55 +00002464 */
Nandana Duttd2f5f082019-01-18 17:13:52 +00002465Dumpstate::RunStatus Dumpstate::RunInternal(int32_t calling_uid,
2466 const std::string& calling_package) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002467 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00002468 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002469 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002470 return RunStatus::INVALID_INPUT;
2471 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002472 /* set as high priority, and protect from OOM killer */
2473 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002474
Felipe Lemed071c682016-10-20 16:48:00 -07002475 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002476 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002477 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002478 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002479 } else {
2480 /* fallback to kernels <= 2.6.35 */
2481 oom_adj = fopen("/proc/self/oom_adj", "we");
2482 if (oom_adj) {
2483 fputs("-17", oom_adj);
2484 fclose(oom_adj);
2485 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002486 }
2487
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002488 if (version_ == VERSION_DEFAULT) {
2489 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00002490 }
2491
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002492 if (version_ != VERSION_CURRENT && version_ != VERSION_SPLIT_ANR) {
Vishnu Nair64afc022018-02-01 15:29:34 -08002493 MYLOGE("invalid version requested ('%s'); suppported values are: ('%s', '%s', '%s')\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002494 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str(),
Vishnu Nair64afc022018-02-01 15:29:34 -08002495 VERSION_SPLIT_ANR.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002496 return RunStatus::INVALID_INPUT;
Felipe Lemed071c682016-10-20 16:48:00 -07002497 }
2498
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002499 if (options_->show_header_only) {
2500 PrintHeader();
2501 return RunStatus::OK;
Felipe Lemed071c682016-10-20 16:48:00 -07002502 }
2503
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002504 MYLOGD("dumpstate calling_uid = %d ; calling package = %s \n",
2505 calling_uid, calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00002506
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002507 // Redirect output if needed
Nandana Dutt9a76d202019-01-21 15:56:48 +00002508 bool is_redirecting = options_->OutputToFile();
Felipe Leme7447d7c2016-11-03 18:12:22 -07002509
2510 // TODO: temporarily set progress until it's part of the Dumpstate constructor
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002511 std::string stats_path =
Nandana Dutt979388e2018-11-30 16:48:55 +00002512 is_redirecting
2513 ? android::base::StringPrintf("%s/dumpstate-stats.txt", bugreport_internal_dir_.c_str())
2514 : "";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002515 progress_.reset(new Progress(stats_path));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002516
Sahana Raof35ed432019-07-12 10:47:52 +01002517 if (acquire_wake_lock(PARTIAL_WAKE_LOCK, WAKE_LOCK_NAME) < 0) {
2518 MYLOGE("Failed to acquire wake lock: %s\n", strerror(errno));
2519 } else {
2520 // Wake lock will be released automatically on process death
2521 MYLOGD("Wake lock acquired.\n");
2522 }
2523
Felipe Leme6ae5c4f2017-01-10 14:13:22 -08002524 register_sig_handler();
Felipe Lemed071c682016-10-20 16:48:00 -07002525
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002526 // TODO(b/111441001): maybe skip if already started?
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002527 if (options_->do_start_service) {
Felipe Leme75876a22016-10-27 16:31:27 -07002528 MYLOGI("Starting 'dumpstate' service\n");
2529 android::status_t ret;
2530 if ((ret = android::os::DumpstateService::Start()) != android::OK) {
2531 MYLOGE("Unable to start DumpstateService: %d\n", ret);
2532 }
2533 }
2534
Felipe Lemef0292972016-11-22 13:57:05 -08002535 if (PropertiesHelper::IsDryRun()) {
Felipe Lemed071c682016-10-20 16:48:00 -07002536 MYLOGI("Running on dry-run mode (to disable it, call 'setprop dumpstate.dry_run false')\n");
2537 }
2538
Nandana Dutt235c6672019-11-14 15:22:32 +00002539 MYLOGI("dumpstate info: id=%d, args='%s', bugreport_mode= %s bugreport format version: %s\n",
2540 id_, options_->args.c_str(), options_->bugreport_mode.c_str(), version_.c_str());
Felipe Leme809d74e2016-02-02 12:57:00 -08002541
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002542 do_early_screenshot_ = options_->do_progress_updates;
Felipe Lemee338bf62015-12-07 14:03:50 -08002543
Christopher Ferrised9354f2014-10-01 17:35:01 -07002544 // If we are going to use a socket, do it as early as possible
2545 // to avoid timeouts from bugreport.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002546 if (options_->use_socket) {
Nandana Dutta344cb62019-02-22 15:12:35 +00002547 if (!redirect_to_socket(stdout, "dumpstate")) {
2548 return ERROR;
2549 }
Christopher Ferrised9354f2014-10-01 17:35:01 -07002550 }
2551
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002552 if (options_->use_control_socket) {
Felipe Leme2628e9e2016-04-12 16:36:51 -07002553 MYLOGD("Opening control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002554 control_socket_fd_ = open_socket("dumpstate");
Nandana Dutta344cb62019-02-22 15:12:35 +00002555 if (control_socket_fd_ == -1) {
2556 return ERROR;
2557 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002558 options_->do_progress_updates = 1;
Felipe Leme2628e9e2016-04-12 16:36:51 -07002559 }
2560
Felipe Leme71bbfc52015-11-23 14:14:51 -08002561 if (is_redirecting) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002562 PrepareToWriteToFile();
Felipe Leme1e9edc62015-12-21 16:02:13 -08002563
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002564 if (options_->do_progress_updates) {
Abhijeet Kaure370d682019-10-01 16:49:30 +01002565 // clang-format off
2566 std::vector<std::string> am_args = {
2567 "--receiver-permission", "android.permission.DUMP",
2568 };
2569 // clang-format on
2570 // Send STARTED broadcast for apps that listen to bugreport generation events
2571 SendBroadcast("com.android.internal.intent.action.BUGREPORT_STARTED", am_args);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002572 if (options_->use_control_socket) {
2573 dprintf(control_socket_fd_, "BEGIN:%s\n", path_.c_str());
Felipe Lemeaabfcae2016-07-29 09:49:04 -07002574 }
Felipe Leme71bbfc52015-11-23 14:14:51 -08002575 }
2576 }
2577
Nick Kralevichf3599b32016-01-25 15:05:16 -08002578 /* read /proc/cmdline before dropping root */
2579 FILE *cmdline = fopen("/proc/cmdline", "re");
2580 if (cmdline) {
2581 fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
2582 fclose(cmdline);
2583 }
2584
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002585 if (options_->do_vibrate) {
Felipe Leme35b8cf12017-02-10 15:47:29 -08002586 Vibrate(150);
John Michelau1f794c42012-09-17 11:20:19 -05002587 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002588
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002589 if (options_->do_zip_file && zip_file != nullptr) {
2590 if (chown(path_.c_str(), AID_SHELL, AID_SHELL)) {
2591 MYLOGE("Unable to change ownership of zip file %s: %s\n", path_.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -07002592 strerror(errno));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002593 }
2594 }
2595
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002596 int dup_stdout_fd;
2597 int dup_stderr_fd;
Felipe Leme71bbfc52015-11-23 14:14:51 -08002598 if (is_redirecting) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002599 // Redirect stderr to log_path_ for debugging.
Vishnu Nair20cf5032018-01-05 13:15:49 -08002600 TEMP_FAILURE_RETRY(dup_stderr_fd = dup(fileno(stderr)));
Nandana Dutta344cb62019-02-22 15:12:35 +00002601 if (!redirect_to_file(stderr, const_cast<char*>(log_path_.c_str()))) {
2602 return ERROR;
2603 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002604 if (chown(log_path_.c_str(), AID_SHELL, AID_SHELL)) {
2605 MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n", log_path_.c_str(),
2606 strerror(errno));
Felipe Leme6fe9db62016-02-12 09:04:16 -08002607 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002608
2609 // Redirect stdout to tmp_path_. This is the main bugreport entry and will be
2610 // moved into zip file later, if zipping.
Vishnu Nair20cf5032018-01-05 13:15:49 -08002611 TEMP_FAILURE_RETRY(dup_stdout_fd = dup(fileno(stdout)));
Nandana Dutt979388e2018-11-30 16:48:55 +00002612 // TODO: why not write to a file instead of stdout to overcome this problem?
Felipe Leme6e01fa62015-11-11 19:35:14 -08002613 /* TODO: rather than generating a text file now and zipping it later,
2614 it would be more efficient to redirect stdout to the zip entry
2615 directly, but the libziparchive doesn't support that option yet. */
Nandana Dutta344cb62019-02-22 15:12:35 +00002616 if (!redirect_to_file(stdout, const_cast<char*>(tmp_path_.c_str()))) {
2617 return ERROR;
2618 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002619 if (chown(tmp_path_.c_str(), AID_SHELL, AID_SHELL)) {
Felipe Leme6fe9db62016-02-12 09:04:16 -08002620 MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002621 tmp_path_.c_str(), strerror(errno));
Felipe Leme6fe9db62016-02-12 09:04:16 -08002622 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002623 }
Felipe Lemed8b94e52016-12-08 10:21:44 -08002624
2625 // Don't buffer stdout
2626 setvbuf(stdout, nullptr, _IONBF, 0);
2627
Felipe Leme608385d2016-02-01 10:35:38 -08002628 // NOTE: there should be no stdout output until now, otherwise it would break the header.
2629 // In particular, DurationReport objects should be created passing 'title, NULL', so their
Felipe Lemecbce55d2016-02-08 09:53:18 -08002630 // duration is logged into MYLOG instead.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002631 PrintHeader();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002632
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002633 if (options_->telephony_only) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002634 MaybeTakeEarlyScreenshot();
Paul Changc490e662020-04-11 18:14:09 +08002635 onUiIntensiveBugreportDumpsFinished(calling_uid, calling_package);
Jichao Lie89d9c12019-11-21 19:02:51 -08002636 MaybeCheckUserConsent(calling_uid, calling_package);
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08002637 DumpstateTelephonyOnly(calling_package);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002638 DumpstateBoard();
2639 } else if (options_->wifi_only) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002640 MaybeTakeEarlyScreenshot();
Paul Changc490e662020-04-11 18:14:09 +08002641 onUiIntensiveBugreportDumpsFinished(calling_uid, calling_package);
Jichao Lie89d9c12019-11-21 19:02:51 -08002642 MaybeCheckUserConsent(calling_uid, calling_package);
mukesh agrawal253dad42018-01-23 21:59:59 -08002643 DumpstateWifiOnly();
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002644 } else {
Paul Chang0d2aad72020-02-13 20:04:03 +08002645 // Invoke critical dumpsys first to preserve system state, before doing anything else.
Jichao Lie89d9c12019-11-21 19:02:51 -08002646 RunDumpsysCritical();
2647
Paul Chang0d2aad72020-02-13 20:04:03 +08002648 // Take screenshot and get consent only after critical dumpsys has finished.
2649 MaybeTakeEarlyScreenshot();
Paul Changc490e662020-04-11 18:14:09 +08002650 onUiIntensiveBugreportDumpsFinished(calling_uid, calling_package);
Jichao Lie89d9c12019-11-21 19:02:51 -08002651 MaybeCheckUserConsent(calling_uid, calling_package);
2652
Nandana Dutt4be45d12018-09-26 15:04:23 +01002653 // Dump state for the default case. This also drops root.
Jichao Lie89d9c12019-11-21 19:02:51 -08002654 RunStatus s = DumpstateDefaultAfterCritical();
Nandana Dutt5c390032019-03-12 10:52:56 +00002655 if (s != RunStatus::OK) {
Nandana Duttaac6f582019-07-26 14:32:47 +01002656 if (s == RunStatus::USER_CONSENT_DENIED) {
Nandana Dutt5c390032019-03-12 10:52:56 +00002657 HandleUserConsentDenied();
2658 }
2659 return s;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002660 }
Zhengyin Qian068ecc72016-08-10 16:48:14 -07002661 }
Felipe Leme71a74ac2016-03-17 15:43:25 -07002662
Felipe Leme55b42a62015-11-10 17:39:08 -08002663 /* close output if needed */
Felipe Leme71bbfc52015-11-23 14:14:51 -08002664 if (is_redirecting) {
Vishnu Nair20cf5032018-01-05 13:15:49 -08002665 TEMP_FAILURE_RETRY(dup2(dup_stdout_fd, fileno(stdout)));
Colin Crossf45fa6b2012-03-26 12:38:26 -07002666 }
2667
Abhijeet Kaure370d682019-10-01 16:49:30 +01002668 // Zip the (now complete) .tmp file within the internal directory.
Nandana Dutt9a76d202019-01-21 15:56:48 +00002669 if (options_->OutputToFile()) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002670 FinalizeFile();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002671 }
2672
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002673 // Share the final file with the caller if the user has consented or Shell is the caller.
Nandana Duttd2f5f082019-01-18 17:13:52 +00002674 Dumpstate::RunStatus status = Dumpstate::RunStatus::OK;
Abhijeet Kaure370d682019-10-01 16:49:30 +01002675 if (CalledByApi()) {
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002676 status = CopyBugreportIfUserConsented(calling_uid);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002677 if (status != Dumpstate::RunStatus::OK &&
2678 status != Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2679 // Do an early return if there were errors. We make an exception for consent
2680 // timing out because it's possible the user got distracted. In this case the
2681 // bugreport is not shared but made available for manual retrieval.
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002682 MYLOGI("User denied consent. Returning\n");
Nandana Duttd2f5f082019-01-18 17:13:52 +00002683 return status;
2684 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002685 if (status == Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2686 MYLOGI(
2687 "Did not receive user consent yet."
2688 " Will not copy the bugreport artifacts to caller.\n");
Abhijeet Kaur57627412019-04-17 16:00:09 +01002689 const String16 incidentcompanion("incidentcompanion");
2690 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
2691 if (ics != nullptr) {
2692 MYLOGD("Canceling user consent request via incidentcompanion service\n");
2693 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
2694 consent_callback_.get());
2695 } else {
2696 MYLOGD("Unable to cancel user consent; incidentcompanion service unavailable\n");
2697 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002698 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00002699 }
2700
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002701 /* vibrate a few but shortly times to let user know it's finished */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002702 if (options_->do_vibrate) {
Takuya Ogawa47f644e2017-12-20 18:09:09 +09002703 for (int i = 0; i < 3; i++) {
2704 Vibrate(75);
2705 usleep((75 + 50) * 1000);
2706 }
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002707 }
2708
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002709 MYLOGD("Final progress: %d/%d (estimated %d)\n", progress_->Get(), progress_->GetMax(),
2710 progress_->GetInitialMax());
2711 progress_->Save();
2712 MYLOGI("done (id %d)\n", id_);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002713
Felipe Leme107a05f2016-03-08 15:11:15 -08002714 if (is_redirecting) {
Vishnu Nair20cf5032018-01-05 13:15:49 -08002715 TEMP_FAILURE_RETRY(dup2(dup_stderr_fd, fileno(stderr)));
Felipe Leme107a05f2016-03-08 15:11:15 -08002716 }
2717
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002718 if (options_->use_control_socket && control_socket_fd_ != -1) {
Felipe Lemee844a9d2016-09-21 15:01:39 -07002719 MYLOGD("Closing control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002720 close(control_socket_fd_);
Felipe Leme2628e9e2016-04-12 16:36:51 -07002721 }
2722
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002723 tombstone_data_.clear();
2724 anr_data_.clear();
Narayan Kamath6b9516c2017-10-27 11:15:51 +01002725
Nandana Duttd2f5f082019-01-18 17:13:52 +00002726 return (consent_callback_ != nullptr &&
2727 consent_callback_->getResult() == UserConsentResult::UNAVAILABLE)
2728 ? USER_CONSENT_TIMED_OUT
2729 : RunStatus::OK;
2730}
2731
Paul Chang0d2aad72020-02-13 20:04:03 +08002732void Dumpstate::MaybeTakeEarlyScreenshot() {
2733 if (!options_->do_screenshot || !do_early_screenshot_) {
2734 return;
2735 }
2736
2737 TakeScreenshot();
2738}
2739
Paul Changc490e662020-04-11 18:14:09 +08002740void Dumpstate::onUiIntensiveBugreportDumpsFinished(int32_t calling_uid,
2741 const std::string& calling_package) {
2742 if (calling_uid == AID_SHELL || !CalledByApi()) {
2743 return;
2744 }
2745 if (listener_ != nullptr) {
2746 // Let listener know ui intensive bugreport dumps are finished, then it can do event
2747 // handling if required.
2748 android::String16 package(calling_package.c_str());
2749 listener_->onUiIntensiveBugreportDumpsFinished(package);
2750 }
2751}
2752
Jichao Lie89d9c12019-11-21 19:02:51 -08002753void Dumpstate::MaybeCheckUserConsent(int32_t calling_uid, const std::string& calling_package) {
2754 if (calling_uid == AID_SHELL || !CalledByApi()) {
2755 // No need to get consent for shell triggered dumpstates, or not through
2756 // bugreporting API (i.e. no fd to copy back).
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002757 return;
2758 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00002759 consent_callback_ = new ConsentCallback();
2760 const String16 incidentcompanion("incidentcompanion");
2761 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
Jichao Lie89d9c12019-11-21 19:02:51 -08002762 android::String16 package(calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00002763 if (ics != nullptr) {
2764 MYLOGD("Checking user consent via incidentcompanion service\n");
2765 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
Jichao Lie89d9c12019-11-21 19:02:51 -08002766 calling_uid, package, String16(), String16(),
Joe Onorato1c36d752019-03-17 18:26:43 -07002767 0x1 /* FLAG_CONFIRMATION_DIALOG */, consent_callback_.get());
Nandana Duttd2f5f082019-01-18 17:13:52 +00002768 } else {
2769 MYLOGD("Unable to check user consent; incidentcompanion service unavailable\n");
2770 }
2771}
2772
Nandana Dutt5c390032019-03-12 10:52:56 +00002773bool Dumpstate::IsUserConsentDenied() const {
2774 return ds.consent_callback_ != nullptr &&
2775 ds.consent_callback_->getResult() == UserConsentResult::DENIED;
2776}
2777
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002778bool Dumpstate::CalledByApi() const {
2779 return ds.options_->bugreport_fd.get() != -1 ? true : false;
2780}
2781
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002782void Dumpstate::CleanupTmpFiles() {
Nandana Duttd2f5f082019-01-18 17:13:52 +00002783 android::os::UnlinkAndLogOnError(tmp_path_);
2784 android::os::UnlinkAndLogOnError(screenshot_path_);
2785 android::os::UnlinkAndLogOnError(path_);
2786}
2787
2788Dumpstate::RunStatus Dumpstate::HandleUserConsentDenied() {
2789 MYLOGD("User denied consent; deleting files and returning\n");
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002790 CleanupTmpFiles();
Nandana Duttd2f5f082019-01-18 17:13:52 +00002791 return USER_CONSENT_DENIED;
2792}
2793
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002794Dumpstate::RunStatus Dumpstate::CopyBugreportIfUserConsented(int32_t calling_uid) {
Nandana Duttd2f5f082019-01-18 17:13:52 +00002795 // If the caller has asked to copy the bugreport over to their directory, we need explicit
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002796 // user consent (unless the caller is Shell).
2797 UserConsentResult consent_result;
2798 if (calling_uid == AID_SHELL) {
2799 consent_result = UserConsentResult::APPROVED;
2800 } else {
2801 consent_result = consent_callback_->getResult();
2802 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00002803 if (consent_result == UserConsentResult::UNAVAILABLE) {
2804 // User has not responded yet.
2805 uint64_t elapsed_ms = consent_callback_->getElapsedTimeMs();
Hunter Knepshield70610fa2020-01-03 15:27:33 -08002806 // Telephony is a fast report type, particularly on user builds where information may be
2807 // more aggressively limited. To give the user time to read the consent dialog, increase the
2808 // timeout.
2809 uint64_t timeout_ms = options_->telephony_only ? TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS
2810 : USER_CONSENT_TIMEOUT_MS;
2811 if (elapsed_ms < timeout_ms) {
2812 uint delay_seconds = (timeout_ms - elapsed_ms) / 1000;
Nandana Duttd2f5f082019-01-18 17:13:52 +00002813 MYLOGD("Did not receive user consent yet; going to wait for %d seconds", delay_seconds);
2814 sleep(delay_seconds);
2815 }
2816 consent_result = consent_callback_->getResult();
2817 }
2818 if (consent_result == UserConsentResult::DENIED) {
2819 // User has explicitly denied sharing with the app. To be safe delete the
2820 // internal bugreport & tmp files.
2821 return HandleUserConsentDenied();
2822 }
2823 if (consent_result == UserConsentResult::APPROVED) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00002824 bool copy_succeeded = android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
2825 if (copy_succeeded) {
2826 android::os::UnlinkAndLogOnError(path_);
Abhijeet Kaur9ce94672020-04-01 17:22:36 +01002827 if (options_->do_screenshot &&
2828 options_->screenshot_fd.get() != -1 &&
2829 !options_->is_screenshot_copied) {
2830 copy_succeeded = android::os::CopyFileToFd(screenshot_path_,
2831 options_->screenshot_fd.get());
2832 options_->is_screenshot_copied = copy_succeeded;
2833 if (copy_succeeded) {
2834 android::os::UnlinkAndLogOnError(screenshot_path_);
2835 }
2836 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00002837 }
2838 return copy_succeeded ? Dumpstate::RunStatus::OK : Dumpstate::RunStatus::ERROR;
2839 } else if (consent_result == UserConsentResult::UNAVAILABLE) {
2840 // consent_result is still UNAVAILABLE. The user has likely not responded yet.
2841 // Since we do not have user consent to share the bugreport it does not get
2842 // copied over to the calling app but remains in the internal directory from
2843 // where the user can manually pull it.
2844 return Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT;
2845 }
2846 // Unknown result; must be a programming error.
2847 MYLOGE("Unknown user consent result:%d\n", consent_result);
2848 return Dumpstate::RunStatus::ERROR;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002849}
2850
Nandana Duttf02564e2019-02-15 15:24:24 +00002851Dumpstate::RunStatus Dumpstate::ParseCommandlineAndRun(int argc, char* argv[]) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002852 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
2853 Dumpstate::RunStatus status = options->Initialize(argc, argv);
2854 if (status == Dumpstate::RunStatus::OK) {
Nandana Duttf02564e2019-02-15 15:24:24 +00002855 SetOptions(std::move(options));
Nandana Duttd2f5f082019-01-18 17:13:52 +00002856 // When directly running dumpstate binary, the output is not expected to be written
2857 // to any external file descriptor.
Nandana Duttf02564e2019-02-15 15:24:24 +00002858 assert(options_->bugreport_fd.get() == -1);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002859
2860 // calling_uid and calling_package are for user consent to share the bugreport with
Abhijeet Kaura407fb82020-03-27 12:51:12 +00002861 // an app; they are irrelevant here because bugreport is triggered via command line.
2862 // Update Last ID before calling Run().
2863 Initialize();
Nandana Duttf02564e2019-02-15 15:24:24 +00002864 status = Run(-1 /* calling_uid */, "" /* calling_package */);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002865 }
Nandana Duttf02564e2019-02-15 15:24:24 +00002866 return status;
2867}
2868
2869/* Main entry point for dumpstate binary. */
2870int run_main(int argc, char* argv[]) {
2871 Dumpstate::RunStatus status = ds.ParseCommandlineAndRun(argc, argv);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002872
2873 switch (status) {
2874 case Dumpstate::RunStatus::OK:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002875 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002876 case Dumpstate::RunStatus::HELP:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002877 ShowUsage();
2878 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002879 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002880 fprintf(stderr, "Invalid combination of args\n");
2881 ShowUsage();
2882 exit(1);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002883 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002884 FALLTHROUGH_INTENDED;
2885 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2886 FALLTHROUGH_INTENDED;
2887 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002888 exit(2);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002889 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002890}
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002891
2892// TODO(111441001): Default DumpOptions to sensible values.
2893Dumpstate::Dumpstate(const std::string& version)
2894 : pid_(getpid()),
2895 options_(new Dumpstate::DumpOptions()),
Nandana Dutt402a8392019-06-14 14:25:13 +01002896 last_reported_percent_progress_(0),
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002897 version_(version),
2898 now_(time(nullptr)) {
2899}
2900
2901Dumpstate& Dumpstate::GetInstance() {
2902 static Dumpstate singleton_(android::base::GetProperty("dumpstate.version", VERSION_CURRENT));
2903 return singleton_;
2904}
2905
Nandana Dutt8d945c02019-08-14 13:30:07 +01002906DurationReporter::DurationReporter(const std::string& title, bool logcat_only, bool verbose)
2907 : title_(title), logcat_only_(logcat_only), verbose_(verbose) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002908 if (!title_.empty()) {
2909 started_ = Nanotime();
2910 }
2911}
2912
2913DurationReporter::~DurationReporter() {
2914 if (!title_.empty()) {
2915 float elapsed = (float)(Nanotime() - started_) / NANOS_PER_SEC;
chenqiwuaf8b2d92019-12-12 18:53:51 +08002916 if (elapsed >= .5f || verbose_) {
2917 MYLOGD("Duration of '%s': %.2fs\n", title_.c_str(), elapsed);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002918 }
chenqiwuaf8b2d92019-12-12 18:53:51 +08002919 if (!logcat_only_) {
2920 // Use "Yoda grammar" to make it easier to grep|sort sections.
2921 printf("------ %.3fs was the duration of '%s' ------\n", elapsed, title_.c_str());
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002922 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002923 }
2924}
2925
2926const int32_t Progress::kDefaultMax = 5000;
2927
2928Progress::Progress(const std::string& path) : Progress(Progress::kDefaultMax, 1.1, path) {
2929}
2930
2931Progress::Progress(int32_t initial_max, int32_t progress, float growth_factor)
2932 : Progress(initial_max, growth_factor, "") {
2933 progress_ = progress;
2934}
2935
2936Progress::Progress(int32_t initial_max, float growth_factor, const std::string& path)
2937 : initial_max_(initial_max),
2938 progress_(0),
2939 max_(initial_max),
2940 growth_factor_(growth_factor),
2941 n_runs_(0),
2942 average_max_(0),
2943 path_(path) {
2944 if (!path_.empty()) {
2945 Load();
2946 }
2947}
2948
2949void Progress::Load() {
2950 MYLOGD("Loading stats from %s\n", path_.c_str());
2951 std::string content;
2952 if (!android::base::ReadFileToString(path_, &content)) {
2953 MYLOGI("Could not read stats from %s; using max of %d\n", path_.c_str(), max_);
2954 return;
2955 }
2956 if (content.empty()) {
2957 MYLOGE("No stats (empty file) on %s; using max of %d\n", path_.c_str(), max_);
2958 return;
2959 }
2960 std::vector<std::string> lines = android::base::Split(content, "\n");
2961
2962 if (lines.size() < 1) {
2963 MYLOGE("Invalid stats on file %s: not enough lines (%d). Using max of %d\n", path_.c_str(),
2964 (int)lines.size(), max_);
2965 return;
2966 }
2967 char* ptr;
2968 n_runs_ = strtol(lines[0].c_str(), &ptr, 10);
2969 average_max_ = strtol(ptr, nullptr, 10);
2970 if (n_runs_ <= 0 || average_max_ <= 0 || n_runs_ > STATS_MAX_N_RUNS ||
2971 average_max_ > STATS_MAX_AVERAGE) {
2972 MYLOGE("Invalid stats line on file %s: %s\n", path_.c_str(), lines[0].c_str());
2973 initial_max_ = Progress::kDefaultMax;
2974 } else {
2975 initial_max_ = average_max_;
2976 }
2977 max_ = initial_max_;
2978
2979 MYLOGI("Average max progress: %d in %d runs; estimated max: %d\n", average_max_, n_runs_, max_);
2980}
2981
2982void Progress::Save() {
2983 int32_t total = n_runs_ * average_max_ + progress_;
2984 int32_t runs = n_runs_ + 1;
2985 int32_t average = floor(((float)total) / runs);
2986 MYLOGI("Saving stats (total=%d, runs=%d, average=%d) on %s\n", total, runs, average,
2987 path_.c_str());
2988 if (path_.empty()) {
2989 return;
2990 }
2991
2992 std::string content = android::base::StringPrintf("%d %d\n", runs, average);
2993 if (!android::base::WriteStringToFile(content, path_)) {
2994 MYLOGE("Could not save stats on %s\n", path_.c_str());
2995 }
2996}
2997
2998int32_t Progress::Get() const {
2999 return progress_;
3000}
3001
3002bool Progress::Inc(int32_t delta_sec) {
3003 bool changed = false;
3004 if (delta_sec >= 0) {
3005 progress_ += delta_sec;
3006 if (progress_ > max_) {
3007 int32_t old_max = max_;
3008 max_ = floor((float)progress_ * growth_factor_);
3009 MYLOGD("Adjusting max progress from %d to %d\n", old_max, max_);
3010 changed = true;
3011 }
3012 }
3013 return changed;
3014}
3015
3016int32_t Progress::GetMax() const {
3017 return max_;
3018}
3019
3020int32_t Progress::GetInitialMax() const {
3021 return initial_max_;
3022}
3023
3024void Progress::Dump(int fd, const std::string& prefix) const {
3025 const char* pr = prefix.c_str();
3026 dprintf(fd, "%sprogress: %d\n", pr, progress_);
3027 dprintf(fd, "%smax: %d\n", pr, max_);
3028 dprintf(fd, "%sinitial_max: %d\n", pr, initial_max_);
3029 dprintf(fd, "%sgrowth_factor: %0.2f\n", pr, growth_factor_);
3030 dprintf(fd, "%spath: %s\n", pr, path_.c_str());
3031 dprintf(fd, "%sn_runs: %d\n", pr, n_runs_);
3032 dprintf(fd, "%saverage_max: %d\n", pr, average_max_);
3033}
3034
3035bool Dumpstate::IsZipping() const {
3036 return zip_writer_ != nullptr;
3037}
3038
3039std::string Dumpstate::GetPath(const std::string& suffix) const {
3040 return GetPath(bugreport_internal_dir_, suffix);
3041}
3042
3043std::string Dumpstate::GetPath(const std::string& directory, const std::string& suffix) const {
3044 return android::base::StringPrintf("%s/%s-%s%s", directory.c_str(), base_name_.c_str(),
3045 name_.c_str(), suffix.c_str());
3046}
3047
3048void Dumpstate::SetProgress(std::unique_ptr<Progress> progress) {
3049 progress_ = std::move(progress);
3050}
3051
3052void for_each_userid(void (*func)(int), const char *header) {
3053 std::string title = header == nullptr ? "for_each_userid" : android::base::StringPrintf(
3054 "for_each_userid(%s)", header);
3055 DurationReporter duration_reporter(title);
3056 if (PropertiesHelper::IsDryRun()) return;
3057
3058 DIR *d;
3059 struct dirent *de;
3060
3061 if (header) printf("\n------ %s ------\n", header);
3062 func(0);
3063
3064 if (!(d = opendir("/data/system/users"))) {
3065 printf("Failed to open /data/system/users (%s)\n", strerror(errno));
3066 return;
3067 }
3068
3069 while ((de = readdir(d))) {
3070 int userid;
3071 if (de->d_type != DT_DIR || !(userid = atoi(de->d_name))) {
3072 continue;
3073 }
3074 func(userid);
3075 }
3076
3077 closedir(d);
3078}
3079
3080static void __for_each_pid(void (*helper)(int, const char *, void *), const char *header, void *arg) {
3081 DIR *d;
3082 struct dirent *de;
3083
3084 if (!(d = opendir("/proc"))) {
3085 printf("Failed to open /proc (%s)\n", strerror(errno));
3086 return;
3087 }
3088
3089 if (header) printf("\n------ %s ------\n", header);
3090 while ((de = readdir(d))) {
3091 if (ds.IsUserConsentDenied()) {
3092 MYLOGE(
3093 "Returning early because user denied consent to share bugreport with calling app.");
3094 closedir(d);
3095 return;
3096 }
3097 int pid;
3098 int fd;
3099 char cmdpath[255];
3100 char cmdline[255];
3101
3102 if (!(pid = atoi(de->d_name))) {
3103 continue;
3104 }
3105
3106 memset(cmdline, 0, sizeof(cmdline));
3107
3108 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/cmdline", pid);
3109 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3110 TEMP_FAILURE_RETRY(read(fd, cmdline, sizeof(cmdline) - 2));
3111 close(fd);
3112 if (cmdline[0]) {
3113 helper(pid, cmdline, arg);
3114 continue;
3115 }
3116 }
3117
3118 // if no cmdline, a kernel thread has comm
3119 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/comm", pid);
3120 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3121 TEMP_FAILURE_RETRY(read(fd, cmdline + 1, sizeof(cmdline) - 4));
3122 close(fd);
3123 if (cmdline[1]) {
3124 cmdline[0] = '[';
3125 size_t len = strcspn(cmdline, "\f\b\r\n");
3126 cmdline[len] = ']';
3127 cmdline[len+1] = '\0';
3128 }
3129 }
3130 if (!cmdline[0]) {
3131 strcpy(cmdline, "N/A");
3132 }
3133 helper(pid, cmdline, arg);
3134 }
3135
3136 closedir(d);
3137}
3138
3139static void for_each_pid_helper(int pid, const char *cmdline, void *arg) {
3140 for_each_pid_func *func = (for_each_pid_func*) arg;
3141 func(pid, cmdline);
3142}
3143
3144void for_each_pid(for_each_pid_func func, const char *header) {
3145 std::string title = header == nullptr ? "for_each_pid"
3146 : android::base::StringPrintf("for_each_pid(%s)", header);
3147 DurationReporter duration_reporter(title);
3148 if (PropertiesHelper::IsDryRun()) return;
3149
3150 __for_each_pid(for_each_pid_helper, header, (void *) func);
3151}
3152
3153static void for_each_tid_helper(int pid, const char *cmdline, void *arg) {
3154 DIR *d;
3155 struct dirent *de;
3156 char taskpath[255];
3157 for_each_tid_func *func = (for_each_tid_func *) arg;
3158
3159 snprintf(taskpath, sizeof(taskpath), "/proc/%d/task", pid);
3160
3161 if (!(d = opendir(taskpath))) {
3162 printf("Failed to open %s (%s)\n", taskpath, strerror(errno));
3163 return;
3164 }
3165
3166 func(pid, pid, cmdline);
3167
3168 while ((de = readdir(d))) {
3169 if (ds.IsUserConsentDenied()) {
3170 MYLOGE(
3171 "Returning early because user denied consent to share bugreport with calling app.");
3172 closedir(d);
3173 return;
3174 }
3175 int tid;
3176 int fd;
3177 char commpath[255];
3178 char comm[255];
3179
3180 if (!(tid = atoi(de->d_name))) {
3181 continue;
3182 }
3183
3184 if (tid == pid)
3185 continue;
3186
3187 snprintf(commpath, sizeof(commpath), "/proc/%d/comm", tid);
3188 memset(comm, 0, sizeof(comm));
3189 if ((fd = TEMP_FAILURE_RETRY(open(commpath, O_RDONLY | O_CLOEXEC))) < 0) {
3190 strcpy(comm, "N/A");
3191 } else {
3192 char *c;
3193 TEMP_FAILURE_RETRY(read(fd, comm, sizeof(comm) - 2));
3194 close(fd);
3195
3196 c = strrchr(comm, '\n');
3197 if (c) {
3198 *c = '\0';
3199 }
3200 }
3201 func(pid, tid, comm);
3202 }
3203
3204 closedir(d);
3205}
3206
3207void for_each_tid(for_each_tid_func func, const char *header) {
3208 std::string title = header == nullptr ? "for_each_tid"
3209 : android::base::StringPrintf("for_each_tid(%s)", header);
3210 DurationReporter duration_reporter(title);
3211
3212 if (PropertiesHelper::IsDryRun()) return;
3213
3214 __for_each_pid(for_each_tid_helper, header, (void *) func);
3215}
3216
3217void show_wchan(int pid, int tid, const char *name) {
3218 if (PropertiesHelper::IsDryRun()) return;
3219
3220 char path[255];
3221 char buffer[255];
3222 int fd, ret, save_errno;
3223 char name_buffer[255];
3224
3225 memset(buffer, 0, sizeof(buffer));
3226
3227 snprintf(path, sizeof(path), "/proc/%d/wchan", tid);
3228 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3229 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3230 return;
3231 }
3232
3233 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3234 save_errno = errno;
3235 close(fd);
3236
3237 if (ret < 0) {
3238 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3239 return;
3240 }
3241
3242 snprintf(name_buffer, sizeof(name_buffer), "%*s%s",
3243 pid == tid ? 0 : 3, "", name);
3244
3245 printf("%-7d %-32s %s\n", tid, name_buffer, buffer);
3246
3247 return;
3248}
3249
3250// print time in centiseconds
3251static void snprcent(char *buffer, size_t len, size_t spc,
3252 unsigned long long time) {
3253 static long hz; // cache discovered hz
3254
3255 if (hz <= 0) {
3256 hz = sysconf(_SC_CLK_TCK);
3257 if (hz <= 0) {
3258 hz = 1000;
3259 }
3260 }
3261
3262 // convert to centiseconds
3263 time = (time * 100 + (hz / 2)) / hz;
3264
3265 char str[16];
3266
3267 snprintf(str, sizeof(str), " %llu.%02u",
3268 time / 100, (unsigned)(time % 100));
3269 size_t offset = strlen(buffer);
3270 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3271 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3272}
3273
3274// print permille as a percent
3275static void snprdec(char *buffer, size_t len, size_t spc, unsigned permille) {
3276 char str[16];
3277
3278 snprintf(str, sizeof(str), " %u.%u%%", permille / 10, permille % 10);
3279 size_t offset = strlen(buffer);
3280 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3281 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3282}
3283
3284void show_showtime(int pid, const char *name) {
3285 if (PropertiesHelper::IsDryRun()) return;
3286
3287 char path[255];
3288 char buffer[1023];
3289 int fd, ret, save_errno;
3290
3291 memset(buffer, 0, sizeof(buffer));
3292
3293 snprintf(path, sizeof(path), "/proc/%d/stat", pid);
3294 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3295 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3296 return;
3297 }
3298
3299 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3300 save_errno = errno;
3301 close(fd);
3302
3303 if (ret < 0) {
3304 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3305 return;
3306 }
3307
3308 // field 14 is utime
3309 // field 15 is stime
3310 // field 42 is iotime
3311 unsigned long long utime = 0, stime = 0, iotime = 0;
3312 if (sscanf(buffer,
3313 "%*u %*s %*s %*d %*d %*d %*d %*d %*d %*d %*d "
3314 "%*d %*d %llu %llu %*d %*d %*d %*d %*d %*d "
3315 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %*d "
3316 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %llu ",
3317 &utime, &stime, &iotime) != 3) {
3318 return;
3319 }
3320
3321 unsigned long long total = utime + stime;
3322 if (!total) {
3323 return;
3324 }
3325
3326 unsigned permille = (iotime * 1000 + (total / 2)) / total;
3327 if (permille > 1000) {
3328 permille = 1000;
3329 }
3330
3331 // try to beautify and stabilize columns at <80 characters
3332 snprintf(buffer, sizeof(buffer), "%-6d%s", pid, name);
3333 if ((name[0] != '[') || utime) {
3334 snprcent(buffer, sizeof(buffer), 57, utime);
3335 }
3336 snprcent(buffer, sizeof(buffer), 65, stime);
3337 if ((name[0] != '[') || iotime) {
3338 snprcent(buffer, sizeof(buffer), 73, iotime);
3339 }
3340 if (iotime) {
3341 snprdec(buffer, sizeof(buffer), 79, permille);
3342 }
3343 puts(buffer); // adds a trailing newline
3344
3345 return;
3346}
3347
3348void do_dmesg() {
3349 const char *title = "KERNEL LOG (dmesg)";
3350 DurationReporter duration_reporter(title);
3351 printf("------ %s ------\n", title);
3352
3353 if (PropertiesHelper::IsDryRun()) return;
3354
3355 /* Get size of kernel buffer */
3356 int size = klogctl(KLOG_SIZE_BUFFER, nullptr, 0);
3357 if (size <= 0) {
3358 printf("Unexpected klogctl return value: %d\n\n", size);
3359 return;
3360 }
3361 char *buf = (char *) malloc(size + 1);
3362 if (buf == nullptr) {
3363 printf("memory allocation failed\n\n");
3364 return;
3365 }
3366 int retval = klogctl(KLOG_READ_ALL, buf, size);
3367 if (retval < 0) {
3368 printf("klogctl failure\n\n");
3369 free(buf);
3370 return;
3371 }
3372 buf[retval] = '\0';
3373 printf("%s\n\n", buf);
3374 free(buf);
3375 return;
3376}
3377
3378void do_showmap(int pid, const char *name) {
3379 char title[255];
3380 char arg[255];
3381
3382 snprintf(title, sizeof(title), "SHOW MAP %d (%s)", pid, name);
3383 snprintf(arg, sizeof(arg), "%d", pid);
3384 RunCommand(title, {"showmap", "-q", arg}, CommandOptions::AS_ROOT);
3385}
3386
3387int Dumpstate::DumpFile(const std::string& title, const std::string& path) {
3388 DurationReporter duration_reporter(title);
3389
3390 int status = DumpFileToFd(STDOUT_FILENO, title, path);
3391
3392 UpdateProgress(WEIGHT_FILE);
3393
3394 return status;
3395}
3396
3397int read_file_as_long(const char *path, long int *output) {
3398 int fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC));
3399 if (fd < 0) {
3400 int err = errno;
3401 MYLOGE("Error opening file descriptor for %s: %s\n", path, strerror(err));
3402 return -1;
3403 }
3404 char buffer[50];
3405 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3406 if (bytes_read == -1) {
3407 MYLOGE("Error reading file %s: %s\n", path, strerror(errno));
3408 return -2;
3409 }
3410 if (bytes_read == 0) {
3411 MYLOGE("File %s is empty\n", path);
3412 return -3;
3413 }
3414 *output = atoi(buffer);
3415 return 0;
3416}
3417
3418/* calls skip to gate calling dump_from_fd recursively
3419 * in the specified directory. dump_from_fd defaults to
3420 * dump_file_from_fd above when set to NULL. skip defaults
3421 * to false when set to NULL. dump_from_fd will always be
3422 * called with title NULL.
3423 */
3424int dump_files(const std::string& title, const char* dir, bool (*skip)(const char* path),
3425 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
3426 DurationReporter duration_reporter(title);
3427 DIR *dirp;
3428 struct dirent *d;
3429 char *newpath = nullptr;
3430 const char *slash = "/";
3431 int retval = 0;
3432
3433 if (!title.empty()) {
3434 printf("------ %s (%s) ------\n", title.c_str(), dir);
3435 }
3436 if (PropertiesHelper::IsDryRun()) return 0;
3437
3438 if (dir[strlen(dir) - 1] == '/') {
3439 ++slash;
3440 }
3441 dirp = opendir(dir);
3442 if (dirp == nullptr) {
3443 retval = -errno;
3444 MYLOGE("%s: %s\n", dir, strerror(errno));
3445 return retval;
3446 }
3447
3448 if (!dump_from_fd) {
3449 dump_from_fd = dump_file_from_fd;
3450 }
3451 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
3452 if ((d->d_name[0] == '.')
3453 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
3454 || (d->d_name[1] == '\0'))) {
3455 continue;
3456 }
3457 asprintf(&newpath, "%s%s%s%s", dir, slash, d->d_name,
3458 (d->d_type == DT_DIR) ? "/" : "");
3459 if (!newpath) {
3460 retval = -errno;
3461 continue;
3462 }
3463 if (skip && (*skip)(newpath)) {
3464 continue;
3465 }
3466 if (d->d_type == DT_DIR) {
3467 int ret = dump_files("", newpath, skip, dump_from_fd);
3468 if (ret < 0) {
3469 retval = ret;
3470 }
3471 continue;
3472 }
3473 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(newpath, O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
3474 if (fd.get() < 0) {
3475 retval = -1;
3476 printf("*** %s: %s\n", newpath, strerror(errno));
3477 continue;
3478 }
3479 (*dump_from_fd)(nullptr, newpath, fd.get());
3480 }
3481 closedir(dirp);
3482 if (!title.empty()) {
3483 printf("\n");
3484 }
3485 return retval;
3486}
3487
3488/* fd must have been opened with the flag O_NONBLOCK. With this flag set,
3489 * it's possible to avoid issues where opening the file itself can get
3490 * stuck.
3491 */
3492int dump_file_from_fd(const char *title, const char *path, int fd) {
3493 if (PropertiesHelper::IsDryRun()) return 0;
3494
3495 int flags = fcntl(fd, F_GETFL);
3496 if (flags == -1) {
3497 printf("*** %s: failed to get flags on fd %d: %s\n", path, fd, strerror(errno));
3498 return -1;
3499 } else if (!(flags & O_NONBLOCK)) {
3500 printf("*** %s: fd must have O_NONBLOCK set.\n", path);
3501 return -1;
3502 }
3503 return DumpFileFromFdToFd(title, path, fd, STDOUT_FILENO, PropertiesHelper::IsDryRun());
3504}
3505
3506int Dumpstate::RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Nandana Dutt8d945c02019-08-14 13:30:07 +01003507 const CommandOptions& options, bool verbose_duration) {
3508 DurationReporter duration_reporter(title, false /* logcat_only */, verbose_duration);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003509
3510 int status = RunCommandToFd(STDOUT_FILENO, title, full_command, options);
3511
3512 /* TODO: for now we're simplifying the progress calculation by using the
3513 * timeout as the weight. It's a good approximation for most cases, except when calling dumpsys,
3514 * where its weight should be much higher proportionally to its timeout.
3515 * Ideally, it should use a options.EstimatedDuration() instead...*/
3516 UpdateProgress(options.Timeout());
3517
3518 return status;
3519}
3520
3521void Dumpstate::RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsys_args,
3522 const CommandOptions& options, long dumpsysTimeoutMs) {
3523 long timeout_ms = dumpsysTimeoutMs > 0 ? dumpsysTimeoutMs : options.TimeoutInMs();
3524 std::vector<std::string> dumpsys = {"/system/bin/dumpsys", "-T", std::to_string(timeout_ms)};
3525 dumpsys.insert(dumpsys.end(), dumpsys_args.begin(), dumpsys_args.end());
3526 RunCommand(title, dumpsys, options);
3527}
3528
3529int open_socket(const char *service) {
3530 int s = android_get_control_socket(service);
3531 if (s < 0) {
3532 MYLOGE("android_get_control_socket(%s): %s\n", service, strerror(errno));
3533 return -1;
3534 }
3535 fcntl(s, F_SETFD, FD_CLOEXEC);
3536
3537 // Set backlog to 0 to make sure that queue size will be minimum.
3538 // In Linux, because the minimum queue will be 1, connect() will be blocked
3539 // if the other clients already called connect() and the connection request was not accepted.
3540 if (listen(s, 0) < 0) {
3541 MYLOGE("listen(control socket): %s\n", strerror(errno));
3542 return -1;
3543 }
3544
3545 struct sockaddr addr;
3546 socklen_t alen = sizeof(addr);
Abhijeet Kaur2113cae2019-09-13 09:24:15 +01003547 int fd = accept4(s, &addr, &alen, SOCK_CLOEXEC);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003548
3549 // Close socket just after accept(), to make sure that connect() by client will get error
3550 // when the socket is used by the other services.
3551 // There is still a race condition possibility between accept and close, but there is no way
3552 // to close-on-accept atomically.
3553 // See detail; b/123306389#comment25
3554 close(s);
3555
3556 if (fd < 0) {
3557 MYLOGE("accept(control socket): %s\n", strerror(errno));
3558 return -1;
3559 }
3560
3561 return fd;
3562}
3563
3564/* redirect output to a service control socket */
3565bool redirect_to_socket(FILE* redirect, const char* service) {
3566 int fd = open_socket(service);
3567 if (fd == -1) {
3568 return false;
3569 }
3570 fflush(redirect);
3571 // TODO: handle dup2 failure
3572 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
3573 close(fd);
3574 return true;
3575}
3576
3577// TODO: should call is_valid_output_file and/or be merged into it.
3578void create_parent_dirs(const char *path) {
3579 char *chp = const_cast<char *> (path);
3580
3581 /* skip initial slash */
3582 if (chp[0] == '/')
3583 chp++;
3584
3585 /* create leading directories, if necessary */
3586 struct stat dir_stat;
3587 while (chp && chp[0]) {
3588 chp = strchr(chp, '/');
3589 if (chp) {
3590 *chp = 0;
3591 if (stat(path, &dir_stat) == -1 || !S_ISDIR(dir_stat.st_mode)) {
3592 MYLOGI("Creating directory %s\n", path);
3593 if (mkdir(path, 0770)) { /* drwxrwx--- */
3594 MYLOGE("Unable to create directory %s: %s\n", path, strerror(errno));
3595 } else if (chown(path, AID_SHELL, AID_SHELL)) {
3596 MYLOGE("Unable to change ownership of dir %s: %s\n", path, strerror(errno));
3597 }
3598 }
3599 *chp++ = '/';
3600 }
3601 }
3602}
3603
3604bool _redirect_to_file(FILE* redirect, char* path, int truncate_flag) {
3605 create_parent_dirs(path);
3606
3607 int fd = TEMP_FAILURE_RETRY(open(path,
3608 O_WRONLY | O_CREAT | truncate_flag | O_CLOEXEC | O_NOFOLLOW,
3609 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH));
3610 if (fd < 0) {
3611 MYLOGE("%s: %s\n", path, strerror(errno));
3612 return false;
3613 }
3614
3615 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
3616 close(fd);
3617 return true;
3618}
3619
3620bool redirect_to_file(FILE* redirect, char* path) {
3621 return _redirect_to_file(redirect, path, O_TRUNC);
3622}
3623
3624bool redirect_to_existing_file(FILE* redirect, char* path) {
3625 return _redirect_to_file(redirect, path, O_APPEND);
3626}
3627
3628void dump_route_tables() {
3629 DurationReporter duration_reporter("DUMP ROUTE TABLES");
3630 if (PropertiesHelper::IsDryRun()) return;
3631 const char* const RT_TABLES_PATH = "/data/misc/net/rt_tables";
3632 ds.DumpFile("RT_TABLES", RT_TABLES_PATH);
3633 FILE* fp = fopen(RT_TABLES_PATH, "re");
3634 if (!fp) {
3635 printf("*** %s: %s\n", RT_TABLES_PATH, strerror(errno));
3636 return;
3637 }
3638 char table[16];
3639 // Each line has an integer (the table number), a space, and a string (the table name). We only
3640 // need the table number. It's a 32-bit unsigned number, so max 10 chars. Skip the table name.
3641 // Add a fixed max limit so this doesn't go awry.
3642 for (int i = 0; i < 64 && fscanf(fp, " %10s %*s", table) == 1; ++i) {
3643 RunCommand("ROUTE TABLE IPv4", {"ip", "-4", "route", "show", "table", table});
3644 RunCommand("ROUTE TABLE IPv6", {"ip", "-6", "route", "show", "table", table});
3645 }
3646 fclose(fp);
3647}
3648
3649// TODO: make this function thread safe if sections are generated in parallel.
3650void Dumpstate::UpdateProgress(int32_t delta_sec) {
3651 if (progress_ == nullptr) {
3652 MYLOGE("UpdateProgress: progress_ not set\n");
3653 return;
3654 }
3655
3656 // Always update progess so stats can be tuned...
Nandana Dutt402a8392019-06-14 14:25:13 +01003657 progress_->Inc(delta_sec);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003658
3659 // ...but only notifiy listeners when necessary.
3660 if (!options_->do_progress_updates) return;
3661
3662 int progress = progress_->Get();
3663 int max = progress_->GetMax();
Nandana Dutt402a8392019-06-14 14:25:13 +01003664 int percent = 100 * progress / max;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003665
Nandana Dutt402a8392019-06-14 14:25:13 +01003666 if (last_reported_percent_progress_ > 0 && percent <= last_reported_percent_progress_) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003667 return;
3668 }
Nandana Dutt402a8392019-06-14 14:25:13 +01003669 last_reported_percent_progress_ = percent;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003670
3671 if (control_socket_fd_ >= 0) {
3672 dprintf(control_socket_fd_, "PROGRESS:%d/%d\n", progress, max);
3673 fsync(control_socket_fd_);
3674 }
3675
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003676 if (listener_ != nullptr) {
Nandana Dutt235c6672019-11-14 15:22:32 +00003677 if (percent % 10 == 0) {
3678 // We don't want to spam logcat, so only log multiples of 10.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01003679 MYLOGD("Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003680 } else {
3681 // stderr is ignored on normal invocations, but useful when calling
3682 // /system/bin/dumpstate directly for debuggging.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01003683 fprintf(stderr, "Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003684 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003685
3686 listener_->onProgress(percent);
3687 }
3688}
3689
3690void Dumpstate::TakeScreenshot(const std::string& path) {
3691 const std::string& real_path = path.empty() ? screenshot_path_ : path;
3692 int status =
3693 RunCommand("", {"/system/bin/screencap", "-p", real_path},
3694 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3695 if (status == 0) {
3696 MYLOGD("Screenshot saved on %s\n", real_path.c_str());
3697 } else {
3698 MYLOGE("Failed to take screenshot on %s\n", real_path.c_str());
3699 }
Paul Chang0d2aad72020-02-13 20:04:03 +08003700 if (listener_ != nullptr) {
3701 // Show a visual indication to indicate screenshot is taken via
3702 // IDumpstateListener.onScreenshotTaken()
3703 listener_->onScreenshotTaken(status == 0);
3704 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003705}
3706
3707bool is_dir(const char* pathname) {
3708 struct stat info;
3709 if (stat(pathname, &info) == -1) {
3710 return false;
3711 }
3712 return S_ISDIR(info.st_mode);
3713}
3714
3715time_t get_mtime(int fd, time_t default_mtime) {
3716 struct stat info;
3717 if (fstat(fd, &info) == -1) {
3718 return default_mtime;
3719 }
3720 return info.st_mtime;
3721}