blob: f535605dea0d8dc5a80609890ea9b0fe03d80627 [file] [log] [blame]
Colin Crossf45fa6b2012-03-26 12:38:26 -07001/*
2 * Copyright (C) 2008 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
Felipe Lemef0292972016-11-22 13:57:05 -080016
Mark Salyzyn6c3d90f2016-09-27 14:55:27 -070017#define LOG_TAG "dumpstate"
Colin Crossf45fa6b2012-03-26 12:38:26 -070018
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -070019#include <dirent.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070020#include <errno.h>
21#include <fcntl.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010022#include <inttypes.h>
Felipe Lemead5f6c42015-11-30 14:26:46 -080023#include <libgen.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070024#include <limits.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010025#include <math.h>
26#include <poll.h>
Mark Salyzyn8f37aa52015-06-12 12:28:24 -070027#include <stdbool.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070028#include <stdio.h>
29#include <stdlib.h>
30#include <string.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080031#include <sys/poll.h>
Christopher Ferris7dc7f322014-07-22 16:08:19 -070032#include <sys/prctl.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070033#include <sys/resource.h>
34#include <sys/stat.h>
35#include <sys/time.h>
36#include <sys/wait.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010037#include <signal.h>
38#include <stdarg.h>
39#include <string.h>
40#include <sys/capability.h>
41#include <sys/inotify.h>
42#include <sys/klog.h>
43#include <time.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070044#include <unistd.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070045
46#include <chrono>
Hridya Valsarajuac582cd2019-08-05 15:39:54 -070047#include <cmath>
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +000048#include <fstream>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070049#include <functional>
50#include <future>
Narayan Kamath8f788292017-05-25 13:20:39 +010051#include <memory>
Hridya Valsarajuac582cd2019-08-05 15:39:54 -070052#include <numeric>
Narayan Kamath8f788292017-05-25 13:20:39 +010053#include <regex>
54#include <set>
55#include <string>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070056#include <utility>
Narayan Kamath8f788292017-05-25 13:20:39 +010057#include <vector>
Colin Crossf45fa6b2012-03-26 12:38:26 -070058
Felipe Leme96c2bbb2016-09-26 09:21:21 -070059#include <android-base/file.h>
60#include <android-base/properties.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070061#include <android-base/scopeguard.h>
Elliott Hughes9dc117c2015-12-07 14:21:50 -080062#include <android-base/stringprintf.h>
Naveen Kalla058e1e82016-10-19 21:38:44 -070063#include <android-base/strings.h>
Andreas Gampeaff68432016-07-18 18:01:27 -070064#include <android-base/unique_fd.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010065#include <android/content/pm/IPackageManagerNative.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080066#include <android/hardware/dumpstate/1.0/IDumpstateDevice.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080067#include <android/hidl/manager/1.0/IServiceManager.h>
Nandana Duttd2f5f082019-01-18 17:13:52 +000068#include <android/os/IIncidentCompanion.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010069#include <binder/IServiceManager.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080070#include <cutils/native_handle.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070071#include <cutils/properties.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010072#include <cutils/sockets.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000073#include <debuggerd/client.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080074#include <dumpsys.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000075#include <dumputils/dump_utils.h>
Sahana Raof35ed432019-07-12 10:47:52 +010076#include <hardware_legacy/power.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080077#include <hidl/ServiceManagement.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010078#include <log/log.h>
Felipe Leme75876a22016-10-27 16:31:27 -070079#include <openssl/sha.h>
Mark Salyzyn6c3d90f2016-09-27 14:55:27 -070080#include <private/android_filesystem_config.h>
81#include <private/android_logger.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080082#include <serviceutils/PriorityDumper.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070083#include <utils/StrongPointer.h>
Felipe Lemef0292972016-11-22 13:57:05 -080084#include "DumpstateInternal.h"
Felipe Leme75876a22016-10-27 16:31:27 -070085#include "DumpstateService.h"
Colin Crossf45fa6b2012-03-26 12:38:26 -070086#include "dumpstate.h"
Felipe Leme6e01fa62015-11-11 19:35:14 -080087
Steven Morelandcb7ef822016-11-29 13:20:37 -080088using ::android::hardware::dumpstate::V1_0::IDumpstateDevice;
Vishnu Naire97d6122018-01-18 13:58:56 -080089using ::std::literals::chrono_literals::operator""ms;
90using ::std::literals::chrono_literals::operator""s;
Steven Morelandcb7ef822016-11-29 13:20:37 -080091
Felipe Leme47e9be22016-12-21 15:37:07 -080092// TODO: remove once moved to namespace
Vishnu Naire97d6122018-01-18 13:58:56 -080093using android::defaultServiceManager;
94using android::Dumpsys;
95using android::INVALID_OPERATION;
96using android::IServiceManager;
97using android::OK;
98using android::sp;
99using android::status_t;
100using android::String16;
101using android::String8;
102using android::TIMED_OUT;
103using android::UNKNOWN_ERROR;
104using android::Vector;
Nandana Dutt979388e2018-11-30 16:48:55 +0000105using android::base::StringPrintf;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000106using android::os::IDumpstateListener;
Felipe Leme47e9be22016-12-21 15:37:07 -0800107using android::os::dumpstate::CommandOptions;
108using android::os::dumpstate::DumpFileToFd;
Vishnu Naire97d6122018-01-18 13:58:56 -0800109using android::os::dumpstate::PropertiesHelper;
Felipe Leme47e9be22016-12-21 15:37:07 -0800110
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100111// Keep in sync with
112// frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
113static const int TRACE_DUMP_TIMEOUT_MS = 10000; // 10 seconds
114
115/* Most simple commands have 10 as timeout, so 5 is a good estimate */
116static const int32_t WEIGHT_FILE = 5;
117
118// TODO: temporary variables and functions used during C++ refactoring
119static Dumpstate& ds = Dumpstate::GetInstance();
120static int RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Nandana Dutt8d945c02019-08-14 13:30:07 +0100121 const CommandOptions& options = CommandOptions::DEFAULT,
122 bool verbose_duration = false) {
123 return ds.RunCommand(title, full_command, options, verbose_duration);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100124}
125
126// Reasonable value for max stats.
127static const int STATS_MAX_N_RUNS = 1000;
128static const long STATS_MAX_AVERAGE = 100000;
129
130CommandOptions Dumpstate::DEFAULT_DUMPSYS = CommandOptions::WithTimeout(30).Build();
131
Nandana Duttd2f5f082019-01-18 17:13:52 +0000132typedef Dumpstate::ConsentCallback::ConsentResult UserConsentResult;
133
Colin Crossf45fa6b2012-03-26 12:38:26 -0700134/* read before root is shed */
135static char cmdline_buf[16384] = "(unknown)";
Yi Kong19d5c002018-07-20 13:39:55 -0700136static const char *dump_traces_path = nullptr;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000137static const uint64_t USER_CONSENT_TIMEOUT_MS = 30 * 1000;
Hunter Knepshield70610fa2020-01-03 15:27:33 -0800138// Because telephony reports are significantly faster to collect (< 10 seconds vs. > 2 minutes),
139// it's often the case that they time out far too quickly for consent with such a hefty dialog for
140// the user to read. For telephony reports only, we increase the default timeout to 2 minutes to
141// roughly match full reports' durations.
142static const uint64_t TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS = 2 * 60 * 1000;
Colin Crossf45fa6b2012-03-26 12:38:26 -0700143
Felipe Leme1d486fe2016-10-14 18:06:47 -0700144// TODO: variables and functions below should be part of dumpstate object
145
Felipe Leme635ca312016-01-05 14:23:02 -0800146static std::set<std::string> mount_points;
147void add_mountinfo();
Felipe Leme78f2c862015-12-21 09:55:22 -0800148
Todd Poynor2a83daa2013-11-22 15:44:22 -0800149#define PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops"
Mark Salyzyn7d0a7622016-06-24 14:06:15 -0700150#define ALT_PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops-0"
Wei Wang509bb5d2017-06-09 14:42:12 -0700151#define BLK_DEV_SYS_DIR "/sys/block"
Todd Poynor2a83daa2013-11-22 15:44:22 -0800152
Felipe Lemee82a27d2016-01-05 13:35:44 -0800153#define RECOVERY_DIR "/cache/recovery"
Mark Salyzynd6ab0112016-03-25 12:56:39 -0700154#define RECOVERY_DATA_DIR "/data/misc/recovery"
Tianjie Xu75d53362018-04-11 16:42:28 -0700155#define UPDATE_ENGINE_LOG_DIR "/data/misc/update_engine_log"
Mark Salyzyn4d42dea2016-04-01 10:03:14 -0700156#define LOGPERSIST_DATA_DIR "/data/misc/logd"
Jerry Changa1df8a92020-01-02 16:03:39 +0800157#define PREREBOOT_DATA_DIR "/data/misc/prereboot"
David Brazdild2991962016-06-03 14:40:44 +0100158#define PROFILE_DATA_DIR_CUR "/data/misc/profiles/cur"
159#define PROFILE_DATA_DIR_REF "/data/misc/profiles/ref"
Benedict Wong8f9d8a42019-01-03 16:19:38 -0800160#define XFRM_STAT_PROC_FILE "/proc/net/xfrm_stat"
Erik Kline08165202016-05-30 11:55:44 +0900161#define WLUTIL "/vendor/xbin/wlutil"
Vishnu Nair36b4cdb2017-11-17 10:27:05 -0800162#define WMTRACE_DATA_DIR "/data/misc/wmtrace"
Yifan Hong3945e1b2019-10-29 12:59:23 -0700163#define OTA_METADATA_DIR "/metadata/ota"
Yifan Hong0efa7972020-02-03 16:45:02 -0800164#define SNAPSHOTCTL_LOG_DIR "/data/misc/snapshotctl_log"
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +0900165#define LINKERCONFIG_DIR "/linkerconfig"
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700166
Narayan Kamath8f788292017-05-25 13:20:39 +0100167// TODO(narayan): Since this information has to be kept in sync
168// with tombstoned, we should just put it in a common header.
169//
170// File: system/core/debuggerd/tombstoned/tombstoned.cpp
Narayan Kamathbd863722017-06-01 18:50:12 +0100171static const std::string TOMBSTONE_DIR = "/data/tombstones/";
172static const std::string TOMBSTONE_FILE_PREFIX = "tombstone_";
173static const std::string ANR_DIR = "/data/anr/";
174static const std::string ANR_FILE_PREFIX = "anr_";
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700175
Felipe Lemee844a9d2016-09-21 15:01:39 -0700176// TODO: temporary variables and functions used during C++ refactoring
Nandana Dutt979388e2018-11-30 16:48:55 +0000177
Nandana Dutt5c390032019-03-12 10:52:56 +0000178#define RETURN_IF_USER_DENIED_CONSENT() \
179 if (ds.IsUserConsentDenied()) { \
180 MYLOGE("Returning early as user denied consent to share bugreport with calling app."); \
181 return Dumpstate::RunStatus::USER_CONSENT_DENIED; \
182 }
183
184// Runs func_ptr, but checks user consent before and after running it. Returns USER_CONSENT_DENIED
185// if consent is found to be denied.
186#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(func_ptr, ...) \
187 RETURN_IF_USER_DENIED_CONSENT(); \
188 func_ptr(__VA_ARGS__); \
189 RETURN_IF_USER_DENIED_CONSENT();
190
Sahana Raof35ed432019-07-12 10:47:52 +0100191static const char* WAKE_LOCK_NAME = "dumpstate_wakelock";
192
Nandana Dutt979388e2018-11-30 16:48:55 +0000193namespace android {
194namespace os {
195namespace {
196
197static int Open(std::string path, int flags, mode_t mode = 0) {
198 int fd = TEMP_FAILURE_RETRY(open(path.c_str(), flags, mode));
199 if (fd == -1) {
200 MYLOGE("open(%s, %s)\n", path.c_str(), strerror(errno));
201 }
202 return fd;
203}
204
Nandana Dutt979388e2018-11-30 16:48:55 +0000205
206static int OpenForRead(std::string path) {
207 return Open(path, O_RDONLY | O_CLOEXEC | O_NOFOLLOW);
208}
209
210bool CopyFile(int in_fd, int out_fd) {
211 char buf[4096];
212 ssize_t byte_count;
213 while ((byte_count = TEMP_FAILURE_RETRY(read(in_fd, buf, sizeof(buf)))) > 0) {
214 if (!android::base::WriteFully(out_fd, buf, byte_count)) {
215 return false;
216 }
217 }
218 return (byte_count != -1);
219}
220
221static bool CopyFileToFd(const std::string& input_file, int out_fd) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000222 MYLOGD("Going to copy file (%s) to %d\n", input_file.c_str(), out_fd);
Nandana Dutt979388e2018-11-30 16:48:55 +0000223
224 // Obtain a handle to the source file.
225 android::base::unique_fd in_fd(OpenForRead(input_file));
226 if (out_fd != -1 && in_fd.get() != -1) {
227 if (CopyFile(in_fd.get(), out_fd)) {
228 return true;
229 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000230 MYLOGE("Failed to copy file: %s\n", strerror(errno));
Nandana Dutt979388e2018-11-30 16:48:55 +0000231 }
232 return false;
233}
234
Nandana Duttd2f5f082019-01-18 17:13:52 +0000235static bool UnlinkAndLogOnError(const std::string& file) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000236 if (unlink(file.c_str())) {
237 MYLOGE("Failed to unlink file (%s): %s\n", file.c_str(), strerror(errno));
Nandana Duttd2f5f082019-01-18 17:13:52 +0000238 return false;
239 }
240 return true;
241}
Nandana Dutt979388e2018-11-30 16:48:55 +0000242
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +0000243static bool IsFileEmpty(const std::string& file_path) {
244 std::ifstream file(file_path, std::ios::binary | std::ios::ate);
245 if(file.bad()) {
246 MYLOGE("Cannot open file: %s\n", file_path.c_str());
247 return true;
248 }
249 return file.tellg() <= 0;
250}
251
Nikita Ioffea325a572019-05-16 19:49:47 +0100252int64_t GetModuleMetadataVersion() {
253 auto binder = defaultServiceManager()->getService(android::String16("package_native"));
254 if (binder == nullptr) {
255 MYLOGE("Failed to retrieve package_native service");
256 return 0L;
257 }
258 auto package_service = android::interface_cast<content::pm::IPackageManagerNative>(binder);
259 std::string package_name;
260 auto status = package_service->getModuleMetadataPackageName(&package_name);
261 if (!status.isOk()) {
262 MYLOGE("Failed to retrieve module metadata package name: %s", status.toString8().c_str());
263 return 0L;
264 }
Nandana Duttdb379fa2019-10-09 16:54:41 +0100265 MYLOGD("Module metadata package name: %s\n", package_name.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100266 int64_t version_code;
267 status = package_service->getVersionCodeForPackage(android::String16(package_name.c_str()),
268 &version_code);
269 if (!status.isOk()) {
270 MYLOGE("Failed to retrieve module metadata version: %s", status.toString8().c_str());
271 return 0L;
272 }
273 return version_code;
274}
275
Nandana Dutt979388e2018-11-30 16:48:55 +0000276} // namespace
277} // namespace os
278} // namespace android
279
Felipe Leme678727a2016-09-21 17:22:11 -0700280static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
Felipe Lemebda15a02016-11-16 17:48:25 -0800281 const CommandOptions& options = Dumpstate::DEFAULT_DUMPSYS,
Vishnu Nair6921f802017-11-22 09:17:23 -0800282 long dumpsysTimeoutMs = 0) {
283 return ds.RunDumpsys(title, dumpsysArgs, options, dumpsysTimeoutMs);
Felipe Leme678727a2016-09-21 17:22:11 -0700284}
285static int DumpFile(const std::string& title, const std::string& path) {
286 return ds.DumpFile(title, path);
287}
Felipe Lemee82a27d2016-01-05 13:35:44 -0800288
Felipe Lemee844a9d2016-09-21 15:01:39 -0700289// Relative directory (inside the zip) for all files copied as-is into the bugreport.
290static const std::string ZIP_ROOT_DIR = "FS";
291
Vishnu Naire97d6122018-01-18 13:58:56 -0800292static const std::string kProtoPath = "proto/";
293static const std::string kProtoExt = ".proto";
Jie Song9fbfad02017-06-20 16:29:42 -0700294static const std::string kDumpstateBoardFiles[] = {
295 "dumpstate_board.txt",
Felipe Leme95d6ca52017-08-01 16:35:56 -0700296 "dumpstate_board.bin"
Jie Song9fbfad02017-06-20 16:29:42 -0700297};
298static const int NUM_OF_DUMPS = arraysize(kDumpstateBoardFiles);
299
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700300static constexpr char PROPERTY_EXTRA_OPTIONS[] = "dumpstate.options";
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700301static constexpr char PROPERTY_LAST_ID[] = "dumpstate.last_id";
Felipe Lemed071c682016-10-20 16:48:00 -0700302static constexpr char PROPERTY_VERSION[] = "dumpstate.version";
Naveen Kallab53a1c92017-03-16 18:17:25 -0700303static constexpr char PROPERTY_EXTRA_TITLE[] = "dumpstate.options.title";
304static constexpr char PROPERTY_EXTRA_DESCRIPTION[] = "dumpstate.options.description";
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700305
Felipe Lemef0292972016-11-22 13:57:05 -0800306static const CommandOptions AS_ROOT_20 = CommandOptions::WithTimeout(20).AsRoot().Build();
307
Narayan Kamath8f788292017-05-25 13:20:39 +0100308/*
Narayan Kamathbd863722017-06-01 18:50:12 +0100309 * Returns a vector of dump fds under |dir_path| with a given |file_prefix|.
310 * The returned vector is sorted by the mtimes of the dumps. If |limit_by_mtime|
311 * is set, the vector only contains files that were written in the last 30 minutes.
Narayan Kamath8f788292017-05-25 13:20:39 +0100312 */
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700313static std::vector<DumpData> GetDumpFds(const std::string& dir_path,
314 const std::string& file_prefix,
Elliott Hughesdb6d2112019-09-26 15:24:51 -0700315 bool limit_by_mtime) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100316 const time_t thirty_minutes_ago = ds.now_ - 60 * 30;
317
Narayan Kamathbd863722017-06-01 18:50:12 +0100318 std::unique_ptr<DIR, decltype(&closedir)> dump_dir(opendir(dir_path.c_str()), closedir);
Narayan Kamath8f788292017-05-25 13:20:39 +0100319
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700320 if (dump_dir == nullptr) {
321 MYLOGW("Unable to open directory %s: %s\n", dir_path.c_str(), strerror(errno));
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700322 return std::vector<DumpData>();
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700323 }
324
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700325 std::vector<DumpData> dump_data;
Narayan Kamathbd863722017-06-01 18:50:12 +0100326 struct dirent* entry = nullptr;
327 while ((entry = readdir(dump_dir.get()))) {
328 if (entry->d_type != DT_REG) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100329 continue;
330 }
331
Narayan Kamathbd863722017-06-01 18:50:12 +0100332 const std::string base_name(entry->d_name);
333 if (base_name.find(file_prefix) != 0) {
334 continue;
335 }
336
337 const std::string abs_path = dir_path + base_name;
338 android::base::unique_fd fd(
339 TEMP_FAILURE_RETRY(open(abs_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW | O_NONBLOCK)));
340 if (fd == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700341 MYLOGW("Unable to open dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamathbd863722017-06-01 18:50:12 +0100342 break;
343 }
344
345 struct stat st = {};
346 if (fstat(fd, &st) == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700347 MYLOGW("Unable to stat dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamath8f788292017-05-25 13:20:39 +0100348 continue;
349 }
350
Narayan Kamath3f31b632018-02-22 19:42:36 +0000351 if (limit_by_mtime && st.st_mtime < thirty_minutes_ago) {
Narayan Kamathbd863722017-06-01 18:50:12 +0100352 MYLOGI("Excluding stale dump file: %s\n", abs_path.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100353 continue;
354 }
355
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700356 dump_data.emplace_back(DumpData{abs_path, std::move(fd), st.st_mtime});
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700357 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100358
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700359 return dump_data;
Narayan Kamath8f788292017-05-25 13:20:39 +0100360}
361
Narayan Kamathbd863722017-06-01 18:50:12 +0100362static bool AddDumps(const std::vector<DumpData>::const_iterator start,
363 const std::vector<DumpData>::const_iterator end,
364 const char* type_name, const bool add_to_zip) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100365 bool dumped = false;
Narayan Kamathbd863722017-06-01 18:50:12 +0100366 for (auto it = start; it != end; ++it) {
367 const std::string& name = it->name;
368 const int fd = it->fd;
Narayan Kamath8f788292017-05-25 13:20:39 +0100369 dumped = true;
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100370
371 // Seek to the beginning of the file before dumping any data. A given
372 // DumpData entry might be dumped multiple times in the report.
373 //
374 // For example, the most recent ANR entry is dumped to the body of the
375 // main entry and it also shows up as a separate entry in the bugreport
376 // ZIP file.
377 if (lseek(fd, 0, SEEK_SET) != static_cast<off_t>(0)) {
378 MYLOGE("Unable to add %s to zip file, lseek failed: %s\n", name.c_str(),
379 strerror(errno));
380 }
381
Narayan Kamath8f788292017-05-25 13:20:39 +0100382 if (ds.IsZipping() && add_to_zip) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800383 if (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + name, fd, /* timeout = */ 0ms) != OK) {
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100384 MYLOGE("Unable to add %s to zip file, addZipEntryFromFd failed\n", name.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100385 }
386 } else {
387 dump_file_from_fd(type_name, name.c_str(), fd);
388 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100389 }
390
391 return dumped;
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700392}
393
Felipe Leme635ca312016-01-05 14:23:02 -0800394// for_each_pid() callback to get mount info about a process.
Felipe Leme4c2d6632016-09-28 14:32:00 -0700395void do_mountinfo(int pid, const char* name __attribute__((unused))) {
Felipe Leme635ca312016-01-05 14:23:02 -0800396 char path[PATH_MAX];
397
398 // Gets the the content of the /proc/PID/ns/mnt link, so only unique mount points
399 // are added.
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700400 snprintf(path, sizeof(path), "/proc/%d/ns/mnt", pid);
Felipe Leme635ca312016-01-05 14:23:02 -0800401 char linkname[PATH_MAX];
402 ssize_t r = readlink(path, linkname, PATH_MAX);
403 if (r == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800404 MYLOGE("Unable to read link for %s: %s\n", path, strerror(errno));
Felipe Leme635ca312016-01-05 14:23:02 -0800405 return;
406 }
407 linkname[r] = '\0';
408
409 if (mount_points.find(linkname) == mount_points.end()) {
410 // First time this mount point was found: add it
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700411 snprintf(path, sizeof(path), "/proc/%d/mountinfo", pid);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700412 if (ds.AddZipEntry(ZIP_ROOT_DIR + path, path)) {
Felipe Leme635ca312016-01-05 14:23:02 -0800413 mount_points.insert(linkname);
414 } else {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800415 MYLOGE("Unable to add mountinfo %s to zip file\n", path);
Felipe Leme635ca312016-01-05 14:23:02 -0800416 }
417 }
418}
419
420void add_mountinfo() {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700421 if (!ds.IsZipping()) return;
Felipe Leme678727a2016-09-21 17:22:11 -0700422 std::string title = "MOUNT INFO";
Felipe Leme635ca312016-01-05 14:23:02 -0800423 mount_points.clear();
Felipe Leme46b85da2016-11-21 17:40:45 -0800424 DurationReporter duration_reporter(title, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700425 for_each_pid(do_mountinfo, nullptr);
426 MYLOGD("%s: %d entries added to zip file\n", title.c_str(), (int)mount_points.size());
Felipe Leme635ca312016-01-05 14:23:02 -0800427}
428
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700429static void dump_dev_files(const char *title, const char *driverpath, const char *filename)
430{
431 DIR *d;
432 struct dirent *de;
433 char path[PATH_MAX];
434
435 d = opendir(driverpath);
Yi Kong19d5c002018-07-20 13:39:55 -0700436 if (d == nullptr) {
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700437 return;
438 }
439
440 while ((de = readdir(d))) {
441 if (de->d_type != DT_LNK) {
442 continue;
443 }
444 snprintf(path, sizeof(path), "%s/%s/%s", driverpath, de->d_name, filename);
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700445 DumpFile(title, path);
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700446 }
447
448 closedir(d);
449}
450
Mark Salyzyn326842f2015-04-30 09:49:41 -0700451static bool skip_not_stat(const char *path) {
452 static const char stat[] = "/stat";
453 size_t len = strlen(path);
454 if (path[len - 1] == '/') { /* Directory? */
455 return false;
456 }
457 return strcmp(path + len - sizeof(stat) + 1, stat); /* .../stat? */
458}
459
Felipe Leme4c2d6632016-09-28 14:32:00 -0700460static bool skip_none(const char* path __attribute__((unused))) {
Felipe Lemee82a27d2016-01-05 13:35:44 -0800461 return false;
462}
463
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700464unsigned long worst_write_perf = 20000; /* in KB/s */
Mark Salyzyn326842f2015-04-30 09:49:41 -0700465
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800466//
467// stat offsets
468// Name units description
469// ---- ----- -----------
470// read I/Os requests number of read I/Os processed
471#define __STAT_READ_IOS 0
472// read merges requests number of read I/Os merged with in-queue I/O
473#define __STAT_READ_MERGES 1
474// read sectors sectors number of sectors read
475#define __STAT_READ_SECTORS 2
476// read ticks milliseconds total wait time for read requests
477#define __STAT_READ_TICKS 3
478// write I/Os requests number of write I/Os processed
479#define __STAT_WRITE_IOS 4
480// write merges requests number of write I/Os merged with in-queue I/O
481#define __STAT_WRITE_MERGES 5
482// write sectors sectors number of sectors written
483#define __STAT_WRITE_SECTORS 6
484// write ticks milliseconds total wait time for write requests
485#define __STAT_WRITE_TICKS 7
486// in_flight requests number of I/Os currently in flight
487#define __STAT_IN_FLIGHT 8
488// io_ticks milliseconds total time this block device has been active
489#define __STAT_IO_TICKS 9
490// time_in_queue milliseconds total wait time for all requests
491#define __STAT_IN_QUEUE 10
492#define __STAT_NUMBER_FIELD 11
493//
494// read I/Os, write I/Os
495// =====================
496//
497// These values increment when an I/O request completes.
498//
499// read merges, write merges
500// =========================
501//
502// These values increment when an I/O request is merged with an
503// already-queued I/O request.
504//
505// read sectors, write sectors
506// ===========================
507//
508// These values count the number of sectors read from or written to this
509// block device. The "sectors" in question are the standard UNIX 512-byte
510// sectors, not any device- or filesystem-specific block size. The
511// counters are incremented when the I/O completes.
512#define SECTOR_SIZE 512
513//
514// read ticks, write ticks
515// =======================
516//
517// These values count the number of milliseconds that I/O requests have
518// waited on this block device. If there are multiple I/O requests waiting,
519// these values will increase at a rate greater than 1000/second; for
520// example, if 60 read requests wait for an average of 30 ms, the read_ticks
521// field will increase by 60*30 = 1800.
522//
523// in_flight
524// =========
525//
526// This value counts the number of I/O requests that have been issued to
527// the device driver but have not yet completed. It does not include I/O
528// requests that are in the queue but not yet issued to the device driver.
529//
530// io_ticks
531// ========
532//
533// This value counts the number of milliseconds during which the device has
534// had I/O requests queued.
535//
536// time_in_queue
537// =============
538//
539// This value counts the number of milliseconds that I/O requests have waited
540// on this block device. If there are multiple I/O requests waiting, this
541// value will increase as the product of the number of milliseconds times the
542// number of requests waiting (see "read ticks" above for an example).
543#define S_TO_MS 1000
544//
545
Mark Salyzyn326842f2015-04-30 09:49:41 -0700546static int dump_stat_from_fd(const char *title __unused, const char *path, int fd) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800547 unsigned long long fields[__STAT_NUMBER_FIELD];
Mark Salyzyn326842f2015-04-30 09:49:41 -0700548 bool z;
Yi Kong19d5c002018-07-20 13:39:55 -0700549 char *cp, *buffer = nullptr;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700550 size_t i = 0;
Josh Gao7c4258c2018-06-25 13:40:08 -0700551 FILE *fp = fdopen(dup(fd), "rb");
Mark Salyzyn326842f2015-04-30 09:49:41 -0700552 getline(&buffer, &i, fp);
553 fclose(fp);
554 if (!buffer) {
555 return -errno;
556 }
557 i = strlen(buffer);
558 while ((i > 0) && (buffer[i - 1] == '\n')) {
559 buffer[--i] = '\0';
560 }
561 if (!*buffer) {
562 free(buffer);
563 return 0;
564 }
565 z = true;
566 for (cp = buffer, i = 0; i < (sizeof(fields) / sizeof(fields[0])); ++i) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800567 fields[i] = strtoull(cp, &cp, 10);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700568 if (fields[i] != 0) {
569 z = false;
570 }
571 }
572 if (z) { /* never accessed */
573 free(buffer);
574 return 0;
575 }
576
Wei Wang509bb5d2017-06-09 14:42:12 -0700577 if (!strncmp(path, BLK_DEV_SYS_DIR, sizeof(BLK_DEV_SYS_DIR) - 1)) {
578 path += sizeof(BLK_DEV_SYS_DIR) - 1;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700579 }
Wei Wang1dc1ef52017-06-12 11:28:37 -0700580
581 printf("%-30s:%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s\n%-30s:\t%s\n", "Block-Dev",
582 "R-IOs", "R-merg", "R-sect", "R-wait", "W-IOs", "W-merg", "W-sect",
583 "W-wait", "in-fli", "activ", "T-wait", path, buffer);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700584 free(buffer);
585
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800586 if (fields[__STAT_IO_TICKS]) {
587 unsigned long read_perf = 0;
588 unsigned long read_ios = 0;
589 if (fields[__STAT_READ_TICKS]) {
590 unsigned long long divisor = fields[__STAT_READ_TICKS]
591 * fields[__STAT_IO_TICKS];
592 read_perf = ((unsigned long long)SECTOR_SIZE
593 * fields[__STAT_READ_SECTORS]
594 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
595 / divisor;
596 read_ios = ((unsigned long long)S_TO_MS * fields[__STAT_READ_IOS]
597 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
598 / divisor;
599 }
600
601 unsigned long write_perf = 0;
602 unsigned long write_ios = 0;
603 if (fields[__STAT_WRITE_TICKS]) {
604 unsigned long long divisor = fields[__STAT_WRITE_TICKS]
605 * fields[__STAT_IO_TICKS];
606 write_perf = ((unsigned long long)SECTOR_SIZE
607 * fields[__STAT_WRITE_SECTORS]
608 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
609 / divisor;
610 write_ios = ((unsigned long long)S_TO_MS * fields[__STAT_WRITE_IOS]
611 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
612 / divisor;
613 }
614
615 unsigned queue = (fields[__STAT_IN_QUEUE]
616 + (fields[__STAT_IO_TICKS] >> 1))
617 / fields[__STAT_IO_TICKS];
618
619 if (!write_perf && !write_ios) {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700620 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 -0800621 } else {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700622 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 -0800623 read_ios, write_perf, write_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800624 }
625
626 /* bugreport timeout factor adjustment */
627 if ((write_perf > 1) && (write_perf < worst_write_perf)) {
628 worst_write_perf = write_perf;
629 }
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700630 }
Mark Salyzyn326842f2015-04-30 09:49:41 -0700631 return 0;
632}
633
Yao Chenbe3bbc12018-01-17 16:31:10 -0800634static const long MINIMUM_LOGCAT_TIMEOUT_MS = 50000;
635
636/* timeout in ms to read a list of buffers */
637static unsigned long logcat_timeout(const std::vector<std::string>& buffers) {
638 unsigned long timeout_ms = 0;
639 for (const auto& buffer : buffers) {
640 log_id_t id = android_name_to_log_id(buffer.c_str());
641 unsigned long property_size = __android_logger_get_buffer_size(id);
642 /* Engineering margin is ten-fold our guess */
643 timeout_ms += 10 * (property_size + worst_write_perf) / worst_write_perf;
644 }
645 return timeout_ms > MINIMUM_LOGCAT_TIMEOUT_MS ? timeout_ms : MINIMUM_LOGCAT_TIMEOUT_MS;
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700646}
647
Nandana Duttd2f5f082019-01-18 17:13:52 +0000648Dumpstate::ConsentCallback::ConsentCallback() : result_(UNAVAILABLE), start_time_(Nanotime()) {
649}
650
651android::binder::Status Dumpstate::ConsentCallback::onReportApproved() {
652 std::lock_guard<std::mutex> lock(lock_);
653 result_ = APPROVED;
654 MYLOGD("User approved consent to share bugreport\n");
655 return android::binder::Status::ok();
656}
657
658android::binder::Status Dumpstate::ConsentCallback::onReportDenied() {
659 std::lock_guard<std::mutex> lock(lock_);
660 result_ = DENIED;
661 MYLOGW("User denied consent to share bugreport\n");
662 return android::binder::Status::ok();
663}
664
665UserConsentResult Dumpstate::ConsentCallback::getResult() {
666 std::lock_guard<std::mutex> lock(lock_);
667 return result_;
668}
669
670uint64_t Dumpstate::ConsentCallback::getElapsedTimeMs() const {
Hunter Knepshieldf0a39052020-01-03 14:53:04 -0800671 return (Nanotime() - start_time_) / NANOS_PER_MILLI;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000672}
673
Felipe Leme2b9b06c2016-10-14 09:13:06 -0700674void Dumpstate::PrintHeader() const {
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700675 std::string build, fingerprint, radio, bootloader, network;
676 char date[80];
Colin Crossf45fa6b2012-03-26 12:38:26 -0700677
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700678 build = android::base::GetProperty("ro.build.display.id", "(unknown)");
679 fingerprint = android::base::GetProperty("ro.build.fingerprint", "(unknown)");
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700680 radio = android::base::GetProperty("gsm.version.baseband", "(unknown)");
681 bootloader = android::base::GetProperty("ro.bootloader", "(unknown)");
682 network = android::base::GetProperty("gsm.operator.alpha", "(unknown)");
Felipe Lemebbaf3c12016-10-11 14:32:25 -0700683 strftime(date, sizeof(date), "%Y-%m-%d %H:%M:%S", localtime(&now_));
Colin Crossf45fa6b2012-03-26 12:38:26 -0700684
Felipe Lemed8b94e52016-12-08 10:21:44 -0800685 printf("========================================================\n");
686 printf("== dumpstate: %s\n", date);
687 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -0700688
Felipe Lemed8b94e52016-12-08 10:21:44 -0800689 printf("\n");
690 printf("Build: %s\n", build.c_str());
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700691 // NOTE: fingerprint entry format is important for other tools.
Felipe Lemed8b94e52016-12-08 10:21:44 -0800692 printf("Build fingerprint: '%s'\n", fingerprint.c_str());
693 printf("Bootloader: %s\n", bootloader.c_str());
694 printf("Radio: %s\n", radio.c_str());
695 printf("Network: %s\n", network.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100696 int64_t module_metadata_version = android::os::GetModuleMetadataVersion();
697 if (module_metadata_version != 0) {
698 printf("Module Metadata version: %" PRId64 "\n", module_metadata_version);
699 }
Colin Crossf45fa6b2012-03-26 12:38:26 -0700700
Felipe Lemed8b94e52016-12-08 10:21:44 -0800701 printf("Kernel: ");
Felipe Lemef0292972016-11-22 13:57:05 -0800702 DumpFileToFd(STDOUT_FILENO, "", "/proc/version");
Felipe Lemed8b94e52016-12-08 10:21:44 -0800703 printf("Command line: %s\n", strtok(cmdline_buf, "\n"));
Felipe Leme7709f8a2017-12-05 09:30:09 -0800704 printf("Uptime: ");
705 RunCommandToFd(STDOUT_FILENO, "", {"uptime", "-p"},
706 CommandOptions::WithTimeout(1).Always().Build());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800707 printf("Bugreport format version: %s\n", version_.c_str());
708 printf("Dumpstate info: id=%d pid=%d dry_run=%d args=%s extra_options=%s\n", id_, pid_,
Nandana Dutt5fb117b2018-09-27 09:23:36 +0100709 PropertiesHelper::IsDryRun(), options_->args.c_str(), options_->extra_options.c_str());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800710 printf("\n");
Felipe Leme78f2c862015-12-21 09:55:22 -0800711}
712
Felipe Leme24b66ee2016-06-16 10:55:26 -0700713// List of file extensions that can cause a zip file attachment to be rejected by some email
714// service providers.
715static const std::set<std::string> PROBLEMATIC_FILE_EXTENSIONS = {
716 ".ade", ".adp", ".bat", ".chm", ".cmd", ".com", ".cpl", ".exe", ".hta", ".ins", ".isp",
717 ".jar", ".jse", ".lib", ".lnk", ".mde", ".msc", ".msp", ".mst", ".pif", ".scr", ".sct",
718 ".shb", ".sys", ".vb", ".vbe", ".vbs", ".vxd", ".wsc", ".wsf", ".wsh"
719};
720
Vishnu Naire97d6122018-01-18 13:58:56 -0800721status_t Dumpstate::AddZipEntryFromFd(const std::string& entry_name, int fd,
722 std::chrono::milliseconds timeout = 0ms) {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700723 if (!IsZipping()) {
724 MYLOGD("Not adding zip entry %s from fd because it's not a zipped bugreport\n",
725 entry_name.c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -0800726 return INVALID_OPERATION;
Felipe Leme111b9d02016-02-03 09:28:24 -0800727 }
Felipe Leme24b66ee2016-06-16 10:55:26 -0700728 std::string valid_name = entry_name;
729
730 // Rename extension if necessary.
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -0700731 size_t idx = entry_name.rfind('.');
Felipe Leme24b66ee2016-06-16 10:55:26 -0700732 if (idx != std::string::npos) {
733 std::string extension = entry_name.substr(idx);
734 std::transform(extension.begin(), extension.end(), extension.begin(), ::tolower);
735 if (PROBLEMATIC_FILE_EXTENSIONS.count(extension) != 0) {
736 valid_name = entry_name + ".renamed";
737 MYLOGI("Renaming entry %s to %s\n", entry_name.c_str(), valid_name.c_str());
738 }
739 }
740
Felipe Leme6fe9db62016-02-12 09:04:16 -0800741 // Logging statement below is useful to time how long each entry takes, but it's too verbose.
742 // MYLOGD("Adding zip entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700743 int32_t err = zip_writer_->StartEntryWithTime(valid_name.c_str(), ZipWriter::kCompress,
744 get_mtime(fd, ds.now_));
Felipe Leme1d486fe2016-10-14 18:06:47 -0700745 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700746 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", valid_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700747 ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800748 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800749 }
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000750 bool finished_entry = false;
751 auto finish_entry = [this, &finished_entry] {
752 if (!finished_entry) {
753 // This should only be called when we're going to return an earlier error,
754 // which would've been logged. This may imply the file is already corrupt
755 // and any further logging from FinishEntry is more likely to mislead than
756 // not.
757 this->zip_writer_->FinishEntry();
758 }
759 };
760 auto scope_guard = android::base::make_scope_guard(finish_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -0800761 auto start = std::chrono::steady_clock::now();
762 auto end = start + timeout;
763 struct pollfd pfd = {fd, POLLIN};
Felipe Lemee82a27d2016-01-05 13:35:44 -0800764
Felipe Leme770410d2016-01-26 17:07:14 -0800765 std::vector<uint8_t> buffer(65536);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800766 while (1) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800767 if (timeout.count() > 0) {
768 // lambda to recalculate the timeout.
769 auto time_left_ms = [end]() {
770 auto now = std::chrono::steady_clock::now();
771 auto diff = std::chrono::duration_cast<std::chrono::milliseconds>(end - now);
772 return std::max(diff.count(), 0LL);
773 };
774
775 int rc = TEMP_FAILURE_RETRY(poll(&pfd, 1, time_left_ms()));
776 if (rc < 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000777 MYLOGE("Error in poll while adding from fd to zip entry %s:%s\n",
778 entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800779 return -errno;
780 } else if (rc == 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000781 MYLOGE("Timed out adding from fd to zip entry %s:%s Timeout:%lldms\n",
Vishnu Naire97d6122018-01-18 13:58:56 -0800782 entry_name.c_str(), strerror(errno), timeout.count());
783 return TIMED_OUT;
784 }
785 }
786
Zach Riggle22200402016-08-18 01:01:24 -0400787 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800788 if (bytes_read == 0) {
789 break;
790 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800791 MYLOGE("read(%s): %s\n", entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800792 return -errno;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800793 }
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700794 err = zip_writer_->WriteBytes(buffer.data(), bytes_read);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800795 if (err) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700796 MYLOGE("zip_writer_->WriteBytes(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800797 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800798 }
799 }
800
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700801 err = zip_writer_->FinishEntry();
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000802 finished_entry = true;
Felipe Leme1d486fe2016-10-14 18:06:47 -0700803 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700804 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800805 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800806 }
807
Vishnu Naire97d6122018-01-18 13:58:56 -0800808 return OK;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800809}
810
Felipe Leme1d486fe2016-10-14 18:06:47 -0700811bool Dumpstate::AddZipEntry(const std::string& entry_name, const std::string& entry_path) {
812 android::base::unique_fd fd(
813 TEMP_FAILURE_RETRY(open(entry_path.c_str(), O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
Andreas Gampeaff68432016-07-18 18:01:27 -0700814 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800815 MYLOGE("open(%s): %s\n", entry_path.c_str(), strerror(errno));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800816 return false;
817 }
818
Vishnu Naire97d6122018-01-18 13:58:56 -0800819 return (AddZipEntryFromFd(entry_name, fd.get()) == OK);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800820}
821
822/* adds a file to the existing zipped bugreport */
Felipe Leme4c2d6632016-09-28 14:32:00 -0700823static int _add_file_from_fd(const char* title __attribute__((unused)), const char* path, int fd) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800824 return (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + path, fd) == OK) ? 0 : 1;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800825}
826
Felipe Leme1d486fe2016-10-14 18:06:47 -0700827void Dumpstate::AddDir(const std::string& dir, bool recursive) {
828 if (!IsZipping()) {
829 MYLOGD("Not adding dir %s because it's not a zipped bugreport\n", dir.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800830 return;
831 }
Felipe Leme678727a2016-09-21 17:22:11 -0700832 MYLOGD("Adding dir %s (recursive: %d)\n", dir.c_str(), recursive);
Felipe Leme46b85da2016-11-21 17:40:45 -0800833 DurationReporter duration_reporter(dir, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700834 dump_files("", dir.c_str(), recursive ? skip_none : is_dir, _add_file_from_fd);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800835}
836
Felipe Leme1d486fe2016-10-14 18:06:47 -0700837bool Dumpstate::AddTextZipEntry(const std::string& entry_name, const std::string& content) {
838 if (!IsZipping()) {
839 MYLOGD("Not adding text zip entry %s because it's not a zipped bugreport\n",
840 entry_name.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800841 return false;
842 }
Felipe Lemecbce55d2016-02-08 09:53:18 -0800843 MYLOGD("Adding zip text entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700844 int32_t err = zip_writer_->StartEntryWithTime(entry_name.c_str(), ZipWriter::kCompress, ds.now_);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700845 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700846 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700847 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800848 return false;
849 }
850
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700851 err = zip_writer_->WriteBytes(content.c_str(), content.length());
Felipe Leme1d486fe2016-10-14 18:06:47 -0700852 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700853 MYLOGE("zip_writer_->WriteBytes(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700854 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800855 return false;
856 }
857
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700858 err = zip_writer_->FinishEntry();
Felipe Leme1d486fe2016-10-14 18:06:47 -0700859 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700860 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800861 return false;
862 }
863
864 return true;
865}
866
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800867static void DoKmsg() {
868 struct stat st;
869 if (!stat(PSTORE_LAST_KMSG, &st)) {
870 /* Also TODO: Make console-ramoops CAP_SYSLOG protected. */
871 DumpFile("LAST KMSG", PSTORE_LAST_KMSG);
872 } else if (!stat(ALT_PSTORE_LAST_KMSG, &st)) {
873 DumpFile("LAST KMSG", ALT_PSTORE_LAST_KMSG);
874 } else {
875 /* TODO: Make last_kmsg CAP_SYSLOG protected. b/5555691 */
876 DumpFile("LAST KMSG", "/proc/last_kmsg");
877 }
878}
879
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800880static void DoKernelLogcat() {
Yao Chenbe3bbc12018-01-17 16:31:10 -0800881 unsigned long timeout_ms = logcat_timeout({"kernel"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800882 RunCommand(
883 "KERNEL LOG",
884 {"logcat", "-b", "kernel", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
885 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
886}
887
Nandana Duttdb379fa2019-10-09 16:54:41 +0100888static void DoSystemLogcat(time_t since) {
889 char since_str[80];
890 strftime(since_str, sizeof(since_str), "%Y-%m-%d %H:%M:%S.000", localtime(&since));
891
892 unsigned long timeout_ms = logcat_timeout({"main", "system", "crash"});
893 RunCommand("SYSTEM LOG",
894 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v", "-T",
895 since_str},
896 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
897}
898
Hunter Knepshield820f9bc2020-02-05 20:10:53 -0800899static void DoRadioLogcat() {
900 unsigned long timeout_ms = logcat_timeout({"radio"});
901 RunCommand(
902 "RADIO LOG",
903 {"logcat", "-b", "radio", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
904 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
905}
906
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800907static void DoLogcat() {
Vishnu Nair6921f802017-11-22 09:17:23 -0800908 unsigned long timeout_ms;
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800909 // DumpFile("EVENT LOG TAGS", "/etc/event-log-tags");
910 // calculate timeout
Yao Chenbe3bbc12018-01-17 16:31:10 -0800911 timeout_ms = logcat_timeout({"main", "system", "crash"});
Tony Makae737652017-03-30 17:47:09 +0100912 RunCommand("SYSTEM LOG",
Vishnu Nair6921f802017-11-22 09:17:23 -0800913 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
914 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -0800915 timeout_ms = logcat_timeout({"events"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800916 RunCommand(
917 "EVENT LOG",
918 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +0100919 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Yao Chenbe3bbc12018-01-17 16:31:10 -0800920 timeout_ms = logcat_timeout({"stats"});
921 RunCommand(
922 "STATS LOG",
923 {"logcat", "-b", "stats", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +0100924 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Hunter Knepshield820f9bc2020-02-05 20:10:53 -0800925 DoRadioLogcat();
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800926
927 RunCommand("LOG STATISTICS", {"logcat", "-b", "all", "-S"});
928
929 /* kernels must set CONFIG_PSTORE_PMSG, slice up pstore with device tree */
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800930 RunCommand("LAST LOGCAT", {"logcat", "-L", "-b", "all", "-v", "threadtime", "-v", "printable",
931 "-v", "uid", "-d", "*:v"});
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800932}
933
Mike Ma5c267872019-08-21 11:31:34 -0700934static void DumpIncidentReport() {
935 if (!ds.IsZipping()) {
936 MYLOGD("Not dumping incident report because it's not a zipped bugreport\n");
937 return;
938 }
939 DurationReporter duration_reporter("INCIDENT REPORT");
940 const std::string path = ds.bugreport_internal_dir_ + "/tmp_incident_report";
941 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
942 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
943 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
944 if (fd < 0) {
945 MYLOGE("Could not open %s to dump incident report.\n", path.c_str());
946 return;
947 }
948 RunCommandToFd(fd, "", {"incident", "-u"}, CommandOptions::WithTimeout(120).Build());
949 bool empty = 0 == lseek(fd, 0, SEEK_END);
950 if (!empty) {
951 // Use a different name from "incident.proto"
952 // /proto/incident.proto is reserved for incident service dump
953 // i.e. metadata for debugging.
954 ds.AddZipEntry(kProtoPath + "incident_report" + kProtoExt, path);
955 }
956 unlink(path.c_str());
957}
958
Jayachandran Ca94c7172017-06-10 15:08:12 -0700959static void DumpIpTablesAsRoot() {
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700960 RunCommand("IPTABLES", {"iptables", "-L", "-nvx"});
961 RunCommand("IP6TABLES", {"ip6tables", "-L", "-nvx"});
Erik Kline32af8c22016-09-28 17:26:26 +0900962 RunCommand("IPTABLES NAT", {"iptables", "-t", "nat", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -0700963 /* no ip6 nat */
Erik Kline32af8c22016-09-28 17:26:26 +0900964 RunCommand("IPTABLES MANGLE", {"iptables", "-t", "mangle", "-L", "-nvx"});
965 RunCommand("IP6TABLES MANGLE", {"ip6tables", "-t", "mangle", "-L", "-nvx"});
966 RunCommand("IPTABLES RAW", {"iptables", "-t", "raw", "-L", "-nvx"});
967 RunCommand("IP6TABLES RAW", {"ip6tables", "-t", "raw", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -0700968}
969
David Andersond9ba4752018-12-11 18:26:59 -0800970static void DumpDynamicPartitionInfo() {
971 if (!::android::base::GetBoolProperty("ro.boot.dynamic_partitions", false)) {
972 return;
973 }
974
975 RunCommand("LPDUMP", {"lpdump", "--all"});
David Anderson6650ade2019-10-02 15:18:59 -0700976 RunCommand("DEVICE-MAPPER", {"gsid", "dump-device-mapper"});
David Andersond9ba4752018-12-11 18:26:59 -0800977}
978
Narayan Kamath8f788292017-05-25 13:20:39 +0100979static void AddAnrTraceDir(const bool add_to_zip, const std::string& anr_traces_dir) {
980 MYLOGD("AddAnrTraceDir(): dump_traces_file=%s, anr_traces_dir=%s\n", dump_traces_path,
981 anr_traces_dir.c_str());
982
983 // If we're here, dump_traces_path will always be a temporary file
984 // (created with mkostemp or similar) that contains dumps taken earlier
985 // on in the process.
986 if (dump_traces_path != nullptr) {
987 if (add_to_zip) {
988 ds.AddZipEntry(ZIP_ROOT_DIR + anr_traces_dir + "/traces-just-now.txt", dump_traces_path);
989 } else {
990 MYLOGD("Dumping current ANR traces (%s) to the main bugreport entry\n",
991 dump_traces_path);
992 ds.DumpFile("VM TRACES JUST NOW", dump_traces_path);
993 }
994
995 const int ret = unlink(dump_traces_path);
996 if (ret == -1) {
997 MYLOGW("Error unlinking temporary trace path %s: %s\n", dump_traces_path,
998 strerror(errno));
Felipe Lemee184f662016-10-27 10:04:47 -0700999 }
1000 }
1001
Narayan Kamathbd863722017-06-01 18:50:12 +01001002 // Add a specific message for the first ANR Dump.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001003 if (ds.anr_data_.size() > 0) {
1004 AddDumps(ds.anr_data_.begin(), ds.anr_data_.begin() + 1,
Narayan Kamathbd863722017-06-01 18:50:12 +01001005 "VM TRACES AT LAST ANR", add_to_zip);
1006
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001007 // The "last" ANR will always be included as separate entry in the zip file. In addition,
1008 // it will be present in the body of the main entry if |add_to_zip| == false.
1009 //
1010 // Historical ANRs are always included as separate entries in the bugreport zip file.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001011 AddDumps(ds.anr_data_.begin() + ((add_to_zip) ? 1 : 0), ds.anr_data_.end(),
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001012 "HISTORICAL ANR", true /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001013 } else {
Narayan Kamath8f788292017-05-25 13:20:39 +01001014 printf("*** NO ANRs to dump in %s\n\n", ANR_DIR.c_str());
1015 }
1016}
1017
1018static void AddAnrTraceFiles() {
1019 const bool add_to_zip = ds.IsZipping() && ds.version_ == VERSION_SPLIT_ANR;
1020
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001021 std::string anr_traces_dir = "/data/anr";
Narayan Kamath8f788292017-05-25 13:20:39 +01001022
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001023 AddAnrTraceDir(add_to_zip, anr_traces_dir);
Narayan Kamath8f788292017-05-25 13:20:39 +01001024
Makoto Onuki83ec63f2019-01-31 17:08:59 -08001025 RunCommand("ANR FILES", {"ls", "-lt", ANR_DIR});
1026
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001027 // Slow traces for slow operations.
Felipe Lemee184f662016-10-27 10:04:47 -07001028 struct stat st;
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001029 int i = 0;
1030 while (true) {
1031 const std::string slow_trace_path =
1032 anr_traces_dir + android::base::StringPrintf("slow%02d.txt", i);
1033 if (stat(slow_trace_path.c_str(), &st)) {
1034 // No traces file at this index, done with the files.
1035 break;
Felipe Lemee184f662016-10-27 10:04:47 -07001036 }
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001037 ds.DumpFile("VM TRACES WHEN SLOW", slow_trace_path.c_str());
1038 i++;
Felipe Lemee184f662016-10-27 10:04:47 -07001039 }
1040}
1041
Wei Wang509bb5d2017-06-09 14:42:12 -07001042static void DumpBlockStatFiles() {
1043 DurationReporter duration_reporter("DUMP BLOCK STAT");
Wei Wang509bb5d2017-06-09 14:42:12 -07001044
Wei Wang1dc1ef52017-06-12 11:28:37 -07001045 std::unique_ptr<DIR, std::function<int(DIR*)>> dirptr(opendir(BLK_DEV_SYS_DIR), closedir);
1046
1047 if (dirptr == nullptr) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001048 MYLOGE("Failed to open %s: %s\n", BLK_DEV_SYS_DIR, strerror(errno));
1049 return;
1050 }
1051
1052 printf("------ DUMP BLOCK STAT ------\n\n");
Wei Wang1dc1ef52017-06-12 11:28:37 -07001053 while (struct dirent *d = readdir(dirptr.get())) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001054 if ((d->d_name[0] == '.')
1055 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
1056 || (d->d_name[1] == '\0'))) {
1057 continue;
1058 }
1059 const std::string new_path =
1060 android::base::StringPrintf("%s/%s", BLK_DEV_SYS_DIR, d->d_name);
1061 printf("------ BLOCK STAT (%s) ------\n", new_path.c_str());
1062 dump_files("", new_path.c_str(), skip_not_stat, dump_stat_from_fd);
1063 printf("\n");
1064 }
Wei Wang1dc1ef52017-06-12 11:28:37 -07001065 return;
Wei Wang509bb5d2017-06-09 14:42:12 -07001066}
Jayachandran Ca94c7172017-06-10 15:08:12 -07001067
1068static void DumpPacketStats() {
1069 DumpFile("NETWORK DEV INFO", "/proc/net/dev");
1070 DumpFile("QTAGUID NETWORK INTERFACES INFO", "/proc/net/xt_qtaguid/iface_stat_all");
1071 DumpFile("QTAGUID NETWORK INTERFACES INFO (xt)", "/proc/net/xt_qtaguid/iface_stat_fmt");
1072 DumpFile("QTAGUID CTRL INFO", "/proc/net/xt_qtaguid/ctrl");
1073 DumpFile("QTAGUID STATS INFO", "/proc/net/xt_qtaguid/stats");
1074}
1075
1076static void DumpIpAddrAndRules() {
1077 /* The following have a tendency to get wedged when wifi drivers/fw goes belly-up. */
1078 RunCommand("NETWORK INTERFACES", {"ip", "link"});
1079 RunCommand("IPv4 ADDRESSES", {"ip", "-4", "addr", "show"});
1080 RunCommand("IPv6 ADDRESSES", {"ip", "-6", "addr", "show"});
1081 RunCommand("IP RULES", {"ip", "rule", "show"});
1082 RunCommand("IP RULES v6", {"ip", "-6", "rule", "show"});
1083}
1084
Nandana Dutt5c390032019-03-12 10:52:56 +00001085static Dumpstate::RunStatus RunDumpsysTextByPriority(const std::string& title, int priority,
1086 std::chrono::milliseconds timeout,
1087 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001088 auto start = std::chrono::steady_clock::now();
Vishnu Naire97d6122018-01-18 13:58:56 -08001089 sp<android::IServiceManager> sm = defaultServiceManager();
1090 Dumpsys dumpsys(sm.get());
Vishnu Naire97d6122018-01-18 13:58:56 -08001091 Vector<String16> args;
1092 Dumpsys::setServiceArgs(args, /* asProto = */ false, priority);
Vishnu Naire97d6122018-01-18 13:58:56 -08001093 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ false);
1094 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001095 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001096 std::string path(title);
1097 path.append(" - ").append(String8(service).c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -08001098 size_t bytes_written = 0;
Steven Moreland5a30d342019-10-08 13:53:28 -07001099 status_t status = dumpsys.startDumpThread(Dumpsys::Type::DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001100 if (status == OK) {
1101 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1102 std::chrono::duration<double> elapsed_seconds;
1103 status = dumpsys.writeDump(STDOUT_FILENO, service, service_timeout,
1104 /* as_proto = */ false, elapsed_seconds, bytes_written);
Vishnu Naire97d6122018-01-18 13:58:56 -08001105 dumpsys.writeDumpFooter(STDOUT_FILENO, service, elapsed_seconds);
1106 bool dump_complete = (status == OK);
1107 dumpsys.stopDumpThread(dump_complete);
1108 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001109
1110 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1111 std::chrono::steady_clock::now() - start);
1112 if (elapsed_duration > timeout) {
1113 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1114 elapsed_duration.count());
1115 break;
1116 }
1117 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001118 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001119}
1120
Vishnu Nair64afc022018-02-01 15:29:34 -08001121static void RunDumpsysText(const std::string& title, int priority,
1122 std::chrono::milliseconds timeout,
1123 std::chrono::milliseconds service_timeout) {
1124 DurationReporter duration_reporter(title);
1125 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1126 fsync(STDOUT_FILENO);
1127 RunDumpsysTextByPriority(title, priority, timeout, service_timeout);
1128}
1129
1130/* Dump all services registered with Normal or Default priority. */
Nandana Dutt5c390032019-03-12 10:52:56 +00001131static Dumpstate::RunStatus RunDumpsysTextNormalPriority(const std::string& title,
1132 std::chrono::milliseconds timeout,
1133 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001134 DurationReporter duration_reporter(title);
1135 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1136 fsync(STDOUT_FILENO);
1137 RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_NORMAL, timeout,
1138 service_timeout);
Nandana Dutt5c390032019-03-12 10:52:56 +00001139
1140 RETURN_IF_USER_DENIED_CONSENT();
1141
1142 return RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_DEFAULT, timeout,
1143 service_timeout);
Vishnu Nair64afc022018-02-01 15:29:34 -08001144}
1145
Nandana Dutt5c390032019-03-12 10:52:56 +00001146static Dumpstate::RunStatus RunDumpsysProto(const std::string& title, int priority,
1147 std::chrono::milliseconds timeout,
1148 std::chrono::milliseconds service_timeout) {
Luis Hector Chavez1e27b082018-03-22 15:36:42 -07001149 if (!ds.IsZipping()) {
1150 MYLOGD("Not dumping %s because it's not a zipped bugreport\n", title.c_str());
Nandana Dutt5c390032019-03-12 10:52:56 +00001151 return Dumpstate::RunStatus::OK;
Luis Hector Chavez1e27b082018-03-22 15:36:42 -07001152 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001153 sp<android::IServiceManager> sm = defaultServiceManager();
1154 Dumpsys dumpsys(sm.get());
1155 Vector<String16> args;
1156 Dumpsys::setServiceArgs(args, /* asProto = */ true, priority);
1157 DurationReporter duration_reporter(title);
1158
1159 auto start = std::chrono::steady_clock::now();
1160 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ true);
1161 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001162 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001163 std::string path(kProtoPath);
1164 path.append(String8(service).c_str());
1165 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL) {
1166 path.append("_CRITICAL");
1167 } else if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH) {
1168 path.append("_HIGH");
1169 }
1170 path.append(kProtoExt);
Steven Moreland5a30d342019-10-08 13:53:28 -07001171 status_t status = dumpsys.startDumpThread(Dumpsys::Type::DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001172 if (status == OK) {
1173 status = ds.AddZipEntryFromFd(path, dumpsys.getDumpFd(), service_timeout);
1174 bool dumpTerminated = (status == OK);
1175 dumpsys.stopDumpThread(dumpTerminated);
1176 }
1177 ZipWriter::FileEntry file_entry;
1178 ds.zip_writer_->GetLastEntry(&file_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -08001179
1180 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1181 std::chrono::steady_clock::now() - start);
1182 if (elapsed_duration > timeout) {
1183 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1184 elapsed_duration.count());
1185 break;
1186 }
1187 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001188 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001189}
1190
Nandana Dutta7db6342018-11-21 14:53:34 +00001191// Runs dumpsys on services that must dump first and will take less than 100ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001192static Dumpstate::RunStatus RunDumpsysCritical() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001193 RunDumpsysText("DUMPSYS CRITICAL", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1194 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Nandana Dutt5c390032019-03-12 10:52:56 +00001195
1196 RETURN_IF_USER_DENIED_CONSENT();
1197
1198 return RunDumpsysProto("DUMPSYS CRITICAL PROTO", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1199 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Vishnu Nair780b1282017-10-10 13:57:24 -07001200}
1201
1202// Runs dumpsys on services that must dump first but can take up to 250ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001203static Dumpstate::RunStatus RunDumpsysHigh() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001204 // TODO meminfo takes ~10s, connectivity takes ~5sec to dump. They are both
1205 // high priority. Reduce timeout once they are able to dump in a shorter time or
1206 // moved to a parallel task.
1207 RunDumpsysText("DUMPSYS HIGH", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1208 /* timeout= */ 90s, /* service_timeout= */ 30s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001209
1210 RETURN_IF_USER_DENIED_CONSENT();
1211
1212 return RunDumpsysProto("DUMPSYS HIGH PROTO", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1213 /* timeout= */ 5s, /* service_timeout= */ 1s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001214}
1215
1216// Runs dumpsys on services that must dump but can take up to 10s to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001217static Dumpstate::RunStatus RunDumpsysNormal() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001218 RunDumpsysTextNormalPriority("DUMPSYS", /* timeout= */ 90s, /* service_timeout= */ 10s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001219
1220 RETURN_IF_USER_DENIED_CONSENT();
1221
1222 return RunDumpsysProto("DUMPSYS PROTO", IServiceManager::DUMP_FLAG_PRIORITY_NORMAL,
1223 /* timeout= */ 90s, /* service_timeout= */ 10s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001224}
1225
Steven Moreland44cd9482018-01-04 16:24:13 -08001226static void DumpHals() {
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001227 if (!ds.IsZipping()) {
1228 RunCommand("HARDWARE HALS", {"lshal", "-lVSietrpc", "--types=b,c,l,z", "--debug"},
1229 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build());
1230 return;
1231 }
1232 DurationReporter duration_reporter("DUMP HALS");
1233 RunCommand("HARDWARE HALS", {"lshal", "-lVSietrpc", "--types=b,c,l,z"},
Greg Kaiser3dfeda32019-05-16 10:32:51 -07001234 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build());
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001235
Steven Moreland44cd9482018-01-04 16:24:13 -08001236 using android::hidl::manager::V1_0::IServiceManager;
1237 using android::hardware::defaultServiceManager;
1238
1239 sp<IServiceManager> sm = defaultServiceManager();
1240 if (sm == nullptr) {
1241 MYLOGE("Could not retrieve hwservicemanager to dump hals.\n");
1242 return;
1243 }
1244
1245 auto ret = sm->list([&](const auto& interfaces) {
1246 for (const std::string& interface : interfaces) {
1247 std::string cleanName = interface;
1248 std::replace_if(cleanName.begin(),
1249 cleanName.end(),
1250 [](char c) {
1251 return !isalnum(c) &&
1252 std::string("@-_:.").find(c) == std::string::npos;
1253 }, '_');
Nandana Dutt979388e2018-11-30 16:48:55 +00001254 const std::string path = ds.bugreport_internal_dir_ + "/lshal_debug_" + cleanName;
Steven Moreland44cd9482018-01-04 16:24:13 -08001255
1256 {
1257 auto fd = android::base::unique_fd(
1258 TEMP_FAILURE_RETRY(open(path.c_str(),
1259 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1260 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1261 if (fd < 0) {
1262 MYLOGE("Could not open %s to dump additional hal information.\n", path.c_str());
1263 continue;
1264 }
1265 RunCommandToFd(fd,
1266 "",
Steven Morelandc81cd3c2018-01-18 14:36:26 -08001267 {"lshal", "debug", "-E", interface},
Steven Moreland44cd9482018-01-04 16:24:13 -08001268 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
1269
1270 bool empty = 0 == lseek(fd, 0, SEEK_END);
1271 if (!empty) {
1272 ds.AddZipEntry("lshal-debug/" + cleanName + ".txt", path);
1273 }
1274 }
1275
1276 unlink(path.c_str());
1277 }
1278 });
1279
1280 if (!ret.isOk()) {
1281 MYLOGE("Could not list hals from hwservicemanager.\n");
1282 }
1283}
1284
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001285static void DumpExternalFragmentationInfo() {
1286 struct stat st;
1287 if (stat("/proc/buddyinfo", &st) != 0) {
1288 MYLOGE("Unable to dump external fragmentation info\n");
1289 return;
1290 }
1291
1292 printf("------ EXTERNAL FRAGMENTATION INFO ------\n");
1293 std::ifstream ifs("/proc/buddyinfo");
1294 auto unusable_index_regex = std::regex{"Node\\s+([0-9]+),\\s+zone\\s+(\\S+)\\s+(.*)"};
1295 for (std::string line; std::getline(ifs, line);) {
1296 std::smatch match_results;
1297 if (std::regex_match(line, match_results, unusable_index_regex)) {
1298 std::stringstream free_pages(std::string{match_results[3]});
1299 std::vector<int> free_pages_per_order(std::istream_iterator<int>{free_pages},
1300 std::istream_iterator<int>());
1301
1302 int total_free_pages = 0;
1303 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1304 total_free_pages += (free_pages_per_order[i] * std::pow(2, i));
1305 }
1306
1307 printf("Node %s, zone %8s", match_results[1].str().c_str(),
1308 match_results[2].str().c_str());
1309
1310 int usable_free_pages = total_free_pages;
1311 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1312 auto unusable_index = (total_free_pages - usable_free_pages) /
1313 static_cast<double>(total_free_pages);
1314 printf(" %5.3f", unusable_index);
1315 usable_free_pages -= (free_pages_per_order[i] * std::pow(2, i));
1316 }
1317
1318 printf("\n");
1319 }
1320 }
1321 printf("\n");
1322}
1323
Nandana Dutt5c390032019-03-12 10:52:56 +00001324// Dumps various things. Returns early with status USER_CONSENT_DENIED if user denies consent
1325// via the consent they are shown. Ignores other errors that occur while running various
1326// commands. The consent checking is currently done around long running tasks, which happen to
1327// be distributed fairly evenly throughout the function.
1328static Dumpstate::RunStatus dumpstate() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001329 DurationReporter duration_reporter("DUMPSTATE");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001330
Nandana Dutt5c390032019-03-12 10:52:56 +00001331 // Dump various things. Note that anything that takes "long" (i.e. several seconds) should
1332 // check intermittently (if it's intrerruptable like a foreach on pids) and/or should be wrapped
1333 // in a consent check (via RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK).
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -07001334 dump_dev_files("TRUSTY VERSION", "/sys/bus/platform/drivers/trusty", "trusty_version");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001335 RunCommand("UPTIME", {"uptime"});
Wei Wang509bb5d2017-06-09 14:42:12 -07001336 DumpBlockStatFiles();
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001337 DumpFile("MEMORY INFO", "/proc/meminfo");
1338 RunCommand("CPU INFO", {"top", "-b", "-n", "1", "-H", "-s", "6", "-o",
Felipe Leme30dbfa12016-09-02 12:43:26 -07001339 "pid,tid,user,pr,ni,%cpu,s,virt,res,pcy,cmd,name"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001340
1341 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "PROCRANK", {"procrank"}, AS_ROOT_20);
1342
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001343 DumpFile("VIRTUAL MEMORY STATS", "/proc/vmstat");
1344 DumpFile("VMALLOC INFO", "/proc/vmallocinfo");
1345 DumpFile("SLAB INFO", "/proc/slabinfo");
1346 DumpFile("ZONEINFO", "/proc/zoneinfo");
1347 DumpFile("PAGETYPEINFO", "/proc/pagetypeinfo");
1348 DumpFile("BUDDYINFO", "/proc/buddyinfo");
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001349 DumpExternalFragmentationInfo();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001350
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001351 DumpFile("KERNEL WAKE SOURCES", "/d/wakeup_sources");
1352 DumpFile("KERNEL CPUFREQ", "/sys/devices/system/cpu/cpu0/cpufreq/stats/time_in_state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001353
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001354 RunCommand("PROCESSES AND THREADS",
Yohei Yukawa591a72d2017-10-05 21:36:35 -07001355 {"ps", "-A", "-T", "-Z", "-O", "pri,nice,rtprio,sched,pcy,time"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001356
1357 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "LIBRANK", {"librank"},
1358 CommandOptions::AS_ROOT);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001359
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001360 DumpHals();
Steven Moreland81b429e2017-01-31 19:50:46 -08001361
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001362 RunCommand("PRINTENV", {"printenv"});
Elliott Hughes21b7c8d2016-10-28 08:53:02 -07001363 RunCommand("NETSTAT", {"netstat", "-nW"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001364 struct stat s;
1365 if (stat("/proc/modules", &s) != 0) {
1366 MYLOGD("Skipping 'lsmod' because /proc/modules does not exist\n");
1367 } else {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001368 RunCommand("LSMOD", {"lsmod"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001369 }
Michal Karpinski4db754f2015-12-11 18:04:32 +00001370
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001371 if (__android_logger_property_get_bool(
1372 "ro.logd.kernel", BOOL_DEFAULT_TRUE | BOOL_DEFAULT_FLAG_ENG | BOOL_DEFAULT_FLAG_SVELTE)) {
1373 DoKernelLogcat();
1374 } else {
1375 do_dmesg();
1376 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001377
Felipe Lemef0292972016-11-22 13:57:05 -08001378 RunCommand("LIST OF OPEN FILES", {"lsof"}, CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001379
1380 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(for_each_pid, do_showmap, "SMAPS OF ALL PROCESSES");
1381
Jeff Brown1dc94e32014-09-11 14:15:27 -07001382 for_each_tid(show_wchan, "BLOCKED PROCESS WAIT-CHANNELS");
Mark Salyzyna297c322016-02-05 15:33:17 -08001383 for_each_pid(show_showtime, "PROCESS TIMES (pid cmd user system iowait+percentage)");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001384
Ajay Panicker2ff8e872017-04-27 14:04:32 -07001385 /* Dump Bluetooth HCI logs */
1386 ds.AddDir("/data/misc/bluetooth/logs", true);
Ajay Panickerd886ec42016-09-14 12:26:46 -07001387
Greg Kaiser3ddc3fa2019-05-23 16:14:52 -07001388 if (ds.options_->do_fb && !ds.do_early_screenshot_) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001389 MYLOGI("taking late screenshot\n");
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001390 ds.TakeScreenshot();
Jeff Sharkey5a930032013-03-19 15:05:19 -07001391 }
1392
Felipe Lemee184f662016-10-27 10:04:47 -07001393 AddAnrTraceFiles();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001394
Narayan Kamath8f788292017-05-25 13:20:39 +01001395 // NOTE: tombstones are always added as separate entries in the zip archive
1396 // and are not interspersed with the main report.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001397 const bool tombstones_dumped = AddDumps(ds.tombstone_data_.begin(), ds.tombstone_data_.end(),
Narayan Kamathbd863722017-06-01 18:50:12 +01001398 "TOMBSTONE", true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001399 if (!tombstones_dumped) {
1400 printf("*** NO TOMBSTONES to dump in %s\n\n", TOMBSTONE_DIR.c_str());
Christopher Ferris7dc7f322014-07-22 16:08:19 -07001401 }
1402
Jayachandran Ca94c7172017-06-10 15:08:12 -07001403 DumpPacketStats();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001404
Chenbo Feng276a3b62018-08-07 11:44:49 -07001405 RunDumpsys("EBPF MAP STATS", {"netd", "trafficcontroller"});
1406
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001407 DoKmsg();
Mark Salyzyn2262c162014-12-16 09:09:26 -08001408
Jayachandran Ca94c7172017-06-10 15:08:12 -07001409 DumpIpAddrAndRules();
Sreeram Ramachandran2b3bba32014-07-08 15:40:55 -07001410
1411 dump_route_tables();
1412
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001413 RunCommand("ARP CACHE", {"ip", "-4", "neigh", "show"});
1414 RunCommand("IPv6 ND CACHE", {"ip", "-6", "neigh", "show"});
1415 RunCommand("MULTICAST ADDRESSES", {"ip", "maddr"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001416
Nandana Dutt5c390032019-03-12 10:52:56 +00001417 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysHigh);
Lorenzo Colitti6afc38c2015-09-09 22:59:25 +09001418
Elliott Hughes23ccc622017-02-28 10:14:22 -08001419 RunCommand("SYSTEM PROPERTIES", {"getprop"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001420
Jin Qianf334d662017-10-10 14:41:37 -07001421 RunCommand("STORAGED IO INFO", {"storaged", "-u", "-p"});
ynwangf649a6e2016-07-17 21:56:00 -07001422
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001423 RunCommand("FILESYSTEMS & FREE SPACE", {"df"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001424
Colin Crossf45fa6b2012-03-26 12:38:26 -07001425 /* Binder state is expensive to look at as it uses a lot of memory. */
Hridya Valsaraju920ba712020-02-09 16:27:01 -08001426 std::string binder_logs_dir = access("/dev/binderfs/binder_logs", R_OK) ?
1427 "/sys/kernel/debug/binder" : "/dev/binderfs/binder_logs";
1428
1429 DumpFile("BINDER FAILED TRANSACTION LOG", binder_logs_dir + "/failed_transaction_log");
1430 DumpFile("BINDER TRANSACTION LOG", binder_logs_dir + "/transaction_log");
1431 DumpFile("BINDER TRANSACTIONS", binder_logs_dir + "/transactions");
1432 DumpFile("BINDER STATS", binder_logs_dir + "/stats");
1433 DumpFile("BINDER STATE", binder_logs_dir + "/state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001434
Vishnu Nair36b4cdb2017-11-17 10:27:05 -08001435 /* Add window and surface trace files. */
1436 if (!PropertiesHelper::IsUserBuild()) {
1437 ds.AddDir(WMTRACE_DATA_DIR, false);
1438 }
1439
Yifan Hongcba0a4f2020-02-08 16:52:02 -08001440 ds.AddDir(SNAPSHOTCTL_LOG_DIR, false);
1441
Nandana Dutt5c390032019-03-12 10:52:56 +00001442 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(ds.DumpstateBoard);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001443
Steven Moreland7440ddb2016-12-15 16:13:39 -08001444 /* Migrate the ril_dumpstate to a device specific dumpstate? */
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001445 int rilDumpstateTimeout = android::base::GetIntProperty("ril.dumpstate.timeout", 0);
1446 if (rilDumpstateTimeout > 0) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001447 // su does not exist on user builds, so try running without it.
1448 // This way any implementations of vril-dump that do not require
1449 // root can run on user builds.
1450 CommandOptions::CommandOptionsBuilder options =
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001451 CommandOptions::WithTimeout(rilDumpstateTimeout);
Felipe Lemef0292972016-11-22 13:57:05 -08001452 if (!PropertiesHelper::IsUserBuild()) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001453 options.AsRoot();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001454 }
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001455 RunCommand("DUMP VENDOR RIL LOGS", {"vril-dump"}, options.Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -07001456 }
1457
Felipe Lemed8b94e52016-12-08 10:21:44 -08001458 printf("========================================================\n");
1459 printf("== Android Framework Services\n");
1460 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001461
Nandana Dutt5c390032019-03-12 10:52:56 +00001462 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysNormal);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001463
Felipe Lemed8b94e52016-12-08 10:21:44 -08001464 printf("========================================================\n");
1465 printf("== Checkins\n");
1466 printf("========================================================\n");
Dianne Hackborn02bea972013-06-26 18:59:09 -07001467
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001468 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001469
1470 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsys, "CHECKIN MEMINFO", {"meminfo", "--checkin"});
1471
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001472 RunDumpsys("CHECKIN NETSTATS", {"netstats", "--checkin"});
1473 RunDumpsys("CHECKIN PROCSTATS", {"procstats", "-c"});
1474 RunDumpsys("CHECKIN USAGESTATS", {"usagestats", "-c"});
1475 RunDumpsys("CHECKIN PACKAGE", {"package", "--checkin"});
Dianne Hackborn02bea972013-06-26 18:59:09 -07001476
Felipe Lemed8b94e52016-12-08 10:21:44 -08001477 printf("========================================================\n");
1478 printf("== Running Application Activities\n");
1479 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001480
Makoto Onuki60780982018-04-16 15:34:00 -07001481 // The following dumpsys internally collects output from running apps, so it can take a long
1482 // time. So let's extend the timeout.
1483
1484 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
1485
1486 RunDumpsys("APP ACTIVITIES", {"activity", "-v", "all"}, DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001487
Felipe Lemed8b94e52016-12-08 10:21:44 -08001488 printf("========================================================\n");
Makoto Onuki60780982018-04-16 15:34:00 -07001489 printf("== Running Application Services (platform)\n");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001490 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001491
Vishnu Nairc6e6ea72018-07-02 14:20:06 -07001492 RunDumpsys("APP SERVICES PLATFORM", {"activity", "service", "all-platform-non-critical"},
Makoto Onuki60780982018-04-16 15:34:00 -07001493 DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001494
Felipe Lemed8b94e52016-12-08 10:21:44 -08001495 printf("========================================================\n");
Makoto Onuki60780982018-04-16 15:34:00 -07001496 printf("== Running Application Services (non-platform)\n");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001497 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001498
Makoto Onuki60780982018-04-16 15:34:00 -07001499 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1500 DUMPSYS_COMPONENTS_OPTIONS);
1501
1502 printf("========================================================\n");
1503 printf("== Running Application Providers (platform)\n");
1504 printf("========================================================\n");
1505
1506 RunDumpsys("APP PROVIDERS PLATFORM", {"activity", "provider", "all-platform"},
1507 DUMPSYS_COMPONENTS_OPTIONS);
1508
1509 printf("========================================================\n");
1510 printf("== Running Application Providers (non-platform)\n");
1511 printf("========================================================\n");
1512
1513 RunDumpsys("APP PROVIDERS NON-PLATFORM", {"activity", "provider", "all-non-platform"},
1514 DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001515
Adrian Roos8b397ab2017-04-04 16:35:44 -07001516 printf("========================================================\n");
1517 printf("== Dropbox crashes\n");
1518 printf("========================================================\n");
1519
1520 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1521 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1522
Felipe Lemed8b94e52016-12-08 10:21:44 -08001523 printf("========================================================\n");
1524 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1525 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1526 printf("========================================================\n");
1527 printf("== dumpstate: done (id %d)\n", ds.id_);
1528 printf("========================================================\n");
Bookatz38472142018-09-28 10:20:24 -07001529
1530 printf("========================================================\n");
1531 printf("== Obtaining statsd metadata\n");
1532 printf("========================================================\n");
1533 // This differs from the usual dumpsys stats, which is the stats report data.
1534 RunDumpsys("STATSDSTATS", {"stats", "--metadata"});
Mike Ma5c267872019-08-21 11:31:34 -07001535
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +09001536 // Add linker configuration directory
1537 ds.AddDir(LINKERCONFIG_DIR, true);
1538
Mike Ma5c267872019-08-21 11:31:34 -07001539 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpIncidentReport);
1540
Nandana Dutt5c390032019-03-12 10:52:56 +00001541 return Dumpstate::RunStatus::OK;
Colin Crossf45fa6b2012-03-26 12:38:26 -07001542}
1543
Nandana Dutt5c390032019-03-12 10:52:56 +00001544/*
1545 * Dumps state for the default case; drops root after it's no longer necessary.
1546 *
1547 * Returns RunStatus::OK if everything went fine.
1548 * Returns RunStatus::ERROR if there was an error.
1549 * Returns RunStatus::USER_DENIED_CONSENT if user explicitly denied consent to sharing the bugreport
1550 * with the caller.
1551 */
1552static Dumpstate::RunStatus DumpstateDefault() {
Nandana Duttcf419a72019-03-14 10:40:17 +00001553 // Invoking the following dumpsys calls before DumpTraces() to try and
Nandana Dutt4be45d12018-09-26 15:04:23 +01001554 // keep the system stats as close to its initial state as possible.
Nandana Dutt5c390032019-03-12 10:52:56 +00001555 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysCritical);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001556
Nandana Duttdb379fa2019-10-09 16:54:41 +01001557 // Capture first logcat early on; useful to take a snapshot before dumpstate logs take over the
1558 // buffer.
1559 DoLogcat();
1560 // Capture timestamp after first logcat to use in next logcat
1561 time_t logcat_ts = time(nullptr);
1562
Nandana Dutt4be45d12018-09-26 15:04:23 +01001563 /* collect stack traces from Dalvik and native processes (needs root) */
Nandana Duttcf419a72019-03-14 10:40:17 +00001564 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(ds.DumpTraces, &dump_traces_path);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001565
1566 /* Run some operations that require root. */
1567 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX, !ds.IsZipping());
1568 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX, !ds.IsZipping());
1569
1570 ds.AddDir(RECOVERY_DIR, true);
1571 ds.AddDir(RECOVERY_DATA_DIR, true);
1572 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
1573 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1574 if (!PropertiesHelper::IsUserBuild()) {
1575 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1576 ds.AddDir(PROFILE_DATA_DIR_REF, true);
1577 }
Jerry Changa1df8a92020-01-02 16:03:39 +08001578 ds.AddDir(PREREBOOT_DATA_DIR, false);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001579 add_mountinfo();
1580 DumpIpTablesAsRoot();
David Andersond9ba4752018-12-11 18:26:59 -08001581 DumpDynamicPartitionInfo();
Yifan Hong3945e1b2019-10-29 12:59:23 -07001582 ds.AddDir(OTA_METADATA_DIR, true);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001583
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001584 // Capture any IPSec policies in play. No keys are exposed here.
Nandana Dutt4be45d12018-09-26 15:04:23 +01001585 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1586
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001587 // Dump IPsec stats. No keys are exposed here.
1588 DumpFile("XFRM STATS", XFRM_STAT_PROC_FILE);
1589
Nandana Dutt4be45d12018-09-26 15:04:23 +01001590 // Run ss as root so we can see socket marks.
1591 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
1592
1593 // Run iotop as root to show top 100 IO threads
1594 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
1595
Erick Reyese68df822019-02-11 14:46:36 -08001596 // Gather shared memory buffer info if the product implements it
1597 struct stat st;
1598 if (!stat("/product/bin/dmabuf_dump", &st)) {
1599 RunCommand("Dmabuf dump", {"/product/bin/dmabuf_dump"});
1600 }
1601
Minchan Kim22c6a1e2019-09-30 15:58:10 -07001602 DumpFile("PSI cpu", "/proc/pressure/cpu");
1603 DumpFile("PSI memory", "/proc/pressure/memory");
1604 DumpFile("PSI io", "/proc/pressure/io");
1605
Nandana Dutt4be45d12018-09-26 15:04:23 +01001606 if (!DropRootUser()) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001607 return Dumpstate::RunStatus::ERROR;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001608 }
1609
Nandana Dutt5c390032019-03-12 10:52:56 +00001610 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttdb379fa2019-10-09 16:54:41 +01001611 Dumpstate::RunStatus status = dumpstate();
1612 // Capture logcat since the last time we did it.
1613 DoSystemLogcat(logcat_ts);
1614 return status;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001615}
1616
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001617// This method collects common dumpsys for telephony and wifi. Typically, wifi
1618// reports are fine to include all information, but telephony reports on user
1619// builds need to strip some content (see DumpstateTelephonyOnly).
1620static void DumpstateRadioCommon(bool include_sensitive_info = true) {
Jayachandran Ca94c7172017-06-10 15:08:12 -07001621 DumpIpTablesAsRoot();
1622
Jayachandran C69968272019-07-08 09:46:05 -07001623 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1624
Jayachandran Ca94c7172017-06-10 15:08:12 -07001625 if (!DropRootUser()) {
1626 return;
1627 }
1628
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001629 // We need to be picky about some stuff for telephony reports on user builds.
1630 if (!include_sensitive_info) {
1631 // Only dump the radio log buffer (other buffers and dumps contain too much unrelated info).
1632 DoRadioLogcat();
1633 } else {
1634 // Contains various system properties and process startup info.
1635 do_dmesg();
1636 // Logs other than the radio buffer may contain package/component names and potential PII.
1637 DoLogcat();
1638 // Too broad for connectivity problems.
1639 DoKmsg();
1640 // Contains unrelated hardware info (camera, NFC, biometrics, ...).
1641 DumpHals();
1642 }
1643
Jayachandran Ca94c7172017-06-10 15:08:12 -07001644 DumpPacketStats();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001645 DumpIpAddrAndRules();
1646 dump_route_tables();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001647 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
1648 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08001649}
1650
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001651// We use "telephony" here for legacy reasons, though this now really means "connectivity" (cellular
1652// + wifi + networking). This method collects dumpsys for connectivity debugging only. General rules
1653// for what can be included on user builds: all reported information MUST directly relate to
1654// connectivity debugging or customer support and MUST NOT contain unrelated personally identifiable
1655// information. This information MUST NOT identify user-installed packages (UIDs are OK, package
1656// names are not), and MUST NOT contain logs of user application traffic.
1657// TODO(b/148168577) rename this and other related fields/methods to "connectivity" instead.
mukesh agrawal253dad42018-01-23 21:59:59 -08001658static void DumpstateTelephonyOnly() {
1659 DurationReporter duration_reporter("DUMPSTATE");
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001660
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001661 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08001662
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001663 const bool include_sensitive_info = !PropertiesHelper::IsUserBuild();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001664
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001665 DumpstateRadioCommon(include_sensitive_info);
1666
1667 if (include_sensitive_info) {
1668 // Contains too much unrelated PII, and given the unstructured nature of sysprops, we can't
1669 // really cherrypick all of the connectivity-related ones. Apps generally have no business
1670 // reading these anyway, and there should be APIs to supply the info in a more app-friendly
1671 // way.
1672 RunCommand("SYSTEM PROPERTIES", {"getprop"});
1673 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07001674
1675 printf("========================================================\n");
1676 printf("== Android Framework Services\n");
1677 printf("========================================================\n");
1678
Vishnu Nair652cc802017-11-30 15:18:30 -08001679 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1680 SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001681 // TODO(b/146521742) build out an argument to include bound services here for user builds
Vishnu Nair652cc802017-11-30 15:18:30 -08001682 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
1683 SEC_TO_MSEC(10));
Amruth Ramachandrand25a9142018-04-02 16:16:09 -07001684 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
1685 SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001686 RunDumpsys("DUMPSYS", {"netpolicy"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
1687 RunDumpsys("DUMPSYS", {"network_management"}, CommandOptions::WithTimeout(90).Build(),
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07001688 SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001689 if (include_sensitive_info) {
1690 // Contains raw IP addresses, omit from reports on user builds.
1691 RunDumpsys("DUMPSYS", {"netd"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
1692 // Contains raw destination IP/MAC addresses, omit from reports on user builds.
1693 RunDumpsys("DUMPSYS", {"connmetrics"}, CommandOptions::WithTimeout(90).Build(),
1694 SEC_TO_MSEC(10));
1695 // Contains package/component names, omit from reports on user builds.
1696 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
1697 SEC_TO_MSEC(10));
1698 // Contains package names, but should be relatively simple to remove them (also contains
1699 // UIDs already), omit from reports on user builds.
1700 RunDumpsys("BATTERYSTATS", {"deviceidle"}, CommandOptions::WithTimeout(90).Build(),
1701 SEC_TO_MSEC(10));
1702 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07001703
1704 printf("========================================================\n");
1705 printf("== Running Application Services\n");
1706 printf("========================================================\n");
1707
1708 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
1709
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001710 if (include_sensitive_info) {
1711 printf("========================================================\n");
1712 printf("== Running Application Services (non-platform)\n");
1713 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001714
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001715 // Contains package/component names and potential PII, omit from reports on user builds.
1716 // To get dumps of the active CarrierService(s) on user builds, we supply an argument to the
1717 // carrier_config dumpsys instead.
1718 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1719 DUMPSYS_COMPONENTS_OPTIONS);
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001720
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001721 printf("========================================================\n");
1722 printf("== Checkins\n");
1723 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07001724
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001725 // Contains package/component names, omit from reports on user builds.
1726 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
1727 }
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07001728
1729 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07001730 printf("== dumpstate: done (id %d)\n", ds.id_);
1731 printf("========================================================\n");
1732}
1733
mukesh agrawal253dad42018-01-23 21:59:59 -08001734// This method collects dumpsys for wifi debugging only
1735static void DumpstateWifiOnly() {
1736 DurationReporter duration_reporter("DUMPSTATE");
1737
1738 DumpstateRadioCommon();
1739
1740 printf("========================================================\n");
1741 printf("== Android Framework Services\n");
1742 printf("========================================================\n");
1743
1744 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1745 SEC_TO_MSEC(10));
1746 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
1747 SEC_TO_MSEC(10));
1748
1749 printf("========================================================\n");
1750 printf("== dumpstate: done (id %d)\n", ds.id_);
1751 printf("========================================================\n");
1752}
1753
Nandana Duttcf419a72019-03-14 10:40:17 +00001754Dumpstate::RunStatus Dumpstate::DumpTraces(const char** path) {
Nandana Duttfaafd522019-03-11 09:23:09 +00001755 DurationReporter duration_reporter("DUMP TRACES");
1756
1757 const std::string temp_file_pattern = "/data/anr/dumptrace_XXXXXX";
1758 const size_t buf_size = temp_file_pattern.length() + 1;
1759 std::unique_ptr<char[]> file_name_buf(new char[buf_size]);
1760 memcpy(file_name_buf.get(), temp_file_pattern.c_str(), buf_size);
1761
1762 // Create a new, empty file to receive all trace dumps.
1763 //
1764 // TODO: This can be simplified once we remove support for the old style
1765 // dumps. We can have a file descriptor passed in to dump_traces instead
1766 // of creating a file, closing it and then reopening it again.
1767 android::base::unique_fd fd(mkostemp(file_name_buf.get(), O_APPEND | O_CLOEXEC));
1768 if (fd < 0) {
1769 MYLOGE("mkostemp on pattern %s: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001770 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001771 }
1772
1773 // Nobody should have access to this temporary file except dumpstate, but we
1774 // temporarily grant 'read' to 'others' here because this file is created
1775 // when tombstoned is still running as root, but dumped after dropping. This
1776 // can go away once support for old style dumping has.
1777 const int chmod_ret = fchmod(fd, 0666);
1778 if (chmod_ret < 0) {
1779 MYLOGE("fchmod on %s failed: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001780 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001781 }
1782
1783 std::unique_ptr<DIR, decltype(&closedir)> proc(opendir("/proc"), closedir);
1784 if (proc.get() == nullptr) {
1785 MYLOGE("opendir /proc failed: %s\n", strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001786 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001787 }
1788
1789 // Number of times process dumping has timed out. If we encounter too many
1790 // failures, we'll give up.
1791 int timeout_failures = 0;
1792 bool dalvik_found = false;
1793
1794 const std::set<int> hal_pids = get_interesting_hal_pids();
1795
1796 struct dirent* d;
1797 while ((d = readdir(proc.get()))) {
Nandana Duttcf419a72019-03-14 10:40:17 +00001798 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttfaafd522019-03-11 09:23:09 +00001799 int pid = atoi(d->d_name);
1800 if (pid <= 0) {
1801 continue;
1802 }
1803
1804 const std::string link_name = android::base::StringPrintf("/proc/%d/exe", pid);
1805 std::string exe;
1806 if (!android::base::Readlink(link_name, &exe)) {
1807 continue;
1808 }
1809
1810 bool is_java_process;
1811 if (exe == "/system/bin/app_process32" || exe == "/system/bin/app_process64") {
1812 // Don't bother dumping backtraces for the zygote.
1813 if (IsZygote(pid)) {
1814 continue;
1815 }
1816
1817 dalvik_found = true;
1818 is_java_process = true;
1819 } else if (should_dump_native_traces(exe.c_str()) || hal_pids.find(pid) != hal_pids.end()) {
1820 is_java_process = false;
1821 } else {
1822 // Probably a native process we don't care about, continue.
1823 continue;
1824 }
1825
1826 // If 3 backtrace dumps fail in a row, consider debuggerd dead.
1827 if (timeout_failures == 3) {
1828 dprintf(fd, "ERROR: Too many stack dump failures, exiting.\n");
1829 break;
1830 }
1831
1832 const uint64_t start = Nanotime();
1833 const int ret = dump_backtrace_to_file_timeout(
1834 pid, is_java_process ? kDebuggerdJavaBacktrace : kDebuggerdNativeBacktrace,
1835 is_java_process ? 5 : 20, fd);
1836
1837 if (ret == -1) {
1838 // For consistency, the header and footer to this message match those
1839 // dumped by debuggerd in the success case.
1840 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
1841 dprintf(fd, "Dump failed, likely due to a timeout.\n");
1842 dprintf(fd, "---- end %d ----", pid);
1843 timeout_failures++;
1844 continue;
1845 }
1846
1847 // We've successfully dumped stack traces, reset the failure count
1848 // and write a summary of the elapsed time to the file and continue with the
1849 // next process.
1850 timeout_failures = 0;
1851
1852 dprintf(fd, "[dump %s stack %d: %.3fs elapsed]\n", is_java_process ? "dalvik" : "native",
1853 pid, (float)(Nanotime() - start) / NANOS_PER_SEC);
1854 }
1855
1856 if (!dalvik_found) {
1857 MYLOGE("Warning: no Dalvik processes found to dump stacks\n");
1858 }
1859
Nandana Duttcf419a72019-03-14 10:40:17 +00001860 *path = file_name_buf.release();
1861 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001862}
1863
Felipe Leme6f674ae2016-11-18 17:10:33 -08001864void Dumpstate::DumpstateBoard() {
1865 DurationReporter duration_reporter("dumpstate_board()");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001866 printf("========================================================\n");
1867 printf("== Board\n");
1868 printf("========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001869
Felipe Leme6f674ae2016-11-18 17:10:33 -08001870 if (!IsZipping()) {
Steven Moreland7440ddb2016-12-15 16:13:39 -08001871 MYLOGD("Not dumping board info because it's not a zipped bugreport\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001872 return;
1873 }
1874
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001875 std::vector<std::string> paths;
1876 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07001877 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00001878 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
1879 kDumpstateBoardFiles[i].c_str()));
Nandana Dutt16d1aee2019-02-15 16:13:53 +00001880 remover.emplace_back(android::base::make_scope_guard(
1881 std::bind([](std::string path) { android::os::UnlinkAndLogOnError(path); }, paths[i])));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001882 }
Jie Song9fbfad02017-06-20 16:29:42 -07001883
Wei Wang587eac92018-04-05 12:17:20 -07001884 sp<IDumpstateDevice> dumpstate_device(IDumpstateDevice::getService());
1885 if (dumpstate_device == nullptr) {
1886 MYLOGE("No IDumpstateDevice implementation\n");
1887 return;
1888 }
1889
1890 using ScopedNativeHandle =
1891 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
1892 ScopedNativeHandle handle(native_handle_create(static_cast<int>(paths.size()), 0),
1893 [](native_handle_t* handle) {
1894 native_handle_close(handle);
1895 native_handle_delete(handle);
1896 });
1897 if (handle == nullptr) {
1898 MYLOGE("Could not create native_handle\n");
1899 return;
1900 }
1901
Nandana Dutt5c390032019-03-12 10:52:56 +00001902 // TODO(128270426): Check for consent in between?
Wei Wang587eac92018-04-05 12:17:20 -07001903 for (size_t i = 0; i < paths.size(); i++) {
1904 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
1905
1906 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
1907 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1908 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1909 if (fd < 0) {
1910 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
1911 return;
1912 }
1913 handle.get()->data[i] = fd.release();
1914 }
1915
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001916 // Given that bugreport is required to diagnose failures, it's better to
Wei Wang587eac92018-04-05 12:17:20 -07001917 // set an arbitrary amount of timeout for IDumpstateDevice than to block the
1918 // rest of bugreport. In the timeout case, we will kill dumpstate board HAL
1919 // and grab whatever dumped
1920 std::packaged_task<bool()>
1921 dumpstate_task([paths, dumpstate_device, &handle]() -> bool {
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001922 android::hardware::Return<void> status = dumpstate_device->dumpstateBoard(handle.get());
1923 if (!status.isOk()) {
1924 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
Wei Wang587eac92018-04-05 12:17:20 -07001925 return false;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001926 }
Wei Wang587eac92018-04-05 12:17:20 -07001927 return true;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001928 });
Wei Wang587eac92018-04-05 12:17:20 -07001929
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001930 auto result = dumpstate_task.get_future();
1931 std::thread(std::move(dumpstate_task)).detach();
Wei Wang587eac92018-04-05 12:17:20 -07001932
1933 constexpr size_t timeout_sec = 30;
1934 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
1935 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate vendor HAL\n", timeout_sec);
1936 if (!android::base::SetProperty("ctl.interface_restart",
1937 android::base::StringPrintf("%s/default",
1938 IDumpstateDevice::descriptor))) {
1939 MYLOGE("Couldn't restart dumpstate HAL\n");
1940 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001941 }
Wei Wang587eac92018-04-05 12:17:20 -07001942 // Wait some time for init to kill dumpstate vendor HAL
1943 constexpr size_t killing_timeout_sec = 10;
1944 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
1945 MYLOGE("killing dumpstateBoard timed out after %zus, continue and "
1946 "there might be racing in content\n", killing_timeout_sec);
1947 }
1948
1949 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
1950 for (size_t i = 0; i < paths.size(); i++) {
1951 struct stat s;
1952 if (fstat(handle.get()->data[i], &s) == -1) {
1953 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(),
1954 strerror(errno));
1955 file_sizes[i] = -1;
1956 continue;
1957 }
1958 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001959 }
1960
1961 for (size_t i = 0; i < paths.size(); i++) {
1962 if (file_sizes[i] == -1) {
1963 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07001964 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001965 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07001966 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001967 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07001968 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001969 AddZipEntry(kDumpstateBoardFiles[i], paths[i]);
Jie Song9fbfad02017-06-20 16:29:42 -07001970 }
1971
Felipe Lemed8b94e52016-12-08 10:21:44 -08001972 printf("*** See dumpstate-board.txt entry ***\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001973}
1974
Nandana Dutt12ae14a2019-01-09 10:35:53 +00001975static void ShowUsage() {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001976 fprintf(stderr,
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001977 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-d] [-p] "
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001978 "[-z]] [-s] [-S] [-q] [-B] [-P] [-R] [-V version]\n"
1979 " -h: display this help message\n"
1980 " -b: play sound file instead of vibrate, at beginning of job\n"
1981 " -e: play sound file instead of vibrate, at end of job\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001982 " -d: append date to filename\n"
1983 " -p: capture screenshot to filename.png\n"
1984 " -z: generate zipped file\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001985 " -s: write output to control socket (for init)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001986 " -S: write file location to control socket (for init; requires -z)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001987 " -q: disable vibrate\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001988 " -B: send broadcast when finished\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001989 " -P: send broadcast when started and update system properties on "
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001990 "progress (requires -B)\n"
1991 " -R: take bugreport in remote mode (requires -z, -d and -B, "
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001992 "shouldn't be used with -P)\n"
Nandana Dutt235864b2019-01-22 12:10:16 +00001993 " -w: start binder service and make it wait for a call to startBugreport\n"
Felipe Lemed071c682016-10-20 16:48:00 -07001994 " -v: prints the dumpstate header and exit\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001995}
1996
Wei Liuf87959e2016-08-26 14:51:42 -07001997static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07001998 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07001999}
2000
Felipe Leme1d486fe2016-10-14 18:06:47 -07002001bool Dumpstate::FinishZipFile() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07002002 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07002003 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07002004 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002005 // Final timestamp
2006 char date[80];
2007 time_t the_real_now_please_stand_up = time(nullptr);
2008 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002009 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07002010 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002011
Felipe Leme9a523ae2016-10-20 15:10:33 -07002012 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002013 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08002014 return false;
2015 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07002016 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002017 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08002018 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08002019 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08002020
Felipe Leme0f3fb202016-06-10 17:10:53 -07002021 // Add log file (which contains stderr output) to zip...
2022 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07002023 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07002024 MYLOGE("Failed to add dumpstate log to .zip file\n");
2025 return false;
2026 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002027 // TODO: Should truncate the existing file.
2028 // ... and re-open it for further logging.
Nandana Dutta344cb62019-02-22 15:12:35 +00002029 if (!redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()))) {
2030 return false;
2031 }
Felipe Leme0f3fb202016-06-10 17:10:53 -07002032 fprintf(stderr, "\n");
2033
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002034 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07002035 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002036 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002037 return false;
2038 }
2039
Felipe Leme1d486fe2016-10-14 18:06:47 -07002040 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
2041 ds.zip_file.reset(nullptr);
2042
Felipe Lemee9d2c542016-11-15 11:48:26 -08002043 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002044 android::os::UnlinkAndLogOnError(tmp_path_);
Felipe Lemec4eee562016-04-21 15:42:55 -07002045
Felipe Leme1e9edc62015-12-21 16:02:13 -08002046 return true;
2047}
Felipe Leme6e01fa62015-11-11 19:35:14 -08002048
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -07002049static std::string SHA256_file_hash(const std::string& filepath) {
Andreas Gampe27cd7b22016-07-18 18:24:05 -07002050 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(filepath.c_str(), O_RDONLY | O_NONBLOCK
2051 | O_CLOEXEC | O_NOFOLLOW)));
Andreas Gampeaff68432016-07-18 18:01:27 -07002052 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002053 MYLOGE("open(%s): %s\n", filepath.c_str(), strerror(errno));
Yi Kong19d5c002018-07-20 13:39:55 -07002054 return nullptr;
Michal Karpinski4db754f2015-12-11 18:04:32 +00002055 }
2056
2057 SHA256_CTX ctx;
Elliott Hughesc4dc1412016-04-12 16:28:31 -07002058 SHA256_Init(&ctx);
Michal Karpinski4db754f2015-12-11 18:04:32 +00002059
2060 std::vector<uint8_t> buffer(65536);
2061 while (1) {
2062 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd.get(), buffer.data(), buffer.size()));
2063 if (bytes_read == 0) {
2064 break;
2065 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002066 MYLOGE("read(%s): %s\n", filepath.c_str(), strerror(errno));
Yi Kong19d5c002018-07-20 13:39:55 -07002067 return nullptr;
Michal Karpinski4db754f2015-12-11 18:04:32 +00002068 }
2069
Elliott Hughesc4dc1412016-04-12 16:28:31 -07002070 SHA256_Update(&ctx, buffer.data(), bytes_read);
Michal Karpinski4db754f2015-12-11 18:04:32 +00002071 }
2072
Elliott Hughesc4dc1412016-04-12 16:28:31 -07002073 uint8_t hash[SHA256_DIGEST_LENGTH];
2074 SHA256_Final(hash, &ctx);
2075
2076 char hash_buffer[SHA256_DIGEST_LENGTH * 2 + 1];
2077 for(size_t i = 0; i < SHA256_DIGEST_LENGTH; i++) {
Michal Karpinskicbbdf732016-01-07 20:45:02 +00002078 sprintf(hash_buffer + (i * 2), "%02x", hash[i]);
Michal Karpinski4db754f2015-12-11 18:04:32 +00002079 }
2080 hash_buffer[sizeof(hash_buffer) - 1] = 0;
2081 return std::string(hash_buffer);
2082}
2083
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002084static void SendBroadcast(const std::string& action, const std::vector<std::string>& args) {
2085 // clang-format off
2086 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user", "0",
2087 "--receiver-foreground", "--receiver-include-background", "-a", action};
2088 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08002089
2090 am.insert(am.end(), args.begin(), args.end());
2091
Felipe Leme8d2410e2017-02-08 09:46:08 -08002092 RunCommand("", am,
2093 CommandOptions::WithTimeout(20)
2094 .Log("Sending broadcast: '%s'\n")
2095 .Always()
2096 .DropRoot()
2097 .RedirectStderr()
2098 .Build());
2099}
2100
Felipe Leme35b8cf12017-02-10 15:47:29 -08002101static void Vibrate(int duration_ms) {
2102 // clang-format off
Chris Fries0c3de872019-09-14 15:49:41 +00002103 RunCommand("", {"cmd", "vibrator", "vibrate", "-f", std::to_string(duration_ms), "dumpstate"},
Felipe Leme35b8cf12017-02-10 15:47:29 -08002104 CommandOptions::WithTimeout(10)
2105 .Log("Vibrate: '%s'\n")
2106 .Always()
2107 .Build());
2108 // clang-format on
2109}
2110
Nandana Dutt979388e2018-11-30 16:48:55 +00002111static void MaybeResolveSymlink(std::string* path) {
2112 std::string resolved_path;
2113 if (android::base::Readlink(*path, &resolved_path)) {
2114 *path = resolved_path;
2115 }
2116}
2117
Nandana Dutt4be45d12018-09-26 15:04:23 +01002118/*
2119 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
2120 * if we are writing zip files and adds the version file.
2121 */
2122static void PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002123 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
2124
Nandana Dutt4be45d12018-09-26 15:04:23 +01002125 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
2126 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002127 ds.base_name_ = StringPrintf("bugreport-%s-%s", device_name.c_str(), build_id.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002128 if (ds.options_->do_add_date) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002129 char date[80];
2130 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
2131 ds.name_ = date;
2132 } else {
2133 ds.name_ = "undated";
2134 }
2135
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002136 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002137 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002138 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002139 ds.base_name_ += "-wifi";
2140 }
2141
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002142 if (ds.options_->do_fb) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002143 ds.screenshot_path_ = ds.GetPath(".png");
2144 }
2145 ds.tmp_path_ = ds.GetPath(".tmp");
2146 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
2147
Nandana Dutt54dbd672019-01-11 12:58:05 +00002148 std::string destination = ds.options_->bugreport_fd.get() != -1
2149 ? StringPrintf("[fd:%d]", ds.options_->bugreport_fd.get())
Nandana Dutt9a76d202019-01-21 15:56:48 +00002150 : ds.bugreport_internal_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01002151 MYLOGD(
2152 "Bugreport dir: %s\n"
2153 "Base name: %s\n"
2154 "Suffix: %s\n"
2155 "Log path: %s\n"
2156 "Temporary path: %s\n"
2157 "Screenshot path: %s\n",
Nandana Dutt9a76d202019-01-21 15:56:48 +00002158 destination.c_str(), ds.base_name_.c_str(), ds.name_.c_str(), ds.log_path_.c_str(),
2159 ds.tmp_path_.c_str(), ds.screenshot_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002160
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002161 if (ds.options_->do_zip_file) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002162 ds.path_ = ds.GetPath(".zip");
2163 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
2164 create_parent_dirs(ds.path_.c_str());
2165 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
2166 if (ds.zip_file == nullptr) {
2167 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
2168 } else {
2169 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
2170 }
2171 ds.AddTextZipEntry("version.txt", ds.version_);
2172 }
2173}
2174
2175/*
2176 * Finalizes writing to the file by renaming or zipping the tmp file to the final location,
2177 * printing zipped file status, etc.
2178 */
2179static void FinalizeFile() {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002180 /* check if user changed the suffix using system properties */
2181 std::string name =
2182 android::base::GetProperty(android::base::StringPrintf("dumpstate.%d.name", ds.pid_), "");
2183 bool change_suffix = false;
2184 if (!name.empty()) {
2185 /* must whitelist which characters are allowed, otherwise it could cross directories */
2186 std::regex valid_regex("^[-_a-zA-Z0-9]+$");
2187 if (std::regex_match(name.c_str(), valid_regex)) {
2188 change_suffix = true;
2189 } else {
2190 MYLOGE("invalid suffix provided by user: %s\n", name.c_str());
2191 }
2192 }
2193 if (change_suffix) {
2194 MYLOGI("changing suffix from %s to %s\n", ds.name_.c_str(), name.c_str());
2195 ds.name_ = name;
2196 if (!ds.screenshot_path_.empty()) {
2197 std::string new_screenshot_path = ds.GetPath(".png");
2198 if (rename(ds.screenshot_path_.c_str(), new_screenshot_path.c_str())) {
2199 MYLOGE("rename(%s, %s): %s\n", ds.screenshot_path_.c_str(),
2200 new_screenshot_path.c_str(), strerror(errno));
2201 } else {
2202 ds.screenshot_path_ = new_screenshot_path;
2203 }
2204 }
2205 }
2206
2207 bool do_text_file = true;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002208 if (ds.options_->do_zip_file) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002209 if (!ds.FinishZipFile()) {
2210 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
2211 do_text_file = true;
2212 } else {
2213 do_text_file = false;
Nandana Dutt383d0c12018-11-30 15:54:56 +00002214 // If the user has changed the suffix, we need to change the zip file name.
2215 std::string new_path = ds.GetPath(".zip");
2216 if (ds.path_ != new_path) {
2217 MYLOGD("Renaming zip file from %s to %s\n", ds.path_.c_str(), new_path.c_str());
2218 if (rename(ds.path_.c_str(), new_path.c_str())) {
2219 MYLOGE("rename(%s, %s): %s\n", ds.path_.c_str(), new_path.c_str(),
2220 strerror(errno));
2221 } else {
2222 ds.path_ = new_path;
2223 }
2224 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01002225 }
2226 }
2227 if (do_text_file) {
2228 ds.path_ = ds.GetPath(".txt");
2229 MYLOGD("Generating .txt bugreport at %s from %s\n", ds.path_.c_str(), ds.tmp_path_.c_str());
2230 if (rename(ds.tmp_path_.c_str(), ds.path_.c_str())) {
2231 MYLOGE("rename(%s, %s): %s\n", ds.tmp_path_.c_str(), ds.path_.c_str(), strerror(errno));
2232 ds.path_.clear();
2233 }
2234 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002235 if (ds.options_->use_control_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002236 if (do_text_file) {
2237 dprintf(ds.control_socket_fd_,
2238 "FAIL:could not create zip file, check %s "
2239 "for more details\n",
2240 ds.log_path_.c_str());
2241 } else {
2242 dprintf(ds.control_socket_fd_, "OK:%s\n", ds.path_.c_str());
2243 }
2244 }
2245}
2246
2247/* Broadcasts that we are done with the bugreport */
2248static void SendBugreportFinishedBroadcast() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002249 // TODO(b/111441001): use callback instead of broadcast.
Nandana Dutt9a76d202019-01-21 15:56:48 +00002250 if (!ds.path_.empty()) {
2251 MYLOGI("Final bugreport path: %s\n", ds.path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002252 // clang-format off
2253
2254 std::vector<std::string> am_args = {
2255 "--receiver-permission", "android.permission.DUMP",
2256 "--ei", "android.intent.extra.ID", std::to_string(ds.id_),
2257 "--ei", "android.intent.extra.PID", std::to_string(ds.pid_),
2258 "--ei", "android.intent.extra.MAX", std::to_string(ds.progress_->GetMax()),
Nandana Dutt9a76d202019-01-21 15:56:48 +00002259 "--es", "android.intent.extra.BUGREPORT", ds.path_,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002260 "--es", "android.intent.extra.DUMPSTATE_LOG", ds.log_path_
2261 };
2262 // clang-format on
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +00002263 if (ds.options_->do_fb && !android::os::IsFileEmpty(ds.screenshot_path_)) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002264 am_args.push_back("--es");
2265 am_args.push_back("android.intent.extra.SCREENSHOT");
2266 am_args.push_back(ds.screenshot_path_);
2267 }
Nandana Dutt15b89d72018-11-16 14:14:12 +00002268 if (!ds.options_->notification_title.empty()) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002269 am_args.push_back("--es");
2270 am_args.push_back("android.intent.extra.TITLE");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002271 am_args.push_back(ds.options_->notification_title);
2272 if (!ds.options_->notification_description.empty()) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002273 am_args.push_back("--es");
2274 am_args.push_back("android.intent.extra.DESCRIPTION");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002275 am_args.push_back(ds.options_->notification_description);
Nandana Dutt4be45d12018-09-26 15:04:23 +01002276 }
2277 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002278 if (ds.options_->is_remote_mode) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002279 am_args.push_back("--es");
2280 am_args.push_back("android.intent.extra.REMOTE_BUGREPORT_HASH");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002281 am_args.push_back(SHA256_file_hash(ds.path_));
Nandana Dutt4be45d12018-09-26 15:04:23 +01002282 SendBroadcast("com.android.internal.intent.action.REMOTE_BUGREPORT_FINISHED", am_args);
2283 } else {
2284 SendBroadcast("com.android.internal.intent.action.BUGREPORT_FINISHED", am_args);
2285 }
2286 } else {
2287 MYLOGE("Skipping finished broadcast because bugreport could not be generated\n");
2288 }
2289}
2290
Nandana Dutt58d72e22018-11-16 10:30:48 +00002291static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2292 switch (mode) {
2293 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2294 return "BUGREPORT_FULL";
2295 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2296 return "BUGREPORT_INTERACTIVE";
2297 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2298 return "BUGREPORT_REMOTE";
2299 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2300 return "BUGREPORT_WEAR";
2301 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2302 return "BUGREPORT_TELEPHONY";
2303 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2304 return "BUGREPORT_WIFI";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002305 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2306 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002307 }
2308}
2309
2310static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options) {
Abhijeet Kaur8ca245e2018-12-12 10:34:21 +00002311 options->extra_options = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002312 switch (mode) {
2313 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2314 options->do_broadcast = true;
2315 options->do_fb = true;
2316 break;
2317 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002318 // Currently, the dumpstate binder is only used by Shell to update progress.
2319 options->do_start_service = true;
2320 options->do_progress_updates = true;
2321 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002322 options->do_broadcast = true;
2323 break;
2324 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002325 options->do_vibrate = false;
2326 options->is_remote_mode = true;
2327 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002328 options->do_broadcast = true;
2329 break;
2330 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002331 options->do_start_service = true;
2332 options->do_progress_updates = true;
2333 options->do_zip_file = true;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002334 options->do_fb = true;
2335 options->do_broadcast = true;
2336 break;
2337 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002338 options->telephony_only = true;
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002339 options->do_progress_updates = true;
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +00002340 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002341 options->do_broadcast = true;
2342 break;
2343 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002344 options->wifi_only = true;
2345 options->do_zip_file = true;
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +00002346 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002347 options->do_broadcast = true;
2348 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002349 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2350 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002351 }
2352}
2353
2354static Dumpstate::BugreportMode getBugreportModeFromProperty() {
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002355 // If the system property is not set, it's assumed to be a default bugreport.
2356 Dumpstate::BugreportMode mode = Dumpstate::BugreportMode::BUGREPORT_DEFAULT;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002357
2358 std::string extra_options = android::base::GetProperty(PROPERTY_EXTRA_OPTIONS, "");
2359 if (!extra_options.empty()) {
2360 // Framework uses a system property to override some command-line args.
2361 // Currently, it contains the type of the requested bugreport.
2362 if (extra_options == "bugreportplus") {
2363 mode = Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002364 } else if (extra_options == "bugreportfull") {
2365 mode = Dumpstate::BugreportMode::BUGREPORT_FULL;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002366 } else if (extra_options == "bugreportremote") {
2367 mode = Dumpstate::BugreportMode::BUGREPORT_REMOTE;
2368 } else if (extra_options == "bugreportwear") {
2369 mode = Dumpstate::BugreportMode::BUGREPORT_WEAR;
2370 } else if (extra_options == "bugreporttelephony") {
2371 mode = Dumpstate::BugreportMode::BUGREPORT_TELEPHONY;
2372 } else if (extra_options == "bugreportwifi") {
2373 mode = Dumpstate::BugreportMode::BUGREPORT_WIFI;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002374 } else {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002375 MYLOGE("Unknown extra option: %s\n", extra_options.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002376 }
2377 // Reset the property
2378 android::base::SetProperty(PROPERTY_EXTRA_OPTIONS, "");
2379 }
Nandana Dutt58d72e22018-11-16 10:30:48 +00002380 return mode;
2381}
2382
2383// TODO: Move away from system properties when we have options passed via binder calls.
2384/* Sets runtime options from the system properties and then clears those properties. */
2385static void SetOptionsFromProperties(Dumpstate::DumpOptions* options) {
2386 Dumpstate::BugreportMode mode = getBugreportModeFromProperty();
2387 SetOptionsFromMode(mode, options);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002388
2389 options->notification_title = android::base::GetProperty(PROPERTY_EXTRA_TITLE, "");
2390 if (!options->notification_title.empty()) {
2391 // Reset the property
2392 android::base::SetProperty(PROPERTY_EXTRA_TITLE, "");
2393
Nandana Duttdd8cca32018-11-14 10:10:29 +00002394 options->notification_description =
2395 android::base::GetProperty(PROPERTY_EXTRA_DESCRIPTION, "");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002396 if (!options->notification_description.empty()) {
2397 // Reset the property
2398 android::base::SetProperty(PROPERTY_EXTRA_DESCRIPTION, "");
2399 }
2400 MYLOGD("notification (title: %s, description: %s)\n", options->notification_title.c_str(),
2401 options->notification_description.c_str());
2402 }
2403}
2404
Nandana Dutt58d72e22018-11-16 10:30:48 +00002405static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
2406 MYLOGI("do_zip_file: %d\n", options.do_zip_file);
2407 MYLOGI("do_add_date: %d\n", options.do_add_date);
2408 MYLOGI("do_vibrate: %d\n", options.do_vibrate);
2409 MYLOGI("use_socket: %d\n", options.use_socket);
2410 MYLOGI("use_control_socket: %d\n", options.use_control_socket);
2411 MYLOGI("do_fb: %d\n", options.do_fb);
2412 MYLOGI("do_broadcast: %d\n", options.do_broadcast);
2413 MYLOGI("is_remote_mode: %d\n", options.is_remote_mode);
2414 MYLOGI("show_header_only: %d\n", options.show_header_only);
2415 MYLOGI("do_start_service: %d\n", options.do_start_service);
2416 MYLOGI("telephony_only: %d\n", options.telephony_only);
2417 MYLOGI("wifi_only: %d\n", options.wifi_only);
2418 MYLOGI("do_progress_updates: %d\n", options.do_progress_updates);
Nandana Dutt54dbd672019-01-11 12:58:05 +00002419 MYLOGI("fd: %d\n", options.bugreport_fd.get());
Nandana Dutt58d72e22018-11-16 10:30:48 +00002420 MYLOGI("extra_options: %s\n", options.extra_options.c_str());
2421 MYLOGI("args: %s\n", options.args.c_str());
2422 MYLOGI("notification_title: %s\n", options.notification_title.c_str());
2423 MYLOGI("notification_description: %s\n", options.notification_description.c_str());
2424}
2425
Nandana Dutt54dbd672019-01-11 12:58:05 +00002426void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode,
2427 const android::base::unique_fd& bugreport_fd_in,
2428 const android::base::unique_fd& screenshot_fd_in) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002429 // In the new API world, date is always added; output is always a zip file.
2430 // TODO(111441001): remove these options once they are obsolete.
2431 do_add_date = true;
2432 do_zip_file = true;
2433
Nandana Dutt54dbd672019-01-11 12:58:05 +00002434 // Duplicate the fds because the passed in fds don't outlive the binder transaction.
2435 bugreport_fd.reset(dup(bugreport_fd_in.get()));
2436 screenshot_fd.reset(dup(screenshot_fd_in.get()));
Nandana Dutt58d72e22018-11-16 10:30:48 +00002437
2438 extra_options = ModeToString(bugreport_mode);
2439 SetOptionsFromMode(bugreport_mode, this);
2440}
2441
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002442Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
2443 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002444 int c;
Nandana Dutt235864b2019-01-22 12:10:16 +00002445 while ((c = getopt(argc, argv, "dho:svqzpPBRSV:w")) != -1) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002446 switch (c) {
2447 // clang-format off
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002448 case 'd': do_add_date = true; break;
2449 case 'z': do_zip_file = true; break;
Nandana Dutt9a76d202019-01-21 15:56:48 +00002450 // o=use_outfile not supported anymore.
2451 // TODO(b/111441001): Remove when all callers have migrated.
2452 case 'o': break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002453 case 's': use_socket = true; break;
2454 case 'S': use_control_socket = true; break;
2455 case 'v': show_header_only = true; break;
2456 case 'q': do_vibrate = false; break;
2457 case 'p': do_fb = true; break;
2458 case 'P': do_progress_updates = true; break;
2459 case 'R': is_remote_mode = true; break;
2460 case 'B': do_broadcast = true; break;
2461 case 'V': break; // compatibility no-op
Nandana Dutt235864b2019-01-22 12:10:16 +00002462 case 'w':
2463 // This was already processed
2464 break;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002465 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002466 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002467 break;
2468 default:
2469 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002470 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002471 break;
2472 // clang-format on
2473 }
2474 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08002475
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002476 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002477 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002478 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002479 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002480 }
2481 }
2482
2483 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
2484 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002485
2486 SetOptionsFromProperties(this);
2487 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002488}
2489
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002490bool Dumpstate::DumpOptions::ValidateOptions() const {
Nandana Dutt54dbd672019-01-11 12:58:05 +00002491 if (bugreport_fd.get() != -1 && !do_zip_file) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002492 return false;
2493 }
2494
Nandana Dutt9a76d202019-01-21 15:56:48 +00002495 if ((do_zip_file || do_add_date || do_progress_updates || do_broadcast) && !OutputToFile()) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002496 return false;
2497 }
2498
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002499 if (use_control_socket && !do_zip_file) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002500 return false;
2501 }
2502
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002503 if (do_progress_updates && !do_broadcast) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002504 return false;
2505 }
2506
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002507 if (is_remote_mode && (do_progress_updates || !do_broadcast || !do_zip_file || !do_add_date)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002508 return false;
2509 }
2510 return true;
2511}
2512
Nandana Dutt197661d2018-11-16 16:40:21 +00002513void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
2514 options_ = std::move(options);
2515}
2516
Nandana Duttd2f5f082019-01-18 17:13:52 +00002517Dumpstate::RunStatus Dumpstate::Run(int32_t calling_uid, const std::string& calling_package) {
2518 Dumpstate::RunStatus status = RunInternal(calling_uid, calling_package);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002519 if (listener_ != nullptr) {
2520 switch (status) {
2521 case Dumpstate::RunStatus::OK:
Nandana Duttcc4ead82019-01-23 08:29:23 +00002522 listener_->onFinished();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002523 break;
2524 case Dumpstate::RunStatus::HELP:
2525 break;
2526 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002527 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_INVALID_INPUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002528 break;
2529 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002530 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_RUNTIME_ERROR);
2531 break;
2532 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2533 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_DENIED_CONSENT);
2534 break;
2535 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
2536 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_CONSENT_TIMED_OUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002537 break;
2538 }
2539 }
2540 return status;
2541}
2542
Nandana Dutt979388e2018-11-30 16:48:55 +00002543/*
2544 * Dumps relevant information to a bugreport based on the given options.
2545 *
2546 * The bugreport can be dumped to a file or streamed to a socket.
2547 *
2548 * How dumping to file works:
2549 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
2550 * stderr is redirected a log file.
2551 *
2552 * The temporary bugreport is then populated via printfs, dumping contents of files and
2553 * output of commands to stdout.
2554 *
2555 * If zipping, the temporary bugreport file is added to the zip archive. Else it's renamed to final
2556 * text file.
2557 *
2558 * If zipping, a bunch of other files and dumps also get added to the zip archive. The log file also
2559 * gets added to the archive.
2560 *
Nandana Dutt9a76d202019-01-21 15:56:48 +00002561 * Bugreports are first generated in a local directory and later copied to the caller's fd if
2562 * supplied.
Nandana Dutt979388e2018-11-30 16:48:55 +00002563 */
Nandana Duttd2f5f082019-01-18 17:13:52 +00002564Dumpstate::RunStatus Dumpstate::RunInternal(int32_t calling_uid,
2565 const std::string& calling_package) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002566 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00002567 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002568 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002569 return RunStatus::INVALID_INPUT;
2570 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002571 /* set as high priority, and protect from OOM killer */
2572 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002573
Felipe Lemed071c682016-10-20 16:48:00 -07002574 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002575 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002576 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002577 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002578 } else {
2579 /* fallback to kernels <= 2.6.35 */
2580 oom_adj = fopen("/proc/self/oom_adj", "we");
2581 if (oom_adj) {
2582 fputs("-17", oom_adj);
2583 fclose(oom_adj);
2584 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002585 }
2586
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002587 if (version_ == VERSION_DEFAULT) {
2588 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00002589 }
2590
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002591 if (version_ != VERSION_CURRENT && version_ != VERSION_SPLIT_ANR) {
Vishnu Nair64afc022018-02-01 15:29:34 -08002592 MYLOGE("invalid version requested ('%s'); suppported values are: ('%s', '%s', '%s')\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002593 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str(),
Vishnu Nair64afc022018-02-01 15:29:34 -08002594 VERSION_SPLIT_ANR.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002595 return RunStatus::INVALID_INPUT;
Felipe Lemed071c682016-10-20 16:48:00 -07002596 }
2597
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002598 if (options_->show_header_only) {
2599 PrintHeader();
2600 return RunStatus::OK;
Felipe Lemed071c682016-10-20 16:48:00 -07002601 }
2602
Nandana Duttd2f5f082019-01-18 17:13:52 +00002603 if (options_->bugreport_fd.get() != -1) {
2604 // If the output needs to be copied over to the caller's fd, get user consent.
2605 android::String16 package(calling_package.c_str());
2606 CheckUserConsent(calling_uid, package);
2607 }
2608
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002609 // Redirect output if needed
Nandana Dutt9a76d202019-01-21 15:56:48 +00002610 bool is_redirecting = options_->OutputToFile();
Felipe Leme7447d7c2016-11-03 18:12:22 -07002611
2612 // TODO: temporarily set progress until it's part of the Dumpstate constructor
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002613 std::string stats_path =
Nandana Dutt979388e2018-11-30 16:48:55 +00002614 is_redirecting
2615 ? android::base::StringPrintf("%s/dumpstate-stats.txt", bugreport_internal_dir_.c_str())
2616 : "";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002617 progress_.reset(new Progress(stats_path));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002618
Felipe Lemed071c682016-10-20 16:48:00 -07002619 /* gets the sequential id */
Felipe Leme7447d7c2016-11-03 18:12:22 -07002620 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002621 id_ = ++last_id;
Felipe Lemed071c682016-10-20 16:48:00 -07002622 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
2623
2624 MYLOGI("begin\n");
2625
Sahana Raof35ed432019-07-12 10:47:52 +01002626 if (acquire_wake_lock(PARTIAL_WAKE_LOCK, WAKE_LOCK_NAME) < 0) {
2627 MYLOGE("Failed to acquire wake lock: %s\n", strerror(errno));
2628 } else {
2629 // Wake lock will be released automatically on process death
2630 MYLOGD("Wake lock acquired.\n");
2631 }
2632
Felipe Leme6ae5c4f2017-01-10 14:13:22 -08002633 register_sig_handler();
Felipe Lemed071c682016-10-20 16:48:00 -07002634
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002635 // TODO(b/111441001): maybe skip if already started?
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002636 if (options_->do_start_service) {
Felipe Leme75876a22016-10-27 16:31:27 -07002637 MYLOGI("Starting 'dumpstate' service\n");
2638 android::status_t ret;
2639 if ((ret = android::os::DumpstateService::Start()) != android::OK) {
2640 MYLOGE("Unable to start DumpstateService: %d\n", ret);
2641 }
2642 }
2643
Felipe Lemef0292972016-11-22 13:57:05 -08002644 if (PropertiesHelper::IsDryRun()) {
Felipe Lemed071c682016-10-20 16:48:00 -07002645 MYLOGI("Running on dry-run mode (to disable it, call 'setprop dumpstate.dry_run false')\n");
2646 }
2647
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002648 MYLOGI("dumpstate info: id=%d, args='%s', extra_options= %s)\n", id_, options_->args.c_str(),
2649 options_->extra_options.c_str());
Felipe Lemed071c682016-10-20 16:48:00 -07002650
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002651 MYLOGI("bugreport format version: %s\n", version_.c_str());
Felipe Leme809d74e2016-02-02 12:57:00 -08002652
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002653 do_early_screenshot_ = options_->do_progress_updates;
Felipe Lemee338bf62015-12-07 14:03:50 -08002654
Christopher Ferrised9354f2014-10-01 17:35:01 -07002655 // If we are going to use a socket, do it as early as possible
2656 // to avoid timeouts from bugreport.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002657 if (options_->use_socket) {
Nandana Dutta344cb62019-02-22 15:12:35 +00002658 if (!redirect_to_socket(stdout, "dumpstate")) {
2659 return ERROR;
2660 }
Christopher Ferrised9354f2014-10-01 17:35:01 -07002661 }
2662
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002663 if (options_->use_control_socket) {
Felipe Leme2628e9e2016-04-12 16:36:51 -07002664 MYLOGD("Opening control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002665 control_socket_fd_ = open_socket("dumpstate");
Nandana Dutta344cb62019-02-22 15:12:35 +00002666 if (control_socket_fd_ == -1) {
2667 return ERROR;
2668 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002669 options_->do_progress_updates = 1;
Felipe Leme2628e9e2016-04-12 16:36:51 -07002670 }
2671
Felipe Leme71bbfc52015-11-23 14:14:51 -08002672 if (is_redirecting) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002673 PrepareToWriteToFile();
Felipe Leme1e9edc62015-12-21 16:02:13 -08002674
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002675 if (options_->do_progress_updates) {
2676 if (options_->do_broadcast) {
Felipe Lemedcd1f0d2016-08-04 12:48:50 -07002677 // clang-format off
2678 std::vector<std::string> am_args = {
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002679 "--receiver-permission", "android.permission.DUMP",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002680 "--es", "android.intent.extra.NAME", name_,
2681 "--ei", "android.intent.extra.ID", std::to_string(id_),
2682 "--ei", "android.intent.extra.PID", std::to_string(pid_),
2683 "--ei", "android.intent.extra.MAX", std::to_string(progress_->GetMax()),
Felipe Lemedcd1f0d2016-08-04 12:48:50 -07002684 };
2685 // clang-format on
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002686 SendBroadcast("com.android.internal.intent.action.BUGREPORT_STARTED", am_args);
Felipe Lemedcd1f0d2016-08-04 12:48:50 -07002687 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002688 if (options_->use_control_socket) {
2689 dprintf(control_socket_fd_, "BEGIN:%s\n", path_.c_str());
Felipe Lemeaabfcae2016-07-29 09:49:04 -07002690 }
Felipe Leme71bbfc52015-11-23 14:14:51 -08002691 }
2692 }
2693
Nick Kralevichf3599b32016-01-25 15:05:16 -08002694 /* read /proc/cmdline before dropping root */
2695 FILE *cmdline = fopen("/proc/cmdline", "re");
2696 if (cmdline) {
2697 fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
2698 fclose(cmdline);
2699 }
2700
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002701 if (options_->do_vibrate) {
Felipe Leme35b8cf12017-02-10 15:47:29 -08002702 Vibrate(150);
John Michelau1f794c42012-09-17 11:20:19 -05002703 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002704
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002705 if (options_->do_fb && do_early_screenshot_) {
Greg Kaiser3ddc3fa2019-05-23 16:14:52 -07002706 MYLOGI("taking early screenshot\n");
2707 TakeScreenshot();
Felipe Lemee338bf62015-12-07 14:03:50 -08002708 }
2709
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002710 if (options_->do_zip_file && zip_file != nullptr) {
2711 if (chown(path_.c_str(), AID_SHELL, AID_SHELL)) {
2712 MYLOGE("Unable to change ownership of zip file %s: %s\n", path_.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -07002713 strerror(errno));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002714 }
2715 }
2716
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002717 int dup_stdout_fd;
2718 int dup_stderr_fd;
Felipe Leme71bbfc52015-11-23 14:14:51 -08002719 if (is_redirecting) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002720 // Redirect stderr to log_path_ for debugging.
Vishnu Nair20cf5032018-01-05 13:15:49 -08002721 TEMP_FAILURE_RETRY(dup_stderr_fd = dup(fileno(stderr)));
Nandana Dutta344cb62019-02-22 15:12:35 +00002722 if (!redirect_to_file(stderr, const_cast<char*>(log_path_.c_str()))) {
2723 return ERROR;
2724 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002725 if (chown(log_path_.c_str(), AID_SHELL, AID_SHELL)) {
2726 MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n", log_path_.c_str(),
2727 strerror(errno));
Felipe Leme6fe9db62016-02-12 09:04:16 -08002728 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002729
2730 // Redirect stdout to tmp_path_. This is the main bugreport entry and will be
2731 // moved into zip file later, if zipping.
Vishnu Nair20cf5032018-01-05 13:15:49 -08002732 TEMP_FAILURE_RETRY(dup_stdout_fd = dup(fileno(stdout)));
Nandana Dutt979388e2018-11-30 16:48:55 +00002733 // TODO: why not write to a file instead of stdout to overcome this problem?
Felipe Leme6e01fa62015-11-11 19:35:14 -08002734 /* TODO: rather than generating a text file now and zipping it later,
2735 it would be more efficient to redirect stdout to the zip entry
2736 directly, but the libziparchive doesn't support that option yet. */
Nandana Dutta344cb62019-02-22 15:12:35 +00002737 if (!redirect_to_file(stdout, const_cast<char*>(tmp_path_.c_str()))) {
2738 return ERROR;
2739 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002740 if (chown(tmp_path_.c_str(), AID_SHELL, AID_SHELL)) {
Felipe Leme6fe9db62016-02-12 09:04:16 -08002741 MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002742 tmp_path_.c_str(), strerror(errno));
Felipe Leme6fe9db62016-02-12 09:04:16 -08002743 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002744 }
Felipe Lemed8b94e52016-12-08 10:21:44 -08002745
2746 // Don't buffer stdout
2747 setvbuf(stdout, nullptr, _IONBF, 0);
2748
Felipe Leme608385d2016-02-01 10:35:38 -08002749 // NOTE: there should be no stdout output until now, otherwise it would break the header.
2750 // In particular, DurationReport objects should be created passing 'title, NULL', so their
Felipe Lemecbce55d2016-02-08 09:53:18 -08002751 // duration is logged into MYLOG instead.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002752 PrintHeader();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002753
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002754 if (options_->telephony_only) {
Jayachandran Ca94c7172017-06-10 15:08:12 -07002755 DumpstateTelephonyOnly();
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002756 DumpstateBoard();
2757 } else if (options_->wifi_only) {
mukesh agrawal253dad42018-01-23 21:59:59 -08002758 DumpstateWifiOnly();
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002759 } else {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002760 // Dump state for the default case. This also drops root.
Nandana Dutt5c390032019-03-12 10:52:56 +00002761 RunStatus s = DumpstateDefault();
2762 if (s != RunStatus::OK) {
Nandana Duttaac6f582019-07-26 14:32:47 +01002763 if (s == RunStatus::USER_CONSENT_DENIED) {
Nandana Dutt5c390032019-03-12 10:52:56 +00002764 HandleUserConsentDenied();
2765 }
2766 return s;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002767 }
Zhengyin Qian068ecc72016-08-10 16:48:14 -07002768 }
Felipe Leme71a74ac2016-03-17 15:43:25 -07002769
Felipe Leme55b42a62015-11-10 17:39:08 -08002770 /* close output if needed */
Felipe Leme71bbfc52015-11-23 14:14:51 -08002771 if (is_redirecting) {
Vishnu Nair20cf5032018-01-05 13:15:49 -08002772 TEMP_FAILURE_RETRY(dup2(dup_stdout_fd, fileno(stdout)));
Colin Crossf45fa6b2012-03-26 12:38:26 -07002773 }
2774
Nandana Duttd2f5f082019-01-18 17:13:52 +00002775 // Rename, and/or zip the (now complete) .tmp file within the internal directory.
Nandana Dutt9a76d202019-01-21 15:56:48 +00002776 if (options_->OutputToFile()) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002777 FinalizeFile();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002778 }
2779
Nandana Duttd2f5f082019-01-18 17:13:52 +00002780 // Share the final file with the caller if the user has consented.
2781 Dumpstate::RunStatus status = Dumpstate::RunStatus::OK;
2782 if (options_->bugreport_fd.get() != -1) {
2783 status = CopyBugreportIfUserConsented();
2784 if (status != Dumpstate::RunStatus::OK &&
2785 status != Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2786 // Do an early return if there were errors. We make an exception for consent
2787 // timing out because it's possible the user got distracted. In this case the
2788 // bugreport is not shared but made available for manual retrieval.
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002789 MYLOGI("User denied consent. Returning\n");
Nandana Duttd2f5f082019-01-18 17:13:52 +00002790 return status;
2791 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002792 if (options_->do_fb && options_->screenshot_fd.get() != -1) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00002793 bool copy_succeeded = android::os::CopyFileToFd(screenshot_path_,
2794 options_->screenshot_fd.get());
2795 if (copy_succeeded) {
2796 android::os::UnlinkAndLogOnError(screenshot_path_);
2797 }
2798 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002799 if (status == Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2800 MYLOGI(
2801 "Did not receive user consent yet."
2802 " Will not copy the bugreport artifacts to caller.\n");
Abhijeet Kaur57627412019-04-17 16:00:09 +01002803 const String16 incidentcompanion("incidentcompanion");
2804 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
2805 if (ics != nullptr) {
2806 MYLOGD("Canceling user consent request via incidentcompanion service\n");
2807 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
2808 consent_callback_.get());
2809 } else {
2810 MYLOGD("Unable to cancel user consent; incidentcompanion service unavailable\n");
2811 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002812 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00002813 }
2814
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002815 /* vibrate a few but shortly times to let user know it's finished */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002816 if (options_->do_vibrate) {
Takuya Ogawa47f644e2017-12-20 18:09:09 +09002817 for (int i = 0; i < 3; i++) {
2818 Vibrate(75);
2819 usleep((75 + 50) * 1000);
2820 }
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002821 }
2822
Jeff Brown1dc94e32014-09-11 14:15:27 -07002823 /* tell activity manager we're done */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002824 if (options_->do_broadcast) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002825 SendBugreportFinishedBroadcast();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002826 // Note that listener_ is notified in Run();
Jeff Sharkey27f9e6d2013-03-13 15:45:50 -07002827 }
2828
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002829 MYLOGD("Final progress: %d/%d (estimated %d)\n", progress_->Get(), progress_->GetMax(),
2830 progress_->GetInitialMax());
2831 progress_->Save();
2832 MYLOGI("done (id %d)\n", id_);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002833
Felipe Leme107a05f2016-03-08 15:11:15 -08002834 if (is_redirecting) {
Vishnu Nair20cf5032018-01-05 13:15:49 -08002835 TEMP_FAILURE_RETRY(dup2(dup_stderr_fd, fileno(stderr)));
Felipe Leme107a05f2016-03-08 15:11:15 -08002836 }
2837
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002838 if (options_->use_control_socket && control_socket_fd_ != -1) {
Felipe Lemee844a9d2016-09-21 15:01:39 -07002839 MYLOGD("Closing control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002840 close(control_socket_fd_);
Felipe Leme2628e9e2016-04-12 16:36:51 -07002841 }
2842
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002843 tombstone_data_.clear();
2844 anr_data_.clear();
Narayan Kamath6b9516c2017-10-27 11:15:51 +01002845
Nandana Duttd2f5f082019-01-18 17:13:52 +00002846 return (consent_callback_ != nullptr &&
2847 consent_callback_->getResult() == UserConsentResult::UNAVAILABLE)
2848 ? USER_CONSENT_TIMED_OUT
2849 : RunStatus::OK;
2850}
2851
2852void Dumpstate::CheckUserConsent(int32_t calling_uid, const android::String16& calling_package) {
2853 consent_callback_ = new ConsentCallback();
2854 const String16 incidentcompanion("incidentcompanion");
2855 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
2856 if (ics != nullptr) {
2857 MYLOGD("Checking user consent via incidentcompanion service\n");
2858 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
Joe Onorato1c36d752019-03-17 18:26:43 -07002859 calling_uid, calling_package, String16(), String16(),
2860 0x1 /* FLAG_CONFIRMATION_DIALOG */, consent_callback_.get());
Nandana Duttd2f5f082019-01-18 17:13:52 +00002861 } else {
2862 MYLOGD("Unable to check user consent; incidentcompanion service unavailable\n");
2863 }
2864}
2865
Nandana Dutt5c390032019-03-12 10:52:56 +00002866bool Dumpstate::IsUserConsentDenied() const {
2867 return ds.consent_callback_ != nullptr &&
2868 ds.consent_callback_->getResult() == UserConsentResult::DENIED;
2869}
2870
Nandana Duttd2f5f082019-01-18 17:13:52 +00002871void Dumpstate::CleanupFiles() {
2872 android::os::UnlinkAndLogOnError(tmp_path_);
2873 android::os::UnlinkAndLogOnError(screenshot_path_);
2874 android::os::UnlinkAndLogOnError(path_);
2875}
2876
2877Dumpstate::RunStatus Dumpstate::HandleUserConsentDenied() {
2878 MYLOGD("User denied consent; deleting files and returning\n");
2879 CleanupFiles();
2880 return USER_CONSENT_DENIED;
2881}
2882
2883Dumpstate::RunStatus Dumpstate::CopyBugreportIfUserConsented() {
2884 // If the caller has asked to copy the bugreport over to their directory, we need explicit
2885 // user consent.
2886 UserConsentResult consent_result = consent_callback_->getResult();
2887 if (consent_result == UserConsentResult::UNAVAILABLE) {
2888 // User has not responded yet.
2889 uint64_t elapsed_ms = consent_callback_->getElapsedTimeMs();
Hunter Knepshield70610fa2020-01-03 15:27:33 -08002890 // Telephony is a fast report type, particularly on user builds where information may be
2891 // more aggressively limited. To give the user time to read the consent dialog, increase the
2892 // timeout.
2893 uint64_t timeout_ms = options_->telephony_only ? TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS
2894 : USER_CONSENT_TIMEOUT_MS;
2895 if (elapsed_ms < timeout_ms) {
2896 uint delay_seconds = (timeout_ms - elapsed_ms) / 1000;
Nandana Duttd2f5f082019-01-18 17:13:52 +00002897 MYLOGD("Did not receive user consent yet; going to wait for %d seconds", delay_seconds);
2898 sleep(delay_seconds);
2899 }
2900 consent_result = consent_callback_->getResult();
2901 }
2902 if (consent_result == UserConsentResult::DENIED) {
2903 // User has explicitly denied sharing with the app. To be safe delete the
2904 // internal bugreport & tmp files.
2905 return HandleUserConsentDenied();
2906 }
2907 if (consent_result == UserConsentResult::APPROVED) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00002908 bool copy_succeeded = android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
2909 if (copy_succeeded) {
2910 android::os::UnlinkAndLogOnError(path_);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002911 }
2912 return copy_succeeded ? Dumpstate::RunStatus::OK : Dumpstate::RunStatus::ERROR;
2913 } else if (consent_result == UserConsentResult::UNAVAILABLE) {
2914 // consent_result is still UNAVAILABLE. The user has likely not responded yet.
2915 // Since we do not have user consent to share the bugreport it does not get
2916 // copied over to the calling app but remains in the internal directory from
2917 // where the user can manually pull it.
2918 return Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT;
2919 }
2920 // Unknown result; must be a programming error.
2921 MYLOGE("Unknown user consent result:%d\n", consent_result);
2922 return Dumpstate::RunStatus::ERROR;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002923}
2924
Nandana Duttf02564e2019-02-15 15:24:24 +00002925Dumpstate::RunStatus Dumpstate::ParseCommandlineAndRun(int argc, char* argv[]) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002926 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
2927 Dumpstate::RunStatus status = options->Initialize(argc, argv);
2928 if (status == Dumpstate::RunStatus::OK) {
Nandana Duttf02564e2019-02-15 15:24:24 +00002929 SetOptions(std::move(options));
Nandana Duttd2f5f082019-01-18 17:13:52 +00002930 // When directly running dumpstate binary, the output is not expected to be written
2931 // to any external file descriptor.
Nandana Duttf02564e2019-02-15 15:24:24 +00002932 assert(options_->bugreport_fd.get() == -1);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002933
2934 // calling_uid and calling_package are for user consent to share the bugreport with
2935 // an app; they are irrelvant here because bugreport is only written to a local
2936 // directory, and not shared.
Nandana Duttf02564e2019-02-15 15:24:24 +00002937 status = Run(-1 /* calling_uid */, "" /* calling_package */);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002938 }
Nandana Duttf02564e2019-02-15 15:24:24 +00002939 return status;
2940}
2941
2942/* Main entry point for dumpstate binary. */
2943int run_main(int argc, char* argv[]) {
2944 Dumpstate::RunStatus status = ds.ParseCommandlineAndRun(argc, argv);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002945
2946 switch (status) {
2947 case Dumpstate::RunStatus::OK:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002948 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002949 case Dumpstate::RunStatus::HELP:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002950 ShowUsage();
2951 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002952 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002953 fprintf(stderr, "Invalid combination of args\n");
2954 ShowUsage();
2955 exit(1);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002956 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002957 FALLTHROUGH_INTENDED;
2958 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2959 FALLTHROUGH_INTENDED;
2960 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002961 exit(2);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002962 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002963}
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002964
2965// TODO(111441001): Default DumpOptions to sensible values.
2966Dumpstate::Dumpstate(const std::string& version)
2967 : pid_(getpid()),
2968 options_(new Dumpstate::DumpOptions()),
Nandana Duttf02cd782019-06-14 14:25:13 +01002969 last_reported_percent_progress_(0),
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002970 version_(version),
2971 now_(time(nullptr)) {
2972}
2973
2974Dumpstate& Dumpstate::GetInstance() {
2975 static Dumpstate singleton_(android::base::GetProperty("dumpstate.version", VERSION_CURRENT));
2976 return singleton_;
2977}
2978
Nandana Dutt8d945c02019-08-14 13:30:07 +01002979DurationReporter::DurationReporter(const std::string& title, bool logcat_only, bool verbose)
2980 : title_(title), logcat_only_(logcat_only), verbose_(verbose) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002981 if (!title_.empty()) {
2982 started_ = Nanotime();
2983 }
2984}
2985
2986DurationReporter::~DurationReporter() {
2987 if (!title_.empty()) {
2988 float elapsed = (float)(Nanotime() - started_) / NANOS_PER_SEC;
chenqiwuaf8b2d92019-12-12 18:53:51 +08002989 if (elapsed >= .5f || verbose_) {
2990 MYLOGD("Duration of '%s': %.2fs\n", title_.c_str(), elapsed);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002991 }
chenqiwuaf8b2d92019-12-12 18:53:51 +08002992 if (!logcat_only_) {
2993 // Use "Yoda grammar" to make it easier to grep|sort sections.
2994 printf("------ %.3fs was the duration of '%s' ------\n", elapsed, title_.c_str());
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002995 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002996 }
2997}
2998
2999const int32_t Progress::kDefaultMax = 5000;
3000
3001Progress::Progress(const std::string& path) : Progress(Progress::kDefaultMax, 1.1, path) {
3002}
3003
3004Progress::Progress(int32_t initial_max, int32_t progress, float growth_factor)
3005 : Progress(initial_max, growth_factor, "") {
3006 progress_ = progress;
3007}
3008
3009Progress::Progress(int32_t initial_max, float growth_factor, const std::string& path)
3010 : initial_max_(initial_max),
3011 progress_(0),
3012 max_(initial_max),
3013 growth_factor_(growth_factor),
3014 n_runs_(0),
3015 average_max_(0),
3016 path_(path) {
3017 if (!path_.empty()) {
3018 Load();
3019 }
3020}
3021
3022void Progress::Load() {
3023 MYLOGD("Loading stats from %s\n", path_.c_str());
3024 std::string content;
3025 if (!android::base::ReadFileToString(path_, &content)) {
3026 MYLOGI("Could not read stats from %s; using max of %d\n", path_.c_str(), max_);
3027 return;
3028 }
3029 if (content.empty()) {
3030 MYLOGE("No stats (empty file) on %s; using max of %d\n", path_.c_str(), max_);
3031 return;
3032 }
3033 std::vector<std::string> lines = android::base::Split(content, "\n");
3034
3035 if (lines.size() < 1) {
3036 MYLOGE("Invalid stats on file %s: not enough lines (%d). Using max of %d\n", path_.c_str(),
3037 (int)lines.size(), max_);
3038 return;
3039 }
3040 char* ptr;
3041 n_runs_ = strtol(lines[0].c_str(), &ptr, 10);
3042 average_max_ = strtol(ptr, nullptr, 10);
3043 if (n_runs_ <= 0 || average_max_ <= 0 || n_runs_ > STATS_MAX_N_RUNS ||
3044 average_max_ > STATS_MAX_AVERAGE) {
3045 MYLOGE("Invalid stats line on file %s: %s\n", path_.c_str(), lines[0].c_str());
3046 initial_max_ = Progress::kDefaultMax;
3047 } else {
3048 initial_max_ = average_max_;
3049 }
3050 max_ = initial_max_;
3051
3052 MYLOGI("Average max progress: %d in %d runs; estimated max: %d\n", average_max_, n_runs_, max_);
3053}
3054
3055void Progress::Save() {
3056 int32_t total = n_runs_ * average_max_ + progress_;
3057 int32_t runs = n_runs_ + 1;
3058 int32_t average = floor(((float)total) / runs);
3059 MYLOGI("Saving stats (total=%d, runs=%d, average=%d) on %s\n", total, runs, average,
3060 path_.c_str());
3061 if (path_.empty()) {
3062 return;
3063 }
3064
3065 std::string content = android::base::StringPrintf("%d %d\n", runs, average);
3066 if (!android::base::WriteStringToFile(content, path_)) {
3067 MYLOGE("Could not save stats on %s\n", path_.c_str());
3068 }
3069}
3070
3071int32_t Progress::Get() const {
3072 return progress_;
3073}
3074
3075bool Progress::Inc(int32_t delta_sec) {
3076 bool changed = false;
3077 if (delta_sec >= 0) {
3078 progress_ += delta_sec;
3079 if (progress_ > max_) {
3080 int32_t old_max = max_;
3081 max_ = floor((float)progress_ * growth_factor_);
3082 MYLOGD("Adjusting max progress from %d to %d\n", old_max, max_);
3083 changed = true;
3084 }
3085 }
3086 return changed;
3087}
3088
3089int32_t Progress::GetMax() const {
3090 return max_;
3091}
3092
3093int32_t Progress::GetInitialMax() const {
3094 return initial_max_;
3095}
3096
3097void Progress::Dump(int fd, const std::string& prefix) const {
3098 const char* pr = prefix.c_str();
3099 dprintf(fd, "%sprogress: %d\n", pr, progress_);
3100 dprintf(fd, "%smax: %d\n", pr, max_);
3101 dprintf(fd, "%sinitial_max: %d\n", pr, initial_max_);
3102 dprintf(fd, "%sgrowth_factor: %0.2f\n", pr, growth_factor_);
3103 dprintf(fd, "%spath: %s\n", pr, path_.c_str());
3104 dprintf(fd, "%sn_runs: %d\n", pr, n_runs_);
3105 dprintf(fd, "%saverage_max: %d\n", pr, average_max_);
3106}
3107
3108bool Dumpstate::IsZipping() const {
3109 return zip_writer_ != nullptr;
3110}
3111
3112std::string Dumpstate::GetPath(const std::string& suffix) const {
3113 return GetPath(bugreport_internal_dir_, suffix);
3114}
3115
3116std::string Dumpstate::GetPath(const std::string& directory, const std::string& suffix) const {
3117 return android::base::StringPrintf("%s/%s-%s%s", directory.c_str(), base_name_.c_str(),
3118 name_.c_str(), suffix.c_str());
3119}
3120
3121void Dumpstate::SetProgress(std::unique_ptr<Progress> progress) {
3122 progress_ = std::move(progress);
3123}
3124
3125void for_each_userid(void (*func)(int), const char *header) {
3126 std::string title = header == nullptr ? "for_each_userid" : android::base::StringPrintf(
3127 "for_each_userid(%s)", header);
3128 DurationReporter duration_reporter(title);
3129 if (PropertiesHelper::IsDryRun()) return;
3130
3131 DIR *d;
3132 struct dirent *de;
3133
3134 if (header) printf("\n------ %s ------\n", header);
3135 func(0);
3136
3137 if (!(d = opendir("/data/system/users"))) {
3138 printf("Failed to open /data/system/users (%s)\n", strerror(errno));
3139 return;
3140 }
3141
3142 while ((de = readdir(d))) {
3143 int userid;
3144 if (de->d_type != DT_DIR || !(userid = atoi(de->d_name))) {
3145 continue;
3146 }
3147 func(userid);
3148 }
3149
3150 closedir(d);
3151}
3152
3153static void __for_each_pid(void (*helper)(int, const char *, void *), const char *header, void *arg) {
3154 DIR *d;
3155 struct dirent *de;
3156
3157 if (!(d = opendir("/proc"))) {
3158 printf("Failed to open /proc (%s)\n", strerror(errno));
3159 return;
3160 }
3161
3162 if (header) printf("\n------ %s ------\n", header);
3163 while ((de = readdir(d))) {
3164 if (ds.IsUserConsentDenied()) {
3165 MYLOGE(
3166 "Returning early because user denied consent to share bugreport with calling app.");
3167 closedir(d);
3168 return;
3169 }
3170 int pid;
3171 int fd;
3172 char cmdpath[255];
3173 char cmdline[255];
3174
3175 if (!(pid = atoi(de->d_name))) {
3176 continue;
3177 }
3178
3179 memset(cmdline, 0, sizeof(cmdline));
3180
3181 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/cmdline", pid);
3182 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3183 TEMP_FAILURE_RETRY(read(fd, cmdline, sizeof(cmdline) - 2));
3184 close(fd);
3185 if (cmdline[0]) {
3186 helper(pid, cmdline, arg);
3187 continue;
3188 }
3189 }
3190
3191 // if no cmdline, a kernel thread has comm
3192 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/comm", pid);
3193 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3194 TEMP_FAILURE_RETRY(read(fd, cmdline + 1, sizeof(cmdline) - 4));
3195 close(fd);
3196 if (cmdline[1]) {
3197 cmdline[0] = '[';
3198 size_t len = strcspn(cmdline, "\f\b\r\n");
3199 cmdline[len] = ']';
3200 cmdline[len+1] = '\0';
3201 }
3202 }
3203 if (!cmdline[0]) {
3204 strcpy(cmdline, "N/A");
3205 }
3206 helper(pid, cmdline, arg);
3207 }
3208
3209 closedir(d);
3210}
3211
3212static void for_each_pid_helper(int pid, const char *cmdline, void *arg) {
3213 for_each_pid_func *func = (for_each_pid_func*) arg;
3214 func(pid, cmdline);
3215}
3216
3217void for_each_pid(for_each_pid_func func, const char *header) {
3218 std::string title = header == nullptr ? "for_each_pid"
3219 : android::base::StringPrintf("for_each_pid(%s)", header);
3220 DurationReporter duration_reporter(title);
3221 if (PropertiesHelper::IsDryRun()) return;
3222
3223 __for_each_pid(for_each_pid_helper, header, (void *) func);
3224}
3225
3226static void for_each_tid_helper(int pid, const char *cmdline, void *arg) {
3227 DIR *d;
3228 struct dirent *de;
3229 char taskpath[255];
3230 for_each_tid_func *func = (for_each_tid_func *) arg;
3231
3232 snprintf(taskpath, sizeof(taskpath), "/proc/%d/task", pid);
3233
3234 if (!(d = opendir(taskpath))) {
3235 printf("Failed to open %s (%s)\n", taskpath, strerror(errno));
3236 return;
3237 }
3238
3239 func(pid, pid, cmdline);
3240
3241 while ((de = readdir(d))) {
3242 if (ds.IsUserConsentDenied()) {
3243 MYLOGE(
3244 "Returning early because user denied consent to share bugreport with calling app.");
3245 closedir(d);
3246 return;
3247 }
3248 int tid;
3249 int fd;
3250 char commpath[255];
3251 char comm[255];
3252
3253 if (!(tid = atoi(de->d_name))) {
3254 continue;
3255 }
3256
3257 if (tid == pid)
3258 continue;
3259
3260 snprintf(commpath, sizeof(commpath), "/proc/%d/comm", tid);
3261 memset(comm, 0, sizeof(comm));
3262 if ((fd = TEMP_FAILURE_RETRY(open(commpath, O_RDONLY | O_CLOEXEC))) < 0) {
3263 strcpy(comm, "N/A");
3264 } else {
3265 char *c;
3266 TEMP_FAILURE_RETRY(read(fd, comm, sizeof(comm) - 2));
3267 close(fd);
3268
3269 c = strrchr(comm, '\n');
3270 if (c) {
3271 *c = '\0';
3272 }
3273 }
3274 func(pid, tid, comm);
3275 }
3276
3277 closedir(d);
3278}
3279
3280void for_each_tid(for_each_tid_func func, const char *header) {
3281 std::string title = header == nullptr ? "for_each_tid"
3282 : android::base::StringPrintf("for_each_tid(%s)", header);
3283 DurationReporter duration_reporter(title);
3284
3285 if (PropertiesHelper::IsDryRun()) return;
3286
3287 __for_each_pid(for_each_tid_helper, header, (void *) func);
3288}
3289
3290void show_wchan(int pid, int tid, const char *name) {
3291 if (PropertiesHelper::IsDryRun()) return;
3292
3293 char path[255];
3294 char buffer[255];
3295 int fd, ret, save_errno;
3296 char name_buffer[255];
3297
3298 memset(buffer, 0, sizeof(buffer));
3299
3300 snprintf(path, sizeof(path), "/proc/%d/wchan", tid);
3301 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3302 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3303 return;
3304 }
3305
3306 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3307 save_errno = errno;
3308 close(fd);
3309
3310 if (ret < 0) {
3311 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3312 return;
3313 }
3314
3315 snprintf(name_buffer, sizeof(name_buffer), "%*s%s",
3316 pid == tid ? 0 : 3, "", name);
3317
3318 printf("%-7d %-32s %s\n", tid, name_buffer, buffer);
3319
3320 return;
3321}
3322
3323// print time in centiseconds
3324static void snprcent(char *buffer, size_t len, size_t spc,
3325 unsigned long long time) {
3326 static long hz; // cache discovered hz
3327
3328 if (hz <= 0) {
3329 hz = sysconf(_SC_CLK_TCK);
3330 if (hz <= 0) {
3331 hz = 1000;
3332 }
3333 }
3334
3335 // convert to centiseconds
3336 time = (time * 100 + (hz / 2)) / hz;
3337
3338 char str[16];
3339
3340 snprintf(str, sizeof(str), " %llu.%02u",
3341 time / 100, (unsigned)(time % 100));
3342 size_t offset = strlen(buffer);
3343 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3344 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3345}
3346
3347// print permille as a percent
3348static void snprdec(char *buffer, size_t len, size_t spc, unsigned permille) {
3349 char str[16];
3350
3351 snprintf(str, sizeof(str), " %u.%u%%", permille / 10, permille % 10);
3352 size_t offset = strlen(buffer);
3353 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3354 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3355}
3356
3357void show_showtime(int pid, const char *name) {
3358 if (PropertiesHelper::IsDryRun()) return;
3359
3360 char path[255];
3361 char buffer[1023];
3362 int fd, ret, save_errno;
3363
3364 memset(buffer, 0, sizeof(buffer));
3365
3366 snprintf(path, sizeof(path), "/proc/%d/stat", pid);
3367 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3368 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3369 return;
3370 }
3371
3372 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3373 save_errno = errno;
3374 close(fd);
3375
3376 if (ret < 0) {
3377 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3378 return;
3379 }
3380
3381 // field 14 is utime
3382 // field 15 is stime
3383 // field 42 is iotime
3384 unsigned long long utime = 0, stime = 0, iotime = 0;
3385 if (sscanf(buffer,
3386 "%*u %*s %*s %*d %*d %*d %*d %*d %*d %*d %*d "
3387 "%*d %*d %llu %llu %*d %*d %*d %*d %*d %*d "
3388 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %*d "
3389 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %llu ",
3390 &utime, &stime, &iotime) != 3) {
3391 return;
3392 }
3393
3394 unsigned long long total = utime + stime;
3395 if (!total) {
3396 return;
3397 }
3398
3399 unsigned permille = (iotime * 1000 + (total / 2)) / total;
3400 if (permille > 1000) {
3401 permille = 1000;
3402 }
3403
3404 // try to beautify and stabilize columns at <80 characters
3405 snprintf(buffer, sizeof(buffer), "%-6d%s", pid, name);
3406 if ((name[0] != '[') || utime) {
3407 snprcent(buffer, sizeof(buffer), 57, utime);
3408 }
3409 snprcent(buffer, sizeof(buffer), 65, stime);
3410 if ((name[0] != '[') || iotime) {
3411 snprcent(buffer, sizeof(buffer), 73, iotime);
3412 }
3413 if (iotime) {
3414 snprdec(buffer, sizeof(buffer), 79, permille);
3415 }
3416 puts(buffer); // adds a trailing newline
3417
3418 return;
3419}
3420
3421void do_dmesg() {
3422 const char *title = "KERNEL LOG (dmesg)";
3423 DurationReporter duration_reporter(title);
3424 printf("------ %s ------\n", title);
3425
3426 if (PropertiesHelper::IsDryRun()) return;
3427
3428 /* Get size of kernel buffer */
3429 int size = klogctl(KLOG_SIZE_BUFFER, nullptr, 0);
3430 if (size <= 0) {
3431 printf("Unexpected klogctl return value: %d\n\n", size);
3432 return;
3433 }
3434 char *buf = (char *) malloc(size + 1);
3435 if (buf == nullptr) {
3436 printf("memory allocation failed\n\n");
3437 return;
3438 }
3439 int retval = klogctl(KLOG_READ_ALL, buf, size);
3440 if (retval < 0) {
3441 printf("klogctl failure\n\n");
3442 free(buf);
3443 return;
3444 }
3445 buf[retval] = '\0';
3446 printf("%s\n\n", buf);
3447 free(buf);
3448 return;
3449}
3450
3451void do_showmap(int pid, const char *name) {
3452 char title[255];
3453 char arg[255];
3454
3455 snprintf(title, sizeof(title), "SHOW MAP %d (%s)", pid, name);
3456 snprintf(arg, sizeof(arg), "%d", pid);
3457 RunCommand(title, {"showmap", "-q", arg}, CommandOptions::AS_ROOT);
3458}
3459
3460int Dumpstate::DumpFile(const std::string& title, const std::string& path) {
3461 DurationReporter duration_reporter(title);
3462
3463 int status = DumpFileToFd(STDOUT_FILENO, title, path);
3464
3465 UpdateProgress(WEIGHT_FILE);
3466
3467 return status;
3468}
3469
3470int read_file_as_long(const char *path, long int *output) {
3471 int fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC));
3472 if (fd < 0) {
3473 int err = errno;
3474 MYLOGE("Error opening file descriptor for %s: %s\n", path, strerror(err));
3475 return -1;
3476 }
3477 char buffer[50];
3478 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3479 if (bytes_read == -1) {
3480 MYLOGE("Error reading file %s: %s\n", path, strerror(errno));
3481 return -2;
3482 }
3483 if (bytes_read == 0) {
3484 MYLOGE("File %s is empty\n", path);
3485 return -3;
3486 }
3487 *output = atoi(buffer);
3488 return 0;
3489}
3490
3491/* calls skip to gate calling dump_from_fd recursively
3492 * in the specified directory. dump_from_fd defaults to
3493 * dump_file_from_fd above when set to NULL. skip defaults
3494 * to false when set to NULL. dump_from_fd will always be
3495 * called with title NULL.
3496 */
3497int dump_files(const std::string& title, const char* dir, bool (*skip)(const char* path),
3498 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
3499 DurationReporter duration_reporter(title);
3500 DIR *dirp;
3501 struct dirent *d;
3502 char *newpath = nullptr;
3503 const char *slash = "/";
3504 int retval = 0;
3505
3506 if (!title.empty()) {
3507 printf("------ %s (%s) ------\n", title.c_str(), dir);
3508 }
3509 if (PropertiesHelper::IsDryRun()) return 0;
3510
3511 if (dir[strlen(dir) - 1] == '/') {
3512 ++slash;
3513 }
3514 dirp = opendir(dir);
3515 if (dirp == nullptr) {
3516 retval = -errno;
3517 MYLOGE("%s: %s\n", dir, strerror(errno));
3518 return retval;
3519 }
3520
3521 if (!dump_from_fd) {
3522 dump_from_fd = dump_file_from_fd;
3523 }
3524 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
3525 if ((d->d_name[0] == '.')
3526 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
3527 || (d->d_name[1] == '\0'))) {
3528 continue;
3529 }
3530 asprintf(&newpath, "%s%s%s%s", dir, slash, d->d_name,
3531 (d->d_type == DT_DIR) ? "/" : "");
3532 if (!newpath) {
3533 retval = -errno;
3534 continue;
3535 }
3536 if (skip && (*skip)(newpath)) {
3537 continue;
3538 }
3539 if (d->d_type == DT_DIR) {
3540 int ret = dump_files("", newpath, skip, dump_from_fd);
3541 if (ret < 0) {
3542 retval = ret;
3543 }
3544 continue;
3545 }
3546 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(newpath, O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
3547 if (fd.get() < 0) {
3548 retval = -1;
3549 printf("*** %s: %s\n", newpath, strerror(errno));
3550 continue;
3551 }
3552 (*dump_from_fd)(nullptr, newpath, fd.get());
3553 }
3554 closedir(dirp);
3555 if (!title.empty()) {
3556 printf("\n");
3557 }
3558 return retval;
3559}
3560
3561/* fd must have been opened with the flag O_NONBLOCK. With this flag set,
3562 * it's possible to avoid issues where opening the file itself can get
3563 * stuck.
3564 */
3565int dump_file_from_fd(const char *title, const char *path, int fd) {
3566 if (PropertiesHelper::IsDryRun()) return 0;
3567
3568 int flags = fcntl(fd, F_GETFL);
3569 if (flags == -1) {
3570 printf("*** %s: failed to get flags on fd %d: %s\n", path, fd, strerror(errno));
3571 return -1;
3572 } else if (!(flags & O_NONBLOCK)) {
3573 printf("*** %s: fd must have O_NONBLOCK set.\n", path);
3574 return -1;
3575 }
3576 return DumpFileFromFdToFd(title, path, fd, STDOUT_FILENO, PropertiesHelper::IsDryRun());
3577}
3578
3579int Dumpstate::RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Nandana Dutt8d945c02019-08-14 13:30:07 +01003580 const CommandOptions& options, bool verbose_duration) {
3581 DurationReporter duration_reporter(title, false /* logcat_only */, verbose_duration);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003582
3583 int status = RunCommandToFd(STDOUT_FILENO, title, full_command, options);
3584
3585 /* TODO: for now we're simplifying the progress calculation by using the
3586 * timeout as the weight. It's a good approximation for most cases, except when calling dumpsys,
3587 * where its weight should be much higher proportionally to its timeout.
3588 * Ideally, it should use a options.EstimatedDuration() instead...*/
3589 UpdateProgress(options.Timeout());
3590
3591 return status;
3592}
3593
3594void Dumpstate::RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsys_args,
3595 const CommandOptions& options, long dumpsysTimeoutMs) {
3596 long timeout_ms = dumpsysTimeoutMs > 0 ? dumpsysTimeoutMs : options.TimeoutInMs();
3597 std::vector<std::string> dumpsys = {"/system/bin/dumpsys", "-T", std::to_string(timeout_ms)};
3598 dumpsys.insert(dumpsys.end(), dumpsys_args.begin(), dumpsys_args.end());
3599 RunCommand(title, dumpsys, options);
3600}
3601
3602int open_socket(const char *service) {
3603 int s = android_get_control_socket(service);
3604 if (s < 0) {
3605 MYLOGE("android_get_control_socket(%s): %s\n", service, strerror(errno));
3606 return -1;
3607 }
3608 fcntl(s, F_SETFD, FD_CLOEXEC);
3609
3610 // Set backlog to 0 to make sure that queue size will be minimum.
3611 // In Linux, because the minimum queue will be 1, connect() will be blocked
3612 // if the other clients already called connect() and the connection request was not accepted.
3613 if (listen(s, 0) < 0) {
3614 MYLOGE("listen(control socket): %s\n", strerror(errno));
3615 return -1;
3616 }
3617
3618 struct sockaddr addr;
3619 socklen_t alen = sizeof(addr);
Abhijeet Kaur2113cae2019-09-13 09:24:15 +01003620 int fd = accept4(s, &addr, &alen, SOCK_CLOEXEC);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003621
3622 // Close socket just after accept(), to make sure that connect() by client will get error
3623 // when the socket is used by the other services.
3624 // There is still a race condition possibility between accept and close, but there is no way
3625 // to close-on-accept atomically.
3626 // See detail; b/123306389#comment25
3627 close(s);
3628
3629 if (fd < 0) {
3630 MYLOGE("accept(control socket): %s\n", strerror(errno));
3631 return -1;
3632 }
3633
3634 return fd;
3635}
3636
3637/* redirect output to a service control socket */
3638bool redirect_to_socket(FILE* redirect, const char* service) {
3639 int fd = open_socket(service);
3640 if (fd == -1) {
3641 return false;
3642 }
3643 fflush(redirect);
3644 // TODO: handle dup2 failure
3645 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
3646 close(fd);
3647 return true;
3648}
3649
3650// TODO: should call is_valid_output_file and/or be merged into it.
3651void create_parent_dirs(const char *path) {
3652 char *chp = const_cast<char *> (path);
3653
3654 /* skip initial slash */
3655 if (chp[0] == '/')
3656 chp++;
3657
3658 /* create leading directories, if necessary */
3659 struct stat dir_stat;
3660 while (chp && chp[0]) {
3661 chp = strchr(chp, '/');
3662 if (chp) {
3663 *chp = 0;
3664 if (stat(path, &dir_stat) == -1 || !S_ISDIR(dir_stat.st_mode)) {
3665 MYLOGI("Creating directory %s\n", path);
3666 if (mkdir(path, 0770)) { /* drwxrwx--- */
3667 MYLOGE("Unable to create directory %s: %s\n", path, strerror(errno));
3668 } else if (chown(path, AID_SHELL, AID_SHELL)) {
3669 MYLOGE("Unable to change ownership of dir %s: %s\n", path, strerror(errno));
3670 }
3671 }
3672 *chp++ = '/';
3673 }
3674 }
3675}
3676
3677bool _redirect_to_file(FILE* redirect, char* path, int truncate_flag) {
3678 create_parent_dirs(path);
3679
3680 int fd = TEMP_FAILURE_RETRY(open(path,
3681 O_WRONLY | O_CREAT | truncate_flag | O_CLOEXEC | O_NOFOLLOW,
3682 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH));
3683 if (fd < 0) {
3684 MYLOGE("%s: %s\n", path, strerror(errno));
3685 return false;
3686 }
3687
3688 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
3689 close(fd);
3690 return true;
3691}
3692
3693bool redirect_to_file(FILE* redirect, char* path) {
3694 return _redirect_to_file(redirect, path, O_TRUNC);
3695}
3696
3697bool redirect_to_existing_file(FILE* redirect, char* path) {
3698 return _redirect_to_file(redirect, path, O_APPEND);
3699}
3700
3701void dump_route_tables() {
3702 DurationReporter duration_reporter("DUMP ROUTE TABLES");
3703 if (PropertiesHelper::IsDryRun()) return;
3704 const char* const RT_TABLES_PATH = "/data/misc/net/rt_tables";
3705 ds.DumpFile("RT_TABLES", RT_TABLES_PATH);
3706 FILE* fp = fopen(RT_TABLES_PATH, "re");
3707 if (!fp) {
3708 printf("*** %s: %s\n", RT_TABLES_PATH, strerror(errno));
3709 return;
3710 }
3711 char table[16];
3712 // Each line has an integer (the table number), a space, and a string (the table name). We only
3713 // need the table number. It's a 32-bit unsigned number, so max 10 chars. Skip the table name.
3714 // Add a fixed max limit so this doesn't go awry.
3715 for (int i = 0; i < 64 && fscanf(fp, " %10s %*s", table) == 1; ++i) {
3716 RunCommand("ROUTE TABLE IPv4", {"ip", "-4", "route", "show", "table", table});
3717 RunCommand("ROUTE TABLE IPv6", {"ip", "-6", "route", "show", "table", table});
3718 }
3719 fclose(fp);
3720}
3721
3722// TODO: make this function thread safe if sections are generated in parallel.
3723void Dumpstate::UpdateProgress(int32_t delta_sec) {
3724 if (progress_ == nullptr) {
3725 MYLOGE("UpdateProgress: progress_ not set\n");
3726 return;
3727 }
3728
3729 // Always update progess so stats can be tuned...
Nandana Duttf02cd782019-06-14 14:25:13 +01003730 progress_->Inc(delta_sec);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003731
3732 // ...but only notifiy listeners when necessary.
3733 if (!options_->do_progress_updates) return;
3734
3735 int progress = progress_->Get();
3736 int max = progress_->GetMax();
Nandana Duttf02cd782019-06-14 14:25:13 +01003737 int percent = 100 * progress / max;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003738
Nandana Duttf02cd782019-06-14 14:25:13 +01003739 if (last_reported_percent_progress_ > 0 && percent <= last_reported_percent_progress_) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003740 return;
3741 }
Nandana Duttf02cd782019-06-14 14:25:13 +01003742 last_reported_percent_progress_ = percent;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003743
3744 if (control_socket_fd_ >= 0) {
3745 dprintf(control_socket_fd_, "PROGRESS:%d/%d\n", progress, max);
3746 fsync(control_socket_fd_);
3747 }
3748
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003749 if (listener_ != nullptr) {
3750 if (percent % 5 == 0) {
3751 // We don't want to spam logcat, so only log multiples of 5.
3752 MYLOGD("Setting progress (%s): %d/%d (%d%%)\n", listener_name_.c_str(), progress, max,
3753 percent);
3754 } else {
3755 // stderr is ignored on normal invocations, but useful when calling
3756 // /system/bin/dumpstate directly for debuggging.
3757 fprintf(stderr, "Setting progress (%s): %d/%d (%d%%)\n", listener_name_.c_str(),
3758 progress, max, percent);
3759 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003760
3761 listener_->onProgress(percent);
3762 }
3763}
3764
3765void Dumpstate::TakeScreenshot(const std::string& path) {
3766 const std::string& real_path = path.empty() ? screenshot_path_ : path;
3767 int status =
3768 RunCommand("", {"/system/bin/screencap", "-p", real_path},
3769 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3770 if (status == 0) {
3771 MYLOGD("Screenshot saved on %s\n", real_path.c_str());
3772 } else {
3773 MYLOGE("Failed to take screenshot on %s\n", real_path.c_str());
3774 }
3775}
3776
3777bool is_dir(const char* pathname) {
3778 struct stat info;
3779 if (stat(pathname, &info) == -1) {
3780 return false;
3781 }
3782 return S_ISDIR(info.st_mode);
3783}
3784
3785time_t get_mtime(int fd, time_t default_mtime) {
3786 struct stat info;
3787 if (fstat(fd, &info) == -1) {
3788 return default_mtime;
3789 }
3790 return info.st_mtime;
3791}