blob: fdee3e5e6bd6b10ea5ce91c8e217fc9250cf1a52 [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"
Kevin Jeon2c02e8e2022-07-07 21:45:17 +000018#define ATRACE_TAG ATRACE_TAG_ALWAYS
Colin Crossf45fa6b2012-03-26 12:38:26 -070019
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -070020#include <dirent.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070021#include <errno.h>
22#include <fcntl.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010023#include <inttypes.h>
Felipe Lemead5f6c42015-11-30 14:26:46 -080024#include <libgen.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070025#include <limits.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010026#include <math.h>
27#include <poll.h>
Mark Salyzyn8f37aa52015-06-12 12:28:24 -070028#include <stdbool.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070029#include <stdio.h>
30#include <stdlib.h>
31#include <string.h>
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -070032#include <sys/mount.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080033#include <sys/poll.h>
Christopher Ferris7dc7f322014-07-22 16:08:19 -070034#include <sys/prctl.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070035#include <sys/resource.h>
36#include <sys/stat.h>
37#include <sys/time.h>
38#include <sys/wait.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010039#include <signal.h>
40#include <stdarg.h>
41#include <string.h>
42#include <sys/capability.h>
43#include <sys/inotify.h>
44#include <sys/klog.h>
45#include <time.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070046#include <unistd.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070047
48#include <chrono>
Hridya Valsarajuac582cd2019-08-05 15:39:54 -070049#include <cmath>
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +000050#include <fstream>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070051#include <functional>
52#include <future>
Narayan Kamath8f788292017-05-25 13:20:39 +010053#include <memory>
Hridya Valsarajuac582cd2019-08-05 15:39:54 -070054#include <numeric>
Narayan Kamath8f788292017-05-25 13:20:39 +010055#include <regex>
56#include <set>
57#include <string>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070058#include <utility>
Narayan Kamath8f788292017-05-25 13:20:39 +010059#include <vector>
Colin Crossf45fa6b2012-03-26 12:38:26 -070060
Kedar Chitnis9fd8c052021-11-16 09:09:22 +000061#include <aidl/android/hardware/dumpstate/IDumpstateDevice.h>
Felipe Leme96c2bbb2016-09-26 09:21:21 -070062#include <android-base/file.h>
63#include <android-base/properties.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070064#include <android-base/scopeguard.h>
Elliott Hughes9dc117c2015-12-07 14:21:50 -080065#include <android-base/stringprintf.h>
Naveen Kalla058e1e82016-10-19 21:38:44 -070066#include <android-base/strings.h>
Andreas Gampeaff68432016-07-18 18:01:27 -070067#include <android-base/unique_fd.h>
Kedar Chitnis9fd8c052021-11-16 09:09:22 +000068#include <android/binder_manager.h>
69#include <android/binder_process.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010070#include <android/content/pm/IPackageManagerNative.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080071#include <android/hardware/dumpstate/1.0/IDumpstateDevice.h>
Hunter Knepshield8540faf2020-02-04 19:47:20 -080072#include <android/hardware/dumpstate/1.1/IDumpstateDevice.h>
73#include <android/hardware/dumpstate/1.1/types.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080074#include <android/hidl/manager/1.0/IServiceManager.h>
Nandana Duttd2f5f082019-01-18 17:13:52 +000075#include <android/os/IIncidentCompanion.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010076#include <binder/IServiceManager.h>
Nikhil Kumar28ce35e2023-01-10 14:32:44 +000077#include <cutils/multiuser.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080078#include <cutils/native_handle.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070079#include <cutils/properties.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010080#include <cutils/sockets.h>
Kevin Jeon2c02e8e2022-07-07 21:45:17 +000081#include <cutils/trace.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000082#include <debuggerd/client.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080083#include <dumpsys.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000084#include <dumputils/dump_utils.h>
Sahana Raof35ed432019-07-12 10:47:52 +010085#include <hardware_legacy/power.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080086#include <hidl/ServiceManagement.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010087#include <log/log.h>
Tom Cherryf4472f32020-08-05 09:31:17 -070088#include <log/log_read.h>
Felipe Leme75876a22016-10-27 16:31:27 -070089#include <openssl/sha.h>
Mark Salyzyn6c3d90f2016-09-27 14:55:27 -070090#include <private/android_filesystem_config.h>
91#include <private/android_logger.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080092#include <serviceutils/PriorityDumper.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070093#include <utils/StrongPointer.h>
Devin Moore8df81bb2022-06-08 22:47:02 +000094#include <vintf/VintfObject.h>
Felipe Lemef0292972016-11-22 13:57:05 -080095#include "DumpstateInternal.h"
Felipe Leme75876a22016-10-27 16:31:27 -070096#include "DumpstateService.h"
Colin Crossf45fa6b2012-03-26 12:38:26 -070097#include "dumpstate.h"
Felipe Leme6e01fa62015-11-11 19:35:14 -080098
Kedar Chitnis9fd8c052021-11-16 09:09:22 +000099namespace dumpstate_hal_hidl_1_0 = android::hardware::dumpstate::V1_0;
100namespace dumpstate_hal_hidl = android::hardware::dumpstate::V1_1;
101namespace dumpstate_hal_aidl = aidl::android::hardware::dumpstate;
102
Vishnu Naire97d6122018-01-18 13:58:56 -0800103using ::std::literals::chrono_literals::operator""ms;
104using ::std::literals::chrono_literals::operator""s;
Rhed Jao5377d792020-07-16 17:37:39 +0800105using ::std::placeholders::_1;
Steven Morelandcb7ef822016-11-29 13:20:37 -0800106
Felipe Leme47e9be22016-12-21 15:37:07 -0800107// TODO: remove once moved to namespace
Vishnu Naire97d6122018-01-18 13:58:56 -0800108using android::defaultServiceManager;
109using android::Dumpsys;
110using android::INVALID_OPERATION;
111using android::IServiceManager;
112using android::OK;
113using android::sp;
114using android::status_t;
115using android::String16;
116using android::String8;
117using android::TIMED_OUT;
118using android::UNKNOWN_ERROR;
119using android::Vector;
Nandana Dutt979388e2018-11-30 16:48:55 +0000120using android::base::StringPrintf;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000121using android::os::IDumpstateListener;
Felipe Leme47e9be22016-12-21 15:37:07 -0800122using android::os::dumpstate::CommandOptions;
123using android::os::dumpstate::DumpFileToFd;
Rhed Jao5377d792020-07-16 17:37:39 +0800124using android::os::dumpstate::DumpPool;
Vishnu Naire97d6122018-01-18 13:58:56 -0800125using android::os::dumpstate::PropertiesHelper;
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800126using android::os::dumpstate::TaskQueue;
Chris Morinbc223142022-02-04 14:17:11 -0800127using android::os::dumpstate::WaitForTask;
Felipe Leme47e9be22016-12-21 15:37:07 -0800128
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100129// Keep in sync with
130// frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
131static const int TRACE_DUMP_TIMEOUT_MS = 10000; // 10 seconds
132
133/* Most simple commands have 10 as timeout, so 5 is a good estimate */
134static const int32_t WEIGHT_FILE = 5;
135
136// TODO: temporary variables and functions used during C++ refactoring
137static Dumpstate& ds = Dumpstate::GetInstance();
138static int RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Nandana Dutt8d945c02019-08-14 13:30:07 +0100139 const CommandOptions& options = CommandOptions::DEFAULT,
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800140 bool verbose_duration = false, int out_fd = STDOUT_FILENO) {
141 return ds.RunCommand(title, full_command, options, verbose_duration, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100142}
143
144// Reasonable value for max stats.
145static const int STATS_MAX_N_RUNS = 1000;
146static const long STATS_MAX_AVERAGE = 100000;
147
148CommandOptions Dumpstate::DEFAULT_DUMPSYS = CommandOptions::WithTimeout(30).Build();
149
Nandana Duttd2f5f082019-01-18 17:13:52 +0000150typedef Dumpstate::ConsentCallback::ConsentResult UserConsentResult;
151
Colin Crossf45fa6b2012-03-26 12:38:26 -0700152/* read before root is shed */
153static char cmdline_buf[16384] = "(unknown)";
Yi Kong19d5c002018-07-20 13:39:55 -0700154static const char *dump_traces_path = nullptr;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000155static const uint64_t USER_CONSENT_TIMEOUT_MS = 30 * 1000;
Hunter Knepshield70610fa2020-01-03 15:27:33 -0800156// Because telephony reports are significantly faster to collect (< 10 seconds vs. > 2 minutes),
157// it's often the case that they time out far too quickly for consent with such a hefty dialog for
158// the user to read. For telephony reports only, we increase the default timeout to 2 minutes to
159// roughly match full reports' durations.
160static const uint64_t TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS = 2 * 60 * 1000;
Colin Crossf45fa6b2012-03-26 12:38:26 -0700161
Felipe Leme1d486fe2016-10-14 18:06:47 -0700162// TODO: variables and functions below should be part of dumpstate object
163
Felipe Leme635ca312016-01-05 14:23:02 -0800164static std::set<std::string> mount_points;
165void add_mountinfo();
Felipe Leme78f2c862015-12-21 09:55:22 -0800166
Todd Poynor2a83daa2013-11-22 15:44:22 -0800167#define PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops"
Mark Salyzyn7d0a7622016-06-24 14:06:15 -0700168#define ALT_PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops-0"
Wei Wang509bb5d2017-06-09 14:42:12 -0700169#define BLK_DEV_SYS_DIR "/sys/block"
Todd Poynor2a83daa2013-11-22 15:44:22 -0800170
Felipe Lemee82a27d2016-01-05 13:35:44 -0800171#define RECOVERY_DIR "/cache/recovery"
Mark Salyzynd6ab0112016-03-25 12:56:39 -0700172#define RECOVERY_DATA_DIR "/data/misc/recovery"
Tianjie Xu75d53362018-04-11 16:42:28 -0700173#define UPDATE_ENGINE_LOG_DIR "/data/misc/update_engine_log"
Kelvin Zhang6eaa0f92022-09-12 09:29:19 -0700174#define UPDATE_ENGINE_PREF_DIR "/data/misc/update_engine/prefs"
Mark Salyzyn4d42dea2016-04-01 10:03:14 -0700175#define LOGPERSIST_DATA_DIR "/data/misc/logd"
Jerry Changa1df8a92020-01-02 16:03:39 +0800176#define PREREBOOT_DATA_DIR "/data/misc/prereboot"
David Brazdild2991962016-06-03 14:40:44 +0100177#define PROFILE_DATA_DIR_CUR "/data/misc/profiles/cur"
178#define PROFILE_DATA_DIR_REF "/data/misc/profiles/ref"
Benedict Wong8f9d8a42019-01-03 16:19:38 -0800179#define XFRM_STAT_PROC_FILE "/proc/net/xfrm_stat"
Erik Kline08165202016-05-30 11:55:44 +0900180#define WLUTIL "/vendor/xbin/wlutil"
Vishnu Nair36b4cdb2017-11-17 10:27:05 -0800181#define WMTRACE_DATA_DIR "/data/misc/wmtrace"
Yifan Hong3945e1b2019-10-29 12:59:23 -0700182#define OTA_METADATA_DIR "/metadata/ota"
Yifan Hong0efa7972020-02-03 16:45:02 -0800183#define SNAPSHOTCTL_LOG_DIR "/data/misc/snapshotctl_log"
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +0900184#define LINKERCONFIG_DIR "/linkerconfig"
Calin Juravlef84d3692020-04-28 15:31:12 -0700185#define PACKAGE_DEX_USE_LIST "/data/system/package-dex-usage.list"
Primiano Tuccifaaaafb2021-01-14 12:26:29 +0000186#define SYSTEM_TRACE_SNAPSHOT "/data/misc/perfetto-traces/bugreport/systrace.pftrace"
Li Li2eedd412021-06-30 15:11:53 -0700187#define CGROUPFS_DIR "/sys/fs/cgroup"
Mårten Kongstad60195a72022-09-20 14:14:20 +0200188#define SDK_EXT_INFO "/apex/com.android.sdkext/bin/derive_sdk"
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700189
Narayan Kamath8f788292017-05-25 13:20:39 +0100190// TODO(narayan): Since this information has to be kept in sync
191// with tombstoned, we should just put it in a common header.
192//
193// File: system/core/debuggerd/tombstoned/tombstoned.cpp
Narayan Kamathbd863722017-06-01 18:50:12 +0100194static const std::string TOMBSTONE_DIR = "/data/tombstones/";
195static const std::string TOMBSTONE_FILE_PREFIX = "tombstone_";
196static const std::string ANR_DIR = "/data/anr/";
197static const std::string ANR_FILE_PREFIX = "anr_";
Woody Lin20767a92022-11-29 15:50:24 +0800198static const std::string SHUTDOWN_CHECKPOINTS_DIR = "/data/system/shutdown-checkpoints/";
199static const std::string SHUTDOWN_CHECKPOINTS_FILE_PREFIX = "checkpoints-";
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700200
Felipe Lemee844a9d2016-09-21 15:01:39 -0700201// TODO: temporary variables and functions used during C++ refactoring
Nandana Dutt979388e2018-11-30 16:48:55 +0000202
Nandana Dutt5c390032019-03-12 10:52:56 +0000203#define RETURN_IF_USER_DENIED_CONSENT() \
204 if (ds.IsUserConsentDenied()) { \
205 MYLOGE("Returning early as user denied consent to share bugreport with calling app."); \
206 return Dumpstate::RunStatus::USER_CONSENT_DENIED; \
207 }
208
209// Runs func_ptr, but checks user consent before and after running it. Returns USER_CONSENT_DENIED
210// if consent is found to be denied.
211#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(func_ptr, ...) \
212 RETURN_IF_USER_DENIED_CONSENT(); \
213 func_ptr(__VA_ARGS__); \
214 RETURN_IF_USER_DENIED_CONSENT();
215
Rhed Jao5377d792020-07-16 17:37:39 +0800216// Runs func_ptr, and logs a duration report after it's finished.
217#define RUN_SLOW_FUNCTION_AND_LOG(log_title, func_ptr, ...) \
218 { \
219 DurationReporter duration_reporter_in_macro(log_title); \
220 func_ptr(__VA_ARGS__); \
221 }
222
223// Similar with RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK, an additional duration report
224// is output after a slow function is finished.
225#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(log_title, func_ptr, ...) \
226 RETURN_IF_USER_DENIED_CONSENT(); \
227 RUN_SLOW_FUNCTION_AND_LOG(log_title, func_ptr, __VA_ARGS__); \
228 RETURN_IF_USER_DENIED_CONSENT();
229
Chris Morinbc223142022-02-04 14:17:11 -0800230#define WAIT_TASK_WITH_CONSENT_CHECK(future) \
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800231 RETURN_IF_USER_DENIED_CONSENT(); \
Chris Morinbc223142022-02-04 14:17:11 -0800232 WaitForTask(future); \
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800233 RETURN_IF_USER_DENIED_CONSENT();
234
Sahana Raof35ed432019-07-12 10:47:52 +0100235static const char* WAKE_LOCK_NAME = "dumpstate_wakelock";
236
Rhed Jao5377d792020-07-16 17:37:39 +0800237// Names of parallel tasks, they are used for the DumpPool to identify the dump
238// task and the log title of the duration report.
239static const std::string DUMP_TRACES_TASK = "DUMP TRACES";
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800240static const std::string DUMP_INCIDENT_REPORT_TASK = "INCIDENT REPORT";
Aaron Huang24d215d2022-04-27 18:51:16 +0800241static const std::string DUMP_NETSTATS_PROTO_TASK = "DUMP NETSTATS PROTO";
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800242static const std::string DUMP_HALS_TASK = "DUMP HALS";
243static const std::string DUMP_BOARD_TASK = "dumpstate_board()";
Rhed Jaoe017f982020-07-21 17:58:41 +0800244static const std::string DUMP_CHECKINS_TASK = "DUMP CHECKINS";
Kean Mariotti306633e2022-09-05 16:30:47 +0000245static const std::string POST_PROCESS_UI_TRACES_TASK = "POST-PROCESS UI TRACES";
Rhed Jao5377d792020-07-16 17:37:39 +0800246
Nandana Dutt979388e2018-11-30 16:48:55 +0000247namespace android {
248namespace os {
249namespace {
250
251static int Open(std::string path, int flags, mode_t mode = 0) {
252 int fd = TEMP_FAILURE_RETRY(open(path.c_str(), flags, mode));
253 if (fd == -1) {
254 MYLOGE("open(%s, %s)\n", path.c_str(), strerror(errno));
255 }
256 return fd;
257}
258
mhasank2d75c442020-06-11 15:05:25 -0700259static int OpenForWrite(std::string path) {
260 return Open(path, O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
261 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH);
262}
Nandana Dutt979388e2018-11-30 16:48:55 +0000263
264static int OpenForRead(std::string path) {
265 return Open(path, O_RDONLY | O_CLOEXEC | O_NOFOLLOW);
266}
267
268bool CopyFile(int in_fd, int out_fd) {
269 char buf[4096];
270 ssize_t byte_count;
271 while ((byte_count = TEMP_FAILURE_RETRY(read(in_fd, buf, sizeof(buf)))) > 0) {
272 if (!android::base::WriteFully(out_fd, buf, byte_count)) {
273 return false;
274 }
275 }
276 return (byte_count != -1);
277}
278
279static bool CopyFileToFd(const std::string& input_file, int out_fd) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000280 MYLOGD("Going to copy file (%s) to %d\n", input_file.c_str(), out_fd);
Nandana Dutt979388e2018-11-30 16:48:55 +0000281
282 // Obtain a handle to the source file.
283 android::base::unique_fd in_fd(OpenForRead(input_file));
284 if (out_fd != -1 && in_fd.get() != -1) {
285 if (CopyFile(in_fd.get(), out_fd)) {
286 return true;
287 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000288 MYLOGE("Failed to copy file: %s\n", strerror(errno));
Nandana Dutt979388e2018-11-30 16:48:55 +0000289 }
290 return false;
291}
292
Nandana Duttd2f5f082019-01-18 17:13:52 +0000293static bool UnlinkAndLogOnError(const std::string& file) {
Nandana Dutt8ae16e62020-03-27 10:20:22 +0000294 if (file.empty()) {
295 return false;
296 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000297 if (unlink(file.c_str())) {
298 MYLOGE("Failed to unlink file (%s): %s\n", file.c_str(), strerror(errno));
Nandana Duttd2f5f082019-01-18 17:13:52 +0000299 return false;
300 }
301 return true;
302}
Nandana Dutt979388e2018-11-30 16:48:55 +0000303
Nikita Ioffea325a572019-05-16 19:49:47 +0100304int64_t GetModuleMetadataVersion() {
305 auto binder = defaultServiceManager()->getService(android::String16("package_native"));
306 if (binder == nullptr) {
307 MYLOGE("Failed to retrieve package_native service");
308 return 0L;
309 }
310 auto package_service = android::interface_cast<content::pm::IPackageManagerNative>(binder);
311 std::string package_name;
312 auto status = package_service->getModuleMetadataPackageName(&package_name);
313 if (!status.isOk()) {
314 MYLOGE("Failed to retrieve module metadata package name: %s", status.toString8().c_str());
315 return 0L;
316 }
Nandana Duttdb379fa2019-10-09 16:54:41 +0100317 MYLOGD("Module metadata package name: %s\n", package_name.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100318 int64_t version_code;
319 status = package_service->getVersionCodeForPackage(android::String16(package_name.c_str()),
320 &version_code);
321 if (!status.isOk()) {
322 MYLOGE("Failed to retrieve module metadata version: %s", status.toString8().c_str());
323 return 0L;
324 }
325 return version_code;
326}
327
mhasank2d75c442020-06-11 15:05:25 -0700328static bool PathExists(const std::string& path) {
329 struct stat sb;
330 return stat(path.c_str(), &sb) == 0;
331}
332
333static bool CopyFileToFile(const std::string& input_file, const std::string& output_file) {
334 if (input_file == output_file) {
335 MYLOGD("Skipping copying bugreport file since the destination is the same (%s)\n",
336 output_file.c_str());
337 return false;
338 }
339 else if (PathExists(output_file)) {
340 MYLOGD("Cannot overwrite an existing file (%s)\n", output_file.c_str());
341 return false;
342 }
343
344 MYLOGD("Going to copy bugreport file (%s) to %s\n", input_file.c_str(), output_file.c_str());
345 android::base::unique_fd out_fd(OpenForWrite(output_file));
346 return CopyFileToFd(input_file, out_fd.get());
347}
348
Nandana Dutt979388e2018-11-30 16:48:55 +0000349} // namespace
350} // namespace os
351} // namespace android
352
Felipe Leme678727a2016-09-21 17:22:11 -0700353static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
Felipe Lemebda15a02016-11-16 17:48:25 -0800354 const CommandOptions& options = Dumpstate::DEFAULT_DUMPSYS,
Rhed Jaoe017f982020-07-21 17:58:41 +0800355 long dumpsysTimeoutMs = 0, int out_fd = STDOUT_FILENO) {
356 return ds.RunDumpsys(title, dumpsysArgs, options, dumpsysTimeoutMs, out_fd);
357}
358static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
359 int out_fd) {
360 return ds.RunDumpsys(title, dumpsysArgs, Dumpstate::DEFAULT_DUMPSYS, 0, out_fd);
Felipe Leme678727a2016-09-21 17:22:11 -0700361}
362static int DumpFile(const std::string& title, const std::string& path) {
363 return ds.DumpFile(title, path);
364}
Felipe Lemee82a27d2016-01-05 13:35:44 -0800365
Felipe Lemee844a9d2016-09-21 15:01:39 -0700366// Relative directory (inside the zip) for all files copied as-is into the bugreport.
367static const std::string ZIP_ROOT_DIR = "FS";
368
Vishnu Naire97d6122018-01-18 13:58:56 -0800369static const std::string kProtoPath = "proto/";
370static const std::string kProtoExt = ".proto";
Jie Song9fbfad02017-06-20 16:29:42 -0700371static const std::string kDumpstateBoardFiles[] = {
372 "dumpstate_board.txt",
Felipe Leme95d6ca52017-08-01 16:35:56 -0700373 "dumpstate_board.bin"
Jie Song9fbfad02017-06-20 16:29:42 -0700374};
375static const int NUM_OF_DUMPS = arraysize(kDumpstateBoardFiles);
376
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700377static constexpr char PROPERTY_LAST_ID[] = "dumpstate.last_id";
Felipe Lemed071c682016-10-20 16:48:00 -0700378static constexpr char PROPERTY_VERSION[] = "dumpstate.version";
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700379
Felipe Lemef0292972016-11-22 13:57:05 -0800380static const CommandOptions AS_ROOT_20 = CommandOptions::WithTimeout(20).AsRoot().Build();
381
Narayan Kamath8f788292017-05-25 13:20:39 +0100382/*
Narayan Kamathbd863722017-06-01 18:50:12 +0100383 * Returns a vector of dump fds under |dir_path| with a given |file_prefix|.
Rhed Jao01dc0c62020-06-03 17:13:30 +0800384 * The returned vector is sorted by the mtimes of the dumps with descending
Chris Morinc2cba7a2022-02-01 17:06:50 -0800385 * order.
Narayan Kamath8f788292017-05-25 13:20:39 +0100386 */
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700387static std::vector<DumpData> GetDumpFds(const std::string& dir_path,
Chris Morinc2cba7a2022-02-01 17:06:50 -0800388 const std::string& file_prefix) {
Narayan Kamathbd863722017-06-01 18:50:12 +0100389 std::unique_ptr<DIR, decltype(&closedir)> dump_dir(opendir(dir_path.c_str()), closedir);
Narayan Kamath8f788292017-05-25 13:20:39 +0100390
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700391 if (dump_dir == nullptr) {
392 MYLOGW("Unable to open directory %s: %s\n", dir_path.c_str(), strerror(errno));
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700393 return std::vector<DumpData>();
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700394 }
395
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700396 std::vector<DumpData> dump_data;
Narayan Kamathbd863722017-06-01 18:50:12 +0100397 struct dirent* entry = nullptr;
398 while ((entry = readdir(dump_dir.get()))) {
399 if (entry->d_type != DT_REG) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100400 continue;
401 }
402
Narayan Kamathbd863722017-06-01 18:50:12 +0100403 const std::string base_name(entry->d_name);
404 if (base_name.find(file_prefix) != 0) {
405 continue;
406 }
407
408 const std::string abs_path = dir_path + base_name;
409 android::base::unique_fd fd(
410 TEMP_FAILURE_RETRY(open(abs_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW | O_NONBLOCK)));
411 if (fd == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700412 MYLOGW("Unable to open dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamathbd863722017-06-01 18:50:12 +0100413 break;
414 }
415
416 struct stat st = {};
417 if (fstat(fd, &st) == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700418 MYLOGW("Unable to stat dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamath8f788292017-05-25 13:20:39 +0100419 continue;
420 }
421
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700422 dump_data.emplace_back(DumpData{abs_path, std::move(fd), st.st_mtime});
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700423 }
Rhed Jao01dc0c62020-06-03 17:13:30 +0800424 if (!dump_data.empty()) {
425 std::sort(dump_data.begin(), dump_data.end(),
426 [](const auto& a, const auto& b) { return a.mtime > b.mtime; });
427 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100428
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700429 return dump_data;
Narayan Kamath8f788292017-05-25 13:20:39 +0100430}
431
Narayan Kamathbd863722017-06-01 18:50:12 +0100432static bool AddDumps(const std::vector<DumpData>::const_iterator start,
433 const std::vector<DumpData>::const_iterator end,
434 const char* type_name, const bool add_to_zip) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100435 bool dumped = false;
Narayan Kamathbd863722017-06-01 18:50:12 +0100436 for (auto it = start; it != end; ++it) {
437 const std::string& name = it->name;
438 const int fd = it->fd;
Narayan Kamath8f788292017-05-25 13:20:39 +0100439 dumped = true;
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100440
441 // Seek to the beginning of the file before dumping any data. A given
442 // DumpData entry might be dumped multiple times in the report.
443 //
444 // For example, the most recent ANR entry is dumped to the body of the
445 // main entry and it also shows up as a separate entry in the bugreport
446 // ZIP file.
447 if (lseek(fd, 0, SEEK_SET) != static_cast<off_t>(0)) {
448 MYLOGE("Unable to add %s to zip file, lseek failed: %s\n", name.c_str(),
449 strerror(errno));
450 }
451
Chris Morinc2cba7a2022-02-01 17:06:50 -0800452 if (add_to_zip) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800453 if (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + name, fd, /* timeout = */ 0ms) != OK) {
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100454 MYLOGE("Unable to add %s to zip file, addZipEntryFromFd failed\n", name.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100455 }
456 } else {
457 dump_file_from_fd(type_name, name.c_str(), fd);
458 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100459 }
460
461 return dumped;
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700462}
463
Felipe Leme635ca312016-01-05 14:23:02 -0800464// for_each_pid() callback to get mount info about a process.
Felipe Leme4c2d6632016-09-28 14:32:00 -0700465void do_mountinfo(int pid, const char* name __attribute__((unused))) {
Felipe Leme635ca312016-01-05 14:23:02 -0800466 char path[PATH_MAX];
467
468 // Gets the the content of the /proc/PID/ns/mnt link, so only unique mount points
469 // are added.
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700470 snprintf(path, sizeof(path), "/proc/%d/ns/mnt", pid);
Felipe Leme635ca312016-01-05 14:23:02 -0800471 char linkname[PATH_MAX];
472 ssize_t r = readlink(path, linkname, PATH_MAX);
473 if (r == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800474 MYLOGE("Unable to read link for %s: %s\n", path, strerror(errno));
Felipe Leme635ca312016-01-05 14:23:02 -0800475 return;
476 }
477 linkname[r] = '\0';
478
479 if (mount_points.find(linkname) == mount_points.end()) {
480 // First time this mount point was found: add it
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700481 snprintf(path, sizeof(path), "/proc/%d/mountinfo", pid);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700482 if (ds.AddZipEntry(ZIP_ROOT_DIR + path, path)) {
Felipe Leme635ca312016-01-05 14:23:02 -0800483 mount_points.insert(linkname);
484 } else {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800485 MYLOGE("Unable to add mountinfo %s to zip file\n", path);
Felipe Leme635ca312016-01-05 14:23:02 -0800486 }
487 }
488}
489
490void add_mountinfo() {
Felipe Leme678727a2016-09-21 17:22:11 -0700491 std::string title = "MOUNT INFO";
Felipe Leme635ca312016-01-05 14:23:02 -0800492 mount_points.clear();
Felipe Leme46b85da2016-11-21 17:40:45 -0800493 DurationReporter duration_reporter(title, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700494 for_each_pid(do_mountinfo, nullptr);
495 MYLOGD("%s: %d entries added to zip file\n", title.c_str(), (int)mount_points.size());
Felipe Leme635ca312016-01-05 14:23:02 -0800496}
497
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700498static void dump_dev_files(const char *title, const char *driverpath, const char *filename)
499{
500 DIR *d;
501 struct dirent *de;
502 char path[PATH_MAX];
503
504 d = opendir(driverpath);
Yi Kong19d5c002018-07-20 13:39:55 -0700505 if (d == nullptr) {
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700506 return;
507 }
508
509 while ((de = readdir(d))) {
510 if (de->d_type != DT_LNK) {
511 continue;
512 }
513 snprintf(path, sizeof(path), "%s/%s/%s", driverpath, de->d_name, filename);
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700514 DumpFile(title, path);
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700515 }
516
517 closedir(d);
518}
519
Mark Salyzyn326842f2015-04-30 09:49:41 -0700520static bool skip_not_stat(const char *path) {
521 static const char stat[] = "/stat";
522 size_t len = strlen(path);
523 if (path[len - 1] == '/') { /* Directory? */
524 return false;
525 }
526 return strcmp(path + len - sizeof(stat) + 1, stat); /* .../stat? */
527}
528
Felipe Leme4c2d6632016-09-28 14:32:00 -0700529static bool skip_none(const char* path __attribute__((unused))) {
Felipe Lemee82a27d2016-01-05 13:35:44 -0800530 return false;
531}
532
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700533unsigned long worst_write_perf = 20000; /* in KB/s */
Mark Salyzyn326842f2015-04-30 09:49:41 -0700534
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800535//
536// stat offsets
537// Name units description
538// ---- ----- -----------
539// read I/Os requests number of read I/Os processed
540#define __STAT_READ_IOS 0
541// read merges requests number of read I/Os merged with in-queue I/O
542#define __STAT_READ_MERGES 1
543// read sectors sectors number of sectors read
544#define __STAT_READ_SECTORS 2
545// read ticks milliseconds total wait time for read requests
546#define __STAT_READ_TICKS 3
547// write I/Os requests number of write I/Os processed
548#define __STAT_WRITE_IOS 4
549// write merges requests number of write I/Os merged with in-queue I/O
550#define __STAT_WRITE_MERGES 5
551// write sectors sectors number of sectors written
552#define __STAT_WRITE_SECTORS 6
553// write ticks milliseconds total wait time for write requests
554#define __STAT_WRITE_TICKS 7
555// in_flight requests number of I/Os currently in flight
556#define __STAT_IN_FLIGHT 8
557// io_ticks milliseconds total time this block device has been active
558#define __STAT_IO_TICKS 9
559// time_in_queue milliseconds total wait time for all requests
560#define __STAT_IN_QUEUE 10
561#define __STAT_NUMBER_FIELD 11
562//
563// read I/Os, write I/Os
564// =====================
565//
566// These values increment when an I/O request completes.
567//
568// read merges, write merges
569// =========================
570//
571// These values increment when an I/O request is merged with an
572// already-queued I/O request.
573//
574// read sectors, write sectors
575// ===========================
576//
577// These values count the number of sectors read from or written to this
578// block device. The "sectors" in question are the standard UNIX 512-byte
579// sectors, not any device- or filesystem-specific block size. The
580// counters are incremented when the I/O completes.
581#define SECTOR_SIZE 512
582//
583// read ticks, write ticks
584// =======================
585//
586// These values count the number of milliseconds that I/O requests have
587// waited on this block device. If there are multiple I/O requests waiting,
588// these values will increase at a rate greater than 1000/second; for
589// example, if 60 read requests wait for an average of 30 ms, the read_ticks
590// field will increase by 60*30 = 1800.
591//
592// in_flight
593// =========
594//
595// This value counts the number of I/O requests that have been issued to
596// the device driver but have not yet completed. It does not include I/O
597// requests that are in the queue but not yet issued to the device driver.
598//
599// io_ticks
600// ========
601//
602// This value counts the number of milliseconds during which the device has
603// had I/O requests queued.
604//
605// time_in_queue
606// =============
607//
608// This value counts the number of milliseconds that I/O requests have waited
609// on this block device. If there are multiple I/O requests waiting, this
610// value will increase as the product of the number of milliseconds times the
611// number of requests waiting (see "read ticks" above for an example).
612#define S_TO_MS 1000
613//
614
Mark Salyzyn326842f2015-04-30 09:49:41 -0700615static int dump_stat_from_fd(const char *title __unused, const char *path, int fd) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800616 unsigned long long fields[__STAT_NUMBER_FIELD];
Mark Salyzyn326842f2015-04-30 09:49:41 -0700617 bool z;
Yi Kong19d5c002018-07-20 13:39:55 -0700618 char *cp, *buffer = nullptr;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700619 size_t i = 0;
Josh Gao7c4258c2018-06-25 13:40:08 -0700620 FILE *fp = fdopen(dup(fd), "rb");
Mark Salyzyn326842f2015-04-30 09:49:41 -0700621 getline(&buffer, &i, fp);
622 fclose(fp);
623 if (!buffer) {
624 return -errno;
625 }
626 i = strlen(buffer);
627 while ((i > 0) && (buffer[i - 1] == '\n')) {
628 buffer[--i] = '\0';
629 }
630 if (!*buffer) {
631 free(buffer);
632 return 0;
633 }
634 z = true;
635 for (cp = buffer, i = 0; i < (sizeof(fields) / sizeof(fields[0])); ++i) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800636 fields[i] = strtoull(cp, &cp, 10);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700637 if (fields[i] != 0) {
638 z = false;
639 }
640 }
641 if (z) { /* never accessed */
642 free(buffer);
643 return 0;
644 }
645
Wei Wang509bb5d2017-06-09 14:42:12 -0700646 if (!strncmp(path, BLK_DEV_SYS_DIR, sizeof(BLK_DEV_SYS_DIR) - 1)) {
647 path += sizeof(BLK_DEV_SYS_DIR) - 1;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700648 }
Wei Wang1dc1ef52017-06-12 11:28:37 -0700649
650 printf("%-30s:%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s\n%-30s:\t%s\n", "Block-Dev",
651 "R-IOs", "R-merg", "R-sect", "R-wait", "W-IOs", "W-merg", "W-sect",
652 "W-wait", "in-fli", "activ", "T-wait", path, buffer);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700653 free(buffer);
654
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800655 if (fields[__STAT_IO_TICKS]) {
656 unsigned long read_perf = 0;
657 unsigned long read_ios = 0;
658 if (fields[__STAT_READ_TICKS]) {
659 unsigned long long divisor = fields[__STAT_READ_TICKS]
660 * fields[__STAT_IO_TICKS];
661 read_perf = ((unsigned long long)SECTOR_SIZE
662 * fields[__STAT_READ_SECTORS]
663 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
664 / divisor;
665 read_ios = ((unsigned long long)S_TO_MS * fields[__STAT_READ_IOS]
666 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
667 / divisor;
668 }
669
670 unsigned long write_perf = 0;
671 unsigned long write_ios = 0;
672 if (fields[__STAT_WRITE_TICKS]) {
673 unsigned long long divisor = fields[__STAT_WRITE_TICKS]
674 * fields[__STAT_IO_TICKS];
675 write_perf = ((unsigned long long)SECTOR_SIZE
676 * fields[__STAT_WRITE_SECTORS]
677 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
678 / divisor;
679 write_ios = ((unsigned long long)S_TO_MS * fields[__STAT_WRITE_IOS]
680 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
681 / divisor;
682 }
683
684 unsigned queue = (fields[__STAT_IN_QUEUE]
685 + (fields[__STAT_IO_TICKS] >> 1))
686 / fields[__STAT_IO_TICKS];
687
688 if (!write_perf && !write_ios) {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700689 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 -0800690 } else {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700691 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 -0800692 read_ios, write_perf, write_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800693 }
694
695 /* bugreport timeout factor adjustment */
696 if ((write_perf > 1) && (write_perf < worst_write_perf)) {
697 worst_write_perf = write_perf;
698 }
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700699 }
Mark Salyzyn326842f2015-04-30 09:49:41 -0700700 return 0;
701}
702
Yao Chenbe3bbc12018-01-17 16:31:10 -0800703static const long MINIMUM_LOGCAT_TIMEOUT_MS = 50000;
704
Tom Cherryf4472f32020-08-05 09:31:17 -0700705// Returns the actual readable size of the given buffer or -1 on error.
706static long logcat_buffer_readable_size(const std::string& buffer) {
707 std::unique_ptr<logger_list, decltype(&android_logger_list_free)> logger_list{
708 android_logger_list_alloc(0, 0, 0), &android_logger_list_free};
709 auto logger = android_logger_open(logger_list.get(), android_name_to_log_id(buffer.c_str()));
710
711 return android_logger_get_log_readable_size(logger);
712}
713
714// Returns timeout in ms to read a list of buffers.
Yao Chenbe3bbc12018-01-17 16:31:10 -0800715static unsigned long logcat_timeout(const std::vector<std::string>& buffers) {
716 unsigned long timeout_ms = 0;
717 for (const auto& buffer : buffers) {
Tom Cherryf4472f32020-08-05 09:31:17 -0700718 long readable_size = logcat_buffer_readable_size(buffer);
719 if (readable_size > 0) {
720 // Engineering margin is ten-fold our guess.
721 timeout_ms += 10 * (readable_size + worst_write_perf) / worst_write_perf;
722 }
Yao Chenbe3bbc12018-01-17 16:31:10 -0800723 }
724 return timeout_ms > MINIMUM_LOGCAT_TIMEOUT_MS ? timeout_ms : MINIMUM_LOGCAT_TIMEOUT_MS;
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700725}
726
Dieter Hsu105ad0c2020-09-29 15:23:33 +0800727// Opens a socket and returns its file descriptor.
728static int open_socket(const char* service);
729
Nandana Duttd2f5f082019-01-18 17:13:52 +0000730Dumpstate::ConsentCallback::ConsentCallback() : result_(UNAVAILABLE), start_time_(Nanotime()) {
731}
732
733android::binder::Status Dumpstate::ConsentCallback::onReportApproved() {
734 std::lock_guard<std::mutex> lock(lock_);
735 result_ = APPROVED;
736 MYLOGD("User approved consent to share bugreport\n");
Paul Chang0d2aad72020-02-13 20:04:03 +0800737
738 // Maybe copy screenshot so calling app can display the screenshot to the user as soon as
739 // consent is granted.
740 if (ds.options_->is_screenshot_copied) {
741 return android::binder::Status::ok();
742 }
743
744 if (!ds.options_->do_screenshot || ds.options_->screenshot_fd.get() == -1 ||
745 !ds.do_early_screenshot_) {
746 return android::binder::Status::ok();
747 }
748
749 bool copy_succeeded = android::os::CopyFileToFd(ds.screenshot_path_,
750 ds.options_->screenshot_fd.get());
751 ds.options_->is_screenshot_copied = copy_succeeded;
752 if (copy_succeeded) {
753 android::os::UnlinkAndLogOnError(ds.screenshot_path_);
754 }
Nandana Duttd2f5f082019-01-18 17:13:52 +0000755 return android::binder::Status::ok();
756}
757
758android::binder::Status Dumpstate::ConsentCallback::onReportDenied() {
759 std::lock_guard<std::mutex> lock(lock_);
760 result_ = DENIED;
761 MYLOGW("User denied consent to share bugreport\n");
762 return android::binder::Status::ok();
763}
764
765UserConsentResult Dumpstate::ConsentCallback::getResult() {
766 std::lock_guard<std::mutex> lock(lock_);
767 return result_;
768}
769
770uint64_t Dumpstate::ConsentCallback::getElapsedTimeMs() const {
Hunter Knepshieldf0a39052020-01-03 14:53:04 -0800771 return (Nanotime() - start_time_) / NANOS_PER_MILLI;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000772}
773
Felipe Leme2b9b06c2016-10-14 09:13:06 -0700774void Dumpstate::PrintHeader() const {
Mårten Kongstad60195a72022-09-20 14:14:20 +0200775 std::string build, fingerprint, radio, bootloader, network, sdkversion;
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700776 char date[80];
Colin Crossf45fa6b2012-03-26 12:38:26 -0700777
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700778 build = android::base::GetProperty("ro.build.display.id", "(unknown)");
779 fingerprint = android::base::GetProperty("ro.build.fingerprint", "(unknown)");
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700780 radio = android::base::GetProperty("gsm.version.baseband", "(unknown)");
781 bootloader = android::base::GetProperty("ro.bootloader", "(unknown)");
782 network = android::base::GetProperty("gsm.operator.alpha", "(unknown)");
Mårten Kongstad60195a72022-09-20 14:14:20 +0200783 sdkversion = android::base::GetProperty("ro.build.version.sdk", "(unknown)");
Felipe Lemebbaf3c12016-10-11 14:32:25 -0700784 strftime(date, sizeof(date), "%Y-%m-%d %H:%M:%S", localtime(&now_));
Colin Crossf45fa6b2012-03-26 12:38:26 -0700785
Felipe Lemed8b94e52016-12-08 10:21:44 -0800786 printf("========================================================\n");
787 printf("== dumpstate: %s\n", date);
788 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -0700789
Felipe Lemed8b94e52016-12-08 10:21:44 -0800790 printf("\n");
791 printf("Build: %s\n", build.c_str());
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700792 // NOTE: fingerprint entry format is important for other tools.
Felipe Lemed8b94e52016-12-08 10:21:44 -0800793 printf("Build fingerprint: '%s'\n", fingerprint.c_str());
794 printf("Bootloader: %s\n", bootloader.c_str());
795 printf("Radio: %s\n", radio.c_str());
796 printf("Network: %s\n", network.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100797 int64_t module_metadata_version = android::os::GetModuleMetadataVersion();
798 if (module_metadata_version != 0) {
799 printf("Module Metadata version: %" PRId64 "\n", module_metadata_version);
800 }
Mårten Kongstad60195a72022-09-20 14:14:20 +0200801 printf("Android SDK version: %s\n", sdkversion.c_str());
802 printf("SDK extensions: ");
803 RunCommandToFd(STDOUT_FILENO, "", {SDK_EXT_INFO, "--header"},
804 CommandOptions::WithTimeout(1).Always().DropRoot().Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -0700805
Felipe Lemed8b94e52016-12-08 10:21:44 -0800806 printf("Kernel: ");
Felipe Lemef0292972016-11-22 13:57:05 -0800807 DumpFileToFd(STDOUT_FILENO, "", "/proc/version");
Felipe Lemed8b94e52016-12-08 10:21:44 -0800808 printf("Command line: %s\n", strtok(cmdline_buf, "\n"));
Felipe Leme7709f8a2017-12-05 09:30:09 -0800809 printf("Uptime: ");
810 RunCommandToFd(STDOUT_FILENO, "", {"uptime", "-p"},
811 CommandOptions::WithTimeout(1).Always().Build());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800812 printf("Bugreport format version: %s\n", version_.c_str());
Rhed Jao5377d792020-07-16 17:37:39 +0800813 printf("Dumpstate info: id=%d pid=%d dry_run=%d parallel_run=%d args=%s bugreport_mode=%s\n",
814 id_, pid_, PropertiesHelper::IsDryRun(), PropertiesHelper::IsParallelRun(),
Kedar Chitnis9fd8c052021-11-16 09:09:22 +0000815 options_->args.c_str(), options_->bugreport_mode_string.c_str());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800816 printf("\n");
Felipe Leme78f2c862015-12-21 09:55:22 -0800817}
818
Felipe Leme24b66ee2016-06-16 10:55:26 -0700819// List of file extensions that can cause a zip file attachment to be rejected by some email
820// service providers.
821static const std::set<std::string> PROBLEMATIC_FILE_EXTENSIONS = {
822 ".ade", ".adp", ".bat", ".chm", ".cmd", ".com", ".cpl", ".exe", ".hta", ".ins", ".isp",
823 ".jar", ".jse", ".lib", ".lnk", ".mde", ".msc", ".msp", ".mst", ".pif", ".scr", ".sct",
824 ".shb", ".sys", ".vb", ".vbe", ".vbs", ".vxd", ".wsc", ".wsf", ".wsh"
825};
826
Vishnu Naire97d6122018-01-18 13:58:56 -0800827status_t Dumpstate::AddZipEntryFromFd(const std::string& entry_name, int fd,
828 std::chrono::milliseconds timeout = 0ms) {
Felipe Leme24b66ee2016-06-16 10:55:26 -0700829 std::string valid_name = entry_name;
830
831 // Rename extension if necessary.
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -0700832 size_t idx = entry_name.rfind('.');
Felipe Leme24b66ee2016-06-16 10:55:26 -0700833 if (idx != std::string::npos) {
834 std::string extension = entry_name.substr(idx);
835 std::transform(extension.begin(), extension.end(), extension.begin(), ::tolower);
836 if (PROBLEMATIC_FILE_EXTENSIONS.count(extension) != 0) {
837 valid_name = entry_name + ".renamed";
838 MYLOGI("Renaming entry %s to %s\n", entry_name.c_str(), valid_name.c_str());
839 }
840 }
841
Felipe Leme6fe9db62016-02-12 09:04:16 -0800842 // Logging statement below is useful to time how long each entry takes, but it's too verbose.
843 // MYLOGD("Adding zip entry %s\n", entry_name.c_str());
Kevin Jeon9bbe0ac2022-05-05 22:05:43 +0000844 size_t flags = ZipWriter::kCompress | ZipWriter::kDefaultCompression;
845 int32_t err = zip_writer_->StartEntryWithTime(valid_name.c_str(), flags,
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700846 get_mtime(fd, ds.now_));
Felipe Leme1d486fe2016-10-14 18:06:47 -0700847 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700848 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", valid_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700849 ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800850 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800851 }
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000852 bool finished_entry = false;
853 auto finish_entry = [this, &finished_entry] {
854 if (!finished_entry) {
855 // This should only be called when we're going to return an earlier error,
856 // which would've been logged. This may imply the file is already corrupt
857 // and any further logging from FinishEntry is more likely to mislead than
858 // not.
859 this->zip_writer_->FinishEntry();
860 }
861 };
862 auto scope_guard = android::base::make_scope_guard(finish_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -0800863 auto start = std::chrono::steady_clock::now();
864 auto end = start + timeout;
865 struct pollfd pfd = {fd, POLLIN};
Felipe Lemee82a27d2016-01-05 13:35:44 -0800866
Felipe Leme770410d2016-01-26 17:07:14 -0800867 std::vector<uint8_t> buffer(65536);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800868 while (1) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800869 if (timeout.count() > 0) {
870 // lambda to recalculate the timeout.
871 auto time_left_ms = [end]() {
872 auto now = std::chrono::steady_clock::now();
873 auto diff = std::chrono::duration_cast<std::chrono::milliseconds>(end - now);
874 return std::max(diff.count(), 0LL);
875 };
876
877 int rc = TEMP_FAILURE_RETRY(poll(&pfd, 1, time_left_ms()));
878 if (rc < 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000879 MYLOGE("Error in poll while adding from fd to zip entry %s:%s\n",
880 entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800881 return -errno;
882 } else if (rc == 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000883 MYLOGE("Timed out adding from fd to zip entry %s:%s Timeout:%lldms\n",
Vishnu Naire97d6122018-01-18 13:58:56 -0800884 entry_name.c_str(), strerror(errno), timeout.count());
885 return TIMED_OUT;
886 }
887 }
888
Zach Riggle22200402016-08-18 01:01:24 -0400889 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800890 if (bytes_read == 0) {
891 break;
892 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800893 MYLOGE("read(%s): %s\n", entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800894 return -errno;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800895 }
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700896 err = zip_writer_->WriteBytes(buffer.data(), bytes_read);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800897 if (err) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700898 MYLOGE("zip_writer_->WriteBytes(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800899 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800900 }
901 }
902
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700903 err = zip_writer_->FinishEntry();
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000904 finished_entry = true;
Felipe Leme1d486fe2016-10-14 18:06:47 -0700905 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700906 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800907 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800908 }
909
Vishnu Naire97d6122018-01-18 13:58:56 -0800910 return OK;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800911}
912
Felipe Leme1d486fe2016-10-14 18:06:47 -0700913bool Dumpstate::AddZipEntry(const std::string& entry_name, const std::string& entry_path) {
914 android::base::unique_fd fd(
915 TEMP_FAILURE_RETRY(open(entry_path.c_str(), O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
Andreas Gampeaff68432016-07-18 18:01:27 -0700916 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800917 MYLOGE("open(%s): %s\n", entry_path.c_str(), strerror(errno));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800918 return false;
919 }
920
Vishnu Naire97d6122018-01-18 13:58:56 -0800921 return (AddZipEntryFromFd(entry_name, fd.get()) == OK);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800922}
923
924/* adds a file to the existing zipped bugreport */
Felipe Leme4c2d6632016-09-28 14:32:00 -0700925static int _add_file_from_fd(const char* title __attribute__((unused)), const char* path, int fd) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800926 return (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + path, fd) == OK) ? 0 : 1;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800927}
928
Felipe Leme1d486fe2016-10-14 18:06:47 -0700929void Dumpstate::AddDir(const std::string& dir, bool recursive) {
Felipe Leme678727a2016-09-21 17:22:11 -0700930 MYLOGD("Adding dir %s (recursive: %d)\n", dir.c_str(), recursive);
Felipe Leme46b85da2016-11-21 17:40:45 -0800931 DurationReporter duration_reporter(dir, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700932 dump_files("", dir.c_str(), recursive ? skip_none : is_dir, _add_file_from_fd);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800933}
934
Felipe Leme1d486fe2016-10-14 18:06:47 -0700935bool Dumpstate::AddTextZipEntry(const std::string& entry_name, const std::string& content) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800936 MYLOGD("Adding zip text entry %s\n", entry_name.c_str());
Kevin Jeon9bbe0ac2022-05-05 22:05:43 +0000937 size_t flags = ZipWriter::kCompress | ZipWriter::kDefaultCompression;
938 int32_t err = zip_writer_->StartEntryWithTime(entry_name.c_str(), flags, ds.now_);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700939 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700940 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700941 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800942 return false;
943 }
944
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700945 err = zip_writer_->WriteBytes(content.c_str(), content.length());
Felipe Leme1d486fe2016-10-14 18:06:47 -0700946 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700947 MYLOGE("zip_writer_->WriteBytes(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700948 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800949 return false;
950 }
951
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700952 err = zip_writer_->FinishEntry();
Felipe Leme1d486fe2016-10-14 18:06:47 -0700953 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700954 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800955 return false;
956 }
957
958 return true;
959}
960
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800961static void DoKmsg() {
962 struct stat st;
963 if (!stat(PSTORE_LAST_KMSG, &st)) {
964 /* Also TODO: Make console-ramoops CAP_SYSLOG protected. */
965 DumpFile("LAST KMSG", PSTORE_LAST_KMSG);
966 } else if (!stat(ALT_PSTORE_LAST_KMSG, &st)) {
967 DumpFile("LAST KMSG", ALT_PSTORE_LAST_KMSG);
968 } else {
969 /* TODO: Make last_kmsg CAP_SYSLOG protected. b/5555691 */
970 DumpFile("LAST KMSG", "/proc/last_kmsg");
971 }
972}
973
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800974static void DoKernelLogcat() {
Yao Chenbe3bbc12018-01-17 16:31:10 -0800975 unsigned long timeout_ms = logcat_timeout({"kernel"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800976 RunCommand(
977 "KERNEL LOG",
978 {"logcat", "-b", "kernel", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
979 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
980}
981
Nandana Duttdb379fa2019-10-09 16:54:41 +0100982static void DoSystemLogcat(time_t since) {
983 char since_str[80];
984 strftime(since_str, sizeof(since_str), "%Y-%m-%d %H:%M:%S.000", localtime(&since));
985
986 unsigned long timeout_ms = logcat_timeout({"main", "system", "crash"});
987 RunCommand("SYSTEM LOG",
988 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v", "-T",
989 since_str},
990 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
991}
992
Hunter Knepshield820f9bc2020-02-05 20:10:53 -0800993static void DoRadioLogcat() {
994 unsigned long timeout_ms = logcat_timeout({"radio"});
995 RunCommand(
996 "RADIO LOG",
997 {"logcat", "-b", "radio", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
998 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
999}
1000
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001001static void DoLogcat() {
Vishnu Nair6921f802017-11-22 09:17:23 -08001002 unsigned long timeout_ms;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001003 // DumpFile("EVENT LOG TAGS", "/etc/event-log-tags");
1004 // calculate timeout
Yao Chenbe3bbc12018-01-17 16:31:10 -08001005 timeout_ms = logcat_timeout({"main", "system", "crash"});
Tony Makae737652017-03-30 17:47:09 +01001006 RunCommand("SYSTEM LOG",
Vishnu Nair6921f802017-11-22 09:17:23 -08001007 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1008 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -08001009 timeout_ms = logcat_timeout({"events"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001010 RunCommand(
1011 "EVENT LOG",
1012 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001013 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Yao Chenbe3bbc12018-01-17 16:31:10 -08001014 timeout_ms = logcat_timeout({"stats"});
1015 RunCommand(
1016 "STATS LOG",
1017 {"logcat", "-b", "stats", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001018 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001019 DoRadioLogcat();
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001020
1021 RunCommand("LOG STATISTICS", {"logcat", "-b", "all", "-S"});
1022
1023 /* kernels must set CONFIG_PSTORE_PMSG, slice up pstore with device tree */
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001024 RunCommand("LAST LOGCAT", {"logcat", "-L", "-b", "all", "-v", "threadtime", "-v", "printable",
1025 "-v", "uid", "-d", "*:v"});
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001026}
1027
Mike Ma5c267872019-08-21 11:31:34 -07001028static void DumpIncidentReport() {
Mike Ma5c267872019-08-21 11:31:34 -07001029 const std::string path = ds.bugreport_internal_dir_ + "/tmp_incident_report";
1030 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1031 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1032 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1033 if (fd < 0) {
1034 MYLOGE("Could not open %s to dump incident report.\n", path.c_str());
1035 return;
1036 }
Kevin Jeon774abde2022-09-28 18:20:43 +00001037 RunCommandToFd(fd, "", {"incident", "-u"}, CommandOptions::WithTimeout(20).Build());
Mike Ma5c267872019-08-21 11:31:34 -07001038 bool empty = 0 == lseek(fd, 0, SEEK_END);
1039 if (!empty) {
1040 // Use a different name from "incident.proto"
1041 // /proto/incident.proto is reserved for incident service dump
1042 // i.e. metadata for debugging.
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001043 ds.EnqueueAddZipEntryAndCleanupIfNeeded(kProtoPath + "incident_report" + kProtoExt,
1044 path);
1045 } else {
1046 unlink(path.c_str());
Mike Ma5c267872019-08-21 11:31:34 -07001047 }
Mike Ma5c267872019-08-21 11:31:34 -07001048}
1049
Aaron Huang24d215d2022-04-27 18:51:16 +08001050static void DumpNetstatsProto() {
1051 const std::string path = ds.bugreport_internal_dir_ + "/tmp_netstats_proto";
1052 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1053 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1054 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1055 if (fd < 0) {
1056 MYLOGE("Could not open %s to dump netstats proto.\n", path.c_str());
1057 return;
1058 }
1059 RunCommandToFd(fd, "", {"dumpsys", "netstats", "--proto"},
Kevin Jeon2fb3dd62022-09-28 18:48:55 +00001060 CommandOptions::WithTimeout(5).Build());
Aaron Huang24d215d2022-04-27 18:51:16 +08001061 bool empty = 0 == lseek(fd, 0, SEEK_END);
1062 if (!empty) {
1063 ds.EnqueueAddZipEntryAndCleanupIfNeeded(kProtoPath + "netstats" + kProtoExt,
1064 path);
1065 } else {
1066 unlink(path.c_str());
1067 }
1068}
1069
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001070static void MaybeAddSystemTraceToZip() {
1071 // This function copies into the .zip the system trace that was snapshotted
1072 // by the early call to MaybeSnapshotSystemTrace(), if any background
1073 // tracing was happening.
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001074 if (!ds.has_system_trace_) {
1075 // No background trace was happening at the time dumpstate was invoked.
1076 return;
1077 }
1078 ds.AddZipEntry(
1079 ZIP_ROOT_DIR + SYSTEM_TRACE_SNAPSHOT,
1080 SYSTEM_TRACE_SNAPSHOT);
1081 android::os::UnlinkAndLogOnError(SYSTEM_TRACE_SNAPSHOT);
1082}
1083
Sunny Goyal35949782019-11-19 15:54:36 -08001084static void DumpVisibleWindowViews() {
Sunny Goyal35949782019-11-19 15:54:36 -08001085 DurationReporter duration_reporter("VISIBLE WINDOW VIEWS");
1086 const std::string path = ds.bugreport_internal_dir_ + "/tmp_visible_window_views";
1087 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1088 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1089 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1090 if (fd < 0) {
1091 MYLOGE("Could not open %s to dump visible views.\n", path.c_str());
1092 return;
1093 }
1094 RunCommandToFd(fd, "", {"cmd", "window", "dump-visible-window-views"},
Kevin Jeon774abde2022-09-28 18:20:43 +00001095 CommandOptions::WithTimeout(10).Build());
Sunny Goyal35949782019-11-19 15:54:36 -08001096 bool empty = 0 == lseek(fd, 0, SEEK_END);
1097 if (!empty) {
1098 ds.AddZipEntry("visible_windows.zip", path);
1099 } else {
1100 MYLOGW("Failed to dump visible windows\n");
1101 }
1102 unlink(path.c_str());
1103}
1104
Jayachandran Ca94c7172017-06-10 15:08:12 -07001105static void DumpIpTablesAsRoot() {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001106 RunCommand("IPTABLES", {"iptables", "-L", "-nvx"});
1107 RunCommand("IP6TABLES", {"ip6tables", "-L", "-nvx"});
Erik Kline32af8c22016-09-28 17:26:26 +09001108 RunCommand("IPTABLES NAT", {"iptables", "-t", "nat", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001109 /* no ip6 nat */
Erik Kline32af8c22016-09-28 17:26:26 +09001110 RunCommand("IPTABLES MANGLE", {"iptables", "-t", "mangle", "-L", "-nvx"});
1111 RunCommand("IP6TABLES MANGLE", {"ip6tables", "-t", "mangle", "-L", "-nvx"});
1112 RunCommand("IPTABLES RAW", {"iptables", "-t", "raw", "-L", "-nvx"});
1113 RunCommand("IP6TABLES RAW", {"ip6tables", "-t", "raw", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001114}
1115
Woody Lin20767a92022-11-29 15:50:24 +08001116static void DumpShutdownCheckpoints() {
1117 const bool shutdown_checkpoints_dumped = AddDumps(
1118 ds.shutdown_checkpoints_.begin(), ds.shutdown_checkpoints_.end(),
1119 "SHUTDOWN CHECKPOINTS", false /* add_to_zip */);
1120 if (!shutdown_checkpoints_dumped) {
1121 printf("*** NO SHUTDOWN CHECKPOINTS to dump in %s\n\n",
1122 SHUTDOWN_CHECKPOINTS_DIR.c_str());
1123 }
1124}
1125
David Andersond9ba4752018-12-11 18:26:59 -08001126static void DumpDynamicPartitionInfo() {
1127 if (!::android::base::GetBoolProperty("ro.boot.dynamic_partitions", false)) {
1128 return;
1129 }
1130
1131 RunCommand("LPDUMP", {"lpdump", "--all"});
David Anderson6650ade2019-10-02 15:18:59 -07001132 RunCommand("DEVICE-MAPPER", {"gsid", "dump-device-mapper"});
David Andersond9ba4752018-12-11 18:26:59 -08001133}
1134
Chris Morin5a50d482022-02-01 17:41:18 -08001135static void AddAnrTraceDir(const std::string& anr_traces_dir) {
Narayan Kamath8f788292017-05-25 13:20:39 +01001136 MYLOGD("AddAnrTraceDir(): dump_traces_file=%s, anr_traces_dir=%s\n", dump_traces_path,
1137 anr_traces_dir.c_str());
1138
1139 // If we're here, dump_traces_path will always be a temporary file
1140 // (created with mkostemp or similar) that contains dumps taken earlier
1141 // on in the process.
1142 if (dump_traces_path != nullptr) {
Chris Morin5a50d482022-02-01 17:41:18 -08001143 MYLOGD("Dumping current ANR traces (%s) to the main bugreport entry\n",
1144 dump_traces_path);
1145 ds.DumpFile("VM TRACES JUST NOW", dump_traces_path);
Narayan Kamath8f788292017-05-25 13:20:39 +01001146
1147 const int ret = unlink(dump_traces_path);
1148 if (ret == -1) {
1149 MYLOGW("Error unlinking temporary trace path %s: %s\n", dump_traces_path,
1150 strerror(errno));
Felipe Lemee184f662016-10-27 10:04:47 -07001151 }
1152 }
1153
Narayan Kamathbd863722017-06-01 18:50:12 +01001154 // Add a specific message for the first ANR Dump.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001155 if (ds.anr_data_.size() > 0) {
Chris Morin5a50d482022-02-01 17:41:18 -08001156 // The "last" ANR will always be present in the body of the main entry.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001157 AddDumps(ds.anr_data_.begin(), ds.anr_data_.begin() + 1,
Chris Morin5a50d482022-02-01 17:41:18 -08001158 "VM TRACES AT LAST ANR", false /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001159
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001160 // Historical ANRs are always included as separate entries in the bugreport zip file.
Chris Morin5a50d482022-02-01 17:41:18 -08001161 AddDumps(ds.anr_data_.begin(), ds.anr_data_.end(),
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001162 "HISTORICAL ANR", true /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001163 } else {
Narayan Kamath8f788292017-05-25 13:20:39 +01001164 printf("*** NO ANRs to dump in %s\n\n", ANR_DIR.c_str());
1165 }
1166}
1167
1168static void AddAnrTraceFiles() {
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001169 std::string anr_traces_dir = "/data/anr";
Narayan Kamath8f788292017-05-25 13:20:39 +01001170
Chris Morin5a50d482022-02-01 17:41:18 -08001171 AddAnrTraceDir(anr_traces_dir);
Narayan Kamath8f788292017-05-25 13:20:39 +01001172
Makoto Onuki83ec63f2019-01-31 17:08:59 -08001173 RunCommand("ANR FILES", {"ls", "-lt", ANR_DIR});
1174
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001175 // Slow traces for slow operations.
Felipe Lemee184f662016-10-27 10:04:47 -07001176 struct stat st;
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001177 int i = 0;
1178 while (true) {
1179 const std::string slow_trace_path =
1180 anr_traces_dir + android::base::StringPrintf("slow%02d.txt", i);
1181 if (stat(slow_trace_path.c_str(), &st)) {
1182 // No traces file at this index, done with the files.
1183 break;
Felipe Lemee184f662016-10-27 10:04:47 -07001184 }
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001185 ds.DumpFile("VM TRACES WHEN SLOW", slow_trace_path.c_str());
1186 i++;
Felipe Lemee184f662016-10-27 10:04:47 -07001187 }
1188}
1189
Wei Wang509bb5d2017-06-09 14:42:12 -07001190static void DumpBlockStatFiles() {
1191 DurationReporter duration_reporter("DUMP BLOCK STAT");
Wei Wang509bb5d2017-06-09 14:42:12 -07001192
Wei Wang1dc1ef52017-06-12 11:28:37 -07001193 std::unique_ptr<DIR, std::function<int(DIR*)>> dirptr(opendir(BLK_DEV_SYS_DIR), closedir);
1194
1195 if (dirptr == nullptr) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001196 MYLOGE("Failed to open %s: %s\n", BLK_DEV_SYS_DIR, strerror(errno));
1197 return;
1198 }
1199
1200 printf("------ DUMP BLOCK STAT ------\n\n");
Wei Wang1dc1ef52017-06-12 11:28:37 -07001201 while (struct dirent *d = readdir(dirptr.get())) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001202 if ((d->d_name[0] == '.')
1203 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
1204 || (d->d_name[1] == '\0'))) {
1205 continue;
1206 }
1207 const std::string new_path =
1208 android::base::StringPrintf("%s/%s", BLK_DEV_SYS_DIR, d->d_name);
1209 printf("------ BLOCK STAT (%s) ------\n", new_path.c_str());
1210 dump_files("", new_path.c_str(), skip_not_stat, dump_stat_from_fd);
1211 printf("\n");
1212 }
Wei Wang1dc1ef52017-06-12 11:28:37 -07001213 return;
Wei Wang509bb5d2017-06-09 14:42:12 -07001214}
Jayachandran Ca94c7172017-06-10 15:08:12 -07001215
1216static void DumpPacketStats() {
1217 DumpFile("NETWORK DEV INFO", "/proc/net/dev");
Jayachandran Ca94c7172017-06-10 15:08:12 -07001218}
1219
1220static void DumpIpAddrAndRules() {
1221 /* The following have a tendency to get wedged when wifi drivers/fw goes belly-up. */
1222 RunCommand("NETWORK INTERFACES", {"ip", "link"});
1223 RunCommand("IPv4 ADDRESSES", {"ip", "-4", "addr", "show"});
1224 RunCommand("IPv6 ADDRESSES", {"ip", "-6", "addr", "show"});
1225 RunCommand("IP RULES", {"ip", "rule", "show"});
1226 RunCommand("IP RULES v6", {"ip", "-6", "rule", "show"});
1227}
1228
Nandana Dutt5c390032019-03-12 10:52:56 +00001229static Dumpstate::RunStatus RunDumpsysTextByPriority(const std::string& title, int priority,
1230 std::chrono::milliseconds timeout,
1231 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001232 auto start = std::chrono::steady_clock::now();
Vishnu Naire97d6122018-01-18 13:58:56 -08001233 sp<android::IServiceManager> sm = defaultServiceManager();
1234 Dumpsys dumpsys(sm.get());
Vishnu Naire97d6122018-01-18 13:58:56 -08001235 Vector<String16> args;
1236 Dumpsys::setServiceArgs(args, /* asProto = */ false, priority);
Vishnu Naire97d6122018-01-18 13:58:56 -08001237 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ false);
1238 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001239 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001240 std::string path(title);
1241 path.append(" - ").append(String8(service).c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -08001242 size_t bytes_written = 0;
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001243 if (PropertiesHelper::IsDryRun()) {
1244 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1245 dumpsys.writeDumpFooter(STDOUT_FILENO, service, std::chrono::milliseconds(1));
1246 } else {
1247 status_t status = dumpsys.startDumpThread(Dumpsys::TYPE_DUMP, service, args);
1248 if (status == OK) {
1249 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1250 std::chrono::duration<double> elapsed_seconds;
1251 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH &&
1252 service == String16("meminfo")) {
1253 // Use a longer timeout for meminfo, since 30s is not always enough.
1254 status = dumpsys.writeDump(STDOUT_FILENO, service, 60s,
1255 /* as_proto = */ false, elapsed_seconds,
1256 bytes_written);
1257 } else {
1258 status = dumpsys.writeDump(STDOUT_FILENO, service, service_timeout,
1259 /* as_proto = */ false, elapsed_seconds,
1260 bytes_written);
1261 }
1262 dumpsys.writeDumpFooter(STDOUT_FILENO, service, elapsed_seconds);
1263 bool dump_complete = (status == OK);
1264 dumpsys.stopDumpThread(dump_complete);
Gavin Corkeryfac7e2b2021-07-08 22:39:02 +01001265 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001266 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001267
1268 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1269 std::chrono::steady_clock::now() - start);
1270 if (elapsed_duration > timeout) {
1271 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1272 elapsed_duration.count());
1273 break;
1274 }
1275 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001276 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001277}
1278
Vishnu Nair64afc022018-02-01 15:29:34 -08001279static void RunDumpsysText(const std::string& title, int priority,
1280 std::chrono::milliseconds timeout,
1281 std::chrono::milliseconds service_timeout) {
1282 DurationReporter duration_reporter(title);
1283 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1284 fsync(STDOUT_FILENO);
1285 RunDumpsysTextByPriority(title, priority, timeout, service_timeout);
1286}
1287
1288/* Dump all services registered with Normal or Default priority. */
Nandana Dutt5c390032019-03-12 10:52:56 +00001289static Dumpstate::RunStatus RunDumpsysTextNormalPriority(const std::string& title,
1290 std::chrono::milliseconds timeout,
1291 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001292 DurationReporter duration_reporter(title);
1293 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1294 fsync(STDOUT_FILENO);
1295 RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_NORMAL, timeout,
1296 service_timeout);
Nandana Dutt5c390032019-03-12 10:52:56 +00001297
1298 RETURN_IF_USER_DENIED_CONSENT();
1299
1300 return RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_DEFAULT, timeout,
1301 service_timeout);
Vishnu Nair64afc022018-02-01 15:29:34 -08001302}
1303
Nandana Dutt5c390032019-03-12 10:52:56 +00001304static Dumpstate::RunStatus RunDumpsysProto(const std::string& title, int priority,
1305 std::chrono::milliseconds timeout,
1306 std::chrono::milliseconds service_timeout) {
Vishnu Naire97d6122018-01-18 13:58:56 -08001307 sp<android::IServiceManager> sm = defaultServiceManager();
1308 Dumpsys dumpsys(sm.get());
1309 Vector<String16> args;
1310 Dumpsys::setServiceArgs(args, /* asProto = */ true, priority);
1311 DurationReporter duration_reporter(title);
1312
1313 auto start = std::chrono::steady_clock::now();
1314 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ true);
1315 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001316 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001317 std::string path(kProtoPath);
1318 path.append(String8(service).c_str());
1319 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL) {
1320 path.append("_CRITICAL");
1321 } else if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH) {
1322 path.append("_HIGH");
1323 }
1324 path.append(kProtoExt);
Steven Morelandcbd69fc2021-07-20 20:45:43 +00001325 status_t status = dumpsys.startDumpThread(Dumpsys::TYPE_DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001326 if (status == OK) {
1327 status = ds.AddZipEntryFromFd(path, dumpsys.getDumpFd(), service_timeout);
1328 bool dumpTerminated = (status == OK);
1329 dumpsys.stopDumpThread(dumpTerminated);
1330 }
1331 ZipWriter::FileEntry file_entry;
1332 ds.zip_writer_->GetLastEntry(&file_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -08001333
1334 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1335 std::chrono::steady_clock::now() - start);
1336 if (elapsed_duration > timeout) {
1337 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1338 elapsed_duration.count());
1339 break;
1340 }
1341 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001342 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001343}
1344
Nandana Dutta7db6342018-11-21 14:53:34 +00001345// Runs dumpsys on services that must dump first and will take less than 100ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001346static Dumpstate::RunStatus RunDumpsysCritical() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001347 RunDumpsysText("DUMPSYS CRITICAL", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1348 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Nandana Dutt5c390032019-03-12 10:52:56 +00001349
1350 RETURN_IF_USER_DENIED_CONSENT();
1351
1352 return RunDumpsysProto("DUMPSYS CRITICAL PROTO", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1353 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Vishnu Nair780b1282017-10-10 13:57:24 -07001354}
1355
1356// Runs dumpsys on services that must dump first but can take up to 250ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001357static Dumpstate::RunStatus RunDumpsysHigh() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001358 // TODO meminfo takes ~10s, connectivity takes ~5sec to dump. They are both
1359 // high priority. Reduce timeout once they are able to dump in a shorter time or
1360 // moved to a parallel task.
1361 RunDumpsysText("DUMPSYS HIGH", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1362 /* timeout= */ 90s, /* service_timeout= */ 30s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001363
1364 RETURN_IF_USER_DENIED_CONSENT();
1365
1366 return RunDumpsysProto("DUMPSYS HIGH PROTO", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1367 /* timeout= */ 5s, /* service_timeout= */ 1s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001368}
1369
1370// Runs dumpsys on services that must dump but can take up to 10s to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001371static Dumpstate::RunStatus RunDumpsysNormal() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001372 RunDumpsysTextNormalPriority("DUMPSYS", /* timeout= */ 90s, /* service_timeout= */ 10s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001373
1374 RETURN_IF_USER_DENIED_CONSENT();
1375
1376 return RunDumpsysProto("DUMPSYS PROTO", IServiceManager::DUMP_FLAG_PRIORITY_NORMAL,
1377 /* timeout= */ 90s, /* service_timeout= */ 10s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001378}
1379
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001380/*
1381 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1382 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1383 * if it's not running in the parallel task.
1384 */
1385static void DumpHals(int out_fd = STDOUT_FILENO) {
Yifan Hong30528a22020-08-07 18:24:06 -07001386 RunCommand("HARDWARE HALS", {"lshal", "--all", "--types=all"},
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001387 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build(),
1388 false, out_fd);
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001389
Steven Moreland44cd9482018-01-04 16:24:13 -08001390 using android::hidl::manager::V1_0::IServiceManager;
1391 using android::hardware::defaultServiceManager;
1392
1393 sp<IServiceManager> sm = defaultServiceManager();
1394 if (sm == nullptr) {
1395 MYLOGE("Could not retrieve hwservicemanager to dump hals.\n");
1396 return;
1397 }
1398
1399 auto ret = sm->list([&](const auto& interfaces) {
1400 for (const std::string& interface : interfaces) {
1401 std::string cleanName = interface;
1402 std::replace_if(cleanName.begin(),
1403 cleanName.end(),
1404 [](char c) {
1405 return !isalnum(c) &&
1406 std::string("@-_:.").find(c) == std::string::npos;
1407 }, '_');
Nandana Dutt979388e2018-11-30 16:48:55 +00001408 const std::string path = ds.bugreport_internal_dir_ + "/lshal_debug_" + cleanName;
Steven Moreland44cd9482018-01-04 16:24:13 -08001409
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001410 bool empty = false;
Steven Moreland44cd9482018-01-04 16:24:13 -08001411 {
1412 auto fd = android::base::unique_fd(
1413 TEMP_FAILURE_RETRY(open(path.c_str(),
1414 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1415 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1416 if (fd < 0) {
1417 MYLOGE("Could not open %s to dump additional hal information.\n", path.c_str());
1418 continue;
1419 }
1420 RunCommandToFd(fd,
1421 "",
Steven Morelandc81cd3c2018-01-18 14:36:26 -08001422 {"lshal", "debug", "-E", interface},
Steven Moreland44cd9482018-01-04 16:24:13 -08001423 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
1424
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001425 empty = 0 == lseek(fd, 0, SEEK_END);
Steven Moreland44cd9482018-01-04 16:24:13 -08001426 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001427 if (!empty) {
1428 ds.EnqueueAddZipEntryAndCleanupIfNeeded("lshal-debug/" + cleanName + ".txt",
1429 path);
1430 } else {
1431 unlink(path.c_str());
1432 }
Steven Moreland44cd9482018-01-04 16:24:13 -08001433 }
1434 });
1435
1436 if (!ret.isOk()) {
1437 MYLOGE("Could not list hals from hwservicemanager.\n");
1438 }
1439}
1440
Devin Moore8df81bb2022-06-08 22:47:02 +00001441// Dump all of the files that make up the vendor interface.
1442// See the files listed in dumpFileList() for the latest list of files.
1443static void DumpVintf() {
Devin Moore16271d92022-09-22 18:28:48 +00001444
1445 const std::string sku = android::base::GetProperty("ro.boot.product.hardware.sku", "");
1446 const auto vintfFiles = android::vintf::details::dumpFileList(sku);
Devin Moore8df81bb2022-06-08 22:47:02 +00001447 for (const auto vintfFile : vintfFiles) {
1448 struct stat st;
1449 if (stat(vintfFile.c_str(), &st) == 0) {
1450 if (S_ISDIR(st.st_mode)) {
1451 ds.AddDir(vintfFile, true /* recursive */);
1452 } else {
1453 ds.EnqueueAddZipEntryAndCleanupIfNeeded(ZIP_ROOT_DIR + vintfFile,
1454 vintfFile);
1455 }
1456 }
1457 }
1458}
1459
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001460static void DumpExternalFragmentationInfo() {
1461 struct stat st;
1462 if (stat("/proc/buddyinfo", &st) != 0) {
1463 MYLOGE("Unable to dump external fragmentation info\n");
1464 return;
1465 }
1466
1467 printf("------ EXTERNAL FRAGMENTATION INFO ------\n");
1468 std::ifstream ifs("/proc/buddyinfo");
1469 auto unusable_index_regex = std::regex{"Node\\s+([0-9]+),\\s+zone\\s+(\\S+)\\s+(.*)"};
1470 for (std::string line; std::getline(ifs, line);) {
1471 std::smatch match_results;
1472 if (std::regex_match(line, match_results, unusable_index_regex)) {
1473 std::stringstream free_pages(std::string{match_results[3]});
1474 std::vector<int> free_pages_per_order(std::istream_iterator<int>{free_pages},
1475 std::istream_iterator<int>());
1476
1477 int total_free_pages = 0;
1478 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1479 total_free_pages += (free_pages_per_order[i] * std::pow(2, i));
1480 }
1481
1482 printf("Node %s, zone %8s", match_results[1].str().c_str(),
1483 match_results[2].str().c_str());
1484
1485 int usable_free_pages = total_free_pages;
1486 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1487 auto unusable_index = (total_free_pages - usable_free_pages) /
1488 static_cast<double>(total_free_pages);
1489 printf(" %5.3f", unusable_index);
1490 usable_free_pages -= (free_pages_per_order[i] * std::pow(2, i));
1491 }
1492
1493 printf("\n");
1494 }
1495 }
1496 printf("\n");
1497}
1498
mhasankd451a472020-05-26 18:02:39 -07001499static void DumpstateLimitedOnly() {
1500 // Trimmed-down version of dumpstate to only include a whitelisted
1501 // set of logs (system log, event log, and system server / system app
1502 // crashes, and networking logs). See b/136273873 and b/138459828
1503 // for context.
1504 DurationReporter duration_reporter("DUMPSTATE");
1505 unsigned long timeout_ms;
1506 // calculate timeout
1507 timeout_ms = logcat_timeout({"main", "system", "crash"});
1508 RunCommand("SYSTEM LOG",
1509 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1510 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1511 timeout_ms = logcat_timeout({"events"});
1512 RunCommand(
1513 "EVENT LOG",
1514 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1515 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1516
1517 printf("========================================================\n");
1518 printf("== Networking Service\n");
1519 printf("========================================================\n");
1520
1521 RunDumpsys("DUMPSYS NETWORK_SERVICE_LIMITED", {"wifi", "-a"},
1522 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hugo Benichiaa162682020-10-30 23:28:56 +09001523 RunDumpsys("DUMPSYS CONNECTIVITY REQUESTS", {"connectivity", "requests"},
1524 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
mhasankd451a472020-05-26 18:02:39 -07001525
1526 printf("========================================================\n");
1527 printf("== Dropbox crashes\n");
1528 printf("========================================================\n");
1529
1530 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1531 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1532
1533 printf("========================================================\n");
1534 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1535 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1536 printf("========================================================\n");
1537 printf("== dumpstate: done (id %d)\n", ds.id_);
1538 printf("========================================================\n");
1539}
1540
Rhed Jaoe017f982020-07-21 17:58:41 +08001541/*
1542 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1543 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1544 * if it's not running in the parallel task.
1545 */
1546static void DumpCheckins(int out_fd = STDOUT_FILENO) {
1547 dprintf(out_fd, "========================================================\n");
1548 dprintf(out_fd, "== Checkins\n");
1549 dprintf(out_fd, "========================================================\n");
1550
1551 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"}, out_fd);
Rhed Jaoe017f982020-07-21 17:58:41 +08001552 RunDumpsys("CHECKIN NETSTATS", {"netstats", "--checkin"}, out_fd);
1553 RunDumpsys("CHECKIN PROCSTATS", {"procstats", "-c"}, out_fd);
1554 RunDumpsys("CHECKIN USAGESTATS", {"usagestats", "-c"}, out_fd);
1555 RunDumpsys("CHECKIN PACKAGE", {"package", "--checkin"}, out_fd);
1556}
1557
1558/*
1559 * Runs dumpsys on activity service to dump all application activities, services
1560 * and providers in the device.
1561 *
1562 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1563 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1564 * if it's not running in the parallel task.
1565 */
1566static void DumpAppInfos(int out_fd = STDOUT_FILENO) {
1567 dprintf(out_fd, "========================================================\n");
1568 dprintf(out_fd, "== Running Application Activities\n");
1569 dprintf(out_fd, "========================================================\n");
1570
1571 // The following dumpsys internally collects output from running apps, so it can take a long
1572 // time. So let's extend the timeout.
1573
1574 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
1575
1576 RunDumpsys("APP ACTIVITIES", {"activity", "-v", "all"}, DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1577
1578 dprintf(out_fd, "========================================================\n");
1579 dprintf(out_fd, "== Running Application Services (platform)\n");
1580 dprintf(out_fd, "========================================================\n");
1581
1582 RunDumpsys("APP SERVICES PLATFORM", {"activity", "service", "all-platform-non-critical"},
1583 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1584
1585 dprintf(out_fd, "========================================================\n");
1586 dprintf(out_fd, "== Running Application Services (non-platform)\n");
1587 dprintf(out_fd, "========================================================\n");
1588
1589 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1590 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1591
1592 dprintf(out_fd, "========================================================\n");
1593 dprintf(out_fd, "== Running Application Providers (platform)\n");
1594 dprintf(out_fd, "========================================================\n");
1595
1596 RunDumpsys("APP PROVIDERS PLATFORM", {"activity", "provider", "all-platform"},
Rhed Jaob049f182021-01-11 21:08:43 +08001597 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
Rhed Jaoe017f982020-07-21 17:58:41 +08001598
1599 dprintf(out_fd, "========================================================\n");
1600 dprintf(out_fd, "== Running Application Providers (non-platform)\n");
1601 dprintf(out_fd, "========================================================\n");
1602
1603 RunDumpsys("APP PROVIDERS NON-PLATFORM", {"activity", "provider", "all-non-platform"},
1604 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1605}
1606
Nandana Dutt5c390032019-03-12 10:52:56 +00001607// Dumps various things. Returns early with status USER_CONSENT_DENIED if user denies consent
1608// via the consent they are shown. Ignores other errors that occur while running various
1609// commands. The consent checking is currently done around long running tasks, which happen to
1610// be distributed fairly evenly throughout the function.
Kean Mariotti306633e2022-09-05 16:30:47 +00001611Dumpstate::RunStatus Dumpstate::dumpstate() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001612 DurationReporter duration_reporter("DUMPSTATE");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001613
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001614 // Enqueue slow functions into the thread pool, if the parallel run is enabled.
Aaron Huang24d215d2022-04-27 18:51:16 +08001615 std::future<std::string> dump_hals, dump_incident_report, dump_board, dump_checkins,
Kean Mariotti306633e2022-09-05 16:30:47 +00001616 dump_netstats_report, post_process_ui_traces;
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001617 if (ds.dump_pool_) {
1618 // Pool was shutdown in DumpstateDefaultAfterCritical method in order to
Kean Mariotti306633e2022-09-05 16:30:47 +00001619 // drop root user. Restarts it.
1620 ds.dump_pool_->start(/* thread_counts = */3);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001621
Chris Morinbc223142022-02-04 14:17:11 -08001622 dump_hals = ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
1623 dump_incident_report = ds.dump_pool_->enqueueTask(
1624 DUMP_INCIDENT_REPORT_TASK, &DumpIncidentReport);
Aaron Huang24d215d2022-04-27 18:51:16 +08001625 dump_netstats_report = ds.dump_pool_->enqueueTask(
1626 DUMP_NETSTATS_PROTO_TASK, &DumpNetstatsProto);
Chris Morinbc223142022-02-04 14:17:11 -08001627 dump_board = ds.dump_pool_->enqueueTaskWithFd(
1628 DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
1629 dump_checkins = ds.dump_pool_->enqueueTaskWithFd(DUMP_CHECKINS_TASK, &DumpCheckins, _1);
Kean Mariotti306633e2022-09-05 16:30:47 +00001630 post_process_ui_traces = ds.dump_pool_->enqueueTask(
1631 POST_PROCESS_UI_TRACES_TASK, &Dumpstate::MaybePostProcessUiTraces, &ds);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001632 }
1633
Nandana Dutt5c390032019-03-12 10:52:56 +00001634 // Dump various things. Note that anything that takes "long" (i.e. several seconds) should
1635 // check intermittently (if it's intrerruptable like a foreach on pids) and/or should be wrapped
1636 // in a consent check (via RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK).
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -07001637 dump_dev_files("TRUSTY VERSION", "/sys/bus/platform/drivers/trusty", "trusty_version");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001638 RunCommand("UPTIME", {"uptime"});
Wei Wang509bb5d2017-06-09 14:42:12 -07001639 DumpBlockStatFiles();
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001640 DumpFile("MEMORY INFO", "/proc/meminfo");
1641 RunCommand("CPU INFO", {"top", "-b", "-n", "1", "-H", "-s", "6", "-o",
Felipe Leme30dbfa12016-09-02 12:43:26 -07001642 "pid,tid,user,pr,ni,%cpu,s,virt,res,pcy,cmd,name"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001643
Kevin Jeon947922b2022-09-21 00:29:18 +00001644 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "BUGREPORT_PROCDUMP", {"bugreport_procdump"},
1645 CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001646
Sunny Goyal35949782019-11-19 15:54:36 -08001647 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpVisibleWindowViews);
1648
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001649 DumpFile("VIRTUAL MEMORY STATS", "/proc/vmstat");
1650 DumpFile("VMALLOC INFO", "/proc/vmallocinfo");
1651 DumpFile("SLAB INFO", "/proc/slabinfo");
1652 DumpFile("ZONEINFO", "/proc/zoneinfo");
1653 DumpFile("PAGETYPEINFO", "/proc/pagetypeinfo");
1654 DumpFile("BUDDYINFO", "/proc/buddyinfo");
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001655 DumpExternalFragmentationInfo();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001656
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001657 DumpFile("KERNEL CPUFREQ", "/sys/devices/system/cpu/cpu0/cpufreq/stats/time_in_state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001658
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001659 RunCommand("PROCESSES AND THREADS",
Yohei Yukawa591a72d2017-10-05 21:36:35 -07001660 {"ps", "-A", "-T", "-Z", "-O", "pri,nice,rtprio,sched,pcy,time"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001661
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001662 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001663 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_hals));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001664 } else {
1665 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_HALS_TASK, DumpHals);
1666 }
Steven Moreland81b429e2017-01-31 19:50:46 -08001667
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001668 RunCommand("PRINTENV", {"printenv"});
Elliott Hughes21b7c8d2016-10-28 08:53:02 -07001669 RunCommand("NETSTAT", {"netstat", "-nW"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001670 struct stat s;
1671 if (stat("/proc/modules", &s) != 0) {
1672 MYLOGD("Skipping 'lsmod' because /proc/modules does not exist\n");
1673 } else {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001674 RunCommand("LSMOD", {"lsmod"});
Woody Linc198f252021-05-04 16:37:11 +08001675 RunCommand("MODULES INFO",
1676 {"sh", "-c", "cat /proc/modules | cut -d' ' -f1 | "
1677 " while read MOD ; do echo modinfo:$MOD ; modinfo $MOD ; "
1678 "done"}, CommandOptions::AS_ROOT);
Felipe Lemee4eca582016-06-10 17:48:08 -07001679 }
Michal Karpinski4db754f2015-12-11 18:04:32 +00001680
Tom Cherryb87dbfa2020-07-28 11:28:53 -07001681 if (android::base::GetBoolProperty("ro.logd.kernel", false)) {
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001682 DoKernelLogcat();
1683 } else {
1684 do_dmesg();
1685 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001686
Devin Moore8df81bb2022-06-08 22:47:02 +00001687 DumpVintf();
1688
Felipe Lemef0292972016-11-22 13:57:05 -08001689 RunCommand("LIST OF OPEN FILES", {"lsof"}, CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001690
Jeff Brown1dc94e32014-09-11 14:15:27 -07001691 for_each_tid(show_wchan, "BLOCKED PROCESS WAIT-CHANNELS");
Mark Salyzyna297c322016-02-05 15:33:17 -08001692 for_each_pid(show_showtime, "PROCESS TIMES (pid cmd user system iowait+percentage)");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001693
Jack Yu5a6b2e22020-08-14 18:13:35 +08001694 /* Dump Nfc NCI logs */
1695 ds.AddDir("/data/misc/nfc/logs", true);
Ajay Panickerd886ec42016-09-14 12:26:46 -07001696
Paul Chang0d2aad72020-02-13 20:04:03 +08001697 if (ds.options_->do_screenshot && !ds.do_early_screenshot_) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001698 MYLOGI("taking late screenshot\n");
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001699 ds.TakeScreenshot();
Jeff Sharkey5a930032013-03-19 15:05:19 -07001700 }
1701
Felipe Lemee184f662016-10-27 10:04:47 -07001702 AddAnrTraceFiles();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001703
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001704 MaybeAddSystemTraceToZip();
1705
Narayan Kamath8f788292017-05-25 13:20:39 +01001706 // NOTE: tombstones are always added as separate entries in the zip archive
1707 // and are not interspersed with the main report.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001708 const bool tombstones_dumped = AddDumps(ds.tombstone_data_.begin(), ds.tombstone_data_.end(),
Narayan Kamathbd863722017-06-01 18:50:12 +01001709 "TOMBSTONE", true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001710 if (!tombstones_dumped) {
1711 printf("*** NO TOMBSTONES to dump in %s\n\n", TOMBSTONE_DIR.c_str());
Christopher Ferris7dc7f322014-07-22 16:08:19 -07001712 }
1713
Jayachandran Ca94c7172017-06-10 15:08:12 -07001714 DumpPacketStats();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001715
Lorenzo Colitti807f2dd2022-05-27 12:48:37 +09001716 RunDumpsys("EBPF MAP STATS", {"connectivity", "trafficcontroller"});
Chenbo Feng276a3b62018-08-07 11:44:49 -07001717
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001718 DoKmsg();
Mark Salyzyn2262c162014-12-16 09:09:26 -08001719
Woody Lin20767a92022-11-29 15:50:24 +08001720 DumpShutdownCheckpoints();
1721
Jayachandran Ca94c7172017-06-10 15:08:12 -07001722 DumpIpAddrAndRules();
Sreeram Ramachandran2b3bba32014-07-08 15:40:55 -07001723
1724 dump_route_tables();
1725
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001726 RunCommand("ARP CACHE", {"ip", "-4", "neigh", "show"});
1727 RunCommand("IPv6 ND CACHE", {"ip", "-6", "neigh", "show"});
1728 RunCommand("MULTICAST ADDRESSES", {"ip", "maddr"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001729
Nandana Dutt5c390032019-03-12 10:52:56 +00001730 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysHigh);
Lorenzo Colitti6afc38c2015-09-09 22:59:25 +09001731
Chiachang Wang668ede42021-05-17 17:14:20 +08001732 // The dump mechanism in connectivity is refactored due to modularization work. Connectivity can
1733 // only register with a default priority(NORMAL priority). Dumpstate has to call connectivity
1734 // dump with priority parameters to dump high priority information.
1735 RunDumpsys("SERVICE HIGH connectivity", {"connectivity", "--dump-priority", "HIGH"},
1736 CommandOptions::WithTimeout(10).Build());
1737
Elliott Hughes23ccc622017-02-28 10:14:22 -08001738 RunCommand("SYSTEM PROPERTIES", {"getprop"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001739
Jin Qianf334d662017-10-10 14:41:37 -07001740 RunCommand("STORAGED IO INFO", {"storaged", "-u", "-p"});
ynwangf649a6e2016-07-17 21:56:00 -07001741
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001742 RunCommand("FILESYSTEMS & FREE SPACE", {"df"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001743
Colin Crossf45fa6b2012-03-26 12:38:26 -07001744 /* Binder state is expensive to look at as it uses a lot of memory. */
Hridya Valsaraju920ba712020-02-09 16:27:01 -08001745 std::string binder_logs_dir = access("/dev/binderfs/binder_logs", R_OK) ?
1746 "/sys/kernel/debug/binder" : "/dev/binderfs/binder_logs";
1747
1748 DumpFile("BINDER FAILED TRANSACTION LOG", binder_logs_dir + "/failed_transaction_log");
1749 DumpFile("BINDER TRANSACTION LOG", binder_logs_dir + "/transaction_log");
1750 DumpFile("BINDER TRANSACTIONS", binder_logs_dir + "/transactions");
1751 DumpFile("BINDER STATS", binder_logs_dir + "/stats");
1752 DumpFile("BINDER STATE", binder_logs_dir + "/state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001753
Yifan Hongd90cc652020-02-08 16:52:02 -08001754 ds.AddDir(SNAPSHOTCTL_LOG_DIR, false);
1755
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001756 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001757 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_board));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001758 } else {
1759 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
1760 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001761
Steven Moreland7440ddb2016-12-15 16:13:39 -08001762 /* Migrate the ril_dumpstate to a device specific dumpstate? */
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001763 int rilDumpstateTimeout = android::base::GetIntProperty("ril.dumpstate.timeout", 0);
1764 if (rilDumpstateTimeout > 0) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001765 // su does not exist on user builds, so try running without it.
1766 // This way any implementations of vril-dump that do not require
1767 // root can run on user builds.
1768 CommandOptions::CommandOptionsBuilder options =
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001769 CommandOptions::WithTimeout(rilDumpstateTimeout);
Felipe Lemef0292972016-11-22 13:57:05 -08001770 if (!PropertiesHelper::IsUserBuild()) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001771 options.AsRoot();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001772 }
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001773 RunCommand("DUMP VENDOR RIL LOGS", {"vril-dump"}, options.Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -07001774 }
1775
Felipe Lemed8b94e52016-12-08 10:21:44 -08001776 printf("========================================================\n");
1777 printf("== Android Framework Services\n");
1778 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001779
Nandana Dutt5c390032019-03-12 10:52:56 +00001780 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysNormal);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001781
Jack He91ff2fe2021-02-18 18:23:43 -08001782 /* Dump Bluetooth HCI logs after getting bluetooth_manager dumpsys */
1783 ds.AddDir("/data/misc/bluetooth/logs", true);
1784
Rhed Jaoe017f982020-07-21 17:58:41 +08001785 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001786 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_checkins));
Rhed Jaoe017f982020-07-21 17:58:41 +08001787 } else {
1788 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_CHECKINS_TASK, DumpCheckins);
1789 }
Dianne Hackborn02bea972013-06-26 18:59:09 -07001790
Rhed Jaoc5f7ec32020-12-22 22:11:08 +08001791 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpAppInfos);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001792
Adrian Roos8b397ab2017-04-04 16:35:44 -07001793 printf("========================================================\n");
1794 printf("== Dropbox crashes\n");
1795 printf("========================================================\n");
1796
1797 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1798 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1799
Felipe Lemed8b94e52016-12-08 10:21:44 -08001800 printf("========================================================\n");
1801 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1802 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1803 printf("========================================================\n");
1804 printf("== dumpstate: done (id %d)\n", ds.id_);
1805 printf("========================================================\n");
Bookatz38472142018-09-28 10:20:24 -07001806
1807 printf("========================================================\n");
1808 printf("== Obtaining statsd metadata\n");
1809 printf("========================================================\n");
1810 // This differs from the usual dumpsys stats, which is the stats report data.
1811 RunDumpsys("STATSDSTATS", {"stats", "--metadata"});
Mike Ma5c267872019-08-21 11:31:34 -07001812
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +09001813 // Add linker configuration directory
1814 ds.AddDir(LINKERCONFIG_DIR, true);
1815
Li Li830179f2022-01-04 12:53:29 -08001816 /* Dump frozen cgroupfs */
1817 dump_frozen_cgroupfs();
Li Li2eedd412021-06-30 15:11:53 -07001818
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001819 if (ds.dump_pool_) {
Aaron Huang24d215d2022-04-27 18:51:16 +08001820 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_netstats_report));
1821 } else {
1822 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_NETSTATS_PROTO_TASK,
1823 DumpNetstatsProto);
1824 }
1825
1826 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001827 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_incident_report));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001828 } else {
1829 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_INCIDENT_REPORT_TASK,
1830 DumpIncidentReport);
1831 }
Mike Ma5c267872019-08-21 11:31:34 -07001832
Kean Mariotti306633e2022-09-05 16:30:47 +00001833 if (ds.dump_pool_) {
1834 WaitForTask(std::move(post_process_ui_traces));
1835 } else {
1836 RUN_SLOW_FUNCTION_AND_LOG(POST_PROCESS_UI_TRACES_TASK, MaybePostProcessUiTraces);
1837 }
1838
1839 MaybeAddUiTracesToZip();
1840
Nandana Dutt5c390032019-03-12 10:52:56 +00001841 return Dumpstate::RunStatus::OK;
Colin Crossf45fa6b2012-03-26 12:38:26 -07001842}
1843
Nandana Dutt5c390032019-03-12 10:52:56 +00001844/*
1845 * Dumps state for the default case; drops root after it's no longer necessary.
1846 *
1847 * Returns RunStatus::OK if everything went fine.
1848 * Returns RunStatus::ERROR if there was an error.
1849 * Returns RunStatus::USER_DENIED_CONSENT if user explicitly denied consent to sharing the bugreport
1850 * with the caller.
1851 */
Jichao Lie89d9c12019-11-21 19:02:51 -08001852Dumpstate::RunStatus Dumpstate::DumpstateDefaultAfterCritical() {
Nandana Duttdb379fa2019-10-09 16:54:41 +01001853 // Capture first logcat early on; useful to take a snapshot before dumpstate logs take over the
1854 // buffer.
1855 DoLogcat();
1856 // Capture timestamp after first logcat to use in next logcat
1857 time_t logcat_ts = time(nullptr);
1858
Nandana Dutt4be45d12018-09-26 15:04:23 +01001859 /* collect stack traces from Dalvik and native processes (needs root) */
Chris Morinbc223142022-02-04 14:17:11 -08001860 std::future<std::string> dump_traces;
Rhed Jao5377d792020-07-16 17:37:39 +08001861 if (dump_pool_) {
1862 RETURN_IF_USER_DENIED_CONSENT();
1863 // One thread is enough since we only need to enqueue DumpTraces here.
1864 dump_pool_->start(/* thread_counts = */1);
1865
1866 // DumpTraces takes long time, post it to the another thread in the
1867 // pool, if pool is available
Chris Morinbc223142022-02-04 14:17:11 -08001868 dump_traces = dump_pool_->enqueueTask(
1869 DUMP_TRACES_TASK, &Dumpstate::DumpTraces, &ds, &dump_traces_path);
Rhed Jao5377d792020-07-16 17:37:39 +08001870 } else {
1871 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_TRACES_TASK, ds.DumpTraces,
1872 &dump_traces_path);
1873 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001874
1875 /* Run some operations that require root. */
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001876 if (!PropertiesHelper::IsDryRun()) {
Chris Morinc2cba7a2022-02-01 17:06:50 -08001877 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX);
1878 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX);
Woody Lin20767a92022-11-29 15:50:24 +08001879 ds.shutdown_checkpoints_ = GetDumpFds(
1880 SHUTDOWN_CHECKPOINTS_DIR, SHUTDOWN_CHECKPOINTS_FILE_PREFIX);
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001881 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001882
1883 ds.AddDir(RECOVERY_DIR, true);
1884 ds.AddDir(RECOVERY_DATA_DIR, true);
1885 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
Kelvin Zhang6eaa0f92022-09-12 09:29:19 -07001886 ds.AddDir(UPDATE_ENGINE_PREF_DIR, true);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001887 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1888 if (!PropertiesHelper::IsUserBuild()) {
1889 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1890 ds.AddDir(PROFILE_DATA_DIR_REF, true);
Calin Juravlef84d3692020-04-28 15:31:12 -07001891 ds.AddZipEntry(ZIP_ROOT_DIR + PACKAGE_DEX_USE_LIST, PACKAGE_DEX_USE_LIST);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001892 }
Jerry Changa1df8a92020-01-02 16:03:39 +08001893 ds.AddDir(PREREBOOT_DATA_DIR, false);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001894 add_mountinfo();
1895 DumpIpTablesAsRoot();
David Andersond9ba4752018-12-11 18:26:59 -08001896 DumpDynamicPartitionInfo();
Yifan Hong3945e1b2019-10-29 12:59:23 -07001897 ds.AddDir(OTA_METADATA_DIR, true);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001898
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001899 // Capture any IPSec policies in play. No keys are exposed here.
Nandana Dutt4be45d12018-09-26 15:04:23 +01001900 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1901
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001902 // Dump IPsec stats. No keys are exposed here.
1903 DumpFile("XFRM STATS", XFRM_STAT_PROC_FILE);
1904
Nandana Dutt4be45d12018-09-26 15:04:23 +01001905 // Run ss as root so we can see socket marks.
1906 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
1907
1908 // Run iotop as root to show top 100 IO threads
1909 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
1910
Erick Reyese68df822019-02-11 14:46:36 -08001911 // Gather shared memory buffer info if the product implements it
Hridya Valsaraju1da80c52021-01-09 22:10:11 -08001912 RunCommand("Dmabuf dump", {"dmabuf_dump"});
1913 RunCommand("Dmabuf per-buffer/per-exporter/per-device stats", {"dmabuf_dump", "-b"});
Erick Reyese68df822019-02-11 14:46:36 -08001914
Minchan Kim22c6a1e2019-09-30 15:58:10 -07001915 DumpFile("PSI cpu", "/proc/pressure/cpu");
1916 DumpFile("PSI memory", "/proc/pressure/memory");
1917 DumpFile("PSI io", "/proc/pressure/io");
1918
Mårten Kongstad60195a72022-09-20 14:14:20 +02001919 RunCommand("SDK EXTENSIONS", {SDK_EXT_INFO, "--dump"},
1920 CommandOptions::WithTimeout(10).Always().DropRoot().Build());
1921
Rhed Jao5377d792020-07-16 17:37:39 +08001922 if (dump_pool_) {
1923 RETURN_IF_USER_DENIED_CONSENT();
Chris Morinbc223142022-02-04 14:17:11 -08001924 WaitForTask(std::move(dump_traces));
Rhed Jao5377d792020-07-16 17:37:39 +08001925
Chris Morinbc223142022-02-04 14:17:11 -08001926 // Current running thread in the pool is the root user also. Delete
1927 // the pool and make a new one later to ensure none of threads in the pool are root.
1928 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao5377d792020-07-16 17:37:39 +08001929 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001930 if (!DropRootUser()) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001931 return Dumpstate::RunStatus::ERROR;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001932 }
1933
Nandana Dutt5c390032019-03-12 10:52:56 +00001934 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttdb379fa2019-10-09 16:54:41 +01001935 Dumpstate::RunStatus status = dumpstate();
1936 // Capture logcat since the last time we did it.
1937 DoSystemLogcat(logcat_ts);
1938 return status;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001939}
1940
Rhed Jaob5685b32020-08-14 17:19:17 +08001941// Common states for telephony and wifi which are needed to be collected before
1942// dumpstate drop the root user.
1943static void DumpstateRadioAsRoot() {
1944 DumpIpTablesAsRoot();
1945 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1946}
1947
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001948// This method collects common dumpsys for telephony and wifi. Typically, wifi
1949// reports are fine to include all information, but telephony reports on user
1950// builds need to strip some content (see DumpstateTelephonyOnly).
1951static void DumpstateRadioCommon(bool include_sensitive_info = true) {
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001952 // We need to be picky about some stuff for telephony reports on user builds.
1953 if (!include_sensitive_info) {
1954 // Only dump the radio log buffer (other buffers and dumps contain too much unrelated info).
1955 DoRadioLogcat();
1956 } else {
Rhed Jaob5685b32020-08-14 17:19:17 +08001957 // DumpHals takes long time, post it to the another thread in the pool,
1958 // if pool is available.
Chris Morinbc223142022-02-04 14:17:11 -08001959 std::future<std::string> dump_hals;
Rhed Jaob5685b32020-08-14 17:19:17 +08001960 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001961 dump_hals = ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
Rhed Jaob5685b32020-08-14 17:19:17 +08001962 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001963 // Contains various system properties and process startup info.
1964 do_dmesg();
1965 // Logs other than the radio buffer may contain package/component names and potential PII.
1966 DoLogcat();
1967 // Too broad for connectivity problems.
1968 DoKmsg();
Rhed Jaob5685b32020-08-14 17:19:17 +08001969 // DumpHals contains unrelated hardware info (camera, NFC, biometrics, ...).
1970 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001971 WaitForTask(std::move(dump_hals));
Rhed Jaob5685b32020-08-14 17:19:17 +08001972 } else {
1973 RUN_SLOW_FUNCTION_AND_LOG(DUMP_HALS_TASK, DumpHals);
1974 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001975 }
1976
Jayachandran Ca94c7172017-06-10 15:08:12 -07001977 DumpPacketStats();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001978 DumpIpAddrAndRules();
1979 dump_route_tables();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001980 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
1981 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08001982}
1983
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001984// We use "telephony" here for legacy reasons, though this now really means "connectivity" (cellular
1985// + wifi + networking). This method collects dumpsys for connectivity debugging only. General rules
1986// for what can be included on user builds: all reported information MUST directly relate to
1987// connectivity debugging or customer support and MUST NOT contain unrelated personally identifiable
1988// information. This information MUST NOT identify user-installed packages (UIDs are OK, package
1989// names are not), and MUST NOT contain logs of user application traffic.
1990// TODO(b/148168577) rename this and other related fields/methods to "connectivity" instead.
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08001991static void DumpstateTelephonyOnly(const std::string& calling_package) {
mukesh agrawal253dad42018-01-23 21:59:59 -08001992 DurationReporter duration_reporter("DUMPSTATE");
Jichao Lie89d9c12019-11-21 19:02:51 -08001993
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001994 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08001995
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001996 const bool include_sensitive_info = !PropertiesHelper::IsUserBuild();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001997
Rhed Jaob5685b32020-08-14 17:19:17 +08001998 DumpstateRadioAsRoot();
1999 if (!DropRootUser()) {
2000 return;
2001 }
2002
2003 // Starts thread pool after the root user is dropped, and two additional threads
2004 // are created for DumpHals in the DumpstateRadioCommon and DumpstateBoard.
Chris Morinbc223142022-02-04 14:17:11 -08002005 std::future<std::string> dump_board;
Rhed Jaob5685b32020-08-14 17:19:17 +08002006 if (ds.dump_pool_) {
2007 ds.dump_pool_->start(/*thread_counts =*/2);
2008
2009 // DumpstateBoard takes long time, post it to the another thread in the pool,
2010 // if pool is available.
Chris Morinbc223142022-02-04 14:17:11 -08002011 dump_board = ds.dump_pool_->enqueueTaskWithFd(
2012 DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
Rhed Jaob5685b32020-08-14 17:19:17 +08002013 }
2014
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002015 DumpstateRadioCommon(include_sensitive_info);
2016
2017 if (include_sensitive_info) {
2018 // Contains too much unrelated PII, and given the unstructured nature of sysprops, we can't
2019 // really cherrypick all of the connectivity-related ones. Apps generally have no business
2020 // reading these anyway, and there should be APIs to supply the info in a more app-friendly
2021 // way.
2022 RunCommand("SYSTEM PROPERTIES", {"getprop"});
2023 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002024
2025 printf("========================================================\n");
2026 printf("== Android Framework Services\n");
2027 printf("========================================================\n");
2028
Vishnu Nair652cc802017-11-30 15:18:30 -08002029 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
2030 SEC_TO_MSEC(10));
Hunter Knepshield31cbae12021-05-11 16:23:24 -07002031 RunDumpsys("DUMPSYS", {"vcn_management"}, CommandOptions::WithTimeout(90).Build(),
2032 SEC_TO_MSEC(10));
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08002033 if (include_sensitive_info) {
2034 // Carrier apps' services will be dumped below in dumpsys activity service all-non-platform.
2035 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
2036 SEC_TO_MSEC(10));
2037 } else {
2038 // If the caller is a carrier app and has a carrier service, dump it here since we aren't
2039 // running dumpsys activity service all-non-platform below. Due to the increased output, we
2040 // give a higher timeout as well.
2041 RunDumpsys("DUMPSYS", {"carrier_config", "--requesting-package", calling_package},
2042 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(30));
2043 }
2044 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002045 RunDumpsys("DUMPSYS", {"netpolicy"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
2046 RunDumpsys("DUMPSYS", {"network_management"}, CommandOptions::WithTimeout(90).Build(),
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07002047 SEC_TO_MSEC(10));
Hunter Knepshield0fe51b12020-03-05 16:58:20 -08002048 RunDumpsys("DUMPSYS", {"telephony.registry"}, CommandOptions::WithTimeout(90).Build(),
2049 SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002050 if (include_sensitive_info) {
2051 // Contains raw IP addresses, omit from reports on user builds.
2052 RunDumpsys("DUMPSYS", {"netd"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
2053 // Contains raw destination IP/MAC addresses, omit from reports on user builds.
2054 RunDumpsys("DUMPSYS", {"connmetrics"}, CommandOptions::WithTimeout(90).Build(),
2055 SEC_TO_MSEC(10));
2056 // Contains package/component names, omit from reports on user builds.
2057 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
2058 SEC_TO_MSEC(10));
2059 // Contains package names, but should be relatively simple to remove them (also contains
2060 // UIDs already), omit from reports on user builds.
2061 RunDumpsys("BATTERYSTATS", {"deviceidle"}, CommandOptions::WithTimeout(90).Build(),
2062 SEC_TO_MSEC(10));
2063 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002064
2065 printf("========================================================\n");
2066 printf("== Running Application Services\n");
2067 printf("========================================================\n");
2068
2069 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
2070
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002071 if (include_sensitive_info) {
2072 printf("========================================================\n");
2073 printf("== Running Application Services (non-platform)\n");
2074 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002075
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002076 // Contains package/component names and potential PII, omit from reports on user builds.
2077 // To get dumps of the active CarrierService(s) on user builds, we supply an argument to the
2078 // carrier_config dumpsys instead.
2079 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
2080 DUMPSYS_COMPONENTS_OPTIONS);
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002081
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002082 printf("========================================================\n");
2083 printf("== Checkins\n");
2084 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002085
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002086 // Contains package/component names, omit from reports on user builds.
2087 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
2088 }
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002089
2090 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07002091 printf("== dumpstate: done (id %d)\n", ds.id_);
2092 printf("========================================================\n");
Rhed Jaob5685b32020-08-14 17:19:17 +08002093
2094 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08002095 WaitForTask(std::move(dump_board));
Rhed Jaob5685b32020-08-14 17:19:17 +08002096 } else {
2097 RUN_SLOW_FUNCTION_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
2098 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002099}
2100
mukesh agrawal253dad42018-01-23 21:59:59 -08002101// This method collects dumpsys for wifi debugging only
2102static void DumpstateWifiOnly() {
2103 DurationReporter duration_reporter("DUMPSTATE");
2104
Rhed Jaob5685b32020-08-14 17:19:17 +08002105 DumpstateRadioAsRoot();
2106 if (!DropRootUser()) {
2107 return;
2108 }
2109
2110 // Starts thread pool after the root user is dropped. Only one additional
2111 // thread is needed for DumpHals in the DumpstateRadioCommon.
2112 if (ds.dump_pool_) {
2113 ds.dump_pool_->start(/*thread_counts =*/1);
2114 }
2115
mukesh agrawal253dad42018-01-23 21:59:59 -08002116 DumpstateRadioCommon();
2117
2118 printf("========================================================\n");
2119 printf("== Android Framework Services\n");
2120 printf("========================================================\n");
2121
2122 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
2123 SEC_TO_MSEC(10));
2124 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
2125 SEC_TO_MSEC(10));
2126
2127 printf("========================================================\n");
2128 printf("== dumpstate: done (id %d)\n", ds.id_);
2129 printf("========================================================\n");
2130}
2131
Nandana Duttcf419a72019-03-14 10:40:17 +00002132Dumpstate::RunStatus Dumpstate::DumpTraces(const char** path) {
Gavin Corkery789d7a52021-02-24 23:52:35 +00002133 const std::string temp_file_pattern = ds.bugreport_internal_dir_ + "/dumptrace_XXXXXX";
Nandana Duttfaafd522019-03-11 09:23:09 +00002134 const size_t buf_size = temp_file_pattern.length() + 1;
2135 std::unique_ptr<char[]> file_name_buf(new char[buf_size]);
2136 memcpy(file_name_buf.get(), temp_file_pattern.c_str(), buf_size);
2137
2138 // Create a new, empty file to receive all trace dumps.
2139 //
2140 // TODO: This can be simplified once we remove support for the old style
2141 // dumps. We can have a file descriptor passed in to dump_traces instead
2142 // of creating a file, closing it and then reopening it again.
2143 android::base::unique_fd fd(mkostemp(file_name_buf.get(), O_APPEND | O_CLOEXEC));
2144 if (fd < 0) {
2145 MYLOGE("mkostemp on pattern %s: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002146 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002147 }
2148
2149 // Nobody should have access to this temporary file except dumpstate, but we
2150 // temporarily grant 'read' to 'others' here because this file is created
2151 // when tombstoned is still running as root, but dumped after dropping. This
2152 // can go away once support for old style dumping has.
2153 const int chmod_ret = fchmod(fd, 0666);
2154 if (chmod_ret < 0) {
2155 MYLOGE("fchmod on %s failed: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002156 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002157 }
2158
2159 std::unique_ptr<DIR, decltype(&closedir)> proc(opendir("/proc"), closedir);
2160 if (proc.get() == nullptr) {
2161 MYLOGE("opendir /proc failed: %s\n", strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002162 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002163 }
2164
2165 // Number of times process dumping has timed out. If we encounter too many
2166 // failures, we'll give up.
2167 int timeout_failures = 0;
2168 bool dalvik_found = false;
2169
Jayant Chowdharya0a8eb22022-05-20 03:30:09 +00002170 const std::set<int> hal_pids = get_interesting_pids();
Nandana Duttfaafd522019-03-11 09:23:09 +00002171
2172 struct dirent* d;
2173 while ((d = readdir(proc.get()))) {
Nandana Duttcf419a72019-03-14 10:40:17 +00002174 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttfaafd522019-03-11 09:23:09 +00002175 int pid = atoi(d->d_name);
2176 if (pid <= 0) {
2177 continue;
2178 }
2179
2180 const std::string link_name = android::base::StringPrintf("/proc/%d/exe", pid);
2181 std::string exe;
2182 if (!android::base::Readlink(link_name, &exe)) {
2183 continue;
2184 }
2185
2186 bool is_java_process;
2187 if (exe == "/system/bin/app_process32" || exe == "/system/bin/app_process64") {
2188 // Don't bother dumping backtraces for the zygote.
2189 if (IsZygote(pid)) {
2190 continue;
2191 }
2192
2193 dalvik_found = true;
2194 is_java_process = true;
2195 } else if (should_dump_native_traces(exe.c_str()) || hal_pids.find(pid) != hal_pids.end()) {
2196 is_java_process = false;
2197 } else {
2198 // Probably a native process we don't care about, continue.
2199 continue;
2200 }
2201
2202 // If 3 backtrace dumps fail in a row, consider debuggerd dead.
2203 if (timeout_failures == 3) {
2204 dprintf(fd, "ERROR: Too many stack dump failures, exiting.\n");
2205 break;
2206 }
2207
2208 const uint64_t start = Nanotime();
2209 const int ret = dump_backtrace_to_file_timeout(
2210 pid, is_java_process ? kDebuggerdJavaBacktrace : kDebuggerdNativeBacktrace,
2211 is_java_process ? 5 : 20, fd);
2212
2213 if (ret == -1) {
2214 // For consistency, the header and footer to this message match those
2215 // dumped by debuggerd in the success case.
2216 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
2217 dprintf(fd, "Dump failed, likely due to a timeout.\n");
2218 dprintf(fd, "---- end %d ----", pid);
2219 timeout_failures++;
2220 continue;
2221 }
2222
2223 // We've successfully dumped stack traces, reset the failure count
2224 // and write a summary of the elapsed time to the file and continue with the
2225 // next process.
2226 timeout_failures = 0;
2227
2228 dprintf(fd, "[dump %s stack %d: %.3fs elapsed]\n", is_java_process ? "dalvik" : "native",
2229 pid, (float)(Nanotime() - start) / NANOS_PER_SEC);
2230 }
2231
2232 if (!dalvik_found) {
2233 MYLOGE("Warning: no Dalvik processes found to dump stacks\n");
2234 }
2235
Nandana Duttcf419a72019-03-14 10:40:17 +00002236 *path = file_name_buf.release();
2237 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002238}
2239
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002240static dumpstate_hal_hidl::DumpstateMode GetDumpstateHalModeHidl(
2241 const Dumpstate::BugreportMode bugreport_mode) {
2242 switch (bugreport_mode) {
2243 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2244 return dumpstate_hal_hidl::DumpstateMode::FULL;
2245 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2246 return dumpstate_hal_hidl::DumpstateMode::INTERACTIVE;
2247 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2248 return dumpstate_hal_hidl::DumpstateMode::REMOTE;
2249 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2250 return dumpstate_hal_hidl::DumpstateMode::WEAR;
2251 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2252 return dumpstate_hal_hidl::DumpstateMode::CONNECTIVITY;
2253 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2254 return dumpstate_hal_hidl::DumpstateMode::WIFI;
2255 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2256 return dumpstate_hal_hidl::DumpstateMode::DEFAULT;
2257 }
2258 return dumpstate_hal_hidl::DumpstateMode::DEFAULT;
2259}
2260
2261static dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode GetDumpstateHalModeAidl(
2262 const Dumpstate::BugreportMode bugreport_mode) {
2263 switch (bugreport_mode) {
2264 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2265 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::FULL;
2266 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2267 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::INTERACTIVE;
2268 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2269 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::REMOTE;
2270 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2271 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::WEAR;
2272 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2273 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::CONNECTIVITY;
2274 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2275 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::WIFI;
2276 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2277 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::DEFAULT;
2278 }
2279 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::DEFAULT;
2280}
2281
2282static void DoDumpstateBoardHidl(
2283 const sp<dumpstate_hal_hidl_1_0::IDumpstateDevice> dumpstate_hal_1_0,
2284 const std::vector<::ndk::ScopedFileDescriptor>& dumpstate_fds,
2285 const Dumpstate::BugreportMode bugreport_mode,
2286 const size_t timeout_sec) {
2287
2288 using ScopedNativeHandle =
2289 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
2290 ScopedNativeHandle handle(native_handle_create(static_cast<int>(dumpstate_fds.size()), 0),
2291 [](native_handle_t* handle) {
2292 // we don't close file handle's here
2293 // via native_handle_close(handle)
2294 // instead we let dumpstate_fds close the file handles when
2295 // dumpstate_fds gets destroyed
2296 native_handle_delete(handle);
2297 });
2298 if (handle == nullptr) {
2299 MYLOGE("Could not create native_handle for dumpstate HAL\n");
2300 return;
2301 }
2302
2303 for (size_t i = 0; i < dumpstate_fds.size(); i++) {
2304 handle.get()->data[i] = dumpstate_fds[i].get();
2305 }
2306
2307 // Prefer version 1.1 if available. New devices launching with R are no longer allowed to
2308 // implement just 1.0.
2309 const char* descriptor_to_kill;
2310 using DumpstateBoardTask = std::packaged_task<bool()>;
2311 DumpstateBoardTask dumpstate_board_task;
2312 sp<dumpstate_hal_hidl::IDumpstateDevice> dumpstate_hal(
2313 dumpstate_hal_hidl::IDumpstateDevice::castFrom(dumpstate_hal_1_0));
2314 if (dumpstate_hal != nullptr) {
2315 MYLOGI("Using IDumpstateDevice v1.1 HIDL HAL");
2316
2317 dumpstate_hal_hidl::DumpstateMode dumpstate_hal_mode =
2318 GetDumpstateHalModeHidl(bugreport_mode);
2319
2320 descriptor_to_kill = dumpstate_hal_hidl::IDumpstateDevice::descriptor;
2321 dumpstate_board_task =
2322 DumpstateBoardTask([timeout_sec, dumpstate_hal_mode, dumpstate_hal, &handle]() -> bool {
2323 ::android::hardware::Return<dumpstate_hal_hidl::DumpstateStatus> status =
2324 dumpstate_hal->dumpstateBoard_1_1(handle.get(), dumpstate_hal_mode,
2325 SEC_TO_MSEC(timeout_sec));
2326 if (!status.isOk()) {
2327 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2328 return false;
2329 } else if (status != dumpstate_hal_hidl::DumpstateStatus::OK) {
2330 MYLOGE("dumpstateBoard failed with DumpstateStatus::%s\n",
2331 dumpstate_hal_hidl::toString(status).c_str());
2332 return false;
2333 }
2334 return true;
2335 });
2336 } else {
2337 MYLOGI("Using IDumpstateDevice v1.0 HIDL HAL");
2338
2339 descriptor_to_kill = dumpstate_hal_hidl_1_0::IDumpstateDevice::descriptor;
2340 dumpstate_board_task = DumpstateBoardTask([dumpstate_hal_1_0, &handle]() -> bool {
2341 ::android::hardware::Return<void> status =
2342 dumpstate_hal_1_0->dumpstateBoard(handle.get());
2343 if (!status.isOk()) {
2344 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2345 return false;
2346 }
2347 return true;
2348 });
2349 }
2350 auto result = dumpstate_board_task.get_future();
2351 std::thread(std::move(dumpstate_board_task)).detach();
2352
2353 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2354 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate HAL\n", timeout_sec);
2355 if (!android::base::SetProperty(
2356 "ctl.interface_restart",
2357 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
2358 MYLOGE("Couldn't restart dumpstate HAL\n");
2359 }
2360 }
2361 // Wait some time for init to kill dumpstate vendor HAL
2362 constexpr size_t killing_timeout_sec = 10;
2363 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2364 MYLOGE(
2365 "killing dumpstateBoard timed out after %zus, continue and "
2366 "there might be racing in content\n",
2367 killing_timeout_sec);
2368 }
2369}
2370
2371static void DoDumpstateBoardAidl(
2372 const std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> dumpstate_hal,
2373 const std::vector<::ndk::ScopedFileDescriptor>& dumpstate_fds,
2374 const Dumpstate::BugreportMode bugreport_mode, const size_t timeout_sec) {
2375 MYLOGI("Using IDumpstateDevice AIDL HAL");
2376
2377 const char* descriptor_to_kill;
2378 using DumpstateBoardTask = std::packaged_task<bool()>;
2379 DumpstateBoardTask dumpstate_board_task;
2380 dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode dumpstate_hal_mode =
2381 GetDumpstateHalModeAidl(bugreport_mode);
2382
2383 descriptor_to_kill = dumpstate_hal_aidl::IDumpstateDevice::descriptor;
2384 dumpstate_board_task = DumpstateBoardTask([dumpstate_hal, &dumpstate_fds, dumpstate_hal_mode,
2385 timeout_sec]() -> bool {
2386 auto status = dumpstate_hal->dumpstateBoard(dumpstate_fds, dumpstate_hal_mode, timeout_sec);
2387
2388 if (!status.isOk()) {
2389 MYLOGE("dumpstateBoard failed: %s\n", status.getDescription().c_str());
2390 return false;
2391 }
2392 return true;
2393 });
2394 auto result = dumpstate_board_task.get_future();
2395 std::thread(std::move(dumpstate_board_task)).detach();
2396
2397 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2398 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate HAL\n", timeout_sec);
2399 if (!android::base::SetProperty(
2400 "ctl.interface_restart",
2401 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
2402 MYLOGE("Couldn't restart dumpstate HAL\n");
2403 }
2404 }
2405 // Wait some time for init to kill dumpstate vendor HAL
2406 constexpr size_t killing_timeout_sec = 10;
2407 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2408 MYLOGE(
2409 "killing dumpstateBoard timed out after %zus, continue and "
2410 "there might be racing in content\n",
2411 killing_timeout_sec);
2412 }
2413}
2414
2415static std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> GetDumpstateBoardAidlService() {
2416 const std::string aidl_instance_name =
2417 std::string(dumpstate_hal_aidl::IDumpstateDevice::descriptor) + "/default";
2418
2419 if (!AServiceManager_isDeclared(aidl_instance_name.c_str())) {
2420 return nullptr;
2421 }
2422
2423 ndk::SpAIBinder dumpstateBinder(AServiceManager_waitForService(aidl_instance_name.c_str()));
2424
2425 return dumpstate_hal_aidl::IDumpstateDevice::fromBinder(dumpstateBinder);
2426}
2427
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002428void Dumpstate::DumpstateBoard(int out_fd) {
2429 dprintf(out_fd, "========================================================\n");
2430 dprintf(out_fd, "== Board\n");
2431 dprintf(out_fd, "========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08002432
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002433 /*
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002434 * mount debugfs for non-user builds with ro.product.debugfs_restrictions.enabled
Hridya Valsaraju51101602021-04-02 14:32:46 -07002435 * set to true and unmount it after invoking dumpstateBoard_* methods.
2436 * This is to enable debug builds to not have debugfs mounted during runtime.
2437 * It will also ensure that debugfs is only accessed by the dumpstate HAL.
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002438 */
Hridya Valsaraju51101602021-04-02 14:32:46 -07002439 auto mount_debugfs =
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002440 android::base::GetBoolProperty("ro.product.debugfs_restrictions.enabled", false);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002441 if (mount_debugfs) {
2442 RunCommand("mount debugfs", {"mount", "-t", "debugfs", "debugfs", "/sys/kernel/debug"},
2443 AS_ROOT_20);
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002444 RunCommand("chmod debugfs", {"chmod", "0755", "/sys/kernel/debug"}, AS_ROOT_20);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002445 }
2446
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002447 std::vector<std::string> paths;
2448 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07002449 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002450 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
2451 kDumpstateBoardFiles[i].c_str()));
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002452 remover.emplace_back(android::base::make_scope_guard(
2453 std::bind([](std::string path) { android::os::UnlinkAndLogOnError(path); }, paths[i])));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002454 }
Jie Song9fbfad02017-06-20 16:29:42 -07002455
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002456 // get dumpstate HAL AIDL implementation
2457 std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> dumpstate_hal_handle_aidl(
2458 GetDumpstateBoardAidlService());
2459 if (dumpstate_hal_handle_aidl == nullptr) {
2460 MYLOGI("No IDumpstateDevice AIDL implementation\n");
2461 }
2462
2463 // get dumpstate HAL HIDL implementation, only if AIDL HAL implementation not found
2464 sp<dumpstate_hal_hidl_1_0::IDumpstateDevice> dumpstate_hal_handle_hidl_1_0 = nullptr;
2465 if (dumpstate_hal_handle_aidl == nullptr) {
2466 dumpstate_hal_handle_hidl_1_0 = dumpstate_hal_hidl_1_0::IDumpstateDevice::getService();
2467 if (dumpstate_hal_handle_hidl_1_0 == nullptr) {
2468 MYLOGI("No IDumpstateDevice HIDL implementation\n");
2469 }
2470 }
2471
2472 // if neither HIDL nor AIDL implementation found, then return
2473 if (dumpstate_hal_handle_hidl_1_0 == nullptr && dumpstate_hal_handle_aidl == nullptr) {
2474 MYLOGE("Could not find IDumpstateDevice implementation\n");
Wei Wang587eac92018-04-05 12:17:20 -07002475 return;
2476 }
2477
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002478 // this is used to hold the file descriptors and when this variable goes out of scope
2479 // the file descriptors are closed
2480 std::vector<::ndk::ScopedFileDescriptor> dumpstate_fds;
Wei Wang587eac92018-04-05 12:17:20 -07002481
Nandana Dutt5c390032019-03-12 10:52:56 +00002482 // TODO(128270426): Check for consent in between?
Wei Wang587eac92018-04-05 12:17:20 -07002483 for (size_t i = 0; i < paths.size(); i++) {
2484 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
2485
2486 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
2487 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
2488 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
2489 if (fd < 0) {
2490 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
2491 return;
2492 }
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002493
2494 dumpstate_fds.emplace_back(fd.release());
2495 // we call fd.release() here to make sure "fd" does not get closed
2496 // after "fd" goes out of scope after this block.
2497 // "fd" will be closed when "dumpstate_fds" goes out of scope
2498 // i.e. when we exit this function
Wei Wang587eac92018-04-05 12:17:20 -07002499 }
2500
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002501 // Given that bugreport is required to diagnose failures, it's better to set an arbitrary amount
2502 // of timeout for IDumpstateDevice than to block the rest of bugreport. In the timeout case, we
2503 // will kill the HAL and grab whatever it dumped in time.
Michael Eastwood8523ea02022-03-10 16:33:08 -08002504 constexpr size_t timeout_sec = 45;
Wei Wang587eac92018-04-05 12:17:20 -07002505
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002506 if (dumpstate_hal_handle_aidl != nullptr) {
2507 DoDumpstateBoardAidl(dumpstate_hal_handle_aidl, dumpstate_fds, options_->bugreport_mode,
2508 timeout_sec);
2509 } else if (dumpstate_hal_handle_hidl_1_0 != nullptr) {
2510 // run HIDL HAL only if AIDL HAL not found
2511 DoDumpstateBoardHidl(dumpstate_hal_handle_hidl_1_0, dumpstate_fds, options_->bugreport_mode,
2512 timeout_sec);
Wei Wang587eac92018-04-05 12:17:20 -07002513 }
2514
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002515 if (mount_debugfs) {
Hridya Valsaraju51101602021-04-02 14:32:46 -07002516 auto keep_debugfs_mounted =
2517 android::base::GetProperty("persist.dbg.keep_debugfs_mounted", "");
2518 if (keep_debugfs_mounted.empty())
2519 RunCommand("unmount debugfs", {"umount", "/sys/kernel/debug"}, AS_ROOT_20);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002520 }
2521
Wei Wang587eac92018-04-05 12:17:20 -07002522 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
2523 for (size_t i = 0; i < paths.size(); i++) {
2524 struct stat s;
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002525 if (fstat(dumpstate_fds[i].get(), &s) == -1) {
2526 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(), strerror(errno));
Wei Wang587eac92018-04-05 12:17:20 -07002527 file_sizes[i] = -1;
2528 continue;
2529 }
2530 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002531 }
2532
2533 for (size_t i = 0; i < paths.size(); i++) {
2534 if (file_sizes[i] == -1) {
2535 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002536 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002537 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07002538 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002539 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002540 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002541 remover[i].Disable();
2542 EnqueueAddZipEntryAndCleanupIfNeeded(kDumpstateBoardFiles[i], paths[i]);
2543 dprintf(out_fd, "*** See %s entry ***\n", kDumpstateBoardFiles[i].c_str());
Jie Song9fbfad02017-06-20 16:29:42 -07002544 }
Felipe Leme6f674ae2016-11-18 17:10:33 -08002545}
2546
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002547static void ShowUsage() {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002548 fprintf(stderr,
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002549 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-o directory] [-p] "
2550 "[-s] [-S] [-q] [-P] [-R] [-L] [-V version]\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002551 " -h: display this help message\n"
2552 " -b: play sound file instead of vibrate, at beginning of job\n"
2553 " -e: play sound file instead of vibrate, at end of job\n"
mhasank2d75c442020-06-11 15:05:25 -07002554 " -o: write to custom directory (only in limited mode)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01002555 " -p: capture screenshot to filename.png\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002556 " -s: write zipped file to control socket (for init)\n"
2557 " -S: write file location to control socket (for init)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002558 " -q: disable vibrate\n"
Abhijeet Kaure370d682019-10-01 16:49:30 +01002559 " -P: send broadcast when started and do progress updates\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002560 " -R: take bugreport in remote mode (shouldn't be used with -P)\n"
Nandana Dutt235864b2019-01-22 12:10:16 +00002561 " -w: start binder service and make it wait for a call to startBugreport\n"
mhasankd451a472020-05-26 18:02:39 -07002562 " -L: output limited information that is safe for submission in feedback reports\n"
Felipe Lemed071c682016-10-20 16:48:00 -07002563 " -v: prints the dumpstate header and exit\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002564}
2565
Wei Liuf87959e2016-08-26 14:51:42 -07002566static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07002567 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07002568}
2569
Felipe Leme1d486fe2016-10-14 18:06:47 -07002570bool Dumpstate::FinishZipFile() {
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002571 // Runs all enqueued adding zip entry and cleanup tasks before finishing the zip file.
2572 if (zip_entry_tasks_) {
2573 zip_entry_tasks_->run(/* do_cancel = */false);
2574 }
2575
Felipe Leme9a523ae2016-10-20 15:10:33 -07002576 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07002577 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07002578 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002579 // Final timestamp
2580 char date[80];
2581 time_t the_real_now_please_stand_up = time(nullptr);
2582 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002583 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07002584 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002585
Felipe Leme9a523ae2016-10-20 15:10:33 -07002586 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002587 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08002588 return false;
2589 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07002590 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002591 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08002592 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08002593 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08002594
Felipe Leme0f3fb202016-06-10 17:10:53 -07002595 // Add log file (which contains stderr output) to zip...
2596 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07002597 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07002598 MYLOGE("Failed to add dumpstate log to .zip file\n");
2599 return false;
2600 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002601 // TODO: Should truncate the existing file.
2602 // ... and re-open it for further logging.
Nandana Dutta344cb62019-02-22 15:12:35 +00002603 if (!redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()))) {
2604 return false;
2605 }
Felipe Leme0f3fb202016-06-10 17:10:53 -07002606 fprintf(stderr, "\n");
2607
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002608 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07002609 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002610 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002611 return false;
2612 }
2613
Felipe Leme1d486fe2016-10-14 18:06:47 -07002614 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
2615 ds.zip_file.reset(nullptr);
2616
Felipe Lemee9d2c542016-11-15 11:48:26 -08002617 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002618 android::os::UnlinkAndLogOnError(tmp_path_);
Felipe Lemec4eee562016-04-21 15:42:55 -07002619
Felipe Leme1e9edc62015-12-21 16:02:13 -08002620 return true;
2621}
Felipe Leme6e01fa62015-11-11 19:35:14 -08002622
Nikhil Kumar28ce35e2023-01-10 14:32:44 +00002623static void SendBroadcast(const std::string& action,
2624 const std::vector<std::string>& args,
2625 int32_t user_id) {
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002626 // clang-format off
Nikhil Kumar28ce35e2023-01-10 14:32:44 +00002627 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user",
2628 std::to_string(user_id), "--receiver-foreground",
2629 "--receiver-include-background", "-a", action};
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002630 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08002631
2632 am.insert(am.end(), args.begin(), args.end());
2633
Felipe Leme8d2410e2017-02-08 09:46:08 -08002634 RunCommand("", am,
2635 CommandOptions::WithTimeout(20)
2636 .Log("Sending broadcast: '%s'\n")
2637 .Always()
2638 .DropRoot()
2639 .RedirectStderr()
2640 .Build());
2641}
2642
Felipe Leme35b8cf12017-02-10 15:47:29 -08002643static void Vibrate(int duration_ms) {
2644 // clang-format off
Lais Andrade51156962021-02-22 19:21:35 +00002645 std::vector<std::string> args = {"cmd", "vibrator_manager", "synced", "-f", "-d", "dumpstate",
2646 "oneshot", std::to_string(duration_ms)};
2647 RunCommand("", args,
Felipe Leme35b8cf12017-02-10 15:47:29 -08002648 CommandOptions::WithTimeout(10)
2649 .Log("Vibrate: '%s'\n")
2650 .Always()
2651 .Build());
2652 // clang-format on
2653}
2654
Nandana Dutt979388e2018-11-30 16:48:55 +00002655static void MaybeResolveSymlink(std::string* path) {
2656 std::string resolved_path;
2657 if (android::base::Readlink(*path, &resolved_path)) {
2658 *path = resolved_path;
2659 }
2660}
2661
Nandana Dutt4be45d12018-09-26 15:04:23 +01002662/*
2663 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002664 * and adds the version file. Return false if zip_file could not be open to write.
Nandana Dutt4be45d12018-09-26 15:04:23 +01002665 */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002666static bool PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002667 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
2668
Nandana Dutt4be45d12018-09-26 15:04:23 +01002669 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
2670 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002671 ds.base_name_ = StringPrintf("bugreport-%s-%s", device_name.c_str(), build_id.c_str());
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002672 char date[80];
2673 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
2674 ds.name_ = date;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002675
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002676 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002677 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002678 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002679 ds.base_name_ += "-wifi";
2680 }
2681
Paul Chang0d2aad72020-02-13 20:04:03 +08002682 if (ds.options_->do_screenshot) {
Nandana Dutt9d17b942020-03-26 10:02:59 +00002683 ds.screenshot_path_ = ds.GetPath(ds.CalledByApi() ? "-png.tmp" : ".png");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002684 }
2685 ds.tmp_path_ = ds.GetPath(".tmp");
2686 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
2687
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002688 std::string destination = ds.CalledByApi()
Nandana Dutt54dbd672019-01-11 12:58:05 +00002689 ? StringPrintf("[fd:%d]", ds.options_->bugreport_fd.get())
Nandana Dutt9a76d202019-01-21 15:56:48 +00002690 : ds.bugreport_internal_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01002691 MYLOGD(
Nandana Dutt235c6672019-11-14 15:22:32 +00002692 "Bugreport dir: [%s] "
2693 "Base name: [%s] "
2694 "Suffix: [%s] "
2695 "Log path: [%s] "
2696 "Temporary path: [%s] "
2697 "Screenshot path: [%s]\n",
Nandana Dutt9a76d202019-01-21 15:56:48 +00002698 destination.c_str(), ds.base_name_.c_str(), ds.name_.c_str(), ds.log_path_.c_str(),
2699 ds.tmp_path_.c_str(), ds.screenshot_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002700
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002701 ds.path_ = ds.GetPath(ds.CalledByApi() ? "-zip.tmp" : ".zip");
2702 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
2703 create_parent_dirs(ds.path_.c_str());
2704 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
2705 if (ds.zip_file == nullptr) {
2706 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
2707 return false;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002708 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002709 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
2710 ds.AddTextZipEntry("version.txt", ds.version_);
2711 return true;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002712}
2713
2714/*
Abhijeet Kaure370d682019-10-01 16:49:30 +01002715 * Finalizes writing to the file by zipping the tmp file to the final location,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002716 * printing zipped file status, etc.
2717 */
2718static void FinalizeFile() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002719 bool do_text_file = !ds.FinishZipFile();
2720 if (do_text_file) {
2721 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002722 }
mhasank2d75c442020-06-11 15:05:25 -07002723
2724 std::string final_path = ds.path_;
2725 if (ds.options_->OutputToCustomFile()) {
mhasank3a4cfb42020-06-15 18:06:43 -07002726 final_path = ds.GetPath(ds.options_->out_dir, ".zip");
mhasank2d75c442020-06-11 15:05:25 -07002727 android::os::CopyFileToFile(ds.path_, final_path);
2728 }
2729
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002730 if (ds.options_->stream_to_socket) {
2731 android::os::CopyFileToFd(ds.path_, ds.control_socket_fd_);
2732 } else if (ds.options_->progress_updates_to_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002733 if (do_text_file) {
2734 dprintf(ds.control_socket_fd_,
2735 "FAIL:could not create zip file, check %s "
2736 "for more details\n",
2737 ds.log_path_.c_str());
2738 } else {
mhasank2d75c442020-06-11 15:05:25 -07002739 dprintf(ds.control_socket_fd_, "OK:%s\n", final_path.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002740 }
2741 }
2742}
2743
Nandana Dutt4be45d12018-09-26 15:04:23 +01002744
Nandana Dutt58d72e22018-11-16 10:30:48 +00002745static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2746 switch (mode) {
2747 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2748 return "BUGREPORT_FULL";
2749 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2750 return "BUGREPORT_INTERACTIVE";
2751 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2752 return "BUGREPORT_REMOTE";
2753 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2754 return "BUGREPORT_WEAR";
2755 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2756 return "BUGREPORT_TELEPHONY";
2757 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2758 return "BUGREPORT_WIFI";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002759 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2760 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002761 }
2762}
2763
Paul Changf59c2b72020-03-10 02:08:55 +08002764static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options,
2765 bool is_screenshot_requested) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002766 // Modify com.android.shell.BugreportProgressService#isDefaultScreenshotRequired as well for
2767 // default system screenshots.
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002768 options->bugreport_mode = mode;
2769 options->bugreport_mode_string = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002770 switch (mode) {
2771 case Dumpstate::BugreportMode::BUGREPORT_FULL:
Paul Changf59c2b72020-03-10 02:08:55 +08002772 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002773 break;
2774 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002775 // Currently, the dumpstate binder is only used by Shell to update progress.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002776 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002777 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002778 break;
2779 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002780 options->do_vibrate = false;
2781 options->is_remote_mode = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002782 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002783 break;
2784 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002785 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002786 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002787 break;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002788 // TODO(b/148168577) rename TELEPHONY everywhere to CONNECTIVITY.
Nandana Dutt58d72e22018-11-16 10:30:48 +00002789 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002790 options->telephony_only = true;
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002791 options->do_progress_updates = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002792 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002793 break;
2794 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002795 options->wifi_only = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002796 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002797 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002798 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2799 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002800 }
2801}
2802
Nandana Dutt58d72e22018-11-16 10:30:48 +00002803static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
Nandana Dutt235c6672019-11-14 15:22:32 +00002804 MYLOGI(
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002805 "do_vibrate: %d stream_to_socket: %d progress_updates_to_socket: %d do_screenshot: %d "
Rhed Jao25f50e02020-08-20 00:10:32 +08002806 "is_remote_mode: %d show_header_only: %d telephony_only: %d "
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002807 "wifi_only: %d do_progress_updates: %d fd: %d bugreport_mode: %s "
mhasankd451a472020-05-26 18:02:39 -07002808 "limited_only: %d args: %s\n",
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002809 options.do_vibrate, options.stream_to_socket, options.progress_updates_to_socket,
Paul Chang0d2aad72020-02-13 20:04:03 +08002810 options.do_screenshot, options.is_remote_mode, options.show_header_only,
Rhed Jao25f50e02020-08-20 00:10:32 +08002811 options.telephony_only, options.wifi_only,
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002812 options.do_progress_updates, options.bugreport_fd.get(),
2813 options.bugreport_mode_string.c_str(),
2814 options.limited_only, options.args.c_str());
Nandana Dutt58d72e22018-11-16 10:30:48 +00002815}
2816
Nandana Dutt54dbd672019-01-11 12:58:05 +00002817void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode,
Kean Mariotti306633e2022-09-05 16:30:47 +00002818 int bugreport_flags,
Nandana Dutt54dbd672019-01-11 12:58:05 +00002819 const android::base::unique_fd& bugreport_fd_in,
Paul Changf59c2b72020-03-10 02:08:55 +08002820 const android::base::unique_fd& screenshot_fd_in,
2821 bool is_screenshot_requested) {
Kean Mariotti306633e2022-09-05 16:30:47 +00002822 this->use_predumped_ui_data = bugreport_flags & BugreportFlag::BUGREPORT_USE_PREDUMPED_UI_DATA;
Nandana Dutt54dbd672019-01-11 12:58:05 +00002823 // Duplicate the fds because the passed in fds don't outlive the binder transaction.
Todd Frederick621533f2022-03-26 02:54:17 +00002824 bugreport_fd.reset(fcntl(bugreport_fd_in.get(), F_DUPFD_CLOEXEC, 0));
2825 screenshot_fd.reset(fcntl(screenshot_fd_in.get(), F_DUPFD_CLOEXEC, 0));
Nandana Dutt58d72e22018-11-16 10:30:48 +00002826
Paul Changf59c2b72020-03-10 02:08:55 +08002827 SetOptionsFromMode(bugreport_mode, this, is_screenshot_requested);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002828}
2829
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002830Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
2831 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002832 int c;
mhasankd451a472020-05-26 18:02:39 -07002833 while ((c = getopt(argc, argv, "dho:svqzpLPBRSV:w")) != -1) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002834 switch (c) {
2835 // clang-format off
mhasank3a4cfb42020-06-15 18:06:43 -07002836 case 'o': out_dir = optarg; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002837 case 's': stream_to_socket = true; break;
2838 case 'S': progress_updates_to_socket = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002839 case 'v': show_header_only = true; break;
2840 case 'q': do_vibrate = false; break;
Paul Chang0d2aad72020-02-13 20:04:03 +08002841 case 'p': do_screenshot = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002842 case 'P': do_progress_updates = true; break;
2843 case 'R': is_remote_mode = true; break;
mhasankd451a472020-05-26 18:02:39 -07002844 case 'L': limited_only = true; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002845 case 'V':
2846 case 'd':
2847 case 'z':
2848 // compatibility no-op
2849 break;
Nandana Dutt235864b2019-01-22 12:10:16 +00002850 case 'w':
2851 // This was already processed
2852 break;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002853 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002854 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002855 break;
2856 default:
2857 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002858 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002859 break;
2860 // clang-format on
2861 }
2862 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08002863
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002864 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002865 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002866 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002867 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002868 }
2869 }
2870
2871 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
2872 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002873
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002874 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002875}
2876
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002877bool Dumpstate::DumpOptions::ValidateOptions() const {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002878 if (bugreport_fd.get() != -1 && stream_to_socket) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002879 return false;
2880 }
2881
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002882 if ((progress_updates_to_socket || do_progress_updates) && stream_to_socket) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002883 return false;
2884 }
2885
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002886 if (is_remote_mode && (do_progress_updates || stream_to_socket)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002887 return false;
2888 }
2889 return true;
2890}
2891
Nandana Dutt197661d2018-11-16 16:40:21 +00002892void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
2893 options_ = std::move(options);
2894}
2895
Abhijeet Kaura407fb82020-03-27 12:51:12 +00002896void Dumpstate::Initialize() {
2897 /* gets the sequential id */
2898 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
2899 id_ = ++last_id;
2900 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
2901}
2902
Nandana Duttd2f5f082019-01-18 17:13:52 +00002903Dumpstate::RunStatus Dumpstate::Run(int32_t calling_uid, const std::string& calling_package) {
2904 Dumpstate::RunStatus status = RunInternal(calling_uid, calling_package);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002905 if (listener_ != nullptr) {
2906 switch (status) {
2907 case Dumpstate::RunStatus::OK:
Nandana Duttcc4ead82019-01-23 08:29:23 +00002908 listener_->onFinished();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002909 break;
2910 case Dumpstate::RunStatus::HELP:
2911 break;
2912 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002913 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_INVALID_INPUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002914 break;
2915 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002916 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_RUNTIME_ERROR);
2917 break;
2918 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2919 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_DENIED_CONSENT);
2920 break;
2921 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
2922 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_CONSENT_TIMED_OUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002923 break;
2924 }
2925 }
2926 return status;
2927}
2928
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002929void Dumpstate::Cancel() {
2930 CleanupTmpFiles();
2931 android::os::UnlinkAndLogOnError(log_path_);
2932 for (int i = 0; i < NUM_OF_DUMPS; i++) {
2933 android::os::UnlinkAndLogOnError(ds.bugreport_internal_dir_ + "/" +
2934 kDumpstateBoardFiles[i]);
2935 }
2936 tombstone_data_.clear();
2937 anr_data_.clear();
Woody Lin20767a92022-11-29 15:50:24 +08002938 shutdown_checkpoints_.clear();
Rhed Jao0daac912020-08-21 14:48:20 +08002939
2940 // Instead of shutdown the pool, we delete temporary files directly since
2941 // shutdown blocking the call.
2942 if (dump_pool_) {
2943 dump_pool_->deleteTempFiles();
2944 }
2945 if (zip_entry_tasks_) {
2946 zip_entry_tasks_->run(/*do_cancel =*/ true);
2947 }
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002948}
2949
Kean Mariotti306633e2022-09-05 16:30:47 +00002950void Dumpstate::PreDumpUiData() {
2951 MaybeSnapshotUiTraces();
2952}
2953
Nandana Dutt979388e2018-11-30 16:48:55 +00002954/*
2955 * Dumps relevant information to a bugreport based on the given options.
2956 *
2957 * The bugreport can be dumped to a file or streamed to a socket.
2958 *
2959 * How dumping to file works:
2960 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
2961 * stderr is redirected a log file.
2962 *
2963 * The temporary bugreport is then populated via printfs, dumping contents of files and
2964 * output of commands to stdout.
2965 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002966 * A bunch of other files and dumps are added to the zip archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00002967 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002968 * The temporary bugreport file and the log file also get added to the archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00002969 *
mhasank2d75c442020-06-11 15:05:25 -07002970 * Bugreports are first generated in a local directory and later copied to the caller's fd
2971 * or directory if supplied.
Nandana Dutt979388e2018-11-30 16:48:55 +00002972 */
Nandana Duttd2f5f082019-01-18 17:13:52 +00002973Dumpstate::RunStatus Dumpstate::RunInternal(int32_t calling_uid,
2974 const std::string& calling_package) {
Rhed Jao5377d792020-07-16 17:37:39 +08002975 DurationReporter duration_reporter("RUN INTERNAL", /* logcat_only = */true);
Nandana Dutt979388e2018-11-30 16:48:55 +00002976 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00002977 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002978 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002979 return RunStatus::INVALID_INPUT;
2980 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002981 /* set as high priority, and protect from OOM killer */
2982 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002983
Felipe Lemed071c682016-10-20 16:48:00 -07002984 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002985 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002986 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002987 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002988 } else {
2989 /* fallback to kernels <= 2.6.35 */
2990 oom_adj = fopen("/proc/self/oom_adj", "we");
2991 if (oom_adj) {
2992 fputs("-17", oom_adj);
2993 fclose(oom_adj);
2994 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002995 }
2996
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002997 if (version_ == VERSION_DEFAULT) {
2998 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00002999 }
3000
Chris Morin5a50d482022-02-01 17:41:18 -08003001 if (version_ != VERSION_CURRENT) {
3002 MYLOGE("invalid version requested ('%s'); supported values are: ('%s', '%s')\n",
3003 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003004 return RunStatus::INVALID_INPUT;
Felipe Lemed071c682016-10-20 16:48:00 -07003005 }
3006
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003007 if (options_->show_header_only) {
3008 PrintHeader();
3009 return RunStatus::OK;
Felipe Lemed071c682016-10-20 16:48:00 -07003010 }
3011
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003012 MYLOGD("dumpstate calling_uid = %d ; calling package = %s \n",
3013 calling_uid, calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003014
Felipe Leme7447d7c2016-11-03 18:12:22 -07003015 // TODO: temporarily set progress until it's part of the Dumpstate constructor
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003016 std::string stats_path =
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003017 android::base::StringPrintf("%s/dumpstate-stats.txt", bugreport_internal_dir_.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003018 progress_.reset(new Progress(stats_path));
Felipe Leme7447d7c2016-11-03 18:12:22 -07003019
Sahana Raof35ed432019-07-12 10:47:52 +01003020 if (acquire_wake_lock(PARTIAL_WAKE_LOCK, WAKE_LOCK_NAME) < 0) {
3021 MYLOGE("Failed to acquire wake lock: %s\n", strerror(errno));
3022 } else {
3023 // Wake lock will be released automatically on process death
3024 MYLOGD("Wake lock acquired.\n");
3025 }
3026
Felipe Leme6ae5c4f2017-01-10 14:13:22 -08003027 register_sig_handler();
Felipe Lemed071c682016-10-20 16:48:00 -07003028
Felipe Lemef0292972016-11-22 13:57:05 -08003029 if (PropertiesHelper::IsDryRun()) {
Felipe Lemed071c682016-10-20 16:48:00 -07003030 MYLOGI("Running on dry-run mode (to disable it, call 'setprop dumpstate.dry_run false')\n");
3031 }
3032
Nandana Dutt235c6672019-11-14 15:22:32 +00003033 MYLOGI("dumpstate info: id=%d, args='%s', bugreport_mode= %s bugreport format version: %s\n",
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00003034 id_, options_->args.c_str(), options_->bugreport_mode_string.c_str(), version_.c_str());
Felipe Leme809d74e2016-02-02 12:57:00 -08003035
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003036 do_early_screenshot_ = options_->do_progress_updates;
Felipe Lemee338bf62015-12-07 14:03:50 -08003037
Christopher Ferrised9354f2014-10-01 17:35:01 -07003038 // If we are going to use a socket, do it as early as possible
3039 // to avoid timeouts from bugreport.
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003040 if (options_->stream_to_socket || options_->progress_updates_to_socket) {
Felipe Leme2628e9e2016-04-12 16:36:51 -07003041 MYLOGD("Opening control socket\n");
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003042 control_socket_fd_ = open_socket_fn_("dumpstate");
Nandana Dutta344cb62019-02-22 15:12:35 +00003043 if (control_socket_fd_ == -1) {
3044 return ERROR;
3045 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003046 if (options_->progress_updates_to_socket) {
3047 options_->do_progress_updates = 1;
3048 }
Felipe Leme2628e9e2016-04-12 16:36:51 -07003049 }
3050
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003051 if (!PrepareToWriteToFile()) {
3052 return ERROR;
3053 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08003054
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003055 // Interactive, wear & telephony modes are default to true.
3056 // and may enable from cli option or when using control socket
3057 if (options_->do_progress_updates) {
3058 // clang-format off
3059 std::vector<std::string> am_args = {
3060 "--receiver-permission", "android.permission.DUMP",
3061 };
3062 // clang-format on
3063 // Send STARTED broadcast for apps that listen to bugreport generation events
Nikhil Kumar28ce35e2023-01-10 14:32:44 +00003064 SendBroadcast("com.android.internal.intent.action.BUGREPORT_STARTED",
3065 am_args, multiuser_get_user_id(calling_uid));
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003066 if (options_->progress_updates_to_socket) {
3067 dprintf(control_socket_fd_, "BEGIN:%s\n", path_.c_str());
Felipe Leme71bbfc52015-11-23 14:14:51 -08003068 }
3069 }
3070
Nick Kralevichf3599b32016-01-25 15:05:16 -08003071 /* read /proc/cmdline before dropping root */
3072 FILE *cmdline = fopen("/proc/cmdline", "re");
3073 if (cmdline) {
3074 fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
3075 fclose(cmdline);
3076 }
3077
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003078 if (options_->do_vibrate) {
Felipe Leme35b8cf12017-02-10 15:47:29 -08003079 Vibrate(150);
John Michelau1f794c42012-09-17 11:20:19 -05003080 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003081
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003082 if (zip_file != nullptr) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003083 if (chown(path_.c_str(), AID_SHELL, AID_SHELL)) {
3084 MYLOGE("Unable to change ownership of zip file %s: %s\n", path_.c_str(),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003085 strerror(errno));
Felipe Leme1e9edc62015-12-21 16:02:13 -08003086 }
3087 }
3088
Nandana Dutt3f8c7172018-09-25 12:01:54 +01003089 int dup_stdout_fd;
3090 int dup_stderr_fd;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003091 // Redirect stderr to log_path_ for debugging.
3092 TEMP_FAILURE_RETRY(dup_stderr_fd = dup(fileno(stderr)));
3093 if (!redirect_to_file(stderr, const_cast<char*>(log_path_.c_str()))) {
3094 return ERROR;
3095 }
3096 if (chown(log_path_.c_str(), AID_SHELL, AID_SHELL)) {
3097 MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n", log_path_.c_str(),
3098 strerror(errno));
3099 }
Nandana Dutt979388e2018-11-30 16:48:55 +00003100
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003101 // Redirect stdout to tmp_path_. This is the main bugreport entry and will be
3102 // moved into zip file later, if zipping.
3103 TEMP_FAILURE_RETRY(dup_stdout_fd = dup(fileno(stdout)));
3104 // TODO: why not write to a file instead of stdout to overcome this problem?
3105 /* TODO: rather than generating a text file now and zipping it later,
3106 it would be more efficient to redirect stdout to the zip entry
3107 directly, but the libziparchive doesn't support that option yet. */
3108 if (!redirect_to_file(stdout, const_cast<char*>(tmp_path_.c_str()))) {
3109 return ERROR;
3110 }
3111 if (chown(tmp_path_.c_str(), AID_SHELL, AID_SHELL)) {
3112 MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
3113 tmp_path_.c_str(), strerror(errno));
Colin Crossf45fa6b2012-03-26 12:38:26 -07003114 }
Felipe Lemed8b94e52016-12-08 10:21:44 -08003115
3116 // Don't buffer stdout
3117 setvbuf(stdout, nullptr, _IONBF, 0);
3118
Rhed Jao5377d792020-07-16 17:37:39 +08003119 // Enable the parallel run if the client requests to output to a file.
3120 EnableParallelRunIfNeeded();
3121 // Using scope guard to make sure the dump pool can be shut down correctly.
3122 auto scope_guard_to_shutdown_pool = android::base::make_scope_guard([=]() {
3123 ShutdownDumpPool();
3124 });
3125
Felipe Leme608385d2016-02-01 10:35:38 -08003126 // NOTE: there should be no stdout output until now, otherwise it would break the header.
3127 // In particular, DurationReport objects should be created passing 'title, NULL', so their
Felipe Lemecbce55d2016-02-08 09:53:18 -08003128 // duration is logged into MYLOG instead.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003129 PrintHeader();
Colin Crossf45fa6b2012-03-26 12:38:26 -07003130
Gavin Corkery6968f552020-11-22 18:09:05 +00003131 bool is_dumpstate_restricted = options_->telephony_only
3132 || options_->wifi_only
3133 || options_->limited_only;
3134 if (!is_dumpstate_restricted) {
Paul Chang0d2aad72020-02-13 20:04:03 +08003135 // Invoke critical dumpsys first to preserve system state, before doing anything else.
Jichao Lie89d9c12019-11-21 19:02:51 -08003136 RunDumpsysCritical();
Gavin Corkery6968f552020-11-22 18:09:05 +00003137 }
3138 MaybeTakeEarlyScreenshot();
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003139
3140 if (!is_dumpstate_restricted) {
3141 // Snapshot the system trace now (if running) to avoid that dumpstate's
3142 // own activity pushes out interesting data from the trace ring buffer.
3143 // The trace file is added to the zip by MaybeAddSystemTraceToZip().
3144 MaybeSnapshotSystemTrace();
Yohei Yukawa95305b32021-03-09 07:54:27 -08003145
Kean Mariotti306633e2022-09-05 16:30:47 +00003146 // Snapshot the UI traces now (if running).
3147 // The trace files will be added to bugreport later.
3148 MaybeSnapshotUiTraces();
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003149 }
Gavin Corkery6968f552020-11-22 18:09:05 +00003150 onUiIntensiveBugreportDumpsFinished(calling_uid);
3151 MaybeCheckUserConsent(calling_uid, calling_package);
3152 if (options_->telephony_only) {
3153 DumpstateTelephonyOnly(calling_package);
3154 } else if (options_->wifi_only) {
3155 DumpstateWifiOnly();
3156 } else if (options_->limited_only) {
3157 DumpstateLimitedOnly();
3158 } else {
Nandana Dutt4be45d12018-09-26 15:04:23 +01003159 // Dump state for the default case. This also drops root.
Jichao Lie89d9c12019-11-21 19:02:51 -08003160 RunStatus s = DumpstateDefaultAfterCritical();
Nandana Dutt5c390032019-03-12 10:52:56 +00003161 if (s != RunStatus::OK) {
Nandana Duttaac6f582019-07-26 14:32:47 +01003162 if (s == RunStatus::USER_CONSENT_DENIED) {
Nandana Dutt5c390032019-03-12 10:52:56 +00003163 HandleUserConsentDenied();
3164 }
3165 return s;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08003166 }
Zhengyin Qian068ecc72016-08-10 16:48:14 -07003167 }
Felipe Leme71a74ac2016-03-17 15:43:25 -07003168
Felipe Leme55b42a62015-11-10 17:39:08 -08003169 /* close output if needed */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003170 TEMP_FAILURE_RETRY(dup2(dup_stdout_fd, fileno(stdout)));
Colin Crossf45fa6b2012-03-26 12:38:26 -07003171
Abhijeet Kaure370d682019-10-01 16:49:30 +01003172 // Zip the (now complete) .tmp file within the internal directory.
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003173 ATRACE_BEGIN("FinalizeFile");
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003174 FinalizeFile();
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003175 ATRACE_END();
Colin Crossf45fa6b2012-03-26 12:38:26 -07003176
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003177 // Share the final file with the caller if the user has consented or Shell is the caller.
Nandana Duttd2f5f082019-01-18 17:13:52 +00003178 Dumpstate::RunStatus status = Dumpstate::RunStatus::OK;
Abhijeet Kaure370d682019-10-01 16:49:30 +01003179 if (CalledByApi()) {
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003180 status = CopyBugreportIfUserConsented(calling_uid);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003181 if (status != Dumpstate::RunStatus::OK &&
3182 status != Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
3183 // Do an early return if there were errors. We make an exception for consent
3184 // timing out because it's possible the user got distracted. In this case the
3185 // bugreport is not shared but made available for manual retrieval.
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003186 MYLOGI("User denied consent. Returning\n");
Nandana Duttd2f5f082019-01-18 17:13:52 +00003187 return status;
3188 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003189 if (status == Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
3190 MYLOGI(
3191 "Did not receive user consent yet."
3192 " Will not copy the bugreport artifacts to caller.\n");
Abhijeet Kaur57627412019-04-17 16:00:09 +01003193 const String16 incidentcompanion("incidentcompanion");
3194 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
3195 if (ics != nullptr) {
3196 MYLOGD("Canceling user consent request via incidentcompanion service\n");
3197 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
3198 consent_callback_.get());
3199 } else {
3200 MYLOGD("Unable to cancel user consent; incidentcompanion service unavailable\n");
3201 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003202 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003203 }
3204
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08003205 /* vibrate a few but shortly times to let user know it's finished */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003206 if (options_->do_vibrate) {
Takuya Ogawa47f644e2017-12-20 18:09:09 +09003207 for (int i = 0; i < 3; i++) {
3208 Vibrate(75);
3209 usleep((75 + 50) * 1000);
3210 }
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08003211 }
3212
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003213 MYLOGD("Final progress: %d/%d (estimated %d)\n", progress_->Get(), progress_->GetMax(),
3214 progress_->GetInitialMax());
3215 progress_->Save();
3216 MYLOGI("done (id %d)\n", id_);
Colin Crossf45fa6b2012-03-26 12:38:26 -07003217
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003218 TEMP_FAILURE_RETRY(dup2(dup_stderr_fd, fileno(stderr)));
Felipe Leme107a05f2016-03-08 15:11:15 -08003219
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003220 if (control_socket_fd_ != -1) {
Felipe Lemee844a9d2016-09-21 15:01:39 -07003221 MYLOGD("Closing control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003222 close(control_socket_fd_);
Felipe Leme2628e9e2016-04-12 16:36:51 -07003223 }
3224
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003225 tombstone_data_.clear();
3226 anr_data_.clear();
Woody Lin20767a92022-11-29 15:50:24 +08003227 shutdown_checkpoints_.clear();
Narayan Kamath6b9516c2017-10-27 11:15:51 +01003228
Nandana Duttd2f5f082019-01-18 17:13:52 +00003229 return (consent_callback_ != nullptr &&
3230 consent_callback_->getResult() == UserConsentResult::UNAVAILABLE)
3231 ? USER_CONSENT_TIMED_OUT
3232 : RunStatus::OK;
3233}
3234
Paul Chang0d2aad72020-02-13 20:04:03 +08003235void Dumpstate::MaybeTakeEarlyScreenshot() {
3236 if (!options_->do_screenshot || !do_early_screenshot_) {
3237 return;
3238 }
3239
3240 TakeScreenshot();
3241}
3242
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003243void Dumpstate::MaybeSnapshotSystemTrace() {
3244 // If a background system trace is happening and is marked as "suitable for
3245 // bugreport" (i.e. bugreport_score > 0 in the trace config), this command
3246 // will stop it and serialize into SYSTEM_TRACE_SNAPSHOT. In the (likely)
3247 // case that no trace is ongoing, this command is a no-op.
3248 // Note: this should not be enqueued as we need to freeze the trace before
3249 // dumpstate starts. Otherwise the trace ring buffers will contain mostly
3250 // the dumpstate's own activity which is irrelevant.
3251 int res = RunCommand(
3252 "SERIALIZE PERFETTO TRACE",
3253 {"perfetto", "--save-for-bugreport"},
3254 CommandOptions::WithTimeout(10)
3255 .DropRoot()
3256 .CloseAllFileDescriptorsOnExec()
3257 .Build());
3258 has_system_trace_ = res == 0;
3259 // MaybeAddSystemTraceToZip() will take care of copying the trace in the zip
3260 // file in the later stages.
3261}
3262
Kean Mariotti306633e2022-09-05 16:30:47 +00003263void Dumpstate::MaybeSnapshotUiTraces() {
3264 if (PropertiesHelper::IsUserBuild() || options_->use_predumped_ui_data) {
3265 return;
3266 }
3267
Yohei Yukawa02b1d2c2021-03-16 09:20:30 -07003268 // Currently WindowManagerService and InputMethodManagerSerivice support WinScope protocol.
Kean Mariotti306633e2022-09-05 16:30:47 +00003269 for (const auto& service : {"input_method", "window"}) {
Yohei Yukawa02b1d2c2021-03-16 09:20:30 -07003270 RunCommand(
3271 // Empty name because it's not intended to be classified as a bugreport section.
3272 // Actual tracing files can be found in "/data/misc/wmtrace/" in the bugreport.
3273 "", {"cmd", service, "tracing", "save-for-bugreport"},
3274 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3275 }
Kean Mariotti306633e2022-09-05 16:30:47 +00003276
3277 static const auto SURFACEFLINGER_COMMAND_SAVE_ALL_TRACES = std::vector<std::string> {
3278 "service", "call", "SurfaceFlinger", "1042"
3279 };
3280 // Empty name because it's not intended to be classified as a bugreport section.
3281 // Actual tracing files can be found in "/data/misc/wmtrace/" in the bugreport.
3282 RunCommand(
3283 "", SURFACEFLINGER_COMMAND_SAVE_ALL_TRACES,
3284 CommandOptions::WithTimeout(10).Always().AsRoot().RedirectStderr().Build());
3285}
3286
3287void Dumpstate::MaybePostProcessUiTraces() {
3288 if (PropertiesHelper::IsUserBuild()) {
3289 return;
3290 }
3291
3292 RunCommand(
3293 // Empty name because it's not intended to be classified as a bugreport section.
3294 // Actual tracing files can be found in "/data/misc/wmtrace/" in the bugreport.
3295 "", {
3296 "/system/xbin/su", "system",
3297 "/system/bin/layertracegenerator",
3298 "/data/misc/wmtrace/transactions_trace.winscope",
3299 "/data/misc/wmtrace/layers_trace_from_transactions.winscope"
3300 },
3301 CommandOptions::WithTimeout(120).Always().RedirectStderr().Build());
3302}
3303
3304void Dumpstate::MaybeAddUiTracesToZip() {
3305 if (PropertiesHelper::IsUserBuild()) {
3306 return;
3307 }
3308
3309 ds.AddDir(WMTRACE_DATA_DIR, false);
Yohei Yukawa95305b32021-03-09 07:54:27 -08003310}
3311
Paul Changeb4b4642020-05-28 22:05:47 +08003312void Dumpstate::onUiIntensiveBugreportDumpsFinished(int32_t calling_uid) {
Nikhil Kumar28ce35e2023-01-10 14:32:44 +00003313 if (multiuser_get_app_id(calling_uid) == AID_SHELL || !CalledByApi()) {
Paul Changc490e662020-04-11 18:14:09 +08003314 return;
3315 }
3316 if (listener_ != nullptr) {
3317 // Let listener know ui intensive bugreport dumps are finished, then it can do event
3318 // handling if required.
Paul Changeb4b4642020-05-28 22:05:47 +08003319 listener_->onUiIntensiveBugreportDumpsFinished();
Paul Changc490e662020-04-11 18:14:09 +08003320 }
3321}
3322
Jichao Lie89d9c12019-11-21 19:02:51 -08003323void Dumpstate::MaybeCheckUserConsent(int32_t calling_uid, const std::string& calling_package) {
Nikhil Kumar28ce35e2023-01-10 14:32:44 +00003324 if (multiuser_get_app_id(calling_uid) == AID_SHELL || !CalledByApi()) {
Jichao Lie89d9c12019-11-21 19:02:51 -08003325 // No need to get consent for shell triggered dumpstates, or not through
3326 // bugreporting API (i.e. no fd to copy back).
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003327 return;
3328 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003329 consent_callback_ = new ConsentCallback();
3330 const String16 incidentcompanion("incidentcompanion");
3331 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
Jichao Lie89d9c12019-11-21 19:02:51 -08003332 android::String16 package(calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003333 if (ics != nullptr) {
3334 MYLOGD("Checking user consent via incidentcompanion service\n");
3335 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
Jichao Lie89d9c12019-11-21 19:02:51 -08003336 calling_uid, package, String16(), String16(),
Joe Onorato1c36d752019-03-17 18:26:43 -07003337 0x1 /* FLAG_CONFIRMATION_DIALOG */, consent_callback_.get());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003338 } else {
3339 MYLOGD("Unable to check user consent; incidentcompanion service unavailable\n");
3340 }
3341}
3342
Nandana Dutt5c390032019-03-12 10:52:56 +00003343bool Dumpstate::IsUserConsentDenied() const {
3344 return ds.consent_callback_ != nullptr &&
3345 ds.consent_callback_->getResult() == UserConsentResult::DENIED;
3346}
3347
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01003348bool Dumpstate::CalledByApi() const {
3349 return ds.options_->bugreport_fd.get() != -1 ? true : false;
3350}
3351
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003352void Dumpstate::CleanupTmpFiles() {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003353 android::os::UnlinkAndLogOnError(tmp_path_);
3354 android::os::UnlinkAndLogOnError(screenshot_path_);
3355 android::os::UnlinkAndLogOnError(path_);
Gavin Corkery789d7a52021-02-24 23:52:35 +00003356 if (dump_traces_path != nullptr) {
3357 android::os::UnlinkAndLogOnError(dump_traces_path);
3358 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003359}
3360
Rhed Jao5377d792020-07-16 17:37:39 +08003361void Dumpstate::EnableParallelRunIfNeeded() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003362 if (!PropertiesHelper::IsParallelRun()) {
Rhed Jao5377d792020-07-16 17:37:39 +08003363 return;
3364 }
3365 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003366 zip_entry_tasks_ = std::make_unique<TaskQueue>();
Rhed Jao5377d792020-07-16 17:37:39 +08003367}
3368
3369void Dumpstate::ShutdownDumpPool() {
3370 if (dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08003371 dump_pool_.reset();
Rhed Jao5377d792020-07-16 17:37:39 +08003372 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003373 if (zip_entry_tasks_) {
3374 zip_entry_tasks_->run(/* do_cancel = */true);
3375 zip_entry_tasks_ = nullptr;
3376 }
3377}
3378
3379void Dumpstate::EnqueueAddZipEntryAndCleanupIfNeeded(const std::string& entry_name,
3380 const std::string& entry_path) {
3381 auto func_add_zip_entry_and_cleanup = [=](bool task_cancelled) {
3382 if (!task_cancelled) {
3383 AddZipEntry(entry_name, entry_path);
3384 }
3385 android::os::UnlinkAndLogOnError(entry_path);
3386 };
3387 if (zip_entry_tasks_) {
3388 // Enqueues AddZipEntryAndCleanup function if the parallel run is enabled.
3389 zip_entry_tasks_->add(func_add_zip_entry_and_cleanup, _1);
3390 } else {
3391 // Invokes AddZipEntryAndCleanup immediately
3392 std::invoke(func_add_zip_entry_and_cleanup, /* task_cancelled = */false);
3393 }
Rhed Jao5377d792020-07-16 17:37:39 +08003394}
3395
Nandana Duttd2f5f082019-01-18 17:13:52 +00003396Dumpstate::RunStatus Dumpstate::HandleUserConsentDenied() {
3397 MYLOGD("User denied consent; deleting files and returning\n");
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003398 CleanupTmpFiles();
Nandana Duttd2f5f082019-01-18 17:13:52 +00003399 return USER_CONSENT_DENIED;
3400}
3401
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003402Dumpstate::RunStatus Dumpstate::CopyBugreportIfUserConsented(int32_t calling_uid) {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003403 // If the caller has asked to copy the bugreport over to their directory, we need explicit
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003404 // user consent (unless the caller is Shell).
3405 UserConsentResult consent_result;
Nikhil Kumar28ce35e2023-01-10 14:32:44 +00003406 if (multiuser_get_app_id(calling_uid) == AID_SHELL) {
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003407 consent_result = UserConsentResult::APPROVED;
3408 } else {
3409 consent_result = consent_callback_->getResult();
3410 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003411 if (consent_result == UserConsentResult::UNAVAILABLE) {
3412 // User has not responded yet.
3413 uint64_t elapsed_ms = consent_callback_->getElapsedTimeMs();
Hunter Knepshield70610fa2020-01-03 15:27:33 -08003414 // Telephony is a fast report type, particularly on user builds where information may be
3415 // more aggressively limited. To give the user time to read the consent dialog, increase the
3416 // timeout.
3417 uint64_t timeout_ms = options_->telephony_only ? TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS
3418 : USER_CONSENT_TIMEOUT_MS;
3419 if (elapsed_ms < timeout_ms) {
3420 uint delay_seconds = (timeout_ms - elapsed_ms) / 1000;
Nandana Duttd2f5f082019-01-18 17:13:52 +00003421 MYLOGD("Did not receive user consent yet; going to wait for %d seconds", delay_seconds);
3422 sleep(delay_seconds);
3423 }
3424 consent_result = consent_callback_->getResult();
3425 }
3426 if (consent_result == UserConsentResult::DENIED) {
3427 // User has explicitly denied sharing with the app. To be safe delete the
3428 // internal bugreport & tmp files.
3429 return HandleUserConsentDenied();
3430 }
3431 if (consent_result == UserConsentResult::APPROVED) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00003432 bool copy_succeeded = android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
3433 if (copy_succeeded) {
3434 android::os::UnlinkAndLogOnError(path_);
Abhijeet Kaur9ce94672020-04-01 17:22:36 +01003435 if (options_->do_screenshot &&
3436 options_->screenshot_fd.get() != -1 &&
3437 !options_->is_screenshot_copied) {
3438 copy_succeeded = android::os::CopyFileToFd(screenshot_path_,
3439 options_->screenshot_fd.get());
3440 options_->is_screenshot_copied = copy_succeeded;
3441 if (copy_succeeded) {
3442 android::os::UnlinkAndLogOnError(screenshot_path_);
3443 }
3444 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003445 }
3446 return copy_succeeded ? Dumpstate::RunStatus::OK : Dumpstate::RunStatus::ERROR;
3447 } else if (consent_result == UserConsentResult::UNAVAILABLE) {
3448 // consent_result is still UNAVAILABLE. The user has likely not responded yet.
3449 // Since we do not have user consent to share the bugreport it does not get
3450 // copied over to the calling app but remains in the internal directory from
3451 // where the user can manually pull it.
Paul Changce644212021-05-11 16:06:45 +08003452 std::string final_path = GetPath(".zip");
3453 bool copy_succeeded = android::os::CopyFileToFile(path_, final_path);
3454 if (copy_succeeded) {
3455 android::os::UnlinkAndLogOnError(path_);
3456 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003457 return Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT;
3458 }
3459 // Unknown result; must be a programming error.
3460 MYLOGE("Unknown user consent result:%d\n", consent_result);
3461 return Dumpstate::RunStatus::ERROR;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003462}
3463
Nandana Duttf02564e2019-02-15 15:24:24 +00003464Dumpstate::RunStatus Dumpstate::ParseCommandlineAndRun(int argc, char* argv[]) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003465 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
3466 Dumpstate::RunStatus status = options->Initialize(argc, argv);
3467 if (status == Dumpstate::RunStatus::OK) {
Nandana Duttf02564e2019-02-15 15:24:24 +00003468 SetOptions(std::move(options));
Nandana Duttd2f5f082019-01-18 17:13:52 +00003469 // When directly running dumpstate binary, the output is not expected to be written
3470 // to any external file descriptor.
Nandana Duttf02564e2019-02-15 15:24:24 +00003471 assert(options_->bugreport_fd.get() == -1);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003472
3473 // calling_uid and calling_package are for user consent to share the bugreport with
Abhijeet Kaura407fb82020-03-27 12:51:12 +00003474 // an app; they are irrelevant here because bugreport is triggered via command line.
3475 // Update Last ID before calling Run().
3476 Initialize();
Nandana Duttf02564e2019-02-15 15:24:24 +00003477 status = Run(-1 /* calling_uid */, "" /* calling_package */);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003478 }
Nandana Duttf02564e2019-02-15 15:24:24 +00003479 return status;
3480}
3481
3482/* Main entry point for dumpstate binary. */
3483int run_main(int argc, char* argv[]) {
3484 Dumpstate::RunStatus status = ds.ParseCommandlineAndRun(argc, argv);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003485
3486 switch (status) {
3487 case Dumpstate::RunStatus::OK:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003488 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003489 case Dumpstate::RunStatus::HELP:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003490 ShowUsage();
3491 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003492 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003493 fprintf(stderr, "Invalid combination of args\n");
3494 ShowUsage();
3495 exit(1);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003496 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00003497 FALLTHROUGH_INTENDED;
3498 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
3499 FALLTHROUGH_INTENDED;
3500 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003501 exit(2);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003502 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003503}
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003504
3505// TODO(111441001): Default DumpOptions to sensible values.
3506Dumpstate::Dumpstate(const std::string& version)
3507 : pid_(getpid()),
3508 options_(new Dumpstate::DumpOptions()),
Nandana Dutt402a8392019-06-14 14:25:13 +01003509 last_reported_percent_progress_(0),
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003510 version_(version),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003511 now_(time(nullptr)),
3512 open_socket_fn_(open_socket) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003513}
3514
3515Dumpstate& Dumpstate::GetInstance() {
3516 static Dumpstate singleton_(android::base::GetProperty("dumpstate.version", VERSION_CURRENT));
3517 return singleton_;
3518}
3519
Rhed Jao5377d792020-07-16 17:37:39 +08003520DurationReporter::DurationReporter(const std::string& title, bool logcat_only, bool verbose,
3521 int duration_fd) : title_(title), logcat_only_(logcat_only), verbose_(verbose),
3522 duration_fd_(duration_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003523 if (!title_.empty()) {
3524 started_ = Nanotime();
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003525 if (title_.find("SHOW MAP") == std::string::npos) {
3526 ATRACE_ASYNC_BEGIN(title_.c_str(), 0);
3527 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003528 }
3529}
3530
3531DurationReporter::~DurationReporter() {
3532 if (!title_.empty()) {
3533 float elapsed = (float)(Nanotime() - started_) / NANOS_PER_SEC;
chenqiwuaf8b2d92019-12-12 18:53:51 +08003534 if (elapsed >= .5f || verbose_) {
3535 MYLOGD("Duration of '%s': %.2fs\n", title_.c_str(), elapsed);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003536 }
chenqiwuaf8b2d92019-12-12 18:53:51 +08003537 if (!logcat_only_) {
3538 // Use "Yoda grammar" to make it easier to grep|sort sections.
Rhed Jao5377d792020-07-16 17:37:39 +08003539 dprintf(duration_fd_, "------ %.3fs was the duration of '%s' ------\n",
3540 elapsed, title_.c_str());
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003541 }
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003542 if (title_.find("SHOW MAP") == std::string::npos) {
3543 ATRACE_ASYNC_END(title_.c_str(), 0);
3544 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003545 }
3546}
3547
3548const int32_t Progress::kDefaultMax = 5000;
3549
3550Progress::Progress(const std::string& path) : Progress(Progress::kDefaultMax, 1.1, path) {
3551}
3552
3553Progress::Progress(int32_t initial_max, int32_t progress, float growth_factor)
3554 : Progress(initial_max, growth_factor, "") {
3555 progress_ = progress;
3556}
3557
3558Progress::Progress(int32_t initial_max, float growth_factor, const std::string& path)
3559 : initial_max_(initial_max),
3560 progress_(0),
3561 max_(initial_max),
3562 growth_factor_(growth_factor),
3563 n_runs_(0),
3564 average_max_(0),
3565 path_(path) {
3566 if (!path_.empty()) {
3567 Load();
3568 }
3569}
3570
3571void Progress::Load() {
3572 MYLOGD("Loading stats from %s\n", path_.c_str());
3573 std::string content;
3574 if (!android::base::ReadFileToString(path_, &content)) {
3575 MYLOGI("Could not read stats from %s; using max of %d\n", path_.c_str(), max_);
3576 return;
3577 }
3578 if (content.empty()) {
3579 MYLOGE("No stats (empty file) on %s; using max of %d\n", path_.c_str(), max_);
3580 return;
3581 }
3582 std::vector<std::string> lines = android::base::Split(content, "\n");
3583
3584 if (lines.size() < 1) {
3585 MYLOGE("Invalid stats on file %s: not enough lines (%d). Using max of %d\n", path_.c_str(),
3586 (int)lines.size(), max_);
3587 return;
3588 }
3589 char* ptr;
3590 n_runs_ = strtol(lines[0].c_str(), &ptr, 10);
3591 average_max_ = strtol(ptr, nullptr, 10);
3592 if (n_runs_ <= 0 || average_max_ <= 0 || n_runs_ > STATS_MAX_N_RUNS ||
3593 average_max_ > STATS_MAX_AVERAGE) {
3594 MYLOGE("Invalid stats line on file %s: %s\n", path_.c_str(), lines[0].c_str());
3595 initial_max_ = Progress::kDefaultMax;
3596 } else {
3597 initial_max_ = average_max_;
3598 }
3599 max_ = initial_max_;
3600
3601 MYLOGI("Average max progress: %d in %d runs; estimated max: %d\n", average_max_, n_runs_, max_);
3602}
3603
3604void Progress::Save() {
3605 int32_t total = n_runs_ * average_max_ + progress_;
3606 int32_t runs = n_runs_ + 1;
3607 int32_t average = floor(((float)total) / runs);
3608 MYLOGI("Saving stats (total=%d, runs=%d, average=%d) on %s\n", total, runs, average,
3609 path_.c_str());
3610 if (path_.empty()) {
3611 return;
3612 }
3613
3614 std::string content = android::base::StringPrintf("%d %d\n", runs, average);
3615 if (!android::base::WriteStringToFile(content, path_)) {
3616 MYLOGE("Could not save stats on %s\n", path_.c_str());
3617 }
3618}
3619
3620int32_t Progress::Get() const {
3621 return progress_;
3622}
3623
3624bool Progress::Inc(int32_t delta_sec) {
3625 bool changed = false;
3626 if (delta_sec >= 0) {
3627 progress_ += delta_sec;
3628 if (progress_ > max_) {
3629 int32_t old_max = max_;
3630 max_ = floor((float)progress_ * growth_factor_);
3631 MYLOGD("Adjusting max progress from %d to %d\n", old_max, max_);
3632 changed = true;
3633 }
3634 }
3635 return changed;
3636}
3637
3638int32_t Progress::GetMax() const {
3639 return max_;
3640}
3641
3642int32_t Progress::GetInitialMax() const {
3643 return initial_max_;
3644}
3645
3646void Progress::Dump(int fd, const std::string& prefix) const {
3647 const char* pr = prefix.c_str();
3648 dprintf(fd, "%sprogress: %d\n", pr, progress_);
3649 dprintf(fd, "%smax: %d\n", pr, max_);
3650 dprintf(fd, "%sinitial_max: %d\n", pr, initial_max_);
3651 dprintf(fd, "%sgrowth_factor: %0.2f\n", pr, growth_factor_);
3652 dprintf(fd, "%spath: %s\n", pr, path_.c_str());
3653 dprintf(fd, "%sn_runs: %d\n", pr, n_runs_);
3654 dprintf(fd, "%saverage_max: %d\n", pr, average_max_);
3655}
3656
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003657std::string Dumpstate::GetPath(const std::string& suffix) const {
3658 return GetPath(bugreport_internal_dir_, suffix);
3659}
3660
3661std::string Dumpstate::GetPath(const std::string& directory, const std::string& suffix) const {
3662 return android::base::StringPrintf("%s/%s-%s%s", directory.c_str(), base_name_.c_str(),
3663 name_.c_str(), suffix.c_str());
3664}
3665
3666void Dumpstate::SetProgress(std::unique_ptr<Progress> progress) {
3667 progress_ = std::move(progress);
3668}
3669
3670void for_each_userid(void (*func)(int), const char *header) {
3671 std::string title = header == nullptr ? "for_each_userid" : android::base::StringPrintf(
3672 "for_each_userid(%s)", header);
3673 DurationReporter duration_reporter(title);
3674 if (PropertiesHelper::IsDryRun()) return;
3675
3676 DIR *d;
3677 struct dirent *de;
3678
3679 if (header) printf("\n------ %s ------\n", header);
3680 func(0);
3681
3682 if (!(d = opendir("/data/system/users"))) {
3683 printf("Failed to open /data/system/users (%s)\n", strerror(errno));
3684 return;
3685 }
3686
3687 while ((de = readdir(d))) {
3688 int userid;
3689 if (de->d_type != DT_DIR || !(userid = atoi(de->d_name))) {
3690 continue;
3691 }
3692 func(userid);
3693 }
3694
3695 closedir(d);
3696}
3697
3698static void __for_each_pid(void (*helper)(int, const char *, void *), const char *header, void *arg) {
3699 DIR *d;
3700 struct dirent *de;
3701
3702 if (!(d = opendir("/proc"))) {
3703 printf("Failed to open /proc (%s)\n", strerror(errno));
3704 return;
3705 }
3706
3707 if (header) printf("\n------ %s ------\n", header);
3708 while ((de = readdir(d))) {
3709 if (ds.IsUserConsentDenied()) {
3710 MYLOGE(
3711 "Returning early because user denied consent to share bugreport with calling app.");
3712 closedir(d);
3713 return;
3714 }
3715 int pid;
3716 int fd;
3717 char cmdpath[255];
3718 char cmdline[255];
3719
3720 if (!(pid = atoi(de->d_name))) {
3721 continue;
3722 }
3723
3724 memset(cmdline, 0, sizeof(cmdline));
3725
3726 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/cmdline", pid);
3727 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3728 TEMP_FAILURE_RETRY(read(fd, cmdline, sizeof(cmdline) - 2));
3729 close(fd);
3730 if (cmdline[0]) {
3731 helper(pid, cmdline, arg);
3732 continue;
3733 }
3734 }
3735
3736 // if no cmdline, a kernel thread has comm
3737 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/comm", pid);
3738 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3739 TEMP_FAILURE_RETRY(read(fd, cmdline + 1, sizeof(cmdline) - 4));
3740 close(fd);
3741 if (cmdline[1]) {
3742 cmdline[0] = '[';
3743 size_t len = strcspn(cmdline, "\f\b\r\n");
3744 cmdline[len] = ']';
3745 cmdline[len+1] = '\0';
3746 }
3747 }
3748 if (!cmdline[0]) {
3749 strcpy(cmdline, "N/A");
3750 }
3751 helper(pid, cmdline, arg);
3752 }
3753
3754 closedir(d);
3755}
3756
3757static void for_each_pid_helper(int pid, const char *cmdline, void *arg) {
3758 for_each_pid_func *func = (for_each_pid_func*) arg;
3759 func(pid, cmdline);
3760}
3761
3762void for_each_pid(for_each_pid_func func, const char *header) {
3763 std::string title = header == nullptr ? "for_each_pid"
3764 : android::base::StringPrintf("for_each_pid(%s)", header);
3765 DurationReporter duration_reporter(title);
3766 if (PropertiesHelper::IsDryRun()) return;
3767
3768 __for_each_pid(for_each_pid_helper, header, (void *) func);
3769}
3770
3771static void for_each_tid_helper(int pid, const char *cmdline, void *arg) {
3772 DIR *d;
3773 struct dirent *de;
3774 char taskpath[255];
3775 for_each_tid_func *func = (for_each_tid_func *) arg;
3776
3777 snprintf(taskpath, sizeof(taskpath), "/proc/%d/task", pid);
3778
3779 if (!(d = opendir(taskpath))) {
3780 printf("Failed to open %s (%s)\n", taskpath, strerror(errno));
3781 return;
3782 }
3783
3784 func(pid, pid, cmdline);
3785
3786 while ((de = readdir(d))) {
3787 if (ds.IsUserConsentDenied()) {
3788 MYLOGE(
3789 "Returning early because user denied consent to share bugreport with calling app.");
3790 closedir(d);
3791 return;
3792 }
3793 int tid;
3794 int fd;
3795 char commpath[255];
3796 char comm[255];
3797
3798 if (!(tid = atoi(de->d_name))) {
3799 continue;
3800 }
3801
3802 if (tid == pid)
3803 continue;
3804
3805 snprintf(commpath, sizeof(commpath), "/proc/%d/comm", tid);
3806 memset(comm, 0, sizeof(comm));
3807 if ((fd = TEMP_FAILURE_RETRY(open(commpath, O_RDONLY | O_CLOEXEC))) < 0) {
3808 strcpy(comm, "N/A");
3809 } else {
3810 char *c;
3811 TEMP_FAILURE_RETRY(read(fd, comm, sizeof(comm) - 2));
3812 close(fd);
3813
3814 c = strrchr(comm, '\n');
3815 if (c) {
3816 *c = '\0';
3817 }
3818 }
3819 func(pid, tid, comm);
3820 }
3821
3822 closedir(d);
3823}
3824
3825void for_each_tid(for_each_tid_func func, const char *header) {
3826 std::string title = header == nullptr ? "for_each_tid"
3827 : android::base::StringPrintf("for_each_tid(%s)", header);
3828 DurationReporter duration_reporter(title);
3829
3830 if (PropertiesHelper::IsDryRun()) return;
3831
3832 __for_each_pid(for_each_tid_helper, header, (void *) func);
3833}
3834
3835void show_wchan(int pid, int tid, const char *name) {
3836 if (PropertiesHelper::IsDryRun()) return;
3837
3838 char path[255];
3839 char buffer[255];
3840 int fd, ret, save_errno;
3841 char name_buffer[255];
3842
3843 memset(buffer, 0, sizeof(buffer));
3844
3845 snprintf(path, sizeof(path), "/proc/%d/wchan", tid);
3846 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3847 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3848 return;
3849 }
3850
3851 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3852 save_errno = errno;
3853 close(fd);
3854
3855 if (ret < 0) {
3856 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3857 return;
3858 }
3859
3860 snprintf(name_buffer, sizeof(name_buffer), "%*s%s",
3861 pid == tid ? 0 : 3, "", name);
3862
3863 printf("%-7d %-32s %s\n", tid, name_buffer, buffer);
3864
3865 return;
3866}
3867
3868// print time in centiseconds
3869static void snprcent(char *buffer, size_t len, size_t spc,
3870 unsigned long long time) {
3871 static long hz; // cache discovered hz
3872
3873 if (hz <= 0) {
3874 hz = sysconf(_SC_CLK_TCK);
3875 if (hz <= 0) {
3876 hz = 1000;
3877 }
3878 }
3879
3880 // convert to centiseconds
3881 time = (time * 100 + (hz / 2)) / hz;
3882
3883 char str[16];
3884
3885 snprintf(str, sizeof(str), " %llu.%02u",
3886 time / 100, (unsigned)(time % 100));
3887 size_t offset = strlen(buffer);
3888 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3889 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3890}
3891
3892// print permille as a percent
3893static void snprdec(char *buffer, size_t len, size_t spc, unsigned permille) {
3894 char str[16];
3895
3896 snprintf(str, sizeof(str), " %u.%u%%", permille / 10, permille % 10);
3897 size_t offset = strlen(buffer);
3898 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3899 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3900}
3901
3902void show_showtime(int pid, const char *name) {
3903 if (PropertiesHelper::IsDryRun()) return;
3904
3905 char path[255];
3906 char buffer[1023];
3907 int fd, ret, save_errno;
3908
3909 memset(buffer, 0, sizeof(buffer));
3910
3911 snprintf(path, sizeof(path), "/proc/%d/stat", pid);
3912 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3913 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3914 return;
3915 }
3916
3917 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3918 save_errno = errno;
3919 close(fd);
3920
3921 if (ret < 0) {
3922 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3923 return;
3924 }
3925
3926 // field 14 is utime
3927 // field 15 is stime
3928 // field 42 is iotime
3929 unsigned long long utime = 0, stime = 0, iotime = 0;
3930 if (sscanf(buffer,
3931 "%*u %*s %*s %*d %*d %*d %*d %*d %*d %*d %*d "
3932 "%*d %*d %llu %llu %*d %*d %*d %*d %*d %*d "
3933 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %*d "
3934 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %llu ",
3935 &utime, &stime, &iotime) != 3) {
3936 return;
3937 }
3938
3939 unsigned long long total = utime + stime;
3940 if (!total) {
3941 return;
3942 }
3943
3944 unsigned permille = (iotime * 1000 + (total / 2)) / total;
3945 if (permille > 1000) {
3946 permille = 1000;
3947 }
3948
3949 // try to beautify and stabilize columns at <80 characters
3950 snprintf(buffer, sizeof(buffer), "%-6d%s", pid, name);
3951 if ((name[0] != '[') || utime) {
3952 snprcent(buffer, sizeof(buffer), 57, utime);
3953 }
3954 snprcent(buffer, sizeof(buffer), 65, stime);
3955 if ((name[0] != '[') || iotime) {
3956 snprcent(buffer, sizeof(buffer), 73, iotime);
3957 }
3958 if (iotime) {
3959 snprdec(buffer, sizeof(buffer), 79, permille);
3960 }
3961 puts(buffer); // adds a trailing newline
3962
3963 return;
3964}
3965
3966void do_dmesg() {
3967 const char *title = "KERNEL LOG (dmesg)";
3968 DurationReporter duration_reporter(title);
3969 printf("------ %s ------\n", title);
3970
3971 if (PropertiesHelper::IsDryRun()) return;
3972
3973 /* Get size of kernel buffer */
3974 int size = klogctl(KLOG_SIZE_BUFFER, nullptr, 0);
3975 if (size <= 0) {
3976 printf("Unexpected klogctl return value: %d\n\n", size);
3977 return;
3978 }
3979 char *buf = (char *) malloc(size + 1);
3980 if (buf == nullptr) {
3981 printf("memory allocation failed\n\n");
3982 return;
3983 }
3984 int retval = klogctl(KLOG_READ_ALL, buf, size);
3985 if (retval < 0) {
3986 printf("klogctl failure\n\n");
3987 free(buf);
3988 return;
3989 }
3990 buf[retval] = '\0';
3991 printf("%s\n\n", buf);
3992 free(buf);
3993 return;
3994}
3995
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003996int Dumpstate::DumpFile(const std::string& title, const std::string& path) {
3997 DurationReporter duration_reporter(title);
3998
3999 int status = DumpFileToFd(STDOUT_FILENO, title, path);
4000
4001 UpdateProgress(WEIGHT_FILE);
4002
4003 return status;
4004}
4005
4006int read_file_as_long(const char *path, long int *output) {
4007 int fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC));
4008 if (fd < 0) {
4009 int err = errno;
4010 MYLOGE("Error opening file descriptor for %s: %s\n", path, strerror(err));
4011 return -1;
4012 }
4013 char buffer[50];
4014 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
4015 if (bytes_read == -1) {
4016 MYLOGE("Error reading file %s: %s\n", path, strerror(errno));
4017 return -2;
4018 }
4019 if (bytes_read == 0) {
4020 MYLOGE("File %s is empty\n", path);
4021 return -3;
4022 }
4023 *output = atoi(buffer);
4024 return 0;
4025}
4026
4027/* calls skip to gate calling dump_from_fd recursively
4028 * in the specified directory. dump_from_fd defaults to
4029 * dump_file_from_fd above when set to NULL. skip defaults
4030 * to false when set to NULL. dump_from_fd will always be
4031 * called with title NULL.
4032 */
4033int dump_files(const std::string& title, const char* dir, bool (*skip)(const char* path),
4034 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
4035 DurationReporter duration_reporter(title);
4036 DIR *dirp;
4037 struct dirent *d;
4038 char *newpath = nullptr;
4039 const char *slash = "/";
4040 int retval = 0;
4041
4042 if (!title.empty()) {
4043 printf("------ %s (%s) ------\n", title.c_str(), dir);
4044 }
4045 if (PropertiesHelper::IsDryRun()) return 0;
4046
4047 if (dir[strlen(dir) - 1] == '/') {
4048 ++slash;
4049 }
4050 dirp = opendir(dir);
4051 if (dirp == nullptr) {
4052 retval = -errno;
4053 MYLOGE("%s: %s\n", dir, strerror(errno));
4054 return retval;
4055 }
4056
4057 if (!dump_from_fd) {
4058 dump_from_fd = dump_file_from_fd;
4059 }
4060 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
4061 if ((d->d_name[0] == '.')
4062 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
4063 || (d->d_name[1] == '\0'))) {
4064 continue;
4065 }
4066 asprintf(&newpath, "%s%s%s%s", dir, slash, d->d_name,
4067 (d->d_type == DT_DIR) ? "/" : "");
4068 if (!newpath) {
4069 retval = -errno;
4070 continue;
4071 }
4072 if (skip && (*skip)(newpath)) {
4073 continue;
4074 }
4075 if (d->d_type == DT_DIR) {
4076 int ret = dump_files("", newpath, skip, dump_from_fd);
4077 if (ret < 0) {
4078 retval = ret;
4079 }
4080 continue;
4081 }
4082 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(newpath, O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
4083 if (fd.get() < 0) {
4084 retval = -1;
4085 printf("*** %s: %s\n", newpath, strerror(errno));
4086 continue;
4087 }
4088 (*dump_from_fd)(nullptr, newpath, fd.get());
4089 }
4090 closedir(dirp);
4091 if (!title.empty()) {
4092 printf("\n");
4093 }
4094 return retval;
4095}
4096
4097/* fd must have been opened with the flag O_NONBLOCK. With this flag set,
4098 * it's possible to avoid issues where opening the file itself can get
4099 * stuck.
4100 */
4101int dump_file_from_fd(const char *title, const char *path, int fd) {
4102 if (PropertiesHelper::IsDryRun()) return 0;
4103
4104 int flags = fcntl(fd, F_GETFL);
4105 if (flags == -1) {
4106 printf("*** %s: failed to get flags on fd %d: %s\n", path, fd, strerror(errno));
4107 return -1;
4108 } else if (!(flags & O_NONBLOCK)) {
4109 printf("*** %s: fd must have O_NONBLOCK set.\n", path);
4110 return -1;
4111 }
4112 return DumpFileFromFdToFd(title, path, fd, STDOUT_FILENO, PropertiesHelper::IsDryRun());
4113}
4114
4115int Dumpstate::RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08004116 const CommandOptions& options, bool verbose_duration, int out_fd) {
4117 DurationReporter duration_reporter(title, false /* logcat_only */,
4118 verbose_duration, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004119
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08004120 int status = RunCommandToFd(out_fd, title, full_command, options);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004121
4122 /* TODO: for now we're simplifying the progress calculation by using the
4123 * timeout as the weight. It's a good approximation for most cases, except when calling dumpsys,
4124 * where its weight should be much higher proportionally to its timeout.
4125 * Ideally, it should use a options.EstimatedDuration() instead...*/
4126 UpdateProgress(options.Timeout());
4127
4128 return status;
4129}
4130
4131void Dumpstate::RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsys_args,
Rhed Jaoe017f982020-07-21 17:58:41 +08004132 const CommandOptions& options, long dumpsysTimeoutMs, int out_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004133 long timeout_ms = dumpsysTimeoutMs > 0 ? dumpsysTimeoutMs : options.TimeoutInMs();
4134 std::vector<std::string> dumpsys = {"/system/bin/dumpsys", "-T", std::to_string(timeout_ms)};
4135 dumpsys.insert(dumpsys.end(), dumpsys_args.begin(), dumpsys_args.end());
Rhed Jaoe017f982020-07-21 17:58:41 +08004136 RunCommand(title, dumpsys, options, false, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004137}
4138
Dieter Hsu105ad0c2020-09-29 15:23:33 +08004139static int open_socket(const char* service) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004140 int s = android_get_control_socket(service);
4141 if (s < 0) {
4142 MYLOGE("android_get_control_socket(%s): %s\n", service, strerror(errno));
4143 return -1;
4144 }
4145 fcntl(s, F_SETFD, FD_CLOEXEC);
4146
4147 // Set backlog to 0 to make sure that queue size will be minimum.
4148 // In Linux, because the minimum queue will be 1, connect() will be blocked
4149 // if the other clients already called connect() and the connection request was not accepted.
4150 if (listen(s, 0) < 0) {
4151 MYLOGE("listen(control socket): %s\n", strerror(errno));
4152 return -1;
4153 }
4154
4155 struct sockaddr addr;
4156 socklen_t alen = sizeof(addr);
Abhijeet Kaur2113cae2019-09-13 09:24:15 +01004157 int fd = accept4(s, &addr, &alen, SOCK_CLOEXEC);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004158
4159 // Close socket just after accept(), to make sure that connect() by client will get error
4160 // when the socket is used by the other services.
4161 // There is still a race condition possibility between accept and close, but there is no way
4162 // to close-on-accept atomically.
4163 // See detail; b/123306389#comment25
4164 close(s);
4165
4166 if (fd < 0) {
4167 MYLOGE("accept(control socket): %s\n", strerror(errno));
4168 return -1;
4169 }
4170
4171 return fd;
4172}
4173
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004174// TODO: should call is_valid_output_file and/or be merged into it.
4175void create_parent_dirs(const char *path) {
4176 char *chp = const_cast<char *> (path);
4177
4178 /* skip initial slash */
4179 if (chp[0] == '/')
4180 chp++;
4181
4182 /* create leading directories, if necessary */
4183 struct stat dir_stat;
4184 while (chp && chp[0]) {
4185 chp = strchr(chp, '/');
4186 if (chp) {
4187 *chp = 0;
4188 if (stat(path, &dir_stat) == -1 || !S_ISDIR(dir_stat.st_mode)) {
4189 MYLOGI("Creating directory %s\n", path);
4190 if (mkdir(path, 0770)) { /* drwxrwx--- */
4191 MYLOGE("Unable to create directory %s: %s\n", path, strerror(errno));
4192 } else if (chown(path, AID_SHELL, AID_SHELL)) {
4193 MYLOGE("Unable to change ownership of dir %s: %s\n", path, strerror(errno));
4194 }
4195 }
4196 *chp++ = '/';
4197 }
4198 }
4199}
4200
4201bool _redirect_to_file(FILE* redirect, char* path, int truncate_flag) {
4202 create_parent_dirs(path);
4203
4204 int fd = TEMP_FAILURE_RETRY(open(path,
4205 O_WRONLY | O_CREAT | truncate_flag | O_CLOEXEC | O_NOFOLLOW,
4206 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH));
4207 if (fd < 0) {
4208 MYLOGE("%s: %s\n", path, strerror(errno));
4209 return false;
4210 }
4211
4212 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
4213 close(fd);
4214 return true;
4215}
4216
4217bool redirect_to_file(FILE* redirect, char* path) {
4218 return _redirect_to_file(redirect, path, O_TRUNC);
4219}
4220
4221bool redirect_to_existing_file(FILE* redirect, char* path) {
4222 return _redirect_to_file(redirect, path, O_APPEND);
4223}
4224
4225void dump_route_tables() {
4226 DurationReporter duration_reporter("DUMP ROUTE TABLES");
4227 if (PropertiesHelper::IsDryRun()) return;
4228 const char* const RT_TABLES_PATH = "/data/misc/net/rt_tables";
4229 ds.DumpFile("RT_TABLES", RT_TABLES_PATH);
4230 FILE* fp = fopen(RT_TABLES_PATH, "re");
4231 if (!fp) {
4232 printf("*** %s: %s\n", RT_TABLES_PATH, strerror(errno));
4233 return;
4234 }
4235 char table[16];
4236 // Each line has an integer (the table number), a space, and a string (the table name). We only
4237 // need the table number. It's a 32-bit unsigned number, so max 10 chars. Skip the table name.
4238 // Add a fixed max limit so this doesn't go awry.
4239 for (int i = 0; i < 64 && fscanf(fp, " %10s %*s", table) == 1; ++i) {
4240 RunCommand("ROUTE TABLE IPv4", {"ip", "-4", "route", "show", "table", table});
4241 RunCommand("ROUTE TABLE IPv6", {"ip", "-6", "route", "show", "table", table});
4242 }
4243 fclose(fp);
4244}
4245
Li Li830179f2022-01-04 12:53:29 -08004246void dump_frozen_cgroupfs(const char *dir, int level,
4247 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
4248 DIR *dirp;
4249 struct dirent *d;
4250 char *newpath = nullptr;
4251
4252 dirp = opendir(dir);
4253 if (dirp == nullptr) {
4254 MYLOGE("%s: %s\n", dir, strerror(errno));
4255 return;
4256 }
4257
4258 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
4259 if ((d->d_name[0] == '.')
4260 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
4261 || (d->d_name[1] == '\0'))) {
4262 continue;
4263 }
4264 if (d->d_type == DT_DIR) {
4265 asprintf(&newpath, "%s/%s/", dir, d->d_name);
4266 if (!newpath) {
4267 continue;
4268 }
4269 if (level == 0 && !strncmp(d->d_name, "uid_", 4)) {
4270 dump_frozen_cgroupfs(newpath, 1, dump_from_fd);
4271 } else if (level == 1 && !strncmp(d->d_name, "pid_", 4)) {
4272 char *freezer = nullptr;
4273 asprintf(&freezer, "%s/%s", newpath, "cgroup.freeze");
4274 if (freezer) {
4275 FILE* fp = fopen(freezer, "r");
4276 if (fp != NULL) {
4277 int frozen;
4278 fscanf(fp, "%d", &frozen);
4279 if (frozen > 0) {
4280 dump_files("", newpath, skip_none, dump_from_fd);
4281 }
4282 fclose(fp);
4283 }
4284 free(freezer);
4285 }
4286 }
4287 }
4288 }
4289 closedir(dirp);
4290}
4291
4292void dump_frozen_cgroupfs() {
Li Li830179f2022-01-04 12:53:29 -08004293 MYLOGD("Adding frozen processes from %s\n", CGROUPFS_DIR);
4294 DurationReporter duration_reporter("FROZEN CGROUPFS");
4295 if (PropertiesHelper::IsDryRun()) return;
4296 dump_frozen_cgroupfs(CGROUPFS_DIR, 0, _add_file_from_fd);
4297}
4298
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004299void Dumpstate::UpdateProgress(int32_t delta_sec) {
4300 if (progress_ == nullptr) {
4301 MYLOGE("UpdateProgress: progress_ not set\n");
4302 return;
4303 }
Rhed Jaobf63d8a2020-07-21 15:42:55 +08004304 // This function updates progress related members of the dumpstate and reports
4305 // progress percentage to the bugreport client. Since it could be called by
4306 // different dump tasks at the same time if the parallel run is enabled, a
4307 // mutex lock is necessary here to synchronize the call.
4308 std::lock_guard<std::recursive_mutex> lock(mutex_);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004309
4310 // Always update progess so stats can be tuned...
Nandana Dutt402a8392019-06-14 14:25:13 +01004311 progress_->Inc(delta_sec);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004312
4313 // ...but only notifiy listeners when necessary.
4314 if (!options_->do_progress_updates) return;
4315
4316 int progress = progress_->Get();
4317 int max = progress_->GetMax();
Nandana Dutt402a8392019-06-14 14:25:13 +01004318 int percent = 100 * progress / max;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004319
Nandana Dutt402a8392019-06-14 14:25:13 +01004320 if (last_reported_percent_progress_ > 0 && percent <= last_reported_percent_progress_) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004321 return;
4322 }
Nandana Dutt402a8392019-06-14 14:25:13 +01004323 last_reported_percent_progress_ = percent;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004324
4325 if (control_socket_fd_ >= 0) {
4326 dprintf(control_socket_fd_, "PROGRESS:%d/%d\n", progress, max);
4327 fsync(control_socket_fd_);
4328 }
4329
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004330 if (listener_ != nullptr) {
Nandana Dutt235c6672019-11-14 15:22:32 +00004331 if (percent % 10 == 0) {
4332 // We don't want to spam logcat, so only log multiples of 10.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004333 MYLOGD("Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004334 } else {
4335 // stderr is ignored on normal invocations, but useful when calling
4336 // /system/bin/dumpstate directly for debuggging.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004337 fprintf(stderr, "Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004338 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004339
4340 listener_->onProgress(percent);
4341 }
4342}
4343
4344void Dumpstate::TakeScreenshot(const std::string& path) {
4345 const std::string& real_path = path.empty() ? screenshot_path_ : path;
4346 int status =
4347 RunCommand("", {"/system/bin/screencap", "-p", real_path},
4348 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
4349 if (status == 0) {
4350 MYLOGD("Screenshot saved on %s\n", real_path.c_str());
4351 } else {
4352 MYLOGE("Failed to take screenshot on %s\n", real_path.c_str());
4353 }
Paul Chang0d2aad72020-02-13 20:04:03 +08004354 if (listener_ != nullptr) {
4355 // Show a visual indication to indicate screenshot is taken via
4356 // IDumpstateListener.onScreenshotTaken()
4357 listener_->onScreenshotTaken(status == 0);
4358 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004359}
4360
4361bool is_dir(const char* pathname) {
4362 struct stat info;
4363 if (stat(pathname, &info) == -1) {
4364 return false;
4365 }
4366 return S_ISDIR(info.st_mode);
4367}
4368
4369time_t get_mtime(int fd, time_t default_mtime) {
4370 struct stat info;
4371 if (fstat(fd, &info) == -1) {
4372 return default_mtime;
4373 }
4374 return info.st_mtime;
4375}