blob: 84de9f359607c51cd02c8e3e78dd2586852b364c [file] [log] [blame]
Colin Crossf45fa6b2012-03-26 12:38:26 -07001/*
2 * Copyright (C) 2008 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
Felipe Lemef0292972016-11-22 13:57:05 -080016
Mark Salyzyn6c3d90f2016-09-27 14:55:27 -070017#define LOG_TAG "dumpstate"
Colin Crossf45fa6b2012-03-26 12:38:26 -070018
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -070019#include <dirent.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070020#include <errno.h>
21#include <fcntl.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010022#include <inttypes.h>
Felipe Lemead5f6c42015-11-30 14:26:46 -080023#include <libgen.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070024#include <limits.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010025#include <math.h>
26#include <poll.h>
Mark Salyzyn8f37aa52015-06-12 12:28:24 -070027#include <stdbool.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070028#include <stdio.h>
29#include <stdlib.h>
30#include <string.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080031#include <sys/poll.h>
Christopher Ferris7dc7f322014-07-22 16:08:19 -070032#include <sys/prctl.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070033#include <sys/resource.h>
34#include <sys/stat.h>
35#include <sys/time.h>
36#include <sys/wait.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010037#include <signal.h>
38#include <stdarg.h>
39#include <string.h>
40#include <sys/capability.h>
41#include <sys/inotify.h>
42#include <sys/klog.h>
43#include <time.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070044#include <unistd.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070045
46#include <chrono>
Hridya Valsarajuac582cd2019-08-05 15:39:54 -070047#include <cmath>
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +000048#include <fstream>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070049#include <functional>
50#include <future>
Narayan Kamath8f788292017-05-25 13:20:39 +010051#include <memory>
Hridya Valsarajuac582cd2019-08-05 15:39:54 -070052#include <numeric>
Narayan Kamath8f788292017-05-25 13:20:39 +010053#include <regex>
54#include <set>
55#include <string>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070056#include <utility>
Narayan Kamath8f788292017-05-25 13:20:39 +010057#include <vector>
Colin Crossf45fa6b2012-03-26 12:38:26 -070058
Felipe Leme96c2bbb2016-09-26 09:21:21 -070059#include <android-base/file.h>
60#include <android-base/properties.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070061#include <android-base/scopeguard.h>
Elliott Hughes9dc117c2015-12-07 14:21:50 -080062#include <android-base/stringprintf.h>
Naveen Kalla058e1e82016-10-19 21:38:44 -070063#include <android-base/strings.h>
Andreas Gampeaff68432016-07-18 18:01:27 -070064#include <android-base/unique_fd.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010065#include <android/content/pm/IPackageManagerNative.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080066#include <android/hardware/dumpstate/1.0/IDumpstateDevice.h>
Hunter Knepshield8540faf2020-02-04 19:47:20 -080067#include <android/hardware/dumpstate/1.1/IDumpstateDevice.h>
68#include <android/hardware/dumpstate/1.1/types.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080069#include <android/hidl/manager/1.0/IServiceManager.h>
Nandana Duttd2f5f082019-01-18 17:13:52 +000070#include <android/os/IIncidentCompanion.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010071#include <binder/IServiceManager.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080072#include <cutils/native_handle.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070073#include <cutils/properties.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010074#include <cutils/sockets.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000075#include <debuggerd/client.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080076#include <dumpsys.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000077#include <dumputils/dump_utils.h>
Sahana Raof35ed432019-07-12 10:47:52 +010078#include <hardware_legacy/power.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080079#include <hidl/ServiceManagement.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010080#include <log/log.h>
Tom Cherryf4472f32020-08-05 09:31:17 -070081#include <log/log_read.h>
Felipe Leme75876a22016-10-27 16:31:27 -070082#include <openssl/sha.h>
Mark Salyzyn6c3d90f2016-09-27 14:55:27 -070083#include <private/android_filesystem_config.h>
84#include <private/android_logger.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080085#include <serviceutils/PriorityDumper.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070086#include <utils/StrongPointer.h>
Felipe Lemef0292972016-11-22 13:57:05 -080087#include "DumpstateInternal.h"
Felipe Leme75876a22016-10-27 16:31:27 -070088#include "DumpstateService.h"
Colin Crossf45fa6b2012-03-26 12:38:26 -070089#include "dumpstate.h"
Felipe Leme6e01fa62015-11-11 19:35:14 -080090
Hunter Knepshield8540faf2020-02-04 19:47:20 -080091using IDumpstateDevice_1_0 = ::android::hardware::dumpstate::V1_0::IDumpstateDevice;
92using IDumpstateDevice_1_1 = ::android::hardware::dumpstate::V1_1::IDumpstateDevice;
93using ::android::hardware::dumpstate::V1_1::DumpstateMode;
94using ::android::hardware::dumpstate::V1_1::DumpstateStatus;
95using ::android::hardware::dumpstate::V1_1::toString;
Vishnu Naire97d6122018-01-18 13:58:56 -080096using ::std::literals::chrono_literals::operator""ms;
97using ::std::literals::chrono_literals::operator""s;
Steven Morelandcb7ef822016-11-29 13:20:37 -080098
Felipe Leme47e9be22016-12-21 15:37:07 -080099// TODO: remove once moved to namespace
Vishnu Naire97d6122018-01-18 13:58:56 -0800100using android::defaultServiceManager;
101using android::Dumpsys;
102using android::INVALID_OPERATION;
103using android::IServiceManager;
104using android::OK;
105using android::sp;
106using android::status_t;
107using android::String16;
108using android::String8;
109using android::TIMED_OUT;
110using android::UNKNOWN_ERROR;
111using android::Vector;
Nandana Dutt979388e2018-11-30 16:48:55 +0000112using android::base::StringPrintf;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000113using android::os::IDumpstateListener;
Felipe Leme47e9be22016-12-21 15:37:07 -0800114using android::os::dumpstate::CommandOptions;
115using android::os::dumpstate::DumpFileToFd;
Vishnu Naire97d6122018-01-18 13:58:56 -0800116using android::os::dumpstate::PropertiesHelper;
Felipe Leme47e9be22016-12-21 15:37:07 -0800117
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100118// Keep in sync with
119// frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
120static const int TRACE_DUMP_TIMEOUT_MS = 10000; // 10 seconds
121
122/* Most simple commands have 10 as timeout, so 5 is a good estimate */
123static const int32_t WEIGHT_FILE = 5;
124
125// TODO: temporary variables and functions used during C++ refactoring
126static Dumpstate& ds = Dumpstate::GetInstance();
127static int RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Nandana Dutt8d945c02019-08-14 13:30:07 +0100128 const CommandOptions& options = CommandOptions::DEFAULT,
129 bool verbose_duration = false) {
130 return ds.RunCommand(title, full_command, options, verbose_duration);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100131}
132
133// Reasonable value for max stats.
134static const int STATS_MAX_N_RUNS = 1000;
135static const long STATS_MAX_AVERAGE = 100000;
136
137CommandOptions Dumpstate::DEFAULT_DUMPSYS = CommandOptions::WithTimeout(30).Build();
138
Nandana Duttd2f5f082019-01-18 17:13:52 +0000139typedef Dumpstate::ConsentCallback::ConsentResult UserConsentResult;
140
Colin Crossf45fa6b2012-03-26 12:38:26 -0700141/* read before root is shed */
142static char cmdline_buf[16384] = "(unknown)";
Yi Kong19d5c002018-07-20 13:39:55 -0700143static const char *dump_traces_path = nullptr;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000144static const uint64_t USER_CONSENT_TIMEOUT_MS = 30 * 1000;
Hunter Knepshield70610fa2020-01-03 15:27:33 -0800145// Because telephony reports are significantly faster to collect (< 10 seconds vs. > 2 minutes),
146// it's often the case that they time out far too quickly for consent with such a hefty dialog for
147// the user to read. For telephony reports only, we increase the default timeout to 2 minutes to
148// roughly match full reports' durations.
149static const uint64_t TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS = 2 * 60 * 1000;
Colin Crossf45fa6b2012-03-26 12:38:26 -0700150
Felipe Leme1d486fe2016-10-14 18:06:47 -0700151// TODO: variables and functions below should be part of dumpstate object
152
Felipe Leme635ca312016-01-05 14:23:02 -0800153static std::set<std::string> mount_points;
154void add_mountinfo();
Felipe Leme78f2c862015-12-21 09:55:22 -0800155
Todd Poynor2a83daa2013-11-22 15:44:22 -0800156#define PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops"
Mark Salyzyn7d0a7622016-06-24 14:06:15 -0700157#define ALT_PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops-0"
Wei Wang509bb5d2017-06-09 14:42:12 -0700158#define BLK_DEV_SYS_DIR "/sys/block"
Todd Poynor2a83daa2013-11-22 15:44:22 -0800159
Felipe Lemee82a27d2016-01-05 13:35:44 -0800160#define RECOVERY_DIR "/cache/recovery"
Mark Salyzynd6ab0112016-03-25 12:56:39 -0700161#define RECOVERY_DATA_DIR "/data/misc/recovery"
Tianjie Xu75d53362018-04-11 16:42:28 -0700162#define UPDATE_ENGINE_LOG_DIR "/data/misc/update_engine_log"
Mark Salyzyn4d42dea2016-04-01 10:03:14 -0700163#define LOGPERSIST_DATA_DIR "/data/misc/logd"
Jerry Changa1df8a92020-01-02 16:03:39 +0800164#define PREREBOOT_DATA_DIR "/data/misc/prereboot"
David Brazdild2991962016-06-03 14:40:44 +0100165#define PROFILE_DATA_DIR_CUR "/data/misc/profiles/cur"
166#define PROFILE_DATA_DIR_REF "/data/misc/profiles/ref"
Benedict Wong8f9d8a42019-01-03 16:19:38 -0800167#define XFRM_STAT_PROC_FILE "/proc/net/xfrm_stat"
Erik Kline08165202016-05-30 11:55:44 +0900168#define WLUTIL "/vendor/xbin/wlutil"
Vishnu Nair36b4cdb2017-11-17 10:27:05 -0800169#define WMTRACE_DATA_DIR "/data/misc/wmtrace"
Yifan Hong3945e1b2019-10-29 12:59:23 -0700170#define OTA_METADATA_DIR "/metadata/ota"
Yifan Hong0efa7972020-02-03 16:45:02 -0800171#define SNAPSHOTCTL_LOG_DIR "/data/misc/snapshotctl_log"
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +0900172#define LINKERCONFIG_DIR "/linkerconfig"
Calin Juravle78a0d842020-04-28 15:31:12 -0700173#define PACKAGE_DEX_USE_LIST "/data/system/package-dex-usage.list"
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700174
Narayan Kamath8f788292017-05-25 13:20:39 +0100175// TODO(narayan): Since this information has to be kept in sync
176// with tombstoned, we should just put it in a common header.
177//
178// File: system/core/debuggerd/tombstoned/tombstoned.cpp
Narayan Kamathbd863722017-06-01 18:50:12 +0100179static const std::string TOMBSTONE_DIR = "/data/tombstones/";
180static const std::string TOMBSTONE_FILE_PREFIX = "tombstone_";
181static const std::string ANR_DIR = "/data/anr/";
182static const std::string ANR_FILE_PREFIX = "anr_";
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700183
Felipe Lemee844a9d2016-09-21 15:01:39 -0700184// TODO: temporary variables and functions used during C++ refactoring
Nandana Dutt979388e2018-11-30 16:48:55 +0000185
Nandana Dutt5c390032019-03-12 10:52:56 +0000186#define RETURN_IF_USER_DENIED_CONSENT() \
187 if (ds.IsUserConsentDenied()) { \
188 MYLOGE("Returning early as user denied consent to share bugreport with calling app."); \
189 return Dumpstate::RunStatus::USER_CONSENT_DENIED; \
190 }
191
192// Runs func_ptr, but checks user consent before and after running it. Returns USER_CONSENT_DENIED
193// if consent is found to be denied.
194#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(func_ptr, ...) \
195 RETURN_IF_USER_DENIED_CONSENT(); \
196 func_ptr(__VA_ARGS__); \
197 RETURN_IF_USER_DENIED_CONSENT();
198
Sahana Raof35ed432019-07-12 10:47:52 +0100199static const char* WAKE_LOCK_NAME = "dumpstate_wakelock";
200
Nandana Dutt979388e2018-11-30 16:48:55 +0000201namespace android {
202namespace os {
203namespace {
204
205static int Open(std::string path, int flags, mode_t mode = 0) {
206 int fd = TEMP_FAILURE_RETRY(open(path.c_str(), flags, mode));
207 if (fd == -1) {
208 MYLOGE("open(%s, %s)\n", path.c_str(), strerror(errno));
209 }
210 return fd;
211}
212
mhasank2d75c442020-06-11 15:05:25 -0700213static int OpenForWrite(std::string path) {
214 return Open(path, O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
215 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH);
216}
Nandana Dutt979388e2018-11-30 16:48:55 +0000217
218static int OpenForRead(std::string path) {
219 return Open(path, O_RDONLY | O_CLOEXEC | O_NOFOLLOW);
220}
221
222bool CopyFile(int in_fd, int out_fd) {
223 char buf[4096];
224 ssize_t byte_count;
225 while ((byte_count = TEMP_FAILURE_RETRY(read(in_fd, buf, sizeof(buf)))) > 0) {
226 if (!android::base::WriteFully(out_fd, buf, byte_count)) {
227 return false;
228 }
229 }
230 return (byte_count != -1);
231}
232
233static bool CopyFileToFd(const std::string& input_file, int out_fd) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000234 MYLOGD("Going to copy file (%s) to %d\n", input_file.c_str(), out_fd);
Nandana Dutt979388e2018-11-30 16:48:55 +0000235
236 // Obtain a handle to the source file.
237 android::base::unique_fd in_fd(OpenForRead(input_file));
238 if (out_fd != -1 && in_fd.get() != -1) {
239 if (CopyFile(in_fd.get(), out_fd)) {
240 return true;
241 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000242 MYLOGE("Failed to copy file: %s\n", strerror(errno));
Nandana Dutt979388e2018-11-30 16:48:55 +0000243 }
244 return false;
245}
246
Nandana Duttd2f5f082019-01-18 17:13:52 +0000247static bool UnlinkAndLogOnError(const std::string& file) {
Nandana Dutt8ae16e62020-03-27 10:20:22 +0000248 if (file.empty()) {
249 return false;
250 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000251 if (unlink(file.c_str())) {
252 MYLOGE("Failed to unlink file (%s): %s\n", file.c_str(), strerror(errno));
Nandana Duttd2f5f082019-01-18 17:13:52 +0000253 return false;
254 }
255 return true;
256}
Nandana Dutt979388e2018-11-30 16:48:55 +0000257
Nikita Ioffea325a572019-05-16 19:49:47 +0100258int64_t GetModuleMetadataVersion() {
259 auto binder = defaultServiceManager()->getService(android::String16("package_native"));
260 if (binder == nullptr) {
261 MYLOGE("Failed to retrieve package_native service");
262 return 0L;
263 }
264 auto package_service = android::interface_cast<content::pm::IPackageManagerNative>(binder);
265 std::string package_name;
266 auto status = package_service->getModuleMetadataPackageName(&package_name);
267 if (!status.isOk()) {
268 MYLOGE("Failed to retrieve module metadata package name: %s", status.toString8().c_str());
269 return 0L;
270 }
Nandana Duttdb379fa2019-10-09 16:54:41 +0100271 MYLOGD("Module metadata package name: %s\n", package_name.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100272 int64_t version_code;
273 status = package_service->getVersionCodeForPackage(android::String16(package_name.c_str()),
274 &version_code);
275 if (!status.isOk()) {
276 MYLOGE("Failed to retrieve module metadata version: %s", status.toString8().c_str());
277 return 0L;
278 }
279 return version_code;
280}
281
mhasank2d75c442020-06-11 15:05:25 -0700282static bool PathExists(const std::string& path) {
283 struct stat sb;
284 return stat(path.c_str(), &sb) == 0;
285}
286
287static bool CopyFileToFile(const std::string& input_file, const std::string& output_file) {
288 if (input_file == output_file) {
289 MYLOGD("Skipping copying bugreport file since the destination is the same (%s)\n",
290 output_file.c_str());
291 return false;
292 }
293 else if (PathExists(output_file)) {
294 MYLOGD("Cannot overwrite an existing file (%s)\n", output_file.c_str());
295 return false;
296 }
297
298 MYLOGD("Going to copy bugreport file (%s) to %s\n", input_file.c_str(), output_file.c_str());
299 android::base::unique_fd out_fd(OpenForWrite(output_file));
300 return CopyFileToFd(input_file, out_fd.get());
301}
302
Nandana Dutt979388e2018-11-30 16:48:55 +0000303} // namespace
304} // namespace os
305} // namespace android
306
Felipe Leme678727a2016-09-21 17:22:11 -0700307static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
Felipe Lemebda15a02016-11-16 17:48:25 -0800308 const CommandOptions& options = Dumpstate::DEFAULT_DUMPSYS,
Vishnu Nair6921f802017-11-22 09:17:23 -0800309 long dumpsysTimeoutMs = 0) {
310 return ds.RunDumpsys(title, dumpsysArgs, options, dumpsysTimeoutMs);
Felipe Leme678727a2016-09-21 17:22:11 -0700311}
312static int DumpFile(const std::string& title, const std::string& path) {
313 return ds.DumpFile(title, path);
314}
Felipe Lemee82a27d2016-01-05 13:35:44 -0800315
Felipe Lemee844a9d2016-09-21 15:01:39 -0700316// Relative directory (inside the zip) for all files copied as-is into the bugreport.
317static const std::string ZIP_ROOT_DIR = "FS";
318
Vishnu Naire97d6122018-01-18 13:58:56 -0800319static const std::string kProtoPath = "proto/";
320static const std::string kProtoExt = ".proto";
Jie Song9fbfad02017-06-20 16:29:42 -0700321static const std::string kDumpstateBoardFiles[] = {
322 "dumpstate_board.txt",
Felipe Leme95d6ca52017-08-01 16:35:56 -0700323 "dumpstate_board.bin"
Jie Song9fbfad02017-06-20 16:29:42 -0700324};
325static const int NUM_OF_DUMPS = arraysize(kDumpstateBoardFiles);
326
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700327static constexpr char PROPERTY_LAST_ID[] = "dumpstate.last_id";
Felipe Lemed071c682016-10-20 16:48:00 -0700328static constexpr char PROPERTY_VERSION[] = "dumpstate.version";
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700329
Felipe Lemef0292972016-11-22 13:57:05 -0800330static const CommandOptions AS_ROOT_20 = CommandOptions::WithTimeout(20).AsRoot().Build();
331
Narayan Kamath8f788292017-05-25 13:20:39 +0100332/*
Narayan Kamathbd863722017-06-01 18:50:12 +0100333 * Returns a vector of dump fds under |dir_path| with a given |file_prefix|.
Rhed Jao01dc0c62020-06-03 17:13:30 +0800334 * The returned vector is sorted by the mtimes of the dumps with descending
335 * order. If |limit_by_mtime| is set, the vector only contains files that
336 * were written in the last 30 minutes.
Narayan Kamath8f788292017-05-25 13:20:39 +0100337 */
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700338static std::vector<DumpData> GetDumpFds(const std::string& dir_path,
339 const std::string& file_prefix,
Elliott Hughesdb6d2112019-09-26 15:24:51 -0700340 bool limit_by_mtime) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100341 const time_t thirty_minutes_ago = ds.now_ - 60 * 30;
342
Narayan Kamathbd863722017-06-01 18:50:12 +0100343 std::unique_ptr<DIR, decltype(&closedir)> dump_dir(opendir(dir_path.c_str()), closedir);
Narayan Kamath8f788292017-05-25 13:20:39 +0100344
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700345 if (dump_dir == nullptr) {
346 MYLOGW("Unable to open directory %s: %s\n", dir_path.c_str(), strerror(errno));
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700347 return std::vector<DumpData>();
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700348 }
349
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700350 std::vector<DumpData> dump_data;
Narayan Kamathbd863722017-06-01 18:50:12 +0100351 struct dirent* entry = nullptr;
352 while ((entry = readdir(dump_dir.get()))) {
353 if (entry->d_type != DT_REG) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100354 continue;
355 }
356
Narayan Kamathbd863722017-06-01 18:50:12 +0100357 const std::string base_name(entry->d_name);
358 if (base_name.find(file_prefix) != 0) {
359 continue;
360 }
361
362 const std::string abs_path = dir_path + base_name;
363 android::base::unique_fd fd(
364 TEMP_FAILURE_RETRY(open(abs_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW | O_NONBLOCK)));
365 if (fd == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700366 MYLOGW("Unable to open dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamathbd863722017-06-01 18:50:12 +0100367 break;
368 }
369
370 struct stat st = {};
371 if (fstat(fd, &st) == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700372 MYLOGW("Unable to stat dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamath8f788292017-05-25 13:20:39 +0100373 continue;
374 }
375
Narayan Kamath3f31b632018-02-22 19:42:36 +0000376 if (limit_by_mtime && st.st_mtime < thirty_minutes_ago) {
Narayan Kamathbd863722017-06-01 18:50:12 +0100377 MYLOGI("Excluding stale dump file: %s\n", abs_path.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100378 continue;
379 }
380
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700381 dump_data.emplace_back(DumpData{abs_path, std::move(fd), st.st_mtime});
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700382 }
Rhed Jao01dc0c62020-06-03 17:13:30 +0800383 if (!dump_data.empty()) {
384 std::sort(dump_data.begin(), dump_data.end(),
385 [](const auto& a, const auto& b) { return a.mtime > b.mtime; });
386 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100387
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700388 return dump_data;
Narayan Kamath8f788292017-05-25 13:20:39 +0100389}
390
Narayan Kamathbd863722017-06-01 18:50:12 +0100391static bool AddDumps(const std::vector<DumpData>::const_iterator start,
392 const std::vector<DumpData>::const_iterator end,
393 const char* type_name, const bool add_to_zip) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100394 bool dumped = false;
Narayan Kamathbd863722017-06-01 18:50:12 +0100395 for (auto it = start; it != end; ++it) {
396 const std::string& name = it->name;
397 const int fd = it->fd;
Narayan Kamath8f788292017-05-25 13:20:39 +0100398 dumped = true;
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100399
400 // Seek to the beginning of the file before dumping any data. A given
401 // DumpData entry might be dumped multiple times in the report.
402 //
403 // For example, the most recent ANR entry is dumped to the body of the
404 // main entry and it also shows up as a separate entry in the bugreport
405 // ZIP file.
406 if (lseek(fd, 0, SEEK_SET) != static_cast<off_t>(0)) {
407 MYLOGE("Unable to add %s to zip file, lseek failed: %s\n", name.c_str(),
408 strerror(errno));
409 }
410
Narayan Kamath8f788292017-05-25 13:20:39 +0100411 if (ds.IsZipping() && add_to_zip) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800412 if (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + name, fd, /* timeout = */ 0ms) != OK) {
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100413 MYLOGE("Unable to add %s to zip file, addZipEntryFromFd failed\n", name.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100414 }
415 } else {
416 dump_file_from_fd(type_name, name.c_str(), fd);
417 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100418 }
419
420 return dumped;
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700421}
422
Felipe Leme635ca312016-01-05 14:23:02 -0800423// for_each_pid() callback to get mount info about a process.
Felipe Leme4c2d6632016-09-28 14:32:00 -0700424void do_mountinfo(int pid, const char* name __attribute__((unused))) {
Felipe Leme635ca312016-01-05 14:23:02 -0800425 char path[PATH_MAX];
426
427 // Gets the the content of the /proc/PID/ns/mnt link, so only unique mount points
428 // are added.
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700429 snprintf(path, sizeof(path), "/proc/%d/ns/mnt", pid);
Felipe Leme635ca312016-01-05 14:23:02 -0800430 char linkname[PATH_MAX];
431 ssize_t r = readlink(path, linkname, PATH_MAX);
432 if (r == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800433 MYLOGE("Unable to read link for %s: %s\n", path, strerror(errno));
Felipe Leme635ca312016-01-05 14:23:02 -0800434 return;
435 }
436 linkname[r] = '\0';
437
438 if (mount_points.find(linkname) == mount_points.end()) {
439 // First time this mount point was found: add it
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700440 snprintf(path, sizeof(path), "/proc/%d/mountinfo", pid);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700441 if (ds.AddZipEntry(ZIP_ROOT_DIR + path, path)) {
Felipe Leme635ca312016-01-05 14:23:02 -0800442 mount_points.insert(linkname);
443 } else {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800444 MYLOGE("Unable to add mountinfo %s to zip file\n", path);
Felipe Leme635ca312016-01-05 14:23:02 -0800445 }
446 }
447}
448
449void add_mountinfo() {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700450 if (!ds.IsZipping()) return;
Felipe Leme678727a2016-09-21 17:22:11 -0700451 std::string title = "MOUNT INFO";
Felipe Leme635ca312016-01-05 14:23:02 -0800452 mount_points.clear();
Felipe Leme46b85da2016-11-21 17:40:45 -0800453 DurationReporter duration_reporter(title, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700454 for_each_pid(do_mountinfo, nullptr);
455 MYLOGD("%s: %d entries added to zip file\n", title.c_str(), (int)mount_points.size());
Felipe Leme635ca312016-01-05 14:23:02 -0800456}
457
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700458static void dump_dev_files(const char *title, const char *driverpath, const char *filename)
459{
460 DIR *d;
461 struct dirent *de;
462 char path[PATH_MAX];
463
464 d = opendir(driverpath);
Yi Kong19d5c002018-07-20 13:39:55 -0700465 if (d == nullptr) {
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700466 return;
467 }
468
469 while ((de = readdir(d))) {
470 if (de->d_type != DT_LNK) {
471 continue;
472 }
473 snprintf(path, sizeof(path), "%s/%s/%s", driverpath, de->d_name, filename);
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700474 DumpFile(title, path);
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700475 }
476
477 closedir(d);
478}
479
Mark Salyzyn326842f2015-04-30 09:49:41 -0700480static bool skip_not_stat(const char *path) {
481 static const char stat[] = "/stat";
482 size_t len = strlen(path);
483 if (path[len - 1] == '/') { /* Directory? */
484 return false;
485 }
486 return strcmp(path + len - sizeof(stat) + 1, stat); /* .../stat? */
487}
488
Felipe Leme4c2d6632016-09-28 14:32:00 -0700489static bool skip_none(const char* path __attribute__((unused))) {
Felipe Lemee82a27d2016-01-05 13:35:44 -0800490 return false;
491}
492
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700493unsigned long worst_write_perf = 20000; /* in KB/s */
Mark Salyzyn326842f2015-04-30 09:49:41 -0700494
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800495//
496// stat offsets
497// Name units description
498// ---- ----- -----------
499// read I/Os requests number of read I/Os processed
500#define __STAT_READ_IOS 0
501// read merges requests number of read I/Os merged with in-queue I/O
502#define __STAT_READ_MERGES 1
503// read sectors sectors number of sectors read
504#define __STAT_READ_SECTORS 2
505// read ticks milliseconds total wait time for read requests
506#define __STAT_READ_TICKS 3
507// write I/Os requests number of write I/Os processed
508#define __STAT_WRITE_IOS 4
509// write merges requests number of write I/Os merged with in-queue I/O
510#define __STAT_WRITE_MERGES 5
511// write sectors sectors number of sectors written
512#define __STAT_WRITE_SECTORS 6
513// write ticks milliseconds total wait time for write requests
514#define __STAT_WRITE_TICKS 7
515// in_flight requests number of I/Os currently in flight
516#define __STAT_IN_FLIGHT 8
517// io_ticks milliseconds total time this block device has been active
518#define __STAT_IO_TICKS 9
519// time_in_queue milliseconds total wait time for all requests
520#define __STAT_IN_QUEUE 10
521#define __STAT_NUMBER_FIELD 11
522//
523// read I/Os, write I/Os
524// =====================
525//
526// These values increment when an I/O request completes.
527//
528// read merges, write merges
529// =========================
530//
531// These values increment when an I/O request is merged with an
532// already-queued I/O request.
533//
534// read sectors, write sectors
535// ===========================
536//
537// These values count the number of sectors read from or written to this
538// block device. The "sectors" in question are the standard UNIX 512-byte
539// sectors, not any device- or filesystem-specific block size. The
540// counters are incremented when the I/O completes.
541#define SECTOR_SIZE 512
542//
543// read ticks, write ticks
544// =======================
545//
546// These values count the number of milliseconds that I/O requests have
547// waited on this block device. If there are multiple I/O requests waiting,
548// these values will increase at a rate greater than 1000/second; for
549// example, if 60 read requests wait for an average of 30 ms, the read_ticks
550// field will increase by 60*30 = 1800.
551//
552// in_flight
553// =========
554//
555// This value counts the number of I/O requests that have been issued to
556// the device driver but have not yet completed. It does not include I/O
557// requests that are in the queue but not yet issued to the device driver.
558//
559// io_ticks
560// ========
561//
562// This value counts the number of milliseconds during which the device has
563// had I/O requests queued.
564//
565// time_in_queue
566// =============
567//
568// This value counts the number of milliseconds that I/O requests have waited
569// on this block device. If there are multiple I/O requests waiting, this
570// value will increase as the product of the number of milliseconds times the
571// number of requests waiting (see "read ticks" above for an example).
572#define S_TO_MS 1000
573//
574
Mark Salyzyn326842f2015-04-30 09:49:41 -0700575static int dump_stat_from_fd(const char *title __unused, const char *path, int fd) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800576 unsigned long long fields[__STAT_NUMBER_FIELD];
Mark Salyzyn326842f2015-04-30 09:49:41 -0700577 bool z;
Yi Kong19d5c002018-07-20 13:39:55 -0700578 char *cp, *buffer = nullptr;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700579 size_t i = 0;
Josh Gao7c4258c2018-06-25 13:40:08 -0700580 FILE *fp = fdopen(dup(fd), "rb");
Mark Salyzyn326842f2015-04-30 09:49:41 -0700581 getline(&buffer, &i, fp);
582 fclose(fp);
583 if (!buffer) {
584 return -errno;
585 }
586 i = strlen(buffer);
587 while ((i > 0) && (buffer[i - 1] == '\n')) {
588 buffer[--i] = '\0';
589 }
590 if (!*buffer) {
591 free(buffer);
592 return 0;
593 }
594 z = true;
595 for (cp = buffer, i = 0; i < (sizeof(fields) / sizeof(fields[0])); ++i) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800596 fields[i] = strtoull(cp, &cp, 10);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700597 if (fields[i] != 0) {
598 z = false;
599 }
600 }
601 if (z) { /* never accessed */
602 free(buffer);
603 return 0;
604 }
605
Wei Wang509bb5d2017-06-09 14:42:12 -0700606 if (!strncmp(path, BLK_DEV_SYS_DIR, sizeof(BLK_DEV_SYS_DIR) - 1)) {
607 path += sizeof(BLK_DEV_SYS_DIR) - 1;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700608 }
Wei Wang1dc1ef52017-06-12 11:28:37 -0700609
610 printf("%-30s:%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s\n%-30s:\t%s\n", "Block-Dev",
611 "R-IOs", "R-merg", "R-sect", "R-wait", "W-IOs", "W-merg", "W-sect",
612 "W-wait", "in-fli", "activ", "T-wait", path, buffer);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700613 free(buffer);
614
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800615 if (fields[__STAT_IO_TICKS]) {
616 unsigned long read_perf = 0;
617 unsigned long read_ios = 0;
618 if (fields[__STAT_READ_TICKS]) {
619 unsigned long long divisor = fields[__STAT_READ_TICKS]
620 * fields[__STAT_IO_TICKS];
621 read_perf = ((unsigned long long)SECTOR_SIZE
622 * fields[__STAT_READ_SECTORS]
623 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
624 / divisor;
625 read_ios = ((unsigned long long)S_TO_MS * fields[__STAT_READ_IOS]
626 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
627 / divisor;
628 }
629
630 unsigned long write_perf = 0;
631 unsigned long write_ios = 0;
632 if (fields[__STAT_WRITE_TICKS]) {
633 unsigned long long divisor = fields[__STAT_WRITE_TICKS]
634 * fields[__STAT_IO_TICKS];
635 write_perf = ((unsigned long long)SECTOR_SIZE
636 * fields[__STAT_WRITE_SECTORS]
637 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
638 / divisor;
639 write_ios = ((unsigned long long)S_TO_MS * fields[__STAT_WRITE_IOS]
640 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
641 / divisor;
642 }
643
644 unsigned queue = (fields[__STAT_IN_QUEUE]
645 + (fields[__STAT_IO_TICKS] >> 1))
646 / fields[__STAT_IO_TICKS];
647
648 if (!write_perf && !write_ios) {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700649 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 -0800650 } else {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700651 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 -0800652 read_ios, write_perf, write_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800653 }
654
655 /* bugreport timeout factor adjustment */
656 if ((write_perf > 1) && (write_perf < worst_write_perf)) {
657 worst_write_perf = write_perf;
658 }
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700659 }
Mark Salyzyn326842f2015-04-30 09:49:41 -0700660 return 0;
661}
662
Yao Chenbe3bbc12018-01-17 16:31:10 -0800663static const long MINIMUM_LOGCAT_TIMEOUT_MS = 50000;
664
Tom Cherryf4472f32020-08-05 09:31:17 -0700665// Returns the actual readable size of the given buffer or -1 on error.
666static long logcat_buffer_readable_size(const std::string& buffer) {
667 std::unique_ptr<logger_list, decltype(&android_logger_list_free)> logger_list{
668 android_logger_list_alloc(0, 0, 0), &android_logger_list_free};
669 auto logger = android_logger_open(logger_list.get(), android_name_to_log_id(buffer.c_str()));
670
671 return android_logger_get_log_readable_size(logger);
672}
673
674// Returns timeout in ms to read a list of buffers.
Yao Chenbe3bbc12018-01-17 16:31:10 -0800675static unsigned long logcat_timeout(const std::vector<std::string>& buffers) {
676 unsigned long timeout_ms = 0;
677 for (const auto& buffer : buffers) {
Tom Cherryf4472f32020-08-05 09:31:17 -0700678 long readable_size = logcat_buffer_readable_size(buffer);
679 if (readable_size > 0) {
680 // Engineering margin is ten-fold our guess.
681 timeout_ms += 10 * (readable_size + worst_write_perf) / worst_write_perf;
682 }
Yao Chenbe3bbc12018-01-17 16:31:10 -0800683 }
684 return timeout_ms > MINIMUM_LOGCAT_TIMEOUT_MS ? timeout_ms : MINIMUM_LOGCAT_TIMEOUT_MS;
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700685}
686
Nandana Duttd2f5f082019-01-18 17:13:52 +0000687Dumpstate::ConsentCallback::ConsentCallback() : result_(UNAVAILABLE), start_time_(Nanotime()) {
688}
689
690android::binder::Status Dumpstate::ConsentCallback::onReportApproved() {
691 std::lock_guard<std::mutex> lock(lock_);
692 result_ = APPROVED;
693 MYLOGD("User approved consent to share bugreport\n");
Paul Chang0d2aad72020-02-13 20:04:03 +0800694
695 // Maybe copy screenshot so calling app can display the screenshot to the user as soon as
696 // consent is granted.
697 if (ds.options_->is_screenshot_copied) {
698 return android::binder::Status::ok();
699 }
700
701 if (!ds.options_->do_screenshot || ds.options_->screenshot_fd.get() == -1 ||
702 !ds.do_early_screenshot_) {
703 return android::binder::Status::ok();
704 }
705
706 bool copy_succeeded = android::os::CopyFileToFd(ds.screenshot_path_,
707 ds.options_->screenshot_fd.get());
708 ds.options_->is_screenshot_copied = copy_succeeded;
709 if (copy_succeeded) {
710 android::os::UnlinkAndLogOnError(ds.screenshot_path_);
711 }
Nandana Duttd2f5f082019-01-18 17:13:52 +0000712 return android::binder::Status::ok();
713}
714
715android::binder::Status Dumpstate::ConsentCallback::onReportDenied() {
716 std::lock_guard<std::mutex> lock(lock_);
717 result_ = DENIED;
718 MYLOGW("User denied consent to share bugreport\n");
719 return android::binder::Status::ok();
720}
721
722UserConsentResult Dumpstate::ConsentCallback::getResult() {
723 std::lock_guard<std::mutex> lock(lock_);
724 return result_;
725}
726
727uint64_t Dumpstate::ConsentCallback::getElapsedTimeMs() const {
Hunter Knepshieldf0a39052020-01-03 14:53:04 -0800728 return (Nanotime() - start_time_) / NANOS_PER_MILLI;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000729}
730
Felipe Leme2b9b06c2016-10-14 09:13:06 -0700731void Dumpstate::PrintHeader() const {
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700732 std::string build, fingerprint, radio, bootloader, network;
733 char date[80];
Colin Crossf45fa6b2012-03-26 12:38:26 -0700734
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700735 build = android::base::GetProperty("ro.build.display.id", "(unknown)");
736 fingerprint = android::base::GetProperty("ro.build.fingerprint", "(unknown)");
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700737 radio = android::base::GetProperty("gsm.version.baseband", "(unknown)");
738 bootloader = android::base::GetProperty("ro.bootloader", "(unknown)");
739 network = android::base::GetProperty("gsm.operator.alpha", "(unknown)");
Felipe Lemebbaf3c12016-10-11 14:32:25 -0700740 strftime(date, sizeof(date), "%Y-%m-%d %H:%M:%S", localtime(&now_));
Colin Crossf45fa6b2012-03-26 12:38:26 -0700741
Felipe Lemed8b94e52016-12-08 10:21:44 -0800742 printf("========================================================\n");
743 printf("== dumpstate: %s\n", date);
744 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -0700745
Felipe Lemed8b94e52016-12-08 10:21:44 -0800746 printf("\n");
747 printf("Build: %s\n", build.c_str());
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700748 // NOTE: fingerprint entry format is important for other tools.
Felipe Lemed8b94e52016-12-08 10:21:44 -0800749 printf("Build fingerprint: '%s'\n", fingerprint.c_str());
750 printf("Bootloader: %s\n", bootloader.c_str());
751 printf("Radio: %s\n", radio.c_str());
752 printf("Network: %s\n", network.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100753 int64_t module_metadata_version = android::os::GetModuleMetadataVersion();
754 if (module_metadata_version != 0) {
755 printf("Module Metadata version: %" PRId64 "\n", module_metadata_version);
756 }
Colin Crossf45fa6b2012-03-26 12:38:26 -0700757
Felipe Lemed8b94e52016-12-08 10:21:44 -0800758 printf("Kernel: ");
Felipe Lemef0292972016-11-22 13:57:05 -0800759 DumpFileToFd(STDOUT_FILENO, "", "/proc/version");
Felipe Lemed8b94e52016-12-08 10:21:44 -0800760 printf("Command line: %s\n", strtok(cmdline_buf, "\n"));
Felipe Leme7709f8a2017-12-05 09:30:09 -0800761 printf("Uptime: ");
762 RunCommandToFd(STDOUT_FILENO, "", {"uptime", "-p"},
763 CommandOptions::WithTimeout(1).Always().Build());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800764 printf("Bugreport format version: %s\n", version_.c_str());
Abhijeet Kaure370d682019-10-01 16:49:30 +0100765 printf("Dumpstate info: id=%d pid=%d dry_run=%d args=%s bugreport_mode=%s\n", id_, pid_,
766 PropertiesHelper::IsDryRun(), options_->args.c_str(), options_->bugreport_mode.c_str());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800767 printf("\n");
Felipe Leme78f2c862015-12-21 09:55:22 -0800768}
769
Felipe Leme24b66ee2016-06-16 10:55:26 -0700770// List of file extensions that can cause a zip file attachment to be rejected by some email
771// service providers.
772static const std::set<std::string> PROBLEMATIC_FILE_EXTENSIONS = {
773 ".ade", ".adp", ".bat", ".chm", ".cmd", ".com", ".cpl", ".exe", ".hta", ".ins", ".isp",
774 ".jar", ".jse", ".lib", ".lnk", ".mde", ".msc", ".msp", ".mst", ".pif", ".scr", ".sct",
775 ".shb", ".sys", ".vb", ".vbe", ".vbs", ".vxd", ".wsc", ".wsf", ".wsh"
776};
777
Vishnu Naire97d6122018-01-18 13:58:56 -0800778status_t Dumpstate::AddZipEntryFromFd(const std::string& entry_name, int fd,
779 std::chrono::milliseconds timeout = 0ms) {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700780 if (!IsZipping()) {
781 MYLOGD("Not adding zip entry %s from fd because it's not a zipped bugreport\n",
782 entry_name.c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -0800783 return INVALID_OPERATION;
Felipe Leme111b9d02016-02-03 09:28:24 -0800784 }
Felipe Leme24b66ee2016-06-16 10:55:26 -0700785 std::string valid_name = entry_name;
786
787 // Rename extension if necessary.
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -0700788 size_t idx = entry_name.rfind('.');
Felipe Leme24b66ee2016-06-16 10:55:26 -0700789 if (idx != std::string::npos) {
790 std::string extension = entry_name.substr(idx);
791 std::transform(extension.begin(), extension.end(), extension.begin(), ::tolower);
792 if (PROBLEMATIC_FILE_EXTENSIONS.count(extension) != 0) {
793 valid_name = entry_name + ".renamed";
794 MYLOGI("Renaming entry %s to %s\n", entry_name.c_str(), valid_name.c_str());
795 }
796 }
797
Felipe Leme6fe9db62016-02-12 09:04:16 -0800798 // Logging statement below is useful to time how long each entry takes, but it's too verbose.
799 // MYLOGD("Adding zip entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700800 int32_t err = zip_writer_->StartEntryWithTime(valid_name.c_str(), ZipWriter::kCompress,
801 get_mtime(fd, ds.now_));
Felipe Leme1d486fe2016-10-14 18:06:47 -0700802 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700803 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", valid_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700804 ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800805 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800806 }
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000807 bool finished_entry = false;
808 auto finish_entry = [this, &finished_entry] {
809 if (!finished_entry) {
810 // This should only be called when we're going to return an earlier error,
811 // which would've been logged. This may imply the file is already corrupt
812 // and any further logging from FinishEntry is more likely to mislead than
813 // not.
814 this->zip_writer_->FinishEntry();
815 }
816 };
817 auto scope_guard = android::base::make_scope_guard(finish_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -0800818 auto start = std::chrono::steady_clock::now();
819 auto end = start + timeout;
820 struct pollfd pfd = {fd, POLLIN};
Felipe Lemee82a27d2016-01-05 13:35:44 -0800821
Felipe Leme770410d2016-01-26 17:07:14 -0800822 std::vector<uint8_t> buffer(65536);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800823 while (1) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800824 if (timeout.count() > 0) {
825 // lambda to recalculate the timeout.
826 auto time_left_ms = [end]() {
827 auto now = std::chrono::steady_clock::now();
828 auto diff = std::chrono::duration_cast<std::chrono::milliseconds>(end - now);
829 return std::max(diff.count(), 0LL);
830 };
831
832 int rc = TEMP_FAILURE_RETRY(poll(&pfd, 1, time_left_ms()));
833 if (rc < 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000834 MYLOGE("Error in poll while adding from fd to zip entry %s:%s\n",
835 entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800836 return -errno;
837 } else if (rc == 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000838 MYLOGE("Timed out adding from fd to zip entry %s:%s Timeout:%lldms\n",
Vishnu Naire97d6122018-01-18 13:58:56 -0800839 entry_name.c_str(), strerror(errno), timeout.count());
840 return TIMED_OUT;
841 }
842 }
843
Zach Riggle22200402016-08-18 01:01:24 -0400844 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800845 if (bytes_read == 0) {
846 break;
847 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800848 MYLOGE("read(%s): %s\n", entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800849 return -errno;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800850 }
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700851 err = zip_writer_->WriteBytes(buffer.data(), bytes_read);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800852 if (err) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700853 MYLOGE("zip_writer_->WriteBytes(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800854 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800855 }
856 }
857
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700858 err = zip_writer_->FinishEntry();
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000859 finished_entry = true;
Felipe Leme1d486fe2016-10-14 18:06:47 -0700860 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700861 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800862 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800863 }
864
Vishnu Naire97d6122018-01-18 13:58:56 -0800865 return OK;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800866}
867
Felipe Leme1d486fe2016-10-14 18:06:47 -0700868bool Dumpstate::AddZipEntry(const std::string& entry_name, const std::string& entry_path) {
869 android::base::unique_fd fd(
870 TEMP_FAILURE_RETRY(open(entry_path.c_str(), O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
Andreas Gampeaff68432016-07-18 18:01:27 -0700871 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800872 MYLOGE("open(%s): %s\n", entry_path.c_str(), strerror(errno));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800873 return false;
874 }
875
Vishnu Naire97d6122018-01-18 13:58:56 -0800876 return (AddZipEntryFromFd(entry_name, fd.get()) == OK);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800877}
878
879/* adds a file to the existing zipped bugreport */
Felipe Leme4c2d6632016-09-28 14:32:00 -0700880static int _add_file_from_fd(const char* title __attribute__((unused)), const char* path, int fd) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800881 return (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + path, fd) == OK) ? 0 : 1;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800882}
883
Felipe Leme1d486fe2016-10-14 18:06:47 -0700884void Dumpstate::AddDir(const std::string& dir, bool recursive) {
885 if (!IsZipping()) {
886 MYLOGD("Not adding dir %s because it's not a zipped bugreport\n", dir.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800887 return;
888 }
Felipe Leme678727a2016-09-21 17:22:11 -0700889 MYLOGD("Adding dir %s (recursive: %d)\n", dir.c_str(), recursive);
Felipe Leme46b85da2016-11-21 17:40:45 -0800890 DurationReporter duration_reporter(dir, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700891 dump_files("", dir.c_str(), recursive ? skip_none : is_dir, _add_file_from_fd);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800892}
893
Felipe Leme1d486fe2016-10-14 18:06:47 -0700894bool Dumpstate::AddTextZipEntry(const std::string& entry_name, const std::string& content) {
895 if (!IsZipping()) {
896 MYLOGD("Not adding text zip entry %s because it's not a zipped bugreport\n",
897 entry_name.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800898 return false;
899 }
Felipe Lemecbce55d2016-02-08 09:53:18 -0800900 MYLOGD("Adding zip text entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700901 int32_t err = zip_writer_->StartEntryWithTime(entry_name.c_str(), ZipWriter::kCompress, ds.now_);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700902 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700903 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700904 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800905 return false;
906 }
907
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700908 err = zip_writer_->WriteBytes(content.c_str(), content.length());
Felipe Leme1d486fe2016-10-14 18:06:47 -0700909 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700910 MYLOGE("zip_writer_->WriteBytes(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700911 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800912 return false;
913 }
914
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700915 err = zip_writer_->FinishEntry();
Felipe Leme1d486fe2016-10-14 18:06:47 -0700916 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700917 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800918 return false;
919 }
920
921 return true;
922}
923
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800924static void DoKmsg() {
925 struct stat st;
926 if (!stat(PSTORE_LAST_KMSG, &st)) {
927 /* Also TODO: Make console-ramoops CAP_SYSLOG protected. */
928 DumpFile("LAST KMSG", PSTORE_LAST_KMSG);
929 } else if (!stat(ALT_PSTORE_LAST_KMSG, &st)) {
930 DumpFile("LAST KMSG", ALT_PSTORE_LAST_KMSG);
931 } else {
932 /* TODO: Make last_kmsg CAP_SYSLOG protected. b/5555691 */
933 DumpFile("LAST KMSG", "/proc/last_kmsg");
934 }
935}
936
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800937static void DoKernelLogcat() {
Yao Chenbe3bbc12018-01-17 16:31:10 -0800938 unsigned long timeout_ms = logcat_timeout({"kernel"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800939 RunCommand(
940 "KERNEL LOG",
941 {"logcat", "-b", "kernel", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
942 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
943}
944
Nandana Duttdb379fa2019-10-09 16:54:41 +0100945static void DoSystemLogcat(time_t since) {
946 char since_str[80];
947 strftime(since_str, sizeof(since_str), "%Y-%m-%d %H:%M:%S.000", localtime(&since));
948
949 unsigned long timeout_ms = logcat_timeout({"main", "system", "crash"});
950 RunCommand("SYSTEM LOG",
951 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v", "-T",
952 since_str},
953 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
954}
955
Hunter Knepshield820f9bc2020-02-05 20:10:53 -0800956static void DoRadioLogcat() {
957 unsigned long timeout_ms = logcat_timeout({"radio"});
958 RunCommand(
959 "RADIO LOG",
960 {"logcat", "-b", "radio", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
961 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
962}
963
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800964static void DoLogcat() {
Vishnu Nair6921f802017-11-22 09:17:23 -0800965 unsigned long timeout_ms;
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800966 // DumpFile("EVENT LOG TAGS", "/etc/event-log-tags");
967 // calculate timeout
Yao Chenbe3bbc12018-01-17 16:31:10 -0800968 timeout_ms = logcat_timeout({"main", "system", "crash"});
Tony Makae737652017-03-30 17:47:09 +0100969 RunCommand("SYSTEM LOG",
Vishnu Nair6921f802017-11-22 09:17:23 -0800970 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
971 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -0800972 timeout_ms = logcat_timeout({"events"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800973 RunCommand(
974 "EVENT LOG",
975 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +0100976 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Yao Chenbe3bbc12018-01-17 16:31:10 -0800977 timeout_ms = logcat_timeout({"stats"});
978 RunCommand(
979 "STATS LOG",
980 {"logcat", "-b", "stats", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +0100981 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Hunter Knepshield820f9bc2020-02-05 20:10:53 -0800982 DoRadioLogcat();
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800983
984 RunCommand("LOG STATISTICS", {"logcat", "-b", "all", "-S"});
985
986 /* kernels must set CONFIG_PSTORE_PMSG, slice up pstore with device tree */
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800987 RunCommand("LAST LOGCAT", {"logcat", "-L", "-b", "all", "-v", "threadtime", "-v", "printable",
988 "-v", "uid", "-d", "*:v"});
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800989}
990
Mike Ma5c267872019-08-21 11:31:34 -0700991static void DumpIncidentReport() {
992 if (!ds.IsZipping()) {
993 MYLOGD("Not dumping incident report because it's not a zipped bugreport\n");
994 return;
995 }
996 DurationReporter duration_reporter("INCIDENT REPORT");
997 const std::string path = ds.bugreport_internal_dir_ + "/tmp_incident_report";
998 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
999 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1000 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1001 if (fd < 0) {
1002 MYLOGE("Could not open %s to dump incident report.\n", path.c_str());
1003 return;
1004 }
1005 RunCommandToFd(fd, "", {"incident", "-u"}, CommandOptions::WithTimeout(120).Build());
1006 bool empty = 0 == lseek(fd, 0, SEEK_END);
1007 if (!empty) {
1008 // Use a different name from "incident.proto"
1009 // /proto/incident.proto is reserved for incident service dump
1010 // i.e. metadata for debugging.
1011 ds.AddZipEntry(kProtoPath + "incident_report" + kProtoExt, path);
1012 }
1013 unlink(path.c_str());
1014}
1015
Sunny Goyal35949782019-11-19 15:54:36 -08001016static void DumpVisibleWindowViews() {
1017 if (!ds.IsZipping()) {
1018 MYLOGD("Not dumping visible views because it's not a zipped bugreport\n");
1019 return;
1020 }
1021 DurationReporter duration_reporter("VISIBLE WINDOW VIEWS");
1022 const std::string path = ds.bugreport_internal_dir_ + "/tmp_visible_window_views";
1023 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1024 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1025 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1026 if (fd < 0) {
1027 MYLOGE("Could not open %s to dump visible views.\n", path.c_str());
1028 return;
1029 }
1030 RunCommandToFd(fd, "", {"cmd", "window", "dump-visible-window-views"},
1031 CommandOptions::WithTimeout(120).Build());
1032 bool empty = 0 == lseek(fd, 0, SEEK_END);
1033 if (!empty) {
1034 ds.AddZipEntry("visible_windows.zip", path);
1035 } else {
1036 MYLOGW("Failed to dump visible windows\n");
1037 }
1038 unlink(path.c_str());
1039}
1040
Jayachandran Ca94c7172017-06-10 15:08:12 -07001041static void DumpIpTablesAsRoot() {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001042 RunCommand("IPTABLES", {"iptables", "-L", "-nvx"});
1043 RunCommand("IP6TABLES", {"ip6tables", "-L", "-nvx"});
Erik Kline32af8c22016-09-28 17:26:26 +09001044 RunCommand("IPTABLES NAT", {"iptables", "-t", "nat", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001045 /* no ip6 nat */
Erik Kline32af8c22016-09-28 17:26:26 +09001046 RunCommand("IPTABLES MANGLE", {"iptables", "-t", "mangle", "-L", "-nvx"});
1047 RunCommand("IP6TABLES MANGLE", {"ip6tables", "-t", "mangle", "-L", "-nvx"});
1048 RunCommand("IPTABLES RAW", {"iptables", "-t", "raw", "-L", "-nvx"});
1049 RunCommand("IP6TABLES RAW", {"ip6tables", "-t", "raw", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001050}
1051
David Andersond9ba4752018-12-11 18:26:59 -08001052static void DumpDynamicPartitionInfo() {
1053 if (!::android::base::GetBoolProperty("ro.boot.dynamic_partitions", false)) {
1054 return;
1055 }
1056
1057 RunCommand("LPDUMP", {"lpdump", "--all"});
David Anderson6650ade2019-10-02 15:18:59 -07001058 RunCommand("DEVICE-MAPPER", {"gsid", "dump-device-mapper"});
David Andersond9ba4752018-12-11 18:26:59 -08001059}
1060
Narayan Kamath8f788292017-05-25 13:20:39 +01001061static void AddAnrTraceDir(const bool add_to_zip, const std::string& anr_traces_dir) {
1062 MYLOGD("AddAnrTraceDir(): dump_traces_file=%s, anr_traces_dir=%s\n", dump_traces_path,
1063 anr_traces_dir.c_str());
1064
1065 // If we're here, dump_traces_path will always be a temporary file
1066 // (created with mkostemp or similar) that contains dumps taken earlier
1067 // on in the process.
1068 if (dump_traces_path != nullptr) {
1069 if (add_to_zip) {
1070 ds.AddZipEntry(ZIP_ROOT_DIR + anr_traces_dir + "/traces-just-now.txt", dump_traces_path);
1071 } else {
1072 MYLOGD("Dumping current ANR traces (%s) to the main bugreport entry\n",
1073 dump_traces_path);
1074 ds.DumpFile("VM TRACES JUST NOW", dump_traces_path);
1075 }
1076
1077 const int ret = unlink(dump_traces_path);
1078 if (ret == -1) {
1079 MYLOGW("Error unlinking temporary trace path %s: %s\n", dump_traces_path,
1080 strerror(errno));
Felipe Lemee184f662016-10-27 10:04:47 -07001081 }
1082 }
1083
Narayan Kamathbd863722017-06-01 18:50:12 +01001084 // Add a specific message for the first ANR Dump.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001085 if (ds.anr_data_.size() > 0) {
1086 AddDumps(ds.anr_data_.begin(), ds.anr_data_.begin() + 1,
Narayan Kamathbd863722017-06-01 18:50:12 +01001087 "VM TRACES AT LAST ANR", add_to_zip);
1088
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001089 // The "last" ANR will always be included as separate entry in the zip file. In addition,
1090 // it will be present in the body of the main entry if |add_to_zip| == false.
1091 //
1092 // Historical ANRs are always included as separate entries in the bugreport zip file.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001093 AddDumps(ds.anr_data_.begin() + ((add_to_zip) ? 1 : 0), ds.anr_data_.end(),
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001094 "HISTORICAL ANR", true /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001095 } else {
Narayan Kamath8f788292017-05-25 13:20:39 +01001096 printf("*** NO ANRs to dump in %s\n\n", ANR_DIR.c_str());
1097 }
1098}
1099
1100static void AddAnrTraceFiles() {
1101 const bool add_to_zip = ds.IsZipping() && ds.version_ == VERSION_SPLIT_ANR;
1102
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001103 std::string anr_traces_dir = "/data/anr";
Narayan Kamath8f788292017-05-25 13:20:39 +01001104
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001105 AddAnrTraceDir(add_to_zip, anr_traces_dir);
Narayan Kamath8f788292017-05-25 13:20:39 +01001106
Makoto Onuki83ec63f2019-01-31 17:08:59 -08001107 RunCommand("ANR FILES", {"ls", "-lt", ANR_DIR});
1108
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001109 // Slow traces for slow operations.
Felipe Lemee184f662016-10-27 10:04:47 -07001110 struct stat st;
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001111 int i = 0;
1112 while (true) {
1113 const std::string slow_trace_path =
1114 anr_traces_dir + android::base::StringPrintf("slow%02d.txt", i);
1115 if (stat(slow_trace_path.c_str(), &st)) {
1116 // No traces file at this index, done with the files.
1117 break;
Felipe Lemee184f662016-10-27 10:04:47 -07001118 }
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001119 ds.DumpFile("VM TRACES WHEN SLOW", slow_trace_path.c_str());
1120 i++;
Felipe Lemee184f662016-10-27 10:04:47 -07001121 }
1122}
1123
Wei Wang509bb5d2017-06-09 14:42:12 -07001124static void DumpBlockStatFiles() {
1125 DurationReporter duration_reporter("DUMP BLOCK STAT");
Wei Wang509bb5d2017-06-09 14:42:12 -07001126
Wei Wang1dc1ef52017-06-12 11:28:37 -07001127 std::unique_ptr<DIR, std::function<int(DIR*)>> dirptr(opendir(BLK_DEV_SYS_DIR), closedir);
1128
1129 if (dirptr == nullptr) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001130 MYLOGE("Failed to open %s: %s\n", BLK_DEV_SYS_DIR, strerror(errno));
1131 return;
1132 }
1133
1134 printf("------ DUMP BLOCK STAT ------\n\n");
Wei Wang1dc1ef52017-06-12 11:28:37 -07001135 while (struct dirent *d = readdir(dirptr.get())) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001136 if ((d->d_name[0] == '.')
1137 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
1138 || (d->d_name[1] == '\0'))) {
1139 continue;
1140 }
1141 const std::string new_path =
1142 android::base::StringPrintf("%s/%s", BLK_DEV_SYS_DIR, d->d_name);
1143 printf("------ BLOCK STAT (%s) ------\n", new_path.c_str());
1144 dump_files("", new_path.c_str(), skip_not_stat, dump_stat_from_fd);
1145 printf("\n");
1146 }
Wei Wang1dc1ef52017-06-12 11:28:37 -07001147 return;
Wei Wang509bb5d2017-06-09 14:42:12 -07001148}
Jayachandran Ca94c7172017-06-10 15:08:12 -07001149
1150static void DumpPacketStats() {
1151 DumpFile("NETWORK DEV INFO", "/proc/net/dev");
1152 DumpFile("QTAGUID NETWORK INTERFACES INFO", "/proc/net/xt_qtaguid/iface_stat_all");
1153 DumpFile("QTAGUID NETWORK INTERFACES INFO (xt)", "/proc/net/xt_qtaguid/iface_stat_fmt");
1154 DumpFile("QTAGUID CTRL INFO", "/proc/net/xt_qtaguid/ctrl");
1155 DumpFile("QTAGUID STATS INFO", "/proc/net/xt_qtaguid/stats");
1156}
1157
1158static void DumpIpAddrAndRules() {
1159 /* The following have a tendency to get wedged when wifi drivers/fw goes belly-up. */
1160 RunCommand("NETWORK INTERFACES", {"ip", "link"});
1161 RunCommand("IPv4 ADDRESSES", {"ip", "-4", "addr", "show"});
1162 RunCommand("IPv6 ADDRESSES", {"ip", "-6", "addr", "show"});
1163 RunCommand("IP RULES", {"ip", "rule", "show"});
1164 RunCommand("IP RULES v6", {"ip", "-6", "rule", "show"});
1165}
1166
Nandana Dutt5c390032019-03-12 10:52:56 +00001167static Dumpstate::RunStatus RunDumpsysTextByPriority(const std::string& title, int priority,
1168 std::chrono::milliseconds timeout,
1169 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001170 auto start = std::chrono::steady_clock::now();
Vishnu Naire97d6122018-01-18 13:58:56 -08001171 sp<android::IServiceManager> sm = defaultServiceManager();
1172 Dumpsys dumpsys(sm.get());
Vishnu Naire97d6122018-01-18 13:58:56 -08001173 Vector<String16> args;
1174 Dumpsys::setServiceArgs(args, /* asProto = */ false, priority);
Vishnu Naire97d6122018-01-18 13:58:56 -08001175 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ false);
1176 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001177 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001178 std::string path(title);
1179 path.append(" - ").append(String8(service).c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -08001180 size_t bytes_written = 0;
Steven Moreland5a30d342019-10-08 13:53:28 -07001181 status_t status = dumpsys.startDumpThread(Dumpsys::Type::DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001182 if (status == OK) {
1183 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1184 std::chrono::duration<double> elapsed_seconds;
1185 status = dumpsys.writeDump(STDOUT_FILENO, service, service_timeout,
1186 /* as_proto = */ false, elapsed_seconds, bytes_written);
Vishnu Naire97d6122018-01-18 13:58:56 -08001187 dumpsys.writeDumpFooter(STDOUT_FILENO, service, elapsed_seconds);
1188 bool dump_complete = (status == OK);
1189 dumpsys.stopDumpThread(dump_complete);
1190 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001191
1192 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1193 std::chrono::steady_clock::now() - start);
1194 if (elapsed_duration > timeout) {
1195 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1196 elapsed_duration.count());
1197 break;
1198 }
1199 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001200 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001201}
1202
Vishnu Nair64afc022018-02-01 15:29:34 -08001203static void RunDumpsysText(const std::string& title, int priority,
1204 std::chrono::milliseconds timeout,
1205 std::chrono::milliseconds service_timeout) {
1206 DurationReporter duration_reporter(title);
1207 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1208 fsync(STDOUT_FILENO);
1209 RunDumpsysTextByPriority(title, priority, timeout, service_timeout);
1210}
1211
1212/* Dump all services registered with Normal or Default priority. */
Nandana Dutt5c390032019-03-12 10:52:56 +00001213static Dumpstate::RunStatus RunDumpsysTextNormalPriority(const std::string& title,
1214 std::chrono::milliseconds timeout,
1215 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001216 DurationReporter duration_reporter(title);
1217 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1218 fsync(STDOUT_FILENO);
1219 RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_NORMAL, timeout,
1220 service_timeout);
Nandana Dutt5c390032019-03-12 10:52:56 +00001221
1222 RETURN_IF_USER_DENIED_CONSENT();
1223
1224 return RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_DEFAULT, timeout,
1225 service_timeout);
Vishnu Nair64afc022018-02-01 15:29:34 -08001226}
1227
Nandana Dutt5c390032019-03-12 10:52:56 +00001228static Dumpstate::RunStatus RunDumpsysProto(const std::string& title, int priority,
1229 std::chrono::milliseconds timeout,
1230 std::chrono::milliseconds service_timeout) {
Luis Hector Chavez1e27b082018-03-22 15:36:42 -07001231 if (!ds.IsZipping()) {
1232 MYLOGD("Not dumping %s because it's not a zipped bugreport\n", title.c_str());
Nandana Dutt5c390032019-03-12 10:52:56 +00001233 return Dumpstate::RunStatus::OK;
Luis Hector Chavez1e27b082018-03-22 15:36:42 -07001234 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001235 sp<android::IServiceManager> sm = defaultServiceManager();
1236 Dumpsys dumpsys(sm.get());
1237 Vector<String16> args;
1238 Dumpsys::setServiceArgs(args, /* asProto = */ true, priority);
1239 DurationReporter duration_reporter(title);
1240
1241 auto start = std::chrono::steady_clock::now();
1242 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ true);
1243 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001244 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001245 std::string path(kProtoPath);
1246 path.append(String8(service).c_str());
1247 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL) {
1248 path.append("_CRITICAL");
1249 } else if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH) {
1250 path.append("_HIGH");
1251 }
1252 path.append(kProtoExt);
Steven Moreland5a30d342019-10-08 13:53:28 -07001253 status_t status = dumpsys.startDumpThread(Dumpsys::Type::DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001254 if (status == OK) {
1255 status = ds.AddZipEntryFromFd(path, dumpsys.getDumpFd(), service_timeout);
1256 bool dumpTerminated = (status == OK);
1257 dumpsys.stopDumpThread(dumpTerminated);
1258 }
1259 ZipWriter::FileEntry file_entry;
1260 ds.zip_writer_->GetLastEntry(&file_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -08001261
1262 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1263 std::chrono::steady_clock::now() - start);
1264 if (elapsed_duration > timeout) {
1265 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1266 elapsed_duration.count());
1267 break;
1268 }
1269 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001270 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001271}
1272
Nandana Dutta7db6342018-11-21 14:53:34 +00001273// Runs dumpsys on services that must dump first and will take less than 100ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001274static Dumpstate::RunStatus RunDumpsysCritical() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001275 RunDumpsysText("DUMPSYS CRITICAL", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1276 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Nandana Dutt5c390032019-03-12 10:52:56 +00001277
1278 RETURN_IF_USER_DENIED_CONSENT();
1279
1280 return RunDumpsysProto("DUMPSYS CRITICAL PROTO", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1281 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Vishnu Nair780b1282017-10-10 13:57:24 -07001282}
1283
1284// Runs dumpsys on services that must dump first but can take up to 250ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001285static Dumpstate::RunStatus RunDumpsysHigh() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001286 // TODO meminfo takes ~10s, connectivity takes ~5sec to dump. They are both
1287 // high priority. Reduce timeout once they are able to dump in a shorter time or
1288 // moved to a parallel task.
1289 RunDumpsysText("DUMPSYS HIGH", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1290 /* timeout= */ 90s, /* service_timeout= */ 30s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001291
1292 RETURN_IF_USER_DENIED_CONSENT();
1293
1294 return RunDumpsysProto("DUMPSYS HIGH PROTO", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1295 /* timeout= */ 5s, /* service_timeout= */ 1s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001296}
1297
1298// Runs dumpsys on services that must dump but can take up to 10s to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001299static Dumpstate::RunStatus RunDumpsysNormal() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001300 RunDumpsysTextNormalPriority("DUMPSYS", /* timeout= */ 90s, /* service_timeout= */ 10s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001301
1302 RETURN_IF_USER_DENIED_CONSENT();
1303
1304 return RunDumpsysProto("DUMPSYS PROTO", IServiceManager::DUMP_FLAG_PRIORITY_NORMAL,
1305 /* timeout= */ 90s, /* service_timeout= */ 10s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001306}
1307
Steven Moreland44cd9482018-01-04 16:24:13 -08001308static void DumpHals() {
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001309 if (!ds.IsZipping()) {
Yifan Hong30528a22020-08-07 18:24:06 -07001310 RunCommand("HARDWARE HALS", {"lshal", "--all", "--types=all", "--debug"},
Steven Moreland9de8a1f2020-09-23 17:26:33 +00001311 CommandOptions::WithTimeout(60).AsRootIfAvailable().Build());
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001312 return;
1313 }
1314 DurationReporter duration_reporter("DUMP HALS");
Yifan Hong30528a22020-08-07 18:24:06 -07001315 RunCommand("HARDWARE HALS", {"lshal", "--all", "--types=all"},
Greg Kaiser3dfeda32019-05-16 10:32:51 -07001316 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build());
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001317
Steven Moreland44cd9482018-01-04 16:24:13 -08001318 using android::hidl::manager::V1_0::IServiceManager;
1319 using android::hardware::defaultServiceManager;
1320
1321 sp<IServiceManager> sm = defaultServiceManager();
1322 if (sm == nullptr) {
1323 MYLOGE("Could not retrieve hwservicemanager to dump hals.\n");
1324 return;
1325 }
1326
1327 auto ret = sm->list([&](const auto& interfaces) {
1328 for (const std::string& interface : interfaces) {
1329 std::string cleanName = interface;
1330 std::replace_if(cleanName.begin(),
1331 cleanName.end(),
1332 [](char c) {
1333 return !isalnum(c) &&
1334 std::string("@-_:.").find(c) == std::string::npos;
1335 }, '_');
Nandana Dutt979388e2018-11-30 16:48:55 +00001336 const std::string path = ds.bugreport_internal_dir_ + "/lshal_debug_" + cleanName;
Steven Moreland44cd9482018-01-04 16:24:13 -08001337
1338 {
1339 auto fd = android::base::unique_fd(
1340 TEMP_FAILURE_RETRY(open(path.c_str(),
1341 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1342 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1343 if (fd < 0) {
1344 MYLOGE("Could not open %s to dump additional hal information.\n", path.c_str());
1345 continue;
1346 }
1347 RunCommandToFd(fd,
1348 "",
Steven Morelandc81cd3c2018-01-18 14:36:26 -08001349 {"lshal", "debug", "-E", interface},
Steven Moreland44cd9482018-01-04 16:24:13 -08001350 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
1351
1352 bool empty = 0 == lseek(fd, 0, SEEK_END);
1353 if (!empty) {
1354 ds.AddZipEntry("lshal-debug/" + cleanName + ".txt", path);
1355 }
1356 }
1357
1358 unlink(path.c_str());
1359 }
1360 });
1361
1362 if (!ret.isOk()) {
1363 MYLOGE("Could not list hals from hwservicemanager.\n");
1364 }
1365}
1366
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001367static void DumpExternalFragmentationInfo() {
1368 struct stat st;
1369 if (stat("/proc/buddyinfo", &st) != 0) {
1370 MYLOGE("Unable to dump external fragmentation info\n");
1371 return;
1372 }
1373
1374 printf("------ EXTERNAL FRAGMENTATION INFO ------\n");
1375 std::ifstream ifs("/proc/buddyinfo");
1376 auto unusable_index_regex = std::regex{"Node\\s+([0-9]+),\\s+zone\\s+(\\S+)\\s+(.*)"};
1377 for (std::string line; std::getline(ifs, line);) {
1378 std::smatch match_results;
1379 if (std::regex_match(line, match_results, unusable_index_regex)) {
1380 std::stringstream free_pages(std::string{match_results[3]});
1381 std::vector<int> free_pages_per_order(std::istream_iterator<int>{free_pages},
1382 std::istream_iterator<int>());
1383
1384 int total_free_pages = 0;
1385 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1386 total_free_pages += (free_pages_per_order[i] * std::pow(2, i));
1387 }
1388
1389 printf("Node %s, zone %8s", match_results[1].str().c_str(),
1390 match_results[2].str().c_str());
1391
1392 int usable_free_pages = total_free_pages;
1393 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1394 auto unusable_index = (total_free_pages - usable_free_pages) /
1395 static_cast<double>(total_free_pages);
1396 printf(" %5.3f", unusable_index);
1397 usable_free_pages -= (free_pages_per_order[i] * std::pow(2, i));
1398 }
1399
1400 printf("\n");
1401 }
1402 }
1403 printf("\n");
1404}
1405
mhasankd451a472020-05-26 18:02:39 -07001406static void DumpstateLimitedOnly() {
1407 // Trimmed-down version of dumpstate to only include a whitelisted
1408 // set of logs (system log, event log, and system server / system app
1409 // crashes, and networking logs). See b/136273873 and b/138459828
1410 // for context.
1411 DurationReporter duration_reporter("DUMPSTATE");
1412 unsigned long timeout_ms;
1413 // calculate timeout
1414 timeout_ms = logcat_timeout({"main", "system", "crash"});
1415 RunCommand("SYSTEM LOG",
1416 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1417 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1418 timeout_ms = logcat_timeout({"events"});
1419 RunCommand(
1420 "EVENT LOG",
1421 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1422 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1423
1424 printf("========================================================\n");
1425 printf("== Networking Service\n");
1426 printf("========================================================\n");
1427
1428 RunDumpsys("DUMPSYS NETWORK_SERVICE_LIMITED", {"wifi", "-a"},
1429 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
1430
1431 printf("========================================================\n");
1432 printf("== Dropbox crashes\n");
1433 printf("========================================================\n");
1434
1435 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1436 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1437
1438 printf("========================================================\n");
1439 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1440 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1441 printf("========================================================\n");
1442 printf("== dumpstate: done (id %d)\n", ds.id_);
1443 printf("========================================================\n");
1444}
1445
Nandana Dutt5c390032019-03-12 10:52:56 +00001446// Dumps various things. Returns early with status USER_CONSENT_DENIED if user denies consent
1447// via the consent they are shown. Ignores other errors that occur while running various
1448// commands. The consent checking is currently done around long running tasks, which happen to
1449// be distributed fairly evenly throughout the function.
1450static Dumpstate::RunStatus dumpstate() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001451 DurationReporter duration_reporter("DUMPSTATE");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001452
Nandana Dutt5c390032019-03-12 10:52:56 +00001453 // Dump various things. Note that anything that takes "long" (i.e. several seconds) should
1454 // check intermittently (if it's intrerruptable like a foreach on pids) and/or should be wrapped
1455 // in a consent check (via RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK).
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -07001456 dump_dev_files("TRUSTY VERSION", "/sys/bus/platform/drivers/trusty", "trusty_version");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001457 RunCommand("UPTIME", {"uptime"});
Wei Wang509bb5d2017-06-09 14:42:12 -07001458 DumpBlockStatFiles();
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001459 DumpFile("MEMORY INFO", "/proc/meminfo");
1460 RunCommand("CPU INFO", {"top", "-b", "-n", "1", "-H", "-s", "6", "-o",
Felipe Leme30dbfa12016-09-02 12:43:26 -07001461 "pid,tid,user,pr,ni,%cpu,s,virt,res,pcy,cmd,name"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001462
1463 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "PROCRANK", {"procrank"}, AS_ROOT_20);
1464
Sunny Goyal35949782019-11-19 15:54:36 -08001465 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpVisibleWindowViews);
1466
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001467 DumpFile("VIRTUAL MEMORY STATS", "/proc/vmstat");
1468 DumpFile("VMALLOC INFO", "/proc/vmallocinfo");
1469 DumpFile("SLAB INFO", "/proc/slabinfo");
1470 DumpFile("ZONEINFO", "/proc/zoneinfo");
1471 DumpFile("PAGETYPEINFO", "/proc/pagetypeinfo");
1472 DumpFile("BUDDYINFO", "/proc/buddyinfo");
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001473 DumpExternalFragmentationInfo();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001474
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001475 DumpFile("KERNEL WAKE SOURCES", "/d/wakeup_sources");
1476 DumpFile("KERNEL CPUFREQ", "/sys/devices/system/cpu/cpu0/cpufreq/stats/time_in_state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001477
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001478 RunCommand("PROCESSES AND THREADS",
Yohei Yukawa591a72d2017-10-05 21:36:35 -07001479 {"ps", "-A", "-T", "-Z", "-O", "pri,nice,rtprio,sched,pcy,time"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001480
1481 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "LIBRANK", {"librank"},
1482 CommandOptions::AS_ROOT);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001483
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001484 DumpHals();
Steven Moreland81b429e2017-01-31 19:50:46 -08001485
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001486 RunCommand("PRINTENV", {"printenv"});
Elliott Hughes21b7c8d2016-10-28 08:53:02 -07001487 RunCommand("NETSTAT", {"netstat", "-nW"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001488 struct stat s;
1489 if (stat("/proc/modules", &s) != 0) {
1490 MYLOGD("Skipping 'lsmod' because /proc/modules does not exist\n");
1491 } else {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001492 RunCommand("LSMOD", {"lsmod"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001493 }
Michal Karpinski4db754f2015-12-11 18:04:32 +00001494
Tom Cherryb87dbfa2020-07-28 11:28:53 -07001495 if (android::base::GetBoolProperty("ro.logd.kernel", false)) {
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001496 DoKernelLogcat();
1497 } else {
1498 do_dmesg();
1499 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001500
Felipe Lemef0292972016-11-22 13:57:05 -08001501 RunCommand("LIST OF OPEN FILES", {"lsof"}, CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001502
1503 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(for_each_pid, do_showmap, "SMAPS OF ALL PROCESSES");
1504
Jeff Brown1dc94e32014-09-11 14:15:27 -07001505 for_each_tid(show_wchan, "BLOCKED PROCESS WAIT-CHANNELS");
Mark Salyzyna297c322016-02-05 15:33:17 -08001506 for_each_pid(show_showtime, "PROCESS TIMES (pid cmd user system iowait+percentage)");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001507
Ajay Panicker2ff8e872017-04-27 14:04:32 -07001508 /* Dump Bluetooth HCI logs */
1509 ds.AddDir("/data/misc/bluetooth/logs", true);
Jack Yu5a6b2e22020-08-14 18:13:35 +08001510 /* Dump Nfc NCI logs */
1511 ds.AddDir("/data/misc/nfc/logs", true);
Ajay Panickerd886ec42016-09-14 12:26:46 -07001512
Paul Chang0d2aad72020-02-13 20:04:03 +08001513 if (ds.options_->do_screenshot && !ds.do_early_screenshot_) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001514 MYLOGI("taking late screenshot\n");
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001515 ds.TakeScreenshot();
Jeff Sharkey5a930032013-03-19 15:05:19 -07001516 }
1517
Felipe Lemee184f662016-10-27 10:04:47 -07001518 AddAnrTraceFiles();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001519
Narayan Kamath8f788292017-05-25 13:20:39 +01001520 // NOTE: tombstones are always added as separate entries in the zip archive
1521 // and are not interspersed with the main report.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001522 const bool tombstones_dumped = AddDumps(ds.tombstone_data_.begin(), ds.tombstone_data_.end(),
Narayan Kamathbd863722017-06-01 18:50:12 +01001523 "TOMBSTONE", true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001524 if (!tombstones_dumped) {
1525 printf("*** NO TOMBSTONES to dump in %s\n\n", TOMBSTONE_DIR.c_str());
Christopher Ferris7dc7f322014-07-22 16:08:19 -07001526 }
1527
Jayachandran Ca94c7172017-06-10 15:08:12 -07001528 DumpPacketStats();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001529
Chenbo Feng276a3b62018-08-07 11:44:49 -07001530 RunDumpsys("EBPF MAP STATS", {"netd", "trafficcontroller"});
1531
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001532 DoKmsg();
Mark Salyzyn2262c162014-12-16 09:09:26 -08001533
Jayachandran Ca94c7172017-06-10 15:08:12 -07001534 DumpIpAddrAndRules();
Sreeram Ramachandran2b3bba32014-07-08 15:40:55 -07001535
1536 dump_route_tables();
1537
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001538 RunCommand("ARP CACHE", {"ip", "-4", "neigh", "show"});
1539 RunCommand("IPv6 ND CACHE", {"ip", "-6", "neigh", "show"});
1540 RunCommand("MULTICAST ADDRESSES", {"ip", "maddr"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001541
Nandana Dutt5c390032019-03-12 10:52:56 +00001542 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysHigh);
Lorenzo Colitti6afc38c2015-09-09 22:59:25 +09001543
Elliott Hughes23ccc622017-02-28 10:14:22 -08001544 RunCommand("SYSTEM PROPERTIES", {"getprop"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001545
Jin Qianf334d662017-10-10 14:41:37 -07001546 RunCommand("STORAGED IO INFO", {"storaged", "-u", "-p"});
ynwangf649a6e2016-07-17 21:56:00 -07001547
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001548 RunCommand("FILESYSTEMS & FREE SPACE", {"df"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001549
Colin Crossf45fa6b2012-03-26 12:38:26 -07001550 /* Binder state is expensive to look at as it uses a lot of memory. */
Hridya Valsaraju920ba712020-02-09 16:27:01 -08001551 std::string binder_logs_dir = access("/dev/binderfs/binder_logs", R_OK) ?
1552 "/sys/kernel/debug/binder" : "/dev/binderfs/binder_logs";
1553
1554 DumpFile("BINDER FAILED TRANSACTION LOG", binder_logs_dir + "/failed_transaction_log");
1555 DumpFile("BINDER TRANSACTION LOG", binder_logs_dir + "/transaction_log");
1556 DumpFile("BINDER TRANSACTIONS", binder_logs_dir + "/transactions");
1557 DumpFile("BINDER STATS", binder_logs_dir + "/stats");
1558 DumpFile("BINDER STATE", binder_logs_dir + "/state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001559
Vishnu Nair36b4cdb2017-11-17 10:27:05 -08001560 /* Add window and surface trace files. */
1561 if (!PropertiesHelper::IsUserBuild()) {
1562 ds.AddDir(WMTRACE_DATA_DIR, false);
1563 }
1564
Yifan Hongcba0a4f2020-02-08 16:52:02 -08001565 ds.AddDir(SNAPSHOTCTL_LOG_DIR, false);
1566
Nandana Dutt5c390032019-03-12 10:52:56 +00001567 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(ds.DumpstateBoard);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001568
Steven Moreland7440ddb2016-12-15 16:13:39 -08001569 /* Migrate the ril_dumpstate to a device specific dumpstate? */
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001570 int rilDumpstateTimeout = android::base::GetIntProperty("ril.dumpstate.timeout", 0);
1571 if (rilDumpstateTimeout > 0) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001572 // su does not exist on user builds, so try running without it.
1573 // This way any implementations of vril-dump that do not require
1574 // root can run on user builds.
1575 CommandOptions::CommandOptionsBuilder options =
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001576 CommandOptions::WithTimeout(rilDumpstateTimeout);
Felipe Lemef0292972016-11-22 13:57:05 -08001577 if (!PropertiesHelper::IsUserBuild()) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001578 options.AsRoot();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001579 }
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001580 RunCommand("DUMP VENDOR RIL LOGS", {"vril-dump"}, options.Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -07001581 }
1582
Felipe Lemed8b94e52016-12-08 10:21:44 -08001583 printf("========================================================\n");
1584 printf("== Android Framework Services\n");
1585 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001586
Nandana Dutt5c390032019-03-12 10:52:56 +00001587 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysNormal);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001588
Felipe Lemed8b94e52016-12-08 10:21:44 -08001589 printf("========================================================\n");
1590 printf("== Checkins\n");
1591 printf("========================================================\n");
Dianne Hackborn02bea972013-06-26 18:59:09 -07001592
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001593 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001594
1595 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsys, "CHECKIN MEMINFO", {"meminfo", "--checkin"});
1596
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001597 RunDumpsys("CHECKIN NETSTATS", {"netstats", "--checkin"});
1598 RunDumpsys("CHECKIN PROCSTATS", {"procstats", "-c"});
1599 RunDumpsys("CHECKIN USAGESTATS", {"usagestats", "-c"});
1600 RunDumpsys("CHECKIN PACKAGE", {"package", "--checkin"});
Dianne Hackborn02bea972013-06-26 18:59:09 -07001601
Felipe Lemed8b94e52016-12-08 10:21:44 -08001602 printf("========================================================\n");
1603 printf("== Running Application Activities\n");
1604 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001605
Makoto Onuki60780982018-04-16 15:34:00 -07001606 // The following dumpsys internally collects output from running apps, so it can take a long
1607 // time. So let's extend the timeout.
1608
1609 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
1610
1611 RunDumpsys("APP ACTIVITIES", {"activity", "-v", "all"}, DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001612
Felipe Lemed8b94e52016-12-08 10:21:44 -08001613 printf("========================================================\n");
Makoto Onuki60780982018-04-16 15:34:00 -07001614 printf("== Running Application Services (platform)\n");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001615 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001616
Vishnu Nairc6e6ea72018-07-02 14:20:06 -07001617 RunDumpsys("APP SERVICES PLATFORM", {"activity", "service", "all-platform-non-critical"},
Makoto Onuki60780982018-04-16 15:34:00 -07001618 DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001619
Felipe Lemed8b94e52016-12-08 10:21:44 -08001620 printf("========================================================\n");
Makoto Onuki60780982018-04-16 15:34:00 -07001621 printf("== Running Application Services (non-platform)\n");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001622 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001623
Makoto Onuki60780982018-04-16 15:34:00 -07001624 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1625 DUMPSYS_COMPONENTS_OPTIONS);
1626
1627 printf("========================================================\n");
1628 printf("== Running Application Providers (platform)\n");
1629 printf("========================================================\n");
1630
1631 RunDumpsys("APP PROVIDERS PLATFORM", {"activity", "provider", "all-platform"},
1632 DUMPSYS_COMPONENTS_OPTIONS);
1633
1634 printf("========================================================\n");
1635 printf("== Running Application Providers (non-platform)\n");
1636 printf("========================================================\n");
1637
1638 RunDumpsys("APP PROVIDERS NON-PLATFORM", {"activity", "provider", "all-non-platform"},
1639 DUMPSYS_COMPONENTS_OPTIONS);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001640
Adrian Roos8b397ab2017-04-04 16:35:44 -07001641 printf("========================================================\n");
1642 printf("== Dropbox crashes\n");
1643 printf("========================================================\n");
1644
1645 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1646 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1647
Felipe Lemed8b94e52016-12-08 10:21:44 -08001648 printf("========================================================\n");
1649 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1650 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1651 printf("========================================================\n");
1652 printf("== dumpstate: done (id %d)\n", ds.id_);
1653 printf("========================================================\n");
Bookatz38472142018-09-28 10:20:24 -07001654
1655 printf("========================================================\n");
1656 printf("== Obtaining statsd metadata\n");
1657 printf("========================================================\n");
1658 // This differs from the usual dumpsys stats, which is the stats report data.
1659 RunDumpsys("STATSDSTATS", {"stats", "--metadata"});
Mike Ma5c267872019-08-21 11:31:34 -07001660
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +09001661 // Add linker configuration directory
1662 ds.AddDir(LINKERCONFIG_DIR, true);
1663
Mike Ma5c267872019-08-21 11:31:34 -07001664 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpIncidentReport);
1665
Nandana Dutt5c390032019-03-12 10:52:56 +00001666 return Dumpstate::RunStatus::OK;
Colin Crossf45fa6b2012-03-26 12:38:26 -07001667}
1668
Nandana Dutt5c390032019-03-12 10:52:56 +00001669/*
1670 * Dumps state for the default case; drops root after it's no longer necessary.
1671 *
1672 * Returns RunStatus::OK if everything went fine.
1673 * Returns RunStatus::ERROR if there was an error.
1674 * Returns RunStatus::USER_DENIED_CONSENT if user explicitly denied consent to sharing the bugreport
1675 * with the caller.
1676 */
Jichao Lie89d9c12019-11-21 19:02:51 -08001677Dumpstate::RunStatus Dumpstate::DumpstateDefaultAfterCritical() {
Nandana Duttdb379fa2019-10-09 16:54:41 +01001678 // Capture first logcat early on; useful to take a snapshot before dumpstate logs take over the
1679 // buffer.
1680 DoLogcat();
1681 // Capture timestamp after first logcat to use in next logcat
1682 time_t logcat_ts = time(nullptr);
1683
Nandana Dutt4be45d12018-09-26 15:04:23 +01001684 /* collect stack traces from Dalvik and native processes (needs root) */
Nandana Duttcf419a72019-03-14 10:40:17 +00001685 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(ds.DumpTraces, &dump_traces_path);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001686
1687 /* Run some operations that require root. */
1688 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX, !ds.IsZipping());
1689 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX, !ds.IsZipping());
1690
1691 ds.AddDir(RECOVERY_DIR, true);
1692 ds.AddDir(RECOVERY_DATA_DIR, true);
1693 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
1694 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1695 if (!PropertiesHelper::IsUserBuild()) {
1696 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1697 ds.AddDir(PROFILE_DATA_DIR_REF, true);
Calin Juravle78a0d842020-04-28 15:31:12 -07001698 ds.AddZipEntry(ZIP_ROOT_DIR + PACKAGE_DEX_USE_LIST, PACKAGE_DEX_USE_LIST);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001699 }
Jerry Changa1df8a92020-01-02 16:03:39 +08001700 ds.AddDir(PREREBOOT_DATA_DIR, false);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001701 add_mountinfo();
1702 DumpIpTablesAsRoot();
David Andersond9ba4752018-12-11 18:26:59 -08001703 DumpDynamicPartitionInfo();
Yifan Hong3945e1b2019-10-29 12:59:23 -07001704 ds.AddDir(OTA_METADATA_DIR, true);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001705
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001706 // Capture any IPSec policies in play. No keys are exposed here.
Nandana Dutt4be45d12018-09-26 15:04:23 +01001707 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1708
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001709 // Dump IPsec stats. No keys are exposed here.
1710 DumpFile("XFRM STATS", XFRM_STAT_PROC_FILE);
1711
Nandana Dutt4be45d12018-09-26 15:04:23 +01001712 // Run ss as root so we can see socket marks.
1713 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
1714
1715 // Run iotop as root to show top 100 IO threads
1716 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
1717
Erick Reyese68df822019-02-11 14:46:36 -08001718 // Gather shared memory buffer info if the product implements it
1719 struct stat st;
1720 if (!stat("/product/bin/dmabuf_dump", &st)) {
1721 RunCommand("Dmabuf dump", {"/product/bin/dmabuf_dump"});
1722 }
1723
Minchan Kim22c6a1e2019-09-30 15:58:10 -07001724 DumpFile("PSI cpu", "/proc/pressure/cpu");
1725 DumpFile("PSI memory", "/proc/pressure/memory");
1726 DumpFile("PSI io", "/proc/pressure/io");
1727
Nandana Dutt4be45d12018-09-26 15:04:23 +01001728 if (!DropRootUser()) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001729 return Dumpstate::RunStatus::ERROR;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001730 }
1731
Nandana Dutt5c390032019-03-12 10:52:56 +00001732 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttdb379fa2019-10-09 16:54:41 +01001733 Dumpstate::RunStatus status = dumpstate();
1734 // Capture logcat since the last time we did it.
1735 DoSystemLogcat(logcat_ts);
1736 return status;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001737}
1738
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001739// This method collects common dumpsys for telephony and wifi. Typically, wifi
1740// reports are fine to include all information, but telephony reports on user
1741// builds need to strip some content (see DumpstateTelephonyOnly).
1742static void DumpstateRadioCommon(bool include_sensitive_info = true) {
Jayachandran Ca94c7172017-06-10 15:08:12 -07001743 DumpIpTablesAsRoot();
1744
Jayachandran C69968272019-07-08 09:46:05 -07001745 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1746
Jayachandran Ca94c7172017-06-10 15:08:12 -07001747 if (!DropRootUser()) {
1748 return;
1749 }
1750
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001751 // We need to be picky about some stuff for telephony reports on user builds.
1752 if (!include_sensitive_info) {
1753 // Only dump the radio log buffer (other buffers and dumps contain too much unrelated info).
1754 DoRadioLogcat();
1755 } else {
1756 // Contains various system properties and process startup info.
1757 do_dmesg();
1758 // Logs other than the radio buffer may contain package/component names and potential PII.
1759 DoLogcat();
1760 // Too broad for connectivity problems.
1761 DoKmsg();
1762 // Contains unrelated hardware info (camera, NFC, biometrics, ...).
1763 DumpHals();
1764 }
1765
Jayachandran Ca94c7172017-06-10 15:08:12 -07001766 DumpPacketStats();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001767 DumpIpAddrAndRules();
1768 dump_route_tables();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001769 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
1770 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08001771}
1772
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001773// We use "telephony" here for legacy reasons, though this now really means "connectivity" (cellular
1774// + wifi + networking). This method collects dumpsys for connectivity debugging only. General rules
1775// for what can be included on user builds: all reported information MUST directly relate to
1776// connectivity debugging or customer support and MUST NOT contain unrelated personally identifiable
1777// information. This information MUST NOT identify user-installed packages (UIDs are OK, package
1778// names are not), and MUST NOT contain logs of user application traffic.
1779// TODO(b/148168577) rename this and other related fields/methods to "connectivity" instead.
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08001780static void DumpstateTelephonyOnly(const std::string& calling_package) {
mukesh agrawal253dad42018-01-23 21:59:59 -08001781 DurationReporter duration_reporter("DUMPSTATE");
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001782
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001783 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08001784
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001785 const bool include_sensitive_info = !PropertiesHelper::IsUserBuild();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001786
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001787 DumpstateRadioCommon(include_sensitive_info);
1788
1789 if (include_sensitive_info) {
1790 // Contains too much unrelated PII, and given the unstructured nature of sysprops, we can't
1791 // really cherrypick all of the connectivity-related ones. Apps generally have no business
1792 // reading these anyway, and there should be APIs to supply the info in a more app-friendly
1793 // way.
1794 RunCommand("SYSTEM PROPERTIES", {"getprop"});
1795 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07001796
1797 printf("========================================================\n");
1798 printf("== Android Framework Services\n");
1799 printf("========================================================\n");
1800
Vishnu Nair652cc802017-11-30 15:18:30 -08001801 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1802 SEC_TO_MSEC(10));
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08001803 if (include_sensitive_info) {
1804 // Carrier apps' services will be dumped below in dumpsys activity service all-non-platform.
1805 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
1806 SEC_TO_MSEC(10));
1807 } else {
1808 // If the caller is a carrier app and has a carrier service, dump it here since we aren't
1809 // running dumpsys activity service all-non-platform below. Due to the increased output, we
1810 // give a higher timeout as well.
1811 RunDumpsys("DUMPSYS", {"carrier_config", "--requesting-package", calling_package},
1812 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(30));
1813 }
1814 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001815 RunDumpsys("DUMPSYS", {"netpolicy"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
1816 RunDumpsys("DUMPSYS", {"network_management"}, CommandOptions::WithTimeout(90).Build(),
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07001817 SEC_TO_MSEC(10));
Hunter Knepshield0fe51b12020-03-05 16:58:20 -08001818 RunDumpsys("DUMPSYS", {"telephony.registry"}, CommandOptions::WithTimeout(90).Build(),
1819 SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001820 if (include_sensitive_info) {
1821 // Contains raw IP addresses, omit from reports on user builds.
1822 RunDumpsys("DUMPSYS", {"netd"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
1823 // Contains raw destination IP/MAC addresses, omit from reports on user builds.
1824 RunDumpsys("DUMPSYS", {"connmetrics"}, CommandOptions::WithTimeout(90).Build(),
1825 SEC_TO_MSEC(10));
1826 // Contains package/component names, omit from reports on user builds.
1827 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
1828 SEC_TO_MSEC(10));
1829 // Contains package names, but should be relatively simple to remove them (also contains
1830 // UIDs already), omit from reports on user builds.
1831 RunDumpsys("BATTERYSTATS", {"deviceidle"}, CommandOptions::WithTimeout(90).Build(),
1832 SEC_TO_MSEC(10));
1833 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07001834
1835 printf("========================================================\n");
1836 printf("== Running Application Services\n");
1837 printf("========================================================\n");
1838
1839 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
1840
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001841 if (include_sensitive_info) {
1842 printf("========================================================\n");
1843 printf("== Running Application Services (non-platform)\n");
1844 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001845
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001846 // Contains package/component names and potential PII, omit from reports on user builds.
1847 // To get dumps of the active CarrierService(s) on user builds, we supply an argument to the
1848 // carrier_config dumpsys instead.
1849 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1850 DUMPSYS_COMPONENTS_OPTIONS);
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001851
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001852 printf("========================================================\n");
1853 printf("== Checkins\n");
1854 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07001855
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001856 // Contains package/component names, omit from reports on user builds.
1857 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
1858 }
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07001859
1860 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07001861 printf("== dumpstate: done (id %d)\n", ds.id_);
1862 printf("========================================================\n");
1863}
1864
mukesh agrawal253dad42018-01-23 21:59:59 -08001865// This method collects dumpsys for wifi debugging only
1866static void DumpstateWifiOnly() {
1867 DurationReporter duration_reporter("DUMPSTATE");
1868
1869 DumpstateRadioCommon();
1870
1871 printf("========================================================\n");
1872 printf("== Android Framework Services\n");
1873 printf("========================================================\n");
1874
1875 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1876 SEC_TO_MSEC(10));
1877 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
1878 SEC_TO_MSEC(10));
1879
1880 printf("========================================================\n");
1881 printf("== dumpstate: done (id %d)\n", ds.id_);
1882 printf("========================================================\n");
1883}
1884
Nandana Duttcf419a72019-03-14 10:40:17 +00001885Dumpstate::RunStatus Dumpstate::DumpTraces(const char** path) {
Nandana Duttfaafd522019-03-11 09:23:09 +00001886 DurationReporter duration_reporter("DUMP TRACES");
1887
1888 const std::string temp_file_pattern = "/data/anr/dumptrace_XXXXXX";
1889 const size_t buf_size = temp_file_pattern.length() + 1;
1890 std::unique_ptr<char[]> file_name_buf(new char[buf_size]);
1891 memcpy(file_name_buf.get(), temp_file_pattern.c_str(), buf_size);
1892
1893 // Create a new, empty file to receive all trace dumps.
1894 //
1895 // TODO: This can be simplified once we remove support for the old style
1896 // dumps. We can have a file descriptor passed in to dump_traces instead
1897 // of creating a file, closing it and then reopening it again.
1898 android::base::unique_fd fd(mkostemp(file_name_buf.get(), O_APPEND | O_CLOEXEC));
1899 if (fd < 0) {
1900 MYLOGE("mkostemp on pattern %s: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001901 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001902 }
1903
1904 // Nobody should have access to this temporary file except dumpstate, but we
1905 // temporarily grant 'read' to 'others' here because this file is created
1906 // when tombstoned is still running as root, but dumped after dropping. This
1907 // can go away once support for old style dumping has.
1908 const int chmod_ret = fchmod(fd, 0666);
1909 if (chmod_ret < 0) {
1910 MYLOGE("fchmod on %s failed: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001911 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001912 }
1913
1914 std::unique_ptr<DIR, decltype(&closedir)> proc(opendir("/proc"), closedir);
1915 if (proc.get() == nullptr) {
1916 MYLOGE("opendir /proc failed: %s\n", strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00001917 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001918 }
1919
1920 // Number of times process dumping has timed out. If we encounter too many
1921 // failures, we'll give up.
1922 int timeout_failures = 0;
1923 bool dalvik_found = false;
1924
1925 const std::set<int> hal_pids = get_interesting_hal_pids();
1926
1927 struct dirent* d;
1928 while ((d = readdir(proc.get()))) {
Nandana Duttcf419a72019-03-14 10:40:17 +00001929 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttfaafd522019-03-11 09:23:09 +00001930 int pid = atoi(d->d_name);
1931 if (pid <= 0) {
1932 continue;
1933 }
1934
1935 const std::string link_name = android::base::StringPrintf("/proc/%d/exe", pid);
1936 std::string exe;
1937 if (!android::base::Readlink(link_name, &exe)) {
1938 continue;
1939 }
1940
1941 bool is_java_process;
1942 if (exe == "/system/bin/app_process32" || exe == "/system/bin/app_process64") {
1943 // Don't bother dumping backtraces for the zygote.
1944 if (IsZygote(pid)) {
1945 continue;
1946 }
1947
1948 dalvik_found = true;
1949 is_java_process = true;
1950 } else if (should_dump_native_traces(exe.c_str()) || hal_pids.find(pid) != hal_pids.end()) {
1951 is_java_process = false;
1952 } else {
1953 // Probably a native process we don't care about, continue.
1954 continue;
1955 }
1956
1957 // If 3 backtrace dumps fail in a row, consider debuggerd dead.
1958 if (timeout_failures == 3) {
1959 dprintf(fd, "ERROR: Too many stack dump failures, exiting.\n");
1960 break;
1961 }
1962
1963 const uint64_t start = Nanotime();
1964 const int ret = dump_backtrace_to_file_timeout(
1965 pid, is_java_process ? kDebuggerdJavaBacktrace : kDebuggerdNativeBacktrace,
1966 is_java_process ? 5 : 20, fd);
1967
1968 if (ret == -1) {
1969 // For consistency, the header and footer to this message match those
1970 // dumped by debuggerd in the success case.
1971 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
1972 dprintf(fd, "Dump failed, likely due to a timeout.\n");
1973 dprintf(fd, "---- end %d ----", pid);
1974 timeout_failures++;
1975 continue;
1976 }
1977
1978 // We've successfully dumped stack traces, reset the failure count
1979 // and write a summary of the elapsed time to the file and continue with the
1980 // next process.
1981 timeout_failures = 0;
1982
1983 dprintf(fd, "[dump %s stack %d: %.3fs elapsed]\n", is_java_process ? "dalvik" : "native",
1984 pid, (float)(Nanotime() - start) / NANOS_PER_SEC);
1985 }
1986
1987 if (!dalvik_found) {
1988 MYLOGE("Warning: no Dalvik processes found to dump stacks\n");
1989 }
1990
Nandana Duttcf419a72019-03-14 10:40:17 +00001991 *path = file_name_buf.release();
1992 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00001993}
1994
Felipe Leme6f674ae2016-11-18 17:10:33 -08001995void Dumpstate::DumpstateBoard() {
1996 DurationReporter duration_reporter("dumpstate_board()");
Felipe Lemed8b94e52016-12-08 10:21:44 -08001997 printf("========================================================\n");
1998 printf("== Board\n");
1999 printf("========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08002000
Felipe Leme6f674ae2016-11-18 17:10:33 -08002001 if (!IsZipping()) {
Steven Moreland7440ddb2016-12-15 16:13:39 -08002002 MYLOGD("Not dumping board info because it's not a zipped bugreport\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08002003 return;
2004 }
2005
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002006 std::vector<std::string> paths;
2007 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07002008 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002009 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
2010 kDumpstateBoardFiles[i].c_str()));
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002011 remover.emplace_back(android::base::make_scope_guard(
2012 std::bind([](std::string path) { android::os::UnlinkAndLogOnError(path); }, paths[i])));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002013 }
Jie Song9fbfad02017-06-20 16:29:42 -07002014
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002015 sp<IDumpstateDevice_1_0> dumpstate_device_1_0(IDumpstateDevice_1_0::getService());
2016 if (dumpstate_device_1_0 == nullptr) {
Wei Wang587eac92018-04-05 12:17:20 -07002017 MYLOGE("No IDumpstateDevice implementation\n");
2018 return;
2019 }
2020
2021 using ScopedNativeHandle =
2022 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
2023 ScopedNativeHandle handle(native_handle_create(static_cast<int>(paths.size()), 0),
2024 [](native_handle_t* handle) {
2025 native_handle_close(handle);
2026 native_handle_delete(handle);
2027 });
2028 if (handle == nullptr) {
2029 MYLOGE("Could not create native_handle\n");
2030 return;
2031 }
2032
Nandana Dutt5c390032019-03-12 10:52:56 +00002033 // TODO(128270426): Check for consent in between?
Wei Wang587eac92018-04-05 12:17:20 -07002034 for (size_t i = 0; i < paths.size(); i++) {
2035 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
2036
2037 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
2038 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
2039 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
2040 if (fd < 0) {
2041 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
2042 return;
2043 }
2044 handle.get()->data[i] = fd.release();
2045 }
2046
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002047 // Given that bugreport is required to diagnose failures, it's better to set an arbitrary amount
2048 // of timeout for IDumpstateDevice than to block the rest of bugreport. In the timeout case, we
2049 // will kill the HAL and grab whatever it dumped in time.
2050 constexpr size_t timeout_sec = 30;
2051 // Prefer version 1.1 if available. New devices launching with R are no longer allowed to
2052 // implement just 1.0.
2053 const char* descriptor_to_kill;
2054 using DumpstateBoardTask = std::packaged_task<bool()>;
2055 DumpstateBoardTask dumpstate_board_task;
2056 sp<IDumpstateDevice_1_1> dumpstate_device_1_1(
2057 IDumpstateDevice_1_1::castFrom(dumpstate_device_1_0));
2058 if (dumpstate_device_1_1 != nullptr) {
2059 MYLOGI("Using IDumpstateDevice v1.1");
2060 descriptor_to_kill = IDumpstateDevice_1_1::descriptor;
2061 dumpstate_board_task = DumpstateBoardTask([this, dumpstate_device_1_1, &handle]() -> bool {
2062 ::android::hardware::Return<DumpstateStatus> status =
2063 dumpstate_device_1_1->dumpstateBoard_1_1(handle.get(), options_->dumpstate_hal_mode,
2064 SEC_TO_MSEC(timeout_sec));
2065 if (!status.isOk()) {
2066 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2067 return false;
2068 } else if (status != DumpstateStatus::OK) {
2069 MYLOGE("dumpstateBoard failed with DumpstateStatus::%s\n", toString(status).c_str());
2070 return false;
2071 }
2072 return true;
2073 });
2074 } else {
2075 MYLOGI("Using IDumpstateDevice v1.0");
2076 descriptor_to_kill = IDumpstateDevice_1_0::descriptor;
2077 dumpstate_board_task = DumpstateBoardTask([dumpstate_device_1_0, &handle]() -> bool {
2078 ::android::hardware::Return<void> status =
2079 dumpstate_device_1_0->dumpstateBoard(handle.get());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002080 if (!status.isOk()) {
2081 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
Wei Wang587eac92018-04-05 12:17:20 -07002082 return false;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002083 }
Wei Wang587eac92018-04-05 12:17:20 -07002084 return true;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002085 });
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002086 }
2087 auto result = dumpstate_board_task.get_future();
2088 std::thread(std::move(dumpstate_board_task)).detach();
Wei Wang587eac92018-04-05 12:17:20 -07002089
Wei Wang587eac92018-04-05 12:17:20 -07002090 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2091 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate vendor HAL\n", timeout_sec);
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002092 if (!android::base::SetProperty(
2093 "ctl.interface_restart",
2094 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
Wei Wang587eac92018-04-05 12:17:20 -07002095 MYLOGE("Couldn't restart dumpstate HAL\n");
2096 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002097 }
Wei Wang587eac92018-04-05 12:17:20 -07002098 // Wait some time for init to kill dumpstate vendor HAL
2099 constexpr size_t killing_timeout_sec = 10;
2100 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2101 MYLOGE("killing dumpstateBoard timed out after %zus, continue and "
2102 "there might be racing in content\n", killing_timeout_sec);
2103 }
2104
2105 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
2106 for (size_t i = 0; i < paths.size(); i++) {
2107 struct stat s;
2108 if (fstat(handle.get()->data[i], &s) == -1) {
2109 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(),
2110 strerror(errno));
2111 file_sizes[i] = -1;
2112 continue;
2113 }
2114 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002115 }
2116
2117 for (size_t i = 0; i < paths.size(); i++) {
2118 if (file_sizes[i] == -1) {
2119 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002120 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002121 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07002122 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002123 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002124 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002125 AddZipEntry(kDumpstateBoardFiles[i], paths[i]);
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002126 printf("*** See %s entry ***\n", kDumpstateBoardFiles[i].c_str());
Jie Song9fbfad02017-06-20 16:29:42 -07002127 }
Felipe Leme6f674ae2016-11-18 17:10:33 -08002128}
2129
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002130static void ShowUsage() {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002131 fprintf(stderr,
mhasank2d75c442020-06-11 15:05:25 -07002132 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-o directory] [-d] [-p] "
mhasankd451a472020-05-26 18:02:39 -07002133 "[-z] [-s] [-S] [-q] [-P] [-R] [-L] [-V version]\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002134 " -h: display this help message\n"
2135 " -b: play sound file instead of vibrate, at beginning of job\n"
2136 " -e: play sound file instead of vibrate, at end of job\n"
mhasank2d75c442020-06-11 15:05:25 -07002137 " -o: write to custom directory (only in limited mode)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01002138 " -d: append date to filename\n"
2139 " -p: capture screenshot to filename.png\n"
2140 " -z: generate zipped file\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002141 " -s: write output to control socket (for init)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01002142 " -S: write file location to control socket (for init; requires -z)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002143 " -q: disable vibrate\n"
Abhijeet Kaure370d682019-10-01 16:49:30 +01002144 " -P: send broadcast when started and do progress updates\n"
2145 " -R: take bugreport in remote mode (requires -z and -d, shouldn't be used with -P)\n"
Nandana Dutt235864b2019-01-22 12:10:16 +00002146 " -w: start binder service and make it wait for a call to startBugreport\n"
mhasankd451a472020-05-26 18:02:39 -07002147 " -L: output limited information that is safe for submission in feedback reports\n"
Felipe Lemed071c682016-10-20 16:48:00 -07002148 " -v: prints the dumpstate header and exit\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002149}
2150
Wei Liuf87959e2016-08-26 14:51:42 -07002151static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07002152 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07002153}
2154
Felipe Leme1d486fe2016-10-14 18:06:47 -07002155bool Dumpstate::FinishZipFile() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07002156 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07002157 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07002158 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002159 // Final timestamp
2160 char date[80];
2161 time_t the_real_now_please_stand_up = time(nullptr);
2162 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002163 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07002164 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002165
Felipe Leme9a523ae2016-10-20 15:10:33 -07002166 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002167 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08002168 return false;
2169 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07002170 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002171 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08002172 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08002173 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08002174
Felipe Leme0f3fb202016-06-10 17:10:53 -07002175 // Add log file (which contains stderr output) to zip...
2176 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07002177 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07002178 MYLOGE("Failed to add dumpstate log to .zip file\n");
2179 return false;
2180 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002181 // TODO: Should truncate the existing file.
2182 // ... and re-open it for further logging.
Nandana Dutta344cb62019-02-22 15:12:35 +00002183 if (!redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()))) {
2184 return false;
2185 }
Felipe Leme0f3fb202016-06-10 17:10:53 -07002186 fprintf(stderr, "\n");
2187
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002188 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07002189 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002190 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002191 return false;
2192 }
2193
Felipe Leme1d486fe2016-10-14 18:06:47 -07002194 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
2195 ds.zip_file.reset(nullptr);
2196
Felipe Lemee9d2c542016-11-15 11:48:26 -08002197 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002198 android::os::UnlinkAndLogOnError(tmp_path_);
Felipe Lemec4eee562016-04-21 15:42:55 -07002199
Felipe Leme1e9edc62015-12-21 16:02:13 -08002200 return true;
2201}
Felipe Leme6e01fa62015-11-11 19:35:14 -08002202
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002203static void SendBroadcast(const std::string& action, const std::vector<std::string>& args) {
2204 // clang-format off
2205 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user", "0",
2206 "--receiver-foreground", "--receiver-include-background", "-a", action};
2207 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08002208
2209 am.insert(am.end(), args.begin(), args.end());
2210
Felipe Leme8d2410e2017-02-08 09:46:08 -08002211 RunCommand("", am,
2212 CommandOptions::WithTimeout(20)
2213 .Log("Sending broadcast: '%s'\n")
2214 .Always()
2215 .DropRoot()
2216 .RedirectStderr()
2217 .Build());
2218}
2219
Felipe Leme35b8cf12017-02-10 15:47:29 -08002220static void Vibrate(int duration_ms) {
2221 // clang-format off
Chris Fries0c3de872019-09-14 15:49:41 +00002222 RunCommand("", {"cmd", "vibrator", "vibrate", "-f", std::to_string(duration_ms), "dumpstate"},
Felipe Leme35b8cf12017-02-10 15:47:29 -08002223 CommandOptions::WithTimeout(10)
2224 .Log("Vibrate: '%s'\n")
2225 .Always()
2226 .Build());
2227 // clang-format on
2228}
2229
Nandana Dutt979388e2018-11-30 16:48:55 +00002230static void MaybeResolveSymlink(std::string* path) {
2231 std::string resolved_path;
2232 if (android::base::Readlink(*path, &resolved_path)) {
2233 *path = resolved_path;
2234 }
2235}
2236
Nandana Dutt4be45d12018-09-26 15:04:23 +01002237/*
2238 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
2239 * if we are writing zip files and adds the version file.
2240 */
2241static void PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002242 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
2243
Nandana Dutt4be45d12018-09-26 15:04:23 +01002244 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
2245 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002246 ds.base_name_ = StringPrintf("bugreport-%s-%s", device_name.c_str(), build_id.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002247 if (ds.options_->do_add_date) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002248 char date[80];
2249 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
2250 ds.name_ = date;
2251 } else {
2252 ds.name_ = "undated";
2253 }
2254
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002255 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002256 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002257 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002258 ds.base_name_ += "-wifi";
2259 }
2260
Paul Chang0d2aad72020-02-13 20:04:03 +08002261 if (ds.options_->do_screenshot) {
Nandana Dutt9d17b942020-03-26 10:02:59 +00002262 ds.screenshot_path_ = ds.GetPath(ds.CalledByApi() ? "-png.tmp" : ".png");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002263 }
2264 ds.tmp_path_ = ds.GetPath(".tmp");
2265 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
2266
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002267 std::string destination = ds.CalledByApi()
Nandana Dutt54dbd672019-01-11 12:58:05 +00002268 ? StringPrintf("[fd:%d]", ds.options_->bugreport_fd.get())
Nandana Dutt9a76d202019-01-21 15:56:48 +00002269 : ds.bugreport_internal_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01002270 MYLOGD(
Nandana Dutt235c6672019-11-14 15:22:32 +00002271 "Bugreport dir: [%s] "
2272 "Base name: [%s] "
2273 "Suffix: [%s] "
2274 "Log path: [%s] "
2275 "Temporary path: [%s] "
2276 "Screenshot path: [%s]\n",
Nandana Dutt9a76d202019-01-21 15:56:48 +00002277 destination.c_str(), ds.base_name_.c_str(), ds.name_.c_str(), ds.log_path_.c_str(),
2278 ds.tmp_path_.c_str(), ds.screenshot_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002279
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002280 if (ds.options_->do_zip_file) {
Nandana Dutt9d17b942020-03-26 10:02:59 +00002281 ds.path_ = ds.GetPath(ds.CalledByApi() ? "-zip.tmp" : ".zip");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002282 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
2283 create_parent_dirs(ds.path_.c_str());
2284 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
2285 if (ds.zip_file == nullptr) {
2286 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
2287 } else {
2288 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
2289 }
2290 ds.AddTextZipEntry("version.txt", ds.version_);
2291 }
2292}
2293
2294/*
Abhijeet Kaure370d682019-10-01 16:49:30 +01002295 * Finalizes writing to the file by zipping the tmp file to the final location,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002296 * printing zipped file status, etc.
2297 */
2298static void FinalizeFile() {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002299 bool do_text_file = true;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002300 if (ds.options_->do_zip_file) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002301 if (!ds.FinishZipFile()) {
2302 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
2303 do_text_file = true;
2304 } else {
2305 do_text_file = false;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002306 }
2307 }
mhasank2d75c442020-06-11 15:05:25 -07002308
2309 std::string final_path = ds.path_;
2310 if (ds.options_->OutputToCustomFile()) {
mhasank3a4cfb42020-06-15 18:06:43 -07002311 final_path = ds.GetPath(ds.options_->out_dir, ".zip");
mhasank2d75c442020-06-11 15:05:25 -07002312 android::os::CopyFileToFile(ds.path_, final_path);
Nandana Dutt4be45d12018-09-26 15:04:23 +01002313 }
mhasank2d75c442020-06-11 15:05:25 -07002314
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002315 if (ds.options_->use_control_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002316 if (do_text_file) {
2317 dprintf(ds.control_socket_fd_,
2318 "FAIL:could not create zip file, check %s "
2319 "for more details\n",
2320 ds.log_path_.c_str());
2321 } else {
mhasank2d75c442020-06-11 15:05:25 -07002322 dprintf(ds.control_socket_fd_, "OK:%s\n", final_path.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002323 }
2324 }
2325}
2326
Nandana Dutt4be45d12018-09-26 15:04:23 +01002327
Nandana Dutt58d72e22018-11-16 10:30:48 +00002328static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2329 switch (mode) {
2330 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2331 return "BUGREPORT_FULL";
2332 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2333 return "BUGREPORT_INTERACTIVE";
2334 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2335 return "BUGREPORT_REMOTE";
2336 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2337 return "BUGREPORT_WEAR";
2338 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2339 return "BUGREPORT_TELEPHONY";
2340 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2341 return "BUGREPORT_WIFI";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002342 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2343 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002344 }
2345}
2346
Paul Changf59c2b72020-03-10 02:08:55 +08002347static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options,
2348 bool is_screenshot_requested) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002349 // Modify com.android.shell.BugreportProgressService#isDefaultScreenshotRequired as well for
2350 // default system screenshots.
Abhijeet Kaure370d682019-10-01 16:49:30 +01002351 options->bugreport_mode = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002352 switch (mode) {
2353 case Dumpstate::BugreportMode::BUGREPORT_FULL:
Paul Changf59c2b72020-03-10 02:08:55 +08002354 options->do_screenshot = is_screenshot_requested;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002355 options->dumpstate_hal_mode = DumpstateMode::FULL;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002356 break;
2357 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002358 // Currently, the dumpstate binder is only used by Shell to update progress.
2359 options->do_start_service = true;
2360 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002361 options->do_screenshot = is_screenshot_requested;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002362 options->dumpstate_hal_mode = DumpstateMode::INTERACTIVE;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002363 break;
2364 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002365 options->do_vibrate = false;
2366 options->is_remote_mode = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002367 options->do_screenshot = false;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002368 options->dumpstate_hal_mode = DumpstateMode::REMOTE;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002369 break;
2370 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002371 options->do_start_service = true;
2372 options->do_progress_updates = true;
2373 options->do_zip_file = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002374 options->do_screenshot = is_screenshot_requested;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002375 options->dumpstate_hal_mode = DumpstateMode::WEAR;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002376 break;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002377 // TODO(b/148168577) rename TELEPHONY everywhere to CONNECTIVITY.
Nandana Dutt58d72e22018-11-16 10:30:48 +00002378 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002379 options->telephony_only = true;
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002380 options->do_progress_updates = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002381 options->do_screenshot = false;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002382 options->dumpstate_hal_mode = DumpstateMode::CONNECTIVITY;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002383 break;
2384 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002385 options->wifi_only = true;
2386 options->do_zip_file = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002387 options->do_screenshot = false;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002388 options->dumpstate_hal_mode = DumpstateMode::WIFI;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002389 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002390 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2391 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002392 }
2393}
2394
Nandana Dutt58d72e22018-11-16 10:30:48 +00002395static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
Nandana Dutt235c6672019-11-14 15:22:32 +00002396 MYLOGI(
Paul Chang0d2aad72020-02-13 20:04:03 +08002397 "do_zip_file: %d do_vibrate: %d use_socket: %d use_control_socket: %d do_screenshot: %d "
Nandana Dutt235c6672019-11-14 15:22:32 +00002398 "is_remote_mode: %d show_header_only: %d do_start_service: %d telephony_only: %d "
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002399 "wifi_only: %d do_progress_updates: %d fd: %d bugreport_mode: %s dumpstate_hal_mode: %s "
mhasankd451a472020-05-26 18:02:39 -07002400 "limited_only: %d args: %s\n",
Nandana Dutt235c6672019-11-14 15:22:32 +00002401 options.do_zip_file, options.do_vibrate, options.use_socket, options.use_control_socket,
Paul Chang0d2aad72020-02-13 20:04:03 +08002402 options.do_screenshot, options.is_remote_mode, options.show_header_only,
mhasankd451a472020-05-26 18:02:39 -07002403 options.do_start_service, options.telephony_only, options.wifi_only,
2404 options.do_progress_updates, options.bugreport_fd.get(), options.bugreport_mode.c_str(),
2405 toString(options.dumpstate_hal_mode).c_str(), options.limited_only, options.args.c_str());
Nandana Dutt58d72e22018-11-16 10:30:48 +00002406}
2407
Nandana Dutt54dbd672019-01-11 12:58:05 +00002408void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode,
2409 const android::base::unique_fd& bugreport_fd_in,
Paul Changf59c2b72020-03-10 02:08:55 +08002410 const android::base::unique_fd& screenshot_fd_in,
2411 bool is_screenshot_requested) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002412 // In the new API world, date is always added; output is always a zip file.
2413 // TODO(111441001): remove these options once they are obsolete.
2414 do_add_date = true;
2415 do_zip_file = true;
2416
Nandana Dutt54dbd672019-01-11 12:58:05 +00002417 // Duplicate the fds because the passed in fds don't outlive the binder transaction.
2418 bugreport_fd.reset(dup(bugreport_fd_in.get()));
2419 screenshot_fd.reset(dup(screenshot_fd_in.get()));
Nandana Dutt58d72e22018-11-16 10:30:48 +00002420
Paul Changf59c2b72020-03-10 02:08:55 +08002421 SetOptionsFromMode(bugreport_mode, this, is_screenshot_requested);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002422}
2423
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002424Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
2425 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002426 int c;
mhasankd451a472020-05-26 18:02:39 -07002427 while ((c = getopt(argc, argv, "dho:svqzpLPBRSV:w")) != -1) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002428 switch (c) {
2429 // clang-format off
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002430 case 'd': do_add_date = true; break;
2431 case 'z': do_zip_file = true; break;
mhasank3a4cfb42020-06-15 18:06:43 -07002432 case 'o': out_dir = optarg; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002433 case 's': use_socket = true; break;
2434 case 'S': use_control_socket = true; break;
2435 case 'v': show_header_only = true; break;
2436 case 'q': do_vibrate = false; break;
Paul Chang0d2aad72020-02-13 20:04:03 +08002437 case 'p': do_screenshot = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002438 case 'P': do_progress_updates = true; break;
2439 case 'R': is_remote_mode = true; break;
mhasankd451a472020-05-26 18:02:39 -07002440 case 'L': limited_only = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002441 case 'V': break; // compatibility no-op
Nandana Dutt235864b2019-01-22 12:10:16 +00002442 case 'w':
2443 // This was already processed
2444 break;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002445 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002446 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002447 break;
2448 default:
2449 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002450 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002451 break;
2452 // clang-format on
2453 }
2454 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08002455
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002456 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002457 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002458 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002459 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002460 }
2461 }
2462
2463 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
2464 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002465
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002466 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002467}
2468
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002469bool Dumpstate::DumpOptions::ValidateOptions() const {
Nandana Dutt54dbd672019-01-11 12:58:05 +00002470 if (bugreport_fd.get() != -1 && !do_zip_file) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002471 return false;
2472 }
2473
Abhijeet Kaure370d682019-10-01 16:49:30 +01002474 if ((do_zip_file || do_add_date || do_progress_updates) && !OutputToFile()) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002475 return false;
2476 }
2477
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002478 if (use_control_socket && !do_zip_file) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002479 return false;
2480 }
2481
Abhijeet Kaure370d682019-10-01 16:49:30 +01002482 if (is_remote_mode && (do_progress_updates || !do_zip_file || !do_add_date)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002483 return false;
2484 }
2485 return true;
2486}
2487
Nandana Dutt197661d2018-11-16 16:40:21 +00002488void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
2489 options_ = std::move(options);
2490}
2491
Abhijeet Kaura407fb82020-03-27 12:51:12 +00002492void Dumpstate::Initialize() {
2493 /* gets the sequential id */
2494 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
2495 id_ = ++last_id;
2496 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
2497}
2498
Nandana Duttd2f5f082019-01-18 17:13:52 +00002499Dumpstate::RunStatus Dumpstate::Run(int32_t calling_uid, const std::string& calling_package) {
2500 Dumpstate::RunStatus status = RunInternal(calling_uid, calling_package);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002501 if (listener_ != nullptr) {
2502 switch (status) {
2503 case Dumpstate::RunStatus::OK:
Nandana Duttcc4ead82019-01-23 08:29:23 +00002504 listener_->onFinished();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002505 break;
2506 case Dumpstate::RunStatus::HELP:
2507 break;
2508 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002509 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_INVALID_INPUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002510 break;
2511 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002512 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_RUNTIME_ERROR);
2513 break;
2514 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2515 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_DENIED_CONSENT);
2516 break;
2517 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
2518 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_CONSENT_TIMED_OUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002519 break;
2520 }
2521 }
2522 return status;
2523}
2524
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002525void Dumpstate::Cancel() {
2526 CleanupTmpFiles();
2527 android::os::UnlinkAndLogOnError(log_path_);
2528 for (int i = 0; i < NUM_OF_DUMPS; i++) {
2529 android::os::UnlinkAndLogOnError(ds.bugreport_internal_dir_ + "/" +
2530 kDumpstateBoardFiles[i]);
2531 }
2532 tombstone_data_.clear();
2533 anr_data_.clear();
2534}
2535
Nandana Dutt979388e2018-11-30 16:48:55 +00002536/*
2537 * Dumps relevant information to a bugreport based on the given options.
2538 *
2539 * The bugreport can be dumped to a file or streamed to a socket.
2540 *
2541 * How dumping to file works:
2542 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
2543 * stderr is redirected a log file.
2544 *
2545 * The temporary bugreport is then populated via printfs, dumping contents of files and
2546 * output of commands to stdout.
2547 *
2548 * If zipping, the temporary bugreport file is added to the zip archive. Else it's renamed to final
2549 * text file.
2550 *
2551 * If zipping, a bunch of other files and dumps also get added to the zip archive. The log file also
2552 * gets added to the archive.
2553 *
mhasank2d75c442020-06-11 15:05:25 -07002554 * Bugreports are first generated in a local directory and later copied to the caller's fd
2555 * or directory if supplied.
Nandana Dutt979388e2018-11-30 16:48:55 +00002556 */
Nandana Duttd2f5f082019-01-18 17:13:52 +00002557Dumpstate::RunStatus Dumpstate::RunInternal(int32_t calling_uid,
2558 const std::string& calling_package) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002559 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00002560 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002561 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002562 return RunStatus::INVALID_INPUT;
2563 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002564 /* set as high priority, and protect from OOM killer */
2565 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002566
Felipe Lemed071c682016-10-20 16:48:00 -07002567 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002568 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002569 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002570 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002571 } else {
2572 /* fallback to kernels <= 2.6.35 */
2573 oom_adj = fopen("/proc/self/oom_adj", "we");
2574 if (oom_adj) {
2575 fputs("-17", oom_adj);
2576 fclose(oom_adj);
2577 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002578 }
2579
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002580 if (version_ == VERSION_DEFAULT) {
2581 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00002582 }
2583
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002584 if (version_ != VERSION_CURRENT && version_ != VERSION_SPLIT_ANR) {
Vishnu Nair64afc022018-02-01 15:29:34 -08002585 MYLOGE("invalid version requested ('%s'); suppported values are: ('%s', '%s', '%s')\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002586 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str(),
Vishnu Nair64afc022018-02-01 15:29:34 -08002587 VERSION_SPLIT_ANR.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002588 return RunStatus::INVALID_INPUT;
Felipe Lemed071c682016-10-20 16:48:00 -07002589 }
2590
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002591 if (options_->show_header_only) {
2592 PrintHeader();
2593 return RunStatus::OK;
Felipe Lemed071c682016-10-20 16:48:00 -07002594 }
2595
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002596 MYLOGD("dumpstate calling_uid = %d ; calling package = %s \n",
2597 calling_uid, calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00002598
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002599 // Redirect output if needed
Nandana Dutt9a76d202019-01-21 15:56:48 +00002600 bool is_redirecting = options_->OutputToFile();
Felipe Leme7447d7c2016-11-03 18:12:22 -07002601
2602 // TODO: temporarily set progress until it's part of the Dumpstate constructor
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002603 std::string stats_path =
Nandana Dutt979388e2018-11-30 16:48:55 +00002604 is_redirecting
2605 ? android::base::StringPrintf("%s/dumpstate-stats.txt", bugreport_internal_dir_.c_str())
2606 : "";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002607 progress_.reset(new Progress(stats_path));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002608
Sahana Raof35ed432019-07-12 10:47:52 +01002609 if (acquire_wake_lock(PARTIAL_WAKE_LOCK, WAKE_LOCK_NAME) < 0) {
2610 MYLOGE("Failed to acquire wake lock: %s\n", strerror(errno));
2611 } else {
2612 // Wake lock will be released automatically on process death
2613 MYLOGD("Wake lock acquired.\n");
2614 }
2615
Felipe Leme6ae5c4f2017-01-10 14:13:22 -08002616 register_sig_handler();
Felipe Lemed071c682016-10-20 16:48:00 -07002617
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002618 // TODO(b/111441001): maybe skip if already started?
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002619 if (options_->do_start_service) {
Felipe Leme75876a22016-10-27 16:31:27 -07002620 MYLOGI("Starting 'dumpstate' service\n");
2621 android::status_t ret;
2622 if ((ret = android::os::DumpstateService::Start()) != android::OK) {
2623 MYLOGE("Unable to start DumpstateService: %d\n", ret);
2624 }
2625 }
2626
Felipe Lemef0292972016-11-22 13:57:05 -08002627 if (PropertiesHelper::IsDryRun()) {
Felipe Lemed071c682016-10-20 16:48:00 -07002628 MYLOGI("Running on dry-run mode (to disable it, call 'setprop dumpstate.dry_run false')\n");
2629 }
2630
Nandana Dutt235c6672019-11-14 15:22:32 +00002631 MYLOGI("dumpstate info: id=%d, args='%s', bugreport_mode= %s bugreport format version: %s\n",
2632 id_, options_->args.c_str(), options_->bugreport_mode.c_str(), version_.c_str());
Felipe Leme809d74e2016-02-02 12:57:00 -08002633
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002634 do_early_screenshot_ = options_->do_progress_updates;
Felipe Lemee338bf62015-12-07 14:03:50 -08002635
Christopher Ferrised9354f2014-10-01 17:35:01 -07002636 // If we are going to use a socket, do it as early as possible
2637 // to avoid timeouts from bugreport.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002638 if (options_->use_socket) {
Nandana Dutta344cb62019-02-22 15:12:35 +00002639 if (!redirect_to_socket(stdout, "dumpstate")) {
2640 return ERROR;
2641 }
Christopher Ferrised9354f2014-10-01 17:35:01 -07002642 }
2643
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002644 if (options_->use_control_socket) {
Felipe Leme2628e9e2016-04-12 16:36:51 -07002645 MYLOGD("Opening control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002646 control_socket_fd_ = open_socket("dumpstate");
Nandana Dutta344cb62019-02-22 15:12:35 +00002647 if (control_socket_fd_ == -1) {
2648 return ERROR;
2649 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002650 options_->do_progress_updates = 1;
Felipe Leme2628e9e2016-04-12 16:36:51 -07002651 }
2652
Felipe Leme71bbfc52015-11-23 14:14:51 -08002653 if (is_redirecting) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002654 PrepareToWriteToFile();
Felipe Leme1e9edc62015-12-21 16:02:13 -08002655
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002656 if (options_->do_progress_updates) {
Abhijeet Kaure370d682019-10-01 16:49:30 +01002657 // clang-format off
2658 std::vector<std::string> am_args = {
2659 "--receiver-permission", "android.permission.DUMP",
2660 };
2661 // clang-format on
2662 // Send STARTED broadcast for apps that listen to bugreport generation events
2663 SendBroadcast("com.android.internal.intent.action.BUGREPORT_STARTED", am_args);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002664 if (options_->use_control_socket) {
2665 dprintf(control_socket_fd_, "BEGIN:%s\n", path_.c_str());
Felipe Lemeaabfcae2016-07-29 09:49:04 -07002666 }
Felipe Leme71bbfc52015-11-23 14:14:51 -08002667 }
2668 }
2669
Nick Kralevichf3599b32016-01-25 15:05:16 -08002670 /* read /proc/cmdline before dropping root */
2671 FILE *cmdline = fopen("/proc/cmdline", "re");
2672 if (cmdline) {
2673 fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
2674 fclose(cmdline);
2675 }
2676
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002677 if (options_->do_vibrate) {
Felipe Leme35b8cf12017-02-10 15:47:29 -08002678 Vibrate(150);
John Michelau1f794c42012-09-17 11:20:19 -05002679 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002680
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002681 if (options_->do_zip_file && zip_file != nullptr) {
2682 if (chown(path_.c_str(), AID_SHELL, AID_SHELL)) {
2683 MYLOGE("Unable to change ownership of zip file %s: %s\n", path_.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -07002684 strerror(errno));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002685 }
2686 }
2687
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002688 int dup_stdout_fd;
2689 int dup_stderr_fd;
Felipe Leme71bbfc52015-11-23 14:14:51 -08002690 if (is_redirecting) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002691 // Redirect stderr to log_path_ for debugging.
Vishnu Nair20cf5032018-01-05 13:15:49 -08002692 TEMP_FAILURE_RETRY(dup_stderr_fd = dup(fileno(stderr)));
Nandana Dutta344cb62019-02-22 15:12:35 +00002693 if (!redirect_to_file(stderr, const_cast<char*>(log_path_.c_str()))) {
2694 return ERROR;
2695 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002696 if (chown(log_path_.c_str(), AID_SHELL, AID_SHELL)) {
2697 MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n", log_path_.c_str(),
2698 strerror(errno));
Felipe Leme6fe9db62016-02-12 09:04:16 -08002699 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002700
2701 // Redirect stdout to tmp_path_. This is the main bugreport entry and will be
2702 // moved into zip file later, if zipping.
Vishnu Nair20cf5032018-01-05 13:15:49 -08002703 TEMP_FAILURE_RETRY(dup_stdout_fd = dup(fileno(stdout)));
Nandana Dutt979388e2018-11-30 16:48:55 +00002704 // TODO: why not write to a file instead of stdout to overcome this problem?
Felipe Leme6e01fa62015-11-11 19:35:14 -08002705 /* TODO: rather than generating a text file now and zipping it later,
2706 it would be more efficient to redirect stdout to the zip entry
2707 directly, but the libziparchive doesn't support that option yet. */
Nandana Dutta344cb62019-02-22 15:12:35 +00002708 if (!redirect_to_file(stdout, const_cast<char*>(tmp_path_.c_str()))) {
2709 return ERROR;
2710 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002711 if (chown(tmp_path_.c_str(), AID_SHELL, AID_SHELL)) {
Felipe Leme6fe9db62016-02-12 09:04:16 -08002712 MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002713 tmp_path_.c_str(), strerror(errno));
Felipe Leme6fe9db62016-02-12 09:04:16 -08002714 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002715 }
Felipe Lemed8b94e52016-12-08 10:21:44 -08002716
2717 // Don't buffer stdout
2718 setvbuf(stdout, nullptr, _IONBF, 0);
2719
Felipe Leme608385d2016-02-01 10:35:38 -08002720 // NOTE: there should be no stdout output until now, otherwise it would break the header.
2721 // In particular, DurationReport objects should be created passing 'title, NULL', so their
Felipe Lemecbce55d2016-02-08 09:53:18 -08002722 // duration is logged into MYLOG instead.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002723 PrintHeader();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002724
mhasankd451a472020-05-26 18:02:39 -07002725 // TODO(b/158737089) reduce code repetition in if branches
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002726 if (options_->telephony_only) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002727 MaybeTakeEarlyScreenshot();
Paul Changc490e662020-04-11 18:14:09 +08002728 onUiIntensiveBugreportDumpsFinished(calling_uid, calling_package);
Jichao Lie89d9c12019-11-21 19:02:51 -08002729 MaybeCheckUserConsent(calling_uid, calling_package);
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08002730 DumpstateTelephonyOnly(calling_package);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002731 DumpstateBoard();
2732 } else if (options_->wifi_only) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002733 MaybeTakeEarlyScreenshot();
Paul Changc490e662020-04-11 18:14:09 +08002734 onUiIntensiveBugreportDumpsFinished(calling_uid, calling_package);
Jichao Lie89d9c12019-11-21 19:02:51 -08002735 MaybeCheckUserConsent(calling_uid, calling_package);
mukesh agrawal253dad42018-01-23 21:59:59 -08002736 DumpstateWifiOnly();
mhasankd451a472020-05-26 18:02:39 -07002737 } else if (options_->limited_only) {
2738 MaybeTakeEarlyScreenshot();
2739 onUiIntensiveBugreportDumpsFinished(calling_uid, calling_package);
2740 MaybeCheckUserConsent(calling_uid, calling_package);
2741 DumpstateLimitedOnly();
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002742 } else {
Paul Chang0d2aad72020-02-13 20:04:03 +08002743 // Invoke critical dumpsys first to preserve system state, before doing anything else.
Jichao Lie89d9c12019-11-21 19:02:51 -08002744 RunDumpsysCritical();
2745
Paul Chang0d2aad72020-02-13 20:04:03 +08002746 // Take screenshot and get consent only after critical dumpsys has finished.
2747 MaybeTakeEarlyScreenshot();
Paul Changc490e662020-04-11 18:14:09 +08002748 onUiIntensiveBugreportDumpsFinished(calling_uid, calling_package);
Jichao Lie89d9c12019-11-21 19:02:51 -08002749 MaybeCheckUserConsent(calling_uid, calling_package);
2750
Nandana Dutt4be45d12018-09-26 15:04:23 +01002751 // Dump state for the default case. This also drops root.
Jichao Lie89d9c12019-11-21 19:02:51 -08002752 RunStatus s = DumpstateDefaultAfterCritical();
Nandana Dutt5c390032019-03-12 10:52:56 +00002753 if (s != RunStatus::OK) {
Nandana Duttaac6f582019-07-26 14:32:47 +01002754 if (s == RunStatus::USER_CONSENT_DENIED) {
Nandana Dutt5c390032019-03-12 10:52:56 +00002755 HandleUserConsentDenied();
2756 }
2757 return s;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002758 }
Zhengyin Qian068ecc72016-08-10 16:48:14 -07002759 }
Felipe Leme71a74ac2016-03-17 15:43:25 -07002760
Felipe Leme55b42a62015-11-10 17:39:08 -08002761 /* close output if needed */
Felipe Leme71bbfc52015-11-23 14:14:51 -08002762 if (is_redirecting) {
Vishnu Nair20cf5032018-01-05 13:15:49 -08002763 TEMP_FAILURE_RETRY(dup2(dup_stdout_fd, fileno(stdout)));
Colin Crossf45fa6b2012-03-26 12:38:26 -07002764 }
2765
Abhijeet Kaure370d682019-10-01 16:49:30 +01002766 // Zip the (now complete) .tmp file within the internal directory.
Nandana Dutt9a76d202019-01-21 15:56:48 +00002767 if (options_->OutputToFile()) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002768 FinalizeFile();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002769 }
2770
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002771 // Share the final file with the caller if the user has consented or Shell is the caller.
Nandana Duttd2f5f082019-01-18 17:13:52 +00002772 Dumpstate::RunStatus status = Dumpstate::RunStatus::OK;
Abhijeet Kaure370d682019-10-01 16:49:30 +01002773 if (CalledByApi()) {
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002774 status = CopyBugreportIfUserConsented(calling_uid);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002775 if (status != Dumpstate::RunStatus::OK &&
2776 status != Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2777 // Do an early return if there were errors. We make an exception for consent
2778 // timing out because it's possible the user got distracted. In this case the
2779 // bugreport is not shared but made available for manual retrieval.
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002780 MYLOGI("User denied consent. Returning\n");
Nandana Duttd2f5f082019-01-18 17:13:52 +00002781 return status;
2782 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002783 if (status == Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2784 MYLOGI(
2785 "Did not receive user consent yet."
2786 " Will not copy the bugreport artifacts to caller.\n");
Abhijeet Kaur57627412019-04-17 16:00:09 +01002787 const String16 incidentcompanion("incidentcompanion");
2788 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
2789 if (ics != nullptr) {
2790 MYLOGD("Canceling user consent request via incidentcompanion service\n");
2791 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
2792 consent_callback_.get());
2793 } else {
2794 MYLOGD("Unable to cancel user consent; incidentcompanion service unavailable\n");
2795 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002796 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00002797 }
2798
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002799 /* vibrate a few but shortly times to let user know it's finished */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002800 if (options_->do_vibrate) {
Takuya Ogawa47f644e2017-12-20 18:09:09 +09002801 for (int i = 0; i < 3; i++) {
2802 Vibrate(75);
2803 usleep((75 + 50) * 1000);
2804 }
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002805 }
2806
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002807 MYLOGD("Final progress: %d/%d (estimated %d)\n", progress_->Get(), progress_->GetMax(),
2808 progress_->GetInitialMax());
2809 progress_->Save();
2810 MYLOGI("done (id %d)\n", id_);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002811
Felipe Leme107a05f2016-03-08 15:11:15 -08002812 if (is_redirecting) {
Vishnu Nair20cf5032018-01-05 13:15:49 -08002813 TEMP_FAILURE_RETRY(dup2(dup_stderr_fd, fileno(stderr)));
Felipe Leme107a05f2016-03-08 15:11:15 -08002814 }
2815
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002816 if (options_->use_control_socket && control_socket_fd_ != -1) {
Felipe Lemee844a9d2016-09-21 15:01:39 -07002817 MYLOGD("Closing control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002818 close(control_socket_fd_);
Felipe Leme2628e9e2016-04-12 16:36:51 -07002819 }
2820
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002821 tombstone_data_.clear();
2822 anr_data_.clear();
Narayan Kamath6b9516c2017-10-27 11:15:51 +01002823
Nandana Duttd2f5f082019-01-18 17:13:52 +00002824 return (consent_callback_ != nullptr &&
2825 consent_callback_->getResult() == UserConsentResult::UNAVAILABLE)
2826 ? USER_CONSENT_TIMED_OUT
2827 : RunStatus::OK;
2828}
2829
Paul Chang0d2aad72020-02-13 20:04:03 +08002830void Dumpstate::MaybeTakeEarlyScreenshot() {
2831 if (!options_->do_screenshot || !do_early_screenshot_) {
2832 return;
2833 }
2834
2835 TakeScreenshot();
2836}
2837
Paul Changc490e662020-04-11 18:14:09 +08002838void Dumpstate::onUiIntensiveBugreportDumpsFinished(int32_t calling_uid,
2839 const std::string& calling_package) {
2840 if (calling_uid == AID_SHELL || !CalledByApi()) {
2841 return;
2842 }
2843 if (listener_ != nullptr) {
2844 // Let listener know ui intensive bugreport dumps are finished, then it can do event
2845 // handling if required.
2846 android::String16 package(calling_package.c_str());
2847 listener_->onUiIntensiveBugreportDumpsFinished(package);
2848 }
2849}
2850
Jichao Lie89d9c12019-11-21 19:02:51 -08002851void Dumpstate::MaybeCheckUserConsent(int32_t calling_uid, const std::string& calling_package) {
2852 if (calling_uid == AID_SHELL || !CalledByApi()) {
2853 // No need to get consent for shell triggered dumpstates, or not through
2854 // bugreporting API (i.e. no fd to copy back).
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002855 return;
2856 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00002857 consent_callback_ = new ConsentCallback();
2858 const String16 incidentcompanion("incidentcompanion");
2859 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
Jichao Lie89d9c12019-11-21 19:02:51 -08002860 android::String16 package(calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00002861 if (ics != nullptr) {
2862 MYLOGD("Checking user consent via incidentcompanion service\n");
2863 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
Jichao Lie89d9c12019-11-21 19:02:51 -08002864 calling_uid, package, String16(), String16(),
Joe Onorato1c36d752019-03-17 18:26:43 -07002865 0x1 /* FLAG_CONFIRMATION_DIALOG */, consent_callback_.get());
Nandana Duttd2f5f082019-01-18 17:13:52 +00002866 } else {
2867 MYLOGD("Unable to check user consent; incidentcompanion service unavailable\n");
2868 }
2869}
2870
Nandana Dutt5c390032019-03-12 10:52:56 +00002871bool Dumpstate::IsUserConsentDenied() const {
2872 return ds.consent_callback_ != nullptr &&
2873 ds.consent_callback_->getResult() == UserConsentResult::DENIED;
2874}
2875
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002876bool Dumpstate::CalledByApi() const {
2877 return ds.options_->bugreport_fd.get() != -1 ? true : false;
2878}
2879
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002880void Dumpstate::CleanupTmpFiles() {
Nandana Duttd2f5f082019-01-18 17:13:52 +00002881 android::os::UnlinkAndLogOnError(tmp_path_);
2882 android::os::UnlinkAndLogOnError(screenshot_path_);
2883 android::os::UnlinkAndLogOnError(path_);
2884}
2885
2886Dumpstate::RunStatus Dumpstate::HandleUserConsentDenied() {
2887 MYLOGD("User denied consent; deleting files and returning\n");
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002888 CleanupTmpFiles();
Nandana Duttd2f5f082019-01-18 17:13:52 +00002889 return USER_CONSENT_DENIED;
2890}
2891
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002892Dumpstate::RunStatus Dumpstate::CopyBugreportIfUserConsented(int32_t calling_uid) {
Nandana Duttd2f5f082019-01-18 17:13:52 +00002893 // If the caller has asked to copy the bugreport over to their directory, we need explicit
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002894 // user consent (unless the caller is Shell).
2895 UserConsentResult consent_result;
2896 if (calling_uid == AID_SHELL) {
2897 consent_result = UserConsentResult::APPROVED;
2898 } else {
2899 consent_result = consent_callback_->getResult();
2900 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00002901 if (consent_result == UserConsentResult::UNAVAILABLE) {
2902 // User has not responded yet.
2903 uint64_t elapsed_ms = consent_callback_->getElapsedTimeMs();
Hunter Knepshield70610fa2020-01-03 15:27:33 -08002904 // Telephony is a fast report type, particularly on user builds where information may be
2905 // more aggressively limited. To give the user time to read the consent dialog, increase the
2906 // timeout.
2907 uint64_t timeout_ms = options_->telephony_only ? TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS
2908 : USER_CONSENT_TIMEOUT_MS;
2909 if (elapsed_ms < timeout_ms) {
2910 uint delay_seconds = (timeout_ms - elapsed_ms) / 1000;
Nandana Duttd2f5f082019-01-18 17:13:52 +00002911 MYLOGD("Did not receive user consent yet; going to wait for %d seconds", delay_seconds);
2912 sleep(delay_seconds);
2913 }
2914 consent_result = consent_callback_->getResult();
2915 }
2916 if (consent_result == UserConsentResult::DENIED) {
2917 // User has explicitly denied sharing with the app. To be safe delete the
2918 // internal bugreport & tmp files.
2919 return HandleUserConsentDenied();
2920 }
2921 if (consent_result == UserConsentResult::APPROVED) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00002922 bool copy_succeeded = android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
2923 if (copy_succeeded) {
2924 android::os::UnlinkAndLogOnError(path_);
Abhijeet Kaur9ce94672020-04-01 17:22:36 +01002925 if (options_->do_screenshot &&
2926 options_->screenshot_fd.get() != -1 &&
2927 !options_->is_screenshot_copied) {
2928 copy_succeeded = android::os::CopyFileToFd(screenshot_path_,
2929 options_->screenshot_fd.get());
2930 options_->is_screenshot_copied = copy_succeeded;
2931 if (copy_succeeded) {
2932 android::os::UnlinkAndLogOnError(screenshot_path_);
2933 }
2934 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00002935 }
2936 return copy_succeeded ? Dumpstate::RunStatus::OK : Dumpstate::RunStatus::ERROR;
2937 } else if (consent_result == UserConsentResult::UNAVAILABLE) {
2938 // consent_result is still UNAVAILABLE. The user has likely not responded yet.
2939 // Since we do not have user consent to share the bugreport it does not get
2940 // copied over to the calling app but remains in the internal directory from
2941 // where the user can manually pull it.
2942 return Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT;
2943 }
2944 // Unknown result; must be a programming error.
2945 MYLOGE("Unknown user consent result:%d\n", consent_result);
2946 return Dumpstate::RunStatus::ERROR;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002947}
2948
Nandana Duttf02564e2019-02-15 15:24:24 +00002949Dumpstate::RunStatus Dumpstate::ParseCommandlineAndRun(int argc, char* argv[]) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002950 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
2951 Dumpstate::RunStatus status = options->Initialize(argc, argv);
2952 if (status == Dumpstate::RunStatus::OK) {
Nandana Duttf02564e2019-02-15 15:24:24 +00002953 SetOptions(std::move(options));
Nandana Duttd2f5f082019-01-18 17:13:52 +00002954 // When directly running dumpstate binary, the output is not expected to be written
2955 // to any external file descriptor.
Nandana Duttf02564e2019-02-15 15:24:24 +00002956 assert(options_->bugreport_fd.get() == -1);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002957
2958 // calling_uid and calling_package are for user consent to share the bugreport with
Abhijeet Kaura407fb82020-03-27 12:51:12 +00002959 // an app; they are irrelevant here because bugreport is triggered via command line.
2960 // Update Last ID before calling Run().
2961 Initialize();
Nandana Duttf02564e2019-02-15 15:24:24 +00002962 status = Run(-1 /* calling_uid */, "" /* calling_package */);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002963 }
Nandana Duttf02564e2019-02-15 15:24:24 +00002964 return status;
2965}
2966
2967/* Main entry point for dumpstate binary. */
2968int run_main(int argc, char* argv[]) {
2969 Dumpstate::RunStatus status = ds.ParseCommandlineAndRun(argc, argv);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002970
2971 switch (status) {
2972 case Dumpstate::RunStatus::OK:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002973 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002974 case Dumpstate::RunStatus::HELP:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002975 ShowUsage();
2976 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002977 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002978 fprintf(stderr, "Invalid combination of args\n");
2979 ShowUsage();
2980 exit(1);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002981 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002982 FALLTHROUGH_INTENDED;
2983 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2984 FALLTHROUGH_INTENDED;
2985 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002986 exit(2);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002987 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002988}
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002989
2990// TODO(111441001): Default DumpOptions to sensible values.
2991Dumpstate::Dumpstate(const std::string& version)
2992 : pid_(getpid()),
2993 options_(new Dumpstate::DumpOptions()),
Nandana Duttf02cd782019-06-14 14:25:13 +01002994 last_reported_percent_progress_(0),
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01002995 version_(version),
2996 now_(time(nullptr)) {
2997}
2998
2999Dumpstate& Dumpstate::GetInstance() {
3000 static Dumpstate singleton_(android::base::GetProperty("dumpstate.version", VERSION_CURRENT));
3001 return singleton_;
3002}
3003
Nandana Dutt8d945c02019-08-14 13:30:07 +01003004DurationReporter::DurationReporter(const std::string& title, bool logcat_only, bool verbose)
3005 : title_(title), logcat_only_(logcat_only), verbose_(verbose) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003006 if (!title_.empty()) {
3007 started_ = Nanotime();
3008 }
3009}
3010
3011DurationReporter::~DurationReporter() {
3012 if (!title_.empty()) {
3013 float elapsed = (float)(Nanotime() - started_) / NANOS_PER_SEC;
chenqiwuaf8b2d92019-12-12 18:53:51 +08003014 if (elapsed >= .5f || verbose_) {
3015 MYLOGD("Duration of '%s': %.2fs\n", title_.c_str(), elapsed);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003016 }
chenqiwuaf8b2d92019-12-12 18:53:51 +08003017 if (!logcat_only_) {
3018 // Use "Yoda grammar" to make it easier to grep|sort sections.
3019 printf("------ %.3fs was the duration of '%s' ------\n", elapsed, title_.c_str());
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003020 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003021 }
3022}
3023
3024const int32_t Progress::kDefaultMax = 5000;
3025
3026Progress::Progress(const std::string& path) : Progress(Progress::kDefaultMax, 1.1, path) {
3027}
3028
3029Progress::Progress(int32_t initial_max, int32_t progress, float growth_factor)
3030 : Progress(initial_max, growth_factor, "") {
3031 progress_ = progress;
3032}
3033
3034Progress::Progress(int32_t initial_max, float growth_factor, const std::string& path)
3035 : initial_max_(initial_max),
3036 progress_(0),
3037 max_(initial_max),
3038 growth_factor_(growth_factor),
3039 n_runs_(0),
3040 average_max_(0),
3041 path_(path) {
3042 if (!path_.empty()) {
3043 Load();
3044 }
3045}
3046
3047void Progress::Load() {
3048 MYLOGD("Loading stats from %s\n", path_.c_str());
3049 std::string content;
3050 if (!android::base::ReadFileToString(path_, &content)) {
3051 MYLOGI("Could not read stats from %s; using max of %d\n", path_.c_str(), max_);
3052 return;
3053 }
3054 if (content.empty()) {
3055 MYLOGE("No stats (empty file) on %s; using max of %d\n", path_.c_str(), max_);
3056 return;
3057 }
3058 std::vector<std::string> lines = android::base::Split(content, "\n");
3059
3060 if (lines.size() < 1) {
3061 MYLOGE("Invalid stats on file %s: not enough lines (%d). Using max of %d\n", path_.c_str(),
3062 (int)lines.size(), max_);
3063 return;
3064 }
3065 char* ptr;
3066 n_runs_ = strtol(lines[0].c_str(), &ptr, 10);
3067 average_max_ = strtol(ptr, nullptr, 10);
3068 if (n_runs_ <= 0 || average_max_ <= 0 || n_runs_ > STATS_MAX_N_RUNS ||
3069 average_max_ > STATS_MAX_AVERAGE) {
3070 MYLOGE("Invalid stats line on file %s: %s\n", path_.c_str(), lines[0].c_str());
3071 initial_max_ = Progress::kDefaultMax;
3072 } else {
3073 initial_max_ = average_max_;
3074 }
3075 max_ = initial_max_;
3076
3077 MYLOGI("Average max progress: %d in %d runs; estimated max: %d\n", average_max_, n_runs_, max_);
3078}
3079
3080void Progress::Save() {
3081 int32_t total = n_runs_ * average_max_ + progress_;
3082 int32_t runs = n_runs_ + 1;
3083 int32_t average = floor(((float)total) / runs);
3084 MYLOGI("Saving stats (total=%d, runs=%d, average=%d) on %s\n", total, runs, average,
3085 path_.c_str());
3086 if (path_.empty()) {
3087 return;
3088 }
3089
3090 std::string content = android::base::StringPrintf("%d %d\n", runs, average);
3091 if (!android::base::WriteStringToFile(content, path_)) {
3092 MYLOGE("Could not save stats on %s\n", path_.c_str());
3093 }
3094}
3095
3096int32_t Progress::Get() const {
3097 return progress_;
3098}
3099
3100bool Progress::Inc(int32_t delta_sec) {
3101 bool changed = false;
3102 if (delta_sec >= 0) {
3103 progress_ += delta_sec;
3104 if (progress_ > max_) {
3105 int32_t old_max = max_;
3106 max_ = floor((float)progress_ * growth_factor_);
3107 MYLOGD("Adjusting max progress from %d to %d\n", old_max, max_);
3108 changed = true;
3109 }
3110 }
3111 return changed;
3112}
3113
3114int32_t Progress::GetMax() const {
3115 return max_;
3116}
3117
3118int32_t Progress::GetInitialMax() const {
3119 return initial_max_;
3120}
3121
3122void Progress::Dump(int fd, const std::string& prefix) const {
3123 const char* pr = prefix.c_str();
3124 dprintf(fd, "%sprogress: %d\n", pr, progress_);
3125 dprintf(fd, "%smax: %d\n", pr, max_);
3126 dprintf(fd, "%sinitial_max: %d\n", pr, initial_max_);
3127 dprintf(fd, "%sgrowth_factor: %0.2f\n", pr, growth_factor_);
3128 dprintf(fd, "%spath: %s\n", pr, path_.c_str());
3129 dprintf(fd, "%sn_runs: %d\n", pr, n_runs_);
3130 dprintf(fd, "%saverage_max: %d\n", pr, average_max_);
3131}
3132
3133bool Dumpstate::IsZipping() const {
3134 return zip_writer_ != nullptr;
3135}
3136
3137std::string Dumpstate::GetPath(const std::string& suffix) const {
3138 return GetPath(bugreport_internal_dir_, suffix);
3139}
3140
3141std::string Dumpstate::GetPath(const std::string& directory, const std::string& suffix) const {
3142 return android::base::StringPrintf("%s/%s-%s%s", directory.c_str(), base_name_.c_str(),
3143 name_.c_str(), suffix.c_str());
3144}
3145
3146void Dumpstate::SetProgress(std::unique_ptr<Progress> progress) {
3147 progress_ = std::move(progress);
3148}
3149
3150void for_each_userid(void (*func)(int), const char *header) {
3151 std::string title = header == nullptr ? "for_each_userid" : android::base::StringPrintf(
3152 "for_each_userid(%s)", header);
3153 DurationReporter duration_reporter(title);
3154 if (PropertiesHelper::IsDryRun()) return;
3155
3156 DIR *d;
3157 struct dirent *de;
3158
3159 if (header) printf("\n------ %s ------\n", header);
3160 func(0);
3161
3162 if (!(d = opendir("/data/system/users"))) {
3163 printf("Failed to open /data/system/users (%s)\n", strerror(errno));
3164 return;
3165 }
3166
3167 while ((de = readdir(d))) {
3168 int userid;
3169 if (de->d_type != DT_DIR || !(userid = atoi(de->d_name))) {
3170 continue;
3171 }
3172 func(userid);
3173 }
3174
3175 closedir(d);
3176}
3177
3178static void __for_each_pid(void (*helper)(int, const char *, void *), const char *header, void *arg) {
3179 DIR *d;
3180 struct dirent *de;
3181
3182 if (!(d = opendir("/proc"))) {
3183 printf("Failed to open /proc (%s)\n", strerror(errno));
3184 return;
3185 }
3186
3187 if (header) printf("\n------ %s ------\n", header);
3188 while ((de = readdir(d))) {
3189 if (ds.IsUserConsentDenied()) {
3190 MYLOGE(
3191 "Returning early because user denied consent to share bugreport with calling app.");
3192 closedir(d);
3193 return;
3194 }
3195 int pid;
3196 int fd;
3197 char cmdpath[255];
3198 char cmdline[255];
3199
3200 if (!(pid = atoi(de->d_name))) {
3201 continue;
3202 }
3203
3204 memset(cmdline, 0, sizeof(cmdline));
3205
3206 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/cmdline", pid);
3207 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3208 TEMP_FAILURE_RETRY(read(fd, cmdline, sizeof(cmdline) - 2));
3209 close(fd);
3210 if (cmdline[0]) {
3211 helper(pid, cmdline, arg);
3212 continue;
3213 }
3214 }
3215
3216 // if no cmdline, a kernel thread has comm
3217 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/comm", pid);
3218 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3219 TEMP_FAILURE_RETRY(read(fd, cmdline + 1, sizeof(cmdline) - 4));
3220 close(fd);
3221 if (cmdline[1]) {
3222 cmdline[0] = '[';
3223 size_t len = strcspn(cmdline, "\f\b\r\n");
3224 cmdline[len] = ']';
3225 cmdline[len+1] = '\0';
3226 }
3227 }
3228 if (!cmdline[0]) {
3229 strcpy(cmdline, "N/A");
3230 }
3231 helper(pid, cmdline, arg);
3232 }
3233
3234 closedir(d);
3235}
3236
3237static void for_each_pid_helper(int pid, const char *cmdline, void *arg) {
3238 for_each_pid_func *func = (for_each_pid_func*) arg;
3239 func(pid, cmdline);
3240}
3241
3242void for_each_pid(for_each_pid_func func, const char *header) {
3243 std::string title = header == nullptr ? "for_each_pid"
3244 : android::base::StringPrintf("for_each_pid(%s)", header);
3245 DurationReporter duration_reporter(title);
3246 if (PropertiesHelper::IsDryRun()) return;
3247
3248 __for_each_pid(for_each_pid_helper, header, (void *) func);
3249}
3250
3251static void for_each_tid_helper(int pid, const char *cmdline, void *arg) {
3252 DIR *d;
3253 struct dirent *de;
3254 char taskpath[255];
3255 for_each_tid_func *func = (for_each_tid_func *) arg;
3256
3257 snprintf(taskpath, sizeof(taskpath), "/proc/%d/task", pid);
3258
3259 if (!(d = opendir(taskpath))) {
3260 printf("Failed to open %s (%s)\n", taskpath, strerror(errno));
3261 return;
3262 }
3263
3264 func(pid, pid, cmdline);
3265
3266 while ((de = readdir(d))) {
3267 if (ds.IsUserConsentDenied()) {
3268 MYLOGE(
3269 "Returning early because user denied consent to share bugreport with calling app.");
3270 closedir(d);
3271 return;
3272 }
3273 int tid;
3274 int fd;
3275 char commpath[255];
3276 char comm[255];
3277
3278 if (!(tid = atoi(de->d_name))) {
3279 continue;
3280 }
3281
3282 if (tid == pid)
3283 continue;
3284
3285 snprintf(commpath, sizeof(commpath), "/proc/%d/comm", tid);
3286 memset(comm, 0, sizeof(comm));
3287 if ((fd = TEMP_FAILURE_RETRY(open(commpath, O_RDONLY | O_CLOEXEC))) < 0) {
3288 strcpy(comm, "N/A");
3289 } else {
3290 char *c;
3291 TEMP_FAILURE_RETRY(read(fd, comm, sizeof(comm) - 2));
3292 close(fd);
3293
3294 c = strrchr(comm, '\n');
3295 if (c) {
3296 *c = '\0';
3297 }
3298 }
3299 func(pid, tid, comm);
3300 }
3301
3302 closedir(d);
3303}
3304
3305void for_each_tid(for_each_tid_func func, const char *header) {
3306 std::string title = header == nullptr ? "for_each_tid"
3307 : android::base::StringPrintf("for_each_tid(%s)", header);
3308 DurationReporter duration_reporter(title);
3309
3310 if (PropertiesHelper::IsDryRun()) return;
3311
3312 __for_each_pid(for_each_tid_helper, header, (void *) func);
3313}
3314
3315void show_wchan(int pid, int tid, const char *name) {
3316 if (PropertiesHelper::IsDryRun()) return;
3317
3318 char path[255];
3319 char buffer[255];
3320 int fd, ret, save_errno;
3321 char name_buffer[255];
3322
3323 memset(buffer, 0, sizeof(buffer));
3324
3325 snprintf(path, sizeof(path), "/proc/%d/wchan", tid);
3326 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3327 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3328 return;
3329 }
3330
3331 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3332 save_errno = errno;
3333 close(fd);
3334
3335 if (ret < 0) {
3336 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3337 return;
3338 }
3339
3340 snprintf(name_buffer, sizeof(name_buffer), "%*s%s",
3341 pid == tid ? 0 : 3, "", name);
3342
3343 printf("%-7d %-32s %s\n", tid, name_buffer, buffer);
3344
3345 return;
3346}
3347
3348// print time in centiseconds
3349static void snprcent(char *buffer, size_t len, size_t spc,
3350 unsigned long long time) {
3351 static long hz; // cache discovered hz
3352
3353 if (hz <= 0) {
3354 hz = sysconf(_SC_CLK_TCK);
3355 if (hz <= 0) {
3356 hz = 1000;
3357 }
3358 }
3359
3360 // convert to centiseconds
3361 time = (time * 100 + (hz / 2)) / hz;
3362
3363 char str[16];
3364
3365 snprintf(str, sizeof(str), " %llu.%02u",
3366 time / 100, (unsigned)(time % 100));
3367 size_t offset = strlen(buffer);
3368 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3369 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3370}
3371
3372// print permille as a percent
3373static void snprdec(char *buffer, size_t len, size_t spc, unsigned permille) {
3374 char str[16];
3375
3376 snprintf(str, sizeof(str), " %u.%u%%", permille / 10, permille % 10);
3377 size_t offset = strlen(buffer);
3378 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3379 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3380}
3381
3382void show_showtime(int pid, const char *name) {
3383 if (PropertiesHelper::IsDryRun()) return;
3384
3385 char path[255];
3386 char buffer[1023];
3387 int fd, ret, save_errno;
3388
3389 memset(buffer, 0, sizeof(buffer));
3390
3391 snprintf(path, sizeof(path), "/proc/%d/stat", pid);
3392 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3393 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3394 return;
3395 }
3396
3397 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3398 save_errno = errno;
3399 close(fd);
3400
3401 if (ret < 0) {
3402 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3403 return;
3404 }
3405
3406 // field 14 is utime
3407 // field 15 is stime
3408 // field 42 is iotime
3409 unsigned long long utime = 0, stime = 0, iotime = 0;
3410 if (sscanf(buffer,
3411 "%*u %*s %*s %*d %*d %*d %*d %*d %*d %*d %*d "
3412 "%*d %*d %llu %llu %*d %*d %*d %*d %*d %*d "
3413 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %*d "
3414 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %llu ",
3415 &utime, &stime, &iotime) != 3) {
3416 return;
3417 }
3418
3419 unsigned long long total = utime + stime;
3420 if (!total) {
3421 return;
3422 }
3423
3424 unsigned permille = (iotime * 1000 + (total / 2)) / total;
3425 if (permille > 1000) {
3426 permille = 1000;
3427 }
3428
3429 // try to beautify and stabilize columns at <80 characters
3430 snprintf(buffer, sizeof(buffer), "%-6d%s", pid, name);
3431 if ((name[0] != '[') || utime) {
3432 snprcent(buffer, sizeof(buffer), 57, utime);
3433 }
3434 snprcent(buffer, sizeof(buffer), 65, stime);
3435 if ((name[0] != '[') || iotime) {
3436 snprcent(buffer, sizeof(buffer), 73, iotime);
3437 }
3438 if (iotime) {
3439 snprdec(buffer, sizeof(buffer), 79, permille);
3440 }
3441 puts(buffer); // adds a trailing newline
3442
3443 return;
3444}
3445
3446void do_dmesg() {
3447 const char *title = "KERNEL LOG (dmesg)";
3448 DurationReporter duration_reporter(title);
3449 printf("------ %s ------\n", title);
3450
3451 if (PropertiesHelper::IsDryRun()) return;
3452
3453 /* Get size of kernel buffer */
3454 int size = klogctl(KLOG_SIZE_BUFFER, nullptr, 0);
3455 if (size <= 0) {
3456 printf("Unexpected klogctl return value: %d\n\n", size);
3457 return;
3458 }
3459 char *buf = (char *) malloc(size + 1);
3460 if (buf == nullptr) {
3461 printf("memory allocation failed\n\n");
3462 return;
3463 }
3464 int retval = klogctl(KLOG_READ_ALL, buf, size);
3465 if (retval < 0) {
3466 printf("klogctl failure\n\n");
3467 free(buf);
3468 return;
3469 }
3470 buf[retval] = '\0';
3471 printf("%s\n\n", buf);
3472 free(buf);
3473 return;
3474}
3475
3476void do_showmap(int pid, const char *name) {
3477 char title[255];
3478 char arg[255];
3479
3480 snprintf(title, sizeof(title), "SHOW MAP %d (%s)", pid, name);
3481 snprintf(arg, sizeof(arg), "%d", pid);
3482 RunCommand(title, {"showmap", "-q", arg}, CommandOptions::AS_ROOT);
3483}
3484
3485int Dumpstate::DumpFile(const std::string& title, const std::string& path) {
3486 DurationReporter duration_reporter(title);
3487
3488 int status = DumpFileToFd(STDOUT_FILENO, title, path);
3489
3490 UpdateProgress(WEIGHT_FILE);
3491
3492 return status;
3493}
3494
3495int read_file_as_long(const char *path, long int *output) {
3496 int fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC));
3497 if (fd < 0) {
3498 int err = errno;
3499 MYLOGE("Error opening file descriptor for %s: %s\n", path, strerror(err));
3500 return -1;
3501 }
3502 char buffer[50];
3503 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3504 if (bytes_read == -1) {
3505 MYLOGE("Error reading file %s: %s\n", path, strerror(errno));
3506 return -2;
3507 }
3508 if (bytes_read == 0) {
3509 MYLOGE("File %s is empty\n", path);
3510 return -3;
3511 }
3512 *output = atoi(buffer);
3513 return 0;
3514}
3515
3516/* calls skip to gate calling dump_from_fd recursively
3517 * in the specified directory. dump_from_fd defaults to
3518 * dump_file_from_fd above when set to NULL. skip defaults
3519 * to false when set to NULL. dump_from_fd will always be
3520 * called with title NULL.
3521 */
3522int dump_files(const std::string& title, const char* dir, bool (*skip)(const char* path),
3523 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
3524 DurationReporter duration_reporter(title);
3525 DIR *dirp;
3526 struct dirent *d;
3527 char *newpath = nullptr;
3528 const char *slash = "/";
3529 int retval = 0;
3530
3531 if (!title.empty()) {
3532 printf("------ %s (%s) ------\n", title.c_str(), dir);
3533 }
3534 if (PropertiesHelper::IsDryRun()) return 0;
3535
3536 if (dir[strlen(dir) - 1] == '/') {
3537 ++slash;
3538 }
3539 dirp = opendir(dir);
3540 if (dirp == nullptr) {
3541 retval = -errno;
3542 MYLOGE("%s: %s\n", dir, strerror(errno));
3543 return retval;
3544 }
3545
3546 if (!dump_from_fd) {
3547 dump_from_fd = dump_file_from_fd;
3548 }
3549 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
3550 if ((d->d_name[0] == '.')
3551 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
3552 || (d->d_name[1] == '\0'))) {
3553 continue;
3554 }
3555 asprintf(&newpath, "%s%s%s%s", dir, slash, d->d_name,
3556 (d->d_type == DT_DIR) ? "/" : "");
3557 if (!newpath) {
3558 retval = -errno;
3559 continue;
3560 }
3561 if (skip && (*skip)(newpath)) {
3562 continue;
3563 }
3564 if (d->d_type == DT_DIR) {
3565 int ret = dump_files("", newpath, skip, dump_from_fd);
3566 if (ret < 0) {
3567 retval = ret;
3568 }
3569 continue;
3570 }
3571 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(newpath, O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
3572 if (fd.get() < 0) {
3573 retval = -1;
3574 printf("*** %s: %s\n", newpath, strerror(errno));
3575 continue;
3576 }
3577 (*dump_from_fd)(nullptr, newpath, fd.get());
3578 }
3579 closedir(dirp);
3580 if (!title.empty()) {
3581 printf("\n");
3582 }
3583 return retval;
3584}
3585
3586/* fd must have been opened with the flag O_NONBLOCK. With this flag set,
3587 * it's possible to avoid issues where opening the file itself can get
3588 * stuck.
3589 */
3590int dump_file_from_fd(const char *title, const char *path, int fd) {
3591 if (PropertiesHelper::IsDryRun()) return 0;
3592
3593 int flags = fcntl(fd, F_GETFL);
3594 if (flags == -1) {
3595 printf("*** %s: failed to get flags on fd %d: %s\n", path, fd, strerror(errno));
3596 return -1;
3597 } else if (!(flags & O_NONBLOCK)) {
3598 printf("*** %s: fd must have O_NONBLOCK set.\n", path);
3599 return -1;
3600 }
3601 return DumpFileFromFdToFd(title, path, fd, STDOUT_FILENO, PropertiesHelper::IsDryRun());
3602}
3603
3604int Dumpstate::RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Nandana Dutt8d945c02019-08-14 13:30:07 +01003605 const CommandOptions& options, bool verbose_duration) {
3606 DurationReporter duration_reporter(title, false /* logcat_only */, verbose_duration);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003607
3608 int status = RunCommandToFd(STDOUT_FILENO, title, full_command, options);
3609
3610 /* TODO: for now we're simplifying the progress calculation by using the
3611 * timeout as the weight. It's a good approximation for most cases, except when calling dumpsys,
3612 * where its weight should be much higher proportionally to its timeout.
3613 * Ideally, it should use a options.EstimatedDuration() instead...*/
3614 UpdateProgress(options.Timeout());
3615
3616 return status;
3617}
3618
3619void Dumpstate::RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsys_args,
3620 const CommandOptions& options, long dumpsysTimeoutMs) {
3621 long timeout_ms = dumpsysTimeoutMs > 0 ? dumpsysTimeoutMs : options.TimeoutInMs();
3622 std::vector<std::string> dumpsys = {"/system/bin/dumpsys", "-T", std::to_string(timeout_ms)};
3623 dumpsys.insert(dumpsys.end(), dumpsys_args.begin(), dumpsys_args.end());
3624 RunCommand(title, dumpsys, options);
3625}
3626
3627int open_socket(const char *service) {
3628 int s = android_get_control_socket(service);
3629 if (s < 0) {
3630 MYLOGE("android_get_control_socket(%s): %s\n", service, strerror(errno));
3631 return -1;
3632 }
3633 fcntl(s, F_SETFD, FD_CLOEXEC);
3634
3635 // Set backlog to 0 to make sure that queue size will be minimum.
3636 // In Linux, because the minimum queue will be 1, connect() will be blocked
3637 // if the other clients already called connect() and the connection request was not accepted.
3638 if (listen(s, 0) < 0) {
3639 MYLOGE("listen(control socket): %s\n", strerror(errno));
3640 return -1;
3641 }
3642
3643 struct sockaddr addr;
3644 socklen_t alen = sizeof(addr);
Abhijeet Kaur2113cae2019-09-13 09:24:15 +01003645 int fd = accept4(s, &addr, &alen, SOCK_CLOEXEC);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003646
3647 // Close socket just after accept(), to make sure that connect() by client will get error
3648 // when the socket is used by the other services.
3649 // There is still a race condition possibility between accept and close, but there is no way
3650 // to close-on-accept atomically.
3651 // See detail; b/123306389#comment25
3652 close(s);
3653
3654 if (fd < 0) {
3655 MYLOGE("accept(control socket): %s\n", strerror(errno));
3656 return -1;
3657 }
3658
3659 return fd;
3660}
3661
3662/* redirect output to a service control socket */
3663bool redirect_to_socket(FILE* redirect, const char* service) {
3664 int fd = open_socket(service);
3665 if (fd == -1) {
3666 return false;
3667 }
3668 fflush(redirect);
3669 // TODO: handle dup2 failure
3670 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
3671 close(fd);
3672 return true;
3673}
3674
3675// TODO: should call is_valid_output_file and/or be merged into it.
3676void create_parent_dirs(const char *path) {
3677 char *chp = const_cast<char *> (path);
3678
3679 /* skip initial slash */
3680 if (chp[0] == '/')
3681 chp++;
3682
3683 /* create leading directories, if necessary */
3684 struct stat dir_stat;
3685 while (chp && chp[0]) {
3686 chp = strchr(chp, '/');
3687 if (chp) {
3688 *chp = 0;
3689 if (stat(path, &dir_stat) == -1 || !S_ISDIR(dir_stat.st_mode)) {
3690 MYLOGI("Creating directory %s\n", path);
3691 if (mkdir(path, 0770)) { /* drwxrwx--- */
3692 MYLOGE("Unable to create directory %s: %s\n", path, strerror(errno));
3693 } else if (chown(path, AID_SHELL, AID_SHELL)) {
3694 MYLOGE("Unable to change ownership of dir %s: %s\n", path, strerror(errno));
3695 }
3696 }
3697 *chp++ = '/';
3698 }
3699 }
3700}
3701
3702bool _redirect_to_file(FILE* redirect, char* path, int truncate_flag) {
3703 create_parent_dirs(path);
3704
3705 int fd = TEMP_FAILURE_RETRY(open(path,
3706 O_WRONLY | O_CREAT | truncate_flag | O_CLOEXEC | O_NOFOLLOW,
3707 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH));
3708 if (fd < 0) {
3709 MYLOGE("%s: %s\n", path, strerror(errno));
3710 return false;
3711 }
3712
3713 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
3714 close(fd);
3715 return true;
3716}
3717
3718bool redirect_to_file(FILE* redirect, char* path) {
3719 return _redirect_to_file(redirect, path, O_TRUNC);
3720}
3721
3722bool redirect_to_existing_file(FILE* redirect, char* path) {
3723 return _redirect_to_file(redirect, path, O_APPEND);
3724}
3725
3726void dump_route_tables() {
3727 DurationReporter duration_reporter("DUMP ROUTE TABLES");
3728 if (PropertiesHelper::IsDryRun()) return;
3729 const char* const RT_TABLES_PATH = "/data/misc/net/rt_tables";
3730 ds.DumpFile("RT_TABLES", RT_TABLES_PATH);
3731 FILE* fp = fopen(RT_TABLES_PATH, "re");
3732 if (!fp) {
3733 printf("*** %s: %s\n", RT_TABLES_PATH, strerror(errno));
3734 return;
3735 }
3736 char table[16];
3737 // Each line has an integer (the table number), a space, and a string (the table name). We only
3738 // need the table number. It's a 32-bit unsigned number, so max 10 chars. Skip the table name.
3739 // Add a fixed max limit so this doesn't go awry.
3740 for (int i = 0; i < 64 && fscanf(fp, " %10s %*s", table) == 1; ++i) {
3741 RunCommand("ROUTE TABLE IPv4", {"ip", "-4", "route", "show", "table", table});
3742 RunCommand("ROUTE TABLE IPv6", {"ip", "-6", "route", "show", "table", table});
3743 }
3744 fclose(fp);
3745}
3746
3747// TODO: make this function thread safe if sections are generated in parallel.
3748void Dumpstate::UpdateProgress(int32_t delta_sec) {
3749 if (progress_ == nullptr) {
3750 MYLOGE("UpdateProgress: progress_ not set\n");
3751 return;
3752 }
3753
3754 // Always update progess so stats can be tuned...
Nandana Duttf02cd782019-06-14 14:25:13 +01003755 progress_->Inc(delta_sec);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003756
3757 // ...but only notifiy listeners when necessary.
3758 if (!options_->do_progress_updates) return;
3759
3760 int progress = progress_->Get();
3761 int max = progress_->GetMax();
Nandana Duttf02cd782019-06-14 14:25:13 +01003762 int percent = 100 * progress / max;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003763
Nandana Duttf02cd782019-06-14 14:25:13 +01003764 if (last_reported_percent_progress_ > 0 && percent <= last_reported_percent_progress_) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003765 return;
3766 }
Nandana Duttf02cd782019-06-14 14:25:13 +01003767 last_reported_percent_progress_ = percent;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003768
3769 if (control_socket_fd_ >= 0) {
3770 dprintf(control_socket_fd_, "PROGRESS:%d/%d\n", progress, max);
3771 fsync(control_socket_fd_);
3772 }
3773
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003774 if (listener_ != nullptr) {
Nandana Dutt235c6672019-11-14 15:22:32 +00003775 if (percent % 10 == 0) {
3776 // We don't want to spam logcat, so only log multiples of 10.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01003777 MYLOGD("Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003778 } else {
3779 // stderr is ignored on normal invocations, but useful when calling
3780 // /system/bin/dumpstate directly for debuggging.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01003781 fprintf(stderr, "Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003782 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003783
3784 listener_->onProgress(percent);
3785 }
3786}
3787
3788void Dumpstate::TakeScreenshot(const std::string& path) {
3789 const std::string& real_path = path.empty() ? screenshot_path_ : path;
3790 int status =
3791 RunCommand("", {"/system/bin/screencap", "-p", real_path},
3792 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3793 if (status == 0) {
3794 MYLOGD("Screenshot saved on %s\n", real_path.c_str());
3795 } else {
3796 MYLOGE("Failed to take screenshot on %s\n", real_path.c_str());
3797 }
Paul Chang0d2aad72020-02-13 20:04:03 +08003798 if (listener_ != nullptr) {
3799 // Show a visual indication to indicate screenshot is taken via
3800 // IDumpstateListener.onScreenshotTaken()
3801 listener_->onScreenshotTaken(status == 0);
3802 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003803}
3804
3805bool is_dir(const char* pathname) {
3806 struct stat info;
3807 if (stat(pathname, &info) == -1) {
3808 return false;
3809 }
3810 return S_ISDIR(info.st_mode);
3811}
3812
3813time_t get_mtime(int fd, time_t default_mtime) {
3814 struct stat info;
3815 if (fstat(fd, &info) == -1) {
3816 return default_mtime;
3817 }
3818 return info.st_mtime;
3819}