blob: 344011675d7847e05c6916951ed1061d7ceaa007 [file] [log] [blame]
Colin Crossf45fa6b2012-03-26 12:38:26 -07001/*
2 * Copyright (C) 2008 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
Felipe Lemef0292972016-11-22 13:57:05 -080016
Mark Salyzyn6c3d90f2016-09-27 14:55:27 -070017#define LOG_TAG "dumpstate"
Colin Crossf45fa6b2012-03-26 12:38:26 -070018
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -070019#include <dirent.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070020#include <errno.h>
21#include <fcntl.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010022#include <inttypes.h>
Felipe Lemead5f6c42015-11-30 14:26:46 -080023#include <libgen.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070024#include <limits.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010025#include <math.h>
26#include <poll.h>
Mark Salyzyn8f37aa52015-06-12 12:28:24 -070027#include <stdbool.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070028#include <stdio.h>
29#include <stdlib.h>
30#include <string.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080031#include <sys/poll.h>
Christopher Ferris7dc7f322014-07-22 16:08:19 -070032#include <sys/prctl.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070033#include <sys/resource.h>
34#include <sys/stat.h>
35#include <sys/time.h>
36#include <sys/wait.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010037#include <signal.h>
38#include <stdarg.h>
39#include <string.h>
40#include <sys/capability.h>
41#include <sys/inotify.h>
42#include <sys/klog.h>
43#include <time.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070044#include <unistd.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070045
46#include <chrono>
Hridya Valsarajuac582cd2019-08-05 15:39:54 -070047#include <cmath>
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +000048#include <fstream>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070049#include <functional>
50#include <future>
Narayan Kamath8f788292017-05-25 13:20:39 +010051#include <memory>
Hridya Valsarajuac582cd2019-08-05 15:39:54 -070052#include <numeric>
Narayan Kamath8f788292017-05-25 13:20:39 +010053#include <regex>
54#include <set>
55#include <string>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070056#include <utility>
Narayan Kamath8f788292017-05-25 13:20:39 +010057#include <vector>
Colin Crossf45fa6b2012-03-26 12:38:26 -070058
Felipe Leme96c2bbb2016-09-26 09:21:21 -070059#include <android-base/file.h>
60#include <android-base/properties.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070061#include <android-base/scopeguard.h>
Elliott Hughes9dc117c2015-12-07 14:21:50 -080062#include <android-base/stringprintf.h>
Naveen Kalla058e1e82016-10-19 21:38:44 -070063#include <android-base/strings.h>
Andreas Gampeaff68432016-07-18 18:01:27 -070064#include <android-base/unique_fd.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010065#include <android/content/pm/IPackageManagerNative.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080066#include <android/hardware/dumpstate/1.0/IDumpstateDevice.h>
Hunter Knepshield8540faf2020-02-04 19:47:20 -080067#include <android/hardware/dumpstate/1.1/IDumpstateDevice.h>
68#include <android/hardware/dumpstate/1.1/types.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080069#include <android/hidl/manager/1.0/IServiceManager.h>
Nandana Duttd2f5f082019-01-18 17:13:52 +000070#include <android/os/IIncidentCompanion.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010071#include <binder/IServiceManager.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080072#include <cutils/native_handle.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070073#include <cutils/properties.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010074#include <cutils/sockets.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000075#include <debuggerd/client.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080076#include <dumpsys.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000077#include <dumputils/dump_utils.h>
Sahana Raof35ed432019-07-12 10:47:52 +010078#include <hardware_legacy/power.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080079#include <hidl/ServiceManagement.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010080#include <log/log.h>
Felipe Leme75876a22016-10-27 16:31:27 -070081#include <openssl/sha.h>
Mark Salyzyn6c3d90f2016-09-27 14:55:27 -070082#include <private/android_filesystem_config.h>
83#include <private/android_logger.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080084#include <serviceutils/PriorityDumper.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070085#include <utils/StrongPointer.h>
Felipe Lemef0292972016-11-22 13:57:05 -080086#include "DumpstateInternal.h"
Felipe Leme75876a22016-10-27 16:31:27 -070087#include "DumpstateService.h"
Colin Crossf45fa6b2012-03-26 12:38:26 -070088#include "dumpstate.h"
Felipe Leme6e01fa62015-11-11 19:35:14 -080089
Hunter Knepshield8540faf2020-02-04 19:47:20 -080090using IDumpstateDevice_1_0 = ::android::hardware::dumpstate::V1_0::IDumpstateDevice;
91using IDumpstateDevice_1_1 = ::android::hardware::dumpstate::V1_1::IDumpstateDevice;
92using ::android::hardware::dumpstate::V1_1::DumpstateMode;
93using ::android::hardware::dumpstate::V1_1::DumpstateStatus;
94using ::android::hardware::dumpstate::V1_1::toString;
Vishnu Naire97d6122018-01-18 13:58:56 -080095using ::std::literals::chrono_literals::operator""ms;
96using ::std::literals::chrono_literals::operator""s;
Steven Morelandcb7ef822016-11-29 13:20:37 -080097
Felipe Leme47e9be22016-12-21 15:37:07 -080098// TODO: remove once moved to namespace
Vishnu Naire97d6122018-01-18 13:58:56 -080099using android::defaultServiceManager;
100using android::Dumpsys;
101using android::INVALID_OPERATION;
102using android::IServiceManager;
103using android::OK;
104using android::sp;
105using android::status_t;
106using android::String16;
107using android::String8;
108using android::TIMED_OUT;
109using android::UNKNOWN_ERROR;
110using android::Vector;
Nandana Dutt979388e2018-11-30 16:48:55 +0000111using android::base::StringPrintf;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000112using android::os::IDumpstateListener;
Felipe Leme47e9be22016-12-21 15:37:07 -0800113using android::os::dumpstate::CommandOptions;
114using android::os::dumpstate::DumpFileToFd;
Vishnu Naire97d6122018-01-18 13:58:56 -0800115using android::os::dumpstate::PropertiesHelper;
Felipe Leme47e9be22016-12-21 15:37:07 -0800116
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100117// Keep in sync with
118// frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
119static const int TRACE_DUMP_TIMEOUT_MS = 10000; // 10 seconds
120
121/* Most simple commands have 10 as timeout, so 5 is a good estimate */
122static const int32_t WEIGHT_FILE = 5;
123
124// TODO: temporary variables and functions used during C++ refactoring
125static Dumpstate& ds = Dumpstate::GetInstance();
126static int RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Nandana Dutt8d945c02019-08-14 13:30:07 +0100127 const CommandOptions& options = CommandOptions::DEFAULT,
128 bool verbose_duration = false) {
129 return ds.RunCommand(title, full_command, options, verbose_duration);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100130}
131
132// Reasonable value for max stats.
133static const int STATS_MAX_N_RUNS = 1000;
134static const long STATS_MAX_AVERAGE = 100000;
135
136CommandOptions Dumpstate::DEFAULT_DUMPSYS = CommandOptions::WithTimeout(30).Build();
137
Nandana Duttd2f5f082019-01-18 17:13:52 +0000138typedef Dumpstate::ConsentCallback::ConsentResult UserConsentResult;
139
Colin Crossf45fa6b2012-03-26 12:38:26 -0700140/* read before root is shed */
141static char cmdline_buf[16384] = "(unknown)";
Yi Kong19d5c002018-07-20 13:39:55 -0700142static const char *dump_traces_path = nullptr;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000143static const uint64_t USER_CONSENT_TIMEOUT_MS = 30 * 1000;
Hunter Knepshield70610fa2020-01-03 15:27:33 -0800144// Because telephony reports are significantly faster to collect (< 10 seconds vs. > 2 minutes),
145// it's often the case that they time out far too quickly for consent with such a hefty dialog for
146// the user to read. For telephony reports only, we increase the default timeout to 2 minutes to
147// roughly match full reports' durations.
148static const uint64_t TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS = 2 * 60 * 1000;
Colin Crossf45fa6b2012-03-26 12:38:26 -0700149
Felipe Leme1d486fe2016-10-14 18:06:47 -0700150// TODO: variables and functions below should be part of dumpstate object
151
Felipe Leme635ca312016-01-05 14:23:02 -0800152static std::set<std::string> mount_points;
153void add_mountinfo();
Felipe Leme78f2c862015-12-21 09:55:22 -0800154
Todd Poynor2a83daa2013-11-22 15:44:22 -0800155#define PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops"
Mark Salyzyn7d0a7622016-06-24 14:06:15 -0700156#define ALT_PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops-0"
Wei Wang509bb5d2017-06-09 14:42:12 -0700157#define BLK_DEV_SYS_DIR "/sys/block"
Todd Poynor2a83daa2013-11-22 15:44:22 -0800158
Felipe Lemee82a27d2016-01-05 13:35:44 -0800159#define RECOVERY_DIR "/cache/recovery"
Mark Salyzynd6ab0112016-03-25 12:56:39 -0700160#define RECOVERY_DATA_DIR "/data/misc/recovery"
Tianjie Xu75d53362018-04-11 16:42:28 -0700161#define UPDATE_ENGINE_LOG_DIR "/data/misc/update_engine_log"
Mark Salyzyn4d42dea2016-04-01 10:03:14 -0700162#define LOGPERSIST_DATA_DIR "/data/misc/logd"
Jerry Changa1df8a92020-01-02 16:03:39 +0800163#define PREREBOOT_DATA_DIR "/data/misc/prereboot"
David Brazdild2991962016-06-03 14:40:44 +0100164#define PROFILE_DATA_DIR_CUR "/data/misc/profiles/cur"
165#define PROFILE_DATA_DIR_REF "/data/misc/profiles/ref"
Benedict Wong8f9d8a42019-01-03 16:19:38 -0800166#define XFRM_STAT_PROC_FILE "/proc/net/xfrm_stat"
Erik Kline08165202016-05-30 11:55:44 +0900167#define WLUTIL "/vendor/xbin/wlutil"
Vishnu Nair36b4cdb2017-11-17 10:27:05 -0800168#define WMTRACE_DATA_DIR "/data/misc/wmtrace"
Yifan Hong3945e1b2019-10-29 12:59:23 -0700169#define OTA_METADATA_DIR "/metadata/ota"
Yifan Hong0efa7972020-02-03 16:45:02 -0800170#define SNAPSHOTCTL_LOG_DIR "/data/misc/snapshotctl_log"
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +0900171#define LINKERCONFIG_DIR "/linkerconfig"
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700172
Narayan Kamath8f788292017-05-25 13:20:39 +0100173// TODO(narayan): Since this information has to be kept in sync
174// with tombstoned, we should just put it in a common header.
175//
176// File: system/core/debuggerd/tombstoned/tombstoned.cpp
Narayan Kamathbd863722017-06-01 18:50:12 +0100177static const std::string TOMBSTONE_DIR = "/data/tombstones/";
178static const std::string TOMBSTONE_FILE_PREFIX = "tombstone_";
179static const std::string ANR_DIR = "/data/anr/";
180static const std::string ANR_FILE_PREFIX = "anr_";
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700181
Felipe Lemee844a9d2016-09-21 15:01:39 -0700182// TODO: temporary variables and functions used during C++ refactoring
Nandana Dutt979388e2018-11-30 16:48:55 +0000183
Nandana Dutt5c390032019-03-12 10:52:56 +0000184#define RETURN_IF_USER_DENIED_CONSENT() \
185 if (ds.IsUserConsentDenied()) { \
186 MYLOGE("Returning early as user denied consent to share bugreport with calling app."); \
187 return Dumpstate::RunStatus::USER_CONSENT_DENIED; \
188 }
189
190// Runs func_ptr, but checks user consent before and after running it. Returns USER_CONSENT_DENIED
191// if consent is found to be denied.
192#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(func_ptr, ...) \
193 RETURN_IF_USER_DENIED_CONSENT(); \
194 func_ptr(__VA_ARGS__); \
195 RETURN_IF_USER_DENIED_CONSENT();
196
Sahana Raof35ed432019-07-12 10:47:52 +0100197static const char* WAKE_LOCK_NAME = "dumpstate_wakelock";
198
Nandana Dutt979388e2018-11-30 16:48:55 +0000199namespace android {
200namespace os {
201namespace {
202
203static int Open(std::string path, int flags, mode_t mode = 0) {
204 int fd = TEMP_FAILURE_RETRY(open(path.c_str(), flags, mode));
205 if (fd == -1) {
206 MYLOGE("open(%s, %s)\n", path.c_str(), strerror(errno));
207 }
208 return fd;
209}
210
Nandana Dutt979388e2018-11-30 16:48:55 +0000211
212static int OpenForRead(std::string path) {
213 return Open(path, O_RDONLY | O_CLOEXEC | O_NOFOLLOW);
214}
215
216bool CopyFile(int in_fd, int out_fd) {
217 char buf[4096];
218 ssize_t byte_count;
219 while ((byte_count = TEMP_FAILURE_RETRY(read(in_fd, buf, sizeof(buf)))) > 0) {
220 if (!android::base::WriteFully(out_fd, buf, byte_count)) {
221 return false;
222 }
223 }
224 return (byte_count != -1);
225}
226
227static bool CopyFileToFd(const std::string& input_file, int out_fd) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000228 MYLOGD("Going to copy file (%s) to %d\n", input_file.c_str(), out_fd);
Nandana Dutt979388e2018-11-30 16:48:55 +0000229
230 // Obtain a handle to the source file.
231 android::base::unique_fd in_fd(OpenForRead(input_file));
232 if (out_fd != -1 && in_fd.get() != -1) {
233 if (CopyFile(in_fd.get(), out_fd)) {
234 return true;
235 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000236 MYLOGE("Failed to copy file: %s\n", strerror(errno));
Nandana Dutt979388e2018-11-30 16:48:55 +0000237 }
238 return false;
239}
240
Nandana Duttd2f5f082019-01-18 17:13:52 +0000241static bool UnlinkAndLogOnError(const std::string& file) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000242 if (unlink(file.c_str())) {
243 MYLOGE("Failed to unlink file (%s): %s\n", file.c_str(), strerror(errno));
Nandana Duttd2f5f082019-01-18 17:13:52 +0000244 return false;
245 }
246 return true;
247}
Nandana Dutt979388e2018-11-30 16:48:55 +0000248
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +0000249
Nikita Ioffea325a572019-05-16 19:49:47 +0100250int64_t GetModuleMetadataVersion() {
251 auto binder = defaultServiceManager()->getService(android::String16("package_native"));
252 if (binder == nullptr) {
253 MYLOGE("Failed to retrieve package_native service");
254 return 0L;
255 }
256 auto package_service = android::interface_cast<content::pm::IPackageManagerNative>(binder);
257 std::string package_name;
258 auto status = package_service->getModuleMetadataPackageName(&package_name);
259 if (!status.isOk()) {
260 MYLOGE("Failed to retrieve module metadata package name: %s", status.toString8().c_str());
261 return 0L;
262 }
Nandana Duttdb379fa2019-10-09 16:54:41 +0100263 MYLOGD("Module metadata package name: %s\n", package_name.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100264 int64_t version_code;
265 status = package_service->getVersionCodeForPackage(android::String16(package_name.c_str()),
266 &version_code);
267 if (!status.isOk()) {
268 MYLOGE("Failed to retrieve module metadata version: %s", status.toString8().c_str());
269 return 0L;
270 }
271 return version_code;
272}
273
Nandana Dutt979388e2018-11-30 16:48:55 +0000274} // namespace
275} // namespace os
276} // namespace android
277
Felipe Leme678727a2016-09-21 17:22:11 -0700278static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
Felipe Lemebda15a02016-11-16 17:48:25 -0800279 const CommandOptions& options = Dumpstate::DEFAULT_DUMPSYS,
Vishnu Nair6921f802017-11-22 09:17:23 -0800280 long dumpsysTimeoutMs = 0) {
281 return ds.RunDumpsys(title, dumpsysArgs, options, dumpsysTimeoutMs);
Felipe Leme678727a2016-09-21 17:22:11 -0700282}
283static int DumpFile(const std::string& title, const std::string& path) {
284 return ds.DumpFile(title, path);
285}
Felipe Lemee82a27d2016-01-05 13:35:44 -0800286
Felipe Lemee844a9d2016-09-21 15:01:39 -0700287// Relative directory (inside the zip) for all files copied as-is into the bugreport.
288static const std::string ZIP_ROOT_DIR = "FS";
289
Vishnu Naire97d6122018-01-18 13:58:56 -0800290static const std::string kProtoPath = "proto/";
291static const std::string kProtoExt = ".proto";
Jie Song9fbfad02017-06-20 16:29:42 -0700292static const std::string kDumpstateBoardFiles[] = {
293 "dumpstate_board.txt",
Felipe Leme95d6ca52017-08-01 16:35:56 -0700294 "dumpstate_board.bin"
Jie Song9fbfad02017-06-20 16:29:42 -0700295};
296static const int NUM_OF_DUMPS = arraysize(kDumpstateBoardFiles);
297
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700298static constexpr char PROPERTY_LAST_ID[] = "dumpstate.last_id";
Felipe Lemed071c682016-10-20 16:48:00 -0700299static constexpr char PROPERTY_VERSION[] = "dumpstate.version";
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700300
Felipe Lemef0292972016-11-22 13:57:05 -0800301static const CommandOptions AS_ROOT_20 = CommandOptions::WithTimeout(20).AsRoot().Build();
302
Narayan Kamath8f788292017-05-25 13:20:39 +0100303/*
Narayan Kamathbd863722017-06-01 18:50:12 +0100304 * Returns a vector of dump fds under |dir_path| with a given |file_prefix|.
305 * The returned vector is sorted by the mtimes of the dumps. If |limit_by_mtime|
306 * is set, the vector only contains files that were written in the last 30 minutes.
Narayan Kamath8f788292017-05-25 13:20:39 +0100307 */
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700308static std::vector<DumpData> GetDumpFds(const std::string& dir_path,
309 const std::string& file_prefix,
Elliott Hughesdb6d2112019-09-26 15:24:51 -0700310 bool limit_by_mtime) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100311 const time_t thirty_minutes_ago = ds.now_ - 60 * 30;
312
Narayan Kamathbd863722017-06-01 18:50:12 +0100313 std::unique_ptr<DIR, decltype(&closedir)> dump_dir(opendir(dir_path.c_str()), closedir);
Narayan Kamath8f788292017-05-25 13:20:39 +0100314
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700315 if (dump_dir == nullptr) {
316 MYLOGW("Unable to open directory %s: %s\n", dir_path.c_str(), strerror(errno));
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700317 return std::vector<DumpData>();
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700318 }
319
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700320 std::vector<DumpData> dump_data;
Narayan Kamathbd863722017-06-01 18:50:12 +0100321 struct dirent* entry = nullptr;
322 while ((entry = readdir(dump_dir.get()))) {
323 if (entry->d_type != DT_REG) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100324 continue;
325 }
326
Narayan Kamathbd863722017-06-01 18:50:12 +0100327 const std::string base_name(entry->d_name);
328 if (base_name.find(file_prefix) != 0) {
329 continue;
330 }
331
332 const std::string abs_path = dir_path + base_name;
333 android::base::unique_fd fd(
334 TEMP_FAILURE_RETRY(open(abs_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW | O_NONBLOCK)));
335 if (fd == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700336 MYLOGW("Unable to open dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamathbd863722017-06-01 18:50:12 +0100337 break;
338 }
339
340 struct stat st = {};
341 if (fstat(fd, &st) == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700342 MYLOGW("Unable to stat dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamath8f788292017-05-25 13:20:39 +0100343 continue;
344 }
345
Narayan Kamath3f31b632018-02-22 19:42:36 +0000346 if (limit_by_mtime && st.st_mtime < thirty_minutes_ago) {
Narayan Kamathbd863722017-06-01 18:50:12 +0100347 MYLOGI("Excluding stale dump file: %s\n", abs_path.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100348 continue;
349 }
350
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700351 dump_data.emplace_back(DumpData{abs_path, std::move(fd), st.st_mtime});
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700352 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100353
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700354 return dump_data;
Narayan Kamath8f788292017-05-25 13:20:39 +0100355}
356
Narayan Kamathbd863722017-06-01 18:50:12 +0100357static bool AddDumps(const std::vector<DumpData>::const_iterator start,
358 const std::vector<DumpData>::const_iterator end,
359 const char* type_name, const bool add_to_zip) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100360 bool dumped = false;
Narayan Kamathbd863722017-06-01 18:50:12 +0100361 for (auto it = start; it != end; ++it) {
362 const std::string& name = it->name;
363 const int fd = it->fd;
Narayan Kamath8f788292017-05-25 13:20:39 +0100364 dumped = true;
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100365
366 // Seek to the beginning of the file before dumping any data. A given
367 // DumpData entry might be dumped multiple times in the report.
368 //
369 // For example, the most recent ANR entry is dumped to the body of the
370 // main entry and it also shows up as a separate entry in the bugreport
371 // ZIP file.
372 if (lseek(fd, 0, SEEK_SET) != static_cast<off_t>(0)) {
373 MYLOGE("Unable to add %s to zip file, lseek failed: %s\n", name.c_str(),
374 strerror(errno));
375 }
376
Narayan Kamath8f788292017-05-25 13:20:39 +0100377 if (ds.IsZipping() && add_to_zip) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800378 if (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + name, fd, /* timeout = */ 0ms) != OK) {
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100379 MYLOGE("Unable to add %s to zip file, addZipEntryFromFd failed\n", name.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100380 }
381 } else {
382 dump_file_from_fd(type_name, name.c_str(), fd);
383 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100384 }
385
386 return dumped;
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700387}
388
Felipe Leme635ca312016-01-05 14:23:02 -0800389// for_each_pid() callback to get mount info about a process.
Felipe Leme4c2d6632016-09-28 14:32:00 -0700390void do_mountinfo(int pid, const char* name __attribute__((unused))) {
Felipe Leme635ca312016-01-05 14:23:02 -0800391 char path[PATH_MAX];
392
393 // Gets the the content of the /proc/PID/ns/mnt link, so only unique mount points
394 // are added.
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700395 snprintf(path, sizeof(path), "/proc/%d/ns/mnt", pid);
Felipe Leme635ca312016-01-05 14:23:02 -0800396 char linkname[PATH_MAX];
397 ssize_t r = readlink(path, linkname, PATH_MAX);
398 if (r == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800399 MYLOGE("Unable to read link for %s: %s\n", path, strerror(errno));
Felipe Leme635ca312016-01-05 14:23:02 -0800400 return;
401 }
402 linkname[r] = '\0';
403
404 if (mount_points.find(linkname) == mount_points.end()) {
405 // First time this mount point was found: add it
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700406 snprintf(path, sizeof(path), "/proc/%d/mountinfo", pid);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700407 if (ds.AddZipEntry(ZIP_ROOT_DIR + path, path)) {
Felipe Leme635ca312016-01-05 14:23:02 -0800408 mount_points.insert(linkname);
409 } else {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800410 MYLOGE("Unable to add mountinfo %s to zip file\n", path);
Felipe Leme635ca312016-01-05 14:23:02 -0800411 }
412 }
413}
414
415void add_mountinfo() {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700416 if (!ds.IsZipping()) return;
Felipe Leme678727a2016-09-21 17:22:11 -0700417 std::string title = "MOUNT INFO";
Felipe Leme635ca312016-01-05 14:23:02 -0800418 mount_points.clear();
Felipe Leme46b85da2016-11-21 17:40:45 -0800419 DurationReporter duration_reporter(title, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700420 for_each_pid(do_mountinfo, nullptr);
421 MYLOGD("%s: %d entries added to zip file\n", title.c_str(), (int)mount_points.size());
Felipe Leme635ca312016-01-05 14:23:02 -0800422}
423
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700424static void dump_dev_files(const char *title, const char *driverpath, const char *filename)
425{
426 DIR *d;
427 struct dirent *de;
428 char path[PATH_MAX];
429
430 d = opendir(driverpath);
Yi Kong19d5c002018-07-20 13:39:55 -0700431 if (d == nullptr) {
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700432 return;
433 }
434
435 while ((de = readdir(d))) {
436 if (de->d_type != DT_LNK) {
437 continue;
438 }
439 snprintf(path, sizeof(path), "%s/%s/%s", driverpath, de->d_name, filename);
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700440 DumpFile(title, path);
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700441 }
442
443 closedir(d);
444}
445
Mark Salyzyn326842f2015-04-30 09:49:41 -0700446static bool skip_not_stat(const char *path) {
447 static const char stat[] = "/stat";
448 size_t len = strlen(path);
449 if (path[len - 1] == '/') { /* Directory? */
450 return false;
451 }
452 return strcmp(path + len - sizeof(stat) + 1, stat); /* .../stat? */
453}
454
Felipe Leme4c2d6632016-09-28 14:32:00 -0700455static bool skip_none(const char* path __attribute__((unused))) {
Felipe Lemee82a27d2016-01-05 13:35:44 -0800456 return false;
457}
458
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700459unsigned long worst_write_perf = 20000; /* in KB/s */
Mark Salyzyn326842f2015-04-30 09:49:41 -0700460
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800461//
462// stat offsets
463// Name units description
464// ---- ----- -----------
465// read I/Os requests number of read I/Os processed
466#define __STAT_READ_IOS 0
467// read merges requests number of read I/Os merged with in-queue I/O
468#define __STAT_READ_MERGES 1
469// read sectors sectors number of sectors read
470#define __STAT_READ_SECTORS 2
471// read ticks milliseconds total wait time for read requests
472#define __STAT_READ_TICKS 3
473// write I/Os requests number of write I/Os processed
474#define __STAT_WRITE_IOS 4
475// write merges requests number of write I/Os merged with in-queue I/O
476#define __STAT_WRITE_MERGES 5
477// write sectors sectors number of sectors written
478#define __STAT_WRITE_SECTORS 6
479// write ticks milliseconds total wait time for write requests
480#define __STAT_WRITE_TICKS 7
481// in_flight requests number of I/Os currently in flight
482#define __STAT_IN_FLIGHT 8
483// io_ticks milliseconds total time this block device has been active
484#define __STAT_IO_TICKS 9
485// time_in_queue milliseconds total wait time for all requests
486#define __STAT_IN_QUEUE 10
487#define __STAT_NUMBER_FIELD 11
488//
489// read I/Os, write I/Os
490// =====================
491//
492// These values increment when an I/O request completes.
493//
494// read merges, write merges
495// =========================
496//
497// These values increment when an I/O request is merged with an
498// already-queued I/O request.
499//
500// read sectors, write sectors
501// ===========================
502//
503// These values count the number of sectors read from or written to this
504// block device. The "sectors" in question are the standard UNIX 512-byte
505// sectors, not any device- or filesystem-specific block size. The
506// counters are incremented when the I/O completes.
507#define SECTOR_SIZE 512
508//
509// read ticks, write ticks
510// =======================
511//
512// These values count the number of milliseconds that I/O requests have
513// waited on this block device. If there are multiple I/O requests waiting,
514// these values will increase at a rate greater than 1000/second; for
515// example, if 60 read requests wait for an average of 30 ms, the read_ticks
516// field will increase by 60*30 = 1800.
517//
518// in_flight
519// =========
520//
521// This value counts the number of I/O requests that have been issued to
522// the device driver but have not yet completed. It does not include I/O
523// requests that are in the queue but not yet issued to the device driver.
524//
525// io_ticks
526// ========
527//
528// This value counts the number of milliseconds during which the device has
529// had I/O requests queued.
530//
531// time_in_queue
532// =============
533//
534// This value counts the number of milliseconds that I/O requests have waited
535// on this block device. If there are multiple I/O requests waiting, this
536// value will increase as the product of the number of milliseconds times the
537// number of requests waiting (see "read ticks" above for an example).
538#define S_TO_MS 1000
539//
540
Mark Salyzyn326842f2015-04-30 09:49:41 -0700541static int dump_stat_from_fd(const char *title __unused, const char *path, int fd) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800542 unsigned long long fields[__STAT_NUMBER_FIELD];
Mark Salyzyn326842f2015-04-30 09:49:41 -0700543 bool z;
Yi Kong19d5c002018-07-20 13:39:55 -0700544 char *cp, *buffer = nullptr;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700545 size_t i = 0;
Josh Gao7c4258c2018-06-25 13:40:08 -0700546 FILE *fp = fdopen(dup(fd), "rb");
Mark Salyzyn326842f2015-04-30 09:49:41 -0700547 getline(&buffer, &i, fp);
548 fclose(fp);
549 if (!buffer) {
550 return -errno;
551 }
552 i = strlen(buffer);
553 while ((i > 0) && (buffer[i - 1] == '\n')) {
554 buffer[--i] = '\0';
555 }
556 if (!*buffer) {
557 free(buffer);
558 return 0;
559 }
560 z = true;
561 for (cp = buffer, i = 0; i < (sizeof(fields) / sizeof(fields[0])); ++i) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800562 fields[i] = strtoull(cp, &cp, 10);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700563 if (fields[i] != 0) {
564 z = false;
565 }
566 }
567 if (z) { /* never accessed */
568 free(buffer);
569 return 0;
570 }
571
Wei Wang509bb5d2017-06-09 14:42:12 -0700572 if (!strncmp(path, BLK_DEV_SYS_DIR, sizeof(BLK_DEV_SYS_DIR) - 1)) {
573 path += sizeof(BLK_DEV_SYS_DIR) - 1;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700574 }
Wei Wang1dc1ef52017-06-12 11:28:37 -0700575
576 printf("%-30s:%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s\n%-30s:\t%s\n", "Block-Dev",
577 "R-IOs", "R-merg", "R-sect", "R-wait", "W-IOs", "W-merg", "W-sect",
578 "W-wait", "in-fli", "activ", "T-wait", path, buffer);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700579 free(buffer);
580
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800581 if (fields[__STAT_IO_TICKS]) {
582 unsigned long read_perf = 0;
583 unsigned long read_ios = 0;
584 if (fields[__STAT_READ_TICKS]) {
585 unsigned long long divisor = fields[__STAT_READ_TICKS]
586 * fields[__STAT_IO_TICKS];
587 read_perf = ((unsigned long long)SECTOR_SIZE
588 * fields[__STAT_READ_SECTORS]
589 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
590 / divisor;
591 read_ios = ((unsigned long long)S_TO_MS * fields[__STAT_READ_IOS]
592 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
593 / divisor;
594 }
595
596 unsigned long write_perf = 0;
597 unsigned long write_ios = 0;
598 if (fields[__STAT_WRITE_TICKS]) {
599 unsigned long long divisor = fields[__STAT_WRITE_TICKS]
600 * fields[__STAT_IO_TICKS];
601 write_perf = ((unsigned long long)SECTOR_SIZE
602 * fields[__STAT_WRITE_SECTORS]
603 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
604 / divisor;
605 write_ios = ((unsigned long long)S_TO_MS * fields[__STAT_WRITE_IOS]
606 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
607 / divisor;
608 }
609
610 unsigned queue = (fields[__STAT_IN_QUEUE]
611 + (fields[__STAT_IO_TICKS] >> 1))
612 / fields[__STAT_IO_TICKS];
613
614 if (!write_perf && !write_ios) {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700615 printf("%-30s: perf(ios) rd: %luKB/s(%lu/s) q: %u\n", path, read_perf, read_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800616 } else {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700617 printf("%-30s: perf(ios) rd: %luKB/s(%lu/s) wr: %luKB/s(%lu/s) q: %u\n", path, read_perf,
Felipe Lemed8b94e52016-12-08 10:21:44 -0800618 read_ios, write_perf, write_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800619 }
620
621 /* bugreport timeout factor adjustment */
622 if ((write_perf > 1) && (write_perf < worst_write_perf)) {
623 worst_write_perf = write_perf;
624 }
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700625 }
Mark Salyzyn326842f2015-04-30 09:49:41 -0700626 return 0;
627}
628
Yao Chenbe3bbc12018-01-17 16:31:10 -0800629static const long MINIMUM_LOGCAT_TIMEOUT_MS = 50000;
630
631/* timeout in ms to read a list of buffers */
632static unsigned long logcat_timeout(const std::vector<std::string>& buffers) {
633 unsigned long timeout_ms = 0;
634 for (const auto& buffer : buffers) {
635 log_id_t id = android_name_to_log_id(buffer.c_str());
636 unsigned long property_size = __android_logger_get_buffer_size(id);
637 /* Engineering margin is ten-fold our guess */
638 timeout_ms += 10 * (property_size + worst_write_perf) / worst_write_perf;
639 }
640 return timeout_ms > MINIMUM_LOGCAT_TIMEOUT_MS ? timeout_ms : MINIMUM_LOGCAT_TIMEOUT_MS;
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700641}
642
Nandana Duttd2f5f082019-01-18 17:13:52 +0000643Dumpstate::ConsentCallback::ConsentCallback() : result_(UNAVAILABLE), start_time_(Nanotime()) {
644}
645
646android::binder::Status Dumpstate::ConsentCallback::onReportApproved() {
647 std::lock_guard<std::mutex> lock(lock_);
648 result_ = APPROVED;
649 MYLOGD("User approved consent to share bugreport\n");
Paul Chang0d2aad72020-02-13 20:04:03 +0800650
651 // Maybe copy screenshot so calling app can display the screenshot to the user as soon as
652 // consent is granted.
653 if (ds.options_->is_screenshot_copied) {
654 return android::binder::Status::ok();
655 }
656
657 if (!ds.options_->do_screenshot || ds.options_->screenshot_fd.get() == -1 ||
658 !ds.do_early_screenshot_) {
659 return android::binder::Status::ok();
660 }
661
662 bool copy_succeeded = android::os::CopyFileToFd(ds.screenshot_path_,
663 ds.options_->screenshot_fd.get());
664 ds.options_->is_screenshot_copied = copy_succeeded;
665 if (copy_succeeded) {
666 android::os::UnlinkAndLogOnError(ds.screenshot_path_);
667 }
Nandana Duttd2f5f082019-01-18 17:13:52 +0000668 return android::binder::Status::ok();
669}
670
671android::binder::Status Dumpstate::ConsentCallback::onReportDenied() {
672 std::lock_guard<std::mutex> lock(lock_);
673 result_ = DENIED;
674 MYLOGW("User denied consent to share bugreport\n");
675 return android::binder::Status::ok();
676}
677
678UserConsentResult Dumpstate::ConsentCallback::getResult() {
679 std::lock_guard<std::mutex> lock(lock_);
680 return result_;
681}
682
683uint64_t Dumpstate::ConsentCallback::getElapsedTimeMs() const {
Hunter Knepshieldf0a39052020-01-03 14:53:04 -0800684 return (Nanotime() - start_time_) / NANOS_PER_MILLI;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000685}
686
Felipe Leme2b9b06c2016-10-14 09:13:06 -0700687void Dumpstate::PrintHeader() const {
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700688 std::string build, fingerprint, radio, bootloader, network;
689 char date[80];
Colin Crossf45fa6b2012-03-26 12:38:26 -0700690
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700691 build = android::base::GetProperty("ro.build.display.id", "(unknown)");
692 fingerprint = android::base::GetProperty("ro.build.fingerprint", "(unknown)");
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700693 radio = android::base::GetProperty("gsm.version.baseband", "(unknown)");
694 bootloader = android::base::GetProperty("ro.bootloader", "(unknown)");
695 network = android::base::GetProperty("gsm.operator.alpha", "(unknown)");
Felipe Lemebbaf3c12016-10-11 14:32:25 -0700696 strftime(date, sizeof(date), "%Y-%m-%d %H:%M:%S", localtime(&now_));
Colin Crossf45fa6b2012-03-26 12:38:26 -0700697
Felipe Lemed8b94e52016-12-08 10:21:44 -0800698 printf("========================================================\n");
699 printf("== dumpstate: %s\n", date);
700 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -0700701
Felipe Lemed8b94e52016-12-08 10:21:44 -0800702 printf("\n");
703 printf("Build: %s\n", build.c_str());
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700704 // NOTE: fingerprint entry format is important for other tools.
Felipe Lemed8b94e52016-12-08 10:21:44 -0800705 printf("Build fingerprint: '%s'\n", fingerprint.c_str());
706 printf("Bootloader: %s\n", bootloader.c_str());
707 printf("Radio: %s\n", radio.c_str());
708 printf("Network: %s\n", network.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100709 int64_t module_metadata_version = android::os::GetModuleMetadataVersion();
710 if (module_metadata_version != 0) {
711 printf("Module Metadata version: %" PRId64 "\n", module_metadata_version);
712 }
Colin Crossf45fa6b2012-03-26 12:38:26 -0700713
Felipe Lemed8b94e52016-12-08 10:21:44 -0800714 printf("Kernel: ");
Felipe Lemef0292972016-11-22 13:57:05 -0800715 DumpFileToFd(STDOUT_FILENO, "", "/proc/version");
Felipe Lemed8b94e52016-12-08 10:21:44 -0800716 printf("Command line: %s\n", strtok(cmdline_buf, "\n"));
Felipe Leme7709f8a2017-12-05 09:30:09 -0800717 printf("Uptime: ");
718 RunCommandToFd(STDOUT_FILENO, "", {"uptime", "-p"},
719 CommandOptions::WithTimeout(1).Always().Build());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800720 printf("Bugreport format version: %s\n", version_.c_str());
Abhijeet Kaure370d682019-10-01 16:49:30 +0100721 printf("Dumpstate info: id=%d pid=%d dry_run=%d args=%s bugreport_mode=%s\n", id_, pid_,
722 PropertiesHelper::IsDryRun(), options_->args.c_str(), options_->bugreport_mode.c_str());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800723 printf("\n");
Felipe Leme78f2c862015-12-21 09:55:22 -0800724}
725
Felipe Leme24b66ee2016-06-16 10:55:26 -0700726// List of file extensions that can cause a zip file attachment to be rejected by some email
727// service providers.
728static const std::set<std::string> PROBLEMATIC_FILE_EXTENSIONS = {
729 ".ade", ".adp", ".bat", ".chm", ".cmd", ".com", ".cpl", ".exe", ".hta", ".ins", ".isp",
730 ".jar", ".jse", ".lib", ".lnk", ".mde", ".msc", ".msp", ".mst", ".pif", ".scr", ".sct",
731 ".shb", ".sys", ".vb", ".vbe", ".vbs", ".vxd", ".wsc", ".wsf", ".wsh"
732};
733
Vishnu Naire97d6122018-01-18 13:58:56 -0800734status_t Dumpstate::AddZipEntryFromFd(const std::string& entry_name, int fd,
735 std::chrono::milliseconds timeout = 0ms) {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700736 if (!IsZipping()) {
737 MYLOGD("Not adding zip entry %s from fd because it's not a zipped bugreport\n",
738 entry_name.c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -0800739 return INVALID_OPERATION;
Felipe Leme111b9d02016-02-03 09:28:24 -0800740 }
Felipe Leme24b66ee2016-06-16 10:55:26 -0700741 std::string valid_name = entry_name;
742
743 // Rename extension if necessary.
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -0700744 size_t idx = entry_name.rfind('.');
Felipe Leme24b66ee2016-06-16 10:55:26 -0700745 if (idx != std::string::npos) {
746 std::string extension = entry_name.substr(idx);
747 std::transform(extension.begin(), extension.end(), extension.begin(), ::tolower);
748 if (PROBLEMATIC_FILE_EXTENSIONS.count(extension) != 0) {
749 valid_name = entry_name + ".renamed";
750 MYLOGI("Renaming entry %s to %s\n", entry_name.c_str(), valid_name.c_str());
751 }
752 }
753
Felipe Leme6fe9db62016-02-12 09:04:16 -0800754 // Logging statement below is useful to time how long each entry takes, but it's too verbose.
755 // MYLOGD("Adding zip entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700756 int32_t err = zip_writer_->StartEntryWithTime(valid_name.c_str(), ZipWriter::kCompress,
757 get_mtime(fd, ds.now_));
Felipe Leme1d486fe2016-10-14 18:06:47 -0700758 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700759 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", valid_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700760 ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800761 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800762 }
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000763 bool finished_entry = false;
764 auto finish_entry = [this, &finished_entry] {
765 if (!finished_entry) {
766 // This should only be called when we're going to return an earlier error,
767 // which would've been logged. This may imply the file is already corrupt
768 // and any further logging from FinishEntry is more likely to mislead than
769 // not.
770 this->zip_writer_->FinishEntry();
771 }
772 };
773 auto scope_guard = android::base::make_scope_guard(finish_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -0800774 auto start = std::chrono::steady_clock::now();
775 auto end = start + timeout;
776 struct pollfd pfd = {fd, POLLIN};
Felipe Lemee82a27d2016-01-05 13:35:44 -0800777
Felipe Leme770410d2016-01-26 17:07:14 -0800778 std::vector<uint8_t> buffer(65536);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800779 while (1) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800780 if (timeout.count() > 0) {
781 // lambda to recalculate the timeout.
782 auto time_left_ms = [end]() {
783 auto now = std::chrono::steady_clock::now();
784 auto diff = std::chrono::duration_cast<std::chrono::milliseconds>(end - now);
785 return std::max(diff.count(), 0LL);
786 };
787
788 int rc = TEMP_FAILURE_RETRY(poll(&pfd, 1, time_left_ms()));
789 if (rc < 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000790 MYLOGE("Error in poll while adding from fd to zip entry %s:%s\n",
791 entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800792 return -errno;
793 } else if (rc == 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000794 MYLOGE("Timed out adding from fd to zip entry %s:%s Timeout:%lldms\n",
Vishnu Naire97d6122018-01-18 13:58:56 -0800795 entry_name.c_str(), strerror(errno), timeout.count());
796 return TIMED_OUT;
797 }
798 }
799
Zach Riggle22200402016-08-18 01:01:24 -0400800 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800801 if (bytes_read == 0) {
802 break;
803 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800804 MYLOGE("read(%s): %s\n", entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800805 return -errno;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800806 }
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700807 err = zip_writer_->WriteBytes(buffer.data(), bytes_read);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800808 if (err) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700809 MYLOGE("zip_writer_->WriteBytes(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800810 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800811 }
812 }
813
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700814 err = zip_writer_->FinishEntry();
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000815 finished_entry = true;
Felipe Leme1d486fe2016-10-14 18:06:47 -0700816 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700817 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800818 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800819 }
820
Vishnu Naire97d6122018-01-18 13:58:56 -0800821 return OK;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800822}
823
Felipe Leme1d486fe2016-10-14 18:06:47 -0700824bool Dumpstate::AddZipEntry(const std::string& entry_name, const std::string& entry_path) {
825 android::base::unique_fd fd(
826 TEMP_FAILURE_RETRY(open(entry_path.c_str(), O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
Andreas Gampeaff68432016-07-18 18:01:27 -0700827 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800828 MYLOGE("open(%s): %s\n", entry_path.c_str(), strerror(errno));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800829 return false;
830 }
831
Vishnu Naire97d6122018-01-18 13:58:56 -0800832 return (AddZipEntryFromFd(entry_name, fd.get()) == OK);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800833}
834
835/* adds a file to the existing zipped bugreport */
Felipe Leme4c2d6632016-09-28 14:32:00 -0700836static int _add_file_from_fd(const char* title __attribute__((unused)), const char* path, int fd) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800837 return (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + path, fd) == OK) ? 0 : 1;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800838}
839
Felipe Leme1d486fe2016-10-14 18:06:47 -0700840void Dumpstate::AddDir(const std::string& dir, bool recursive) {
841 if (!IsZipping()) {
842 MYLOGD("Not adding dir %s because it's not a zipped bugreport\n", dir.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800843 return;
844 }
Felipe Leme678727a2016-09-21 17:22:11 -0700845 MYLOGD("Adding dir %s (recursive: %d)\n", dir.c_str(), recursive);
Felipe Leme46b85da2016-11-21 17:40:45 -0800846 DurationReporter duration_reporter(dir, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700847 dump_files("", dir.c_str(), recursive ? skip_none : is_dir, _add_file_from_fd);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800848}
849
Felipe Leme1d486fe2016-10-14 18:06:47 -0700850bool Dumpstate::AddTextZipEntry(const std::string& entry_name, const std::string& content) {
851 if (!IsZipping()) {
852 MYLOGD("Not adding text zip entry %s because it's not a zipped bugreport\n",
853 entry_name.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800854 return false;
855 }
Felipe Lemecbce55d2016-02-08 09:53:18 -0800856 MYLOGD("Adding zip text entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700857 int32_t err = zip_writer_->StartEntryWithTime(entry_name.c_str(), ZipWriter::kCompress, ds.now_);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700858 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700859 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700860 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800861 return false;
862 }
863
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700864 err = zip_writer_->WriteBytes(content.c_str(), content.length());
Felipe Leme1d486fe2016-10-14 18:06:47 -0700865 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700866 MYLOGE("zip_writer_->WriteBytes(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700867 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800868 return false;
869 }
870
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700871 err = zip_writer_->FinishEntry();
Felipe Leme1d486fe2016-10-14 18:06:47 -0700872 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700873 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800874 return false;
875 }
876
877 return true;
878}
879
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800880static void DoKmsg() {
881 struct stat st;
882 if (!stat(PSTORE_LAST_KMSG, &st)) {
883 /* Also TODO: Make console-ramoops CAP_SYSLOG protected. */
884 DumpFile("LAST KMSG", PSTORE_LAST_KMSG);
885 } else if (!stat(ALT_PSTORE_LAST_KMSG, &st)) {
886 DumpFile("LAST KMSG", ALT_PSTORE_LAST_KMSG);
887 } else {
888 /* TODO: Make last_kmsg CAP_SYSLOG protected. b/5555691 */
889 DumpFile("LAST KMSG", "/proc/last_kmsg");
890 }
891}
892
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800893static void DoKernelLogcat() {
Yao Chenbe3bbc12018-01-17 16:31:10 -0800894 unsigned long timeout_ms = logcat_timeout({"kernel"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800895 RunCommand(
896 "KERNEL LOG",
897 {"logcat", "-b", "kernel", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
898 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
899}
900
Nandana Duttdb379fa2019-10-09 16:54:41 +0100901static void DoSystemLogcat(time_t since) {
902 char since_str[80];
903 strftime(since_str, sizeof(since_str), "%Y-%m-%d %H:%M:%S.000", localtime(&since));
904
905 unsigned long timeout_ms = logcat_timeout({"main", "system", "crash"});
906 RunCommand("SYSTEM LOG",
907 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v", "-T",
908 since_str},
909 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
910}
911
Hunter Knepshield820f9bc2020-02-05 20:10:53 -0800912static void DoRadioLogcat() {
913 unsigned long timeout_ms = logcat_timeout({"radio"});
914 RunCommand(
915 "RADIO LOG",
916 {"logcat", "-b", "radio", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
917 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
918}
919
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800920static void DoLogcat() {
Vishnu Nair6921f802017-11-22 09:17:23 -0800921 unsigned long timeout_ms;
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800922 // DumpFile("EVENT LOG TAGS", "/etc/event-log-tags");
923 // calculate timeout
Yao Chenbe3bbc12018-01-17 16:31:10 -0800924 timeout_ms = logcat_timeout({"main", "system", "crash"});
Tony Makae737652017-03-30 17:47:09 +0100925 RunCommand("SYSTEM LOG",
Vishnu Nair6921f802017-11-22 09:17:23 -0800926 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
927 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -0800928 timeout_ms = logcat_timeout({"events"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800929 RunCommand(
930 "EVENT LOG",
931 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +0100932 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Yao Chenbe3bbc12018-01-17 16:31:10 -0800933 timeout_ms = logcat_timeout({"stats"});
934 RunCommand(
935 "STATS LOG",
936 {"logcat", "-b", "stats", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +0100937 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Hunter Knepshield820f9bc2020-02-05 20:10:53 -0800938 DoRadioLogcat();
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800939
940 RunCommand("LOG STATISTICS", {"logcat", "-b", "all", "-S"});
941
942 /* kernels must set CONFIG_PSTORE_PMSG, slice up pstore with device tree */
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800943 RunCommand("LAST LOGCAT", {"logcat", "-L", "-b", "all", "-v", "threadtime", "-v", "printable",
944 "-v", "uid", "-d", "*:v"});
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800945}
946
Mike Ma5c267872019-08-21 11:31:34 -0700947static void DumpIncidentReport() {
948 if (!ds.IsZipping()) {
949 MYLOGD("Not dumping incident report because it's not a zipped bugreport\n");
950 return;
951 }
952 DurationReporter duration_reporter("INCIDENT REPORT");
953 const std::string path = ds.bugreport_internal_dir_ + "/tmp_incident_report";
954 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
955 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
956 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
957 if (fd < 0) {
958 MYLOGE("Could not open %s to dump incident report.\n", path.c_str());
959 return;
960 }
961 RunCommandToFd(fd, "", {"incident", "-u"}, CommandOptions::WithTimeout(120).Build());
962 bool empty = 0 == lseek(fd, 0, SEEK_END);
963 if (!empty) {
964 // Use a different name from "incident.proto"
965 // /proto/incident.proto is reserved for incident service dump
966 // i.e. metadata for debugging.
967 ds.AddZipEntry(kProtoPath + "incident_report" + kProtoExt, path);
968 }
969 unlink(path.c_str());
970}
971
Sunny Goyal35949782019-11-19 15:54:36 -0800972static void DumpVisibleWindowViews() {
973 if (!ds.IsZipping()) {
974 MYLOGD("Not dumping visible views because it's not a zipped bugreport\n");
975 return;
976 }
977 DurationReporter duration_reporter("VISIBLE WINDOW VIEWS");
978 const std::string path = ds.bugreport_internal_dir_ + "/tmp_visible_window_views";
979 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
980 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
981 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
982 if (fd < 0) {
983 MYLOGE("Could not open %s to dump visible views.\n", path.c_str());
984 return;
985 }
986 RunCommandToFd(fd, "", {"cmd", "window", "dump-visible-window-views"},
987 CommandOptions::WithTimeout(120).Build());
988 bool empty = 0 == lseek(fd, 0, SEEK_END);
989 if (!empty) {
990 ds.AddZipEntry("visible_windows.zip", path);
991 } else {
992 MYLOGW("Failed to dump visible windows\n");
993 }
994 unlink(path.c_str());
995}
996
Jayachandran Ca94c7172017-06-10 15:08:12 -0700997static void DumpIpTablesAsRoot() {
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700998 RunCommand("IPTABLES", {"iptables", "-L", "-nvx"});
999 RunCommand("IP6TABLES", {"ip6tables", "-L", "-nvx"});
Erik Kline32af8c22016-09-28 17:26:26 +09001000 RunCommand("IPTABLES NAT", {"iptables", "-t", "nat", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001001 /* no ip6 nat */
Erik Kline32af8c22016-09-28 17:26:26 +09001002 RunCommand("IPTABLES MANGLE", {"iptables", "-t", "mangle", "-L", "-nvx"});
1003 RunCommand("IP6TABLES MANGLE", {"ip6tables", "-t", "mangle", "-L", "-nvx"});
1004 RunCommand("IPTABLES RAW", {"iptables", "-t", "raw", "-L", "-nvx"});
1005 RunCommand("IP6TABLES RAW", {"ip6tables", "-t", "raw", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001006}
1007
David Andersond9ba4752018-12-11 18:26:59 -08001008static void DumpDynamicPartitionInfo() {
1009 if (!::android::base::GetBoolProperty("ro.boot.dynamic_partitions", false)) {
1010 return;
1011 }
1012
1013 RunCommand("LPDUMP", {"lpdump", "--all"});
David Anderson6650ade2019-10-02 15:18:59 -07001014 RunCommand("DEVICE-MAPPER", {"gsid", "dump-device-mapper"});
David Andersond9ba4752018-12-11 18:26:59 -08001015}
1016
Narayan Kamath8f788292017-05-25 13:20:39 +01001017static void AddAnrTraceDir(const bool add_to_zip, const std::string& anr_traces_dir) {
1018 MYLOGD("AddAnrTraceDir(): dump_traces_file=%s, anr_traces_dir=%s\n", dump_traces_path,
1019 anr_traces_dir.c_str());
1020
1021 // If we're here, dump_traces_path will always be a temporary file
1022 // (created with mkostemp or similar) that contains dumps taken earlier
1023 // on in the process.
1024 if (dump_traces_path != nullptr) {
1025 if (add_to_zip) {
1026 ds.AddZipEntry(ZIP_ROOT_DIR + anr_traces_dir + "/traces-just-now.txt", dump_traces_path);
1027 } else {
1028 MYLOGD("Dumping current ANR traces (%s) to the main bugreport entry\n",
1029 dump_traces_path);
1030 ds.DumpFile("VM TRACES JUST NOW", dump_traces_path);
1031 }
1032
1033 const int ret = unlink(dump_traces_path);
1034 if (ret == -1) {
1035 MYLOGW("Error unlinking temporary trace path %s: %s\n", dump_traces_path,
1036 strerror(errno));
Felipe Lemee184f662016-10-27 10:04:47 -07001037 }
1038 }
1039
Narayan Kamathbd863722017-06-01 18:50:12 +01001040 // Add a specific message for the first ANR Dump.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001041 if (ds.anr_data_.size() > 0) {
1042 AddDumps(ds.anr_data_.begin(), ds.anr_data_.begin() + 1,
Narayan Kamathbd863722017-06-01 18:50:12 +01001043 "VM TRACES AT LAST ANR", add_to_zip);
1044
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001045 // The "last" ANR will always be included as separate entry in the zip file. In addition,
1046 // it will be present in the body of the main entry if |add_to_zip| == false.
1047 //
1048 // Historical ANRs are always included as separate entries in the bugreport zip file.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001049 AddDumps(ds.anr_data_.begin() + ((add_to_zip) ? 1 : 0), ds.anr_data_.end(),
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001050 "HISTORICAL ANR", true /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001051 } else {
Narayan Kamath8f788292017-05-25 13:20:39 +01001052 printf("*** NO ANRs to dump in %s\n\n", ANR_DIR.c_str());
1053 }
1054}
1055
1056static void AddAnrTraceFiles() {
1057 const bool add_to_zip = ds.IsZipping() && ds.version_ == VERSION_SPLIT_ANR;
1058
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001059 std::string anr_traces_dir = "/data/anr";
Narayan Kamath8f788292017-05-25 13:20:39 +01001060
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001061 AddAnrTraceDir(add_to_zip, anr_traces_dir);
Narayan Kamath8f788292017-05-25 13:20:39 +01001062
Makoto Onuki83ec63f2019-01-31 17:08:59 -08001063 RunCommand("ANR FILES", {"ls", "-lt", ANR_DIR});
1064
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001065 // Slow traces for slow operations.
Felipe Lemee184f662016-10-27 10:04:47 -07001066 struct stat st;
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001067 int i = 0;
1068 while (true) {
1069 const std::string slow_trace_path =
1070 anr_traces_dir + android::base::StringPrintf("slow%02d.txt", i);
1071 if (stat(slow_trace_path.c_str(), &st)) {
1072 // No traces file at this index, done with the files.
1073 break;
Felipe Lemee184f662016-10-27 10:04:47 -07001074 }
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001075 ds.DumpFile("VM TRACES WHEN SLOW", slow_trace_path.c_str());
1076 i++;
Felipe Lemee184f662016-10-27 10:04:47 -07001077 }
1078}
1079
Wei Wang509bb5d2017-06-09 14:42:12 -07001080static void DumpBlockStatFiles() {
1081 DurationReporter duration_reporter("DUMP BLOCK STAT");
Wei Wang509bb5d2017-06-09 14:42:12 -07001082
Wei Wang1dc1ef52017-06-12 11:28:37 -07001083 std::unique_ptr<DIR, std::function<int(DIR*)>> dirptr(opendir(BLK_DEV_SYS_DIR), closedir);
1084
1085 if (dirptr == nullptr) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001086 MYLOGE("Failed to open %s: %s\n", BLK_DEV_SYS_DIR, strerror(errno));
1087 return;
1088 }
1089
1090 printf("------ DUMP BLOCK STAT ------\n\n");
Wei Wang1dc1ef52017-06-12 11:28:37 -07001091 while (struct dirent *d = readdir(dirptr.get())) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001092 if ((d->d_name[0] == '.')
1093 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
1094 || (d->d_name[1] == '\0'))) {
1095 continue;
1096 }
1097 const std::string new_path =
1098 android::base::StringPrintf("%s/%s", BLK_DEV_SYS_DIR, d->d_name);
1099 printf("------ BLOCK STAT (%s) ------\n", new_path.c_str());
1100 dump_files("", new_path.c_str(), skip_not_stat, dump_stat_from_fd);
1101 printf("\n");
1102 }
Wei Wang1dc1ef52017-06-12 11:28:37 -07001103 return;
Wei Wang509bb5d2017-06-09 14:42:12 -07001104}
Jayachandran Ca94c7172017-06-10 15:08:12 -07001105
1106static void DumpPacketStats() {
1107 DumpFile("NETWORK DEV INFO", "/proc/net/dev");
1108 DumpFile("QTAGUID NETWORK INTERFACES INFO", "/proc/net/xt_qtaguid/iface_stat_all");
1109 DumpFile("QTAGUID NETWORK INTERFACES INFO (xt)", "/proc/net/xt_qtaguid/iface_stat_fmt");
1110 DumpFile("QTAGUID CTRL INFO", "/proc/net/xt_qtaguid/ctrl");
1111 DumpFile("QTAGUID STATS INFO", "/proc/net/xt_qtaguid/stats");
1112}
1113
1114static void DumpIpAddrAndRules() {
1115 /* The following have a tendency to get wedged when wifi drivers/fw goes belly-up. */
1116 RunCommand("NETWORK INTERFACES", {"ip", "link"});
1117 RunCommand("IPv4 ADDRESSES", {"ip", "-4", "addr", "show"});
1118 RunCommand("IPv6 ADDRESSES", {"ip", "-6", "addr", "show"});
1119 RunCommand("IP RULES", {"ip", "rule", "show"});
1120 RunCommand("IP RULES v6", {"ip", "-6", "rule", "show"});
1121}
1122
Nandana Dutt5c390032019-03-12 10:52:56 +00001123static Dumpstate::RunStatus RunDumpsysTextByPriority(const std::string& title, int priority,
1124 std::chrono::milliseconds timeout,
1125 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001126 auto start = std::chrono::steady_clock::now();
Vishnu Naire97d6122018-01-18 13:58:56 -08001127 sp<android::IServiceManager> sm = defaultServiceManager();
1128 Dumpsys dumpsys(sm.get());
Vishnu Naire97d6122018-01-18 13:58:56 -08001129 Vector<String16> args;
1130 Dumpsys::setServiceArgs(args, /* asProto = */ false, priority);
Vishnu Naire97d6122018-01-18 13:58:56 -08001131 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ false);
1132 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001133 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001134 std::string path(title);
1135 path.append(" - ").append(String8(service).c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -08001136 size_t bytes_written = 0;
Steven Moreland5a30d342019-10-08 13:53:28 -07001137 status_t status = dumpsys.startDumpThread(Dumpsys::Type::DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001138 if (status == OK) {
1139 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1140 std::chrono::duration<double> elapsed_seconds;
1141 status = dumpsys.writeDump(STDOUT_FILENO, service, service_timeout,
1142 /* as_proto = */ false, elapsed_seconds, bytes_written);
Vishnu Naire97d6122018-01-18 13:58:56 -08001143 dumpsys.writeDumpFooter(STDOUT_FILENO, service, elapsed_seconds);
1144 bool dump_complete = (status == OK);
1145 dumpsys.stopDumpThread(dump_complete);
1146 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001147
1148 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1149 std::chrono::steady_clock::now() - start);
1150 if (elapsed_duration > timeout) {
1151 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1152 elapsed_duration.count());
1153 break;
1154 }
1155 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001156 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001157}
1158
Vishnu Nair64afc022018-02-01 15:29:34 -08001159static void RunDumpsysText(const std::string& title, int priority,
1160 std::chrono::milliseconds timeout,
1161 std::chrono::milliseconds service_timeout) {
1162 DurationReporter duration_reporter(title);
1163 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1164 fsync(STDOUT_FILENO);
1165 RunDumpsysTextByPriority(title, priority, timeout, service_timeout);
1166}
1167
1168/* Dump all services registered with Normal or Default priority. */
Nandana Dutt5c390032019-03-12 10:52:56 +00001169static Dumpstate::RunStatus RunDumpsysTextNormalPriority(const std::string& title,
1170 std::chrono::milliseconds timeout,
1171 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001172 DurationReporter duration_reporter(title);
1173 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1174 fsync(STDOUT_FILENO);
1175 RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_NORMAL, timeout,
1176 service_timeout);
Nandana Dutt5c390032019-03-12 10:52:56 +00001177
1178 RETURN_IF_USER_DENIED_CONSENT();
1179
1180 return RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_DEFAULT, timeout,
1181 service_timeout);
Vishnu Nair64afc022018-02-01 15:29:34 -08001182}
1183
Nandana Dutt5c390032019-03-12 10:52:56 +00001184static Dumpstate::RunStatus RunDumpsysProto(const std::string& title, int priority,
1185 std::chrono::milliseconds timeout,
1186 std::chrono::milliseconds service_timeout) {
Luis Hector Chavez1e27b082018-03-22 15:36:42 -07001187 if (!ds.IsZipping()) {
1188 MYLOGD("Not dumping %s because it's not a zipped bugreport\n", title.c_str());
Nandana Dutt5c390032019-03-12 10:52:56 +00001189 return Dumpstate::RunStatus::OK;
Luis Hector Chavez1e27b082018-03-22 15:36:42 -07001190 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001191 sp<android::IServiceManager> sm = defaultServiceManager();
1192 Dumpsys dumpsys(sm.get());
1193 Vector<String16> args;
1194 Dumpsys::setServiceArgs(args, /* asProto = */ true, priority);
1195 DurationReporter duration_reporter(title);
1196
1197 auto start = std::chrono::steady_clock::now();
1198 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ true);
1199 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001200 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001201 std::string path(kProtoPath);
1202 path.append(String8(service).c_str());
1203 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL) {
1204 path.append("_CRITICAL");
1205 } else if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH) {
1206 path.append("_HIGH");
1207 }
1208 path.append(kProtoExt);
Steven Moreland5a30d342019-10-08 13:53:28 -07001209 status_t status = dumpsys.startDumpThread(Dumpsys::Type::DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001210 if (status == OK) {
1211 status = ds.AddZipEntryFromFd(path, dumpsys.getDumpFd(), service_timeout);
1212 bool dumpTerminated = (status == OK);
1213 dumpsys.stopDumpThread(dumpTerminated);
1214 }
1215 ZipWriter::FileEntry file_entry;
1216 ds.zip_writer_->GetLastEntry(&file_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -08001217
1218 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1219 std::chrono::steady_clock::now() - start);
1220 if (elapsed_duration > timeout) {
1221 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1222 elapsed_duration.count());
1223 break;
1224 }
1225 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001226 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001227}
1228
Nandana Dutta7db6342018-11-21 14:53:34 +00001229// Runs dumpsys on services that must dump first and will take less than 100ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001230static Dumpstate::RunStatus RunDumpsysCritical() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001231 RunDumpsysText("DUMPSYS CRITICAL", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1232 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Nandana Dutt5c390032019-03-12 10:52:56 +00001233
1234 RETURN_IF_USER_DENIED_CONSENT();
1235
1236 return RunDumpsysProto("DUMPSYS CRITICAL PROTO", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1237 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Vishnu Nair780b1282017-10-10 13:57:24 -07001238}
1239
1240// Runs dumpsys on services that must dump first but can take up to 250ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001241static Dumpstate::RunStatus RunDumpsysHigh() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001242 // TODO meminfo takes ~10s, connectivity takes ~5sec to dump. They are both
1243 // high priority. Reduce timeout once they are able to dump in a shorter time or
1244 // moved to a parallel task.
1245 RunDumpsysText("DUMPSYS HIGH", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1246 /* timeout= */ 90s, /* service_timeout= */ 30s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001247
1248 RETURN_IF_USER_DENIED_CONSENT();
1249
1250 return RunDumpsysProto("DUMPSYS HIGH PROTO", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1251 /* timeout= */ 5s, /* service_timeout= */ 1s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001252}
1253
1254// Runs dumpsys on services that must dump but can take up to 10s to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001255static Dumpstate::RunStatus RunDumpsysNormal() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001256 RunDumpsysTextNormalPriority("DUMPSYS", /* timeout= */ 90s, /* service_timeout= */ 10s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001257
1258 RETURN_IF_USER_DENIED_CONSENT();
1259
1260 return RunDumpsysProto("DUMPSYS PROTO", IServiceManager::DUMP_FLAG_PRIORITY_NORMAL,
1261 /* timeout= */ 90s, /* service_timeout= */ 10s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001262}
1263
Steven Moreland44cd9482018-01-04 16:24:13 -08001264static void DumpHals() {
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001265 if (!ds.IsZipping()) {
1266 RunCommand("HARDWARE HALS", {"lshal", "-lVSietrpc", "--types=b,c,l,z", "--debug"},
1267 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build());
1268 return;
1269 }
1270 DurationReporter duration_reporter("DUMP HALS");
1271 RunCommand("HARDWARE HALS", {"lshal", "-lVSietrpc", "--types=b,c,l,z"},
Greg Kaiser3dfeda32019-05-16 10:32:51 -07001272 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build());
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001273
Steven Moreland44cd9482018-01-04 16:24:13 -08001274 using android::hidl::manager::V1_0::IServiceManager;
1275 using android::hardware::defaultServiceManager;
1276
1277 sp<IServiceManager> sm = defaultServiceManager();
1278 if (sm == nullptr) {
1279 MYLOGE("Could not retrieve hwservicemanager to dump hals.\n");
1280 return;
1281 }
1282
1283 auto ret = sm->list([&](const auto& interfaces) {
1284 for (const std::string& interface : interfaces) {
1285 std::string cleanName = interface;
1286 std::replace_if(cleanName.begin(),
1287 cleanName.end(),
1288 [](char c) {
1289 return !isalnum(c) &&
1290 std::string("@-_:.").find(c) == std::string::npos;
1291 }, '_');
Nandana Dutt979388e2018-11-30 16:48:55 +00001292 const std::string path = ds.bugreport_internal_dir_ + "/lshal_debug_" + cleanName;
Steven Moreland44cd9482018-01-04 16:24:13 -08001293
1294 {
1295 auto fd = android::base::unique_fd(
1296 TEMP_FAILURE_RETRY(open(path.c_str(),
1297 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1298 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1299 if (fd < 0) {
1300 MYLOGE("Could not open %s to dump additional hal information.\n", path.c_str());
1301 continue;
1302 }
1303 RunCommandToFd(fd,
1304 "",
Steven Morelandc81cd3c2018-01-18 14:36:26 -08001305 {"lshal", "debug", "-E", interface},
Steven Moreland44cd9482018-01-04 16:24:13 -08001306 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
1307
1308 bool empty = 0 == lseek(fd, 0, SEEK_END);
1309 if (!empty) {
1310 ds.AddZipEntry("lshal-debug/" + cleanName + ".txt", path);
1311 }
1312 }
1313
1314 unlink(path.c_str());
1315 }
1316 });
1317
1318 if (!ret.isOk()) {
1319 MYLOGE("Could not list hals from hwservicemanager.\n");
1320 }
1321}
1322
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001323static void DumpExternalFragmentationInfo() {
1324 struct stat st;
1325 if (stat("/proc/buddyinfo", &st) != 0) {
1326 MYLOGE("Unable to dump external fragmentation info\n");
1327 return;
1328 }
1329
1330 printf("------ EXTERNAL FRAGMENTATION INFO ------\n");
1331 std::ifstream ifs("/proc/buddyinfo");
1332 auto unusable_index_regex = std::regex{"Node\\s+([0-9]+),\\s+zone\\s+(\\S+)\\s+(.*)"};
1333 for (std::string line; std::getline(ifs, line);) {
1334 std::smatch match_results;
1335 if (std::regex_match(line, match_results, unusable_index_regex)) {
1336 std::stringstream free_pages(std::string{match_results[3]});
1337 std::vector<int> free_pages_per_order(std::istream_iterator<int>{free_pages},
1338 std::istream_iterator<int>());
1339
1340 int total_free_pages = 0;
1341 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1342 total_free_pages += (free_pages_per_order[i] * std::pow(2, i));
1343 }
1344
1345 printf("Node %s, zone %8s", match_results[1].str().c_str(),
1346 match_results[2].str().c_str());
1347
1348 int usable_free_pages = total_free_pages;
1349 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1350 auto unusable_index = (total_free_pages - usable_free_pages) /
1351 static_cast<double>(total_free_pages);
1352 printf(" %5.3f", unusable_index);
1353 usable_free_pages -= (free_pages_per_order[i] * std::pow(2, i));
1354 }
1355
1356 printf("\n");
1357 }
1358 }
1359 printf("\n");
1360}
1361
Nandana Dutt5c390032019-03-12 10:52:56 +00001362// Dumps various things. Returns early with status USER_CONSENT_DENIED if user denies consent
1363// via the consent they are shown. Ignores other errors that occur while running various
1364// commands. The consent checking is currently done around long running tasks, which happen to
1365// be distributed fairly evenly throughout the function.
1366static Dumpstate::RunStatus dumpstate() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001367 DurationReporter duration_reporter("DUMPSTATE");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001368
Nandana Dutt5c390032019-03-12 10:52:56 +00001369 // Dump various things. Note that anything that takes "long" (i.e. several seconds) should
1370 // check intermittently (if it's intrerruptable like a foreach on pids) and/or should be wrapped
1371 // in a consent check (via RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK).
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -07001372 dump_dev_files("TRUSTY VERSION", "/sys/bus/platform/drivers/trusty", "trusty_version");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001373 RunCommand("UPTIME", {"uptime"});
Wei Wang509bb5d2017-06-09 14:42:12 -07001374 DumpBlockStatFiles();
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001375 DumpFile("MEMORY INFO", "/proc/meminfo");
1376 RunCommand("CPU INFO", {"top", "-b", "-n", "1", "-H", "-s", "6", "-o",
Felipe Leme30dbfa12016-09-02 12:43:26 -07001377 "pid,tid,user,pr,ni,%cpu,s,virt,res,pcy,cmd,name"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001378
1379 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "PROCRANK", {"procrank"}, AS_ROOT_20);
1380
Sunny Goyal35949782019-11-19 15:54:36 -08001381 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpVisibleWindowViews);
1382
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001383 DumpFile("VIRTUAL MEMORY STATS", "/proc/vmstat");
1384 DumpFile("VMALLOC INFO", "/proc/vmallocinfo");
1385 DumpFile("SLAB INFO", "/proc/slabinfo");
1386 DumpFile("ZONEINFO", "/proc/zoneinfo");
1387 DumpFile("PAGETYPEINFO", "/proc/pagetypeinfo");
1388 DumpFile("BUDDYINFO", "/proc/buddyinfo");
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001389 DumpExternalFragmentationInfo();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001390
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001391 DumpFile("KERNEL WAKE SOURCES", "/d/wakeup_sources");
1392 DumpFile("KERNEL CPUFREQ", "/sys/devices/system/cpu/cpu0/cpufreq/stats/time_in_state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001393
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001394 RunCommand("PROCESSES AND THREADS",
Yohei Yukawa591a72d2017-10-05 21:36:35 -07001395 {"ps", "-A", "-T", "-Z", "-O", "pri,nice,rtprio,sched,pcy,time"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001396
1397 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "LIBRANK", {"librank"},
1398 CommandOptions::AS_ROOT);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001399
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001400 DumpHals();
Steven Moreland81b429e2017-01-31 19:50:46 -08001401
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001402 RunCommand("PRINTENV", {"printenv"});
Elliott Hughes21b7c8d2016-10-28 08:53:02 -07001403 RunCommand("NETSTAT", {"netstat", "-nW"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001404 struct stat s;
1405 if (stat("/proc/modules", &s) != 0) {
1406 MYLOGD("Skipping 'lsmod' because /proc/modules does not exist\n");
1407 } else {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001408 RunCommand("LSMOD", {"lsmod"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001409 }
Michal Karpinski4db754f2015-12-11 18:04:32 +00001410
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001411 if (__android_logger_property_get_bool(
1412 "ro.logd.kernel", BOOL_DEFAULT_TRUE | BOOL_DEFAULT_FLAG_ENG | BOOL_DEFAULT_FLAG_SVELTE)) {
1413 DoKernelLogcat();
1414 } else {
1415 do_dmesg();
1416 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001417
Felipe Lemef0292972016-11-22 13:57:05 -08001418 RunCommand("LIST OF OPEN FILES", {"lsof"}, CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001419
1420 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(for_each_pid, do_showmap, "SMAPS OF ALL PROCESSES");
1421
Jeff Brown1dc94e32014-09-11 14:15:27 -07001422 for_each_tid(show_wchan, "BLOCKED PROCESS WAIT-CHANNELS");
Mark Salyzyna297c322016-02-05 15:33:17 -08001423 for_each_pid(show_showtime, "PROCESS TIMES (pid cmd user system iowait+percentage)");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001424
Ajay Panicker2ff8e872017-04-27 14:04:32 -07001425 /* Dump Bluetooth HCI logs */
1426 ds.AddDir("/data/misc/bluetooth/logs", true);
Ajay Panickerd886ec42016-09-14 12:26:46 -07001427
Paul Chang0d2aad72020-02-13 20:04:03 +08001428 if (ds.options_->do_screenshot && !ds.do_early_screenshot_) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001429 MYLOGI("taking late screenshot\n");
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001430 ds.TakeScreenshot();
Jeff Sharkey5a930032013-03-19 15:05:19 -07001431 }
1432
Felipe Lemee184f662016-10-27 10:04:47 -07001433 AddAnrTraceFiles();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001434
Narayan Kamath8f788292017-05-25 13:20:39 +01001435 // NOTE: tombstones are always added as separate entries in the zip archive
1436 // and are not interspersed with the main report.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001437 const bool tombstones_dumped = AddDumps(ds.tombstone_data_.begin(), ds.tombstone_data_.end(),
Narayan Kamathbd863722017-06-01 18:50:12 +01001438 "TOMBSTONE", true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001439 if (!tombstones_dumped) {
1440 printf("*** NO TOMBSTONES to dump in %s\n\n", TOMBSTONE_DIR.c_str());
Christopher Ferris7dc7f322014-07-22 16:08:19 -07001441 }
1442
Jayachandran Ca94c7172017-06-10 15:08:12 -07001443 DumpPacketStats();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001444
Chenbo Feng276a3b62018-08-07 11:44:49 -07001445 RunDumpsys("EBPF MAP STATS", {"netd", "trafficcontroller"});
1446
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001447 DoKmsg();
Mark Salyzyn2262c162014-12-16 09:09:26 -08001448
Jayachandran Ca94c7172017-06-10 15:08:12 -07001449 DumpIpAddrAndRules();
Sreeram Ramachandran2b3bba32014-07-08 15:40:55 -07001450
1451 dump_route_tables();
1452
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001453 RunCommand("ARP CACHE", {"ip", "-4", "neigh", "show"});
1454 RunCommand("IPv6 ND CACHE", {"ip", "-6", "neigh", "show"});
1455 RunCommand("MULTICAST ADDRESSES", {"ip", "maddr"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001456
Nandana Dutt5c390032019-03-12 10:52:56 +00001457 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysHigh);
Lorenzo Colitti6afc38c2015-09-09 22:59:25 +09001458
Elliott Hughes23ccc622017-02-28 10:14:22 -08001459 RunCommand("SYSTEM PROPERTIES", {"getprop"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001460
Jin Qianf334d662017-10-10 14:41:37 -07001461 RunCommand("STORAGED IO INFO", {"storaged", "-u", "-p"});
ynwangf649a6e2016-07-17 21:56:00 -07001462
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001463 RunCommand("FILESYSTEMS & FREE SPACE", {"df"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001464
Colin Crossf45fa6b2012-03-26 12:38:26 -07001465 /* Binder state is expensive to look at as it uses a lot of memory. */
Hridya Valsaraju920ba712020-02-09 16:27:01 -08001466 std::string binder_logs_dir = access("/dev/binderfs/binder_logs", R_OK) ?
1467 "/sys/kernel/debug/binder" : "/dev/binderfs/binder_logs";
1468
1469 DumpFile("BINDER FAILED TRANSACTION LOG", binder_logs_dir + "/failed_transaction_log");
1470 DumpFile("BINDER TRANSACTION LOG", binder_logs_dir + "/transaction_log");
1471 DumpFile("BINDER TRANSACTIONS", binder_logs_dir + "/transactions");
1472 DumpFile("BINDER STATS", binder_logs_dir + "/stats");
1473 DumpFile("BINDER STATE", binder_logs_dir + "/state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001474
Vishnu Nair36b4cdb2017-11-17 10:27:05 -08001475 /* Add window and surface trace files. */
1476 if (!PropertiesHelper::IsUserBuild()) {
1477 ds.AddDir(WMTRACE_DATA_DIR, false);
1478 }
1479
Nandana Dutt5c390032019-03-12 10:52:56 +00001480 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(ds.DumpstateBoard);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001481
Steven Moreland7440ddb2016-12-15 16:13:39 -08001482 /* Migrate the ril_dumpstate to a device specific dumpstate? */
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001483 int rilDumpstateTimeout = android::base::GetIntProperty("ril.dumpstate.timeout", 0);
1484 if (rilDumpstateTimeout > 0) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001485 // su does not exist on user builds, so try running without it.
1486 // This way any implementations of vril-dump that do not require
1487 // root can run on user builds.
1488 CommandOptions::CommandOptionsBuilder options =
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001489 CommandOptions::WithTimeout(rilDumpstateTimeout);
Felipe Lemef0292972016-11-22 13:57:05 -08001490 if (!PropertiesHelper::IsUserBuild()) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001491 options.AsRoot();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001492 }
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001493 RunCommand("DUMP VENDOR RIL LOGS", {"vril-dump"}, options.Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -07001494 }
1495
Felipe Lemed8b94e52016-12-08 10:21:44 -08001496 printf("========================================================\n");
1497 printf("== Android Framework Services\n");
1498 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001499
Nandana Dutt5c390032019-03-12 10:52:56 +00001500 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysNormal);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001501
Felipe Lemed8b94e52016-12-08 10:21:44 -08001502 printf("========================================================\n");
1503 printf("== Checkins\n");
1504 printf("========================================================\n");
Dianne Hackborn02bea972013-06-26 18:59:09 -07001505
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001506 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001507
1508 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsys, "CHECKIN MEMINFO", {"meminfo", "--checkin"});
1509
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001510 RunDumpsys("CHECKIN NETSTATS", {"netstats", "--checkin"});
1511 RunDumpsys("CHECKIN PROCSTATS", {"procstats", "-c"});
1512 RunDumpsys("CHECKIN USAGESTATS", {"usagestats", "-c"});
1513 RunDumpsys("CHECKIN PACKAGE", {"package", "--checkin"});
Dianne Hackborn02bea972013-06-26 18:59:09 -07001514
Felipe Lemed8b94e52016-12-08 10:21:44 -08001515 printf("========================================================\n");
1516 printf("== Running Application Activities\n");
1517 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001518
Makoto Onuki60780982018-04-16 15:34:00 -07001519 // The following dumpsys internally collects output from running apps, so it can take a long
1520 // time. So let's extend the timeout.
1521
1522 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
1523
1524 RunDumpsys("APP ACTIVITIES", {"activity", "-v", "all"}, DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001525
Felipe Lemed8b94e52016-12-08 10:21:44 -08001526 printf("========================================================\n");
Makoto Onuki60780982018-04-16 15:34:00 -07001527 printf("== Running Application Services (platform)\n");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001528 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001529
Vishnu Nairc6e6ea72018-07-02 14:20:06 -07001530 RunDumpsys("APP SERVICES PLATFORM", {"activity", "service", "all-platform-non-critical"},
Makoto Onuki60780982018-04-16 15:34:00 -07001531 DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001532
Felipe Lemed8b94e52016-12-08 10:21:44 -08001533 printf("========================================================\n");
Makoto Onuki60780982018-04-16 15:34:00 -07001534 printf("== Running Application Services (non-platform)\n");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001535 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001536
Makoto Onuki60780982018-04-16 15:34:00 -07001537 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1538 DUMPSYS_COMPONENTS_OPTIONS);
1539
1540 printf("========================================================\n");
1541 printf("== Running Application Providers (platform)\n");
1542 printf("========================================================\n");
1543
1544 RunDumpsys("APP PROVIDERS PLATFORM", {"activity", "provider", "all-platform"},
1545 DUMPSYS_COMPONENTS_OPTIONS);
1546
1547 printf("========================================================\n");
1548 printf("== Running Application Providers (non-platform)\n");
1549 printf("========================================================\n");
1550
1551 RunDumpsys("APP PROVIDERS NON-PLATFORM", {"activity", "provider", "all-non-platform"},
1552 DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001553
Adrian Roos8b397ab2017-04-04 16:35:44 -07001554 printf("========================================================\n");
1555 printf("== Dropbox crashes\n");
1556 printf("========================================================\n");
1557
1558 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1559 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1560
Felipe Lemed8b94e52016-12-08 10:21:44 -08001561 printf("========================================================\n");
1562 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1563 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1564 printf("========================================================\n");
1565 printf("== dumpstate: done (id %d)\n", ds.id_);
1566 printf("========================================================\n");
Bookatz38472142018-09-28 10:20:24 -07001567
1568 printf("========================================================\n");
1569 printf("== Obtaining statsd metadata\n");
1570 printf("========================================================\n");
1571 // This differs from the usual dumpsys stats, which is the stats report data.
1572 RunDumpsys("STATSDSTATS", {"stats", "--metadata"});
Mike Ma5c267872019-08-21 11:31:34 -07001573
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +09001574 // Add linker configuration directory
1575 ds.AddDir(LINKERCONFIG_DIR, true);
1576
Mike Ma5c267872019-08-21 11:31:34 -07001577 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpIncidentReport);
1578
Nandana Dutt5c390032019-03-12 10:52:56 +00001579 return Dumpstate::RunStatus::OK;
Colin Crossf45fa6b2012-03-26 12:38:26 -07001580}
1581
Nandana Dutt5c390032019-03-12 10:52:56 +00001582/*
1583 * Dumps state for the default case; drops root after it's no longer necessary.
1584 *
1585 * Returns RunStatus::OK if everything went fine.
1586 * Returns RunStatus::ERROR if there was an error.
1587 * Returns RunStatus::USER_DENIED_CONSENT if user explicitly denied consent to sharing the bugreport
1588 * with the caller.
1589 */
Jichao Lie89d9c12019-11-21 19:02:51 -08001590Dumpstate::RunStatus Dumpstate::DumpstateDefaultAfterCritical() {
Nandana Duttdb379fa2019-10-09 16:54:41 +01001591 // Capture first logcat early on; useful to take a snapshot before dumpstate logs take over the
1592 // buffer.
1593 DoLogcat();
1594 // Capture timestamp after first logcat to use in next logcat
1595 time_t logcat_ts = time(nullptr);
1596
Nandana Dutt4be45d12018-09-26 15:04:23 +01001597 /* collect stack traces from Dalvik and native processes (needs root) */
Nandana Duttcf419a72019-03-14 10:40:17 +00001598 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(ds.DumpTraces, &dump_traces_path);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001599
1600 /* Run some operations that require root. */
1601 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX, !ds.IsZipping());
1602 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX, !ds.IsZipping());
1603
1604 ds.AddDir(RECOVERY_DIR, true);
1605 ds.AddDir(RECOVERY_DATA_DIR, true);
1606 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
1607 ds.AddDir(LOGPERSIST_DATA_DIR, false);
Yifan Hong0efa7972020-02-03 16:45:02 -08001608 ds.AddDir(SNAPSHOTCTL_LOG_DIR, false);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001609 if (!PropertiesHelper::IsUserBuild()) {
1610 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1611 ds.AddDir(PROFILE_DATA_DIR_REF, true);
1612 }
Jerry Changa1df8a92020-01-02 16:03:39 +08001613 ds.AddDir(PREREBOOT_DATA_DIR, false);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001614 add_mountinfo();
1615 DumpIpTablesAsRoot();
David Andersond9ba4752018-12-11 18:26:59 -08001616 DumpDynamicPartitionInfo();
Yifan Hong3945e1b2019-10-29 12:59:23 -07001617 ds.AddDir(OTA_METADATA_DIR, true);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001618
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001619 // Capture any IPSec policies in play. No keys are exposed here.
Nandana Dutt4be45d12018-09-26 15:04:23 +01001620 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1621
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001622 // Dump IPsec stats. No keys are exposed here.
1623 DumpFile("XFRM STATS", XFRM_STAT_PROC_FILE);
1624
Nandana Dutt4be45d12018-09-26 15:04:23 +01001625 // Run ss as root so we can see socket marks.
1626 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
1627
1628 // Run iotop as root to show top 100 IO threads
1629 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
1630
Erick Reyese68df822019-02-11 14:46:36 -08001631 // Gather shared memory buffer info if the product implements it
1632 struct stat st;
1633 if (!stat("/product/bin/dmabuf_dump", &st)) {
1634 RunCommand("Dmabuf dump", {"/product/bin/dmabuf_dump"});
1635 }
1636
Minchan Kim22c6a1e2019-09-30 15:58:10 -07001637 DumpFile("PSI cpu", "/proc/pressure/cpu");
1638 DumpFile("PSI memory", "/proc/pressure/memory");
1639 DumpFile("PSI io", "/proc/pressure/io");
1640
Nandana Dutt4be45d12018-09-26 15:04:23 +01001641 if (!DropRootUser()) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001642 return Dumpstate::RunStatus::ERROR;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001643 }
1644
Nandana Dutt5c390032019-03-12 10:52:56 +00001645 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttdb379fa2019-10-09 16:54:41 +01001646 Dumpstate::RunStatus status = dumpstate();
1647 // Capture logcat since the last time we did it.
1648 DoSystemLogcat(logcat_ts);
1649 return status;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001650}
1651
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001652// This method collects common dumpsys for telephony and wifi. Typically, wifi
1653// reports are fine to include all information, but telephony reports on user
1654// builds need to strip some content (see DumpstateTelephonyOnly).
1655static void DumpstateRadioCommon(bool include_sensitive_info = true) {
Jayachandran Ca94c7172017-06-10 15:08:12 -07001656 DumpIpTablesAsRoot();
1657
Jayachandran Cb4389d92019-07-08 09:46:05 -07001658 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1659
Jayachandran Ca94c7172017-06-10 15:08:12 -07001660 if (!DropRootUser()) {
1661 return;
1662 }
1663
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001664 // We need to be picky about some stuff for telephony reports on user builds.
1665 if (!include_sensitive_info) {
1666 // Only dump the radio log buffer (other buffers and dumps contain too much unrelated info).
1667 DoRadioLogcat();
1668 } else {
1669 // Contains various system properties and process startup info.
1670 do_dmesg();
1671 // Logs other than the radio buffer may contain package/component names and potential PII.
1672 DoLogcat();
1673 // Too broad for connectivity problems.
1674 DoKmsg();
1675 // Contains unrelated hardware info (camera, NFC, biometrics, ...).
1676 DumpHals();
1677 }
1678
Jayachandran Ca94c7172017-06-10 15:08:12 -07001679 DumpPacketStats();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001680 DumpIpAddrAndRules();
1681 dump_route_tables();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001682 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
1683 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08001684}
1685
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001686// We use "telephony" here for legacy reasons, though this now really means "connectivity" (cellular
1687// + wifi + networking). This method collects dumpsys for connectivity debugging only. General rules
1688// for what can be included on user builds: all reported information MUST directly relate to
1689// connectivity debugging or customer support and MUST NOT contain unrelated personally identifiable
1690// information. This information MUST NOT identify user-installed packages (UIDs are OK, package
1691// names are not), and MUST NOT contain logs of user application traffic.
1692// TODO(b/148168577) rename this and other related fields/methods to "connectivity" instead.
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08001693static void DumpstateTelephonyOnly(const std::string& calling_package) {
mukesh agrawal253dad42018-01-23 21:59:59 -08001694 DurationReporter duration_reporter("DUMPSTATE");
Jichao Lie89d9c12019-11-21 19:02:51 -08001695
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001696 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08001697
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001698 const bool include_sensitive_info = !PropertiesHelper::IsUserBuild();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001699
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001700 DumpstateRadioCommon(include_sensitive_info);
1701
1702 if (include_sensitive_info) {
1703 // Contains too much unrelated PII, and given the unstructured nature of sysprops, we can't
1704 // really cherrypick all of the connectivity-related ones. Apps generally have no business
1705 // reading these anyway, and there should be APIs to supply the info in a more app-friendly
1706 // way.
1707 RunCommand("SYSTEM PROPERTIES", {"getprop"});
1708 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07001709
1710 printf("========================================================\n");
1711 printf("== Android Framework Services\n");
1712 printf("========================================================\n");
1713
Vishnu Nair652cc802017-11-30 15:18:30 -08001714 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1715 SEC_TO_MSEC(10));
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08001716 if (include_sensitive_info) {
1717 // Carrier apps' services will be dumped below in dumpsys activity service all-non-platform.
1718 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
1719 SEC_TO_MSEC(10));
1720 } else {
1721 // If the caller is a carrier app and has a carrier service, dump it here since we aren't
1722 // running dumpsys activity service all-non-platform below. Due to the increased output, we
1723 // give a higher timeout as well.
1724 RunDumpsys("DUMPSYS", {"carrier_config", "--requesting-package", calling_package},
1725 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(30));
1726 }
1727 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001728 RunDumpsys("DUMPSYS", {"netpolicy"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
1729 RunDumpsys("DUMPSYS", {"network_management"}, CommandOptions::WithTimeout(90).Build(),
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07001730 SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001731 if (include_sensitive_info) {
1732 // Contains raw IP addresses, omit from reports on user builds.
1733 RunDumpsys("DUMPSYS", {"netd"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
1734 // Contains raw destination IP/MAC addresses, omit from reports on user builds.
1735 RunDumpsys("DUMPSYS", {"connmetrics"}, CommandOptions::WithTimeout(90).Build(),
1736 SEC_TO_MSEC(10));
1737 // Contains package/component names, omit from reports on user builds.
1738 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
1739 SEC_TO_MSEC(10));
1740 // Contains package names, but should be relatively simple to remove them (also contains
1741 // UIDs already), omit from reports on user builds.
1742 RunDumpsys("BATTERYSTATS", {"deviceidle"}, CommandOptions::WithTimeout(90).Build(),
1743 SEC_TO_MSEC(10));
1744 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07001745
1746 printf("========================================================\n");
1747 printf("== Running Application Services\n");
1748 printf("========================================================\n");
1749
1750 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
1751
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001752 if (include_sensitive_info) {
1753 printf("========================================================\n");
1754 printf("== Running Application Services (non-platform)\n");
1755 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001756
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001757 // Contains package/component names and potential PII, omit from reports on user builds.
1758 // To get dumps of the active CarrierService(s) on user builds, we supply an argument to the
1759 // carrier_config dumpsys instead.
1760 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1761 DUMPSYS_COMPONENTS_OPTIONS);
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001762
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001763 printf("========================================================\n");
1764 printf("== Checkins\n");
1765 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07001766
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001767 // Contains package/component names, omit from reports on user builds.
1768 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
1769 }
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07001770
1771 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07001772 printf("== dumpstate: done (id %d)\n", ds.id_);
1773 printf("========================================================\n");
1774}
1775
mukesh agrawal253dad42018-01-23 21:59:59 -08001776// This method collects dumpsys for wifi debugging only
1777static void DumpstateWifiOnly() {
1778 DurationReporter duration_reporter("DUMPSTATE");
1779
1780 DumpstateRadioCommon();
1781
1782 printf("========================================================\n");
1783 printf("== Android Framework Services\n");
1784 printf("========================================================\n");
1785
1786 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1787 SEC_TO_MSEC(10));
1788 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
1789 SEC_TO_MSEC(10));
1790
1791 printf("========================================================\n");
1792 printf("== dumpstate: done (id %d)\n", ds.id_);
1793 printf("========================================================\n");
1794}
1795
Nandana Duttcf419a72019-03-14 10:40:17 +00001796Dumpstate::RunStatus Dumpstate::DumpTraces(const char** path) {
Nandana Duttfaafd522019-03-11 09:23:09 +00001797 DurationReporter duration_reporter("DUMP TRACES");
1798
1799 const std::string temp_file_pattern = "/data/anr/dumptrace_XXXXXX";
1800 const size_t buf_size = temp_file_pattern.length() + 1;
1801 std::unique_ptr<char[]> file_name_buf(new char[buf_size]);
1802 memcpy(file_name_buf.get(), temp_file_pattern.c_str(), buf_size);
1803
1804 // Create a new, empty file to receive all trace dumps.
1805 //
1806 // TODO: This can be simplified once we remove support for the old style
1807 // dumps. We can have a file descriptor passed in to dump_traces instead
1808 // of creating a file, closing it and then reopening it again.
1809 android::base::unique_fd fd(mkostemp(file_name_buf.get(), O_APPEND | O_CLOEXEC));
1810 if (fd < 0) {
1811 MYLOGE("mkostemp on pattern %s: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001812 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001813 }
1814
1815 // Nobody should have access to this temporary file except dumpstate, but we
1816 // temporarily grant 'read' to 'others' here because this file is created
1817 // when tombstoned is still running as root, but dumped after dropping. This
1818 // can go away once support for old style dumping has.
1819 const int chmod_ret = fchmod(fd, 0666);
1820 if (chmod_ret < 0) {
1821 MYLOGE("fchmod on %s failed: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001822 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001823 }
1824
1825 std::unique_ptr<DIR, decltype(&closedir)> proc(opendir("/proc"), closedir);
1826 if (proc.get() == nullptr) {
1827 MYLOGE("opendir /proc failed: %s\n", strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001828 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001829 }
1830
1831 // Number of times process dumping has timed out. If we encounter too many
1832 // failures, we'll give up.
1833 int timeout_failures = 0;
1834 bool dalvik_found = false;
1835
1836 const std::set<int> hal_pids = get_interesting_hal_pids();
1837
1838 struct dirent* d;
1839 while ((d = readdir(proc.get()))) {
Nandana Duttcf419a72019-03-14 10:40:17 +00001840 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttfaafd522019-03-11 09:23:09 +00001841 int pid = atoi(d->d_name);
1842 if (pid <= 0) {
1843 continue;
1844 }
1845
1846 const std::string link_name = android::base::StringPrintf("/proc/%d/exe", pid);
1847 std::string exe;
1848 if (!android::base::Readlink(link_name, &exe)) {
1849 continue;
1850 }
1851
1852 bool is_java_process;
1853 if (exe == "/system/bin/app_process32" || exe == "/system/bin/app_process64") {
1854 // Don't bother dumping backtraces for the zygote.
1855 if (IsZygote(pid)) {
1856 continue;
1857 }
1858
1859 dalvik_found = true;
1860 is_java_process = true;
1861 } else if (should_dump_native_traces(exe.c_str()) || hal_pids.find(pid) != hal_pids.end()) {
1862 is_java_process = false;
1863 } else {
1864 // Probably a native process we don't care about, continue.
1865 continue;
1866 }
1867
1868 // If 3 backtrace dumps fail in a row, consider debuggerd dead.
1869 if (timeout_failures == 3) {
1870 dprintf(fd, "ERROR: Too many stack dump failures, exiting.\n");
1871 break;
1872 }
1873
1874 const uint64_t start = Nanotime();
1875 const int ret = dump_backtrace_to_file_timeout(
1876 pid, is_java_process ? kDebuggerdJavaBacktrace : kDebuggerdNativeBacktrace,
1877 is_java_process ? 5 : 20, fd);
1878
1879 if (ret == -1) {
1880 // For consistency, the header and footer to this message match those
1881 // dumped by debuggerd in the success case.
1882 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
1883 dprintf(fd, "Dump failed, likely due to a timeout.\n");
1884 dprintf(fd, "---- end %d ----", pid);
1885 timeout_failures++;
1886 continue;
1887 }
1888
1889 // We've successfully dumped stack traces, reset the failure count
1890 // and write a summary of the elapsed time to the file and continue with the
1891 // next process.
1892 timeout_failures = 0;
1893
1894 dprintf(fd, "[dump %s stack %d: %.3fs elapsed]\n", is_java_process ? "dalvik" : "native",
1895 pid, (float)(Nanotime() - start) / NANOS_PER_SEC);
1896 }
1897
1898 if (!dalvik_found) {
1899 MYLOGE("Warning: no Dalvik processes found to dump stacks\n");
1900 }
1901
Nandana Duttcf419a72019-03-14 10:40:17 +00001902 *path = file_name_buf.release();
1903 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001904}
1905
Felipe Leme6f674ae2016-11-18 17:10:33 -08001906void Dumpstate::DumpstateBoard() {
1907 DurationReporter duration_reporter("dumpstate_board()");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001908 printf("========================================================\n");
1909 printf("== Board\n");
1910 printf("========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001911
Felipe Leme6f674ae2016-11-18 17:10:33 -08001912 if (!IsZipping()) {
Steven Moreland7440ddb2016-12-15 16:13:39 -08001913 MYLOGD("Not dumping board info because it's not a zipped bugreport\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001914 return;
1915 }
1916
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001917 std::vector<std::string> paths;
1918 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07001919 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00001920 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
1921 kDumpstateBoardFiles[i].c_str()));
Nandana Dutt16d1aee2019-02-15 16:13:53 +00001922 remover.emplace_back(android::base::make_scope_guard(
1923 std::bind([](std::string path) { android::os::UnlinkAndLogOnError(path); }, paths[i])));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001924 }
Jie Song9fbfad02017-06-20 16:29:42 -07001925
Hunter Knepshield8540faf2020-02-04 19:47:20 -08001926 sp<IDumpstateDevice_1_0> dumpstate_device_1_0(IDumpstateDevice_1_0::getService());
1927 if (dumpstate_device_1_0 == nullptr) {
Wei Wang587eac92018-04-05 12:17:20 -07001928 MYLOGE("No IDumpstateDevice implementation\n");
1929 return;
1930 }
1931
1932 using ScopedNativeHandle =
1933 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
1934 ScopedNativeHandle handle(native_handle_create(static_cast<int>(paths.size()), 0),
1935 [](native_handle_t* handle) {
1936 native_handle_close(handle);
1937 native_handle_delete(handle);
1938 });
1939 if (handle == nullptr) {
1940 MYLOGE("Could not create native_handle\n");
1941 return;
1942 }
1943
Nandana Dutt5c390032019-03-12 10:52:56 +00001944 // TODO(128270426): Check for consent in between?
Wei Wang587eac92018-04-05 12:17:20 -07001945 for (size_t i = 0; i < paths.size(); i++) {
1946 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
1947
1948 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
1949 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1950 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1951 if (fd < 0) {
1952 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
1953 return;
1954 }
1955 handle.get()->data[i] = fd.release();
1956 }
1957
Hunter Knepshield8540faf2020-02-04 19:47:20 -08001958 // Given that bugreport is required to diagnose failures, it's better to set an arbitrary amount
1959 // of timeout for IDumpstateDevice than to block the rest of bugreport. In the timeout case, we
1960 // will kill the HAL and grab whatever it dumped in time.
1961 constexpr size_t timeout_sec = 30;
1962 // Prefer version 1.1 if available. New devices launching with R are no longer allowed to
1963 // implement just 1.0.
1964 const char* descriptor_to_kill;
1965 using DumpstateBoardTask = std::packaged_task<bool()>;
1966 DumpstateBoardTask dumpstate_board_task;
1967 sp<IDumpstateDevice_1_1> dumpstate_device_1_1(
1968 IDumpstateDevice_1_1::castFrom(dumpstate_device_1_0));
1969 if (dumpstate_device_1_1 != nullptr) {
1970 MYLOGI("Using IDumpstateDevice v1.1");
1971 descriptor_to_kill = IDumpstateDevice_1_1::descriptor;
1972 dumpstate_board_task = DumpstateBoardTask([this, dumpstate_device_1_1, &handle]() -> bool {
1973 ::android::hardware::Return<DumpstateStatus> status =
1974 dumpstate_device_1_1->dumpstateBoard_1_1(handle.get(), options_->dumpstate_hal_mode,
1975 SEC_TO_MSEC(timeout_sec));
1976 if (!status.isOk()) {
1977 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
1978 return false;
1979 } else if (status != DumpstateStatus::OK) {
1980 MYLOGE("dumpstateBoard failed with DumpstateStatus::%s\n", toString(status).c_str());
1981 return false;
1982 }
1983 return true;
1984 });
1985 } else {
1986 MYLOGI("Using IDumpstateDevice v1.0");
1987 descriptor_to_kill = IDumpstateDevice_1_0::descriptor;
1988 dumpstate_board_task = DumpstateBoardTask([dumpstate_device_1_0, &handle]() -> bool {
1989 ::android::hardware::Return<void> status =
1990 dumpstate_device_1_0->dumpstateBoard(handle.get());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001991 if (!status.isOk()) {
1992 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
Wei Wang587eac92018-04-05 12:17:20 -07001993 return false;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001994 }
Wei Wang587eac92018-04-05 12:17:20 -07001995 return true;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001996 });
Hunter Knepshield8540faf2020-02-04 19:47:20 -08001997 }
1998 auto result = dumpstate_board_task.get_future();
1999 std::thread(std::move(dumpstate_board_task)).detach();
Wei Wang587eac92018-04-05 12:17:20 -07002000
Wei Wang587eac92018-04-05 12:17:20 -07002001 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2002 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate vendor HAL\n", timeout_sec);
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002003 if (!android::base::SetProperty(
2004 "ctl.interface_restart",
2005 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
Wei Wang587eac92018-04-05 12:17:20 -07002006 MYLOGE("Couldn't restart dumpstate HAL\n");
2007 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002008 }
Wei Wang587eac92018-04-05 12:17:20 -07002009 // Wait some time for init to kill dumpstate vendor HAL
2010 constexpr size_t killing_timeout_sec = 10;
2011 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2012 MYLOGE("killing dumpstateBoard timed out after %zus, continue and "
2013 "there might be racing in content\n", killing_timeout_sec);
2014 }
2015
2016 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
2017 for (size_t i = 0; i < paths.size(); i++) {
2018 struct stat s;
2019 if (fstat(handle.get()->data[i], &s) == -1) {
2020 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(),
2021 strerror(errno));
2022 file_sizes[i] = -1;
2023 continue;
2024 }
2025 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002026 }
2027
2028 for (size_t i = 0; i < paths.size(); i++) {
2029 if (file_sizes[i] == -1) {
2030 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002031 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002032 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07002033 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002034 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002035 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002036 AddZipEntry(kDumpstateBoardFiles[i], paths[i]);
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002037 printf("*** See %s entry ***\n", kDumpstateBoardFiles[i].c_str());
Jie Song9fbfad02017-06-20 16:29:42 -07002038 }
Felipe Leme6f674ae2016-11-18 17:10:33 -08002039}
2040
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002041static void ShowUsage() {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002042 fprintf(stderr,
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01002043 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-d] [-p] "
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002044 "[-z] [-s] [-S] [-q] [-P] [-R] [-V version]\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002045 " -h: display this help message\n"
2046 " -b: play sound file instead of vibrate, at beginning of job\n"
2047 " -e: play sound file instead of vibrate, at end of job\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01002048 " -d: append date to filename\n"
2049 " -p: capture screenshot to filename.png\n"
2050 " -z: generate zipped file\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002051 " -s: write output to control socket (for init)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01002052 " -S: write file location to control socket (for init; requires -z)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002053 " -q: disable vibrate\n"
Abhijeet Kaure370d682019-10-01 16:49:30 +01002054 " -P: send broadcast when started and do progress updates\n"
2055 " -R: take bugreport in remote mode (requires -z and -d, shouldn't be used with -P)\n"
Nandana Dutt235864b2019-01-22 12:10:16 +00002056 " -w: start binder service and make it wait for a call to startBugreport\n"
Felipe Lemed071c682016-10-20 16:48:00 -07002057 " -v: prints the dumpstate header and exit\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002058}
2059
Wei Liuf87959e2016-08-26 14:51:42 -07002060static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07002061 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07002062}
2063
Felipe Leme1d486fe2016-10-14 18:06:47 -07002064bool Dumpstate::FinishZipFile() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07002065 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07002066 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07002067 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002068 // Final timestamp
2069 char date[80];
2070 time_t the_real_now_please_stand_up = time(nullptr);
2071 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002072 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07002073 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002074
Felipe Leme9a523ae2016-10-20 15:10:33 -07002075 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002076 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08002077 return false;
2078 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07002079 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002080 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08002081 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08002082 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08002083
Felipe Leme0f3fb202016-06-10 17:10:53 -07002084 // Add log file (which contains stderr output) to zip...
2085 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07002086 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07002087 MYLOGE("Failed to add dumpstate log to .zip file\n");
2088 return false;
2089 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002090 // TODO: Should truncate the existing file.
2091 // ... and re-open it for further logging.
Nandana Dutta344cb62019-02-22 15:12:35 +00002092 if (!redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()))) {
2093 return false;
2094 }
Felipe Leme0f3fb202016-06-10 17:10:53 -07002095 fprintf(stderr, "\n");
2096
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002097 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07002098 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002099 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002100 return false;
2101 }
2102
Felipe Leme1d486fe2016-10-14 18:06:47 -07002103 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
2104 ds.zip_file.reset(nullptr);
2105
Felipe Lemee9d2c542016-11-15 11:48:26 -08002106 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002107 android::os::UnlinkAndLogOnError(tmp_path_);
Felipe Lemec4eee562016-04-21 15:42:55 -07002108
Felipe Leme1e9edc62015-12-21 16:02:13 -08002109 return true;
2110}
Felipe Leme6e01fa62015-11-11 19:35:14 -08002111
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002112static void SendBroadcast(const std::string& action, const std::vector<std::string>& args) {
2113 // clang-format off
2114 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user", "0",
2115 "--receiver-foreground", "--receiver-include-background", "-a", action};
2116 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08002117
2118 am.insert(am.end(), args.begin(), args.end());
2119
Felipe Leme8d2410e2017-02-08 09:46:08 -08002120 RunCommand("", am,
2121 CommandOptions::WithTimeout(20)
2122 .Log("Sending broadcast: '%s'\n")
2123 .Always()
2124 .DropRoot()
2125 .RedirectStderr()
2126 .Build());
2127}
2128
Felipe Leme35b8cf12017-02-10 15:47:29 -08002129static void Vibrate(int duration_ms) {
2130 // clang-format off
Chris Fries0c3de872019-09-14 15:49:41 +00002131 RunCommand("", {"cmd", "vibrator", "vibrate", "-f", std::to_string(duration_ms), "dumpstate"},
Felipe Leme35b8cf12017-02-10 15:47:29 -08002132 CommandOptions::WithTimeout(10)
2133 .Log("Vibrate: '%s'\n")
2134 .Always()
2135 .Build());
2136 // clang-format on
2137}
2138
Nandana Dutt979388e2018-11-30 16:48:55 +00002139static void MaybeResolveSymlink(std::string* path) {
2140 std::string resolved_path;
2141 if (android::base::Readlink(*path, &resolved_path)) {
2142 *path = resolved_path;
2143 }
2144}
2145
Nandana Dutt4be45d12018-09-26 15:04:23 +01002146/*
2147 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
2148 * if we are writing zip files and adds the version file.
2149 */
2150static void PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002151 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
2152
Nandana Dutt4be45d12018-09-26 15:04:23 +01002153 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
2154 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002155 ds.base_name_ = StringPrintf("bugreport-%s-%s", device_name.c_str(), build_id.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002156 if (ds.options_->do_add_date) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002157 char date[80];
2158 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
2159 ds.name_ = date;
2160 } else {
2161 ds.name_ = "undated";
2162 }
2163
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002164 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002165 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002166 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002167 ds.base_name_ += "-wifi";
2168 }
2169
Paul Chang0d2aad72020-02-13 20:04:03 +08002170 if (ds.options_->do_screenshot) {
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002171 ds.screenshot_path_ = ds.GetPath(ds.CalledByApi() ? "-tmp.png" : ".png");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002172 }
2173 ds.tmp_path_ = ds.GetPath(".tmp");
2174 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
2175
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002176 std::string destination = ds.CalledByApi()
Nandana Dutt54dbd672019-01-11 12:58:05 +00002177 ? StringPrintf("[fd:%d]", ds.options_->bugreport_fd.get())
Nandana Dutt9a76d202019-01-21 15:56:48 +00002178 : ds.bugreport_internal_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01002179 MYLOGD(
Nandana Dutt235c6672019-11-14 15:22:32 +00002180 "Bugreport dir: [%s] "
2181 "Base name: [%s] "
2182 "Suffix: [%s] "
2183 "Log path: [%s] "
2184 "Temporary path: [%s] "
2185 "Screenshot path: [%s]\n",
Nandana Dutt9a76d202019-01-21 15:56:48 +00002186 destination.c_str(), ds.base_name_.c_str(), ds.name_.c_str(), ds.log_path_.c_str(),
2187 ds.tmp_path_.c_str(), ds.screenshot_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002188
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002189 if (ds.options_->do_zip_file) {
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002190 ds.path_ = ds.GetPath(ds.CalledByApi() ? "-tmp.zip" : ".zip");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002191 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
2192 create_parent_dirs(ds.path_.c_str());
2193 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
2194 if (ds.zip_file == nullptr) {
2195 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
2196 } else {
2197 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
2198 }
2199 ds.AddTextZipEntry("version.txt", ds.version_);
2200 }
2201}
2202
2203/*
Abhijeet Kaure370d682019-10-01 16:49:30 +01002204 * Finalizes writing to the file by zipping the tmp file to the final location,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002205 * printing zipped file status, etc.
2206 */
2207static void FinalizeFile() {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002208 bool do_text_file = true;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002209 if (ds.options_->do_zip_file) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002210 if (!ds.FinishZipFile()) {
2211 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
2212 do_text_file = true;
2213 } else {
2214 do_text_file = false;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002215 }
2216 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002217 if (ds.options_->use_control_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002218 if (do_text_file) {
2219 dprintf(ds.control_socket_fd_,
2220 "FAIL:could not create zip file, check %s "
2221 "for more details\n",
2222 ds.log_path_.c_str());
2223 } else {
2224 dprintf(ds.control_socket_fd_, "OK:%s\n", ds.path_.c_str());
2225 }
2226 }
2227}
2228
Nandana Dutt4be45d12018-09-26 15:04:23 +01002229
Nandana Dutt58d72e22018-11-16 10:30:48 +00002230static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2231 switch (mode) {
2232 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2233 return "BUGREPORT_FULL";
2234 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2235 return "BUGREPORT_INTERACTIVE";
2236 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2237 return "BUGREPORT_REMOTE";
2238 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2239 return "BUGREPORT_WEAR";
2240 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2241 return "BUGREPORT_TELEPHONY";
2242 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2243 return "BUGREPORT_WIFI";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002244 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2245 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002246 }
2247}
2248
2249static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002250 // Modify com.android.shell.BugreportProgressService#isDefaultScreenshotRequired as well for
2251 // default system screenshots.
Abhijeet Kaure370d682019-10-01 16:49:30 +01002252 options->bugreport_mode = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002253 switch (mode) {
2254 case Dumpstate::BugreportMode::BUGREPORT_FULL:
Paul Chang0d2aad72020-02-13 20:04:03 +08002255 options->do_screenshot = true;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002256 options->dumpstate_hal_mode = DumpstateMode::FULL;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002257 break;
2258 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002259 // Currently, the dumpstate binder is only used by Shell to update progress.
2260 options->do_start_service = true;
2261 options->do_progress_updates = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002262 options->do_screenshot = true;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002263 options->dumpstate_hal_mode = DumpstateMode::INTERACTIVE;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002264 break;
2265 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002266 options->do_vibrate = false;
2267 options->is_remote_mode = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002268 options->do_screenshot = false;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002269 options->dumpstate_hal_mode = DumpstateMode::REMOTE;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002270 break;
2271 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002272 options->do_start_service = true;
2273 options->do_progress_updates = true;
2274 options->do_zip_file = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002275 options->do_screenshot = true;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002276 options->dumpstate_hal_mode = DumpstateMode::WEAR;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002277 break;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002278 // TODO(b/148168577) rename TELEPHONY everywhere to CONNECTIVITY.
Nandana Dutt58d72e22018-11-16 10:30:48 +00002279 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002280 options->telephony_only = true;
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002281 options->do_progress_updates = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002282 options->do_screenshot = false;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002283 options->dumpstate_hal_mode = DumpstateMode::CONNECTIVITY;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002284 break;
2285 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002286 options->wifi_only = true;
2287 options->do_zip_file = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002288 options->do_screenshot = false;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002289 options->dumpstate_hal_mode = DumpstateMode::WIFI;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002290 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002291 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2292 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002293 }
2294}
2295
Nandana Dutt58d72e22018-11-16 10:30:48 +00002296static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
Nandana Dutt235c6672019-11-14 15:22:32 +00002297 MYLOGI(
Paul Chang0d2aad72020-02-13 20:04:03 +08002298 "do_zip_file: %d do_vibrate: %d use_socket: %d use_control_socket: %d do_screenshot: %d "
Nandana Dutt235c6672019-11-14 15:22:32 +00002299 "is_remote_mode: %d show_header_only: %d do_start_service: %d telephony_only: %d "
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002300 "wifi_only: %d do_progress_updates: %d fd: %d bugreport_mode: %s dumpstate_hal_mode: %s "
2301 "args: %s\n",
Nandana Dutt235c6672019-11-14 15:22:32 +00002302 options.do_zip_file, options.do_vibrate, options.use_socket, options.use_control_socket,
Paul Chang0d2aad72020-02-13 20:04:03 +08002303 options.do_screenshot, options.is_remote_mode, options.show_header_only,
2304 options.do_start_service,
Nandana Dutt235c6672019-11-14 15:22:32 +00002305 options.telephony_only, options.wifi_only, options.do_progress_updates,
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002306 options.bugreport_fd.get(), options.bugreport_mode.c_str(),
2307 toString(options.dumpstate_hal_mode).c_str(), options.args.c_str());
Nandana Dutt58d72e22018-11-16 10:30:48 +00002308}
2309
Nandana Dutt54dbd672019-01-11 12:58:05 +00002310void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode,
2311 const android::base::unique_fd& bugreport_fd_in,
2312 const android::base::unique_fd& screenshot_fd_in) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002313 // In the new API world, date is always added; output is always a zip file.
2314 // TODO(111441001): remove these options once they are obsolete.
2315 do_add_date = true;
2316 do_zip_file = true;
2317
Nandana Dutt54dbd672019-01-11 12:58:05 +00002318 // Duplicate the fds because the passed in fds don't outlive the binder transaction.
2319 bugreport_fd.reset(dup(bugreport_fd_in.get()));
2320 screenshot_fd.reset(dup(screenshot_fd_in.get()));
Nandana Dutt58d72e22018-11-16 10:30:48 +00002321
Nandana Dutt58d72e22018-11-16 10:30:48 +00002322 SetOptionsFromMode(bugreport_mode, this);
2323}
2324
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002325Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
2326 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002327 int c;
Nandana Dutt235864b2019-01-22 12:10:16 +00002328 while ((c = getopt(argc, argv, "dho:svqzpPBRSV:w")) != -1) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002329 switch (c) {
2330 // clang-format off
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002331 case 'd': do_add_date = true; break;
2332 case 'z': do_zip_file = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002333 case 's': use_socket = true; break;
2334 case 'S': use_control_socket = true; break;
2335 case 'v': show_header_only = true; break;
2336 case 'q': do_vibrate = false; break;
Paul Chang0d2aad72020-02-13 20:04:03 +08002337 case 'p': do_screenshot = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002338 case 'P': do_progress_updates = true; break;
2339 case 'R': is_remote_mode = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002340 case 'V': break; // compatibility no-op
Nandana Dutt235864b2019-01-22 12:10:16 +00002341 case 'w':
2342 // This was already processed
2343 break;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002344 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002345 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002346 break;
2347 default:
2348 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002349 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002350 break;
2351 // clang-format on
2352 }
2353 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08002354
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002355 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002356 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002357 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002358 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002359 }
2360 }
2361
2362 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
2363 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002364
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002365 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002366}
2367
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002368bool Dumpstate::DumpOptions::ValidateOptions() const {
Nandana Dutt54dbd672019-01-11 12:58:05 +00002369 if (bugreport_fd.get() != -1 && !do_zip_file) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002370 return false;
2371 }
2372
Abhijeet Kaure370d682019-10-01 16:49:30 +01002373 if ((do_zip_file || do_add_date || do_progress_updates) && !OutputToFile()) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002374 return false;
2375 }
2376
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002377 if (use_control_socket && !do_zip_file) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002378 return false;
2379 }
2380
Abhijeet Kaure370d682019-10-01 16:49:30 +01002381 if (is_remote_mode && (do_progress_updates || !do_zip_file || !do_add_date)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002382 return false;
2383 }
2384 return true;
2385}
2386
Nandana Dutt197661d2018-11-16 16:40:21 +00002387void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
2388 options_ = std::move(options);
2389}
2390
Nandana Duttd2f5f082019-01-18 17:13:52 +00002391Dumpstate::RunStatus Dumpstate::Run(int32_t calling_uid, const std::string& calling_package) {
2392 Dumpstate::RunStatus status = RunInternal(calling_uid, calling_package);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002393 if (listener_ != nullptr) {
2394 switch (status) {
2395 case Dumpstate::RunStatus::OK:
Nandana Duttcc4ead82019-01-23 08:29:23 +00002396 listener_->onFinished();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002397 break;
2398 case Dumpstate::RunStatus::HELP:
2399 break;
2400 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002401 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_INVALID_INPUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002402 break;
2403 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002404 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_RUNTIME_ERROR);
2405 break;
2406 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2407 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_DENIED_CONSENT);
2408 break;
2409 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
2410 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_CONSENT_TIMED_OUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002411 break;
2412 }
2413 }
2414 return status;
2415}
2416
Nandana Dutt979388e2018-11-30 16:48:55 +00002417/*
2418 * Dumps relevant information to a bugreport based on the given options.
2419 *
2420 * The bugreport can be dumped to a file or streamed to a socket.
2421 *
2422 * How dumping to file works:
2423 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
2424 * stderr is redirected a log file.
2425 *
2426 * The temporary bugreport is then populated via printfs, dumping contents of files and
2427 * output of commands to stdout.
2428 *
2429 * If zipping, the temporary bugreport file is added to the zip archive. Else it's renamed to final
2430 * text file.
2431 *
2432 * If zipping, a bunch of other files and dumps also get added to the zip archive. The log file also
2433 * gets added to the archive.
2434 *
Nandana Dutt9a76d202019-01-21 15:56:48 +00002435 * Bugreports are first generated in a local directory and later copied to the caller's fd if
2436 * supplied.
Nandana Dutt979388e2018-11-30 16:48:55 +00002437 */
Nandana Duttd2f5f082019-01-18 17:13:52 +00002438Dumpstate::RunStatus Dumpstate::RunInternal(int32_t calling_uid,
2439 const std::string& calling_package) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002440 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00002441 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002442 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002443 return RunStatus::INVALID_INPUT;
2444 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002445 /* set as high priority, and protect from OOM killer */
2446 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002447
Felipe Lemed071c682016-10-20 16:48:00 -07002448 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002449 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002450 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002451 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002452 } else {
2453 /* fallback to kernels <= 2.6.35 */
2454 oom_adj = fopen("/proc/self/oom_adj", "we");
2455 if (oom_adj) {
2456 fputs("-17", oom_adj);
2457 fclose(oom_adj);
2458 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002459 }
2460
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002461 if (version_ == VERSION_DEFAULT) {
2462 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00002463 }
2464
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002465 if (version_ != VERSION_CURRENT && version_ != VERSION_SPLIT_ANR) {
Vishnu Nair64afc022018-02-01 15:29:34 -08002466 MYLOGE("invalid version requested ('%s'); suppported values are: ('%s', '%s', '%s')\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002467 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str(),
Vishnu Nair64afc022018-02-01 15:29:34 -08002468 VERSION_SPLIT_ANR.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002469 return RunStatus::INVALID_INPUT;
Felipe Lemed071c682016-10-20 16:48:00 -07002470 }
2471
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002472 if (options_->show_header_only) {
2473 PrintHeader();
2474 return RunStatus::OK;
Felipe Lemed071c682016-10-20 16:48:00 -07002475 }
2476
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002477 MYLOGD("dumpstate calling_uid = %d ; calling package = %s \n",
2478 calling_uid, calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00002479
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002480 // Redirect output if needed
Nandana Dutt9a76d202019-01-21 15:56:48 +00002481 bool is_redirecting = options_->OutputToFile();
Felipe Leme7447d7c2016-11-03 18:12:22 -07002482
2483 // TODO: temporarily set progress until it's part of the Dumpstate constructor
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002484 std::string stats_path =
Nandana Dutt979388e2018-11-30 16:48:55 +00002485 is_redirecting
2486 ? android::base::StringPrintf("%s/dumpstate-stats.txt", bugreport_internal_dir_.c_str())
2487 : "";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002488 progress_.reset(new Progress(stats_path));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002489
Felipe Lemed071c682016-10-20 16:48:00 -07002490 /* gets the sequential id */
Felipe Leme7447d7c2016-11-03 18:12:22 -07002491 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002492 id_ = ++last_id;
Felipe Lemed071c682016-10-20 16:48:00 -07002493 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
2494
Sahana Raof35ed432019-07-12 10:47:52 +01002495 if (acquire_wake_lock(PARTIAL_WAKE_LOCK, WAKE_LOCK_NAME) < 0) {
2496 MYLOGE("Failed to acquire wake lock: %s\n", strerror(errno));
2497 } else {
2498 // Wake lock will be released automatically on process death
2499 MYLOGD("Wake lock acquired.\n");
2500 }
2501
Felipe Leme6ae5c4f2017-01-10 14:13:22 -08002502 register_sig_handler();
Felipe Lemed071c682016-10-20 16:48:00 -07002503
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002504 // TODO(b/111441001): maybe skip if already started?
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002505 if (options_->do_start_service) {
Felipe Leme75876a22016-10-27 16:31:27 -07002506 MYLOGI("Starting 'dumpstate' service\n");
2507 android::status_t ret;
2508 if ((ret = android::os::DumpstateService::Start()) != android::OK) {
2509 MYLOGE("Unable to start DumpstateService: %d\n", ret);
2510 }
2511 }
2512
Felipe Lemef0292972016-11-22 13:57:05 -08002513 if (PropertiesHelper::IsDryRun()) {
Felipe Lemed071c682016-10-20 16:48:00 -07002514 MYLOGI("Running on dry-run mode (to disable it, call 'setprop dumpstate.dry_run false')\n");
2515 }
2516
Nandana Dutt235c6672019-11-14 15:22:32 +00002517 MYLOGI("dumpstate info: id=%d, args='%s', bugreport_mode= %s bugreport format version: %s\n",
2518 id_, options_->args.c_str(), options_->bugreport_mode.c_str(), version_.c_str());
Felipe Leme809d74e2016-02-02 12:57:00 -08002519
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002520 do_early_screenshot_ = options_->do_progress_updates;
Felipe Lemee338bf62015-12-07 14:03:50 -08002521
Christopher Ferrised9354f2014-10-01 17:35:01 -07002522 // If we are going to use a socket, do it as early as possible
2523 // to avoid timeouts from bugreport.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002524 if (options_->use_socket) {
Nandana Dutta344cb62019-02-22 15:12:35 +00002525 if (!redirect_to_socket(stdout, "dumpstate")) {
2526 return ERROR;
2527 }
Christopher Ferrised9354f2014-10-01 17:35:01 -07002528 }
2529
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002530 if (options_->use_control_socket) {
Felipe Leme2628e9e2016-04-12 16:36:51 -07002531 MYLOGD("Opening control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002532 control_socket_fd_ = open_socket("dumpstate");
Nandana Dutta344cb62019-02-22 15:12:35 +00002533 if (control_socket_fd_ == -1) {
2534 return ERROR;
2535 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002536 options_->do_progress_updates = 1;
Felipe Leme2628e9e2016-04-12 16:36:51 -07002537 }
2538
Felipe Leme71bbfc52015-11-23 14:14:51 -08002539 if (is_redirecting) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002540 PrepareToWriteToFile();
Felipe Leme1e9edc62015-12-21 16:02:13 -08002541
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002542 if (options_->do_progress_updates) {
Abhijeet Kaure370d682019-10-01 16:49:30 +01002543 // clang-format off
2544 std::vector<std::string> am_args = {
2545 "--receiver-permission", "android.permission.DUMP",
2546 };
2547 // clang-format on
2548 // Send STARTED broadcast for apps that listen to bugreport generation events
2549 SendBroadcast("com.android.internal.intent.action.BUGREPORT_STARTED", am_args);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002550 if (options_->use_control_socket) {
2551 dprintf(control_socket_fd_, "BEGIN:%s\n", path_.c_str());
Felipe Lemeaabfcae2016-07-29 09:49:04 -07002552 }
Felipe Leme71bbfc52015-11-23 14:14:51 -08002553 }
2554 }
2555
Nick Kralevichf3599b32016-01-25 15:05:16 -08002556 /* read /proc/cmdline before dropping root */
2557 FILE *cmdline = fopen("/proc/cmdline", "re");
2558 if (cmdline) {
2559 fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
2560 fclose(cmdline);
2561 }
2562
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002563 if (options_->do_vibrate) {
Felipe Leme35b8cf12017-02-10 15:47:29 -08002564 Vibrate(150);
John Michelau1f794c42012-09-17 11:20:19 -05002565 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002566
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002567 if (options_->do_zip_file && zip_file != nullptr) {
2568 if (chown(path_.c_str(), AID_SHELL, AID_SHELL)) {
2569 MYLOGE("Unable to change ownership of zip file %s: %s\n", path_.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -07002570 strerror(errno));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002571 }
2572 }
2573
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002574 int dup_stdout_fd;
2575 int dup_stderr_fd;
Felipe Leme71bbfc52015-11-23 14:14:51 -08002576 if (is_redirecting) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002577 // Redirect stderr to log_path_ for debugging.
Vishnu Nair20cf5032018-01-05 13:15:49 -08002578 TEMP_FAILURE_RETRY(dup_stderr_fd = dup(fileno(stderr)));
Nandana Dutta344cb62019-02-22 15:12:35 +00002579 if (!redirect_to_file(stderr, const_cast<char*>(log_path_.c_str()))) {
2580 return ERROR;
2581 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002582 if (chown(log_path_.c_str(), AID_SHELL, AID_SHELL)) {
2583 MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n", log_path_.c_str(),
2584 strerror(errno));
Felipe Leme6fe9db62016-02-12 09:04:16 -08002585 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002586
2587 // Redirect stdout to tmp_path_. This is the main bugreport entry and will be
2588 // moved into zip file later, if zipping.
Vishnu Nair20cf5032018-01-05 13:15:49 -08002589 TEMP_FAILURE_RETRY(dup_stdout_fd = dup(fileno(stdout)));
Nandana Dutt979388e2018-11-30 16:48:55 +00002590 // TODO: why not write to a file instead of stdout to overcome this problem?
Felipe Leme6e01fa62015-11-11 19:35:14 -08002591 /* TODO: rather than generating a text file now and zipping it later,
2592 it would be more efficient to redirect stdout to the zip entry
2593 directly, but the libziparchive doesn't support that option yet. */
Nandana Dutta344cb62019-02-22 15:12:35 +00002594 if (!redirect_to_file(stdout, const_cast<char*>(tmp_path_.c_str()))) {
2595 return ERROR;
2596 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002597 if (chown(tmp_path_.c_str(), AID_SHELL, AID_SHELL)) {
Felipe Leme6fe9db62016-02-12 09:04:16 -08002598 MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002599 tmp_path_.c_str(), strerror(errno));
Felipe Leme6fe9db62016-02-12 09:04:16 -08002600 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002601 }
Felipe Lemed8b94e52016-12-08 10:21:44 -08002602
2603 // Don't buffer stdout
2604 setvbuf(stdout, nullptr, _IONBF, 0);
2605
Felipe Leme608385d2016-02-01 10:35:38 -08002606 // NOTE: there should be no stdout output until now, otherwise it would break the header.
2607 // In particular, DurationReport objects should be created passing 'title, NULL', so their
Felipe Lemecbce55d2016-02-08 09:53:18 -08002608 // duration is logged into MYLOG instead.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002609 PrintHeader();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002610
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002611 if (options_->telephony_only) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002612 MaybeTakeEarlyScreenshot();
Jichao Lie89d9c12019-11-21 19:02:51 -08002613 MaybeCheckUserConsent(calling_uid, calling_package);
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08002614 DumpstateTelephonyOnly(calling_package);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002615 DumpstateBoard();
2616 } else if (options_->wifi_only) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002617 MaybeTakeEarlyScreenshot();
Jichao Lie89d9c12019-11-21 19:02:51 -08002618 MaybeCheckUserConsent(calling_uid, calling_package);
mukesh agrawal253dad42018-01-23 21:59:59 -08002619 DumpstateWifiOnly();
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002620 } else {
Paul Chang0d2aad72020-02-13 20:04:03 +08002621 // Invoke critical dumpsys first to preserve system state, before doing anything else.
Jichao Lie89d9c12019-11-21 19:02:51 -08002622 RunDumpsysCritical();
2623
Paul Chang0d2aad72020-02-13 20:04:03 +08002624 // Take screenshot and get consent only after critical dumpsys has finished.
2625 MaybeTakeEarlyScreenshot();
Jichao Lie89d9c12019-11-21 19:02:51 -08002626 MaybeCheckUserConsent(calling_uid, calling_package);
2627
Nandana Dutt4be45d12018-09-26 15:04:23 +01002628 // Dump state for the default case. This also drops root.
Jichao Lie89d9c12019-11-21 19:02:51 -08002629 RunStatus s = DumpstateDefaultAfterCritical();
Nandana Dutt5c390032019-03-12 10:52:56 +00002630 if (s != RunStatus::OK) {
Nandana Duttaac6f582019-07-26 14:32:47 +01002631 if (s == RunStatus::USER_CONSENT_DENIED) {
Nandana Dutt5c390032019-03-12 10:52:56 +00002632 HandleUserConsentDenied();
2633 }
2634 return s;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002635 }
Zhengyin Qian068ecc72016-08-10 16:48:14 -07002636 }
Felipe Leme71a74ac2016-03-17 15:43:25 -07002637
Felipe Leme55b42a62015-11-10 17:39:08 -08002638 /* close output if needed */
Felipe Leme71bbfc52015-11-23 14:14:51 -08002639 if (is_redirecting) {
Vishnu Nair20cf5032018-01-05 13:15:49 -08002640 TEMP_FAILURE_RETRY(dup2(dup_stdout_fd, fileno(stdout)));
Colin Crossf45fa6b2012-03-26 12:38:26 -07002641 }
2642
Abhijeet Kaure370d682019-10-01 16:49:30 +01002643 // Zip the (now complete) .tmp file within the internal directory.
Nandana Dutt9a76d202019-01-21 15:56:48 +00002644 if (options_->OutputToFile()) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002645 FinalizeFile();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002646 }
2647
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002648 // Share the final file with the caller if the user has consented or Shell is the caller.
Nandana Duttd2f5f082019-01-18 17:13:52 +00002649 Dumpstate::RunStatus status = Dumpstate::RunStatus::OK;
Abhijeet Kaure370d682019-10-01 16:49:30 +01002650 if (CalledByApi()) {
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002651 status = CopyBugreportIfUserConsented(calling_uid);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002652 if (status != Dumpstate::RunStatus::OK &&
2653 status != Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2654 // Do an early return if there were errors. We make an exception for consent
2655 // timing out because it's possible the user got distracted. In this case the
2656 // bugreport is not shared but made available for manual retrieval.
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002657 MYLOGI("User denied consent. Returning\n");
Nandana Duttd2f5f082019-01-18 17:13:52 +00002658 return status;
2659 }
Paul Chang0d2aad72020-02-13 20:04:03 +08002660 if (options_->do_screenshot &&
2661 options_->screenshot_fd.get() != -1 &&
2662 !options_->is_screenshot_copied) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00002663 bool copy_succeeded = android::os::CopyFileToFd(screenshot_path_,
2664 options_->screenshot_fd.get());
2665 if (copy_succeeded) {
2666 android::os::UnlinkAndLogOnError(screenshot_path_);
2667 }
2668 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002669 if (status == Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2670 MYLOGI(
2671 "Did not receive user consent yet."
2672 " Will not copy the bugreport artifacts to caller.\n");
Abhijeet Kaur57627412019-04-17 16:00:09 +01002673 const String16 incidentcompanion("incidentcompanion");
2674 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
2675 if (ics != nullptr) {
2676 MYLOGD("Canceling user consent request via incidentcompanion service\n");
2677 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
2678 consent_callback_.get());
2679 } else {
2680 MYLOGD("Unable to cancel user consent; incidentcompanion service unavailable\n");
2681 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002682 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00002683 }
2684
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002685 /* vibrate a few but shortly times to let user know it's finished */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002686 if (options_->do_vibrate) {
Takuya Ogawa47f644e2017-12-20 18:09:09 +09002687 for (int i = 0; i < 3; i++) {
2688 Vibrate(75);
2689 usleep((75 + 50) * 1000);
2690 }
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002691 }
2692
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002693 MYLOGD("Final progress: %d/%d (estimated %d)\n", progress_->Get(), progress_->GetMax(),
2694 progress_->GetInitialMax());
2695 progress_->Save();
2696 MYLOGI("done (id %d)\n", id_);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002697
Felipe Leme107a05f2016-03-08 15:11:15 -08002698 if (is_redirecting) {
Vishnu Nair20cf5032018-01-05 13:15:49 -08002699 TEMP_FAILURE_RETRY(dup2(dup_stderr_fd, fileno(stderr)));
Felipe Leme107a05f2016-03-08 15:11:15 -08002700 }
2701
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002702 if (options_->use_control_socket && control_socket_fd_ != -1) {
Felipe Lemee844a9d2016-09-21 15:01:39 -07002703 MYLOGD("Closing control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002704 close(control_socket_fd_);
Felipe Leme2628e9e2016-04-12 16:36:51 -07002705 }
2706
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002707 tombstone_data_.clear();
2708 anr_data_.clear();
Narayan Kamath6b9516c2017-10-27 11:15:51 +01002709
Nandana Duttd2f5f082019-01-18 17:13:52 +00002710 return (consent_callback_ != nullptr &&
2711 consent_callback_->getResult() == UserConsentResult::UNAVAILABLE)
2712 ? USER_CONSENT_TIMED_OUT
2713 : RunStatus::OK;
2714}
2715
Paul Chang0d2aad72020-02-13 20:04:03 +08002716void Dumpstate::MaybeTakeEarlyScreenshot() {
2717 if (!options_->do_screenshot || !do_early_screenshot_) {
2718 return;
2719 }
2720
2721 TakeScreenshot();
2722}
2723
Jichao Lie89d9c12019-11-21 19:02:51 -08002724void Dumpstate::MaybeCheckUserConsent(int32_t calling_uid, const std::string& calling_package) {
2725 if (calling_uid == AID_SHELL || !CalledByApi()) {
2726 // No need to get consent for shell triggered dumpstates, or not through
2727 // bugreporting API (i.e. no fd to copy back).
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002728 return;
2729 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00002730 consent_callback_ = new ConsentCallback();
2731 const String16 incidentcompanion("incidentcompanion");
2732 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
Jichao Lie89d9c12019-11-21 19:02:51 -08002733 android::String16 package(calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00002734 if (ics != nullptr) {
2735 MYLOGD("Checking user consent via incidentcompanion service\n");
2736 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
Jichao Lie89d9c12019-11-21 19:02:51 -08002737 calling_uid, package, String16(), String16(),
Joe Onorato1c36d752019-03-17 18:26:43 -07002738 0x1 /* FLAG_CONFIRMATION_DIALOG */, consent_callback_.get());
Nandana Duttd2f5f082019-01-18 17:13:52 +00002739 } else {
2740 MYLOGD("Unable to check user consent; incidentcompanion service unavailable\n");
2741 }
2742}
2743
Nandana Dutt5c390032019-03-12 10:52:56 +00002744bool Dumpstate::IsUserConsentDenied() const {
2745 return ds.consent_callback_ != nullptr &&
2746 ds.consent_callback_->getResult() == UserConsentResult::DENIED;
2747}
2748
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002749bool Dumpstate::CalledByApi() const {
2750 return ds.options_->bugreport_fd.get() != -1 ? true : false;
2751}
2752
Nandana Duttd2f5f082019-01-18 17:13:52 +00002753void Dumpstate::CleanupFiles() {
2754 android::os::UnlinkAndLogOnError(tmp_path_);
2755 android::os::UnlinkAndLogOnError(screenshot_path_);
2756 android::os::UnlinkAndLogOnError(path_);
2757}
2758
2759Dumpstate::RunStatus Dumpstate::HandleUserConsentDenied() {
2760 MYLOGD("User denied consent; deleting files and returning\n");
2761 CleanupFiles();
2762 return USER_CONSENT_DENIED;
2763}
2764
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002765Dumpstate::RunStatus Dumpstate::CopyBugreportIfUserConsented(int32_t calling_uid) {
Nandana Duttd2f5f082019-01-18 17:13:52 +00002766 // If the caller has asked to copy the bugreport over to their directory, we need explicit
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002767 // user consent (unless the caller is Shell).
2768 UserConsentResult consent_result;
2769 if (calling_uid == AID_SHELL) {
2770 consent_result = UserConsentResult::APPROVED;
2771 } else {
2772 consent_result = consent_callback_->getResult();
2773 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00002774 if (consent_result == UserConsentResult::UNAVAILABLE) {
2775 // User has not responded yet.
2776 uint64_t elapsed_ms = consent_callback_->getElapsedTimeMs();
Hunter Knepshield70610fa2020-01-03 15:27:33 -08002777 // Telephony is a fast report type, particularly on user builds where information may be
2778 // more aggressively limited. To give the user time to read the consent dialog, increase the
2779 // timeout.
2780 uint64_t timeout_ms = options_->telephony_only ? TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS
2781 : USER_CONSENT_TIMEOUT_MS;
2782 if (elapsed_ms < timeout_ms) {
2783 uint delay_seconds = (timeout_ms - elapsed_ms) / 1000;
Nandana Duttd2f5f082019-01-18 17:13:52 +00002784 MYLOGD("Did not receive user consent yet; going to wait for %d seconds", delay_seconds);
2785 sleep(delay_seconds);
2786 }
2787 consent_result = consent_callback_->getResult();
2788 }
2789 if (consent_result == UserConsentResult::DENIED) {
2790 // User has explicitly denied sharing with the app. To be safe delete the
2791 // internal bugreport & tmp files.
2792 return HandleUserConsentDenied();
2793 }
2794 if (consent_result == UserConsentResult::APPROVED) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00002795 bool copy_succeeded = android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
2796 if (copy_succeeded) {
2797 android::os::UnlinkAndLogOnError(path_);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002798 }
2799 return copy_succeeded ? Dumpstate::RunStatus::OK : Dumpstate::RunStatus::ERROR;
2800 } else if (consent_result == UserConsentResult::UNAVAILABLE) {
2801 // consent_result is still UNAVAILABLE. The user has likely not responded yet.
2802 // Since we do not have user consent to share the bugreport it does not get
2803 // copied over to the calling app but remains in the internal directory from
2804 // where the user can manually pull it.
2805 return Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT;
2806 }
2807 // Unknown result; must be a programming error.
2808 MYLOGE("Unknown user consent result:%d\n", consent_result);
2809 return Dumpstate::RunStatus::ERROR;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002810}
2811
Nandana Duttf02564e2019-02-15 15:24:24 +00002812Dumpstate::RunStatus Dumpstate::ParseCommandlineAndRun(int argc, char* argv[]) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002813 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
2814 Dumpstate::RunStatus status = options->Initialize(argc, argv);
2815 if (status == Dumpstate::RunStatus::OK) {
Nandana Duttf02564e2019-02-15 15:24:24 +00002816 SetOptions(std::move(options));
Nandana Duttd2f5f082019-01-18 17:13:52 +00002817 // When directly running dumpstate binary, the output is not expected to be written
2818 // to any external file descriptor.
Nandana Duttf02564e2019-02-15 15:24:24 +00002819 assert(options_->bugreport_fd.get() == -1);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002820
2821 // calling_uid and calling_package are for user consent to share the bugreport with
2822 // an app; they are irrelvant here because bugreport is only written to a local
2823 // directory, and not shared.
Nandana Duttf02564e2019-02-15 15:24:24 +00002824 status = Run(-1 /* calling_uid */, "" /* calling_package */);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002825 }
Nandana Duttf02564e2019-02-15 15:24:24 +00002826 return status;
2827}
2828
2829/* Main entry point for dumpstate binary. */
2830int run_main(int argc, char* argv[]) {
2831 Dumpstate::RunStatus status = ds.ParseCommandlineAndRun(argc, argv);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002832
2833 switch (status) {
2834 case Dumpstate::RunStatus::OK:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002835 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002836 case Dumpstate::RunStatus::HELP:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002837 ShowUsage();
2838 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002839 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002840 fprintf(stderr, "Invalid combination of args\n");
2841 ShowUsage();
2842 exit(1);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002843 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002844 FALLTHROUGH_INTENDED;
2845 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2846 FALLTHROUGH_INTENDED;
2847 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002848 exit(2);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002849 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002850}
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002851
2852// TODO(111441001): Default DumpOptions to sensible values.
2853Dumpstate::Dumpstate(const std::string& version)
2854 : pid_(getpid()),
2855 options_(new Dumpstate::DumpOptions()),
Nandana Dutt402a8392019-06-14 14:25:13 +01002856 last_reported_percent_progress_(0),
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002857 version_(version),
2858 now_(time(nullptr)) {
2859}
2860
2861Dumpstate& Dumpstate::GetInstance() {
2862 static Dumpstate singleton_(android::base::GetProperty("dumpstate.version", VERSION_CURRENT));
2863 return singleton_;
2864}
2865
Nandana Dutt8d945c02019-08-14 13:30:07 +01002866DurationReporter::DurationReporter(const std::string& title, bool logcat_only, bool verbose)
2867 : title_(title), logcat_only_(logcat_only), verbose_(verbose) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002868 if (!title_.empty()) {
2869 started_ = Nanotime();
2870 }
2871}
2872
2873DurationReporter::~DurationReporter() {
2874 if (!title_.empty()) {
2875 float elapsed = (float)(Nanotime() - started_) / NANOS_PER_SEC;
chenqiwuaf8b2d92019-12-12 18:53:51 +08002876 if (elapsed >= .5f || verbose_) {
2877 MYLOGD("Duration of '%s': %.2fs\n", title_.c_str(), elapsed);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002878 }
chenqiwuaf8b2d92019-12-12 18:53:51 +08002879 if (!logcat_only_) {
2880 // Use "Yoda grammar" to make it easier to grep|sort sections.
2881 printf("------ %.3fs was the duration of '%s' ------\n", elapsed, title_.c_str());
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002882 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002883 }
2884}
2885
2886const int32_t Progress::kDefaultMax = 5000;
2887
2888Progress::Progress(const std::string& path) : Progress(Progress::kDefaultMax, 1.1, path) {
2889}
2890
2891Progress::Progress(int32_t initial_max, int32_t progress, float growth_factor)
2892 : Progress(initial_max, growth_factor, "") {
2893 progress_ = progress;
2894}
2895
2896Progress::Progress(int32_t initial_max, float growth_factor, const std::string& path)
2897 : initial_max_(initial_max),
2898 progress_(0),
2899 max_(initial_max),
2900 growth_factor_(growth_factor),
2901 n_runs_(0),
2902 average_max_(0),
2903 path_(path) {
2904 if (!path_.empty()) {
2905 Load();
2906 }
2907}
2908
2909void Progress::Load() {
2910 MYLOGD("Loading stats from %s\n", path_.c_str());
2911 std::string content;
2912 if (!android::base::ReadFileToString(path_, &content)) {
2913 MYLOGI("Could not read stats from %s; using max of %d\n", path_.c_str(), max_);
2914 return;
2915 }
2916 if (content.empty()) {
2917 MYLOGE("No stats (empty file) on %s; using max of %d\n", path_.c_str(), max_);
2918 return;
2919 }
2920 std::vector<std::string> lines = android::base::Split(content, "\n");
2921
2922 if (lines.size() < 1) {
2923 MYLOGE("Invalid stats on file %s: not enough lines (%d). Using max of %d\n", path_.c_str(),
2924 (int)lines.size(), max_);
2925 return;
2926 }
2927 char* ptr;
2928 n_runs_ = strtol(lines[0].c_str(), &ptr, 10);
2929 average_max_ = strtol(ptr, nullptr, 10);
2930 if (n_runs_ <= 0 || average_max_ <= 0 || n_runs_ > STATS_MAX_N_RUNS ||
2931 average_max_ > STATS_MAX_AVERAGE) {
2932 MYLOGE("Invalid stats line on file %s: %s\n", path_.c_str(), lines[0].c_str());
2933 initial_max_ = Progress::kDefaultMax;
2934 } else {
2935 initial_max_ = average_max_;
2936 }
2937 max_ = initial_max_;
2938
2939 MYLOGI("Average max progress: %d in %d runs; estimated max: %d\n", average_max_, n_runs_, max_);
2940}
2941
2942void Progress::Save() {
2943 int32_t total = n_runs_ * average_max_ + progress_;
2944 int32_t runs = n_runs_ + 1;
2945 int32_t average = floor(((float)total) / runs);
2946 MYLOGI("Saving stats (total=%d, runs=%d, average=%d) on %s\n", total, runs, average,
2947 path_.c_str());
2948 if (path_.empty()) {
2949 return;
2950 }
2951
2952 std::string content = android::base::StringPrintf("%d %d\n", runs, average);
2953 if (!android::base::WriteStringToFile(content, path_)) {
2954 MYLOGE("Could not save stats on %s\n", path_.c_str());
2955 }
2956}
2957
2958int32_t Progress::Get() const {
2959 return progress_;
2960}
2961
2962bool Progress::Inc(int32_t delta_sec) {
2963 bool changed = false;
2964 if (delta_sec >= 0) {
2965 progress_ += delta_sec;
2966 if (progress_ > max_) {
2967 int32_t old_max = max_;
2968 max_ = floor((float)progress_ * growth_factor_);
2969 MYLOGD("Adjusting max progress from %d to %d\n", old_max, max_);
2970 changed = true;
2971 }
2972 }
2973 return changed;
2974}
2975
2976int32_t Progress::GetMax() const {
2977 return max_;
2978}
2979
2980int32_t Progress::GetInitialMax() const {
2981 return initial_max_;
2982}
2983
2984void Progress::Dump(int fd, const std::string& prefix) const {
2985 const char* pr = prefix.c_str();
2986 dprintf(fd, "%sprogress: %d\n", pr, progress_);
2987 dprintf(fd, "%smax: %d\n", pr, max_);
2988 dprintf(fd, "%sinitial_max: %d\n", pr, initial_max_);
2989 dprintf(fd, "%sgrowth_factor: %0.2f\n", pr, growth_factor_);
2990 dprintf(fd, "%spath: %s\n", pr, path_.c_str());
2991 dprintf(fd, "%sn_runs: %d\n", pr, n_runs_);
2992 dprintf(fd, "%saverage_max: %d\n", pr, average_max_);
2993}
2994
2995bool Dumpstate::IsZipping() const {
2996 return zip_writer_ != nullptr;
2997}
2998
2999std::string Dumpstate::GetPath(const std::string& suffix) const {
3000 return GetPath(bugreport_internal_dir_, suffix);
3001}
3002
3003std::string Dumpstate::GetPath(const std::string& directory, const std::string& suffix) const {
3004 return android::base::StringPrintf("%s/%s-%s%s", directory.c_str(), base_name_.c_str(),
3005 name_.c_str(), suffix.c_str());
3006}
3007
3008void Dumpstate::SetProgress(std::unique_ptr<Progress> progress) {
3009 progress_ = std::move(progress);
3010}
3011
3012void for_each_userid(void (*func)(int), const char *header) {
3013 std::string title = header == nullptr ? "for_each_userid" : android::base::StringPrintf(
3014 "for_each_userid(%s)", header);
3015 DurationReporter duration_reporter(title);
3016 if (PropertiesHelper::IsDryRun()) return;
3017
3018 DIR *d;
3019 struct dirent *de;
3020
3021 if (header) printf("\n------ %s ------\n", header);
3022 func(0);
3023
3024 if (!(d = opendir("/data/system/users"))) {
3025 printf("Failed to open /data/system/users (%s)\n", strerror(errno));
3026 return;
3027 }
3028
3029 while ((de = readdir(d))) {
3030 int userid;
3031 if (de->d_type != DT_DIR || !(userid = atoi(de->d_name))) {
3032 continue;
3033 }
3034 func(userid);
3035 }
3036
3037 closedir(d);
3038}
3039
3040static void __for_each_pid(void (*helper)(int, const char *, void *), const char *header, void *arg) {
3041 DIR *d;
3042 struct dirent *de;
3043
3044 if (!(d = opendir("/proc"))) {
3045 printf("Failed to open /proc (%s)\n", strerror(errno));
3046 return;
3047 }
3048
3049 if (header) printf("\n------ %s ------\n", header);
3050 while ((de = readdir(d))) {
3051 if (ds.IsUserConsentDenied()) {
3052 MYLOGE(
3053 "Returning early because user denied consent to share bugreport with calling app.");
3054 closedir(d);
3055 return;
3056 }
3057 int pid;
3058 int fd;
3059 char cmdpath[255];
3060 char cmdline[255];
3061
3062 if (!(pid = atoi(de->d_name))) {
3063 continue;
3064 }
3065
3066 memset(cmdline, 0, sizeof(cmdline));
3067
3068 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/cmdline", pid);
3069 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3070 TEMP_FAILURE_RETRY(read(fd, cmdline, sizeof(cmdline) - 2));
3071 close(fd);
3072 if (cmdline[0]) {
3073 helper(pid, cmdline, arg);
3074 continue;
3075 }
3076 }
3077
3078 // if no cmdline, a kernel thread has comm
3079 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/comm", pid);
3080 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3081 TEMP_FAILURE_RETRY(read(fd, cmdline + 1, sizeof(cmdline) - 4));
3082 close(fd);
3083 if (cmdline[1]) {
3084 cmdline[0] = '[';
3085 size_t len = strcspn(cmdline, "\f\b\r\n");
3086 cmdline[len] = ']';
3087 cmdline[len+1] = '\0';
3088 }
3089 }
3090 if (!cmdline[0]) {
3091 strcpy(cmdline, "N/A");
3092 }
3093 helper(pid, cmdline, arg);
3094 }
3095
3096 closedir(d);
3097}
3098
3099static void for_each_pid_helper(int pid, const char *cmdline, void *arg) {
3100 for_each_pid_func *func = (for_each_pid_func*) arg;
3101 func(pid, cmdline);
3102}
3103
3104void for_each_pid(for_each_pid_func func, const char *header) {
3105 std::string title = header == nullptr ? "for_each_pid"
3106 : android::base::StringPrintf("for_each_pid(%s)", header);
3107 DurationReporter duration_reporter(title);
3108 if (PropertiesHelper::IsDryRun()) return;
3109
3110 __for_each_pid(for_each_pid_helper, header, (void *) func);
3111}
3112
3113static void for_each_tid_helper(int pid, const char *cmdline, void *arg) {
3114 DIR *d;
3115 struct dirent *de;
3116 char taskpath[255];
3117 for_each_tid_func *func = (for_each_tid_func *) arg;
3118
3119 snprintf(taskpath, sizeof(taskpath), "/proc/%d/task", pid);
3120
3121 if (!(d = opendir(taskpath))) {
3122 printf("Failed to open %s (%s)\n", taskpath, strerror(errno));
3123 return;
3124 }
3125
3126 func(pid, pid, cmdline);
3127
3128 while ((de = readdir(d))) {
3129 if (ds.IsUserConsentDenied()) {
3130 MYLOGE(
3131 "Returning early because user denied consent to share bugreport with calling app.");
3132 closedir(d);
3133 return;
3134 }
3135 int tid;
3136 int fd;
3137 char commpath[255];
3138 char comm[255];
3139
3140 if (!(tid = atoi(de->d_name))) {
3141 continue;
3142 }
3143
3144 if (tid == pid)
3145 continue;
3146
3147 snprintf(commpath, sizeof(commpath), "/proc/%d/comm", tid);
3148 memset(comm, 0, sizeof(comm));
3149 if ((fd = TEMP_FAILURE_RETRY(open(commpath, O_RDONLY | O_CLOEXEC))) < 0) {
3150 strcpy(comm, "N/A");
3151 } else {
3152 char *c;
3153 TEMP_FAILURE_RETRY(read(fd, comm, sizeof(comm) - 2));
3154 close(fd);
3155
3156 c = strrchr(comm, '\n');
3157 if (c) {
3158 *c = '\0';
3159 }
3160 }
3161 func(pid, tid, comm);
3162 }
3163
3164 closedir(d);
3165}
3166
3167void for_each_tid(for_each_tid_func func, const char *header) {
3168 std::string title = header == nullptr ? "for_each_tid"
3169 : android::base::StringPrintf("for_each_tid(%s)", header);
3170 DurationReporter duration_reporter(title);
3171
3172 if (PropertiesHelper::IsDryRun()) return;
3173
3174 __for_each_pid(for_each_tid_helper, header, (void *) func);
3175}
3176
3177void show_wchan(int pid, int tid, const char *name) {
3178 if (PropertiesHelper::IsDryRun()) return;
3179
3180 char path[255];
3181 char buffer[255];
3182 int fd, ret, save_errno;
3183 char name_buffer[255];
3184
3185 memset(buffer, 0, sizeof(buffer));
3186
3187 snprintf(path, sizeof(path), "/proc/%d/wchan", tid);
3188 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3189 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3190 return;
3191 }
3192
3193 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3194 save_errno = errno;
3195 close(fd);
3196
3197 if (ret < 0) {
3198 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3199 return;
3200 }
3201
3202 snprintf(name_buffer, sizeof(name_buffer), "%*s%s",
3203 pid == tid ? 0 : 3, "", name);
3204
3205 printf("%-7d %-32s %s\n", tid, name_buffer, buffer);
3206
3207 return;
3208}
3209
3210// print time in centiseconds
3211static void snprcent(char *buffer, size_t len, size_t spc,
3212 unsigned long long time) {
3213 static long hz; // cache discovered hz
3214
3215 if (hz <= 0) {
3216 hz = sysconf(_SC_CLK_TCK);
3217 if (hz <= 0) {
3218 hz = 1000;
3219 }
3220 }
3221
3222 // convert to centiseconds
3223 time = (time * 100 + (hz / 2)) / hz;
3224
3225 char str[16];
3226
3227 snprintf(str, sizeof(str), " %llu.%02u",
3228 time / 100, (unsigned)(time % 100));
3229 size_t offset = strlen(buffer);
3230 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3231 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3232}
3233
3234// print permille as a percent
3235static void snprdec(char *buffer, size_t len, size_t spc, unsigned permille) {
3236 char str[16];
3237
3238 snprintf(str, sizeof(str), " %u.%u%%", permille / 10, permille % 10);
3239 size_t offset = strlen(buffer);
3240 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3241 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3242}
3243
3244void show_showtime(int pid, const char *name) {
3245 if (PropertiesHelper::IsDryRun()) return;
3246
3247 char path[255];
3248 char buffer[1023];
3249 int fd, ret, save_errno;
3250
3251 memset(buffer, 0, sizeof(buffer));
3252
3253 snprintf(path, sizeof(path), "/proc/%d/stat", pid);
3254 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3255 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3256 return;
3257 }
3258
3259 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3260 save_errno = errno;
3261 close(fd);
3262
3263 if (ret < 0) {
3264 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3265 return;
3266 }
3267
3268 // field 14 is utime
3269 // field 15 is stime
3270 // field 42 is iotime
3271 unsigned long long utime = 0, stime = 0, iotime = 0;
3272 if (sscanf(buffer,
3273 "%*u %*s %*s %*d %*d %*d %*d %*d %*d %*d %*d "
3274 "%*d %*d %llu %llu %*d %*d %*d %*d %*d %*d "
3275 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %*d "
3276 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %llu ",
3277 &utime, &stime, &iotime) != 3) {
3278 return;
3279 }
3280
3281 unsigned long long total = utime + stime;
3282 if (!total) {
3283 return;
3284 }
3285
3286 unsigned permille = (iotime * 1000 + (total / 2)) / total;
3287 if (permille > 1000) {
3288 permille = 1000;
3289 }
3290
3291 // try to beautify and stabilize columns at <80 characters
3292 snprintf(buffer, sizeof(buffer), "%-6d%s", pid, name);
3293 if ((name[0] != '[') || utime) {
3294 snprcent(buffer, sizeof(buffer), 57, utime);
3295 }
3296 snprcent(buffer, sizeof(buffer), 65, stime);
3297 if ((name[0] != '[') || iotime) {
3298 snprcent(buffer, sizeof(buffer), 73, iotime);
3299 }
3300 if (iotime) {
3301 snprdec(buffer, sizeof(buffer), 79, permille);
3302 }
3303 puts(buffer); // adds a trailing newline
3304
3305 return;
3306}
3307
3308void do_dmesg() {
3309 const char *title = "KERNEL LOG (dmesg)";
3310 DurationReporter duration_reporter(title);
3311 printf("------ %s ------\n", title);
3312
3313 if (PropertiesHelper::IsDryRun()) return;
3314
3315 /* Get size of kernel buffer */
3316 int size = klogctl(KLOG_SIZE_BUFFER, nullptr, 0);
3317 if (size <= 0) {
3318 printf("Unexpected klogctl return value: %d\n\n", size);
3319 return;
3320 }
3321 char *buf = (char *) malloc(size + 1);
3322 if (buf == nullptr) {
3323 printf("memory allocation failed\n\n");
3324 return;
3325 }
3326 int retval = klogctl(KLOG_READ_ALL, buf, size);
3327 if (retval < 0) {
3328 printf("klogctl failure\n\n");
3329 free(buf);
3330 return;
3331 }
3332 buf[retval] = '\0';
3333 printf("%s\n\n", buf);
3334 free(buf);
3335 return;
3336}
3337
3338void do_showmap(int pid, const char *name) {
3339 char title[255];
3340 char arg[255];
3341
3342 snprintf(title, sizeof(title), "SHOW MAP %d (%s)", pid, name);
3343 snprintf(arg, sizeof(arg), "%d", pid);
3344 RunCommand(title, {"showmap", "-q", arg}, CommandOptions::AS_ROOT);
3345}
3346
3347int Dumpstate::DumpFile(const std::string& title, const std::string& path) {
3348 DurationReporter duration_reporter(title);
3349
3350 int status = DumpFileToFd(STDOUT_FILENO, title, path);
3351
3352 UpdateProgress(WEIGHT_FILE);
3353
3354 return status;
3355}
3356
3357int read_file_as_long(const char *path, long int *output) {
3358 int fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC));
3359 if (fd < 0) {
3360 int err = errno;
3361 MYLOGE("Error opening file descriptor for %s: %s\n", path, strerror(err));
3362 return -1;
3363 }
3364 char buffer[50];
3365 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3366 if (bytes_read == -1) {
3367 MYLOGE("Error reading file %s: %s\n", path, strerror(errno));
3368 return -2;
3369 }
3370 if (bytes_read == 0) {
3371 MYLOGE("File %s is empty\n", path);
3372 return -3;
3373 }
3374 *output = atoi(buffer);
3375 return 0;
3376}
3377
3378/* calls skip to gate calling dump_from_fd recursively
3379 * in the specified directory. dump_from_fd defaults to
3380 * dump_file_from_fd above when set to NULL. skip defaults
3381 * to false when set to NULL. dump_from_fd will always be
3382 * called with title NULL.
3383 */
3384int dump_files(const std::string& title, const char* dir, bool (*skip)(const char* path),
3385 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
3386 DurationReporter duration_reporter(title);
3387 DIR *dirp;
3388 struct dirent *d;
3389 char *newpath = nullptr;
3390 const char *slash = "/";
3391 int retval = 0;
3392
3393 if (!title.empty()) {
3394 printf("------ %s (%s) ------\n", title.c_str(), dir);
3395 }
3396 if (PropertiesHelper::IsDryRun()) return 0;
3397
3398 if (dir[strlen(dir) - 1] == '/') {
3399 ++slash;
3400 }
3401 dirp = opendir(dir);
3402 if (dirp == nullptr) {
3403 retval = -errno;
3404 MYLOGE("%s: %s\n", dir, strerror(errno));
3405 return retval;
3406 }
3407
3408 if (!dump_from_fd) {
3409 dump_from_fd = dump_file_from_fd;
3410 }
3411 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
3412 if ((d->d_name[0] == '.')
3413 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
3414 || (d->d_name[1] == '\0'))) {
3415 continue;
3416 }
3417 asprintf(&newpath, "%s%s%s%s", dir, slash, d->d_name,
3418 (d->d_type == DT_DIR) ? "/" : "");
3419 if (!newpath) {
3420 retval = -errno;
3421 continue;
3422 }
3423 if (skip && (*skip)(newpath)) {
3424 continue;
3425 }
3426 if (d->d_type == DT_DIR) {
3427 int ret = dump_files("", newpath, skip, dump_from_fd);
3428 if (ret < 0) {
3429 retval = ret;
3430 }
3431 continue;
3432 }
3433 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(newpath, O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
3434 if (fd.get() < 0) {
3435 retval = -1;
3436 printf("*** %s: %s\n", newpath, strerror(errno));
3437 continue;
3438 }
3439 (*dump_from_fd)(nullptr, newpath, fd.get());
3440 }
3441 closedir(dirp);
3442 if (!title.empty()) {
3443 printf("\n");
3444 }
3445 return retval;
3446}
3447
3448/* fd must have been opened with the flag O_NONBLOCK. With this flag set,
3449 * it's possible to avoid issues where opening the file itself can get
3450 * stuck.
3451 */
3452int dump_file_from_fd(const char *title, const char *path, int fd) {
3453 if (PropertiesHelper::IsDryRun()) return 0;
3454
3455 int flags = fcntl(fd, F_GETFL);
3456 if (flags == -1) {
3457 printf("*** %s: failed to get flags on fd %d: %s\n", path, fd, strerror(errno));
3458 return -1;
3459 } else if (!(flags & O_NONBLOCK)) {
3460 printf("*** %s: fd must have O_NONBLOCK set.\n", path);
3461 return -1;
3462 }
3463 return DumpFileFromFdToFd(title, path, fd, STDOUT_FILENO, PropertiesHelper::IsDryRun());
3464}
3465
3466int Dumpstate::RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Nandana Dutt8d945c02019-08-14 13:30:07 +01003467 const CommandOptions& options, bool verbose_duration) {
3468 DurationReporter duration_reporter(title, false /* logcat_only */, verbose_duration);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003469
3470 int status = RunCommandToFd(STDOUT_FILENO, title, full_command, options);
3471
3472 /* TODO: for now we're simplifying the progress calculation by using the
3473 * timeout as the weight. It's a good approximation for most cases, except when calling dumpsys,
3474 * where its weight should be much higher proportionally to its timeout.
3475 * Ideally, it should use a options.EstimatedDuration() instead...*/
3476 UpdateProgress(options.Timeout());
3477
3478 return status;
3479}
3480
3481void Dumpstate::RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsys_args,
3482 const CommandOptions& options, long dumpsysTimeoutMs) {
3483 long timeout_ms = dumpsysTimeoutMs > 0 ? dumpsysTimeoutMs : options.TimeoutInMs();
3484 std::vector<std::string> dumpsys = {"/system/bin/dumpsys", "-T", std::to_string(timeout_ms)};
3485 dumpsys.insert(dumpsys.end(), dumpsys_args.begin(), dumpsys_args.end());
3486 RunCommand(title, dumpsys, options);
3487}
3488
3489int open_socket(const char *service) {
3490 int s = android_get_control_socket(service);
3491 if (s < 0) {
3492 MYLOGE("android_get_control_socket(%s): %s\n", service, strerror(errno));
3493 return -1;
3494 }
3495 fcntl(s, F_SETFD, FD_CLOEXEC);
3496
3497 // Set backlog to 0 to make sure that queue size will be minimum.
3498 // In Linux, because the minimum queue will be 1, connect() will be blocked
3499 // if the other clients already called connect() and the connection request was not accepted.
3500 if (listen(s, 0) < 0) {
3501 MYLOGE("listen(control socket): %s\n", strerror(errno));
3502 return -1;
3503 }
3504
3505 struct sockaddr addr;
3506 socklen_t alen = sizeof(addr);
Abhijeet Kaur2113cae2019-09-13 09:24:15 +01003507 int fd = accept4(s, &addr, &alen, SOCK_CLOEXEC);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003508
3509 // Close socket just after accept(), to make sure that connect() by client will get error
3510 // when the socket is used by the other services.
3511 // There is still a race condition possibility between accept and close, but there is no way
3512 // to close-on-accept atomically.
3513 // See detail; b/123306389#comment25
3514 close(s);
3515
3516 if (fd < 0) {
3517 MYLOGE("accept(control socket): %s\n", strerror(errno));
3518 return -1;
3519 }
3520
3521 return fd;
3522}
3523
3524/* redirect output to a service control socket */
3525bool redirect_to_socket(FILE* redirect, const char* service) {
3526 int fd = open_socket(service);
3527 if (fd == -1) {
3528 return false;
3529 }
3530 fflush(redirect);
3531 // TODO: handle dup2 failure
3532 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
3533 close(fd);
3534 return true;
3535}
3536
3537// TODO: should call is_valid_output_file and/or be merged into it.
3538void create_parent_dirs(const char *path) {
3539 char *chp = const_cast<char *> (path);
3540
3541 /* skip initial slash */
3542 if (chp[0] == '/')
3543 chp++;
3544
3545 /* create leading directories, if necessary */
3546 struct stat dir_stat;
3547 while (chp && chp[0]) {
3548 chp = strchr(chp, '/');
3549 if (chp) {
3550 *chp = 0;
3551 if (stat(path, &dir_stat) == -1 || !S_ISDIR(dir_stat.st_mode)) {
3552 MYLOGI("Creating directory %s\n", path);
3553 if (mkdir(path, 0770)) { /* drwxrwx--- */
3554 MYLOGE("Unable to create directory %s: %s\n", path, strerror(errno));
3555 } else if (chown(path, AID_SHELL, AID_SHELL)) {
3556 MYLOGE("Unable to change ownership of dir %s: %s\n", path, strerror(errno));
3557 }
3558 }
3559 *chp++ = '/';
3560 }
3561 }
3562}
3563
3564bool _redirect_to_file(FILE* redirect, char* path, int truncate_flag) {
3565 create_parent_dirs(path);
3566
3567 int fd = TEMP_FAILURE_RETRY(open(path,
3568 O_WRONLY | O_CREAT | truncate_flag | O_CLOEXEC | O_NOFOLLOW,
3569 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH));
3570 if (fd < 0) {
3571 MYLOGE("%s: %s\n", path, strerror(errno));
3572 return false;
3573 }
3574
3575 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
3576 close(fd);
3577 return true;
3578}
3579
3580bool redirect_to_file(FILE* redirect, char* path) {
3581 return _redirect_to_file(redirect, path, O_TRUNC);
3582}
3583
3584bool redirect_to_existing_file(FILE* redirect, char* path) {
3585 return _redirect_to_file(redirect, path, O_APPEND);
3586}
3587
3588void dump_route_tables() {
3589 DurationReporter duration_reporter("DUMP ROUTE TABLES");
3590 if (PropertiesHelper::IsDryRun()) return;
3591 const char* const RT_TABLES_PATH = "/data/misc/net/rt_tables";
3592 ds.DumpFile("RT_TABLES", RT_TABLES_PATH);
3593 FILE* fp = fopen(RT_TABLES_PATH, "re");
3594 if (!fp) {
3595 printf("*** %s: %s\n", RT_TABLES_PATH, strerror(errno));
3596 return;
3597 }
3598 char table[16];
3599 // Each line has an integer (the table number), a space, and a string (the table name). We only
3600 // need the table number. It's a 32-bit unsigned number, so max 10 chars. Skip the table name.
3601 // Add a fixed max limit so this doesn't go awry.
3602 for (int i = 0; i < 64 && fscanf(fp, " %10s %*s", table) == 1; ++i) {
3603 RunCommand("ROUTE TABLE IPv4", {"ip", "-4", "route", "show", "table", table});
3604 RunCommand("ROUTE TABLE IPv6", {"ip", "-6", "route", "show", "table", table});
3605 }
3606 fclose(fp);
3607}
3608
3609// TODO: make this function thread safe if sections are generated in parallel.
3610void Dumpstate::UpdateProgress(int32_t delta_sec) {
3611 if (progress_ == nullptr) {
3612 MYLOGE("UpdateProgress: progress_ not set\n");
3613 return;
3614 }
3615
3616 // Always update progess so stats can be tuned...
Nandana Dutt402a8392019-06-14 14:25:13 +01003617 progress_->Inc(delta_sec);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003618
3619 // ...but only notifiy listeners when necessary.
3620 if (!options_->do_progress_updates) return;
3621
3622 int progress = progress_->Get();
3623 int max = progress_->GetMax();
Nandana Dutt402a8392019-06-14 14:25:13 +01003624 int percent = 100 * progress / max;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003625
Nandana Dutt402a8392019-06-14 14:25:13 +01003626 if (last_reported_percent_progress_ > 0 && percent <= last_reported_percent_progress_) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003627 return;
3628 }
Nandana Dutt402a8392019-06-14 14:25:13 +01003629 last_reported_percent_progress_ = percent;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003630
3631 if (control_socket_fd_ >= 0) {
3632 dprintf(control_socket_fd_, "PROGRESS:%d/%d\n", progress, max);
3633 fsync(control_socket_fd_);
3634 }
3635
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003636 if (listener_ != nullptr) {
Nandana Dutt235c6672019-11-14 15:22:32 +00003637 if (percent % 10 == 0) {
3638 // We don't want to spam logcat, so only log multiples of 10.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01003639 MYLOGD("Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003640 } else {
3641 // stderr is ignored on normal invocations, but useful when calling
3642 // /system/bin/dumpstate directly for debuggging.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01003643 fprintf(stderr, "Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003644 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003645
3646 listener_->onProgress(percent);
3647 }
3648}
3649
3650void Dumpstate::TakeScreenshot(const std::string& path) {
3651 const std::string& real_path = path.empty() ? screenshot_path_ : path;
3652 int status =
3653 RunCommand("", {"/system/bin/screencap", "-p", real_path},
3654 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3655 if (status == 0) {
3656 MYLOGD("Screenshot saved on %s\n", real_path.c_str());
3657 } else {
3658 MYLOGE("Failed to take screenshot on %s\n", real_path.c_str());
3659 }
Paul Chang0d2aad72020-02-13 20:04:03 +08003660 if (listener_ != nullptr) {
3661 // Show a visual indication to indicate screenshot is taken via
3662 // IDumpstateListener.onScreenshotTaken()
3663 listener_->onScreenshotTaken(status == 0);
3664 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003665}
3666
3667bool is_dir(const char* pathname) {
3668 struct stat info;
3669 if (stat(pathname, &info) == -1) {
3670 return false;
3671 }
3672 return S_ISDIR(info.st_mode);
3673}
3674
3675time_t get_mtime(int fd, time_t default_mtime) {
3676 struct stat info;
3677 if (fstat(fd, &info) == -1) {
3678 return default_mtime;
3679 }
3680 return info.st_mtime;
3681}