blob: f8b2fdb6c76d6e397ba8b0885532b0e53b20ae90 [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;
Colin Crossf45fa6b2012-03-26 12:38:26 -0700138
Felipe Leme1d486fe2016-10-14 18:06:47 -0700139// TODO: variables and functions below should be part of dumpstate object
140
Felipe Leme635ca312016-01-05 14:23:02 -0800141static std::set<std::string> mount_points;
142void add_mountinfo();
Felipe Leme78f2c862015-12-21 09:55:22 -0800143
Todd Poynor2a83daa2013-11-22 15:44:22 -0800144#define PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops"
Mark Salyzyn7d0a7622016-06-24 14:06:15 -0700145#define ALT_PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops-0"
Wei Wang509bb5d2017-06-09 14:42:12 -0700146#define BLK_DEV_SYS_DIR "/sys/block"
Todd Poynor2a83daa2013-11-22 15:44:22 -0800147
Felipe Lemee82a27d2016-01-05 13:35:44 -0800148#define RECOVERY_DIR "/cache/recovery"
Mark Salyzynd6ab0112016-03-25 12:56:39 -0700149#define RECOVERY_DATA_DIR "/data/misc/recovery"
Tianjie Xu75d53362018-04-11 16:42:28 -0700150#define UPDATE_ENGINE_LOG_DIR "/data/misc/update_engine_log"
Mark Salyzyn4d42dea2016-04-01 10:03:14 -0700151#define LOGPERSIST_DATA_DIR "/data/misc/logd"
David Brazdild2991962016-06-03 14:40:44 +0100152#define PROFILE_DATA_DIR_CUR "/data/misc/profiles/cur"
153#define PROFILE_DATA_DIR_REF "/data/misc/profiles/ref"
Benedict Wong8f9d8a42019-01-03 16:19:38 -0800154#define XFRM_STAT_PROC_FILE "/proc/net/xfrm_stat"
Erik Kline08165202016-05-30 11:55:44 +0900155#define WLUTIL "/vendor/xbin/wlutil"
Vishnu Nair36b4cdb2017-11-17 10:27:05 -0800156#define WMTRACE_DATA_DIR "/data/misc/wmtrace"
Yifan Hong3945e1b2019-10-29 12:59:23 -0700157#define OTA_METADATA_DIR "/metadata/ota"
Yifan Hong0efa7972020-02-03 16:45:02 -0800158#define SNAPSHOTCTL_LOG_DIR "/data/misc/snapshotctl_log"
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700159
Narayan Kamath8f788292017-05-25 13:20:39 +0100160// TODO(narayan): Since this information has to be kept in sync
161// with tombstoned, we should just put it in a common header.
162//
163// File: system/core/debuggerd/tombstoned/tombstoned.cpp
Narayan Kamathbd863722017-06-01 18:50:12 +0100164static const std::string TOMBSTONE_DIR = "/data/tombstones/";
165static const std::string TOMBSTONE_FILE_PREFIX = "tombstone_";
166static const std::string ANR_DIR = "/data/anr/";
167static const std::string ANR_FILE_PREFIX = "anr_";
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700168
Felipe Lemee844a9d2016-09-21 15:01:39 -0700169// TODO: temporary variables and functions used during C++ refactoring
Nandana Dutt979388e2018-11-30 16:48:55 +0000170
Nandana Dutt5c390032019-03-12 10:52:56 +0000171#define RETURN_IF_USER_DENIED_CONSENT() \
172 if (ds.IsUserConsentDenied()) { \
173 MYLOGE("Returning early as user denied consent to share bugreport with calling app."); \
174 return Dumpstate::RunStatus::USER_CONSENT_DENIED; \
175 }
176
177// Runs func_ptr, but checks user consent before and after running it. Returns USER_CONSENT_DENIED
178// if consent is found to be denied.
179#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(func_ptr, ...) \
180 RETURN_IF_USER_DENIED_CONSENT(); \
181 func_ptr(__VA_ARGS__); \
182 RETURN_IF_USER_DENIED_CONSENT();
183
Sahana Raof35ed432019-07-12 10:47:52 +0100184static const char* WAKE_LOCK_NAME = "dumpstate_wakelock";
185
Nandana Dutt979388e2018-11-30 16:48:55 +0000186namespace android {
187namespace os {
188namespace {
189
190static int Open(std::string path, int flags, mode_t mode = 0) {
191 int fd = TEMP_FAILURE_RETRY(open(path.c_str(), flags, mode));
192 if (fd == -1) {
193 MYLOGE("open(%s, %s)\n", path.c_str(), strerror(errno));
194 }
195 return fd;
196}
197
Nandana Dutt979388e2018-11-30 16:48:55 +0000198
199static int OpenForRead(std::string path) {
200 return Open(path, O_RDONLY | O_CLOEXEC | O_NOFOLLOW);
201}
202
203bool CopyFile(int in_fd, int out_fd) {
204 char buf[4096];
205 ssize_t byte_count;
206 while ((byte_count = TEMP_FAILURE_RETRY(read(in_fd, buf, sizeof(buf)))) > 0) {
207 if (!android::base::WriteFully(out_fd, buf, byte_count)) {
208 return false;
209 }
210 }
211 return (byte_count != -1);
212}
213
214static bool CopyFileToFd(const std::string& input_file, int out_fd) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000215 MYLOGD("Going to copy file (%s) to %d\n", input_file.c_str(), out_fd);
Nandana Dutt979388e2018-11-30 16:48:55 +0000216
217 // Obtain a handle to the source file.
218 android::base::unique_fd in_fd(OpenForRead(input_file));
219 if (out_fd != -1 && in_fd.get() != -1) {
220 if (CopyFile(in_fd.get(), out_fd)) {
221 return true;
222 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000223 MYLOGE("Failed to copy file: %s\n", strerror(errno));
Nandana Dutt979388e2018-11-30 16:48:55 +0000224 }
225 return false;
226}
227
Nandana Duttd2f5f082019-01-18 17:13:52 +0000228static bool UnlinkAndLogOnError(const std::string& file) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000229 if (unlink(file.c_str())) {
230 MYLOGE("Failed to unlink file (%s): %s\n", file.c_str(), strerror(errno));
Nandana Duttd2f5f082019-01-18 17:13:52 +0000231 return false;
232 }
233 return true;
234}
Nandana Dutt979388e2018-11-30 16:48:55 +0000235
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +0000236
Nikita Ioffea325a572019-05-16 19:49:47 +0100237int64_t GetModuleMetadataVersion() {
238 auto binder = defaultServiceManager()->getService(android::String16("package_native"));
239 if (binder == nullptr) {
240 MYLOGE("Failed to retrieve package_native service");
241 return 0L;
242 }
243 auto package_service = android::interface_cast<content::pm::IPackageManagerNative>(binder);
244 std::string package_name;
245 auto status = package_service->getModuleMetadataPackageName(&package_name);
246 if (!status.isOk()) {
247 MYLOGE("Failed to retrieve module metadata package name: %s", status.toString8().c_str());
248 return 0L;
249 }
Nandana Duttdb379fa2019-10-09 16:54:41 +0100250 MYLOGD("Module metadata package name: %s\n", package_name.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100251 int64_t version_code;
252 status = package_service->getVersionCodeForPackage(android::String16(package_name.c_str()),
253 &version_code);
254 if (!status.isOk()) {
255 MYLOGE("Failed to retrieve module metadata version: %s", status.toString8().c_str());
256 return 0L;
257 }
258 return version_code;
259}
260
Nandana Dutt979388e2018-11-30 16:48:55 +0000261} // namespace
262} // namespace os
263} // namespace android
264
Felipe Leme678727a2016-09-21 17:22:11 -0700265static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
Felipe Lemebda15a02016-11-16 17:48:25 -0800266 const CommandOptions& options = Dumpstate::DEFAULT_DUMPSYS,
Vishnu Nair6921f802017-11-22 09:17:23 -0800267 long dumpsysTimeoutMs = 0) {
268 return ds.RunDumpsys(title, dumpsysArgs, options, dumpsysTimeoutMs);
Felipe Leme678727a2016-09-21 17:22:11 -0700269}
270static int DumpFile(const std::string& title, const std::string& path) {
271 return ds.DumpFile(title, path);
272}
Felipe Lemee82a27d2016-01-05 13:35:44 -0800273
Felipe Lemee844a9d2016-09-21 15:01:39 -0700274// Relative directory (inside the zip) for all files copied as-is into the bugreport.
275static const std::string ZIP_ROOT_DIR = "FS";
276
Vishnu Naire97d6122018-01-18 13:58:56 -0800277static const std::string kProtoPath = "proto/";
278static const std::string kProtoExt = ".proto";
Jie Song9fbfad02017-06-20 16:29:42 -0700279static const std::string kDumpstateBoardFiles[] = {
280 "dumpstate_board.txt",
Felipe Leme95d6ca52017-08-01 16:35:56 -0700281 "dumpstate_board.bin"
Jie Song9fbfad02017-06-20 16:29:42 -0700282};
283static const int NUM_OF_DUMPS = arraysize(kDumpstateBoardFiles);
284
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700285static constexpr char PROPERTY_LAST_ID[] = "dumpstate.last_id";
Felipe Lemed071c682016-10-20 16:48:00 -0700286static constexpr char PROPERTY_VERSION[] = "dumpstate.version";
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700287
Felipe Lemef0292972016-11-22 13:57:05 -0800288static const CommandOptions AS_ROOT_20 = CommandOptions::WithTimeout(20).AsRoot().Build();
289
Narayan Kamath8f788292017-05-25 13:20:39 +0100290/*
Narayan Kamathbd863722017-06-01 18:50:12 +0100291 * Returns a vector of dump fds under |dir_path| with a given |file_prefix|.
292 * The returned vector is sorted by the mtimes of the dumps. If |limit_by_mtime|
293 * is set, the vector only contains files that were written in the last 30 minutes.
Narayan Kamath8f788292017-05-25 13:20:39 +0100294 */
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700295static std::vector<DumpData> GetDumpFds(const std::string& dir_path,
296 const std::string& file_prefix,
Elliott Hughesdb6d2112019-09-26 15:24:51 -0700297 bool limit_by_mtime) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100298 const time_t thirty_minutes_ago = ds.now_ - 60 * 30;
299
Narayan Kamathbd863722017-06-01 18:50:12 +0100300 std::unique_ptr<DIR, decltype(&closedir)> dump_dir(opendir(dir_path.c_str()), closedir);
Narayan Kamath8f788292017-05-25 13:20:39 +0100301
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700302 if (dump_dir == nullptr) {
303 MYLOGW("Unable to open directory %s: %s\n", dir_path.c_str(), strerror(errno));
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700304 return std::vector<DumpData>();
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700305 }
306
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700307 std::vector<DumpData> dump_data;
Narayan Kamathbd863722017-06-01 18:50:12 +0100308 struct dirent* entry = nullptr;
309 while ((entry = readdir(dump_dir.get()))) {
310 if (entry->d_type != DT_REG) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100311 continue;
312 }
313
Narayan Kamathbd863722017-06-01 18:50:12 +0100314 const std::string base_name(entry->d_name);
315 if (base_name.find(file_prefix) != 0) {
316 continue;
317 }
318
319 const std::string abs_path = dir_path + base_name;
320 android::base::unique_fd fd(
321 TEMP_FAILURE_RETRY(open(abs_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW | O_NONBLOCK)));
322 if (fd == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700323 MYLOGW("Unable to open dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamathbd863722017-06-01 18:50:12 +0100324 break;
325 }
326
327 struct stat st = {};
328 if (fstat(fd, &st) == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700329 MYLOGW("Unable to stat dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamath8f788292017-05-25 13:20:39 +0100330 continue;
331 }
332
Narayan Kamath3f31b632018-02-22 19:42:36 +0000333 if (limit_by_mtime && st.st_mtime < thirty_minutes_ago) {
Narayan Kamathbd863722017-06-01 18:50:12 +0100334 MYLOGI("Excluding stale dump file: %s\n", abs_path.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100335 continue;
336 }
337
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700338 dump_data.emplace_back(DumpData{abs_path, std::move(fd), st.st_mtime});
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700339 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100340
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700341 return dump_data;
Narayan Kamath8f788292017-05-25 13:20:39 +0100342}
343
Narayan Kamathbd863722017-06-01 18:50:12 +0100344static bool AddDumps(const std::vector<DumpData>::const_iterator start,
345 const std::vector<DumpData>::const_iterator end,
346 const char* type_name, const bool add_to_zip) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100347 bool dumped = false;
Narayan Kamathbd863722017-06-01 18:50:12 +0100348 for (auto it = start; it != end; ++it) {
349 const std::string& name = it->name;
350 const int fd = it->fd;
Narayan Kamath8f788292017-05-25 13:20:39 +0100351 dumped = true;
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100352
353 // Seek to the beginning of the file before dumping any data. A given
354 // DumpData entry might be dumped multiple times in the report.
355 //
356 // For example, the most recent ANR entry is dumped to the body of the
357 // main entry and it also shows up as a separate entry in the bugreport
358 // ZIP file.
359 if (lseek(fd, 0, SEEK_SET) != static_cast<off_t>(0)) {
360 MYLOGE("Unable to add %s to zip file, lseek failed: %s\n", name.c_str(),
361 strerror(errno));
362 }
363
Narayan Kamath8f788292017-05-25 13:20:39 +0100364 if (ds.IsZipping() && add_to_zip) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800365 if (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + name, fd, /* timeout = */ 0ms) != OK) {
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100366 MYLOGE("Unable to add %s to zip file, addZipEntryFromFd failed\n", name.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100367 }
368 } else {
369 dump_file_from_fd(type_name, name.c_str(), fd);
370 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100371 }
372
373 return dumped;
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700374}
375
Felipe Leme635ca312016-01-05 14:23:02 -0800376// for_each_pid() callback to get mount info about a process.
Felipe Leme4c2d6632016-09-28 14:32:00 -0700377void do_mountinfo(int pid, const char* name __attribute__((unused))) {
Felipe Leme635ca312016-01-05 14:23:02 -0800378 char path[PATH_MAX];
379
380 // Gets the the content of the /proc/PID/ns/mnt link, so only unique mount points
381 // are added.
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700382 snprintf(path, sizeof(path), "/proc/%d/ns/mnt", pid);
Felipe Leme635ca312016-01-05 14:23:02 -0800383 char linkname[PATH_MAX];
384 ssize_t r = readlink(path, linkname, PATH_MAX);
385 if (r == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800386 MYLOGE("Unable to read link for %s: %s\n", path, strerror(errno));
Felipe Leme635ca312016-01-05 14:23:02 -0800387 return;
388 }
389 linkname[r] = '\0';
390
391 if (mount_points.find(linkname) == mount_points.end()) {
392 // First time this mount point was found: add it
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700393 snprintf(path, sizeof(path), "/proc/%d/mountinfo", pid);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700394 if (ds.AddZipEntry(ZIP_ROOT_DIR + path, path)) {
Felipe Leme635ca312016-01-05 14:23:02 -0800395 mount_points.insert(linkname);
396 } else {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800397 MYLOGE("Unable to add mountinfo %s to zip file\n", path);
Felipe Leme635ca312016-01-05 14:23:02 -0800398 }
399 }
400}
401
402void add_mountinfo() {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700403 if (!ds.IsZipping()) return;
Felipe Leme678727a2016-09-21 17:22:11 -0700404 std::string title = "MOUNT INFO";
Felipe Leme635ca312016-01-05 14:23:02 -0800405 mount_points.clear();
Felipe Leme46b85da2016-11-21 17:40:45 -0800406 DurationReporter duration_reporter(title, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700407 for_each_pid(do_mountinfo, nullptr);
408 MYLOGD("%s: %d entries added to zip file\n", title.c_str(), (int)mount_points.size());
Felipe Leme635ca312016-01-05 14:23:02 -0800409}
410
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700411static void dump_dev_files(const char *title, const char *driverpath, const char *filename)
412{
413 DIR *d;
414 struct dirent *de;
415 char path[PATH_MAX];
416
417 d = opendir(driverpath);
Yi Kong19d5c002018-07-20 13:39:55 -0700418 if (d == nullptr) {
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700419 return;
420 }
421
422 while ((de = readdir(d))) {
423 if (de->d_type != DT_LNK) {
424 continue;
425 }
426 snprintf(path, sizeof(path), "%s/%s/%s", driverpath, de->d_name, filename);
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700427 DumpFile(title, path);
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700428 }
429
430 closedir(d);
431}
432
Mark Salyzyn326842f2015-04-30 09:49:41 -0700433static bool skip_not_stat(const char *path) {
434 static const char stat[] = "/stat";
435 size_t len = strlen(path);
436 if (path[len - 1] == '/') { /* Directory? */
437 return false;
438 }
439 return strcmp(path + len - sizeof(stat) + 1, stat); /* .../stat? */
440}
441
Felipe Leme4c2d6632016-09-28 14:32:00 -0700442static bool skip_none(const char* path __attribute__((unused))) {
Felipe Lemee82a27d2016-01-05 13:35:44 -0800443 return false;
444}
445
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700446unsigned long worst_write_perf = 20000; /* in KB/s */
Mark Salyzyn326842f2015-04-30 09:49:41 -0700447
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800448//
449// stat offsets
450// Name units description
451// ---- ----- -----------
452// read I/Os requests number of read I/Os processed
453#define __STAT_READ_IOS 0
454// read merges requests number of read I/Os merged with in-queue I/O
455#define __STAT_READ_MERGES 1
456// read sectors sectors number of sectors read
457#define __STAT_READ_SECTORS 2
458// read ticks milliseconds total wait time for read requests
459#define __STAT_READ_TICKS 3
460// write I/Os requests number of write I/Os processed
461#define __STAT_WRITE_IOS 4
462// write merges requests number of write I/Os merged with in-queue I/O
463#define __STAT_WRITE_MERGES 5
464// write sectors sectors number of sectors written
465#define __STAT_WRITE_SECTORS 6
466// write ticks milliseconds total wait time for write requests
467#define __STAT_WRITE_TICKS 7
468// in_flight requests number of I/Os currently in flight
469#define __STAT_IN_FLIGHT 8
470// io_ticks milliseconds total time this block device has been active
471#define __STAT_IO_TICKS 9
472// time_in_queue milliseconds total wait time for all requests
473#define __STAT_IN_QUEUE 10
474#define __STAT_NUMBER_FIELD 11
475//
476// read I/Os, write I/Os
477// =====================
478//
479// These values increment when an I/O request completes.
480//
481// read merges, write merges
482// =========================
483//
484// These values increment when an I/O request is merged with an
485// already-queued I/O request.
486//
487// read sectors, write sectors
488// ===========================
489//
490// These values count the number of sectors read from or written to this
491// block device. The "sectors" in question are the standard UNIX 512-byte
492// sectors, not any device- or filesystem-specific block size. The
493// counters are incremented when the I/O completes.
494#define SECTOR_SIZE 512
495//
496// read ticks, write ticks
497// =======================
498//
499// These values count the number of milliseconds that I/O requests have
500// waited on this block device. If there are multiple I/O requests waiting,
501// these values will increase at a rate greater than 1000/second; for
502// example, if 60 read requests wait for an average of 30 ms, the read_ticks
503// field will increase by 60*30 = 1800.
504//
505// in_flight
506// =========
507//
508// This value counts the number of I/O requests that have been issued to
509// the device driver but have not yet completed. It does not include I/O
510// requests that are in the queue but not yet issued to the device driver.
511//
512// io_ticks
513// ========
514//
515// This value counts the number of milliseconds during which the device has
516// had I/O requests queued.
517//
518// time_in_queue
519// =============
520//
521// This value counts the number of milliseconds that I/O requests have waited
522// on this block device. If there are multiple I/O requests waiting, this
523// value will increase as the product of the number of milliseconds times the
524// number of requests waiting (see "read ticks" above for an example).
525#define S_TO_MS 1000
526//
527
Mark Salyzyn326842f2015-04-30 09:49:41 -0700528static int dump_stat_from_fd(const char *title __unused, const char *path, int fd) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800529 unsigned long long fields[__STAT_NUMBER_FIELD];
Mark Salyzyn326842f2015-04-30 09:49:41 -0700530 bool z;
Yi Kong19d5c002018-07-20 13:39:55 -0700531 char *cp, *buffer = nullptr;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700532 size_t i = 0;
Josh Gao7c4258c2018-06-25 13:40:08 -0700533 FILE *fp = fdopen(dup(fd), "rb");
Mark Salyzyn326842f2015-04-30 09:49:41 -0700534 getline(&buffer, &i, fp);
535 fclose(fp);
536 if (!buffer) {
537 return -errno;
538 }
539 i = strlen(buffer);
540 while ((i > 0) && (buffer[i - 1] == '\n')) {
541 buffer[--i] = '\0';
542 }
543 if (!*buffer) {
544 free(buffer);
545 return 0;
546 }
547 z = true;
548 for (cp = buffer, i = 0; i < (sizeof(fields) / sizeof(fields[0])); ++i) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800549 fields[i] = strtoull(cp, &cp, 10);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700550 if (fields[i] != 0) {
551 z = false;
552 }
553 }
554 if (z) { /* never accessed */
555 free(buffer);
556 return 0;
557 }
558
Wei Wang509bb5d2017-06-09 14:42:12 -0700559 if (!strncmp(path, BLK_DEV_SYS_DIR, sizeof(BLK_DEV_SYS_DIR) - 1)) {
560 path += sizeof(BLK_DEV_SYS_DIR) - 1;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700561 }
Wei Wang1dc1ef52017-06-12 11:28:37 -0700562
563 printf("%-30s:%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s\n%-30s:\t%s\n", "Block-Dev",
564 "R-IOs", "R-merg", "R-sect", "R-wait", "W-IOs", "W-merg", "W-sect",
565 "W-wait", "in-fli", "activ", "T-wait", path, buffer);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700566 free(buffer);
567
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800568 if (fields[__STAT_IO_TICKS]) {
569 unsigned long read_perf = 0;
570 unsigned long read_ios = 0;
571 if (fields[__STAT_READ_TICKS]) {
572 unsigned long long divisor = fields[__STAT_READ_TICKS]
573 * fields[__STAT_IO_TICKS];
574 read_perf = ((unsigned long long)SECTOR_SIZE
575 * fields[__STAT_READ_SECTORS]
576 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
577 / divisor;
578 read_ios = ((unsigned long long)S_TO_MS * fields[__STAT_READ_IOS]
579 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
580 / divisor;
581 }
582
583 unsigned long write_perf = 0;
584 unsigned long write_ios = 0;
585 if (fields[__STAT_WRITE_TICKS]) {
586 unsigned long long divisor = fields[__STAT_WRITE_TICKS]
587 * fields[__STAT_IO_TICKS];
588 write_perf = ((unsigned long long)SECTOR_SIZE
589 * fields[__STAT_WRITE_SECTORS]
590 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
591 / divisor;
592 write_ios = ((unsigned long long)S_TO_MS * fields[__STAT_WRITE_IOS]
593 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
594 / divisor;
595 }
596
597 unsigned queue = (fields[__STAT_IN_QUEUE]
598 + (fields[__STAT_IO_TICKS] >> 1))
599 / fields[__STAT_IO_TICKS];
600
601 if (!write_perf && !write_ios) {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700602 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 -0800603 } else {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700604 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 -0800605 read_ios, write_perf, write_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800606 }
607
608 /* bugreport timeout factor adjustment */
609 if ((write_perf > 1) && (write_perf < worst_write_perf)) {
610 worst_write_perf = write_perf;
611 }
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700612 }
Mark Salyzyn326842f2015-04-30 09:49:41 -0700613 return 0;
614}
615
Yao Chenbe3bbc12018-01-17 16:31:10 -0800616static const long MINIMUM_LOGCAT_TIMEOUT_MS = 50000;
617
618/* timeout in ms to read a list of buffers */
619static unsigned long logcat_timeout(const std::vector<std::string>& buffers) {
620 unsigned long timeout_ms = 0;
621 for (const auto& buffer : buffers) {
622 log_id_t id = android_name_to_log_id(buffer.c_str());
623 unsigned long property_size = __android_logger_get_buffer_size(id);
624 /* Engineering margin is ten-fold our guess */
625 timeout_ms += 10 * (property_size + worst_write_perf) / worst_write_perf;
626 }
627 return timeout_ms > MINIMUM_LOGCAT_TIMEOUT_MS ? timeout_ms : MINIMUM_LOGCAT_TIMEOUT_MS;
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700628}
629
Nandana Duttd2f5f082019-01-18 17:13:52 +0000630Dumpstate::ConsentCallback::ConsentCallback() : result_(UNAVAILABLE), start_time_(Nanotime()) {
631}
632
633android::binder::Status Dumpstate::ConsentCallback::onReportApproved() {
634 std::lock_guard<std::mutex> lock(lock_);
635 result_ = APPROVED;
636 MYLOGD("User approved consent to share bugreport\n");
637 return android::binder::Status::ok();
638}
639
640android::binder::Status Dumpstate::ConsentCallback::onReportDenied() {
641 std::lock_guard<std::mutex> lock(lock_);
642 result_ = DENIED;
643 MYLOGW("User denied consent to share bugreport\n");
644 return android::binder::Status::ok();
645}
646
647UserConsentResult Dumpstate::ConsentCallback::getResult() {
648 std::lock_guard<std::mutex> lock(lock_);
649 return result_;
650}
651
652uint64_t Dumpstate::ConsentCallback::getElapsedTimeMs() const {
Hunter Knepshieldf0a39052020-01-03 14:53:04 -0800653 return (Nanotime() - start_time_) / NANOS_PER_MILLI;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000654}
655
Felipe Leme2b9b06c2016-10-14 09:13:06 -0700656void Dumpstate::PrintHeader() const {
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700657 std::string build, fingerprint, radio, bootloader, network;
658 char date[80];
Colin Crossf45fa6b2012-03-26 12:38:26 -0700659
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700660 build = android::base::GetProperty("ro.build.display.id", "(unknown)");
661 fingerprint = android::base::GetProperty("ro.build.fingerprint", "(unknown)");
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700662 radio = android::base::GetProperty("gsm.version.baseband", "(unknown)");
663 bootloader = android::base::GetProperty("ro.bootloader", "(unknown)");
664 network = android::base::GetProperty("gsm.operator.alpha", "(unknown)");
Felipe Lemebbaf3c12016-10-11 14:32:25 -0700665 strftime(date, sizeof(date), "%Y-%m-%d %H:%M:%S", localtime(&now_));
Colin Crossf45fa6b2012-03-26 12:38:26 -0700666
Felipe Lemed8b94e52016-12-08 10:21:44 -0800667 printf("========================================================\n");
668 printf("== dumpstate: %s\n", date);
669 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -0700670
Felipe Lemed8b94e52016-12-08 10:21:44 -0800671 printf("\n");
672 printf("Build: %s\n", build.c_str());
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700673 // NOTE: fingerprint entry format is important for other tools.
Felipe Lemed8b94e52016-12-08 10:21:44 -0800674 printf("Build fingerprint: '%s'\n", fingerprint.c_str());
675 printf("Bootloader: %s\n", bootloader.c_str());
676 printf("Radio: %s\n", radio.c_str());
677 printf("Network: %s\n", network.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100678 int64_t module_metadata_version = android::os::GetModuleMetadataVersion();
679 if (module_metadata_version != 0) {
680 printf("Module Metadata version: %" PRId64 "\n", module_metadata_version);
681 }
Colin Crossf45fa6b2012-03-26 12:38:26 -0700682
Felipe Lemed8b94e52016-12-08 10:21:44 -0800683 printf("Kernel: ");
Felipe Lemef0292972016-11-22 13:57:05 -0800684 DumpFileToFd(STDOUT_FILENO, "", "/proc/version");
Felipe Lemed8b94e52016-12-08 10:21:44 -0800685 printf("Command line: %s\n", strtok(cmdline_buf, "\n"));
Felipe Leme7709f8a2017-12-05 09:30:09 -0800686 printf("Uptime: ");
687 RunCommandToFd(STDOUT_FILENO, "", {"uptime", "-p"},
688 CommandOptions::WithTimeout(1).Always().Build());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800689 printf("Bugreport format version: %s\n", version_.c_str());
Abhijeet Kaure370d682019-10-01 16:49:30 +0100690 printf("Dumpstate info: id=%d pid=%d dry_run=%d args=%s bugreport_mode=%s\n", id_, pid_,
691 PropertiesHelper::IsDryRun(), options_->args.c_str(), options_->bugreport_mode.c_str());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800692 printf("\n");
Felipe Leme78f2c862015-12-21 09:55:22 -0800693}
694
Felipe Leme24b66ee2016-06-16 10:55:26 -0700695// List of file extensions that can cause a zip file attachment to be rejected by some email
696// service providers.
697static const std::set<std::string> PROBLEMATIC_FILE_EXTENSIONS = {
698 ".ade", ".adp", ".bat", ".chm", ".cmd", ".com", ".cpl", ".exe", ".hta", ".ins", ".isp",
699 ".jar", ".jse", ".lib", ".lnk", ".mde", ".msc", ".msp", ".mst", ".pif", ".scr", ".sct",
700 ".shb", ".sys", ".vb", ".vbe", ".vbs", ".vxd", ".wsc", ".wsf", ".wsh"
701};
702
Vishnu Naire97d6122018-01-18 13:58:56 -0800703status_t Dumpstate::AddZipEntryFromFd(const std::string& entry_name, int fd,
704 std::chrono::milliseconds timeout = 0ms) {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700705 if (!IsZipping()) {
706 MYLOGD("Not adding zip entry %s from fd because it's not a zipped bugreport\n",
707 entry_name.c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -0800708 return INVALID_OPERATION;
Felipe Leme111b9d02016-02-03 09:28:24 -0800709 }
Felipe Leme24b66ee2016-06-16 10:55:26 -0700710 std::string valid_name = entry_name;
711
712 // Rename extension if necessary.
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -0700713 size_t idx = entry_name.rfind('.');
Felipe Leme24b66ee2016-06-16 10:55:26 -0700714 if (idx != std::string::npos) {
715 std::string extension = entry_name.substr(idx);
716 std::transform(extension.begin(), extension.end(), extension.begin(), ::tolower);
717 if (PROBLEMATIC_FILE_EXTENSIONS.count(extension) != 0) {
718 valid_name = entry_name + ".renamed";
719 MYLOGI("Renaming entry %s to %s\n", entry_name.c_str(), valid_name.c_str());
720 }
721 }
722
Felipe Leme6fe9db62016-02-12 09:04:16 -0800723 // Logging statement below is useful to time how long each entry takes, but it's too verbose.
724 // MYLOGD("Adding zip entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700725 int32_t err = zip_writer_->StartEntryWithTime(valid_name.c_str(), ZipWriter::kCompress,
726 get_mtime(fd, ds.now_));
Felipe Leme1d486fe2016-10-14 18:06:47 -0700727 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700728 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", valid_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700729 ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800730 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800731 }
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000732 bool finished_entry = false;
733 auto finish_entry = [this, &finished_entry] {
734 if (!finished_entry) {
735 // This should only be called when we're going to return an earlier error,
736 // which would've been logged. This may imply the file is already corrupt
737 // and any further logging from FinishEntry is more likely to mislead than
738 // not.
739 this->zip_writer_->FinishEntry();
740 }
741 };
742 auto scope_guard = android::base::make_scope_guard(finish_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -0800743 auto start = std::chrono::steady_clock::now();
744 auto end = start + timeout;
745 struct pollfd pfd = {fd, POLLIN};
Felipe Lemee82a27d2016-01-05 13:35:44 -0800746
Felipe Leme770410d2016-01-26 17:07:14 -0800747 std::vector<uint8_t> buffer(65536);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800748 while (1) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800749 if (timeout.count() > 0) {
750 // lambda to recalculate the timeout.
751 auto time_left_ms = [end]() {
752 auto now = std::chrono::steady_clock::now();
753 auto diff = std::chrono::duration_cast<std::chrono::milliseconds>(end - now);
754 return std::max(diff.count(), 0LL);
755 };
756
757 int rc = TEMP_FAILURE_RETRY(poll(&pfd, 1, time_left_ms()));
758 if (rc < 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000759 MYLOGE("Error in poll while adding from fd to zip entry %s:%s\n",
760 entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800761 return -errno;
762 } else if (rc == 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000763 MYLOGE("Timed out adding from fd to zip entry %s:%s Timeout:%lldms\n",
Vishnu Naire97d6122018-01-18 13:58:56 -0800764 entry_name.c_str(), strerror(errno), timeout.count());
765 return TIMED_OUT;
766 }
767 }
768
Zach Riggle22200402016-08-18 01:01:24 -0400769 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800770 if (bytes_read == 0) {
771 break;
772 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800773 MYLOGE("read(%s): %s\n", entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800774 return -errno;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800775 }
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700776 err = zip_writer_->WriteBytes(buffer.data(), bytes_read);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800777 if (err) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700778 MYLOGE("zip_writer_->WriteBytes(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800779 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800780 }
781 }
782
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700783 err = zip_writer_->FinishEntry();
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000784 finished_entry = true;
Felipe Leme1d486fe2016-10-14 18:06:47 -0700785 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700786 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800787 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800788 }
789
Vishnu Naire97d6122018-01-18 13:58:56 -0800790 return OK;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800791}
792
Felipe Leme1d486fe2016-10-14 18:06:47 -0700793bool Dumpstate::AddZipEntry(const std::string& entry_name, const std::string& entry_path) {
794 android::base::unique_fd fd(
795 TEMP_FAILURE_RETRY(open(entry_path.c_str(), O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
Andreas Gampeaff68432016-07-18 18:01:27 -0700796 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800797 MYLOGE("open(%s): %s\n", entry_path.c_str(), strerror(errno));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800798 return false;
799 }
800
Vishnu Naire97d6122018-01-18 13:58:56 -0800801 return (AddZipEntryFromFd(entry_name, fd.get()) == OK);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800802}
803
804/* adds a file to the existing zipped bugreport */
Felipe Leme4c2d6632016-09-28 14:32:00 -0700805static int _add_file_from_fd(const char* title __attribute__((unused)), const char* path, int fd) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800806 return (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + path, fd) == OK) ? 0 : 1;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800807}
808
Felipe Leme1d486fe2016-10-14 18:06:47 -0700809void Dumpstate::AddDir(const std::string& dir, bool recursive) {
810 if (!IsZipping()) {
811 MYLOGD("Not adding dir %s because it's not a zipped bugreport\n", dir.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800812 return;
813 }
Felipe Leme678727a2016-09-21 17:22:11 -0700814 MYLOGD("Adding dir %s (recursive: %d)\n", dir.c_str(), recursive);
Felipe Leme46b85da2016-11-21 17:40:45 -0800815 DurationReporter duration_reporter(dir, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700816 dump_files("", dir.c_str(), recursive ? skip_none : is_dir, _add_file_from_fd);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800817}
818
Felipe Leme1d486fe2016-10-14 18:06:47 -0700819bool Dumpstate::AddTextZipEntry(const std::string& entry_name, const std::string& content) {
820 if (!IsZipping()) {
821 MYLOGD("Not adding text zip entry %s because it's not a zipped bugreport\n",
822 entry_name.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800823 return false;
824 }
Felipe Lemecbce55d2016-02-08 09:53:18 -0800825 MYLOGD("Adding zip text entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700826 int32_t err = zip_writer_->StartEntryWithTime(entry_name.c_str(), ZipWriter::kCompress, ds.now_);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700827 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700828 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700829 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800830 return false;
831 }
832
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700833 err = zip_writer_->WriteBytes(content.c_str(), content.length());
Felipe Leme1d486fe2016-10-14 18:06:47 -0700834 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700835 MYLOGE("zip_writer_->WriteBytes(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700836 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800837 return false;
838 }
839
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700840 err = zip_writer_->FinishEntry();
Felipe Leme1d486fe2016-10-14 18:06:47 -0700841 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700842 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800843 return false;
844 }
845
846 return true;
847}
848
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800849static void DoKmsg() {
850 struct stat st;
851 if (!stat(PSTORE_LAST_KMSG, &st)) {
852 /* Also TODO: Make console-ramoops CAP_SYSLOG protected. */
853 DumpFile("LAST KMSG", PSTORE_LAST_KMSG);
854 } else if (!stat(ALT_PSTORE_LAST_KMSG, &st)) {
855 DumpFile("LAST KMSG", ALT_PSTORE_LAST_KMSG);
856 } else {
857 /* TODO: Make last_kmsg CAP_SYSLOG protected. b/5555691 */
858 DumpFile("LAST KMSG", "/proc/last_kmsg");
859 }
860}
861
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800862static void DoKernelLogcat() {
Yao Chenbe3bbc12018-01-17 16:31:10 -0800863 unsigned long timeout_ms = logcat_timeout({"kernel"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800864 RunCommand(
865 "KERNEL LOG",
866 {"logcat", "-b", "kernel", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
867 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
868}
869
Nandana Duttdb379fa2019-10-09 16:54:41 +0100870static void DoSystemLogcat(time_t since) {
871 char since_str[80];
872 strftime(since_str, sizeof(since_str), "%Y-%m-%d %H:%M:%S.000", localtime(&since));
873
874 unsigned long timeout_ms = logcat_timeout({"main", "system", "crash"});
875 RunCommand("SYSTEM LOG",
876 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v", "-T",
877 since_str},
878 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
879}
880
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800881static void DoLogcat() {
Vishnu Nair6921f802017-11-22 09:17:23 -0800882 unsigned long timeout_ms;
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800883 // DumpFile("EVENT LOG TAGS", "/etc/event-log-tags");
884 // calculate timeout
Yao Chenbe3bbc12018-01-17 16:31:10 -0800885 timeout_ms = logcat_timeout({"main", "system", "crash"});
Tony Makae737652017-03-30 17:47:09 +0100886 RunCommand("SYSTEM LOG",
Vishnu Nair6921f802017-11-22 09:17:23 -0800887 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
888 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -0800889 timeout_ms = logcat_timeout({"events"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800890 RunCommand(
891 "EVENT LOG",
892 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +0100893 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Yao Chenbe3bbc12018-01-17 16:31:10 -0800894 timeout_ms = logcat_timeout({"stats"});
895 RunCommand(
896 "STATS LOG",
897 {"logcat", "-b", "stats", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +0100898 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Yao Chenbe3bbc12018-01-17 16:31:10 -0800899 timeout_ms = logcat_timeout({"radio"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800900 RunCommand(
901 "RADIO LOG",
902 {"logcat", "-b", "radio", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +0100903 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800904
905 RunCommand("LOG STATISTICS", {"logcat", "-b", "all", "-S"});
906
907 /* kernels must set CONFIG_PSTORE_PMSG, slice up pstore with device tree */
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800908 RunCommand("LAST LOGCAT", {"logcat", "-L", "-b", "all", "-v", "threadtime", "-v", "printable",
909 "-v", "uid", "-d", "*:v"});
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800910}
911
Mike Ma5c267872019-08-21 11:31:34 -0700912static void DumpIncidentReport() {
913 if (!ds.IsZipping()) {
914 MYLOGD("Not dumping incident report because it's not a zipped bugreport\n");
915 return;
916 }
917 DurationReporter duration_reporter("INCIDENT REPORT");
918 const std::string path = ds.bugreport_internal_dir_ + "/tmp_incident_report";
919 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
920 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
921 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
922 if (fd < 0) {
923 MYLOGE("Could not open %s to dump incident report.\n", path.c_str());
924 return;
925 }
926 RunCommandToFd(fd, "", {"incident", "-u"}, CommandOptions::WithTimeout(120).Build());
927 bool empty = 0 == lseek(fd, 0, SEEK_END);
928 if (!empty) {
929 // Use a different name from "incident.proto"
930 // /proto/incident.proto is reserved for incident service dump
931 // i.e. metadata for debugging.
932 ds.AddZipEntry(kProtoPath + "incident_report" + kProtoExt, path);
933 }
934 unlink(path.c_str());
935}
936
Sunny Goyal35949782019-11-19 15:54:36 -0800937static void DumpVisibleWindowViews() {
938 if (!ds.IsZipping()) {
939 MYLOGD("Not dumping visible views because it's not a zipped bugreport\n");
940 return;
941 }
942 DurationReporter duration_reporter("VISIBLE WINDOW VIEWS");
943 const std::string path = ds.bugreport_internal_dir_ + "/tmp_visible_window_views";
944 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
945 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
946 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
947 if (fd < 0) {
948 MYLOGE("Could not open %s to dump visible views.\n", path.c_str());
949 return;
950 }
951 RunCommandToFd(fd, "", {"cmd", "window", "dump-visible-window-views"},
952 CommandOptions::WithTimeout(120).Build());
953 bool empty = 0 == lseek(fd, 0, SEEK_END);
954 if (!empty) {
955 ds.AddZipEntry("visible_windows.zip", path);
956 } else {
957 MYLOGW("Failed to dump visible windows\n");
958 }
959 unlink(path.c_str());
960}
961
Jayachandran Ca94c7172017-06-10 15:08:12 -0700962static void DumpIpTablesAsRoot() {
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700963 RunCommand("IPTABLES", {"iptables", "-L", "-nvx"});
964 RunCommand("IP6TABLES", {"ip6tables", "-L", "-nvx"});
Erik Kline32af8c22016-09-28 17:26:26 +0900965 RunCommand("IPTABLES NAT", {"iptables", "-t", "nat", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -0700966 /* no ip6 nat */
Erik Kline32af8c22016-09-28 17:26:26 +0900967 RunCommand("IPTABLES MANGLE", {"iptables", "-t", "mangle", "-L", "-nvx"});
968 RunCommand("IP6TABLES MANGLE", {"ip6tables", "-t", "mangle", "-L", "-nvx"});
969 RunCommand("IPTABLES RAW", {"iptables", "-t", "raw", "-L", "-nvx"});
970 RunCommand("IP6TABLES RAW", {"ip6tables", "-t", "raw", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -0700971}
972
David Andersond9ba4752018-12-11 18:26:59 -0800973static void DumpDynamicPartitionInfo() {
974 if (!::android::base::GetBoolProperty("ro.boot.dynamic_partitions", false)) {
975 return;
976 }
977
978 RunCommand("LPDUMP", {"lpdump", "--all"});
David Anderson6650ade2019-10-02 15:18:59 -0700979 RunCommand("DEVICE-MAPPER", {"gsid", "dump-device-mapper"});
David Andersond9ba4752018-12-11 18:26:59 -0800980}
981
Narayan Kamath8f788292017-05-25 13:20:39 +0100982static void AddAnrTraceDir(const bool add_to_zip, const std::string& anr_traces_dir) {
983 MYLOGD("AddAnrTraceDir(): dump_traces_file=%s, anr_traces_dir=%s\n", dump_traces_path,
984 anr_traces_dir.c_str());
985
986 // If we're here, dump_traces_path will always be a temporary file
987 // (created with mkostemp or similar) that contains dumps taken earlier
988 // on in the process.
989 if (dump_traces_path != nullptr) {
990 if (add_to_zip) {
991 ds.AddZipEntry(ZIP_ROOT_DIR + anr_traces_dir + "/traces-just-now.txt", dump_traces_path);
992 } else {
993 MYLOGD("Dumping current ANR traces (%s) to the main bugreport entry\n",
994 dump_traces_path);
995 ds.DumpFile("VM TRACES JUST NOW", dump_traces_path);
996 }
997
998 const int ret = unlink(dump_traces_path);
999 if (ret == -1) {
1000 MYLOGW("Error unlinking temporary trace path %s: %s\n", dump_traces_path,
1001 strerror(errno));
Felipe Lemee184f662016-10-27 10:04:47 -07001002 }
1003 }
1004
Narayan Kamathbd863722017-06-01 18:50:12 +01001005 // Add a specific message for the first ANR Dump.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001006 if (ds.anr_data_.size() > 0) {
1007 AddDumps(ds.anr_data_.begin(), ds.anr_data_.begin() + 1,
Narayan Kamathbd863722017-06-01 18:50:12 +01001008 "VM TRACES AT LAST ANR", add_to_zip);
1009
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001010 // The "last" ANR will always be included as separate entry in the zip file. In addition,
1011 // it will be present in the body of the main entry if |add_to_zip| == false.
1012 //
1013 // Historical ANRs are always included as separate entries in the bugreport zip file.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001014 AddDumps(ds.anr_data_.begin() + ((add_to_zip) ? 1 : 0), ds.anr_data_.end(),
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001015 "HISTORICAL ANR", true /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001016 } else {
Narayan Kamath8f788292017-05-25 13:20:39 +01001017 printf("*** NO ANRs to dump in %s\n\n", ANR_DIR.c_str());
1018 }
1019}
1020
1021static void AddAnrTraceFiles() {
1022 const bool add_to_zip = ds.IsZipping() && ds.version_ == VERSION_SPLIT_ANR;
1023
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001024 std::string anr_traces_dir = "/data/anr";
Narayan Kamath8f788292017-05-25 13:20:39 +01001025
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001026 AddAnrTraceDir(add_to_zip, anr_traces_dir);
Narayan Kamath8f788292017-05-25 13:20:39 +01001027
Makoto Onuki83ec63f2019-01-31 17:08:59 -08001028 RunCommand("ANR FILES", {"ls", "-lt", ANR_DIR});
1029
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001030 // Slow traces for slow operations.
Felipe Lemee184f662016-10-27 10:04:47 -07001031 struct stat st;
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001032 int i = 0;
1033 while (true) {
1034 const std::string slow_trace_path =
1035 anr_traces_dir + android::base::StringPrintf("slow%02d.txt", i);
1036 if (stat(slow_trace_path.c_str(), &st)) {
1037 // No traces file at this index, done with the files.
1038 break;
Felipe Lemee184f662016-10-27 10:04:47 -07001039 }
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001040 ds.DumpFile("VM TRACES WHEN SLOW", slow_trace_path.c_str());
1041 i++;
Felipe Lemee184f662016-10-27 10:04:47 -07001042 }
1043}
1044
Wei Wang509bb5d2017-06-09 14:42:12 -07001045static void DumpBlockStatFiles() {
1046 DurationReporter duration_reporter("DUMP BLOCK STAT");
Wei Wang509bb5d2017-06-09 14:42:12 -07001047
Wei Wang1dc1ef52017-06-12 11:28:37 -07001048 std::unique_ptr<DIR, std::function<int(DIR*)>> dirptr(opendir(BLK_DEV_SYS_DIR), closedir);
1049
1050 if (dirptr == nullptr) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001051 MYLOGE("Failed to open %s: %s\n", BLK_DEV_SYS_DIR, strerror(errno));
1052 return;
1053 }
1054
1055 printf("------ DUMP BLOCK STAT ------\n\n");
Wei Wang1dc1ef52017-06-12 11:28:37 -07001056 while (struct dirent *d = readdir(dirptr.get())) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001057 if ((d->d_name[0] == '.')
1058 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
1059 || (d->d_name[1] == '\0'))) {
1060 continue;
1061 }
1062 const std::string new_path =
1063 android::base::StringPrintf("%s/%s", BLK_DEV_SYS_DIR, d->d_name);
1064 printf("------ BLOCK STAT (%s) ------\n", new_path.c_str());
1065 dump_files("", new_path.c_str(), skip_not_stat, dump_stat_from_fd);
1066 printf("\n");
1067 }
Wei Wang1dc1ef52017-06-12 11:28:37 -07001068 return;
Wei Wang509bb5d2017-06-09 14:42:12 -07001069}
Jayachandran Ca94c7172017-06-10 15:08:12 -07001070
1071static void DumpPacketStats() {
1072 DumpFile("NETWORK DEV INFO", "/proc/net/dev");
1073 DumpFile("QTAGUID NETWORK INTERFACES INFO", "/proc/net/xt_qtaguid/iface_stat_all");
1074 DumpFile("QTAGUID NETWORK INTERFACES INFO (xt)", "/proc/net/xt_qtaguid/iface_stat_fmt");
1075 DumpFile("QTAGUID CTRL INFO", "/proc/net/xt_qtaguid/ctrl");
1076 DumpFile("QTAGUID STATS INFO", "/proc/net/xt_qtaguid/stats");
1077}
1078
1079static void DumpIpAddrAndRules() {
1080 /* The following have a tendency to get wedged when wifi drivers/fw goes belly-up. */
1081 RunCommand("NETWORK INTERFACES", {"ip", "link"});
1082 RunCommand("IPv4 ADDRESSES", {"ip", "-4", "addr", "show"});
1083 RunCommand("IPv6 ADDRESSES", {"ip", "-6", "addr", "show"});
1084 RunCommand("IP RULES", {"ip", "rule", "show"});
1085 RunCommand("IP RULES v6", {"ip", "-6", "rule", "show"});
1086}
1087
Nandana Dutt5c390032019-03-12 10:52:56 +00001088static Dumpstate::RunStatus RunDumpsysTextByPriority(const std::string& title, int priority,
1089 std::chrono::milliseconds timeout,
1090 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001091 auto start = std::chrono::steady_clock::now();
Vishnu Naire97d6122018-01-18 13:58:56 -08001092 sp<android::IServiceManager> sm = defaultServiceManager();
1093 Dumpsys dumpsys(sm.get());
Vishnu Naire97d6122018-01-18 13:58:56 -08001094 Vector<String16> args;
1095 Dumpsys::setServiceArgs(args, /* asProto = */ false, priority);
Vishnu Naire97d6122018-01-18 13:58:56 -08001096 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ false);
1097 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001098 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001099 std::string path(title);
1100 path.append(" - ").append(String8(service).c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -08001101 size_t bytes_written = 0;
Steven Moreland5a30d342019-10-08 13:53:28 -07001102 status_t status = dumpsys.startDumpThread(Dumpsys::Type::DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001103 if (status == OK) {
1104 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1105 std::chrono::duration<double> elapsed_seconds;
1106 status = dumpsys.writeDump(STDOUT_FILENO, service, service_timeout,
1107 /* as_proto = */ false, elapsed_seconds, bytes_written);
Vishnu Naire97d6122018-01-18 13:58:56 -08001108 dumpsys.writeDumpFooter(STDOUT_FILENO, service, elapsed_seconds);
1109 bool dump_complete = (status == OK);
1110 dumpsys.stopDumpThread(dump_complete);
1111 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001112
1113 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1114 std::chrono::steady_clock::now() - start);
1115 if (elapsed_duration > timeout) {
1116 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1117 elapsed_duration.count());
1118 break;
1119 }
1120 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001121 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001122}
1123
Vishnu Nair64afc022018-02-01 15:29:34 -08001124static void RunDumpsysText(const std::string& title, int priority,
1125 std::chrono::milliseconds timeout,
1126 std::chrono::milliseconds service_timeout) {
1127 DurationReporter duration_reporter(title);
1128 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1129 fsync(STDOUT_FILENO);
1130 RunDumpsysTextByPriority(title, priority, timeout, service_timeout);
1131}
1132
1133/* Dump all services registered with Normal or Default priority. */
Nandana Dutt5c390032019-03-12 10:52:56 +00001134static Dumpstate::RunStatus RunDumpsysTextNormalPriority(const std::string& title,
1135 std::chrono::milliseconds timeout,
1136 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001137 DurationReporter duration_reporter(title);
1138 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1139 fsync(STDOUT_FILENO);
1140 RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_NORMAL, timeout,
1141 service_timeout);
Nandana Dutt5c390032019-03-12 10:52:56 +00001142
1143 RETURN_IF_USER_DENIED_CONSENT();
1144
1145 return RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_DEFAULT, timeout,
1146 service_timeout);
Vishnu Nair64afc022018-02-01 15:29:34 -08001147}
1148
Nandana Dutt5c390032019-03-12 10:52:56 +00001149static Dumpstate::RunStatus RunDumpsysProto(const std::string& title, int priority,
1150 std::chrono::milliseconds timeout,
1151 std::chrono::milliseconds service_timeout) {
Luis Hector Chavez1e27b082018-03-22 15:36:42 -07001152 if (!ds.IsZipping()) {
1153 MYLOGD("Not dumping %s because it's not a zipped bugreport\n", title.c_str());
Nandana Dutt5c390032019-03-12 10:52:56 +00001154 return Dumpstate::RunStatus::OK;
Luis Hector Chavez1e27b082018-03-22 15:36:42 -07001155 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001156 sp<android::IServiceManager> sm = defaultServiceManager();
1157 Dumpsys dumpsys(sm.get());
1158 Vector<String16> args;
1159 Dumpsys::setServiceArgs(args, /* asProto = */ true, priority);
1160 DurationReporter duration_reporter(title);
1161
1162 auto start = std::chrono::steady_clock::now();
1163 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ true);
1164 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001165 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001166 std::string path(kProtoPath);
1167 path.append(String8(service).c_str());
1168 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL) {
1169 path.append("_CRITICAL");
1170 } else if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH) {
1171 path.append("_HIGH");
1172 }
1173 path.append(kProtoExt);
Steven Moreland5a30d342019-10-08 13:53:28 -07001174 status_t status = dumpsys.startDumpThread(Dumpsys::Type::DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001175 if (status == OK) {
1176 status = ds.AddZipEntryFromFd(path, dumpsys.getDumpFd(), service_timeout);
1177 bool dumpTerminated = (status == OK);
1178 dumpsys.stopDumpThread(dumpTerminated);
1179 }
1180 ZipWriter::FileEntry file_entry;
1181 ds.zip_writer_->GetLastEntry(&file_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -08001182
1183 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1184 std::chrono::steady_clock::now() - start);
1185 if (elapsed_duration > timeout) {
1186 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1187 elapsed_duration.count());
1188 break;
1189 }
1190 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001191 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001192}
1193
Nandana Dutta7db6342018-11-21 14:53:34 +00001194// Runs dumpsys on services that must dump first and will take less than 100ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001195static Dumpstate::RunStatus RunDumpsysCritical() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001196 RunDumpsysText("DUMPSYS CRITICAL", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1197 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Nandana Dutt5c390032019-03-12 10:52:56 +00001198
1199 RETURN_IF_USER_DENIED_CONSENT();
1200
1201 return RunDumpsysProto("DUMPSYS CRITICAL PROTO", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1202 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Vishnu Nair780b1282017-10-10 13:57:24 -07001203}
1204
1205// Runs dumpsys on services that must dump first but can take up to 250ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001206static Dumpstate::RunStatus RunDumpsysHigh() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001207 // TODO meminfo takes ~10s, connectivity takes ~5sec to dump. They are both
1208 // high priority. Reduce timeout once they are able to dump in a shorter time or
1209 // moved to a parallel task.
1210 RunDumpsysText("DUMPSYS HIGH", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1211 /* timeout= */ 90s, /* service_timeout= */ 30s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001212
1213 RETURN_IF_USER_DENIED_CONSENT();
1214
1215 return RunDumpsysProto("DUMPSYS HIGH PROTO", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1216 /* timeout= */ 5s, /* service_timeout= */ 1s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001217}
1218
1219// Runs dumpsys on services that must dump but can take up to 10s to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001220static Dumpstate::RunStatus RunDumpsysNormal() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001221 RunDumpsysTextNormalPriority("DUMPSYS", /* timeout= */ 90s, /* service_timeout= */ 10s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001222
1223 RETURN_IF_USER_DENIED_CONSENT();
1224
1225 return RunDumpsysProto("DUMPSYS PROTO", IServiceManager::DUMP_FLAG_PRIORITY_NORMAL,
1226 /* timeout= */ 90s, /* service_timeout= */ 10s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001227}
1228
Steven Moreland44cd9482018-01-04 16:24:13 -08001229static void DumpHals() {
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001230 if (!ds.IsZipping()) {
1231 RunCommand("HARDWARE HALS", {"lshal", "-lVSietrpc", "--types=b,c,l,z", "--debug"},
1232 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build());
1233 return;
1234 }
1235 DurationReporter duration_reporter("DUMP HALS");
1236 RunCommand("HARDWARE HALS", {"lshal", "-lVSietrpc", "--types=b,c,l,z"},
Greg Kaiser3dfeda32019-05-16 10:32:51 -07001237 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build());
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001238
Steven Moreland44cd9482018-01-04 16:24:13 -08001239 using android::hidl::manager::V1_0::IServiceManager;
1240 using android::hardware::defaultServiceManager;
1241
1242 sp<IServiceManager> sm = defaultServiceManager();
1243 if (sm == nullptr) {
1244 MYLOGE("Could not retrieve hwservicemanager to dump hals.\n");
1245 return;
1246 }
1247
1248 auto ret = sm->list([&](const auto& interfaces) {
1249 for (const std::string& interface : interfaces) {
1250 std::string cleanName = interface;
1251 std::replace_if(cleanName.begin(),
1252 cleanName.end(),
1253 [](char c) {
1254 return !isalnum(c) &&
1255 std::string("@-_:.").find(c) == std::string::npos;
1256 }, '_');
Nandana Dutt979388e2018-11-30 16:48:55 +00001257 const std::string path = ds.bugreport_internal_dir_ + "/lshal_debug_" + cleanName;
Steven Moreland44cd9482018-01-04 16:24:13 -08001258
1259 {
1260 auto fd = android::base::unique_fd(
1261 TEMP_FAILURE_RETRY(open(path.c_str(),
1262 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1263 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1264 if (fd < 0) {
1265 MYLOGE("Could not open %s to dump additional hal information.\n", path.c_str());
1266 continue;
1267 }
1268 RunCommandToFd(fd,
1269 "",
Steven Morelandc81cd3c2018-01-18 14:36:26 -08001270 {"lshal", "debug", "-E", interface},
Steven Moreland44cd9482018-01-04 16:24:13 -08001271 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
1272
1273 bool empty = 0 == lseek(fd, 0, SEEK_END);
1274 if (!empty) {
1275 ds.AddZipEntry("lshal-debug/" + cleanName + ".txt", path);
1276 }
1277 }
1278
1279 unlink(path.c_str());
1280 }
1281 });
1282
1283 if (!ret.isOk()) {
1284 MYLOGE("Could not list hals from hwservicemanager.\n");
1285 }
1286}
1287
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001288static void DumpExternalFragmentationInfo() {
1289 struct stat st;
1290 if (stat("/proc/buddyinfo", &st) != 0) {
1291 MYLOGE("Unable to dump external fragmentation info\n");
1292 return;
1293 }
1294
1295 printf("------ EXTERNAL FRAGMENTATION INFO ------\n");
1296 std::ifstream ifs("/proc/buddyinfo");
1297 auto unusable_index_regex = std::regex{"Node\\s+([0-9]+),\\s+zone\\s+(\\S+)\\s+(.*)"};
1298 for (std::string line; std::getline(ifs, line);) {
1299 std::smatch match_results;
1300 if (std::regex_match(line, match_results, unusable_index_regex)) {
1301 std::stringstream free_pages(std::string{match_results[3]});
1302 std::vector<int> free_pages_per_order(std::istream_iterator<int>{free_pages},
1303 std::istream_iterator<int>());
1304
1305 int total_free_pages = 0;
1306 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1307 total_free_pages += (free_pages_per_order[i] * std::pow(2, i));
1308 }
1309
1310 printf("Node %s, zone %8s", match_results[1].str().c_str(),
1311 match_results[2].str().c_str());
1312
1313 int usable_free_pages = total_free_pages;
1314 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1315 auto unusable_index = (total_free_pages - usable_free_pages) /
1316 static_cast<double>(total_free_pages);
1317 printf(" %5.3f", unusable_index);
1318 usable_free_pages -= (free_pages_per_order[i] * std::pow(2, i));
1319 }
1320
1321 printf("\n");
1322 }
1323 }
1324 printf("\n");
1325}
1326
Nandana Dutt5c390032019-03-12 10:52:56 +00001327// Dumps various things. Returns early with status USER_CONSENT_DENIED if user denies consent
1328// via the consent they are shown. Ignores other errors that occur while running various
1329// commands. The consent checking is currently done around long running tasks, which happen to
1330// be distributed fairly evenly throughout the function.
1331static Dumpstate::RunStatus dumpstate() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001332 DurationReporter duration_reporter("DUMPSTATE");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001333
Nandana Dutt5c390032019-03-12 10:52:56 +00001334 // Dump various things. Note that anything that takes "long" (i.e. several seconds) should
1335 // check intermittently (if it's intrerruptable like a foreach on pids) and/or should be wrapped
1336 // in a consent check (via RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK).
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -07001337 dump_dev_files("TRUSTY VERSION", "/sys/bus/platform/drivers/trusty", "trusty_version");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001338 RunCommand("UPTIME", {"uptime"});
Wei Wang509bb5d2017-06-09 14:42:12 -07001339 DumpBlockStatFiles();
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001340 DumpFile("MEMORY INFO", "/proc/meminfo");
1341 RunCommand("CPU INFO", {"top", "-b", "-n", "1", "-H", "-s", "6", "-o",
Felipe Leme30dbfa12016-09-02 12:43:26 -07001342 "pid,tid,user,pr,ni,%cpu,s,virt,res,pcy,cmd,name"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001343
1344 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "PROCRANK", {"procrank"}, AS_ROOT_20);
1345
Sunny Goyal35949782019-11-19 15:54:36 -08001346 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpVisibleWindowViews);
1347
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001348 DumpFile("VIRTUAL MEMORY STATS", "/proc/vmstat");
1349 DumpFile("VMALLOC INFO", "/proc/vmallocinfo");
1350 DumpFile("SLAB INFO", "/proc/slabinfo");
1351 DumpFile("ZONEINFO", "/proc/zoneinfo");
1352 DumpFile("PAGETYPEINFO", "/proc/pagetypeinfo");
1353 DumpFile("BUDDYINFO", "/proc/buddyinfo");
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001354 DumpExternalFragmentationInfo();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001355
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001356 DumpFile("KERNEL WAKE SOURCES", "/d/wakeup_sources");
1357 DumpFile("KERNEL CPUFREQ", "/sys/devices/system/cpu/cpu0/cpufreq/stats/time_in_state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001358
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001359 RunCommand("PROCESSES AND THREADS",
Yohei Yukawa591a72d2017-10-05 21:36:35 -07001360 {"ps", "-A", "-T", "-Z", "-O", "pri,nice,rtprio,sched,pcy,time"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001361
1362 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "LIBRANK", {"librank"},
1363 CommandOptions::AS_ROOT);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001364
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001365 DumpHals();
Steven Moreland81b429e2017-01-31 19:50:46 -08001366
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001367 RunCommand("PRINTENV", {"printenv"});
Elliott Hughes21b7c8d2016-10-28 08:53:02 -07001368 RunCommand("NETSTAT", {"netstat", "-nW"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001369 struct stat s;
1370 if (stat("/proc/modules", &s) != 0) {
1371 MYLOGD("Skipping 'lsmod' because /proc/modules does not exist\n");
1372 } else {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001373 RunCommand("LSMOD", {"lsmod"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001374 }
Michal Karpinski4db754f2015-12-11 18:04:32 +00001375
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001376 if (__android_logger_property_get_bool(
1377 "ro.logd.kernel", BOOL_DEFAULT_TRUE | BOOL_DEFAULT_FLAG_ENG | BOOL_DEFAULT_FLAG_SVELTE)) {
1378 DoKernelLogcat();
1379 } else {
1380 do_dmesg();
1381 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001382
Felipe Lemef0292972016-11-22 13:57:05 -08001383 RunCommand("LIST OF OPEN FILES", {"lsof"}, CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001384
1385 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(for_each_pid, do_showmap, "SMAPS OF ALL PROCESSES");
1386
Jeff Brown1dc94e32014-09-11 14:15:27 -07001387 for_each_tid(show_wchan, "BLOCKED PROCESS WAIT-CHANNELS");
Mark Salyzyna297c322016-02-05 15:33:17 -08001388 for_each_pid(show_showtime, "PROCESS TIMES (pid cmd user system iowait+percentage)");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001389
Ajay Panicker2ff8e872017-04-27 14:04:32 -07001390 /* Dump Bluetooth HCI logs */
1391 ds.AddDir("/data/misc/bluetooth/logs", true);
Ajay Panickerd886ec42016-09-14 12:26:46 -07001392
Greg Kaiser3ddc3fa2019-05-23 16:14:52 -07001393 if (ds.options_->do_fb && !ds.do_early_screenshot_) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001394 MYLOGI("taking late screenshot\n");
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001395 ds.TakeScreenshot();
Jeff Sharkey5a930032013-03-19 15:05:19 -07001396 }
1397
Felipe Lemee184f662016-10-27 10:04:47 -07001398 AddAnrTraceFiles();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001399
Narayan Kamath8f788292017-05-25 13:20:39 +01001400 // NOTE: tombstones are always added as separate entries in the zip archive
1401 // and are not interspersed with the main report.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001402 const bool tombstones_dumped = AddDumps(ds.tombstone_data_.begin(), ds.tombstone_data_.end(),
Narayan Kamathbd863722017-06-01 18:50:12 +01001403 "TOMBSTONE", true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001404 if (!tombstones_dumped) {
1405 printf("*** NO TOMBSTONES to dump in %s\n\n", TOMBSTONE_DIR.c_str());
Christopher Ferris7dc7f322014-07-22 16:08:19 -07001406 }
1407
Jayachandran Ca94c7172017-06-10 15:08:12 -07001408 DumpPacketStats();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001409
Chenbo Feng276a3b62018-08-07 11:44:49 -07001410 RunDumpsys("EBPF MAP STATS", {"netd", "trafficcontroller"});
1411
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001412 DoKmsg();
Mark Salyzyn2262c162014-12-16 09:09:26 -08001413
Jayachandran Ca94c7172017-06-10 15:08:12 -07001414 DumpIpAddrAndRules();
Sreeram Ramachandran2b3bba32014-07-08 15:40:55 -07001415
1416 dump_route_tables();
1417
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001418 RunCommand("ARP CACHE", {"ip", "-4", "neigh", "show"});
1419 RunCommand("IPv6 ND CACHE", {"ip", "-6", "neigh", "show"});
1420 RunCommand("MULTICAST ADDRESSES", {"ip", "maddr"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001421
Nandana Dutt5c390032019-03-12 10:52:56 +00001422 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysHigh);
Lorenzo Colitti6afc38c2015-09-09 22:59:25 +09001423
Elliott Hughes23ccc622017-02-28 10:14:22 -08001424 RunCommand("SYSTEM PROPERTIES", {"getprop"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001425
Jin Qianf334d662017-10-10 14:41:37 -07001426 RunCommand("STORAGED IO INFO", {"storaged", "-u", "-p"});
ynwangf649a6e2016-07-17 21:56:00 -07001427
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001428 RunCommand("FILESYSTEMS & FREE SPACE", {"df"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001429
Colin Crossf45fa6b2012-03-26 12:38:26 -07001430 /* Binder state is expensive to look at as it uses a lot of memory. */
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001431 DumpFile("BINDER FAILED TRANSACTION LOG", "/sys/kernel/debug/binder/failed_transaction_log");
1432 DumpFile("BINDER TRANSACTION LOG", "/sys/kernel/debug/binder/transaction_log");
1433 DumpFile("BINDER TRANSACTIONS", "/sys/kernel/debug/binder/transactions");
1434 DumpFile("BINDER STATS", "/sys/kernel/debug/binder/stats");
1435 DumpFile("BINDER STATE", "/sys/kernel/debug/binder/state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001436
Vishnu Nair36b4cdb2017-11-17 10:27:05 -08001437 /* Add window and surface trace files. */
1438 if (!PropertiesHelper::IsUserBuild()) {
1439 ds.AddDir(WMTRACE_DATA_DIR, false);
1440 }
1441
Nandana Dutt5c390032019-03-12 10:52:56 +00001442 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(ds.DumpstateBoard);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001443
Steven Moreland7440ddb2016-12-15 16:13:39 -08001444 /* Migrate the ril_dumpstate to a device specific dumpstate? */
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001445 int rilDumpstateTimeout = android::base::GetIntProperty("ril.dumpstate.timeout", 0);
1446 if (rilDumpstateTimeout > 0) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001447 // su does not exist on user builds, so try running without it.
1448 // This way any implementations of vril-dump that do not require
1449 // root can run on user builds.
1450 CommandOptions::CommandOptionsBuilder options =
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001451 CommandOptions::WithTimeout(rilDumpstateTimeout);
Felipe Lemef0292972016-11-22 13:57:05 -08001452 if (!PropertiesHelper::IsUserBuild()) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001453 options.AsRoot();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001454 }
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001455 RunCommand("DUMP VENDOR RIL LOGS", {"vril-dump"}, options.Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -07001456 }
1457
Felipe Lemed8b94e52016-12-08 10:21:44 -08001458 printf("========================================================\n");
1459 printf("== Android Framework Services\n");
1460 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001461
Nandana Dutt5c390032019-03-12 10:52:56 +00001462 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysNormal);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001463
Felipe Lemed8b94e52016-12-08 10:21:44 -08001464 printf("========================================================\n");
1465 printf("== Checkins\n");
1466 printf("========================================================\n");
Dianne Hackborn02bea972013-06-26 18:59:09 -07001467
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001468 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001469
1470 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsys, "CHECKIN MEMINFO", {"meminfo", "--checkin"});
1471
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001472 RunDumpsys("CHECKIN NETSTATS", {"netstats", "--checkin"});
1473 RunDumpsys("CHECKIN PROCSTATS", {"procstats", "-c"});
1474 RunDumpsys("CHECKIN USAGESTATS", {"usagestats", "-c"});
1475 RunDumpsys("CHECKIN PACKAGE", {"package", "--checkin"});
Dianne Hackborn02bea972013-06-26 18:59:09 -07001476
Felipe Lemed8b94e52016-12-08 10:21:44 -08001477 printf("========================================================\n");
1478 printf("== Running Application Activities\n");
1479 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001480
Makoto Onuki60780982018-04-16 15:34:00 -07001481 // The following dumpsys internally collects output from running apps, so it can take a long
1482 // time. So let's extend the timeout.
1483
1484 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
1485
1486 RunDumpsys("APP ACTIVITIES", {"activity", "-v", "all"}, DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001487
Felipe Lemed8b94e52016-12-08 10:21:44 -08001488 printf("========================================================\n");
Makoto Onuki60780982018-04-16 15:34:00 -07001489 printf("== Running Application Services (platform)\n");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001490 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001491
Vishnu Nairc6e6ea72018-07-02 14:20:06 -07001492 RunDumpsys("APP SERVICES PLATFORM", {"activity", "service", "all-platform-non-critical"},
Makoto Onuki60780982018-04-16 15:34:00 -07001493 DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001494
Felipe Lemed8b94e52016-12-08 10:21:44 -08001495 printf("========================================================\n");
Makoto Onuki60780982018-04-16 15:34:00 -07001496 printf("== Running Application Services (non-platform)\n");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001497 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001498
Makoto Onuki60780982018-04-16 15:34:00 -07001499 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1500 DUMPSYS_COMPONENTS_OPTIONS);
1501
1502 printf("========================================================\n");
1503 printf("== Running Application Providers (platform)\n");
1504 printf("========================================================\n");
1505
1506 RunDumpsys("APP PROVIDERS PLATFORM", {"activity", "provider", "all-platform"},
1507 DUMPSYS_COMPONENTS_OPTIONS);
1508
1509 printf("========================================================\n");
1510 printf("== Running Application Providers (non-platform)\n");
1511 printf("========================================================\n");
1512
1513 RunDumpsys("APP PROVIDERS NON-PLATFORM", {"activity", "provider", "all-non-platform"},
1514 DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001515
Adrian Roos8b397ab2017-04-04 16:35:44 -07001516 printf("========================================================\n");
1517 printf("== Dropbox crashes\n");
1518 printf("========================================================\n");
1519
1520 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1521 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1522
Felipe Lemed8b94e52016-12-08 10:21:44 -08001523 printf("========================================================\n");
1524 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1525 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1526 printf("========================================================\n");
1527 printf("== dumpstate: done (id %d)\n", ds.id_);
1528 printf("========================================================\n");
Bookatz38472142018-09-28 10:20:24 -07001529
1530 printf("========================================================\n");
1531 printf("== Obtaining statsd metadata\n");
1532 printf("========================================================\n");
1533 // This differs from the usual dumpsys stats, which is the stats report data.
1534 RunDumpsys("STATSDSTATS", {"stats", "--metadata"});
Mike Ma5c267872019-08-21 11:31:34 -07001535
1536 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpIncidentReport);
1537
Nandana Dutt5c390032019-03-12 10:52:56 +00001538 return Dumpstate::RunStatus::OK;
Colin Crossf45fa6b2012-03-26 12:38:26 -07001539}
1540
Nandana Dutt5c390032019-03-12 10:52:56 +00001541/*
1542 * Dumps state for the default case; drops root after it's no longer necessary.
1543 *
1544 * Returns RunStatus::OK if everything went fine.
1545 * Returns RunStatus::ERROR if there was an error.
1546 * Returns RunStatus::USER_DENIED_CONSENT if user explicitly denied consent to sharing the bugreport
1547 * with the caller.
1548 */
Jichao Lie89d9c12019-11-21 19:02:51 -08001549Dumpstate::RunStatus Dumpstate::DumpstateDefaultAfterCritical() {
Nandana Duttdb379fa2019-10-09 16:54:41 +01001550 // Capture first logcat early on; useful to take a snapshot before dumpstate logs take over the
1551 // buffer.
1552 DoLogcat();
1553 // Capture timestamp after first logcat to use in next logcat
1554 time_t logcat_ts = time(nullptr);
1555
Nandana Dutt4be45d12018-09-26 15:04:23 +01001556 /* collect stack traces from Dalvik and native processes (needs root) */
Nandana Duttcf419a72019-03-14 10:40:17 +00001557 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(ds.DumpTraces, &dump_traces_path);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001558
1559 /* Run some operations that require root. */
1560 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX, !ds.IsZipping());
1561 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX, !ds.IsZipping());
1562
1563 ds.AddDir(RECOVERY_DIR, true);
1564 ds.AddDir(RECOVERY_DATA_DIR, true);
1565 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
1566 ds.AddDir(LOGPERSIST_DATA_DIR, false);
Yifan Hong0efa7972020-02-03 16:45:02 -08001567 ds.AddDir(SNAPSHOTCTL_LOG_DIR, false);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001568 if (!PropertiesHelper::IsUserBuild()) {
1569 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1570 ds.AddDir(PROFILE_DATA_DIR_REF, true);
1571 }
1572 add_mountinfo();
1573 DumpIpTablesAsRoot();
David Andersond9ba4752018-12-11 18:26:59 -08001574 DumpDynamicPartitionInfo();
Yifan Hong3945e1b2019-10-29 12:59:23 -07001575 ds.AddDir(OTA_METADATA_DIR, true);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001576
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001577 // Capture any IPSec policies in play. No keys are exposed here.
Nandana Dutt4be45d12018-09-26 15:04:23 +01001578 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1579
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001580 // Dump IPsec stats. No keys are exposed here.
1581 DumpFile("XFRM STATS", XFRM_STAT_PROC_FILE);
1582
Nandana Dutt4be45d12018-09-26 15:04:23 +01001583 // Run ss as root so we can see socket marks.
1584 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
1585
1586 // Run iotop as root to show top 100 IO threads
1587 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
1588
Erick Reyese68df822019-02-11 14:46:36 -08001589 // Gather shared memory buffer info if the product implements it
1590 struct stat st;
1591 if (!stat("/product/bin/dmabuf_dump", &st)) {
1592 RunCommand("Dmabuf dump", {"/product/bin/dmabuf_dump"});
1593 }
1594
Minchan Kim22c6a1e2019-09-30 15:58:10 -07001595 DumpFile("PSI cpu", "/proc/pressure/cpu");
1596 DumpFile("PSI memory", "/proc/pressure/memory");
1597 DumpFile("PSI io", "/proc/pressure/io");
1598
Nandana Dutt4be45d12018-09-26 15:04:23 +01001599 if (!DropRootUser()) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001600 return Dumpstate::RunStatus::ERROR;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001601 }
1602
Nandana Dutt5c390032019-03-12 10:52:56 +00001603 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttdb379fa2019-10-09 16:54:41 +01001604 Dumpstate::RunStatus status = dumpstate();
1605 // Capture logcat since the last time we did it.
1606 DoSystemLogcat(logcat_ts);
1607 return status;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001608}
1609
mukesh agrawal253dad42018-01-23 21:59:59 -08001610// This method collects common dumpsys for telephony and wifi
1611static void DumpstateRadioCommon() {
Jayachandran Ca94c7172017-06-10 15:08:12 -07001612 DumpIpTablesAsRoot();
1613
Jayachandran Cb4389d92019-07-08 09:46:05 -07001614 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1615
Jayachandran Ca94c7172017-06-10 15:08:12 -07001616 if (!DropRootUser()) {
1617 return;
1618 }
1619
1620 do_dmesg();
1621 DoLogcat();
1622 DumpPacketStats();
1623 DoKmsg();
1624 DumpIpAddrAndRules();
1625 dump_route_tables();
Jayachandran Cb4389d92019-07-08 09:46:05 -07001626 DumpHals();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001627
1628 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
1629 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08001630}
1631
1632// This method collects dumpsys for telephony debugging only
1633static void DumpstateTelephonyOnly() {
1634 DurationReporter duration_reporter("DUMPSTATE");
Jichao Lie89d9c12019-11-21 19:02:51 -08001635
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001636 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08001637
1638 DumpstateRadioCommon();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001639
1640 RunCommand("SYSTEM PROPERTIES", {"getprop"});
1641
1642 printf("========================================================\n");
1643 printf("== Android Framework Services\n");
1644 printf("========================================================\n");
1645
Vishnu Nair652cc802017-11-30 15:18:30 -08001646 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1647 SEC_TO_MSEC(10));
Chiachang Wang85e0db32019-03-25 08:59:55 +08001648 RunDumpsys("DUMPSYS", {"connmetrics"}, CommandOptions::WithTimeout(90).Build(),
1649 SEC_TO_MSEC(10));
1650 RunDumpsys("DUMPSYS", {"netd"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Vishnu Nair652cc802017-11-30 15:18:30 -08001651 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
1652 SEC_TO_MSEC(10));
Amruth Ramachandrand25a9142018-04-02 16:16:09 -07001653 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
1654 SEC_TO_MSEC(10));
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07001655 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
1656 SEC_TO_MSEC(10));
Jayachandran Ca94c7172017-06-10 15:08:12 -07001657
1658 printf("========================================================\n");
1659 printf("== Running Application Services\n");
1660 printf("========================================================\n");
1661
1662 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
1663
1664 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001665 printf("== Running Application Services (non-platform)\n");
1666 printf("========================================================\n");
1667
1668 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1669 DUMPSYS_COMPONENTS_OPTIONS);
1670
1671 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07001672 printf("== Checkins\n");
1673 printf("========================================================\n");
1674
1675 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
1676
1677 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07001678 printf("== dumpstate: done (id %d)\n", ds.id_);
1679 printf("========================================================\n");
1680}
1681
mukesh agrawal253dad42018-01-23 21:59:59 -08001682// This method collects dumpsys for wifi debugging only
1683static void DumpstateWifiOnly() {
1684 DurationReporter duration_reporter("DUMPSTATE");
1685
1686 DumpstateRadioCommon();
1687
1688 printf("========================================================\n");
1689 printf("== Android Framework Services\n");
1690 printf("========================================================\n");
1691
1692 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1693 SEC_TO_MSEC(10));
1694 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
1695 SEC_TO_MSEC(10));
1696
1697 printf("========================================================\n");
1698 printf("== dumpstate: done (id %d)\n", ds.id_);
1699 printf("========================================================\n");
1700}
1701
Nandana Duttcf419a72019-03-14 10:40:17 +00001702Dumpstate::RunStatus Dumpstate::DumpTraces(const char** path) {
Nandana Duttfaafd522019-03-11 09:23:09 +00001703 DurationReporter duration_reporter("DUMP TRACES");
1704
1705 const std::string temp_file_pattern = "/data/anr/dumptrace_XXXXXX";
1706 const size_t buf_size = temp_file_pattern.length() + 1;
1707 std::unique_ptr<char[]> file_name_buf(new char[buf_size]);
1708 memcpy(file_name_buf.get(), temp_file_pattern.c_str(), buf_size);
1709
1710 // Create a new, empty file to receive all trace dumps.
1711 //
1712 // TODO: This can be simplified once we remove support for the old style
1713 // dumps. We can have a file descriptor passed in to dump_traces instead
1714 // of creating a file, closing it and then reopening it again.
1715 android::base::unique_fd fd(mkostemp(file_name_buf.get(), O_APPEND | O_CLOEXEC));
1716 if (fd < 0) {
1717 MYLOGE("mkostemp on pattern %s: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001718 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001719 }
1720
1721 // Nobody should have access to this temporary file except dumpstate, but we
1722 // temporarily grant 'read' to 'others' here because this file is created
1723 // when tombstoned is still running as root, but dumped after dropping. This
1724 // can go away once support for old style dumping has.
1725 const int chmod_ret = fchmod(fd, 0666);
1726 if (chmod_ret < 0) {
1727 MYLOGE("fchmod on %s failed: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001728 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001729 }
1730
1731 std::unique_ptr<DIR, decltype(&closedir)> proc(opendir("/proc"), closedir);
1732 if (proc.get() == nullptr) {
1733 MYLOGE("opendir /proc failed: %s\n", strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001734 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001735 }
1736
1737 // Number of times process dumping has timed out. If we encounter too many
1738 // failures, we'll give up.
1739 int timeout_failures = 0;
1740 bool dalvik_found = false;
1741
1742 const std::set<int> hal_pids = get_interesting_hal_pids();
1743
1744 struct dirent* d;
1745 while ((d = readdir(proc.get()))) {
Nandana Duttcf419a72019-03-14 10:40:17 +00001746 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttfaafd522019-03-11 09:23:09 +00001747 int pid = atoi(d->d_name);
1748 if (pid <= 0) {
1749 continue;
1750 }
1751
1752 const std::string link_name = android::base::StringPrintf("/proc/%d/exe", pid);
1753 std::string exe;
1754 if (!android::base::Readlink(link_name, &exe)) {
1755 continue;
1756 }
1757
1758 bool is_java_process;
1759 if (exe == "/system/bin/app_process32" || exe == "/system/bin/app_process64") {
1760 // Don't bother dumping backtraces for the zygote.
1761 if (IsZygote(pid)) {
1762 continue;
1763 }
1764
1765 dalvik_found = true;
1766 is_java_process = true;
1767 } else if (should_dump_native_traces(exe.c_str()) || hal_pids.find(pid) != hal_pids.end()) {
1768 is_java_process = false;
1769 } else {
1770 // Probably a native process we don't care about, continue.
1771 continue;
1772 }
1773
1774 // If 3 backtrace dumps fail in a row, consider debuggerd dead.
1775 if (timeout_failures == 3) {
1776 dprintf(fd, "ERROR: Too many stack dump failures, exiting.\n");
1777 break;
1778 }
1779
1780 const uint64_t start = Nanotime();
1781 const int ret = dump_backtrace_to_file_timeout(
1782 pid, is_java_process ? kDebuggerdJavaBacktrace : kDebuggerdNativeBacktrace,
1783 is_java_process ? 5 : 20, fd);
1784
1785 if (ret == -1) {
1786 // For consistency, the header and footer to this message match those
1787 // dumped by debuggerd in the success case.
1788 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
1789 dprintf(fd, "Dump failed, likely due to a timeout.\n");
1790 dprintf(fd, "---- end %d ----", pid);
1791 timeout_failures++;
1792 continue;
1793 }
1794
1795 // We've successfully dumped stack traces, reset the failure count
1796 // and write a summary of the elapsed time to the file and continue with the
1797 // next process.
1798 timeout_failures = 0;
1799
1800 dprintf(fd, "[dump %s stack %d: %.3fs elapsed]\n", is_java_process ? "dalvik" : "native",
1801 pid, (float)(Nanotime() - start) / NANOS_PER_SEC);
1802 }
1803
1804 if (!dalvik_found) {
1805 MYLOGE("Warning: no Dalvik processes found to dump stacks\n");
1806 }
1807
Nandana Duttcf419a72019-03-14 10:40:17 +00001808 *path = file_name_buf.release();
1809 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001810}
1811
Felipe Leme6f674ae2016-11-18 17:10:33 -08001812void Dumpstate::DumpstateBoard() {
1813 DurationReporter duration_reporter("dumpstate_board()");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001814 printf("========================================================\n");
1815 printf("== Board\n");
1816 printf("========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001817
Felipe Leme6f674ae2016-11-18 17:10:33 -08001818 if (!IsZipping()) {
Steven Moreland7440ddb2016-12-15 16:13:39 -08001819 MYLOGD("Not dumping board info because it's not a zipped bugreport\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001820 return;
1821 }
1822
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001823 std::vector<std::string> paths;
1824 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07001825 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00001826 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
1827 kDumpstateBoardFiles[i].c_str()));
Nandana Dutt16d1aee2019-02-15 16:13:53 +00001828 remover.emplace_back(android::base::make_scope_guard(
1829 std::bind([](std::string path) { android::os::UnlinkAndLogOnError(path); }, paths[i])));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001830 }
Jie Song9fbfad02017-06-20 16:29:42 -07001831
Wei Wang587eac92018-04-05 12:17:20 -07001832 sp<IDumpstateDevice> dumpstate_device(IDumpstateDevice::getService());
1833 if (dumpstate_device == nullptr) {
1834 MYLOGE("No IDumpstateDevice implementation\n");
1835 return;
1836 }
1837
1838 using ScopedNativeHandle =
1839 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
1840 ScopedNativeHandle handle(native_handle_create(static_cast<int>(paths.size()), 0),
1841 [](native_handle_t* handle) {
1842 native_handle_close(handle);
1843 native_handle_delete(handle);
1844 });
1845 if (handle == nullptr) {
1846 MYLOGE("Could not create native_handle\n");
1847 return;
1848 }
1849
Nandana Dutt5c390032019-03-12 10:52:56 +00001850 // TODO(128270426): Check for consent in between?
Wei Wang587eac92018-04-05 12:17:20 -07001851 for (size_t i = 0; i < paths.size(); i++) {
1852 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
1853
1854 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
1855 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1856 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1857 if (fd < 0) {
1858 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
1859 return;
1860 }
1861 handle.get()->data[i] = fd.release();
1862 }
1863
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001864 // Given that bugreport is required to diagnose failures, it's better to
Wei Wang587eac92018-04-05 12:17:20 -07001865 // set an arbitrary amount of timeout for IDumpstateDevice than to block the
1866 // rest of bugreport. In the timeout case, we will kill dumpstate board HAL
1867 // and grab whatever dumped
1868 std::packaged_task<bool()>
1869 dumpstate_task([paths, dumpstate_device, &handle]() -> bool {
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001870 android::hardware::Return<void> status = dumpstate_device->dumpstateBoard(handle.get());
1871 if (!status.isOk()) {
1872 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
Wei Wang587eac92018-04-05 12:17:20 -07001873 return false;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001874 }
Wei Wang587eac92018-04-05 12:17:20 -07001875 return true;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001876 });
Wei Wang587eac92018-04-05 12:17:20 -07001877
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001878 auto result = dumpstate_task.get_future();
1879 std::thread(std::move(dumpstate_task)).detach();
Wei Wang587eac92018-04-05 12:17:20 -07001880
1881 constexpr size_t timeout_sec = 30;
1882 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
1883 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate vendor HAL\n", timeout_sec);
1884 if (!android::base::SetProperty("ctl.interface_restart",
1885 android::base::StringPrintf("%s/default",
1886 IDumpstateDevice::descriptor))) {
1887 MYLOGE("Couldn't restart dumpstate HAL\n");
1888 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001889 }
Wei Wang587eac92018-04-05 12:17:20 -07001890 // Wait some time for init to kill dumpstate vendor HAL
1891 constexpr size_t killing_timeout_sec = 10;
1892 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
1893 MYLOGE("killing dumpstateBoard timed out after %zus, continue and "
1894 "there might be racing in content\n", killing_timeout_sec);
1895 }
1896
1897 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
1898 for (size_t i = 0; i < paths.size(); i++) {
1899 struct stat s;
1900 if (fstat(handle.get()->data[i], &s) == -1) {
1901 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(),
1902 strerror(errno));
1903 file_sizes[i] = -1;
1904 continue;
1905 }
1906 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001907 }
1908
1909 for (size_t i = 0; i < paths.size(); i++) {
1910 if (file_sizes[i] == -1) {
1911 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07001912 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001913 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07001914 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001915 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07001916 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07001917 AddZipEntry(kDumpstateBoardFiles[i], paths[i]);
Jie Song9fbfad02017-06-20 16:29:42 -07001918 }
1919
Felipe Lemed8b94e52016-12-08 10:21:44 -08001920 printf("*** See dumpstate-board.txt entry ***\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08001921}
1922
Nandana Dutt12ae14a2019-01-09 10:35:53 +00001923static void ShowUsage() {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001924 fprintf(stderr,
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001925 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-d] [-p] "
Abhijeet Kaure370d682019-10-01 16:49:30 +01001926 "[-z]] [-s] [-S] [-q] [-P] [-R] [-V version]\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001927 " -h: display this help message\n"
1928 " -b: play sound file instead of vibrate, at beginning of job\n"
1929 " -e: play sound file instead of vibrate, at end of job\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001930 " -d: append date to filename\n"
1931 " -p: capture screenshot to filename.png\n"
1932 " -z: generate zipped file\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001933 " -s: write output to control socket (for init)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01001934 " -S: write file location to control socket (for init; requires -z)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07001935 " -q: disable vibrate\n"
Abhijeet Kaure370d682019-10-01 16:49:30 +01001936 " -P: send broadcast when started and do progress updates\n"
1937 " -R: take bugreport in remote mode (requires -z and -d, shouldn't be used with -P)\n"
Nandana Dutt235864b2019-01-22 12:10:16 +00001938 " -w: start binder service and make it wait for a call to startBugreport\n"
Felipe Lemed071c682016-10-20 16:48:00 -07001939 " -v: prints the dumpstate header and exit\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001940}
1941
Wei Liuf87959e2016-08-26 14:51:42 -07001942static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07001943 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07001944}
1945
Felipe Leme1d486fe2016-10-14 18:06:47 -07001946bool Dumpstate::FinishZipFile() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001947 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07001948 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07001949 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07001950 // Final timestamp
1951 char date[80];
1952 time_t the_real_now_please_stand_up = time(nullptr);
1953 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07001954 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001955 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07001956
Felipe Leme9a523ae2016-10-20 15:10:33 -07001957 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001958 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08001959 return false;
1960 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07001961 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001962 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08001963 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08001964 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08001965
Felipe Leme0f3fb202016-06-10 17:10:53 -07001966 // Add log file (which contains stderr output) to zip...
1967 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07001968 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07001969 MYLOGE("Failed to add dumpstate log to .zip file\n");
1970 return false;
1971 }
Nandana Dutt979388e2018-11-30 16:48:55 +00001972 // TODO: Should truncate the existing file.
1973 // ... and re-open it for further logging.
Nandana Dutta344cb62019-02-22 15:12:35 +00001974 if (!redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()))) {
1975 return false;
1976 }
Felipe Leme0f3fb202016-06-10 17:10:53 -07001977 fprintf(stderr, "\n");
1978
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07001979 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07001980 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07001981 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08001982 return false;
1983 }
1984
Felipe Leme1d486fe2016-10-14 18:06:47 -07001985 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
1986 ds.zip_file.reset(nullptr);
1987
Felipe Lemee9d2c542016-11-15 11:48:26 -08001988 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
Nandana Dutt16d1aee2019-02-15 16:13:53 +00001989 android::os::UnlinkAndLogOnError(tmp_path_);
Felipe Lemec4eee562016-04-21 15:42:55 -07001990
Felipe Leme1e9edc62015-12-21 16:02:13 -08001991 return true;
1992}
Felipe Leme6e01fa62015-11-11 19:35:14 -08001993
Felipe Lemea4ef1f02017-02-15 17:27:40 -08001994static void SendBroadcast(const std::string& action, const std::vector<std::string>& args) {
1995 // clang-format off
1996 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user", "0",
1997 "--receiver-foreground", "--receiver-include-background", "-a", action};
1998 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08001999
2000 am.insert(am.end(), args.begin(), args.end());
2001
Felipe Leme8d2410e2017-02-08 09:46:08 -08002002 RunCommand("", am,
2003 CommandOptions::WithTimeout(20)
2004 .Log("Sending broadcast: '%s'\n")
2005 .Always()
2006 .DropRoot()
2007 .RedirectStderr()
2008 .Build());
2009}
2010
Felipe Leme35b8cf12017-02-10 15:47:29 -08002011static void Vibrate(int duration_ms) {
2012 // clang-format off
Chris Fries0c3de872019-09-14 15:49:41 +00002013 RunCommand("", {"cmd", "vibrator", "vibrate", "-f", std::to_string(duration_ms), "dumpstate"},
Felipe Leme35b8cf12017-02-10 15:47:29 -08002014 CommandOptions::WithTimeout(10)
2015 .Log("Vibrate: '%s'\n")
2016 .Always()
2017 .Build());
2018 // clang-format on
2019}
2020
Nandana Dutt979388e2018-11-30 16:48:55 +00002021static void MaybeResolveSymlink(std::string* path) {
2022 std::string resolved_path;
2023 if (android::base::Readlink(*path, &resolved_path)) {
2024 *path = resolved_path;
2025 }
2026}
2027
Nandana Dutt4be45d12018-09-26 15:04:23 +01002028/*
2029 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
2030 * if we are writing zip files and adds the version file.
2031 */
2032static void PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002033 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
2034
Nandana Dutt4be45d12018-09-26 15:04:23 +01002035 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
2036 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002037 ds.base_name_ = StringPrintf("bugreport-%s-%s", device_name.c_str(), build_id.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002038 if (ds.options_->do_add_date) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002039 char date[80];
2040 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
2041 ds.name_ = date;
2042 } else {
2043 ds.name_ = "undated";
2044 }
2045
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002046 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002047 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002048 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002049 ds.base_name_ += "-wifi";
2050 }
2051
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002052 if (ds.options_->do_fb) {
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002053 ds.screenshot_path_ = ds.GetPath(ds.CalledByApi() ? "-tmp.png" : ".png");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002054 }
2055 ds.tmp_path_ = ds.GetPath(".tmp");
2056 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
2057
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002058 std::string destination = ds.CalledByApi()
Nandana Dutt54dbd672019-01-11 12:58:05 +00002059 ? StringPrintf("[fd:%d]", ds.options_->bugreport_fd.get())
Nandana Dutt9a76d202019-01-21 15:56:48 +00002060 : ds.bugreport_internal_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01002061 MYLOGD(
Nandana Dutt235c6672019-11-14 15:22:32 +00002062 "Bugreport dir: [%s] "
2063 "Base name: [%s] "
2064 "Suffix: [%s] "
2065 "Log path: [%s] "
2066 "Temporary path: [%s] "
2067 "Screenshot path: [%s]\n",
Nandana Dutt9a76d202019-01-21 15:56:48 +00002068 destination.c_str(), ds.base_name_.c_str(), ds.name_.c_str(), ds.log_path_.c_str(),
2069 ds.tmp_path_.c_str(), ds.screenshot_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002070
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002071 if (ds.options_->do_zip_file) {
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002072 ds.path_ = ds.GetPath(ds.CalledByApi() ? "-tmp.zip" : ".zip");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002073 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
2074 create_parent_dirs(ds.path_.c_str());
2075 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
2076 if (ds.zip_file == nullptr) {
2077 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
2078 } else {
2079 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
2080 }
2081 ds.AddTextZipEntry("version.txt", ds.version_);
2082 }
2083}
2084
2085/*
Abhijeet Kaure370d682019-10-01 16:49:30 +01002086 * Finalizes writing to the file by zipping the tmp file to the final location,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002087 * printing zipped file status, etc.
2088 */
2089static void FinalizeFile() {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002090 bool do_text_file = true;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002091 if (ds.options_->do_zip_file) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002092 if (!ds.FinishZipFile()) {
2093 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
2094 do_text_file = true;
2095 } else {
2096 do_text_file = false;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002097 }
2098 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002099 if (ds.options_->use_control_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002100 if (do_text_file) {
2101 dprintf(ds.control_socket_fd_,
2102 "FAIL:could not create zip file, check %s "
2103 "for more details\n",
2104 ds.log_path_.c_str());
2105 } else {
2106 dprintf(ds.control_socket_fd_, "OK:%s\n", ds.path_.c_str());
2107 }
2108 }
2109}
2110
Nandana Dutt4be45d12018-09-26 15:04:23 +01002111
Nandana Dutt58d72e22018-11-16 10:30:48 +00002112static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2113 switch (mode) {
2114 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2115 return "BUGREPORT_FULL";
2116 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2117 return "BUGREPORT_INTERACTIVE";
2118 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2119 return "BUGREPORT_REMOTE";
2120 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2121 return "BUGREPORT_WEAR";
2122 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2123 return "BUGREPORT_TELEPHONY";
2124 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2125 return "BUGREPORT_WIFI";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002126 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2127 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002128 }
2129}
2130
2131static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options) {
Abhijeet Kaure370d682019-10-01 16:49:30 +01002132 options->bugreport_mode = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002133 switch (mode) {
2134 case Dumpstate::BugreportMode::BUGREPORT_FULL:
Nandana Dutt58d72e22018-11-16 10:30:48 +00002135 options->do_fb = true;
2136 break;
2137 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002138 // Currently, the dumpstate binder is only used by Shell to update progress.
2139 options->do_start_service = true;
2140 options->do_progress_updates = true;
2141 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002142 break;
2143 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002144 options->do_vibrate = false;
2145 options->is_remote_mode = true;
2146 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002147 break;
2148 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002149 options->do_start_service = true;
2150 options->do_progress_updates = true;
2151 options->do_zip_file = true;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002152 options->do_fb = true;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002153 break;
2154 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002155 options->telephony_only = true;
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +00002156 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002157 break;
2158 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002159 options->wifi_only = true;
2160 options->do_zip_file = true;
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +00002161 options->do_fb = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002162 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002163 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2164 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002165 }
2166}
2167
Nandana Dutt58d72e22018-11-16 10:30:48 +00002168static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
Nandana Dutt235c6672019-11-14 15:22:32 +00002169 MYLOGI(
2170 "do_zip_file: %d do_vibrate: %d use_socket: %d use_control_socket: %d do_fb: %d "
2171 "is_remote_mode: %d show_header_only: %d do_start_service: %d telephony_only: %d "
2172 "wifi_only: %d do_progress_updates: %d fd: %d bugreport_mode: %s args: %s\n",
2173 options.do_zip_file, options.do_vibrate, options.use_socket, options.use_control_socket,
2174 options.do_fb, options.is_remote_mode, options.show_header_only, options.do_start_service,
2175 options.telephony_only, options.wifi_only, options.do_progress_updates,
2176 options.bugreport_fd.get(), options.bugreport_mode.c_str(), options.args.c_str());
Nandana Dutt58d72e22018-11-16 10:30:48 +00002177}
2178
Nandana Dutt54dbd672019-01-11 12:58:05 +00002179void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode,
2180 const android::base::unique_fd& bugreport_fd_in,
2181 const android::base::unique_fd& screenshot_fd_in) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002182 // In the new API world, date is always added; output is always a zip file.
2183 // TODO(111441001): remove these options once they are obsolete.
2184 do_add_date = true;
2185 do_zip_file = true;
2186
Nandana Dutt54dbd672019-01-11 12:58:05 +00002187 // Duplicate the fds because the passed in fds don't outlive the binder transaction.
2188 bugreport_fd.reset(dup(bugreport_fd_in.get()));
2189 screenshot_fd.reset(dup(screenshot_fd_in.get()));
Nandana Dutt58d72e22018-11-16 10:30:48 +00002190
Nandana Dutt58d72e22018-11-16 10:30:48 +00002191 SetOptionsFromMode(bugreport_mode, this);
2192}
2193
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002194Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
2195 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002196 int c;
Nandana Dutt235864b2019-01-22 12:10:16 +00002197 while ((c = getopt(argc, argv, "dho:svqzpPBRSV:w")) != -1) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002198 switch (c) {
2199 // clang-format off
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002200 case 'd': do_add_date = true; break;
2201 case 'z': do_zip_file = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002202 case 's': use_socket = true; break;
2203 case 'S': use_control_socket = true; break;
2204 case 'v': show_header_only = true; break;
2205 case 'q': do_vibrate = false; break;
2206 case 'p': do_fb = true; break;
2207 case 'P': do_progress_updates = true; break;
2208 case 'R': is_remote_mode = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002209 case 'V': break; // compatibility no-op
Nandana Dutt235864b2019-01-22 12:10:16 +00002210 case 'w':
2211 // This was already processed
2212 break;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002213 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002214 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002215 break;
2216 default:
2217 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002218 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002219 break;
2220 // clang-format on
2221 }
2222 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08002223
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002224 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002225 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002226 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002227 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002228 }
2229 }
2230
2231 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
2232 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002233
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002234 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002235}
2236
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002237bool Dumpstate::DumpOptions::ValidateOptions() const {
Nandana Dutt54dbd672019-01-11 12:58:05 +00002238 if (bugreport_fd.get() != -1 && !do_zip_file) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002239 return false;
2240 }
2241
Abhijeet Kaure370d682019-10-01 16:49:30 +01002242 if ((do_zip_file || do_add_date || do_progress_updates) && !OutputToFile()) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002243 return false;
2244 }
2245
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002246 if (use_control_socket && !do_zip_file) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002247 return false;
2248 }
2249
Abhijeet Kaure370d682019-10-01 16:49:30 +01002250 if (is_remote_mode && (do_progress_updates || !do_zip_file || !do_add_date)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002251 return false;
2252 }
2253 return true;
2254}
2255
Nandana Dutt197661d2018-11-16 16:40:21 +00002256void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
2257 options_ = std::move(options);
2258}
2259
Nandana Duttd2f5f082019-01-18 17:13:52 +00002260Dumpstate::RunStatus Dumpstate::Run(int32_t calling_uid, const std::string& calling_package) {
2261 Dumpstate::RunStatus status = RunInternal(calling_uid, calling_package);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002262 if (listener_ != nullptr) {
2263 switch (status) {
2264 case Dumpstate::RunStatus::OK:
Nandana Duttcc4ead82019-01-23 08:29:23 +00002265 listener_->onFinished();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002266 break;
2267 case Dumpstate::RunStatus::HELP:
2268 break;
2269 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002270 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_INVALID_INPUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002271 break;
2272 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002273 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_RUNTIME_ERROR);
2274 break;
2275 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2276 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_DENIED_CONSENT);
2277 break;
2278 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
2279 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_CONSENT_TIMED_OUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002280 break;
2281 }
2282 }
2283 return status;
2284}
2285
Nandana Dutt979388e2018-11-30 16:48:55 +00002286/*
2287 * Dumps relevant information to a bugreport based on the given options.
2288 *
2289 * The bugreport can be dumped to a file or streamed to a socket.
2290 *
2291 * How dumping to file works:
2292 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
2293 * stderr is redirected a log file.
2294 *
2295 * The temporary bugreport is then populated via printfs, dumping contents of files and
2296 * output of commands to stdout.
2297 *
2298 * If zipping, the temporary bugreport file is added to the zip archive. Else it's renamed to final
2299 * text file.
2300 *
2301 * If zipping, a bunch of other files and dumps also get added to the zip archive. The log file also
2302 * gets added to the archive.
2303 *
Nandana Dutt9a76d202019-01-21 15:56:48 +00002304 * Bugreports are first generated in a local directory and later copied to the caller's fd if
2305 * supplied.
Nandana Dutt979388e2018-11-30 16:48:55 +00002306 */
Nandana Duttd2f5f082019-01-18 17:13:52 +00002307Dumpstate::RunStatus Dumpstate::RunInternal(int32_t calling_uid,
2308 const std::string& calling_package) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002309 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00002310 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002311 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002312 return RunStatus::INVALID_INPUT;
2313 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002314 /* set as high priority, and protect from OOM killer */
2315 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002316
Felipe Lemed071c682016-10-20 16:48:00 -07002317 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002318 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002319 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002320 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002321 } else {
2322 /* fallback to kernels <= 2.6.35 */
2323 oom_adj = fopen("/proc/self/oom_adj", "we");
2324 if (oom_adj) {
2325 fputs("-17", oom_adj);
2326 fclose(oom_adj);
2327 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002328 }
2329
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002330 if (version_ == VERSION_DEFAULT) {
2331 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00002332 }
2333
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002334 if (version_ != VERSION_CURRENT && version_ != VERSION_SPLIT_ANR) {
Vishnu Nair64afc022018-02-01 15:29:34 -08002335 MYLOGE("invalid version requested ('%s'); suppported values are: ('%s', '%s', '%s')\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002336 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str(),
Vishnu Nair64afc022018-02-01 15:29:34 -08002337 VERSION_SPLIT_ANR.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002338 return RunStatus::INVALID_INPUT;
Felipe Lemed071c682016-10-20 16:48:00 -07002339 }
2340
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002341 if (options_->show_header_only) {
2342 PrintHeader();
2343 return RunStatus::OK;
Felipe Lemed071c682016-10-20 16:48:00 -07002344 }
2345
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002346 MYLOGD("dumpstate calling_uid = %d ; calling package = %s \n",
2347 calling_uid, calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00002348
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002349 // Redirect output if needed
Nandana Dutt9a76d202019-01-21 15:56:48 +00002350 bool is_redirecting = options_->OutputToFile();
Felipe Leme7447d7c2016-11-03 18:12:22 -07002351
2352 // TODO: temporarily set progress until it's part of the Dumpstate constructor
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002353 std::string stats_path =
Nandana Dutt979388e2018-11-30 16:48:55 +00002354 is_redirecting
2355 ? android::base::StringPrintf("%s/dumpstate-stats.txt", bugreport_internal_dir_.c_str())
2356 : "";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002357 progress_.reset(new Progress(stats_path));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002358
Felipe Lemed071c682016-10-20 16:48:00 -07002359 /* gets the sequential id */
Felipe Leme7447d7c2016-11-03 18:12:22 -07002360 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002361 id_ = ++last_id;
Felipe Lemed071c682016-10-20 16:48:00 -07002362 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
2363
Sahana Raof35ed432019-07-12 10:47:52 +01002364 if (acquire_wake_lock(PARTIAL_WAKE_LOCK, WAKE_LOCK_NAME) < 0) {
2365 MYLOGE("Failed to acquire wake lock: %s\n", strerror(errno));
2366 } else {
2367 // Wake lock will be released automatically on process death
2368 MYLOGD("Wake lock acquired.\n");
2369 }
2370
Felipe Leme6ae5c4f2017-01-10 14:13:22 -08002371 register_sig_handler();
Felipe Lemed071c682016-10-20 16:48:00 -07002372
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002373 // TODO(b/111441001): maybe skip if already started?
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002374 if (options_->do_start_service) {
Felipe Leme75876a22016-10-27 16:31:27 -07002375 MYLOGI("Starting 'dumpstate' service\n");
2376 android::status_t ret;
2377 if ((ret = android::os::DumpstateService::Start()) != android::OK) {
2378 MYLOGE("Unable to start DumpstateService: %d\n", ret);
2379 }
2380 }
2381
Felipe Lemef0292972016-11-22 13:57:05 -08002382 if (PropertiesHelper::IsDryRun()) {
Felipe Lemed071c682016-10-20 16:48:00 -07002383 MYLOGI("Running on dry-run mode (to disable it, call 'setprop dumpstate.dry_run false')\n");
2384 }
2385
Nandana Dutt235c6672019-11-14 15:22:32 +00002386 MYLOGI("dumpstate info: id=%d, args='%s', bugreport_mode= %s bugreport format version: %s\n",
2387 id_, options_->args.c_str(), options_->bugreport_mode.c_str(), version_.c_str());
Felipe Leme809d74e2016-02-02 12:57:00 -08002388
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002389 do_early_screenshot_ = options_->do_progress_updates;
Felipe Lemee338bf62015-12-07 14:03:50 -08002390
Christopher Ferrised9354f2014-10-01 17:35:01 -07002391 // If we are going to use a socket, do it as early as possible
2392 // to avoid timeouts from bugreport.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002393 if (options_->use_socket) {
Nandana Dutta344cb62019-02-22 15:12:35 +00002394 if (!redirect_to_socket(stdout, "dumpstate")) {
2395 return ERROR;
2396 }
Christopher Ferrised9354f2014-10-01 17:35:01 -07002397 }
2398
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002399 if (options_->use_control_socket) {
Felipe Leme2628e9e2016-04-12 16:36:51 -07002400 MYLOGD("Opening control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002401 control_socket_fd_ = open_socket("dumpstate");
Nandana Dutta344cb62019-02-22 15:12:35 +00002402 if (control_socket_fd_ == -1) {
2403 return ERROR;
2404 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002405 options_->do_progress_updates = 1;
Felipe Leme2628e9e2016-04-12 16:36:51 -07002406 }
2407
Felipe Leme71bbfc52015-11-23 14:14:51 -08002408 if (is_redirecting) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002409 PrepareToWriteToFile();
Felipe Leme1e9edc62015-12-21 16:02:13 -08002410
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002411 if (options_->do_progress_updates) {
Abhijeet Kaure370d682019-10-01 16:49:30 +01002412 // clang-format off
2413 std::vector<std::string> am_args = {
2414 "--receiver-permission", "android.permission.DUMP",
2415 };
2416 // clang-format on
2417 // Send STARTED broadcast for apps that listen to bugreport generation events
2418 SendBroadcast("com.android.internal.intent.action.BUGREPORT_STARTED", am_args);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002419 if (options_->use_control_socket) {
2420 dprintf(control_socket_fd_, "BEGIN:%s\n", path_.c_str());
Felipe Lemeaabfcae2016-07-29 09:49:04 -07002421 }
Felipe Leme71bbfc52015-11-23 14:14:51 -08002422 }
2423 }
2424
Nick Kralevichf3599b32016-01-25 15:05:16 -08002425 /* read /proc/cmdline before dropping root */
2426 FILE *cmdline = fopen("/proc/cmdline", "re");
2427 if (cmdline) {
2428 fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
2429 fclose(cmdline);
2430 }
2431
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002432 if (options_->do_vibrate) {
Felipe Leme35b8cf12017-02-10 15:47:29 -08002433 Vibrate(150);
John Michelau1f794c42012-09-17 11:20:19 -05002434 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002435
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002436 if (options_->do_fb && do_early_screenshot_) {
Greg Kaiser3ddc3fa2019-05-23 16:14:52 -07002437 MYLOGI("taking early screenshot\n");
2438 TakeScreenshot();
Felipe Lemee338bf62015-12-07 14:03:50 -08002439 }
2440
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002441 if (options_->do_zip_file && zip_file != nullptr) {
2442 if (chown(path_.c_str(), AID_SHELL, AID_SHELL)) {
2443 MYLOGE("Unable to change ownership of zip file %s: %s\n", path_.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -07002444 strerror(errno));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002445 }
2446 }
2447
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002448 int dup_stdout_fd;
2449 int dup_stderr_fd;
Felipe Leme71bbfc52015-11-23 14:14:51 -08002450 if (is_redirecting) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002451 // Redirect stderr to log_path_ for debugging.
Vishnu Nair20cf5032018-01-05 13:15:49 -08002452 TEMP_FAILURE_RETRY(dup_stderr_fd = dup(fileno(stderr)));
Nandana Dutta344cb62019-02-22 15:12:35 +00002453 if (!redirect_to_file(stderr, const_cast<char*>(log_path_.c_str()))) {
2454 return ERROR;
2455 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002456 if (chown(log_path_.c_str(), AID_SHELL, AID_SHELL)) {
2457 MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n", log_path_.c_str(),
2458 strerror(errno));
Felipe Leme6fe9db62016-02-12 09:04:16 -08002459 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002460
2461 // Redirect stdout to tmp_path_. This is the main bugreport entry and will be
2462 // moved into zip file later, if zipping.
Vishnu Nair20cf5032018-01-05 13:15:49 -08002463 TEMP_FAILURE_RETRY(dup_stdout_fd = dup(fileno(stdout)));
Nandana Dutt979388e2018-11-30 16:48:55 +00002464 // TODO: why not write to a file instead of stdout to overcome this problem?
Felipe Leme6e01fa62015-11-11 19:35:14 -08002465 /* TODO: rather than generating a text file now and zipping it later,
2466 it would be more efficient to redirect stdout to the zip entry
2467 directly, but the libziparchive doesn't support that option yet. */
Nandana Dutta344cb62019-02-22 15:12:35 +00002468 if (!redirect_to_file(stdout, const_cast<char*>(tmp_path_.c_str()))) {
2469 return ERROR;
2470 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002471 if (chown(tmp_path_.c_str(), AID_SHELL, AID_SHELL)) {
Felipe Leme6fe9db62016-02-12 09:04:16 -08002472 MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002473 tmp_path_.c_str(), strerror(errno));
Felipe Leme6fe9db62016-02-12 09:04:16 -08002474 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002475 }
Felipe Lemed8b94e52016-12-08 10:21:44 -08002476
2477 // Don't buffer stdout
2478 setvbuf(stdout, nullptr, _IONBF, 0);
2479
Felipe Leme608385d2016-02-01 10:35:38 -08002480 // NOTE: there should be no stdout output until now, otherwise it would break the header.
2481 // In particular, DurationReport objects should be created passing 'title, NULL', so their
Felipe Lemecbce55d2016-02-08 09:53:18 -08002482 // duration is logged into MYLOG instead.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002483 PrintHeader();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002484
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002485 if (options_->telephony_only) {
Jichao Lie89d9c12019-11-21 19:02:51 -08002486 MaybeCheckUserConsent(calling_uid, calling_package);
Jayachandran Ca94c7172017-06-10 15:08:12 -07002487 DumpstateTelephonyOnly();
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002488 DumpstateBoard();
2489 } else if (options_->wifi_only) {
Jichao Lie89d9c12019-11-21 19:02:51 -08002490 MaybeCheckUserConsent(calling_uid, calling_package);
mukesh agrawal253dad42018-01-23 21:59:59 -08002491 DumpstateWifiOnly();
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002492 } else {
Jichao Lie89d9c12019-11-21 19:02:51 -08002493 // Invoking the critical dumpsys calls before DumpTraces() to try and
2494 // keep the system stats as close to its initial state as possible.
2495 RunDumpsysCritical();
2496
2497 // Run consent check only after critical dumpsys has finished -- so the consent
2498 // isn't going to pollute the system state / logs.
2499 MaybeCheckUserConsent(calling_uid, calling_package);
2500
Nandana Dutt4be45d12018-09-26 15:04:23 +01002501 // Dump state for the default case. This also drops root.
Jichao Lie89d9c12019-11-21 19:02:51 -08002502 RunStatus s = DumpstateDefaultAfterCritical();
Nandana Dutt5c390032019-03-12 10:52:56 +00002503 if (s != RunStatus::OK) {
Nandana Duttaac6f582019-07-26 14:32:47 +01002504 if (s == RunStatus::USER_CONSENT_DENIED) {
Nandana Dutt5c390032019-03-12 10:52:56 +00002505 HandleUserConsentDenied();
2506 }
2507 return s;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002508 }
Zhengyin Qian068ecc72016-08-10 16:48:14 -07002509 }
Felipe Leme71a74ac2016-03-17 15:43:25 -07002510
Felipe Leme55b42a62015-11-10 17:39:08 -08002511 /* close output if needed */
Felipe Leme71bbfc52015-11-23 14:14:51 -08002512 if (is_redirecting) {
Vishnu Nair20cf5032018-01-05 13:15:49 -08002513 TEMP_FAILURE_RETRY(dup2(dup_stdout_fd, fileno(stdout)));
Colin Crossf45fa6b2012-03-26 12:38:26 -07002514 }
2515
Abhijeet Kaure370d682019-10-01 16:49:30 +01002516 // Zip the (now complete) .tmp file within the internal directory.
Nandana Dutt9a76d202019-01-21 15:56:48 +00002517 if (options_->OutputToFile()) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002518 FinalizeFile();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002519 }
2520
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002521 // Share the final file with the caller if the user has consented or Shell is the caller.
Nandana Duttd2f5f082019-01-18 17:13:52 +00002522 Dumpstate::RunStatus status = Dumpstate::RunStatus::OK;
Abhijeet Kaure370d682019-10-01 16:49:30 +01002523 if (CalledByApi()) {
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002524 status = CopyBugreportIfUserConsented(calling_uid);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002525 if (status != Dumpstate::RunStatus::OK &&
2526 status != Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2527 // Do an early return if there were errors. We make an exception for consent
2528 // timing out because it's possible the user got distracted. In this case the
2529 // bugreport is not shared but made available for manual retrieval.
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002530 MYLOGI("User denied consent. Returning\n");
Nandana Duttd2f5f082019-01-18 17:13:52 +00002531 return status;
2532 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002533 if (options_->do_fb && options_->screenshot_fd.get() != -1) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00002534 bool copy_succeeded = android::os::CopyFileToFd(screenshot_path_,
2535 options_->screenshot_fd.get());
2536 if (copy_succeeded) {
2537 android::os::UnlinkAndLogOnError(screenshot_path_);
2538 }
2539 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002540 if (status == Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2541 MYLOGI(
2542 "Did not receive user consent yet."
2543 " Will not copy the bugreport artifacts to caller.\n");
Abhijeet Kaur57627412019-04-17 16:00:09 +01002544 const String16 incidentcompanion("incidentcompanion");
2545 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
2546 if (ics != nullptr) {
2547 MYLOGD("Canceling user consent request via incidentcompanion service\n");
2548 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
2549 consent_callback_.get());
2550 } else {
2551 MYLOGD("Unable to cancel user consent; incidentcompanion service unavailable\n");
2552 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002553 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00002554 }
2555
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002556 /* vibrate a few but shortly times to let user know it's finished */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002557 if (options_->do_vibrate) {
Takuya Ogawa47f644e2017-12-20 18:09:09 +09002558 for (int i = 0; i < 3; i++) {
2559 Vibrate(75);
2560 usleep((75 + 50) * 1000);
2561 }
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002562 }
2563
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002564 MYLOGD("Final progress: %d/%d (estimated %d)\n", progress_->Get(), progress_->GetMax(),
2565 progress_->GetInitialMax());
2566 progress_->Save();
2567 MYLOGI("done (id %d)\n", id_);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002568
Felipe Leme107a05f2016-03-08 15:11:15 -08002569 if (is_redirecting) {
Vishnu Nair20cf5032018-01-05 13:15:49 -08002570 TEMP_FAILURE_RETRY(dup2(dup_stderr_fd, fileno(stderr)));
Felipe Leme107a05f2016-03-08 15:11:15 -08002571 }
2572
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002573 if (options_->use_control_socket && control_socket_fd_ != -1) {
Felipe Lemee844a9d2016-09-21 15:01:39 -07002574 MYLOGD("Closing control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002575 close(control_socket_fd_);
Felipe Leme2628e9e2016-04-12 16:36:51 -07002576 }
2577
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002578 tombstone_data_.clear();
2579 anr_data_.clear();
Narayan Kamath6b9516c2017-10-27 11:15:51 +01002580
Nandana Duttd2f5f082019-01-18 17:13:52 +00002581 return (consent_callback_ != nullptr &&
2582 consent_callback_->getResult() == UserConsentResult::UNAVAILABLE)
2583 ? USER_CONSENT_TIMED_OUT
2584 : RunStatus::OK;
2585}
2586
Jichao Lie89d9c12019-11-21 19:02:51 -08002587void Dumpstate::MaybeCheckUserConsent(int32_t calling_uid, const std::string& calling_package) {
2588 if (calling_uid == AID_SHELL || !CalledByApi()) {
2589 // No need to get consent for shell triggered dumpstates, or not through
2590 // bugreporting API (i.e. no fd to copy back).
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002591 return;
2592 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00002593 consent_callback_ = new ConsentCallback();
2594 const String16 incidentcompanion("incidentcompanion");
2595 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
Jichao Lie89d9c12019-11-21 19:02:51 -08002596 android::String16 package(calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00002597 if (ics != nullptr) {
2598 MYLOGD("Checking user consent via incidentcompanion service\n");
2599 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
Jichao Lie89d9c12019-11-21 19:02:51 -08002600 calling_uid, package, String16(), String16(),
Joe Onorato1c36d752019-03-17 18:26:43 -07002601 0x1 /* FLAG_CONFIRMATION_DIALOG */, consent_callback_.get());
Nandana Duttd2f5f082019-01-18 17:13:52 +00002602 } else {
2603 MYLOGD("Unable to check user consent; incidentcompanion service unavailable\n");
2604 }
2605}
2606
Nandana Dutt5c390032019-03-12 10:52:56 +00002607bool Dumpstate::IsUserConsentDenied() const {
2608 return ds.consent_callback_ != nullptr &&
2609 ds.consent_callback_->getResult() == UserConsentResult::DENIED;
2610}
2611
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002612bool Dumpstate::CalledByApi() const {
2613 return ds.options_->bugreport_fd.get() != -1 ? true : false;
2614}
2615
Nandana Duttd2f5f082019-01-18 17:13:52 +00002616void Dumpstate::CleanupFiles() {
2617 android::os::UnlinkAndLogOnError(tmp_path_);
2618 android::os::UnlinkAndLogOnError(screenshot_path_);
2619 android::os::UnlinkAndLogOnError(path_);
2620}
2621
2622Dumpstate::RunStatus Dumpstate::HandleUserConsentDenied() {
2623 MYLOGD("User denied consent; deleting files and returning\n");
2624 CleanupFiles();
2625 return USER_CONSENT_DENIED;
2626}
2627
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002628Dumpstate::RunStatus Dumpstate::CopyBugreportIfUserConsented(int32_t calling_uid) {
Nandana Duttd2f5f082019-01-18 17:13:52 +00002629 // If the caller has asked to copy the bugreport over to their directory, we need explicit
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002630 // user consent (unless the caller is Shell).
2631 UserConsentResult consent_result;
2632 if (calling_uid == AID_SHELL) {
2633 consent_result = UserConsentResult::APPROVED;
2634 } else {
2635 consent_result = consent_callback_->getResult();
2636 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00002637 if (consent_result == UserConsentResult::UNAVAILABLE) {
2638 // User has not responded yet.
2639 uint64_t elapsed_ms = consent_callback_->getElapsedTimeMs();
2640 if (elapsed_ms < USER_CONSENT_TIMEOUT_MS) {
2641 uint delay_seconds = (USER_CONSENT_TIMEOUT_MS - elapsed_ms) / 1000;
2642 MYLOGD("Did not receive user consent yet; going to wait for %d seconds", delay_seconds);
2643 sleep(delay_seconds);
2644 }
2645 consent_result = consent_callback_->getResult();
2646 }
2647 if (consent_result == UserConsentResult::DENIED) {
2648 // User has explicitly denied sharing with the app. To be safe delete the
2649 // internal bugreport & tmp files.
2650 return HandleUserConsentDenied();
2651 }
2652 if (consent_result == UserConsentResult::APPROVED) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00002653 bool copy_succeeded = android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
2654 if (copy_succeeded) {
2655 android::os::UnlinkAndLogOnError(path_);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002656 }
2657 return copy_succeeded ? Dumpstate::RunStatus::OK : Dumpstate::RunStatus::ERROR;
2658 } else if (consent_result == UserConsentResult::UNAVAILABLE) {
2659 // consent_result is still UNAVAILABLE. The user has likely not responded yet.
2660 // Since we do not have user consent to share the bugreport it does not get
2661 // copied over to the calling app but remains in the internal directory from
2662 // where the user can manually pull it.
2663 return Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT;
2664 }
2665 // Unknown result; must be a programming error.
2666 MYLOGE("Unknown user consent result:%d\n", consent_result);
2667 return Dumpstate::RunStatus::ERROR;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002668}
2669
Nandana Duttf02564e2019-02-15 15:24:24 +00002670Dumpstate::RunStatus Dumpstate::ParseCommandlineAndRun(int argc, char* argv[]) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002671 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
2672 Dumpstate::RunStatus status = options->Initialize(argc, argv);
2673 if (status == Dumpstate::RunStatus::OK) {
Nandana Duttf02564e2019-02-15 15:24:24 +00002674 SetOptions(std::move(options));
Nandana Duttd2f5f082019-01-18 17:13:52 +00002675 // When directly running dumpstate binary, the output is not expected to be written
2676 // to any external file descriptor.
Nandana Duttf02564e2019-02-15 15:24:24 +00002677 assert(options_->bugreport_fd.get() == -1);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002678
2679 // calling_uid and calling_package are for user consent to share the bugreport with
2680 // an app; they are irrelvant here because bugreport is only written to a local
2681 // directory, and not shared.
Nandana Duttf02564e2019-02-15 15:24:24 +00002682 status = Run(-1 /* calling_uid */, "" /* calling_package */);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002683 }
Nandana Duttf02564e2019-02-15 15:24:24 +00002684 return status;
2685}
2686
2687/* Main entry point for dumpstate binary. */
2688int run_main(int argc, char* argv[]) {
2689 Dumpstate::RunStatus status = ds.ParseCommandlineAndRun(argc, argv);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002690
2691 switch (status) {
2692 case Dumpstate::RunStatus::OK:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002693 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002694 case Dumpstate::RunStatus::HELP:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002695 ShowUsage();
2696 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002697 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002698 fprintf(stderr, "Invalid combination of args\n");
2699 ShowUsage();
2700 exit(1);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002701 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002702 FALLTHROUGH_INTENDED;
2703 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2704 FALLTHROUGH_INTENDED;
2705 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002706 exit(2);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002707 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002708}
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002709
2710// TODO(111441001): Default DumpOptions to sensible values.
2711Dumpstate::Dumpstate(const std::string& version)
2712 : pid_(getpid()),
2713 options_(new Dumpstate::DumpOptions()),
Nandana Dutt402a8392019-06-14 14:25:13 +01002714 last_reported_percent_progress_(0),
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002715 version_(version),
2716 now_(time(nullptr)) {
2717}
2718
2719Dumpstate& Dumpstate::GetInstance() {
2720 static Dumpstate singleton_(android::base::GetProperty("dumpstate.version", VERSION_CURRENT));
2721 return singleton_;
2722}
2723
Nandana Dutt8d945c02019-08-14 13:30:07 +01002724DurationReporter::DurationReporter(const std::string& title, bool logcat_only, bool verbose)
2725 : title_(title), logcat_only_(logcat_only), verbose_(verbose) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002726 if (!title_.empty()) {
2727 started_ = Nanotime();
2728 }
2729}
2730
2731DurationReporter::~DurationReporter() {
2732 if (!title_.empty()) {
2733 float elapsed = (float)(Nanotime() - started_) / NANOS_PER_SEC;
chenqiwuaf8b2d92019-12-12 18:53:51 +08002734 if (elapsed >= .5f || verbose_) {
2735 MYLOGD("Duration of '%s': %.2fs\n", title_.c_str(), elapsed);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002736 }
chenqiwuaf8b2d92019-12-12 18:53:51 +08002737 if (!logcat_only_) {
2738 // Use "Yoda grammar" to make it easier to grep|sort sections.
2739 printf("------ %.3fs was the duration of '%s' ------\n", elapsed, title_.c_str());
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002740 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002741 }
2742}
2743
2744const int32_t Progress::kDefaultMax = 5000;
2745
2746Progress::Progress(const std::string& path) : Progress(Progress::kDefaultMax, 1.1, path) {
2747}
2748
2749Progress::Progress(int32_t initial_max, int32_t progress, float growth_factor)
2750 : Progress(initial_max, growth_factor, "") {
2751 progress_ = progress;
2752}
2753
2754Progress::Progress(int32_t initial_max, float growth_factor, const std::string& path)
2755 : initial_max_(initial_max),
2756 progress_(0),
2757 max_(initial_max),
2758 growth_factor_(growth_factor),
2759 n_runs_(0),
2760 average_max_(0),
2761 path_(path) {
2762 if (!path_.empty()) {
2763 Load();
2764 }
2765}
2766
2767void Progress::Load() {
2768 MYLOGD("Loading stats from %s\n", path_.c_str());
2769 std::string content;
2770 if (!android::base::ReadFileToString(path_, &content)) {
2771 MYLOGI("Could not read stats from %s; using max of %d\n", path_.c_str(), max_);
2772 return;
2773 }
2774 if (content.empty()) {
2775 MYLOGE("No stats (empty file) on %s; using max of %d\n", path_.c_str(), max_);
2776 return;
2777 }
2778 std::vector<std::string> lines = android::base::Split(content, "\n");
2779
2780 if (lines.size() < 1) {
2781 MYLOGE("Invalid stats on file %s: not enough lines (%d). Using max of %d\n", path_.c_str(),
2782 (int)lines.size(), max_);
2783 return;
2784 }
2785 char* ptr;
2786 n_runs_ = strtol(lines[0].c_str(), &ptr, 10);
2787 average_max_ = strtol(ptr, nullptr, 10);
2788 if (n_runs_ <= 0 || average_max_ <= 0 || n_runs_ > STATS_MAX_N_RUNS ||
2789 average_max_ > STATS_MAX_AVERAGE) {
2790 MYLOGE("Invalid stats line on file %s: %s\n", path_.c_str(), lines[0].c_str());
2791 initial_max_ = Progress::kDefaultMax;
2792 } else {
2793 initial_max_ = average_max_;
2794 }
2795 max_ = initial_max_;
2796
2797 MYLOGI("Average max progress: %d in %d runs; estimated max: %d\n", average_max_, n_runs_, max_);
2798}
2799
2800void Progress::Save() {
2801 int32_t total = n_runs_ * average_max_ + progress_;
2802 int32_t runs = n_runs_ + 1;
2803 int32_t average = floor(((float)total) / runs);
2804 MYLOGI("Saving stats (total=%d, runs=%d, average=%d) on %s\n", total, runs, average,
2805 path_.c_str());
2806 if (path_.empty()) {
2807 return;
2808 }
2809
2810 std::string content = android::base::StringPrintf("%d %d\n", runs, average);
2811 if (!android::base::WriteStringToFile(content, path_)) {
2812 MYLOGE("Could not save stats on %s\n", path_.c_str());
2813 }
2814}
2815
2816int32_t Progress::Get() const {
2817 return progress_;
2818}
2819
2820bool Progress::Inc(int32_t delta_sec) {
2821 bool changed = false;
2822 if (delta_sec >= 0) {
2823 progress_ += delta_sec;
2824 if (progress_ > max_) {
2825 int32_t old_max = max_;
2826 max_ = floor((float)progress_ * growth_factor_);
2827 MYLOGD("Adjusting max progress from %d to %d\n", old_max, max_);
2828 changed = true;
2829 }
2830 }
2831 return changed;
2832}
2833
2834int32_t Progress::GetMax() const {
2835 return max_;
2836}
2837
2838int32_t Progress::GetInitialMax() const {
2839 return initial_max_;
2840}
2841
2842void Progress::Dump(int fd, const std::string& prefix) const {
2843 const char* pr = prefix.c_str();
2844 dprintf(fd, "%sprogress: %d\n", pr, progress_);
2845 dprintf(fd, "%smax: %d\n", pr, max_);
2846 dprintf(fd, "%sinitial_max: %d\n", pr, initial_max_);
2847 dprintf(fd, "%sgrowth_factor: %0.2f\n", pr, growth_factor_);
2848 dprintf(fd, "%spath: %s\n", pr, path_.c_str());
2849 dprintf(fd, "%sn_runs: %d\n", pr, n_runs_);
2850 dprintf(fd, "%saverage_max: %d\n", pr, average_max_);
2851}
2852
2853bool Dumpstate::IsZipping() const {
2854 return zip_writer_ != nullptr;
2855}
2856
2857std::string Dumpstate::GetPath(const std::string& suffix) const {
2858 return GetPath(bugreport_internal_dir_, suffix);
2859}
2860
2861std::string Dumpstate::GetPath(const std::string& directory, const std::string& suffix) const {
2862 return android::base::StringPrintf("%s/%s-%s%s", directory.c_str(), base_name_.c_str(),
2863 name_.c_str(), suffix.c_str());
2864}
2865
2866void Dumpstate::SetProgress(std::unique_ptr<Progress> progress) {
2867 progress_ = std::move(progress);
2868}
2869
2870void for_each_userid(void (*func)(int), const char *header) {
2871 std::string title = header == nullptr ? "for_each_userid" : android::base::StringPrintf(
2872 "for_each_userid(%s)", header);
2873 DurationReporter duration_reporter(title);
2874 if (PropertiesHelper::IsDryRun()) return;
2875
2876 DIR *d;
2877 struct dirent *de;
2878
2879 if (header) printf("\n------ %s ------\n", header);
2880 func(0);
2881
2882 if (!(d = opendir("/data/system/users"))) {
2883 printf("Failed to open /data/system/users (%s)\n", strerror(errno));
2884 return;
2885 }
2886
2887 while ((de = readdir(d))) {
2888 int userid;
2889 if (de->d_type != DT_DIR || !(userid = atoi(de->d_name))) {
2890 continue;
2891 }
2892 func(userid);
2893 }
2894
2895 closedir(d);
2896}
2897
2898static void __for_each_pid(void (*helper)(int, const char *, void *), const char *header, void *arg) {
2899 DIR *d;
2900 struct dirent *de;
2901
2902 if (!(d = opendir("/proc"))) {
2903 printf("Failed to open /proc (%s)\n", strerror(errno));
2904 return;
2905 }
2906
2907 if (header) printf("\n------ %s ------\n", header);
2908 while ((de = readdir(d))) {
2909 if (ds.IsUserConsentDenied()) {
2910 MYLOGE(
2911 "Returning early because user denied consent to share bugreport with calling app.");
2912 closedir(d);
2913 return;
2914 }
2915 int pid;
2916 int fd;
2917 char cmdpath[255];
2918 char cmdline[255];
2919
2920 if (!(pid = atoi(de->d_name))) {
2921 continue;
2922 }
2923
2924 memset(cmdline, 0, sizeof(cmdline));
2925
2926 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/cmdline", pid);
2927 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
2928 TEMP_FAILURE_RETRY(read(fd, cmdline, sizeof(cmdline) - 2));
2929 close(fd);
2930 if (cmdline[0]) {
2931 helper(pid, cmdline, arg);
2932 continue;
2933 }
2934 }
2935
2936 // if no cmdline, a kernel thread has comm
2937 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/comm", pid);
2938 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
2939 TEMP_FAILURE_RETRY(read(fd, cmdline + 1, sizeof(cmdline) - 4));
2940 close(fd);
2941 if (cmdline[1]) {
2942 cmdline[0] = '[';
2943 size_t len = strcspn(cmdline, "\f\b\r\n");
2944 cmdline[len] = ']';
2945 cmdline[len+1] = '\0';
2946 }
2947 }
2948 if (!cmdline[0]) {
2949 strcpy(cmdline, "N/A");
2950 }
2951 helper(pid, cmdline, arg);
2952 }
2953
2954 closedir(d);
2955}
2956
2957static void for_each_pid_helper(int pid, const char *cmdline, void *arg) {
2958 for_each_pid_func *func = (for_each_pid_func*) arg;
2959 func(pid, cmdline);
2960}
2961
2962void for_each_pid(for_each_pid_func func, const char *header) {
2963 std::string title = header == nullptr ? "for_each_pid"
2964 : android::base::StringPrintf("for_each_pid(%s)", header);
2965 DurationReporter duration_reporter(title);
2966 if (PropertiesHelper::IsDryRun()) return;
2967
2968 __for_each_pid(for_each_pid_helper, header, (void *) func);
2969}
2970
2971static void for_each_tid_helper(int pid, const char *cmdline, void *arg) {
2972 DIR *d;
2973 struct dirent *de;
2974 char taskpath[255];
2975 for_each_tid_func *func = (for_each_tid_func *) arg;
2976
2977 snprintf(taskpath, sizeof(taskpath), "/proc/%d/task", pid);
2978
2979 if (!(d = opendir(taskpath))) {
2980 printf("Failed to open %s (%s)\n", taskpath, strerror(errno));
2981 return;
2982 }
2983
2984 func(pid, pid, cmdline);
2985
2986 while ((de = readdir(d))) {
2987 if (ds.IsUserConsentDenied()) {
2988 MYLOGE(
2989 "Returning early because user denied consent to share bugreport with calling app.");
2990 closedir(d);
2991 return;
2992 }
2993 int tid;
2994 int fd;
2995 char commpath[255];
2996 char comm[255];
2997
2998 if (!(tid = atoi(de->d_name))) {
2999 continue;
3000 }
3001
3002 if (tid == pid)
3003 continue;
3004
3005 snprintf(commpath, sizeof(commpath), "/proc/%d/comm", tid);
3006 memset(comm, 0, sizeof(comm));
3007 if ((fd = TEMP_FAILURE_RETRY(open(commpath, O_RDONLY | O_CLOEXEC))) < 0) {
3008 strcpy(comm, "N/A");
3009 } else {
3010 char *c;
3011 TEMP_FAILURE_RETRY(read(fd, comm, sizeof(comm) - 2));
3012 close(fd);
3013
3014 c = strrchr(comm, '\n');
3015 if (c) {
3016 *c = '\0';
3017 }
3018 }
3019 func(pid, tid, comm);
3020 }
3021
3022 closedir(d);
3023}
3024
3025void for_each_tid(for_each_tid_func func, const char *header) {
3026 std::string title = header == nullptr ? "for_each_tid"
3027 : android::base::StringPrintf("for_each_tid(%s)", header);
3028 DurationReporter duration_reporter(title);
3029
3030 if (PropertiesHelper::IsDryRun()) return;
3031
3032 __for_each_pid(for_each_tid_helper, header, (void *) func);
3033}
3034
3035void show_wchan(int pid, int tid, const char *name) {
3036 if (PropertiesHelper::IsDryRun()) return;
3037
3038 char path[255];
3039 char buffer[255];
3040 int fd, ret, save_errno;
3041 char name_buffer[255];
3042
3043 memset(buffer, 0, sizeof(buffer));
3044
3045 snprintf(path, sizeof(path), "/proc/%d/wchan", tid);
3046 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3047 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3048 return;
3049 }
3050
3051 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3052 save_errno = errno;
3053 close(fd);
3054
3055 if (ret < 0) {
3056 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3057 return;
3058 }
3059
3060 snprintf(name_buffer, sizeof(name_buffer), "%*s%s",
3061 pid == tid ? 0 : 3, "", name);
3062
3063 printf("%-7d %-32s %s\n", tid, name_buffer, buffer);
3064
3065 return;
3066}
3067
3068// print time in centiseconds
3069static void snprcent(char *buffer, size_t len, size_t spc,
3070 unsigned long long time) {
3071 static long hz; // cache discovered hz
3072
3073 if (hz <= 0) {
3074 hz = sysconf(_SC_CLK_TCK);
3075 if (hz <= 0) {
3076 hz = 1000;
3077 }
3078 }
3079
3080 // convert to centiseconds
3081 time = (time * 100 + (hz / 2)) / hz;
3082
3083 char str[16];
3084
3085 snprintf(str, sizeof(str), " %llu.%02u",
3086 time / 100, (unsigned)(time % 100));
3087 size_t offset = strlen(buffer);
3088 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3089 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3090}
3091
3092// print permille as a percent
3093static void snprdec(char *buffer, size_t len, size_t spc, unsigned permille) {
3094 char str[16];
3095
3096 snprintf(str, sizeof(str), " %u.%u%%", permille / 10, permille % 10);
3097 size_t offset = strlen(buffer);
3098 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3099 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3100}
3101
3102void show_showtime(int pid, const char *name) {
3103 if (PropertiesHelper::IsDryRun()) return;
3104
3105 char path[255];
3106 char buffer[1023];
3107 int fd, ret, save_errno;
3108
3109 memset(buffer, 0, sizeof(buffer));
3110
3111 snprintf(path, sizeof(path), "/proc/%d/stat", pid);
3112 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3113 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3114 return;
3115 }
3116
3117 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3118 save_errno = errno;
3119 close(fd);
3120
3121 if (ret < 0) {
3122 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3123 return;
3124 }
3125
3126 // field 14 is utime
3127 // field 15 is stime
3128 // field 42 is iotime
3129 unsigned long long utime = 0, stime = 0, iotime = 0;
3130 if (sscanf(buffer,
3131 "%*u %*s %*s %*d %*d %*d %*d %*d %*d %*d %*d "
3132 "%*d %*d %llu %llu %*d %*d %*d %*d %*d %*d "
3133 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %*d "
3134 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %llu ",
3135 &utime, &stime, &iotime) != 3) {
3136 return;
3137 }
3138
3139 unsigned long long total = utime + stime;
3140 if (!total) {
3141 return;
3142 }
3143
3144 unsigned permille = (iotime * 1000 + (total / 2)) / total;
3145 if (permille > 1000) {
3146 permille = 1000;
3147 }
3148
3149 // try to beautify and stabilize columns at <80 characters
3150 snprintf(buffer, sizeof(buffer), "%-6d%s", pid, name);
3151 if ((name[0] != '[') || utime) {
3152 snprcent(buffer, sizeof(buffer), 57, utime);
3153 }
3154 snprcent(buffer, sizeof(buffer), 65, stime);
3155 if ((name[0] != '[') || iotime) {
3156 snprcent(buffer, sizeof(buffer), 73, iotime);
3157 }
3158 if (iotime) {
3159 snprdec(buffer, sizeof(buffer), 79, permille);
3160 }
3161 puts(buffer); // adds a trailing newline
3162
3163 return;
3164}
3165
3166void do_dmesg() {
3167 const char *title = "KERNEL LOG (dmesg)";
3168 DurationReporter duration_reporter(title);
3169 printf("------ %s ------\n", title);
3170
3171 if (PropertiesHelper::IsDryRun()) return;
3172
3173 /* Get size of kernel buffer */
3174 int size = klogctl(KLOG_SIZE_BUFFER, nullptr, 0);
3175 if (size <= 0) {
3176 printf("Unexpected klogctl return value: %d\n\n", size);
3177 return;
3178 }
3179 char *buf = (char *) malloc(size + 1);
3180 if (buf == nullptr) {
3181 printf("memory allocation failed\n\n");
3182 return;
3183 }
3184 int retval = klogctl(KLOG_READ_ALL, buf, size);
3185 if (retval < 0) {
3186 printf("klogctl failure\n\n");
3187 free(buf);
3188 return;
3189 }
3190 buf[retval] = '\0';
3191 printf("%s\n\n", buf);
3192 free(buf);
3193 return;
3194}
3195
3196void do_showmap(int pid, const char *name) {
3197 char title[255];
3198 char arg[255];
3199
3200 snprintf(title, sizeof(title), "SHOW MAP %d (%s)", pid, name);
3201 snprintf(arg, sizeof(arg), "%d", pid);
3202 RunCommand(title, {"showmap", "-q", arg}, CommandOptions::AS_ROOT);
3203}
3204
3205int Dumpstate::DumpFile(const std::string& title, const std::string& path) {
3206 DurationReporter duration_reporter(title);
3207
3208 int status = DumpFileToFd(STDOUT_FILENO, title, path);
3209
3210 UpdateProgress(WEIGHT_FILE);
3211
3212 return status;
3213}
3214
3215int read_file_as_long(const char *path, long int *output) {
3216 int fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC));
3217 if (fd < 0) {
3218 int err = errno;
3219 MYLOGE("Error opening file descriptor for %s: %s\n", path, strerror(err));
3220 return -1;
3221 }
3222 char buffer[50];
3223 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3224 if (bytes_read == -1) {
3225 MYLOGE("Error reading file %s: %s\n", path, strerror(errno));
3226 return -2;
3227 }
3228 if (bytes_read == 0) {
3229 MYLOGE("File %s is empty\n", path);
3230 return -3;
3231 }
3232 *output = atoi(buffer);
3233 return 0;
3234}
3235
3236/* calls skip to gate calling dump_from_fd recursively
3237 * in the specified directory. dump_from_fd defaults to
3238 * dump_file_from_fd above when set to NULL. skip defaults
3239 * to false when set to NULL. dump_from_fd will always be
3240 * called with title NULL.
3241 */
3242int dump_files(const std::string& title, const char* dir, bool (*skip)(const char* path),
3243 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
3244 DurationReporter duration_reporter(title);
3245 DIR *dirp;
3246 struct dirent *d;
3247 char *newpath = nullptr;
3248 const char *slash = "/";
3249 int retval = 0;
3250
3251 if (!title.empty()) {
3252 printf("------ %s (%s) ------\n", title.c_str(), dir);
3253 }
3254 if (PropertiesHelper::IsDryRun()) return 0;
3255
3256 if (dir[strlen(dir) - 1] == '/') {
3257 ++slash;
3258 }
3259 dirp = opendir(dir);
3260 if (dirp == nullptr) {
3261 retval = -errno;
3262 MYLOGE("%s: %s\n", dir, strerror(errno));
3263 return retval;
3264 }
3265
3266 if (!dump_from_fd) {
3267 dump_from_fd = dump_file_from_fd;
3268 }
3269 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
3270 if ((d->d_name[0] == '.')
3271 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
3272 || (d->d_name[1] == '\0'))) {
3273 continue;
3274 }
3275 asprintf(&newpath, "%s%s%s%s", dir, slash, d->d_name,
3276 (d->d_type == DT_DIR) ? "/" : "");
3277 if (!newpath) {
3278 retval = -errno;
3279 continue;
3280 }
3281 if (skip && (*skip)(newpath)) {
3282 continue;
3283 }
3284 if (d->d_type == DT_DIR) {
3285 int ret = dump_files("", newpath, skip, dump_from_fd);
3286 if (ret < 0) {
3287 retval = ret;
3288 }
3289 continue;
3290 }
3291 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(newpath, O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
3292 if (fd.get() < 0) {
3293 retval = -1;
3294 printf("*** %s: %s\n", newpath, strerror(errno));
3295 continue;
3296 }
3297 (*dump_from_fd)(nullptr, newpath, fd.get());
3298 }
3299 closedir(dirp);
3300 if (!title.empty()) {
3301 printf("\n");
3302 }
3303 return retval;
3304}
3305
3306/* fd must have been opened with the flag O_NONBLOCK. With this flag set,
3307 * it's possible to avoid issues where opening the file itself can get
3308 * stuck.
3309 */
3310int dump_file_from_fd(const char *title, const char *path, int fd) {
3311 if (PropertiesHelper::IsDryRun()) return 0;
3312
3313 int flags = fcntl(fd, F_GETFL);
3314 if (flags == -1) {
3315 printf("*** %s: failed to get flags on fd %d: %s\n", path, fd, strerror(errno));
3316 return -1;
3317 } else if (!(flags & O_NONBLOCK)) {
3318 printf("*** %s: fd must have O_NONBLOCK set.\n", path);
3319 return -1;
3320 }
3321 return DumpFileFromFdToFd(title, path, fd, STDOUT_FILENO, PropertiesHelper::IsDryRun());
3322}
3323
3324int Dumpstate::RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Nandana Dutt8d945c02019-08-14 13:30:07 +01003325 const CommandOptions& options, bool verbose_duration) {
3326 DurationReporter duration_reporter(title, false /* logcat_only */, verbose_duration);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003327
3328 int status = RunCommandToFd(STDOUT_FILENO, title, full_command, options);
3329
3330 /* TODO: for now we're simplifying the progress calculation by using the
3331 * timeout as the weight. It's a good approximation for most cases, except when calling dumpsys,
3332 * where its weight should be much higher proportionally to its timeout.
3333 * Ideally, it should use a options.EstimatedDuration() instead...*/
3334 UpdateProgress(options.Timeout());
3335
3336 return status;
3337}
3338
3339void Dumpstate::RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsys_args,
3340 const CommandOptions& options, long dumpsysTimeoutMs) {
3341 long timeout_ms = dumpsysTimeoutMs > 0 ? dumpsysTimeoutMs : options.TimeoutInMs();
3342 std::vector<std::string> dumpsys = {"/system/bin/dumpsys", "-T", std::to_string(timeout_ms)};
3343 dumpsys.insert(dumpsys.end(), dumpsys_args.begin(), dumpsys_args.end());
3344 RunCommand(title, dumpsys, options);
3345}
3346
3347int open_socket(const char *service) {
3348 int s = android_get_control_socket(service);
3349 if (s < 0) {
3350 MYLOGE("android_get_control_socket(%s): %s\n", service, strerror(errno));
3351 return -1;
3352 }
3353 fcntl(s, F_SETFD, FD_CLOEXEC);
3354
3355 // Set backlog to 0 to make sure that queue size will be minimum.
3356 // In Linux, because the minimum queue will be 1, connect() will be blocked
3357 // if the other clients already called connect() and the connection request was not accepted.
3358 if (listen(s, 0) < 0) {
3359 MYLOGE("listen(control socket): %s\n", strerror(errno));
3360 return -1;
3361 }
3362
3363 struct sockaddr addr;
3364 socklen_t alen = sizeof(addr);
Abhijeet Kaur2113cae2019-09-13 09:24:15 +01003365 int fd = accept4(s, &addr, &alen, SOCK_CLOEXEC);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003366
3367 // Close socket just after accept(), to make sure that connect() by client will get error
3368 // when the socket is used by the other services.
3369 // There is still a race condition possibility between accept and close, but there is no way
3370 // to close-on-accept atomically.
3371 // See detail; b/123306389#comment25
3372 close(s);
3373
3374 if (fd < 0) {
3375 MYLOGE("accept(control socket): %s\n", strerror(errno));
3376 return -1;
3377 }
3378
3379 return fd;
3380}
3381
3382/* redirect output to a service control socket */
3383bool redirect_to_socket(FILE* redirect, const char* service) {
3384 int fd = open_socket(service);
3385 if (fd == -1) {
3386 return false;
3387 }
3388 fflush(redirect);
3389 // TODO: handle dup2 failure
3390 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
3391 close(fd);
3392 return true;
3393}
3394
3395// TODO: should call is_valid_output_file and/or be merged into it.
3396void create_parent_dirs(const char *path) {
3397 char *chp = const_cast<char *> (path);
3398
3399 /* skip initial slash */
3400 if (chp[0] == '/')
3401 chp++;
3402
3403 /* create leading directories, if necessary */
3404 struct stat dir_stat;
3405 while (chp && chp[0]) {
3406 chp = strchr(chp, '/');
3407 if (chp) {
3408 *chp = 0;
3409 if (stat(path, &dir_stat) == -1 || !S_ISDIR(dir_stat.st_mode)) {
3410 MYLOGI("Creating directory %s\n", path);
3411 if (mkdir(path, 0770)) { /* drwxrwx--- */
3412 MYLOGE("Unable to create directory %s: %s\n", path, strerror(errno));
3413 } else if (chown(path, AID_SHELL, AID_SHELL)) {
3414 MYLOGE("Unable to change ownership of dir %s: %s\n", path, strerror(errno));
3415 }
3416 }
3417 *chp++ = '/';
3418 }
3419 }
3420}
3421
3422bool _redirect_to_file(FILE* redirect, char* path, int truncate_flag) {
3423 create_parent_dirs(path);
3424
3425 int fd = TEMP_FAILURE_RETRY(open(path,
3426 O_WRONLY | O_CREAT | truncate_flag | O_CLOEXEC | O_NOFOLLOW,
3427 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH));
3428 if (fd < 0) {
3429 MYLOGE("%s: %s\n", path, strerror(errno));
3430 return false;
3431 }
3432
3433 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
3434 close(fd);
3435 return true;
3436}
3437
3438bool redirect_to_file(FILE* redirect, char* path) {
3439 return _redirect_to_file(redirect, path, O_TRUNC);
3440}
3441
3442bool redirect_to_existing_file(FILE* redirect, char* path) {
3443 return _redirect_to_file(redirect, path, O_APPEND);
3444}
3445
3446void dump_route_tables() {
3447 DurationReporter duration_reporter("DUMP ROUTE TABLES");
3448 if (PropertiesHelper::IsDryRun()) return;
3449 const char* const RT_TABLES_PATH = "/data/misc/net/rt_tables";
3450 ds.DumpFile("RT_TABLES", RT_TABLES_PATH);
3451 FILE* fp = fopen(RT_TABLES_PATH, "re");
3452 if (!fp) {
3453 printf("*** %s: %s\n", RT_TABLES_PATH, strerror(errno));
3454 return;
3455 }
3456 char table[16];
3457 // Each line has an integer (the table number), a space, and a string (the table name). We only
3458 // need the table number. It's a 32-bit unsigned number, so max 10 chars. Skip the table name.
3459 // Add a fixed max limit so this doesn't go awry.
3460 for (int i = 0; i < 64 && fscanf(fp, " %10s %*s", table) == 1; ++i) {
3461 RunCommand("ROUTE TABLE IPv4", {"ip", "-4", "route", "show", "table", table});
3462 RunCommand("ROUTE TABLE IPv6", {"ip", "-6", "route", "show", "table", table});
3463 }
3464 fclose(fp);
3465}
3466
3467// TODO: make this function thread safe if sections are generated in parallel.
3468void Dumpstate::UpdateProgress(int32_t delta_sec) {
3469 if (progress_ == nullptr) {
3470 MYLOGE("UpdateProgress: progress_ not set\n");
3471 return;
3472 }
3473
3474 // Always update progess so stats can be tuned...
Nandana Dutt402a8392019-06-14 14:25:13 +01003475 progress_->Inc(delta_sec);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003476
3477 // ...but only notifiy listeners when necessary.
3478 if (!options_->do_progress_updates) return;
3479
3480 int progress = progress_->Get();
3481 int max = progress_->GetMax();
Nandana Dutt402a8392019-06-14 14:25:13 +01003482 int percent = 100 * progress / max;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003483
Nandana Dutt402a8392019-06-14 14:25:13 +01003484 if (last_reported_percent_progress_ > 0 && percent <= last_reported_percent_progress_) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003485 return;
3486 }
Nandana Dutt402a8392019-06-14 14:25:13 +01003487 last_reported_percent_progress_ = percent;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003488
3489 if (control_socket_fd_ >= 0) {
3490 dprintf(control_socket_fd_, "PROGRESS:%d/%d\n", progress, max);
3491 fsync(control_socket_fd_);
3492 }
3493
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003494 if (listener_ != nullptr) {
Nandana Dutt235c6672019-11-14 15:22:32 +00003495 if (percent % 10 == 0) {
3496 // We don't want to spam logcat, so only log multiples of 10.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01003497 MYLOGD("Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003498 } else {
3499 // stderr is ignored on normal invocations, but useful when calling
3500 // /system/bin/dumpstate directly for debuggging.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01003501 fprintf(stderr, "Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003502 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003503
3504 listener_->onProgress(percent);
3505 }
3506}
3507
3508void Dumpstate::TakeScreenshot(const std::string& path) {
3509 const std::string& real_path = path.empty() ? screenshot_path_ : path;
3510 int status =
3511 RunCommand("", {"/system/bin/screencap", "-p", real_path},
3512 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3513 if (status == 0) {
3514 MYLOGD("Screenshot saved on %s\n", real_path.c_str());
3515 } else {
3516 MYLOGE("Failed to take screenshot on %s\n", real_path.c_str());
3517 }
3518}
3519
3520bool is_dir(const char* pathname) {
3521 struct stat info;
3522 if (stat(pathname, &info) == -1) {
3523 return false;
3524 }
3525 return S_ISDIR(info.st_mode);
3526}
3527
3528time_t get_mtime(int fd, time_t default_mtime) {
3529 struct stat info;
3530 if (fstat(fd, &info) == -1) {
3531 return default_mtime;
3532 }
3533 return info.st_mtime;
3534}