blob: 310b5cecf06010ee108576bda39f23d57b9fa847 [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
Nandana Dutt5c390032019-03-12 10:52:56 +00001440 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(ds.DumpstateBoard);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001441
Steven Moreland7440ddb2016-12-15 16:13:39 -08001442 /* Migrate the ril_dumpstate to a device specific dumpstate? */
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001443 int rilDumpstateTimeout = android::base::GetIntProperty("ril.dumpstate.timeout", 0);
1444 if (rilDumpstateTimeout > 0) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001445 // su does not exist on user builds, so try running without it.
1446 // This way any implementations of vril-dump that do not require
1447 // root can run on user builds.
1448 CommandOptions::CommandOptionsBuilder options =
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001449 CommandOptions::WithTimeout(rilDumpstateTimeout);
Felipe Lemef0292972016-11-22 13:57:05 -08001450 if (!PropertiesHelper::IsUserBuild()) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001451 options.AsRoot();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001452 }
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001453 RunCommand("DUMP VENDOR RIL LOGS", {"vril-dump"}, options.Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -07001454 }
1455
Felipe Lemed8b94e52016-12-08 10:21:44 -08001456 printf("========================================================\n");
1457 printf("== Android Framework Services\n");
1458 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001459
Nandana Dutt5c390032019-03-12 10:52:56 +00001460 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysNormal);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001461
Felipe Lemed8b94e52016-12-08 10:21:44 -08001462 printf("========================================================\n");
1463 printf("== Checkins\n");
1464 printf("========================================================\n");
Dianne Hackborn02bea972013-06-26 18:59:09 -07001465
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001466 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001467
1468 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsys, "CHECKIN MEMINFO", {"meminfo", "--checkin"});
1469
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001470 RunDumpsys("CHECKIN NETSTATS", {"netstats", "--checkin"});
1471 RunDumpsys("CHECKIN PROCSTATS", {"procstats", "-c"});
1472 RunDumpsys("CHECKIN USAGESTATS", {"usagestats", "-c"});
1473 RunDumpsys("CHECKIN PACKAGE", {"package", "--checkin"});
Dianne Hackborn02bea972013-06-26 18:59:09 -07001474
Felipe Lemed8b94e52016-12-08 10:21:44 -08001475 printf("========================================================\n");
1476 printf("== Running Application Activities\n");
1477 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001478
Makoto Onuki60780982018-04-16 15:34:00 -07001479 // The following dumpsys internally collects output from running apps, so it can take a long
1480 // time. So let's extend the timeout.
1481
1482 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
1483
1484 RunDumpsys("APP ACTIVITIES", {"activity", "-v", "all"}, DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001485
Felipe Lemed8b94e52016-12-08 10:21:44 -08001486 printf("========================================================\n");
Makoto Onuki60780982018-04-16 15:34:00 -07001487 printf("== Running Application Services (platform)\n");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001488 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001489
Vishnu Nairc6e6ea72018-07-02 14:20:06 -07001490 RunDumpsys("APP SERVICES PLATFORM", {"activity", "service", "all-platform-non-critical"},
Makoto Onuki60780982018-04-16 15:34:00 -07001491 DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001492
Felipe Lemed8b94e52016-12-08 10:21:44 -08001493 printf("========================================================\n");
Makoto Onuki60780982018-04-16 15:34:00 -07001494 printf("== Running Application Services (non-platform)\n");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001495 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001496
Makoto Onuki60780982018-04-16 15:34:00 -07001497 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1498 DUMPSYS_COMPONENTS_OPTIONS);
1499
1500 printf("========================================================\n");
1501 printf("== Running Application Providers (platform)\n");
1502 printf("========================================================\n");
1503
1504 RunDumpsys("APP PROVIDERS PLATFORM", {"activity", "provider", "all-platform"},
1505 DUMPSYS_COMPONENTS_OPTIONS);
1506
1507 printf("========================================================\n");
1508 printf("== Running Application Providers (non-platform)\n");
1509 printf("========================================================\n");
1510
1511 RunDumpsys("APP PROVIDERS NON-PLATFORM", {"activity", "provider", "all-non-platform"},
1512 DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001513
Adrian Roos8b397ab2017-04-04 16:35:44 -07001514 printf("========================================================\n");
1515 printf("== Dropbox crashes\n");
1516 printf("========================================================\n");
1517
1518 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1519 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1520
Felipe Lemed8b94e52016-12-08 10:21:44 -08001521 printf("========================================================\n");
1522 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1523 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1524 printf("========================================================\n");
1525 printf("== dumpstate: done (id %d)\n", ds.id_);
1526 printf("========================================================\n");
Bookatz38472142018-09-28 10:20:24 -07001527
1528 printf("========================================================\n");
1529 printf("== Obtaining statsd metadata\n");
1530 printf("========================================================\n");
1531 // This differs from the usual dumpsys stats, which is the stats report data.
1532 RunDumpsys("STATSDSTATS", {"stats", "--metadata"});
Mike Ma5c267872019-08-21 11:31:34 -07001533
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +09001534 // Add linker configuration directory
1535 ds.AddDir(LINKERCONFIG_DIR, true);
1536
Mike Ma5c267872019-08-21 11:31:34 -07001537 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpIncidentReport);
1538
Nandana Dutt5c390032019-03-12 10:52:56 +00001539 return Dumpstate::RunStatus::OK;
Colin Crossf45fa6b2012-03-26 12:38:26 -07001540}
1541
Nandana Dutt5c390032019-03-12 10:52:56 +00001542/*
1543 * Dumps state for the default case; drops root after it's no longer necessary.
1544 *
1545 * Returns RunStatus::OK if everything went fine.
1546 * Returns RunStatus::ERROR if there was an error.
1547 * Returns RunStatus::USER_DENIED_CONSENT if user explicitly denied consent to sharing the bugreport
1548 * with the caller.
1549 */
1550static Dumpstate::RunStatus DumpstateDefault() {
Nandana Duttcf419a72019-03-14 10:40:17 +00001551 // Invoking the following dumpsys calls before DumpTraces() to try and
Nandana Dutt4be45d12018-09-26 15:04:23 +01001552 // keep the system stats as close to its initial state as possible.
Nandana Dutt5c390032019-03-12 10:52:56 +00001553 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysCritical);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001554
Nandana Duttdb379fa2019-10-09 16:54:41 +01001555 // Capture first logcat early on; useful to take a snapshot before dumpstate logs take over the
1556 // buffer.
1557 DoLogcat();
1558 // Capture timestamp after first logcat to use in next logcat
1559 time_t logcat_ts = time(nullptr);
1560
Nandana Dutt4be45d12018-09-26 15:04:23 +01001561 /* collect stack traces from Dalvik and native processes (needs root) */
Nandana Duttcf419a72019-03-14 10:40:17 +00001562 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(ds.DumpTraces, &dump_traces_path);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001563
1564 /* Run some operations that require root. */
1565 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX, !ds.IsZipping());
1566 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX, !ds.IsZipping());
1567
1568 ds.AddDir(RECOVERY_DIR, true);
1569 ds.AddDir(RECOVERY_DATA_DIR, true);
1570 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
1571 ds.AddDir(LOGPERSIST_DATA_DIR, false);
Yifan Hong0efa7972020-02-03 16:45:02 -08001572 ds.AddDir(SNAPSHOTCTL_LOG_DIR, false);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001573 if (!PropertiesHelper::IsUserBuild()) {
1574 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1575 ds.AddDir(PROFILE_DATA_DIR_REF, true);
1576 }
Jerry Changa1df8a92020-01-02 16:03:39 +08001577 ds.AddDir(PREREBOOT_DATA_DIR, false);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001578 add_mountinfo();
1579 DumpIpTablesAsRoot();
David Andersond9ba4752018-12-11 18:26:59 -08001580 DumpDynamicPartitionInfo();
Yifan Hong3945e1b2019-10-29 12:59:23 -07001581 ds.AddDir(OTA_METADATA_DIR, true);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001582
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001583 // Capture any IPSec policies in play. No keys are exposed here.
Nandana Dutt4be45d12018-09-26 15:04:23 +01001584 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1585
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001586 // Dump IPsec stats. No keys are exposed here.
1587 DumpFile("XFRM STATS", XFRM_STAT_PROC_FILE);
1588
Nandana Dutt4be45d12018-09-26 15:04:23 +01001589 // Run ss as root so we can see socket marks.
1590 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
1591
1592 // Run iotop as root to show top 100 IO threads
1593 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
1594
Erick Reyese68df822019-02-11 14:46:36 -08001595 // Gather shared memory buffer info if the product implements it
1596 struct stat st;
1597 if (!stat("/product/bin/dmabuf_dump", &st)) {
1598 RunCommand("Dmabuf dump", {"/product/bin/dmabuf_dump"});
1599 }
1600
Minchan Kim22c6a1e2019-09-30 15:58:10 -07001601 DumpFile("PSI cpu", "/proc/pressure/cpu");
1602 DumpFile("PSI memory", "/proc/pressure/memory");
1603 DumpFile("PSI io", "/proc/pressure/io");
1604
Nandana Dutt4be45d12018-09-26 15:04:23 +01001605 if (!DropRootUser()) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001606 return Dumpstate::RunStatus::ERROR;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001607 }
1608
Nandana Dutt5c390032019-03-12 10:52:56 +00001609 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttdb379fa2019-10-09 16:54:41 +01001610 Dumpstate::RunStatus status = dumpstate();
1611 // Capture logcat since the last time we did it.
1612 DoSystemLogcat(logcat_ts);
1613 return status;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001614}
1615
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001616// This method collects common dumpsys for telephony and wifi. Typically, wifi
1617// reports are fine to include all information, but telephony reports on user
1618// builds need to strip some content (see DumpstateTelephonyOnly).
1619static void DumpstateRadioCommon(bool include_sensitive_info = true) {
Jayachandran Ca94c7172017-06-10 15:08:12 -07001620 DumpIpTablesAsRoot();
1621
Jayachandran C69968272019-07-08 09:46:05 -07001622 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1623
Jayachandran Ca94c7172017-06-10 15:08:12 -07001624 if (!DropRootUser()) {
1625 return;
1626 }
1627
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001628 // We need to be picky about some stuff for telephony reports on user builds.
1629 if (!include_sensitive_info) {
1630 // Only dump the radio log buffer (other buffers and dumps contain too much unrelated info).
1631 DoRadioLogcat();
1632 } else {
1633 // Contains various system properties and process startup info.
1634 do_dmesg();
1635 // Logs other than the radio buffer may contain package/component names and potential PII.
1636 DoLogcat();
1637 // Too broad for connectivity problems.
1638 DoKmsg();
1639 // Contains unrelated hardware info (camera, NFC, biometrics, ...).
1640 DumpHals();
1641 }
1642
Jayachandran Ca94c7172017-06-10 15:08:12 -07001643 DumpPacketStats();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001644 DumpIpAddrAndRules();
1645 dump_route_tables();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001646 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
1647 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08001648}
1649
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001650// We use "telephony" here for legacy reasons, though this now really means "connectivity" (cellular
1651// + wifi + networking). This method collects dumpsys for connectivity debugging only. General rules
1652// for what can be included on user builds: all reported information MUST directly relate to
1653// connectivity debugging or customer support and MUST NOT contain unrelated personally identifiable
1654// information. This information MUST NOT identify user-installed packages (UIDs are OK, package
1655// names are not), and MUST NOT contain logs of user application traffic.
1656// TODO(b/148168577) rename this and other related fields/methods to "connectivity" instead.
mukesh agrawal253dad42018-01-23 21:59:59 -08001657static void DumpstateTelephonyOnly() {
1658 DurationReporter duration_reporter("DUMPSTATE");
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001659
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001660 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08001661
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001662 const bool include_sensitive_info = !PropertiesHelper::IsUserBuild();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001663
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001664 DumpstateRadioCommon(include_sensitive_info);
1665
1666 if (include_sensitive_info) {
1667 // Contains too much unrelated PII, and given the unstructured nature of sysprops, we can't
1668 // really cherrypick all of the connectivity-related ones. Apps generally have no business
1669 // reading these anyway, and there should be APIs to supply the info in a more app-friendly
1670 // way.
1671 RunCommand("SYSTEM PROPERTIES", {"getprop"});
1672 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07001673
1674 printf("========================================================\n");
1675 printf("== Android Framework Services\n");
1676 printf("========================================================\n");
1677
Vishnu Nair652cc802017-11-30 15:18:30 -08001678 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1679 SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001680 // TODO(b/146521742) build out an argument to include bound services here for user builds
Vishnu Nair652cc802017-11-30 15:18:30 -08001681 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
1682 SEC_TO_MSEC(10));
Amruth Ramachandrand25a9142018-04-02 16:16:09 -07001683 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
1684 SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001685 RunDumpsys("DUMPSYS", {"netpolicy"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
1686 RunDumpsys("DUMPSYS", {"network_management"}, CommandOptions::WithTimeout(90).Build(),
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07001687 SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001688 if (include_sensitive_info) {
1689 // Contains raw IP addresses, omit from reports on user builds.
1690 RunDumpsys("DUMPSYS", {"netd"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
1691 // Contains raw destination IP/MAC addresses, omit from reports on user builds.
1692 RunDumpsys("DUMPSYS", {"connmetrics"}, CommandOptions::WithTimeout(90).Build(),
1693 SEC_TO_MSEC(10));
1694 // Contains package/component names, omit from reports on user builds.
1695 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
1696 SEC_TO_MSEC(10));
1697 // Contains package names, but should be relatively simple to remove them (also contains
1698 // UIDs already), omit from reports on user builds.
1699 RunDumpsys("BATTERYSTATS", {"deviceidle"}, CommandOptions::WithTimeout(90).Build(),
1700 SEC_TO_MSEC(10));
1701 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07001702
1703 printf("========================================================\n");
1704 printf("== Running Application Services\n");
1705 printf("========================================================\n");
1706
1707 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
1708
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001709 if (include_sensitive_info) {
1710 printf("========================================================\n");
1711 printf("== Running Application Services (non-platform)\n");
1712 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001713
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001714 // Contains package/component names and potential PII, omit from reports on user builds.
1715 // To get dumps of the active CarrierService(s) on user builds, we supply an argument to the
1716 // carrier_config dumpsys instead.
1717 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1718 DUMPSYS_COMPONENTS_OPTIONS);
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001719
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001720 printf("========================================================\n");
1721 printf("== Checkins\n");
1722 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07001723
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001724 // Contains package/component names, omit from reports on user builds.
1725 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
1726 }
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07001727
1728 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07001729 printf("== dumpstate: done (id %d)\n", ds.id_);
1730 printf("========================================================\n");
1731}
1732
mukesh agrawal253dad42018-01-23 21:59:59 -08001733// This method collects dumpsys for wifi debugging only
1734static void DumpstateWifiOnly() {
1735 DurationReporter duration_reporter("DUMPSTATE");
1736
1737 DumpstateRadioCommon();
1738
1739 printf("========================================================\n");
1740 printf("== Android Framework Services\n");
1741 printf("========================================================\n");
1742
1743 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1744 SEC_TO_MSEC(10));
1745 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
1746 SEC_TO_MSEC(10));
1747
1748 printf("========================================================\n");
1749 printf("== dumpstate: done (id %d)\n", ds.id_);
1750 printf("========================================================\n");
1751}
1752
Nandana Duttcf419a72019-03-14 10:40:17 +00001753Dumpstate::RunStatus Dumpstate::DumpTraces(const char** path) {
Nandana Duttfaafd522019-03-11 09:23:09 +00001754 DurationReporter duration_reporter("DUMP TRACES");
1755
1756 const std::string temp_file_pattern = "/data/anr/dumptrace_XXXXXX";
1757 const size_t buf_size = temp_file_pattern.length() + 1;
1758 std::unique_ptr<char[]> file_name_buf(new char[buf_size]);
1759 memcpy(file_name_buf.get(), temp_file_pattern.c_str(), buf_size);
1760
1761 // Create a new, empty file to receive all trace dumps.
1762 //
1763 // TODO: This can be simplified once we remove support for the old style
1764 // dumps. We can have a file descriptor passed in to dump_traces instead
1765 // of creating a file, closing it and then reopening it again.
1766 android::base::unique_fd fd(mkostemp(file_name_buf.get(), O_APPEND | O_CLOEXEC));
1767 if (fd < 0) {
1768 MYLOGE("mkostemp on pattern %s: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001769 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001770 }
1771
1772 // Nobody should have access to this temporary file except dumpstate, but we
1773 // temporarily grant 'read' to 'others' here because this file is created
1774 // when tombstoned is still running as root, but dumped after dropping. This
1775 // can go away once support for old style dumping has.
1776 const int chmod_ret = fchmod(fd, 0666);
1777 if (chmod_ret < 0) {
1778 MYLOGE("fchmod on %s failed: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001779 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001780 }
1781
1782 std::unique_ptr<DIR, decltype(&closedir)> proc(opendir("/proc"), closedir);
1783 if (proc.get() == nullptr) {
1784 MYLOGE("opendir /proc failed: %s\n", strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001785 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001786 }
1787
1788 // Number of times process dumping has timed out. If we encounter too many
1789 // failures, we'll give up.
1790 int timeout_failures = 0;
1791 bool dalvik_found = false;
1792
1793 const std::set<int> hal_pids = get_interesting_hal_pids();
1794
1795 struct dirent* d;
1796 while ((d = readdir(proc.get()))) {
Nandana Duttcf419a72019-03-14 10:40:17 +00001797 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttfaafd522019-03-11 09:23:09 +00001798 int pid = atoi(d->d_name);
1799 if (pid <= 0) {
1800 continue;
1801 }
1802
1803 const std::string link_name = android::base::StringPrintf("/proc/%d/exe", pid);
1804 std::string exe;
1805 if (!android::base::Readlink(link_name, &exe)) {
1806 continue;
1807 }
1808
1809 bool is_java_process;
1810 if (exe == "/system/bin/app_process32" || exe == "/system/bin/app_process64") {
1811 // Don't bother dumping backtraces for the zygote.
1812 if (IsZygote(pid)) {
1813 continue;
1814 }
1815
1816 dalvik_found = true;
1817 is_java_process = true;
1818 } else if (should_dump_native_traces(exe.c_str()) || hal_pids.find(pid) != hal_pids.end()) {
1819 is_java_process = false;
1820 } else {
1821 // Probably a native process we don't care about, continue.
1822 continue;
1823 }
1824
1825 // If 3 backtrace dumps fail in a row, consider debuggerd dead.
1826 if (timeout_failures == 3) {
1827 dprintf(fd, "ERROR: Too many stack dump failures, exiting.\n");
1828 break;
1829 }
1830
1831 const uint64_t start = Nanotime();
1832 const int ret = dump_backtrace_to_file_timeout(
1833 pid, is_java_process ? kDebuggerdJavaBacktrace : kDebuggerdNativeBacktrace,
1834 is_java_process ? 5 : 20, fd);
1835
1836 if (ret == -1) {
1837 // For consistency, the header and footer to this message match those
1838 // dumped by debuggerd in the success case.
1839 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
1840 dprintf(fd, "Dump failed, likely due to a timeout.\n");
1841 dprintf(fd, "---- end %d ----", pid);
1842 timeout_failures++;
1843 continue;
1844 }
1845
1846 // We've successfully dumped stack traces, reset the failure count
1847 // and write a summary of the elapsed time to the file and continue with the
1848 // next process.
1849 timeout_failures = 0;
1850
1851 dprintf(fd, "[dump %s stack %d: %.3fs elapsed]\n", is_java_process ? "dalvik" : "native",
1852 pid, (float)(Nanotime() - start) / NANOS_PER_SEC);
1853 }
1854
1855 if (!dalvik_found) {
1856 MYLOGE("Warning: no Dalvik processes found to dump stacks\n");
1857 }
1858
Nandana Duttcf419a72019-03-14 10:40:17 +00001859 *path = file_name_buf.release();
1860 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001861}
1862
Felipe Leme6f674ae2016-11-18 17:10:33 -08001863void Dumpstate::DumpstateBoard() {
1864 DurationReporter duration_reporter("dumpstate_board()");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001865 printf("========================================================\n");
1866 printf("== Board\n");
1867 printf("========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001868
Felipe Leme6f674ae2016-11-18 17:10:33 -08001869 if (!IsZipping()) {
Steven Moreland7440ddb2016-12-15 16:13:39 -08001870 MYLOGD("Not dumping board info because it's not a zipped bugreport\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001871 return;
1872 }
1873
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001874 std::vector<std::string> paths;
1875 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07001876 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00001877 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
1878 kDumpstateBoardFiles[i].c_str()));
Nandana Dutt16d1aee2019-02-15 16:13:53 +00001879 remover.emplace_back(android::base::make_scope_guard(
1880 std::bind([](std::string path) { android::os::UnlinkAndLogOnError(path); }, paths[i])));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001881 }
Jie Song9fbfad02017-06-20 16:29:42 -07001882
Wei Wang587eac92018-04-05 12:17:20 -07001883 sp<IDumpstateDevice> dumpstate_device(IDumpstateDevice::getService());
1884 if (dumpstate_device == nullptr) {
1885 MYLOGE("No IDumpstateDevice implementation\n");
1886 return;
1887 }
1888
1889 using ScopedNativeHandle =
1890 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
1891 ScopedNativeHandle handle(native_handle_create(static_cast<int>(paths.size()), 0),
1892 [](native_handle_t* handle) {
1893 native_handle_close(handle);
1894 native_handle_delete(handle);
1895 });
1896 if (handle == nullptr) {
1897 MYLOGE("Could not create native_handle\n");
1898 return;
1899 }
1900
Nandana Dutt5c390032019-03-12 10:52:56 +00001901 // TODO(128270426): Check for consent in between?
Wei Wang587eac92018-04-05 12:17:20 -07001902 for (size_t i = 0; i < paths.size(); i++) {
1903 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
1904
1905 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
1906 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1907 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1908 if (fd < 0) {
1909 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
1910 return;
1911 }
1912 handle.get()->data[i] = fd.release();
1913 }
1914
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001915 // Given that bugreport is required to diagnose failures, it's better to
Wei Wang587eac92018-04-05 12:17:20 -07001916 // set an arbitrary amount of timeout for IDumpstateDevice than to block the
1917 // rest of bugreport. In the timeout case, we will kill dumpstate board HAL
1918 // and grab whatever dumped
1919 std::packaged_task<bool()>
1920 dumpstate_task([paths, dumpstate_device, &handle]() -> bool {
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001921 android::hardware::Return<void> status = dumpstate_device->dumpstateBoard(handle.get());
1922 if (!status.isOk()) {
1923 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
Wei Wang587eac92018-04-05 12:17:20 -07001924 return false;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001925 }
Wei Wang587eac92018-04-05 12:17:20 -07001926 return true;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001927 });
Wei Wang587eac92018-04-05 12:17:20 -07001928
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001929 auto result = dumpstate_task.get_future();
1930 std::thread(std::move(dumpstate_task)).detach();
Wei Wang587eac92018-04-05 12:17:20 -07001931
1932 constexpr size_t timeout_sec = 30;
1933 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
1934 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate vendor HAL\n", timeout_sec);
1935 if (!android::base::SetProperty("ctl.interface_restart",
1936 android::base::StringPrintf("%s/default",
1937 IDumpstateDevice::descriptor))) {
1938 MYLOGE("Couldn't restart dumpstate HAL\n");
1939 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001940 }
Wei Wang587eac92018-04-05 12:17:20 -07001941 // Wait some time for init to kill dumpstate vendor HAL
1942 constexpr size_t killing_timeout_sec = 10;
1943 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
1944 MYLOGE("killing dumpstateBoard timed out after %zus, continue and "
1945 "there might be racing in content\n", killing_timeout_sec);
1946 }
1947
1948 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
1949 for (size_t i = 0; i < paths.size(); i++) {
1950 struct stat s;
1951 if (fstat(handle.get()->data[i], &s) == -1) {
1952 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(),
1953 strerror(errno));
1954 file_sizes[i] = -1;
1955 continue;
1956 }
1957 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001958 }
1959
1960 for (size_t i = 0; i < paths.size(); i++) {
1961 if (file_sizes[i] == -1) {
1962 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07001963 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001964 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07001965 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001966 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07001967 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001968 AddZipEntry(kDumpstateBoardFiles[i], paths[i]);
Jie Song9fbfad02017-06-20 16:29:42 -07001969 }
1970
Felipe Lemed8b94e52016-12-08 10:21:44 -08001971 printf("*** See dumpstate-board.txt entry ***\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001972}
1973
Nandana Dutt12ae14a2019-01-09 10:35:53 +00001974static void ShowUsage() {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001975 fprintf(stderr,
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001976 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-d] [-p] "
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001977 "[-z]] [-s] [-S] [-q] [-B] [-P] [-R] [-V version]\n"
1978 " -h: display this help message\n"
1979 " -b: play sound file instead of vibrate, at beginning of job\n"
1980 " -e: play sound file instead of vibrate, at end of job\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001981 " -d: append date to filename\n"
1982 " -p: capture screenshot to filename.png\n"
1983 " -z: generate zipped file\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001984 " -s: write output to control socket (for init)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001985 " -S: write file location to control socket (for init; requires -z)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001986 " -q: disable vibrate\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001987 " -B: send broadcast when finished\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001988 " -P: send broadcast when started and update system properties on "
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001989 "progress (requires -B)\n"
1990 " -R: take bugreport in remote mode (requires -z, -d and -B, "
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001991 "shouldn't be used with -P)\n"
Nandana Dutt235864b2019-01-22 12:10:16 +00001992 " -w: start binder service and make it wait for a call to startBugreport\n"
Felipe Lemed071c682016-10-20 16:48:00 -07001993 " -v: prints the dumpstate header and exit\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001994}
1995
Wei Liuf87959e2016-08-26 14:51:42 -07001996static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07001997 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07001998}
1999
Felipe Leme1d486fe2016-10-14 18:06:47 -07002000bool Dumpstate::FinishZipFile() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07002001 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07002002 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07002003 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002004 // Final timestamp
2005 char date[80];
2006 time_t the_real_now_please_stand_up = time(nullptr);
2007 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002008 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07002009 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002010
Felipe Leme9a523ae2016-10-20 15:10:33 -07002011 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002012 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08002013 return false;
2014 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07002015 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002016 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08002017 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08002018 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08002019
Felipe Leme0f3fb202016-06-10 17:10:53 -07002020 // Add log file (which contains stderr output) to zip...
2021 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07002022 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07002023 MYLOGE("Failed to add dumpstate log to .zip file\n");
2024 return false;
2025 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002026 // TODO: Should truncate the existing file.
2027 // ... and re-open it for further logging.
Nandana Dutta344cb62019-02-22 15:12:35 +00002028 if (!redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()))) {
2029 return false;
2030 }
Felipe Leme0f3fb202016-06-10 17:10:53 -07002031 fprintf(stderr, "\n");
2032
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002033 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07002034 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002035 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002036 return false;
2037 }
2038
Felipe Leme1d486fe2016-10-14 18:06:47 -07002039 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
2040 ds.zip_file.reset(nullptr);
2041
Felipe Lemee9d2c542016-11-15 11:48:26 -08002042 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002043 android::os::UnlinkAndLogOnError(tmp_path_);
Felipe Lemec4eee562016-04-21 15:42:55 -07002044
Felipe Leme1e9edc62015-12-21 16:02:13 -08002045 return true;
2046}
Felipe Leme6e01fa62015-11-11 19:35:14 -08002047
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -07002048static std::string SHA256_file_hash(const std::string& filepath) {
Andreas Gampe27cd7b22016-07-18 18:24:05 -07002049 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(filepath.c_str(), O_RDONLY | O_NONBLOCK
2050 | O_CLOEXEC | O_NOFOLLOW)));
Andreas Gampeaff68432016-07-18 18:01:27 -07002051 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002052 MYLOGE("open(%s): %s\n", filepath.c_str(), strerror(errno));
Yi Kong19d5c002018-07-20 13:39:55 -07002053 return nullptr;
Michal Karpinski4db754f2015-12-11 18:04:32 +00002054 }
2055
2056 SHA256_CTX ctx;
Elliott Hughesc4dc1412016-04-12 16:28:31 -07002057 SHA256_Init(&ctx);
Michal Karpinski4db754f2015-12-11 18:04:32 +00002058
2059 std::vector<uint8_t> buffer(65536);
2060 while (1) {
2061 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd.get(), buffer.data(), buffer.size()));
2062 if (bytes_read == 0) {
2063 break;
2064 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002065 MYLOGE("read(%s): %s\n", filepath.c_str(), strerror(errno));
Yi Kong19d5c002018-07-20 13:39:55 -07002066 return nullptr;
Michal Karpinski4db754f2015-12-11 18:04:32 +00002067 }
2068
Elliott Hughesc4dc1412016-04-12 16:28:31 -07002069 SHA256_Update(&ctx, buffer.data(), bytes_read);
Michal Karpinski4db754f2015-12-11 18:04:32 +00002070 }
2071
Elliott Hughesc4dc1412016-04-12 16:28:31 -07002072 uint8_t hash[SHA256_DIGEST_LENGTH];
2073 SHA256_Final(hash, &ctx);
2074
2075 char hash_buffer[SHA256_DIGEST_LENGTH * 2 + 1];
2076 for(size_t i = 0; i < SHA256_DIGEST_LENGTH; i++) {
Michal Karpinskicbbdf732016-01-07 20:45:02 +00002077 sprintf(hash_buffer + (i * 2), "%02x", hash[i]);
Michal Karpinski4db754f2015-12-11 18:04:32 +00002078 }
2079 hash_buffer[sizeof(hash_buffer) - 1] = 0;
2080 return std::string(hash_buffer);
2081}
2082
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002083static void SendBroadcast(const std::string& action, const std::vector<std::string>& args) {
2084 // clang-format off
2085 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user", "0",
2086 "--receiver-foreground", "--receiver-include-background", "-a", action};
2087 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08002088
2089 am.insert(am.end(), args.begin(), args.end());
2090
Felipe Leme8d2410e2017-02-08 09:46:08 -08002091 RunCommand("", am,
2092 CommandOptions::WithTimeout(20)
2093 .Log("Sending broadcast: '%s'\n")
2094 .Always()
2095 .DropRoot()
2096 .RedirectStderr()
2097 .Build());
2098}
2099
Felipe Leme35b8cf12017-02-10 15:47:29 -08002100static void Vibrate(int duration_ms) {
2101 // clang-format off
Chris Fries0c3de872019-09-14 15:49:41 +00002102 RunCommand("", {"cmd", "vibrator", "vibrate", "-f", std::to_string(duration_ms), "dumpstate"},
Felipe Leme35b8cf12017-02-10 15:47:29 -08002103 CommandOptions::WithTimeout(10)
2104 .Log("Vibrate: '%s'\n")
2105 .Always()
2106 .Build());
2107 // clang-format on
2108}
2109
Nandana Dutt979388e2018-11-30 16:48:55 +00002110static void MaybeResolveSymlink(std::string* path) {
2111 std::string resolved_path;
2112 if (android::base::Readlink(*path, &resolved_path)) {
2113 *path = resolved_path;
2114 }
2115}
2116
Nandana Dutt4be45d12018-09-26 15:04:23 +01002117/*
2118 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
2119 * if we are writing zip files and adds the version file.
2120 */
2121static void PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002122 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
2123
Nandana Dutt4be45d12018-09-26 15:04:23 +01002124 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
2125 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002126 ds.base_name_ = StringPrintf("bugreport-%s-%s", device_name.c_str(), build_id.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002127 if (ds.options_->do_add_date) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002128 char date[80];
2129 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
2130 ds.name_ = date;
2131 } else {
2132 ds.name_ = "undated";
2133 }
2134
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002135 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002136 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002137 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002138 ds.base_name_ += "-wifi";
2139 }
2140
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002141 if (ds.options_->do_fb) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002142 ds.screenshot_path_ = ds.GetPath(".png");
2143 }
2144 ds.tmp_path_ = ds.GetPath(".tmp");
2145 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
2146
Nandana Dutt54dbd672019-01-11 12:58:05 +00002147 std::string destination = ds.options_->bugreport_fd.get() != -1
2148 ? StringPrintf("[fd:%d]", ds.options_->bugreport_fd.get())
Nandana Dutt9a76d202019-01-21 15:56:48 +00002149 : ds.bugreport_internal_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01002150 MYLOGD(
2151 "Bugreport dir: %s\n"
2152 "Base name: %s\n"
2153 "Suffix: %s\n"
2154 "Log path: %s\n"
2155 "Temporary path: %s\n"
2156 "Screenshot path: %s\n",
Nandana Dutt9a76d202019-01-21 15:56:48 +00002157 destination.c_str(), ds.base_name_.c_str(), ds.name_.c_str(), ds.log_path_.c_str(),
2158 ds.tmp_path_.c_str(), ds.screenshot_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002159
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002160 if (ds.options_->do_zip_file) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002161 ds.path_ = ds.GetPath(".zip");
2162 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
2163 create_parent_dirs(ds.path_.c_str());
2164 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
2165 if (ds.zip_file == nullptr) {
2166 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
2167 } else {
2168 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
2169 }
2170 ds.AddTextZipEntry("version.txt", ds.version_);
2171 }
2172}
2173
2174/*
2175 * Finalizes writing to the file by renaming or zipping the tmp file to the final location,
2176 * printing zipped file status, etc.
2177 */
2178static void FinalizeFile() {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002179 /* check if user changed the suffix using system properties */
2180 std::string name =
2181 android::base::GetProperty(android::base::StringPrintf("dumpstate.%d.name", ds.pid_), "");
2182 bool change_suffix = false;
2183 if (!name.empty()) {
2184 /* must whitelist which characters are allowed, otherwise it could cross directories */
2185 std::regex valid_regex("^[-_a-zA-Z0-9]+$");
2186 if (std::regex_match(name.c_str(), valid_regex)) {
2187 change_suffix = true;
2188 } else {
2189 MYLOGE("invalid suffix provided by user: %s\n", name.c_str());
2190 }
2191 }
2192 if (change_suffix) {
2193 MYLOGI("changing suffix from %s to %s\n", ds.name_.c_str(), name.c_str());
2194 ds.name_ = name;
2195 if (!ds.screenshot_path_.empty()) {
2196 std::string new_screenshot_path = ds.GetPath(".png");
2197 if (rename(ds.screenshot_path_.c_str(), new_screenshot_path.c_str())) {
2198 MYLOGE("rename(%s, %s): %s\n", ds.screenshot_path_.c_str(),
2199 new_screenshot_path.c_str(), strerror(errno));
2200 } else {
2201 ds.screenshot_path_ = new_screenshot_path;
2202 }
2203 }
2204 }
2205
2206 bool do_text_file = true;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002207 if (ds.options_->do_zip_file) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002208 if (!ds.FinishZipFile()) {
2209 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
2210 do_text_file = true;
2211 } else {
2212 do_text_file = false;
Nandana Dutt383d0c12018-11-30 15:54:56 +00002213 // If the user has changed the suffix, we need to change the zip file name.
2214 std::string new_path = ds.GetPath(".zip");
2215 if (ds.path_ != new_path) {
2216 MYLOGD("Renaming zip file from %s to %s\n", ds.path_.c_str(), new_path.c_str());
2217 if (rename(ds.path_.c_str(), new_path.c_str())) {
2218 MYLOGE("rename(%s, %s): %s\n", ds.path_.c_str(), new_path.c_str(),
2219 strerror(errno));
2220 } else {
2221 ds.path_ = new_path;
2222 }
2223 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01002224 }
2225 }
2226 if (do_text_file) {
2227 ds.path_ = ds.GetPath(".txt");
2228 MYLOGD("Generating .txt bugreport at %s from %s\n", ds.path_.c_str(), ds.tmp_path_.c_str());
2229 if (rename(ds.tmp_path_.c_str(), ds.path_.c_str())) {
2230 MYLOGE("rename(%s, %s): %s\n", ds.tmp_path_.c_str(), ds.path_.c_str(), strerror(errno));
2231 ds.path_.clear();
2232 }
2233 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002234 if (ds.options_->use_control_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002235 if (do_text_file) {
2236 dprintf(ds.control_socket_fd_,
2237 "FAIL:could not create zip file, check %s "
2238 "for more details\n",
2239 ds.log_path_.c_str());
2240 } else {
2241 dprintf(ds.control_socket_fd_, "OK:%s\n", ds.path_.c_str());
2242 }
2243 }
2244}
2245
2246/* Broadcasts that we are done with the bugreport */
2247static void SendBugreportFinishedBroadcast() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002248 // TODO(b/111441001): use callback instead of broadcast.
Nandana Dutt9a76d202019-01-21 15:56:48 +00002249 if (!ds.path_.empty()) {
2250 MYLOGI("Final bugreport path: %s\n", ds.path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002251 // clang-format off
2252
2253 std::vector<std::string> am_args = {
2254 "--receiver-permission", "android.permission.DUMP",
2255 "--ei", "android.intent.extra.ID", std::to_string(ds.id_),
2256 "--ei", "android.intent.extra.PID", std::to_string(ds.pid_),
2257 "--ei", "android.intent.extra.MAX", std::to_string(ds.progress_->GetMax()),
Nandana Dutt9a76d202019-01-21 15:56:48 +00002258 "--es", "android.intent.extra.BUGREPORT", ds.path_,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002259 "--es", "android.intent.extra.DUMPSTATE_LOG", ds.log_path_
2260 };
2261 // clang-format on
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +00002262 if (ds.options_->do_fb && !android::os::IsFileEmpty(ds.screenshot_path_)) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002263 am_args.push_back("--es");
2264 am_args.push_back("android.intent.extra.SCREENSHOT");
2265 am_args.push_back(ds.screenshot_path_);
2266 }
Nandana Dutt15b89d72018-11-16 14:14:12 +00002267 if (!ds.options_->notification_title.empty()) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002268 am_args.push_back("--es");
2269 am_args.push_back("android.intent.extra.TITLE");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002270 am_args.push_back(ds.options_->notification_title);
2271 if (!ds.options_->notification_description.empty()) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002272 am_args.push_back("--es");
2273 am_args.push_back("android.intent.extra.DESCRIPTION");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002274 am_args.push_back(ds.options_->notification_description);
Nandana Dutt4be45d12018-09-26 15:04:23 +01002275 }
2276 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002277 if (ds.options_->is_remote_mode) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002278 am_args.push_back("--es");
2279 am_args.push_back("android.intent.extra.REMOTE_BUGREPORT_HASH");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002280 am_args.push_back(SHA256_file_hash(ds.path_));
Nandana Dutt4be45d12018-09-26 15:04:23 +01002281 SendBroadcast("com.android.internal.intent.action.REMOTE_BUGREPORT_FINISHED", am_args);
2282 } else {
2283 SendBroadcast("com.android.internal.intent.action.BUGREPORT_FINISHED", am_args);
2284 }
2285 } else {
2286 MYLOGE("Skipping finished broadcast because bugreport could not be generated\n");
2287 }
2288}
2289
Nandana Dutt58d72e22018-11-16 10:30:48 +00002290static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2291 switch (mode) {
2292 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2293 return "BUGREPORT_FULL";
2294 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2295 return "BUGREPORT_INTERACTIVE";
2296 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2297 return "BUGREPORT_REMOTE";
2298 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2299 return "BUGREPORT_WEAR";
2300 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2301 return "BUGREPORT_TELEPHONY";
2302 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2303 return "BUGREPORT_WIFI";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002304 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2305 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002306 }
2307}
2308
2309static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options) {
Abhijeet Kaur8ca245e2018-12-12 10:34:21 +00002310 options->extra_options = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002311 switch (mode) {
2312 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2313 options->do_broadcast = true;
2314 options->do_fb = true;
2315 break;
2316 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002317 // Currently, the dumpstate binder is only used by Shell to update progress.
2318 options->do_start_service = true;
2319 options->do_progress_updates = true;
2320 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002321 options->do_broadcast = true;
2322 break;
2323 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002324 options->do_vibrate = false;
2325 options->is_remote_mode = true;
2326 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002327 options->do_broadcast = true;
2328 break;
2329 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002330 options->do_start_service = true;
2331 options->do_progress_updates = true;
2332 options->do_zip_file = true;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002333 options->do_fb = true;
2334 options->do_broadcast = true;
2335 break;
2336 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002337 options->telephony_only = true;
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002338 options->do_progress_updates = true;
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +00002339 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002340 options->do_broadcast = true;
2341 break;
2342 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002343 options->wifi_only = true;
2344 options->do_zip_file = true;
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +00002345 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002346 options->do_broadcast = true;
2347 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002348 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2349 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002350 }
2351}
2352
2353static Dumpstate::BugreportMode getBugreportModeFromProperty() {
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002354 // If the system property is not set, it's assumed to be a default bugreport.
2355 Dumpstate::BugreportMode mode = Dumpstate::BugreportMode::BUGREPORT_DEFAULT;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002356
2357 std::string extra_options = android::base::GetProperty(PROPERTY_EXTRA_OPTIONS, "");
2358 if (!extra_options.empty()) {
2359 // Framework uses a system property to override some command-line args.
2360 // Currently, it contains the type of the requested bugreport.
2361 if (extra_options == "bugreportplus") {
2362 mode = Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002363 } else if (extra_options == "bugreportfull") {
2364 mode = Dumpstate::BugreportMode::BUGREPORT_FULL;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002365 } else if (extra_options == "bugreportremote") {
2366 mode = Dumpstate::BugreportMode::BUGREPORT_REMOTE;
2367 } else if (extra_options == "bugreportwear") {
2368 mode = Dumpstate::BugreportMode::BUGREPORT_WEAR;
2369 } else if (extra_options == "bugreporttelephony") {
2370 mode = Dumpstate::BugreportMode::BUGREPORT_TELEPHONY;
2371 } else if (extra_options == "bugreportwifi") {
2372 mode = Dumpstate::BugreportMode::BUGREPORT_WIFI;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002373 } else {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002374 MYLOGE("Unknown extra option: %s\n", extra_options.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002375 }
2376 // Reset the property
2377 android::base::SetProperty(PROPERTY_EXTRA_OPTIONS, "");
2378 }
Nandana Dutt58d72e22018-11-16 10:30:48 +00002379 return mode;
2380}
2381
2382// TODO: Move away from system properties when we have options passed via binder calls.
2383/* Sets runtime options from the system properties and then clears those properties. */
2384static void SetOptionsFromProperties(Dumpstate::DumpOptions* options) {
2385 Dumpstate::BugreportMode mode = getBugreportModeFromProperty();
2386 SetOptionsFromMode(mode, options);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002387
2388 options->notification_title = android::base::GetProperty(PROPERTY_EXTRA_TITLE, "");
2389 if (!options->notification_title.empty()) {
2390 // Reset the property
2391 android::base::SetProperty(PROPERTY_EXTRA_TITLE, "");
2392
Nandana Duttdd8cca32018-11-14 10:10:29 +00002393 options->notification_description =
2394 android::base::GetProperty(PROPERTY_EXTRA_DESCRIPTION, "");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002395 if (!options->notification_description.empty()) {
2396 // Reset the property
2397 android::base::SetProperty(PROPERTY_EXTRA_DESCRIPTION, "");
2398 }
2399 MYLOGD("notification (title: %s, description: %s)\n", options->notification_title.c_str(),
2400 options->notification_description.c_str());
2401 }
2402}
2403
Nandana Dutt58d72e22018-11-16 10:30:48 +00002404static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
2405 MYLOGI("do_zip_file: %d\n", options.do_zip_file);
2406 MYLOGI("do_add_date: %d\n", options.do_add_date);
2407 MYLOGI("do_vibrate: %d\n", options.do_vibrate);
2408 MYLOGI("use_socket: %d\n", options.use_socket);
2409 MYLOGI("use_control_socket: %d\n", options.use_control_socket);
2410 MYLOGI("do_fb: %d\n", options.do_fb);
2411 MYLOGI("do_broadcast: %d\n", options.do_broadcast);
2412 MYLOGI("is_remote_mode: %d\n", options.is_remote_mode);
2413 MYLOGI("show_header_only: %d\n", options.show_header_only);
2414 MYLOGI("do_start_service: %d\n", options.do_start_service);
2415 MYLOGI("telephony_only: %d\n", options.telephony_only);
2416 MYLOGI("wifi_only: %d\n", options.wifi_only);
2417 MYLOGI("do_progress_updates: %d\n", options.do_progress_updates);
Nandana Dutt54dbd672019-01-11 12:58:05 +00002418 MYLOGI("fd: %d\n", options.bugreport_fd.get());
Nandana Dutt58d72e22018-11-16 10:30:48 +00002419 MYLOGI("extra_options: %s\n", options.extra_options.c_str());
2420 MYLOGI("args: %s\n", options.args.c_str());
2421 MYLOGI("notification_title: %s\n", options.notification_title.c_str());
2422 MYLOGI("notification_description: %s\n", options.notification_description.c_str());
2423}
2424
Nandana Dutt54dbd672019-01-11 12:58:05 +00002425void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode,
2426 const android::base::unique_fd& bugreport_fd_in,
2427 const android::base::unique_fd& screenshot_fd_in) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002428 // In the new API world, date is always added; output is always a zip file.
2429 // TODO(111441001): remove these options once they are obsolete.
2430 do_add_date = true;
2431 do_zip_file = true;
2432
Nandana Dutt54dbd672019-01-11 12:58:05 +00002433 // Duplicate the fds because the passed in fds don't outlive the binder transaction.
2434 bugreport_fd.reset(dup(bugreport_fd_in.get()));
2435 screenshot_fd.reset(dup(screenshot_fd_in.get()));
Nandana Dutt58d72e22018-11-16 10:30:48 +00002436
2437 extra_options = ModeToString(bugreport_mode);
2438 SetOptionsFromMode(bugreport_mode, this);
2439}
2440
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002441Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
2442 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002443 int c;
Nandana Dutt235864b2019-01-22 12:10:16 +00002444 while ((c = getopt(argc, argv, "dho:svqzpPBRSV:w")) != -1) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002445 switch (c) {
2446 // clang-format off
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002447 case 'd': do_add_date = true; break;
2448 case 'z': do_zip_file = true; break;
Nandana Dutt9a76d202019-01-21 15:56:48 +00002449 // o=use_outfile not supported anymore.
2450 // TODO(b/111441001): Remove when all callers have migrated.
2451 case 'o': break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002452 case 's': use_socket = true; break;
2453 case 'S': use_control_socket = true; break;
2454 case 'v': show_header_only = true; break;
2455 case 'q': do_vibrate = false; break;
2456 case 'p': do_fb = true; break;
2457 case 'P': do_progress_updates = true; break;
2458 case 'R': is_remote_mode = true; break;
2459 case 'B': do_broadcast = true; break;
2460 case 'V': break; // compatibility no-op
Nandana Dutt235864b2019-01-22 12:10:16 +00002461 case 'w':
2462 // This was already processed
2463 break;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002464 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002465 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002466 break;
2467 default:
2468 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002469 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002470 break;
2471 // clang-format on
2472 }
2473 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08002474
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002475 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002476 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002477 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002478 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002479 }
2480 }
2481
2482 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
2483 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002484
2485 SetOptionsFromProperties(this);
2486 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002487}
2488
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002489bool Dumpstate::DumpOptions::ValidateOptions() const {
Nandana Dutt54dbd672019-01-11 12:58:05 +00002490 if (bugreport_fd.get() != -1 && !do_zip_file) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002491 return false;
2492 }
2493
Nandana Dutt9a76d202019-01-21 15:56:48 +00002494 if ((do_zip_file || do_add_date || do_progress_updates || do_broadcast) && !OutputToFile()) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002495 return false;
2496 }
2497
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002498 if (use_control_socket && !do_zip_file) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002499 return false;
2500 }
2501
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002502 if (do_progress_updates && !do_broadcast) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002503 return false;
2504 }
2505
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002506 if (is_remote_mode && (do_progress_updates || !do_broadcast || !do_zip_file || !do_add_date)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002507 return false;
2508 }
2509 return true;
2510}
2511
Nandana Dutt197661d2018-11-16 16:40:21 +00002512void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
2513 options_ = std::move(options);
2514}
2515
Nandana Duttd2f5f082019-01-18 17:13:52 +00002516Dumpstate::RunStatus Dumpstate::Run(int32_t calling_uid, const std::string& calling_package) {
2517 Dumpstate::RunStatus status = RunInternal(calling_uid, calling_package);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002518 if (listener_ != nullptr) {
2519 switch (status) {
2520 case Dumpstate::RunStatus::OK:
Nandana Duttcc4ead82019-01-23 08:29:23 +00002521 listener_->onFinished();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002522 break;
2523 case Dumpstate::RunStatus::HELP:
2524 break;
2525 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002526 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_INVALID_INPUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002527 break;
2528 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002529 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_RUNTIME_ERROR);
2530 break;
2531 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2532 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_DENIED_CONSENT);
2533 break;
2534 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
2535 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_CONSENT_TIMED_OUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002536 break;
2537 }
2538 }
2539 return status;
2540}
2541
Nandana Dutt979388e2018-11-30 16:48:55 +00002542/*
2543 * Dumps relevant information to a bugreport based on the given options.
2544 *
2545 * The bugreport can be dumped to a file or streamed to a socket.
2546 *
2547 * How dumping to file works:
2548 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
2549 * stderr is redirected a log file.
2550 *
2551 * The temporary bugreport is then populated via printfs, dumping contents of files and
2552 * output of commands to stdout.
2553 *
2554 * If zipping, the temporary bugreport file is added to the zip archive. Else it's renamed to final
2555 * text file.
2556 *
2557 * If zipping, a bunch of other files and dumps also get added to the zip archive. The log file also
2558 * gets added to the archive.
2559 *
Nandana Dutt9a76d202019-01-21 15:56:48 +00002560 * Bugreports are first generated in a local directory and later copied to the caller's fd if
2561 * supplied.
Nandana Dutt979388e2018-11-30 16:48:55 +00002562 */
Nandana Duttd2f5f082019-01-18 17:13:52 +00002563Dumpstate::RunStatus Dumpstate::RunInternal(int32_t calling_uid,
2564 const std::string& calling_package) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002565 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00002566 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002567 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002568 return RunStatus::INVALID_INPUT;
2569 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002570 /* set as high priority, and protect from OOM killer */
2571 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002572
Felipe Lemed071c682016-10-20 16:48:00 -07002573 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002574 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002575 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002576 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002577 } else {
2578 /* fallback to kernels <= 2.6.35 */
2579 oom_adj = fopen("/proc/self/oom_adj", "we");
2580 if (oom_adj) {
2581 fputs("-17", oom_adj);
2582 fclose(oom_adj);
2583 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002584 }
2585
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002586 if (version_ == VERSION_DEFAULT) {
2587 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00002588 }
2589
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002590 if (version_ != VERSION_CURRENT && version_ != VERSION_SPLIT_ANR) {
Vishnu Nair64afc022018-02-01 15:29:34 -08002591 MYLOGE("invalid version requested ('%s'); suppported values are: ('%s', '%s', '%s')\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002592 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str(),
Vishnu Nair64afc022018-02-01 15:29:34 -08002593 VERSION_SPLIT_ANR.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002594 return RunStatus::INVALID_INPUT;
Felipe Lemed071c682016-10-20 16:48:00 -07002595 }
2596
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002597 if (options_->show_header_only) {
2598 PrintHeader();
2599 return RunStatus::OK;
Felipe Lemed071c682016-10-20 16:48:00 -07002600 }
2601
Nandana Duttd2f5f082019-01-18 17:13:52 +00002602 if (options_->bugreport_fd.get() != -1) {
2603 // If the output needs to be copied over to the caller's fd, get user consent.
2604 android::String16 package(calling_package.c_str());
2605 CheckUserConsent(calling_uid, package);
2606 }
2607
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002608 // Redirect output if needed
Nandana Dutt9a76d202019-01-21 15:56:48 +00002609 bool is_redirecting = options_->OutputToFile();
Felipe Leme7447d7c2016-11-03 18:12:22 -07002610
2611 // TODO: temporarily set progress until it's part of the Dumpstate constructor
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002612 std::string stats_path =
Nandana Dutt979388e2018-11-30 16:48:55 +00002613 is_redirecting
2614 ? android::base::StringPrintf("%s/dumpstate-stats.txt", bugreport_internal_dir_.c_str())
2615 : "";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002616 progress_.reset(new Progress(stats_path));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002617
Felipe Lemed071c682016-10-20 16:48:00 -07002618 /* gets the sequential id */
Felipe Leme7447d7c2016-11-03 18:12:22 -07002619 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002620 id_ = ++last_id;
Felipe Lemed071c682016-10-20 16:48:00 -07002621 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
2622
2623 MYLOGI("begin\n");
2624
Sahana Raof35ed432019-07-12 10:47:52 +01002625 if (acquire_wake_lock(PARTIAL_WAKE_LOCK, WAKE_LOCK_NAME) < 0) {
2626 MYLOGE("Failed to acquire wake lock: %s\n", strerror(errno));
2627 } else {
2628 // Wake lock will be released automatically on process death
2629 MYLOGD("Wake lock acquired.\n");
2630 }
2631
Felipe Leme6ae5c4f2017-01-10 14:13:22 -08002632 register_sig_handler();
Felipe Lemed071c682016-10-20 16:48:00 -07002633
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002634 // TODO(b/111441001): maybe skip if already started?
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002635 if (options_->do_start_service) {
Felipe Leme75876a22016-10-27 16:31:27 -07002636 MYLOGI("Starting 'dumpstate' service\n");
2637 android::status_t ret;
2638 if ((ret = android::os::DumpstateService::Start()) != android::OK) {
2639 MYLOGE("Unable to start DumpstateService: %d\n", ret);
2640 }
2641 }
2642
Felipe Lemef0292972016-11-22 13:57:05 -08002643 if (PropertiesHelper::IsDryRun()) {
Felipe Lemed071c682016-10-20 16:48:00 -07002644 MYLOGI("Running on dry-run mode (to disable it, call 'setprop dumpstate.dry_run false')\n");
2645 }
2646
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002647 MYLOGI("dumpstate info: id=%d, args='%s', extra_options= %s)\n", id_, options_->args.c_str(),
2648 options_->extra_options.c_str());
Felipe Lemed071c682016-10-20 16:48:00 -07002649
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002650 MYLOGI("bugreport format version: %s\n", version_.c_str());
Felipe Leme809d74e2016-02-02 12:57:00 -08002651
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002652 do_early_screenshot_ = options_->do_progress_updates;
Felipe Lemee338bf62015-12-07 14:03:50 -08002653
Christopher Ferrised9354f2014-10-01 17:35:01 -07002654 // If we are going to use a socket, do it as early as possible
2655 // to avoid timeouts from bugreport.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002656 if (options_->use_socket) {
Nandana Dutta344cb62019-02-22 15:12:35 +00002657 if (!redirect_to_socket(stdout, "dumpstate")) {
2658 return ERROR;
2659 }
Christopher Ferrised9354f2014-10-01 17:35:01 -07002660 }
2661
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002662 if (options_->use_control_socket) {
Felipe Leme2628e9e2016-04-12 16:36:51 -07002663 MYLOGD("Opening control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002664 control_socket_fd_ = open_socket("dumpstate");
Nandana Dutta344cb62019-02-22 15:12:35 +00002665 if (control_socket_fd_ == -1) {
2666 return ERROR;
2667 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002668 options_->do_progress_updates = 1;
Felipe Leme2628e9e2016-04-12 16:36:51 -07002669 }
2670
Felipe Leme71bbfc52015-11-23 14:14:51 -08002671 if (is_redirecting) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002672 PrepareToWriteToFile();
Felipe Leme1e9edc62015-12-21 16:02:13 -08002673
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002674 if (options_->do_progress_updates) {
2675 if (options_->do_broadcast) {
Felipe Lemedcd1f0d2016-08-04 12:48:50 -07002676 // clang-format off
2677 std::vector<std::string> am_args = {
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002678 "--receiver-permission", "android.permission.DUMP",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002679 "--es", "android.intent.extra.NAME", name_,
2680 "--ei", "android.intent.extra.ID", std::to_string(id_),
2681 "--ei", "android.intent.extra.PID", std::to_string(pid_),
2682 "--ei", "android.intent.extra.MAX", std::to_string(progress_->GetMax()),
Felipe Lemedcd1f0d2016-08-04 12:48:50 -07002683 };
2684 // clang-format on
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002685 SendBroadcast("com.android.internal.intent.action.BUGREPORT_STARTED", am_args);
Felipe Lemedcd1f0d2016-08-04 12:48:50 -07002686 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002687 if (options_->use_control_socket) {
2688 dprintf(control_socket_fd_, "BEGIN:%s\n", path_.c_str());
Felipe Lemeaabfcae2016-07-29 09:49:04 -07002689 }
Felipe Leme71bbfc52015-11-23 14:14:51 -08002690 }
2691 }
2692
Nick Kralevichf3599b32016-01-25 15:05:16 -08002693 /* read /proc/cmdline before dropping root */
2694 FILE *cmdline = fopen("/proc/cmdline", "re");
2695 if (cmdline) {
2696 fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
2697 fclose(cmdline);
2698 }
2699
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002700 if (options_->do_vibrate) {
Felipe Leme35b8cf12017-02-10 15:47:29 -08002701 Vibrate(150);
John Michelau1f794c42012-09-17 11:20:19 -05002702 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002703
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002704 if (options_->do_fb && do_early_screenshot_) {
Greg Kaiser3ddc3fa2019-05-23 16:14:52 -07002705 MYLOGI("taking early screenshot\n");
2706 TakeScreenshot();
Felipe Lemee338bf62015-12-07 14:03:50 -08002707 }
2708
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002709 if (options_->do_zip_file && zip_file != nullptr) {
2710 if (chown(path_.c_str(), AID_SHELL, AID_SHELL)) {
2711 MYLOGE("Unable to change ownership of zip file %s: %s\n", path_.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -07002712 strerror(errno));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002713 }
2714 }
2715
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002716 int dup_stdout_fd;
2717 int dup_stderr_fd;
Felipe Leme71bbfc52015-11-23 14:14:51 -08002718 if (is_redirecting) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002719 // Redirect stderr to log_path_ for debugging.
Vishnu Nair20cf5032018-01-05 13:15:49 -08002720 TEMP_FAILURE_RETRY(dup_stderr_fd = dup(fileno(stderr)));
Nandana Dutta344cb62019-02-22 15:12:35 +00002721 if (!redirect_to_file(stderr, const_cast<char*>(log_path_.c_str()))) {
2722 return ERROR;
2723 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002724 if (chown(log_path_.c_str(), AID_SHELL, AID_SHELL)) {
2725 MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n", log_path_.c_str(),
2726 strerror(errno));
Felipe Leme6fe9db62016-02-12 09:04:16 -08002727 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002728
2729 // Redirect stdout to tmp_path_. This is the main bugreport entry and will be
2730 // moved into zip file later, if zipping.
Vishnu Nair20cf5032018-01-05 13:15:49 -08002731 TEMP_FAILURE_RETRY(dup_stdout_fd = dup(fileno(stdout)));
Nandana Dutt979388e2018-11-30 16:48:55 +00002732 // TODO: why not write to a file instead of stdout to overcome this problem?
Felipe Leme6e01fa62015-11-11 19:35:14 -08002733 /* TODO: rather than generating a text file now and zipping it later,
2734 it would be more efficient to redirect stdout to the zip entry
2735 directly, but the libziparchive doesn't support that option yet. */
Nandana Dutta344cb62019-02-22 15:12:35 +00002736 if (!redirect_to_file(stdout, const_cast<char*>(tmp_path_.c_str()))) {
2737 return ERROR;
2738 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002739 if (chown(tmp_path_.c_str(), AID_SHELL, AID_SHELL)) {
Felipe Leme6fe9db62016-02-12 09:04:16 -08002740 MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002741 tmp_path_.c_str(), strerror(errno));
Felipe Leme6fe9db62016-02-12 09:04:16 -08002742 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002743 }
Felipe Lemed8b94e52016-12-08 10:21:44 -08002744
2745 // Don't buffer stdout
2746 setvbuf(stdout, nullptr, _IONBF, 0);
2747
Felipe Leme608385d2016-02-01 10:35:38 -08002748 // NOTE: there should be no stdout output until now, otherwise it would break the header.
2749 // In particular, DurationReport objects should be created passing 'title, NULL', so their
Felipe Lemecbce55d2016-02-08 09:53:18 -08002750 // duration is logged into MYLOG instead.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002751 PrintHeader();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002752
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002753 if (options_->telephony_only) {
Jayachandran Ca94c7172017-06-10 15:08:12 -07002754 DumpstateTelephonyOnly();
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002755 DumpstateBoard();
2756 } else if (options_->wifi_only) {
mukesh agrawal253dad42018-01-23 21:59:59 -08002757 DumpstateWifiOnly();
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002758 } else {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002759 // Dump state for the default case. This also drops root.
Nandana Dutt5c390032019-03-12 10:52:56 +00002760 RunStatus s = DumpstateDefault();
2761 if (s != RunStatus::OK) {
Nandana Duttaac6f582019-07-26 14:32:47 +01002762 if (s == RunStatus::USER_CONSENT_DENIED) {
Nandana Dutt5c390032019-03-12 10:52:56 +00002763 HandleUserConsentDenied();
2764 }
2765 return s;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002766 }
Zhengyin Qian068ecc72016-08-10 16:48:14 -07002767 }
Felipe Leme71a74ac2016-03-17 15:43:25 -07002768
Felipe Leme55b42a62015-11-10 17:39:08 -08002769 /* close output if needed */
Felipe Leme71bbfc52015-11-23 14:14:51 -08002770 if (is_redirecting) {
Vishnu Nair20cf5032018-01-05 13:15:49 -08002771 TEMP_FAILURE_RETRY(dup2(dup_stdout_fd, fileno(stdout)));
Colin Crossf45fa6b2012-03-26 12:38:26 -07002772 }
2773
Nandana Duttd2f5f082019-01-18 17:13:52 +00002774 // Rename, and/or zip the (now complete) .tmp file within the internal directory.
Nandana Dutt9a76d202019-01-21 15:56:48 +00002775 if (options_->OutputToFile()) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002776 FinalizeFile();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002777 }
2778
Nandana Duttd2f5f082019-01-18 17:13:52 +00002779 // Share the final file with the caller if the user has consented.
2780 Dumpstate::RunStatus status = Dumpstate::RunStatus::OK;
2781 if (options_->bugreport_fd.get() != -1) {
2782 status = CopyBugreportIfUserConsented();
2783 if (status != Dumpstate::RunStatus::OK &&
2784 status != Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2785 // Do an early return if there were errors. We make an exception for consent
2786 // timing out because it's possible the user got distracted. In this case the
2787 // bugreport is not shared but made available for manual retrieval.
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002788 MYLOGI("User denied consent. Returning\n");
Nandana Duttd2f5f082019-01-18 17:13:52 +00002789 return status;
2790 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002791 if (options_->do_fb && options_->screenshot_fd.get() != -1) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00002792 bool copy_succeeded = android::os::CopyFileToFd(screenshot_path_,
2793 options_->screenshot_fd.get());
2794 if (copy_succeeded) {
2795 android::os::UnlinkAndLogOnError(screenshot_path_);
2796 }
2797 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002798 if (status == Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2799 MYLOGI(
2800 "Did not receive user consent yet."
2801 " Will not copy the bugreport artifacts to caller.\n");
Abhijeet Kaur57627412019-04-17 16:00:09 +01002802 const String16 incidentcompanion("incidentcompanion");
2803 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
2804 if (ics != nullptr) {
2805 MYLOGD("Canceling user consent request via incidentcompanion service\n");
2806 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
2807 consent_callback_.get());
2808 } else {
2809 MYLOGD("Unable to cancel user consent; incidentcompanion service unavailable\n");
2810 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002811 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00002812 }
2813
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002814 /* vibrate a few but shortly times to let user know it's finished */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002815 if (options_->do_vibrate) {
Takuya Ogawa47f644e2017-12-20 18:09:09 +09002816 for (int i = 0; i < 3; i++) {
2817 Vibrate(75);
2818 usleep((75 + 50) * 1000);
2819 }
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002820 }
2821
Jeff Brown1dc94e32014-09-11 14:15:27 -07002822 /* tell activity manager we're done */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002823 if (options_->do_broadcast) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002824 SendBugreportFinishedBroadcast();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002825 // Note that listener_ is notified in Run();
Jeff Sharkey27f9e6d2013-03-13 15:45:50 -07002826 }
2827
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002828 MYLOGD("Final progress: %d/%d (estimated %d)\n", progress_->Get(), progress_->GetMax(),
2829 progress_->GetInitialMax());
2830 progress_->Save();
2831 MYLOGI("done (id %d)\n", id_);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002832
Felipe Leme107a05f2016-03-08 15:11:15 -08002833 if (is_redirecting) {
Vishnu Nair20cf5032018-01-05 13:15:49 -08002834 TEMP_FAILURE_RETRY(dup2(dup_stderr_fd, fileno(stderr)));
Felipe Leme107a05f2016-03-08 15:11:15 -08002835 }
2836
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002837 if (options_->use_control_socket && control_socket_fd_ != -1) {
Felipe Lemee844a9d2016-09-21 15:01:39 -07002838 MYLOGD("Closing control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002839 close(control_socket_fd_);
Felipe Leme2628e9e2016-04-12 16:36:51 -07002840 }
2841
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002842 tombstone_data_.clear();
2843 anr_data_.clear();
Narayan Kamath6b9516c2017-10-27 11:15:51 +01002844
Nandana Duttd2f5f082019-01-18 17:13:52 +00002845 return (consent_callback_ != nullptr &&
2846 consent_callback_->getResult() == UserConsentResult::UNAVAILABLE)
2847 ? USER_CONSENT_TIMED_OUT
2848 : RunStatus::OK;
2849}
2850
2851void Dumpstate::CheckUserConsent(int32_t calling_uid, const android::String16& calling_package) {
2852 consent_callback_ = new ConsentCallback();
2853 const String16 incidentcompanion("incidentcompanion");
2854 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
2855 if (ics != nullptr) {
2856 MYLOGD("Checking user consent via incidentcompanion service\n");
2857 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
Joe Onorato1c36d752019-03-17 18:26:43 -07002858 calling_uid, calling_package, String16(), String16(),
2859 0x1 /* FLAG_CONFIRMATION_DIALOG */, consent_callback_.get());
Nandana Duttd2f5f082019-01-18 17:13:52 +00002860 } else {
2861 MYLOGD("Unable to check user consent; incidentcompanion service unavailable\n");
2862 }
2863}
2864
Nandana Dutt5c390032019-03-12 10:52:56 +00002865bool Dumpstate::IsUserConsentDenied() const {
2866 return ds.consent_callback_ != nullptr &&
2867 ds.consent_callback_->getResult() == UserConsentResult::DENIED;
2868}
2869
Nandana Duttd2f5f082019-01-18 17:13:52 +00002870void Dumpstate::CleanupFiles() {
2871 android::os::UnlinkAndLogOnError(tmp_path_);
2872 android::os::UnlinkAndLogOnError(screenshot_path_);
2873 android::os::UnlinkAndLogOnError(path_);
2874}
2875
2876Dumpstate::RunStatus Dumpstate::HandleUserConsentDenied() {
2877 MYLOGD("User denied consent; deleting files and returning\n");
2878 CleanupFiles();
2879 return USER_CONSENT_DENIED;
2880}
2881
2882Dumpstate::RunStatus Dumpstate::CopyBugreportIfUserConsented() {
2883 // If the caller has asked to copy the bugreport over to their directory, we need explicit
2884 // user consent.
2885 UserConsentResult consent_result = consent_callback_->getResult();
2886 if (consent_result == UserConsentResult::UNAVAILABLE) {
2887 // User has not responded yet.
2888 uint64_t elapsed_ms = consent_callback_->getElapsedTimeMs();
Hunter Knepshield70610fa2020-01-03 15:27:33 -08002889 // Telephony is a fast report type, particularly on user builds where information may be
2890 // more aggressively limited. To give the user time to read the consent dialog, increase the
2891 // timeout.
2892 uint64_t timeout_ms = options_->telephony_only ? TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS
2893 : USER_CONSENT_TIMEOUT_MS;
2894 if (elapsed_ms < timeout_ms) {
2895 uint delay_seconds = (timeout_ms - elapsed_ms) / 1000;
Nandana Duttd2f5f082019-01-18 17:13:52 +00002896 MYLOGD("Did not receive user consent yet; going to wait for %d seconds", delay_seconds);
2897 sleep(delay_seconds);
2898 }
2899 consent_result = consent_callback_->getResult();
2900 }
2901 if (consent_result == UserConsentResult::DENIED) {
2902 // User has explicitly denied sharing with the app. To be safe delete the
2903 // internal bugreport & tmp files.
2904 return HandleUserConsentDenied();
2905 }
2906 if (consent_result == UserConsentResult::APPROVED) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00002907 bool copy_succeeded = android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
2908 if (copy_succeeded) {
2909 android::os::UnlinkAndLogOnError(path_);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002910 }
2911 return copy_succeeded ? Dumpstate::RunStatus::OK : Dumpstate::RunStatus::ERROR;
2912 } else if (consent_result == UserConsentResult::UNAVAILABLE) {
2913 // consent_result is still UNAVAILABLE. The user has likely not responded yet.
2914 // Since we do not have user consent to share the bugreport it does not get
2915 // copied over to the calling app but remains in the internal directory from
2916 // where the user can manually pull it.
2917 return Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT;
2918 }
2919 // Unknown result; must be a programming error.
2920 MYLOGE("Unknown user consent result:%d\n", consent_result);
2921 return Dumpstate::RunStatus::ERROR;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002922}
2923
Nandana Duttf02564e2019-02-15 15:24:24 +00002924Dumpstate::RunStatus Dumpstate::ParseCommandlineAndRun(int argc, char* argv[]) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002925 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
2926 Dumpstate::RunStatus status = options->Initialize(argc, argv);
2927 if (status == Dumpstate::RunStatus::OK) {
Nandana Duttf02564e2019-02-15 15:24:24 +00002928 SetOptions(std::move(options));
Nandana Duttd2f5f082019-01-18 17:13:52 +00002929 // When directly running dumpstate binary, the output is not expected to be written
2930 // to any external file descriptor.
Nandana Duttf02564e2019-02-15 15:24:24 +00002931 assert(options_->bugreport_fd.get() == -1);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002932
2933 // calling_uid and calling_package are for user consent to share the bugreport with
2934 // an app; they are irrelvant here because bugreport is only written to a local
2935 // directory, and not shared.
Nandana Duttf02564e2019-02-15 15:24:24 +00002936 status = Run(-1 /* calling_uid */, "" /* calling_package */);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002937 }
Nandana Duttf02564e2019-02-15 15:24:24 +00002938 return status;
2939}
2940
2941/* Main entry point for dumpstate binary. */
2942int run_main(int argc, char* argv[]) {
2943 Dumpstate::RunStatus status = ds.ParseCommandlineAndRun(argc, argv);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002944
2945 switch (status) {
2946 case Dumpstate::RunStatus::OK:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002947 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002948 case Dumpstate::RunStatus::HELP:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002949 ShowUsage();
2950 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002951 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002952 fprintf(stderr, "Invalid combination of args\n");
2953 ShowUsage();
2954 exit(1);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002955 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002956 FALLTHROUGH_INTENDED;
2957 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2958 FALLTHROUGH_INTENDED;
2959 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002960 exit(2);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002961 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002962}
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002963
2964// TODO(111441001): Default DumpOptions to sensible values.
2965Dumpstate::Dumpstate(const std::string& version)
2966 : pid_(getpid()),
2967 options_(new Dumpstate::DumpOptions()),
Nandana Duttf02cd782019-06-14 14:25:13 +01002968 last_reported_percent_progress_(0),
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002969 version_(version),
2970 now_(time(nullptr)) {
2971}
2972
2973Dumpstate& Dumpstate::GetInstance() {
2974 static Dumpstate singleton_(android::base::GetProperty("dumpstate.version", VERSION_CURRENT));
2975 return singleton_;
2976}
2977
Nandana Dutt8d945c02019-08-14 13:30:07 +01002978DurationReporter::DurationReporter(const std::string& title, bool logcat_only, bool verbose)
2979 : title_(title), logcat_only_(logcat_only), verbose_(verbose) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002980 if (!title_.empty()) {
2981 started_ = Nanotime();
2982 }
2983}
2984
2985DurationReporter::~DurationReporter() {
2986 if (!title_.empty()) {
2987 float elapsed = (float)(Nanotime() - started_) / NANOS_PER_SEC;
chenqiwuaf8b2d92019-12-12 18:53:51 +08002988 if (elapsed >= .5f || verbose_) {
2989 MYLOGD("Duration of '%s': %.2fs\n", title_.c_str(), elapsed);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002990 }
chenqiwuaf8b2d92019-12-12 18:53:51 +08002991 if (!logcat_only_) {
2992 // Use "Yoda grammar" to make it easier to grep|sort sections.
2993 printf("------ %.3fs was the duration of '%s' ------\n", elapsed, title_.c_str());
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002994 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002995 }
2996}
2997
2998const int32_t Progress::kDefaultMax = 5000;
2999
3000Progress::Progress(const std::string& path) : Progress(Progress::kDefaultMax, 1.1, path) {
3001}
3002
3003Progress::Progress(int32_t initial_max, int32_t progress, float growth_factor)
3004 : Progress(initial_max, growth_factor, "") {
3005 progress_ = progress;
3006}
3007
3008Progress::Progress(int32_t initial_max, float growth_factor, const std::string& path)
3009 : initial_max_(initial_max),
3010 progress_(0),
3011 max_(initial_max),
3012 growth_factor_(growth_factor),
3013 n_runs_(0),
3014 average_max_(0),
3015 path_(path) {
3016 if (!path_.empty()) {
3017 Load();
3018 }
3019}
3020
3021void Progress::Load() {
3022 MYLOGD("Loading stats from %s\n", path_.c_str());
3023 std::string content;
3024 if (!android::base::ReadFileToString(path_, &content)) {
3025 MYLOGI("Could not read stats from %s; using max of %d\n", path_.c_str(), max_);
3026 return;
3027 }
3028 if (content.empty()) {
3029 MYLOGE("No stats (empty file) on %s; using max of %d\n", path_.c_str(), max_);
3030 return;
3031 }
3032 std::vector<std::string> lines = android::base::Split(content, "\n");
3033
3034 if (lines.size() < 1) {
3035 MYLOGE("Invalid stats on file %s: not enough lines (%d). Using max of %d\n", path_.c_str(),
3036 (int)lines.size(), max_);
3037 return;
3038 }
3039 char* ptr;
3040 n_runs_ = strtol(lines[0].c_str(), &ptr, 10);
3041 average_max_ = strtol(ptr, nullptr, 10);
3042 if (n_runs_ <= 0 || average_max_ <= 0 || n_runs_ > STATS_MAX_N_RUNS ||
3043 average_max_ > STATS_MAX_AVERAGE) {
3044 MYLOGE("Invalid stats line on file %s: %s\n", path_.c_str(), lines[0].c_str());
3045 initial_max_ = Progress::kDefaultMax;
3046 } else {
3047 initial_max_ = average_max_;
3048 }
3049 max_ = initial_max_;
3050
3051 MYLOGI("Average max progress: %d in %d runs; estimated max: %d\n", average_max_, n_runs_, max_);
3052}
3053
3054void Progress::Save() {
3055 int32_t total = n_runs_ * average_max_ + progress_;
3056 int32_t runs = n_runs_ + 1;
3057 int32_t average = floor(((float)total) / runs);
3058 MYLOGI("Saving stats (total=%d, runs=%d, average=%d) on %s\n", total, runs, average,
3059 path_.c_str());
3060 if (path_.empty()) {
3061 return;
3062 }
3063
3064 std::string content = android::base::StringPrintf("%d %d\n", runs, average);
3065 if (!android::base::WriteStringToFile(content, path_)) {
3066 MYLOGE("Could not save stats on %s\n", path_.c_str());
3067 }
3068}
3069
3070int32_t Progress::Get() const {
3071 return progress_;
3072}
3073
3074bool Progress::Inc(int32_t delta_sec) {
3075 bool changed = false;
3076 if (delta_sec >= 0) {
3077 progress_ += delta_sec;
3078 if (progress_ > max_) {
3079 int32_t old_max = max_;
3080 max_ = floor((float)progress_ * growth_factor_);
3081 MYLOGD("Adjusting max progress from %d to %d\n", old_max, max_);
3082 changed = true;
3083 }
3084 }
3085 return changed;
3086}
3087
3088int32_t Progress::GetMax() const {
3089 return max_;
3090}
3091
3092int32_t Progress::GetInitialMax() const {
3093 return initial_max_;
3094}
3095
3096void Progress::Dump(int fd, const std::string& prefix) const {
3097 const char* pr = prefix.c_str();
3098 dprintf(fd, "%sprogress: %d\n", pr, progress_);
3099 dprintf(fd, "%smax: %d\n", pr, max_);
3100 dprintf(fd, "%sinitial_max: %d\n", pr, initial_max_);
3101 dprintf(fd, "%sgrowth_factor: %0.2f\n", pr, growth_factor_);
3102 dprintf(fd, "%spath: %s\n", pr, path_.c_str());
3103 dprintf(fd, "%sn_runs: %d\n", pr, n_runs_);
3104 dprintf(fd, "%saverage_max: %d\n", pr, average_max_);
3105}
3106
3107bool Dumpstate::IsZipping() const {
3108 return zip_writer_ != nullptr;
3109}
3110
3111std::string Dumpstate::GetPath(const std::string& suffix) const {
3112 return GetPath(bugreport_internal_dir_, suffix);
3113}
3114
3115std::string Dumpstate::GetPath(const std::string& directory, const std::string& suffix) const {
3116 return android::base::StringPrintf("%s/%s-%s%s", directory.c_str(), base_name_.c_str(),
3117 name_.c_str(), suffix.c_str());
3118}
3119
3120void Dumpstate::SetProgress(std::unique_ptr<Progress> progress) {
3121 progress_ = std::move(progress);
3122}
3123
3124void for_each_userid(void (*func)(int), const char *header) {
3125 std::string title = header == nullptr ? "for_each_userid" : android::base::StringPrintf(
3126 "for_each_userid(%s)", header);
3127 DurationReporter duration_reporter(title);
3128 if (PropertiesHelper::IsDryRun()) return;
3129
3130 DIR *d;
3131 struct dirent *de;
3132
3133 if (header) printf("\n------ %s ------\n", header);
3134 func(0);
3135
3136 if (!(d = opendir("/data/system/users"))) {
3137 printf("Failed to open /data/system/users (%s)\n", strerror(errno));
3138 return;
3139 }
3140
3141 while ((de = readdir(d))) {
3142 int userid;
3143 if (de->d_type != DT_DIR || !(userid = atoi(de->d_name))) {
3144 continue;
3145 }
3146 func(userid);
3147 }
3148
3149 closedir(d);
3150}
3151
3152static void __for_each_pid(void (*helper)(int, const char *, void *), const char *header, void *arg) {
3153 DIR *d;
3154 struct dirent *de;
3155
3156 if (!(d = opendir("/proc"))) {
3157 printf("Failed to open /proc (%s)\n", strerror(errno));
3158 return;
3159 }
3160
3161 if (header) printf("\n------ %s ------\n", header);
3162 while ((de = readdir(d))) {
3163 if (ds.IsUserConsentDenied()) {
3164 MYLOGE(
3165 "Returning early because user denied consent to share bugreport with calling app.");
3166 closedir(d);
3167 return;
3168 }
3169 int pid;
3170 int fd;
3171 char cmdpath[255];
3172 char cmdline[255];
3173
3174 if (!(pid = atoi(de->d_name))) {
3175 continue;
3176 }
3177
3178 memset(cmdline, 0, sizeof(cmdline));
3179
3180 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/cmdline", pid);
3181 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3182 TEMP_FAILURE_RETRY(read(fd, cmdline, sizeof(cmdline) - 2));
3183 close(fd);
3184 if (cmdline[0]) {
3185 helper(pid, cmdline, arg);
3186 continue;
3187 }
3188 }
3189
3190 // if no cmdline, a kernel thread has comm
3191 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/comm", pid);
3192 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3193 TEMP_FAILURE_RETRY(read(fd, cmdline + 1, sizeof(cmdline) - 4));
3194 close(fd);
3195 if (cmdline[1]) {
3196 cmdline[0] = '[';
3197 size_t len = strcspn(cmdline, "\f\b\r\n");
3198 cmdline[len] = ']';
3199 cmdline[len+1] = '\0';
3200 }
3201 }
3202 if (!cmdline[0]) {
3203 strcpy(cmdline, "N/A");
3204 }
3205 helper(pid, cmdline, arg);
3206 }
3207
3208 closedir(d);
3209}
3210
3211static void for_each_pid_helper(int pid, const char *cmdline, void *arg) {
3212 for_each_pid_func *func = (for_each_pid_func*) arg;
3213 func(pid, cmdline);
3214}
3215
3216void for_each_pid(for_each_pid_func func, const char *header) {
3217 std::string title = header == nullptr ? "for_each_pid"
3218 : android::base::StringPrintf("for_each_pid(%s)", header);
3219 DurationReporter duration_reporter(title);
3220 if (PropertiesHelper::IsDryRun()) return;
3221
3222 __for_each_pid(for_each_pid_helper, header, (void *) func);
3223}
3224
3225static void for_each_tid_helper(int pid, const char *cmdline, void *arg) {
3226 DIR *d;
3227 struct dirent *de;
3228 char taskpath[255];
3229 for_each_tid_func *func = (for_each_tid_func *) arg;
3230
3231 snprintf(taskpath, sizeof(taskpath), "/proc/%d/task", pid);
3232
3233 if (!(d = opendir(taskpath))) {
3234 printf("Failed to open %s (%s)\n", taskpath, strerror(errno));
3235 return;
3236 }
3237
3238 func(pid, pid, cmdline);
3239
3240 while ((de = readdir(d))) {
3241 if (ds.IsUserConsentDenied()) {
3242 MYLOGE(
3243 "Returning early because user denied consent to share bugreport with calling app.");
3244 closedir(d);
3245 return;
3246 }
3247 int tid;
3248 int fd;
3249 char commpath[255];
3250 char comm[255];
3251
3252 if (!(tid = atoi(de->d_name))) {
3253 continue;
3254 }
3255
3256 if (tid == pid)
3257 continue;
3258
3259 snprintf(commpath, sizeof(commpath), "/proc/%d/comm", tid);
3260 memset(comm, 0, sizeof(comm));
3261 if ((fd = TEMP_FAILURE_RETRY(open(commpath, O_RDONLY | O_CLOEXEC))) < 0) {
3262 strcpy(comm, "N/A");
3263 } else {
3264 char *c;
3265 TEMP_FAILURE_RETRY(read(fd, comm, sizeof(comm) - 2));
3266 close(fd);
3267
3268 c = strrchr(comm, '\n');
3269 if (c) {
3270 *c = '\0';
3271 }
3272 }
3273 func(pid, tid, comm);
3274 }
3275
3276 closedir(d);
3277}
3278
3279void for_each_tid(for_each_tid_func func, const char *header) {
3280 std::string title = header == nullptr ? "for_each_tid"
3281 : android::base::StringPrintf("for_each_tid(%s)", header);
3282 DurationReporter duration_reporter(title);
3283
3284 if (PropertiesHelper::IsDryRun()) return;
3285
3286 __for_each_pid(for_each_tid_helper, header, (void *) func);
3287}
3288
3289void show_wchan(int pid, int tid, const char *name) {
3290 if (PropertiesHelper::IsDryRun()) return;
3291
3292 char path[255];
3293 char buffer[255];
3294 int fd, ret, save_errno;
3295 char name_buffer[255];
3296
3297 memset(buffer, 0, sizeof(buffer));
3298
3299 snprintf(path, sizeof(path), "/proc/%d/wchan", tid);
3300 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3301 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3302 return;
3303 }
3304
3305 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3306 save_errno = errno;
3307 close(fd);
3308
3309 if (ret < 0) {
3310 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3311 return;
3312 }
3313
3314 snprintf(name_buffer, sizeof(name_buffer), "%*s%s",
3315 pid == tid ? 0 : 3, "", name);
3316
3317 printf("%-7d %-32s %s\n", tid, name_buffer, buffer);
3318
3319 return;
3320}
3321
3322// print time in centiseconds
3323static void snprcent(char *buffer, size_t len, size_t spc,
3324 unsigned long long time) {
3325 static long hz; // cache discovered hz
3326
3327 if (hz <= 0) {
3328 hz = sysconf(_SC_CLK_TCK);
3329 if (hz <= 0) {
3330 hz = 1000;
3331 }
3332 }
3333
3334 // convert to centiseconds
3335 time = (time * 100 + (hz / 2)) / hz;
3336
3337 char str[16];
3338
3339 snprintf(str, sizeof(str), " %llu.%02u",
3340 time / 100, (unsigned)(time % 100));
3341 size_t offset = strlen(buffer);
3342 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3343 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3344}
3345
3346// print permille as a percent
3347static void snprdec(char *buffer, size_t len, size_t spc, unsigned permille) {
3348 char str[16];
3349
3350 snprintf(str, sizeof(str), " %u.%u%%", permille / 10, permille % 10);
3351 size_t offset = strlen(buffer);
3352 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3353 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3354}
3355
3356void show_showtime(int pid, const char *name) {
3357 if (PropertiesHelper::IsDryRun()) return;
3358
3359 char path[255];
3360 char buffer[1023];
3361 int fd, ret, save_errno;
3362
3363 memset(buffer, 0, sizeof(buffer));
3364
3365 snprintf(path, sizeof(path), "/proc/%d/stat", pid);
3366 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3367 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3368 return;
3369 }
3370
3371 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3372 save_errno = errno;
3373 close(fd);
3374
3375 if (ret < 0) {
3376 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3377 return;
3378 }
3379
3380 // field 14 is utime
3381 // field 15 is stime
3382 // field 42 is iotime
3383 unsigned long long utime = 0, stime = 0, iotime = 0;
3384 if (sscanf(buffer,
3385 "%*u %*s %*s %*d %*d %*d %*d %*d %*d %*d %*d "
3386 "%*d %*d %llu %llu %*d %*d %*d %*d %*d %*d "
3387 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %*d "
3388 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %llu ",
3389 &utime, &stime, &iotime) != 3) {
3390 return;
3391 }
3392
3393 unsigned long long total = utime + stime;
3394 if (!total) {
3395 return;
3396 }
3397
3398 unsigned permille = (iotime * 1000 + (total / 2)) / total;
3399 if (permille > 1000) {
3400 permille = 1000;
3401 }
3402
3403 // try to beautify and stabilize columns at <80 characters
3404 snprintf(buffer, sizeof(buffer), "%-6d%s", pid, name);
3405 if ((name[0] != '[') || utime) {
3406 snprcent(buffer, sizeof(buffer), 57, utime);
3407 }
3408 snprcent(buffer, sizeof(buffer), 65, stime);
3409 if ((name[0] != '[') || iotime) {
3410 snprcent(buffer, sizeof(buffer), 73, iotime);
3411 }
3412 if (iotime) {
3413 snprdec(buffer, sizeof(buffer), 79, permille);
3414 }
3415 puts(buffer); // adds a trailing newline
3416
3417 return;
3418}
3419
3420void do_dmesg() {
3421 const char *title = "KERNEL LOG (dmesg)";
3422 DurationReporter duration_reporter(title);
3423 printf("------ %s ------\n", title);
3424
3425 if (PropertiesHelper::IsDryRun()) return;
3426
3427 /* Get size of kernel buffer */
3428 int size = klogctl(KLOG_SIZE_BUFFER, nullptr, 0);
3429 if (size <= 0) {
3430 printf("Unexpected klogctl return value: %d\n\n", size);
3431 return;
3432 }
3433 char *buf = (char *) malloc(size + 1);
3434 if (buf == nullptr) {
3435 printf("memory allocation failed\n\n");
3436 return;
3437 }
3438 int retval = klogctl(KLOG_READ_ALL, buf, size);
3439 if (retval < 0) {
3440 printf("klogctl failure\n\n");
3441 free(buf);
3442 return;
3443 }
3444 buf[retval] = '\0';
3445 printf("%s\n\n", buf);
3446 free(buf);
3447 return;
3448}
3449
3450void do_showmap(int pid, const char *name) {
3451 char title[255];
3452 char arg[255];
3453
3454 snprintf(title, sizeof(title), "SHOW MAP %d (%s)", pid, name);
3455 snprintf(arg, sizeof(arg), "%d", pid);
3456 RunCommand(title, {"showmap", "-q", arg}, CommandOptions::AS_ROOT);
3457}
3458
3459int Dumpstate::DumpFile(const std::string& title, const std::string& path) {
3460 DurationReporter duration_reporter(title);
3461
3462 int status = DumpFileToFd(STDOUT_FILENO, title, path);
3463
3464 UpdateProgress(WEIGHT_FILE);
3465
3466 return status;
3467}
3468
3469int read_file_as_long(const char *path, long int *output) {
3470 int fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC));
3471 if (fd < 0) {
3472 int err = errno;
3473 MYLOGE("Error opening file descriptor for %s: %s\n", path, strerror(err));
3474 return -1;
3475 }
3476 char buffer[50];
3477 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3478 if (bytes_read == -1) {
3479 MYLOGE("Error reading file %s: %s\n", path, strerror(errno));
3480 return -2;
3481 }
3482 if (bytes_read == 0) {
3483 MYLOGE("File %s is empty\n", path);
3484 return -3;
3485 }
3486 *output = atoi(buffer);
3487 return 0;
3488}
3489
3490/* calls skip to gate calling dump_from_fd recursively
3491 * in the specified directory. dump_from_fd defaults to
3492 * dump_file_from_fd above when set to NULL. skip defaults
3493 * to false when set to NULL. dump_from_fd will always be
3494 * called with title NULL.
3495 */
3496int dump_files(const std::string& title, const char* dir, bool (*skip)(const char* path),
3497 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
3498 DurationReporter duration_reporter(title);
3499 DIR *dirp;
3500 struct dirent *d;
3501 char *newpath = nullptr;
3502 const char *slash = "/";
3503 int retval = 0;
3504
3505 if (!title.empty()) {
3506 printf("------ %s (%s) ------\n", title.c_str(), dir);
3507 }
3508 if (PropertiesHelper::IsDryRun()) return 0;
3509
3510 if (dir[strlen(dir) - 1] == '/') {
3511 ++slash;
3512 }
3513 dirp = opendir(dir);
3514 if (dirp == nullptr) {
3515 retval = -errno;
3516 MYLOGE("%s: %s\n", dir, strerror(errno));
3517 return retval;
3518 }
3519
3520 if (!dump_from_fd) {
3521 dump_from_fd = dump_file_from_fd;
3522 }
3523 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
3524 if ((d->d_name[0] == '.')
3525 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
3526 || (d->d_name[1] == '\0'))) {
3527 continue;
3528 }
3529 asprintf(&newpath, "%s%s%s%s", dir, slash, d->d_name,
3530 (d->d_type == DT_DIR) ? "/" : "");
3531 if (!newpath) {
3532 retval = -errno;
3533 continue;
3534 }
3535 if (skip && (*skip)(newpath)) {
3536 continue;
3537 }
3538 if (d->d_type == DT_DIR) {
3539 int ret = dump_files("", newpath, skip, dump_from_fd);
3540 if (ret < 0) {
3541 retval = ret;
3542 }
3543 continue;
3544 }
3545 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(newpath, O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
3546 if (fd.get() < 0) {
3547 retval = -1;
3548 printf("*** %s: %s\n", newpath, strerror(errno));
3549 continue;
3550 }
3551 (*dump_from_fd)(nullptr, newpath, fd.get());
3552 }
3553 closedir(dirp);
3554 if (!title.empty()) {
3555 printf("\n");
3556 }
3557 return retval;
3558}
3559
3560/* fd must have been opened with the flag O_NONBLOCK. With this flag set,
3561 * it's possible to avoid issues where opening the file itself can get
3562 * stuck.
3563 */
3564int dump_file_from_fd(const char *title, const char *path, int fd) {
3565 if (PropertiesHelper::IsDryRun()) return 0;
3566
3567 int flags = fcntl(fd, F_GETFL);
3568 if (flags == -1) {
3569 printf("*** %s: failed to get flags on fd %d: %s\n", path, fd, strerror(errno));
3570 return -1;
3571 } else if (!(flags & O_NONBLOCK)) {
3572 printf("*** %s: fd must have O_NONBLOCK set.\n", path);
3573 return -1;
3574 }
3575 return DumpFileFromFdToFd(title, path, fd, STDOUT_FILENO, PropertiesHelper::IsDryRun());
3576}
3577
3578int Dumpstate::RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Nandana Dutt8d945c02019-08-14 13:30:07 +01003579 const CommandOptions& options, bool verbose_duration) {
3580 DurationReporter duration_reporter(title, false /* logcat_only */, verbose_duration);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003581
3582 int status = RunCommandToFd(STDOUT_FILENO, title, full_command, options);
3583
3584 /* TODO: for now we're simplifying the progress calculation by using the
3585 * timeout as the weight. It's a good approximation for most cases, except when calling dumpsys,
3586 * where its weight should be much higher proportionally to its timeout.
3587 * Ideally, it should use a options.EstimatedDuration() instead...*/
3588 UpdateProgress(options.Timeout());
3589
3590 return status;
3591}
3592
3593void Dumpstate::RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsys_args,
3594 const CommandOptions& options, long dumpsysTimeoutMs) {
3595 long timeout_ms = dumpsysTimeoutMs > 0 ? dumpsysTimeoutMs : options.TimeoutInMs();
3596 std::vector<std::string> dumpsys = {"/system/bin/dumpsys", "-T", std::to_string(timeout_ms)};
3597 dumpsys.insert(dumpsys.end(), dumpsys_args.begin(), dumpsys_args.end());
3598 RunCommand(title, dumpsys, options);
3599}
3600
3601int open_socket(const char *service) {
3602 int s = android_get_control_socket(service);
3603 if (s < 0) {
3604 MYLOGE("android_get_control_socket(%s): %s\n", service, strerror(errno));
3605 return -1;
3606 }
3607 fcntl(s, F_SETFD, FD_CLOEXEC);
3608
3609 // Set backlog to 0 to make sure that queue size will be minimum.
3610 // In Linux, because the minimum queue will be 1, connect() will be blocked
3611 // if the other clients already called connect() and the connection request was not accepted.
3612 if (listen(s, 0) < 0) {
3613 MYLOGE("listen(control socket): %s\n", strerror(errno));
3614 return -1;
3615 }
3616
3617 struct sockaddr addr;
3618 socklen_t alen = sizeof(addr);
Abhijeet Kaur2113cae2019-09-13 09:24:15 +01003619 int fd = accept4(s, &addr, &alen, SOCK_CLOEXEC);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003620
3621 // Close socket just after accept(), to make sure that connect() by client will get error
3622 // when the socket is used by the other services.
3623 // There is still a race condition possibility between accept and close, but there is no way
3624 // to close-on-accept atomically.
3625 // See detail; b/123306389#comment25
3626 close(s);
3627
3628 if (fd < 0) {
3629 MYLOGE("accept(control socket): %s\n", strerror(errno));
3630 return -1;
3631 }
3632
3633 return fd;
3634}
3635
3636/* redirect output to a service control socket */
3637bool redirect_to_socket(FILE* redirect, const char* service) {
3638 int fd = open_socket(service);
3639 if (fd == -1) {
3640 return false;
3641 }
3642 fflush(redirect);
3643 // TODO: handle dup2 failure
3644 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
3645 close(fd);
3646 return true;
3647}
3648
3649// TODO: should call is_valid_output_file and/or be merged into it.
3650void create_parent_dirs(const char *path) {
3651 char *chp = const_cast<char *> (path);
3652
3653 /* skip initial slash */
3654 if (chp[0] == '/')
3655 chp++;
3656
3657 /* create leading directories, if necessary */
3658 struct stat dir_stat;
3659 while (chp && chp[0]) {
3660 chp = strchr(chp, '/');
3661 if (chp) {
3662 *chp = 0;
3663 if (stat(path, &dir_stat) == -1 || !S_ISDIR(dir_stat.st_mode)) {
3664 MYLOGI("Creating directory %s\n", path);
3665 if (mkdir(path, 0770)) { /* drwxrwx--- */
3666 MYLOGE("Unable to create directory %s: %s\n", path, strerror(errno));
3667 } else if (chown(path, AID_SHELL, AID_SHELL)) {
3668 MYLOGE("Unable to change ownership of dir %s: %s\n", path, strerror(errno));
3669 }
3670 }
3671 *chp++ = '/';
3672 }
3673 }
3674}
3675
3676bool _redirect_to_file(FILE* redirect, char* path, int truncate_flag) {
3677 create_parent_dirs(path);
3678
3679 int fd = TEMP_FAILURE_RETRY(open(path,
3680 O_WRONLY | O_CREAT | truncate_flag | O_CLOEXEC | O_NOFOLLOW,
3681 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH));
3682 if (fd < 0) {
3683 MYLOGE("%s: %s\n", path, strerror(errno));
3684 return false;
3685 }
3686
3687 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
3688 close(fd);
3689 return true;
3690}
3691
3692bool redirect_to_file(FILE* redirect, char* path) {
3693 return _redirect_to_file(redirect, path, O_TRUNC);
3694}
3695
3696bool redirect_to_existing_file(FILE* redirect, char* path) {
3697 return _redirect_to_file(redirect, path, O_APPEND);
3698}
3699
3700void dump_route_tables() {
3701 DurationReporter duration_reporter("DUMP ROUTE TABLES");
3702 if (PropertiesHelper::IsDryRun()) return;
3703 const char* const RT_TABLES_PATH = "/data/misc/net/rt_tables";
3704 ds.DumpFile("RT_TABLES", RT_TABLES_PATH);
3705 FILE* fp = fopen(RT_TABLES_PATH, "re");
3706 if (!fp) {
3707 printf("*** %s: %s\n", RT_TABLES_PATH, strerror(errno));
3708 return;
3709 }
3710 char table[16];
3711 // Each line has an integer (the table number), a space, and a string (the table name). We only
3712 // need the table number. It's a 32-bit unsigned number, so max 10 chars. Skip the table name.
3713 // Add a fixed max limit so this doesn't go awry.
3714 for (int i = 0; i < 64 && fscanf(fp, " %10s %*s", table) == 1; ++i) {
3715 RunCommand("ROUTE TABLE IPv4", {"ip", "-4", "route", "show", "table", table});
3716 RunCommand("ROUTE TABLE IPv6", {"ip", "-6", "route", "show", "table", table});
3717 }
3718 fclose(fp);
3719}
3720
3721// TODO: make this function thread safe if sections are generated in parallel.
3722void Dumpstate::UpdateProgress(int32_t delta_sec) {
3723 if (progress_ == nullptr) {
3724 MYLOGE("UpdateProgress: progress_ not set\n");
3725 return;
3726 }
3727
3728 // Always update progess so stats can be tuned...
Nandana Duttf02cd782019-06-14 14:25:13 +01003729 progress_->Inc(delta_sec);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003730
3731 // ...but only notifiy listeners when necessary.
3732 if (!options_->do_progress_updates) return;
3733
3734 int progress = progress_->Get();
3735 int max = progress_->GetMax();
Nandana Duttf02cd782019-06-14 14:25:13 +01003736 int percent = 100 * progress / max;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003737
Nandana Duttf02cd782019-06-14 14:25:13 +01003738 if (last_reported_percent_progress_ > 0 && percent <= last_reported_percent_progress_) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003739 return;
3740 }
Nandana Duttf02cd782019-06-14 14:25:13 +01003741 last_reported_percent_progress_ = percent;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003742
3743 if (control_socket_fd_ >= 0) {
3744 dprintf(control_socket_fd_, "PROGRESS:%d/%d\n", progress, max);
3745 fsync(control_socket_fd_);
3746 }
3747
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003748 if (listener_ != nullptr) {
3749 if (percent % 5 == 0) {
3750 // We don't want to spam logcat, so only log multiples of 5.
3751 MYLOGD("Setting progress (%s): %d/%d (%d%%)\n", listener_name_.c_str(), progress, max,
3752 percent);
3753 } else {
3754 // stderr is ignored on normal invocations, but useful when calling
3755 // /system/bin/dumpstate directly for debuggging.
3756 fprintf(stderr, "Setting progress (%s): %d/%d (%d%%)\n", listener_name_.c_str(),
3757 progress, max, percent);
3758 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003759
3760 listener_->onProgress(percent);
3761 }
3762}
3763
3764void Dumpstate::TakeScreenshot(const std::string& path) {
3765 const std::string& real_path = path.empty() ? screenshot_path_ : path;
3766 int status =
3767 RunCommand("", {"/system/bin/screencap", "-p", real_path},
3768 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3769 if (status == 0) {
3770 MYLOGD("Screenshot saved on %s\n", real_path.c_str());
3771 } else {
3772 MYLOGE("Failed to take screenshot on %s\n", real_path.c_str());
3773 }
3774}
3775
3776bool is_dir(const char* pathname) {
3777 struct stat info;
3778 if (stat(pathname, &info) == -1) {
3779 return false;
3780 }
3781 return S_ISDIR(info.st_mode);
3782}
3783
3784time_t get_mtime(int fd, time_t default_mtime) {
3785 struct stat info;
3786 if (fstat(fd, &info) == -1) {
3787 return default_mtime;
3788 }
3789 return info.st_mtime;
3790}