blob: 616304c621cc65489c7f2b8b8b5f449e052eb41b [file] [log] [blame]
Colin Crossf45fa6b2012-03-26 12:38:26 -07001/*
2 * Copyright (C) 2008 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
Felipe Lemef0292972016-11-22 13:57:05 -080016
Mark Salyzyn6c3d90f2016-09-27 14:55:27 -070017#define LOG_TAG "dumpstate"
Colin Crossf45fa6b2012-03-26 12:38:26 -070018
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -070019#include <dirent.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070020#include <errno.h>
21#include <fcntl.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010022#include <inttypes.h>
Felipe Lemead5f6c42015-11-30 14:26:46 -080023#include <libgen.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070024#include <limits.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010025#include <math.h>
26#include <poll.h>
Mark Salyzyn8f37aa52015-06-12 12:28:24 -070027#include <stdbool.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070028#include <stdio.h>
29#include <stdlib.h>
30#include <string.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080031#include <sys/poll.h>
Christopher Ferris7dc7f322014-07-22 16:08:19 -070032#include <sys/prctl.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070033#include <sys/resource.h>
34#include <sys/stat.h>
35#include <sys/time.h>
36#include <sys/wait.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010037#include <signal.h>
38#include <stdarg.h>
39#include <string.h>
40#include <sys/capability.h>
41#include <sys/inotify.h>
42#include <sys/klog.h>
43#include <time.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070044#include <unistd.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070045
46#include <chrono>
Hridya Valsarajuac582cd2019-08-05 15:39:54 -070047#include <cmath>
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +000048#include <fstream>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070049#include <functional>
50#include <future>
Narayan Kamath8f788292017-05-25 13:20:39 +010051#include <memory>
Hridya Valsarajuac582cd2019-08-05 15:39:54 -070052#include <numeric>
Narayan Kamath8f788292017-05-25 13:20:39 +010053#include <regex>
54#include <set>
55#include <string>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070056#include <utility>
Narayan Kamath8f788292017-05-25 13:20:39 +010057#include <vector>
Colin Crossf45fa6b2012-03-26 12:38:26 -070058
Felipe Leme96c2bbb2016-09-26 09:21:21 -070059#include <android-base/file.h>
60#include <android-base/properties.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070061#include <android-base/scopeguard.h>
Elliott Hughes9dc117c2015-12-07 14:21:50 -080062#include <android-base/stringprintf.h>
Naveen Kalla058e1e82016-10-19 21:38:44 -070063#include <android-base/strings.h>
Andreas Gampeaff68432016-07-18 18:01:27 -070064#include <android-base/unique_fd.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010065#include <android/content/pm/IPackageManagerNative.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080066#include <android/hardware/dumpstate/1.0/IDumpstateDevice.h>
Hunter Knepshield8540faf2020-02-04 19:47:20 -080067#include <android/hardware/dumpstate/1.1/IDumpstateDevice.h>
68#include <android/hardware/dumpstate/1.1/types.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080069#include <android/hidl/manager/1.0/IServiceManager.h>
Nandana Duttd2f5f082019-01-18 17:13:52 +000070#include <android/os/IIncidentCompanion.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010071#include <binder/IServiceManager.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080072#include <cutils/native_handle.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070073#include <cutils/properties.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010074#include <cutils/sockets.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000075#include <debuggerd/client.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080076#include <dumpsys.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000077#include <dumputils/dump_utils.h>
Sahana Raof35ed432019-07-12 10:47:52 +010078#include <hardware_legacy/power.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080079#include <hidl/ServiceManagement.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010080#include <log/log.h>
Tom Cherryf4472f32020-08-05 09:31:17 -070081#include <log/log_read.h>
Felipe Leme75876a22016-10-27 16:31:27 -070082#include <openssl/sha.h>
Mark Salyzyn6c3d90f2016-09-27 14:55:27 -070083#include <private/android_filesystem_config.h>
84#include <private/android_logger.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080085#include <serviceutils/PriorityDumper.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070086#include <utils/StrongPointer.h>
Felipe Lemef0292972016-11-22 13:57:05 -080087#include "DumpstateInternal.h"
Felipe Leme75876a22016-10-27 16:31:27 -070088#include "DumpstateService.h"
Colin Crossf45fa6b2012-03-26 12:38:26 -070089#include "dumpstate.h"
Felipe Leme6e01fa62015-11-11 19:35:14 -080090
Hunter Knepshield8540faf2020-02-04 19:47:20 -080091using IDumpstateDevice_1_0 = ::android::hardware::dumpstate::V1_0::IDumpstateDevice;
92using IDumpstateDevice_1_1 = ::android::hardware::dumpstate::V1_1::IDumpstateDevice;
93using ::android::hardware::dumpstate::V1_1::DumpstateMode;
94using ::android::hardware::dumpstate::V1_1::DumpstateStatus;
95using ::android::hardware::dumpstate::V1_1::toString;
Vishnu Naire97d6122018-01-18 13:58:56 -080096using ::std::literals::chrono_literals::operator""ms;
97using ::std::literals::chrono_literals::operator""s;
Rhed Jao1c855122020-07-16 17:37:39 +080098using ::std::placeholders::_1;
Steven Morelandcb7ef822016-11-29 13:20:37 -080099
Felipe Leme47e9be22016-12-21 15:37:07 -0800100// TODO: remove once moved to namespace
Vishnu Naire97d6122018-01-18 13:58:56 -0800101using android::defaultServiceManager;
102using android::Dumpsys;
103using android::INVALID_OPERATION;
104using android::IServiceManager;
105using android::OK;
106using android::sp;
107using android::status_t;
108using android::String16;
109using android::String8;
110using android::TIMED_OUT;
111using android::UNKNOWN_ERROR;
112using android::Vector;
Nandana Dutt979388e2018-11-30 16:48:55 +0000113using android::base::StringPrintf;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000114using android::os::IDumpstateListener;
Felipe Leme47e9be22016-12-21 15:37:07 -0800115using android::os::dumpstate::CommandOptions;
116using android::os::dumpstate::DumpFileToFd;
Rhed Jao1c855122020-07-16 17:37:39 +0800117using android::os::dumpstate::DumpPool;
Vishnu Naire97d6122018-01-18 13:58:56 -0800118using android::os::dumpstate::PropertiesHelper;
Rhed Jao4875aa62020-07-20 17:46:29 +0800119using android::os::dumpstate::TaskQueue;
Felipe Leme47e9be22016-12-21 15:37:07 -0800120
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100121// Keep in sync with
122// frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
123static const int TRACE_DUMP_TIMEOUT_MS = 10000; // 10 seconds
124
125/* Most simple commands have 10 as timeout, so 5 is a good estimate */
126static const int32_t WEIGHT_FILE = 5;
127
128// TODO: temporary variables and functions used during C++ refactoring
129static Dumpstate& ds = Dumpstate::GetInstance();
130static int RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Nandana Dutt8d945c02019-08-14 13:30:07 +0100131 const CommandOptions& options = CommandOptions::DEFAULT,
Rhed Jao4875aa62020-07-20 17:46:29 +0800132 bool verbose_duration = false, int out_fd = STDOUT_FILENO) {
133 return ds.RunCommand(title, full_command, options, verbose_duration, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100134}
135
136// Reasonable value for max stats.
137static const int STATS_MAX_N_RUNS = 1000;
138static const long STATS_MAX_AVERAGE = 100000;
139
140CommandOptions Dumpstate::DEFAULT_DUMPSYS = CommandOptions::WithTimeout(30).Build();
141
Nandana Duttd2f5f082019-01-18 17:13:52 +0000142typedef Dumpstate::ConsentCallback::ConsentResult UserConsentResult;
143
Colin Crossf45fa6b2012-03-26 12:38:26 -0700144/* read before root is shed */
145static char cmdline_buf[16384] = "(unknown)";
Yi Kong19d5c002018-07-20 13:39:55 -0700146static const char *dump_traces_path = nullptr;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000147static const uint64_t USER_CONSENT_TIMEOUT_MS = 30 * 1000;
Hunter Knepshield70610fa2020-01-03 15:27:33 -0800148// Because telephony reports are significantly faster to collect (< 10 seconds vs. > 2 minutes),
149// it's often the case that they time out far too quickly for consent with such a hefty dialog for
150// the user to read. For telephony reports only, we increase the default timeout to 2 minutes to
151// roughly match full reports' durations.
152static const uint64_t TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS = 2 * 60 * 1000;
Colin Crossf45fa6b2012-03-26 12:38:26 -0700153
Felipe Leme1d486fe2016-10-14 18:06:47 -0700154// TODO: variables and functions below should be part of dumpstate object
155
Felipe Leme635ca312016-01-05 14:23:02 -0800156static std::set<std::string> mount_points;
157void add_mountinfo();
Felipe Leme78f2c862015-12-21 09:55:22 -0800158
Todd Poynor2a83daa2013-11-22 15:44:22 -0800159#define PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops"
Mark Salyzyn7d0a7622016-06-24 14:06:15 -0700160#define ALT_PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops-0"
Wei Wang509bb5d2017-06-09 14:42:12 -0700161#define BLK_DEV_SYS_DIR "/sys/block"
Todd Poynor2a83daa2013-11-22 15:44:22 -0800162
Felipe Lemee82a27d2016-01-05 13:35:44 -0800163#define RECOVERY_DIR "/cache/recovery"
Mark Salyzynd6ab0112016-03-25 12:56:39 -0700164#define RECOVERY_DATA_DIR "/data/misc/recovery"
Tianjie Xu75d53362018-04-11 16:42:28 -0700165#define UPDATE_ENGINE_LOG_DIR "/data/misc/update_engine_log"
Mark Salyzyn4d42dea2016-04-01 10:03:14 -0700166#define LOGPERSIST_DATA_DIR "/data/misc/logd"
Jerry Changa1df8a92020-01-02 16:03:39 +0800167#define PREREBOOT_DATA_DIR "/data/misc/prereboot"
David Brazdild2991962016-06-03 14:40:44 +0100168#define PROFILE_DATA_DIR_CUR "/data/misc/profiles/cur"
169#define PROFILE_DATA_DIR_REF "/data/misc/profiles/ref"
Benedict Wong8f9d8a42019-01-03 16:19:38 -0800170#define XFRM_STAT_PROC_FILE "/proc/net/xfrm_stat"
Erik Kline08165202016-05-30 11:55:44 +0900171#define WLUTIL "/vendor/xbin/wlutil"
Vishnu Nair36b4cdb2017-11-17 10:27:05 -0800172#define WMTRACE_DATA_DIR "/data/misc/wmtrace"
Yifan Hong3945e1b2019-10-29 12:59:23 -0700173#define OTA_METADATA_DIR "/metadata/ota"
Yifan Hong0efa7972020-02-03 16:45:02 -0800174#define SNAPSHOTCTL_LOG_DIR "/data/misc/snapshotctl_log"
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +0900175#define LINKERCONFIG_DIR "/linkerconfig"
Calin Juravle78a0d842020-04-28 15:31:12 -0700176#define PACKAGE_DEX_USE_LIST "/data/system/package-dex-usage.list"
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700177
Narayan Kamath8f788292017-05-25 13:20:39 +0100178// TODO(narayan): Since this information has to be kept in sync
179// with tombstoned, we should just put it in a common header.
180//
181// File: system/core/debuggerd/tombstoned/tombstoned.cpp
Narayan Kamathbd863722017-06-01 18:50:12 +0100182static const std::string TOMBSTONE_DIR = "/data/tombstones/";
183static const std::string TOMBSTONE_FILE_PREFIX = "tombstone_";
184static const std::string ANR_DIR = "/data/anr/";
185static const std::string ANR_FILE_PREFIX = "anr_";
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700186
Felipe Lemee844a9d2016-09-21 15:01:39 -0700187// TODO: temporary variables and functions used during C++ refactoring
Nandana Dutt979388e2018-11-30 16:48:55 +0000188
Nandana Dutt5c390032019-03-12 10:52:56 +0000189#define RETURN_IF_USER_DENIED_CONSENT() \
190 if (ds.IsUserConsentDenied()) { \
191 MYLOGE("Returning early as user denied consent to share bugreport with calling app."); \
192 return Dumpstate::RunStatus::USER_CONSENT_DENIED; \
193 }
194
195// Runs func_ptr, but checks user consent before and after running it. Returns USER_CONSENT_DENIED
196// if consent is found to be denied.
197#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(func_ptr, ...) \
198 RETURN_IF_USER_DENIED_CONSENT(); \
199 func_ptr(__VA_ARGS__); \
200 RETURN_IF_USER_DENIED_CONSENT();
201
Rhed Jao1c855122020-07-16 17:37:39 +0800202// Runs func_ptr, and logs a duration report after it's finished.
203#define RUN_SLOW_FUNCTION_AND_LOG(log_title, func_ptr, ...) \
204 { \
205 DurationReporter duration_reporter_in_macro(log_title); \
206 func_ptr(__VA_ARGS__); \
207 }
208
209// Similar with RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK, an additional duration report
210// is output after a slow function is finished.
211#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(log_title, func_ptr, ...) \
212 RETURN_IF_USER_DENIED_CONSENT(); \
213 RUN_SLOW_FUNCTION_AND_LOG(log_title, func_ptr, __VA_ARGS__); \
214 RETURN_IF_USER_DENIED_CONSENT();
215
Rhed Jao4875aa62020-07-20 17:46:29 +0800216#define WAIT_TASK_WITH_CONSENT_CHECK(task_name, pool_ptr) \
217 RETURN_IF_USER_DENIED_CONSENT(); \
218 pool_ptr->waitForTask(task_name); \
219 RETURN_IF_USER_DENIED_CONSENT();
220
Sahana Raof35ed432019-07-12 10:47:52 +0100221static const char* WAKE_LOCK_NAME = "dumpstate_wakelock";
222
Rhed Jao1c855122020-07-16 17:37:39 +0800223// Names of parallel tasks, they are used for the DumpPool to identify the dump
224// task and the log title of the duration report.
225static const std::string DUMP_TRACES_TASK = "DUMP TRACES";
Rhed Jao4875aa62020-07-20 17:46:29 +0800226static const std::string DUMP_INCIDENT_REPORT_TASK = "INCIDENT REPORT";
227static const std::string DUMP_HALS_TASK = "DUMP HALS";
228static const std::string DUMP_BOARD_TASK = "dumpstate_board()";
Rhed Jao6b1ea2d2020-07-21 17:58:41 +0800229static const std::string DUMP_CHECKINS_TASK = "DUMP CHECKINS";
230static const std::string DUMP_APP_INFOS_TASK = "DUMP APP INFOS";
Rhed Jao1c855122020-07-16 17:37:39 +0800231
Nandana Dutt979388e2018-11-30 16:48:55 +0000232namespace android {
233namespace os {
234namespace {
235
236static int Open(std::string path, int flags, mode_t mode = 0) {
237 int fd = TEMP_FAILURE_RETRY(open(path.c_str(), flags, mode));
238 if (fd == -1) {
239 MYLOGE("open(%s, %s)\n", path.c_str(), strerror(errno));
240 }
241 return fd;
242}
243
mhasank2d75c442020-06-11 15:05:25 -0700244static int OpenForWrite(std::string path) {
245 return Open(path, O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
246 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH);
247}
Nandana Dutt979388e2018-11-30 16:48:55 +0000248
249static int OpenForRead(std::string path) {
250 return Open(path, O_RDONLY | O_CLOEXEC | O_NOFOLLOW);
251}
252
253bool CopyFile(int in_fd, int out_fd) {
254 char buf[4096];
255 ssize_t byte_count;
256 while ((byte_count = TEMP_FAILURE_RETRY(read(in_fd, buf, sizeof(buf)))) > 0) {
257 if (!android::base::WriteFully(out_fd, buf, byte_count)) {
258 return false;
259 }
260 }
261 return (byte_count != -1);
262}
263
264static bool CopyFileToFd(const std::string& input_file, int out_fd) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000265 MYLOGD("Going to copy file (%s) to %d\n", input_file.c_str(), out_fd);
Nandana Dutt979388e2018-11-30 16:48:55 +0000266
267 // Obtain a handle to the source file.
268 android::base::unique_fd in_fd(OpenForRead(input_file));
269 if (out_fd != -1 && in_fd.get() != -1) {
270 if (CopyFile(in_fd.get(), out_fd)) {
271 return true;
272 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000273 MYLOGE("Failed to copy file: %s\n", strerror(errno));
Nandana Dutt979388e2018-11-30 16:48:55 +0000274 }
275 return false;
276}
277
Nandana Duttd2f5f082019-01-18 17:13:52 +0000278static bool UnlinkAndLogOnError(const std::string& file) {
Nandana Dutt8ae16e62020-03-27 10:20:22 +0000279 if (file.empty()) {
280 return false;
281 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000282 if (unlink(file.c_str())) {
283 MYLOGE("Failed to unlink file (%s): %s\n", file.c_str(), strerror(errno));
Nandana Duttd2f5f082019-01-18 17:13:52 +0000284 return false;
285 }
286 return true;
287}
Nandana Dutt979388e2018-11-30 16:48:55 +0000288
Nikita Ioffea325a572019-05-16 19:49:47 +0100289int64_t GetModuleMetadataVersion() {
290 auto binder = defaultServiceManager()->getService(android::String16("package_native"));
291 if (binder == nullptr) {
292 MYLOGE("Failed to retrieve package_native service");
293 return 0L;
294 }
295 auto package_service = android::interface_cast<content::pm::IPackageManagerNative>(binder);
296 std::string package_name;
297 auto status = package_service->getModuleMetadataPackageName(&package_name);
298 if (!status.isOk()) {
299 MYLOGE("Failed to retrieve module metadata package name: %s", status.toString8().c_str());
300 return 0L;
301 }
Nandana Duttdb379fa2019-10-09 16:54:41 +0100302 MYLOGD("Module metadata package name: %s\n", package_name.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100303 int64_t version_code;
304 status = package_service->getVersionCodeForPackage(android::String16(package_name.c_str()),
305 &version_code);
306 if (!status.isOk()) {
307 MYLOGE("Failed to retrieve module metadata version: %s", status.toString8().c_str());
308 return 0L;
309 }
310 return version_code;
311}
312
mhasank2d75c442020-06-11 15:05:25 -0700313static bool PathExists(const std::string& path) {
314 struct stat sb;
315 return stat(path.c_str(), &sb) == 0;
316}
317
318static bool CopyFileToFile(const std::string& input_file, const std::string& output_file) {
319 if (input_file == output_file) {
320 MYLOGD("Skipping copying bugreport file since the destination is the same (%s)\n",
321 output_file.c_str());
322 return false;
323 }
324 else if (PathExists(output_file)) {
325 MYLOGD("Cannot overwrite an existing file (%s)\n", output_file.c_str());
326 return false;
327 }
328
329 MYLOGD("Going to copy bugreport file (%s) to %s\n", input_file.c_str(), output_file.c_str());
330 android::base::unique_fd out_fd(OpenForWrite(output_file));
331 return CopyFileToFd(input_file, out_fd.get());
332}
333
Nandana Dutt979388e2018-11-30 16:48:55 +0000334} // namespace
335} // namespace os
336} // namespace android
337
Felipe Leme678727a2016-09-21 17:22:11 -0700338static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
Felipe Lemebda15a02016-11-16 17:48:25 -0800339 const CommandOptions& options = Dumpstate::DEFAULT_DUMPSYS,
Rhed Jao6b1ea2d2020-07-21 17:58:41 +0800340 long dumpsysTimeoutMs = 0, int out_fd = STDOUT_FILENO) {
341 return ds.RunDumpsys(title, dumpsysArgs, options, dumpsysTimeoutMs, out_fd);
342}
343static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
344 int out_fd) {
345 return ds.RunDumpsys(title, dumpsysArgs, Dumpstate::DEFAULT_DUMPSYS, 0, out_fd);
Felipe Leme678727a2016-09-21 17:22:11 -0700346}
347static int DumpFile(const std::string& title, const std::string& path) {
348 return ds.DumpFile(title, path);
349}
Felipe Lemee82a27d2016-01-05 13:35:44 -0800350
Felipe Lemee844a9d2016-09-21 15:01:39 -0700351// Relative directory (inside the zip) for all files copied as-is into the bugreport.
352static const std::string ZIP_ROOT_DIR = "FS";
353
Vishnu Naire97d6122018-01-18 13:58:56 -0800354static const std::string kProtoPath = "proto/";
355static const std::string kProtoExt = ".proto";
Jie Song9fbfad02017-06-20 16:29:42 -0700356static const std::string kDumpstateBoardFiles[] = {
357 "dumpstate_board.txt",
Felipe Leme95d6ca52017-08-01 16:35:56 -0700358 "dumpstate_board.bin"
Jie Song9fbfad02017-06-20 16:29:42 -0700359};
360static const int NUM_OF_DUMPS = arraysize(kDumpstateBoardFiles);
361
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700362static constexpr char PROPERTY_LAST_ID[] = "dumpstate.last_id";
Felipe Lemed071c682016-10-20 16:48:00 -0700363static constexpr char PROPERTY_VERSION[] = "dumpstate.version";
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700364
Felipe Lemef0292972016-11-22 13:57:05 -0800365static const CommandOptions AS_ROOT_20 = CommandOptions::WithTimeout(20).AsRoot().Build();
366
Narayan Kamath8f788292017-05-25 13:20:39 +0100367/*
Narayan Kamathbd863722017-06-01 18:50:12 +0100368 * Returns a vector of dump fds under |dir_path| with a given |file_prefix|.
Rhed Jao01dc0c62020-06-03 17:13:30 +0800369 * The returned vector is sorted by the mtimes of the dumps with descending
370 * order. If |limit_by_mtime| is set, the vector only contains files that
371 * were written in the last 30 minutes.
Narayan Kamath8f788292017-05-25 13:20:39 +0100372 */
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700373static std::vector<DumpData> GetDumpFds(const std::string& dir_path,
374 const std::string& file_prefix,
Elliott Hughesdb6d2112019-09-26 15:24:51 -0700375 bool limit_by_mtime) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100376 const time_t thirty_minutes_ago = ds.now_ - 60 * 30;
377
Narayan Kamathbd863722017-06-01 18:50:12 +0100378 std::unique_ptr<DIR, decltype(&closedir)> dump_dir(opendir(dir_path.c_str()), closedir);
Narayan Kamath8f788292017-05-25 13:20:39 +0100379
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700380 if (dump_dir == nullptr) {
381 MYLOGW("Unable to open directory %s: %s\n", dir_path.c_str(), strerror(errno));
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700382 return std::vector<DumpData>();
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700383 }
384
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700385 std::vector<DumpData> dump_data;
Narayan Kamathbd863722017-06-01 18:50:12 +0100386 struct dirent* entry = nullptr;
387 while ((entry = readdir(dump_dir.get()))) {
388 if (entry->d_type != DT_REG) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100389 continue;
390 }
391
Narayan Kamathbd863722017-06-01 18:50:12 +0100392 const std::string base_name(entry->d_name);
393 if (base_name.find(file_prefix) != 0) {
394 continue;
395 }
396
397 const std::string abs_path = dir_path + base_name;
398 android::base::unique_fd fd(
399 TEMP_FAILURE_RETRY(open(abs_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW | O_NONBLOCK)));
400 if (fd == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700401 MYLOGW("Unable to open dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamathbd863722017-06-01 18:50:12 +0100402 break;
403 }
404
405 struct stat st = {};
406 if (fstat(fd, &st) == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700407 MYLOGW("Unable to stat dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamath8f788292017-05-25 13:20:39 +0100408 continue;
409 }
410
Narayan Kamath3f31b632018-02-22 19:42:36 +0000411 if (limit_by_mtime && st.st_mtime < thirty_minutes_ago) {
Narayan Kamathbd863722017-06-01 18:50:12 +0100412 MYLOGI("Excluding stale dump file: %s\n", abs_path.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100413 continue;
414 }
415
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700416 dump_data.emplace_back(DumpData{abs_path, std::move(fd), st.st_mtime});
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700417 }
Rhed Jao01dc0c62020-06-03 17:13:30 +0800418 if (!dump_data.empty()) {
419 std::sort(dump_data.begin(), dump_data.end(),
420 [](const auto& a, const auto& b) { return a.mtime > b.mtime; });
421 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100422
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700423 return dump_data;
Narayan Kamath8f788292017-05-25 13:20:39 +0100424}
425
Narayan Kamathbd863722017-06-01 18:50:12 +0100426static bool AddDumps(const std::vector<DumpData>::const_iterator start,
427 const std::vector<DumpData>::const_iterator end,
428 const char* type_name, const bool add_to_zip) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100429 bool dumped = false;
Narayan Kamathbd863722017-06-01 18:50:12 +0100430 for (auto it = start; it != end; ++it) {
431 const std::string& name = it->name;
432 const int fd = it->fd;
Narayan Kamath8f788292017-05-25 13:20:39 +0100433 dumped = true;
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100434
435 // Seek to the beginning of the file before dumping any data. A given
436 // DumpData entry might be dumped multiple times in the report.
437 //
438 // For example, the most recent ANR entry is dumped to the body of the
439 // main entry and it also shows up as a separate entry in the bugreport
440 // ZIP file.
441 if (lseek(fd, 0, SEEK_SET) != static_cast<off_t>(0)) {
442 MYLOGE("Unable to add %s to zip file, lseek failed: %s\n", name.c_str(),
443 strerror(errno));
444 }
445
Narayan Kamath8f788292017-05-25 13:20:39 +0100446 if (ds.IsZipping() && add_to_zip) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800447 if (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + name, fd, /* timeout = */ 0ms) != OK) {
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100448 MYLOGE("Unable to add %s to zip file, addZipEntryFromFd failed\n", name.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100449 }
450 } else {
451 dump_file_from_fd(type_name, name.c_str(), fd);
452 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100453 }
454
455 return dumped;
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700456}
457
Felipe Leme635ca312016-01-05 14:23:02 -0800458// for_each_pid() callback to get mount info about a process.
Felipe Leme4c2d6632016-09-28 14:32:00 -0700459void do_mountinfo(int pid, const char* name __attribute__((unused))) {
Felipe Leme635ca312016-01-05 14:23:02 -0800460 char path[PATH_MAX];
461
462 // Gets the the content of the /proc/PID/ns/mnt link, so only unique mount points
463 // are added.
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700464 snprintf(path, sizeof(path), "/proc/%d/ns/mnt", pid);
Felipe Leme635ca312016-01-05 14:23:02 -0800465 char linkname[PATH_MAX];
466 ssize_t r = readlink(path, linkname, PATH_MAX);
467 if (r == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800468 MYLOGE("Unable to read link for %s: %s\n", path, strerror(errno));
Felipe Leme635ca312016-01-05 14:23:02 -0800469 return;
470 }
471 linkname[r] = '\0';
472
473 if (mount_points.find(linkname) == mount_points.end()) {
474 // First time this mount point was found: add it
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700475 snprintf(path, sizeof(path), "/proc/%d/mountinfo", pid);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700476 if (ds.AddZipEntry(ZIP_ROOT_DIR + path, path)) {
Felipe Leme635ca312016-01-05 14:23:02 -0800477 mount_points.insert(linkname);
478 } else {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800479 MYLOGE("Unable to add mountinfo %s to zip file\n", path);
Felipe Leme635ca312016-01-05 14:23:02 -0800480 }
481 }
482}
483
484void add_mountinfo() {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700485 if (!ds.IsZipping()) return;
Felipe Leme678727a2016-09-21 17:22:11 -0700486 std::string title = "MOUNT INFO";
Felipe Leme635ca312016-01-05 14:23:02 -0800487 mount_points.clear();
Felipe Leme46b85da2016-11-21 17:40:45 -0800488 DurationReporter duration_reporter(title, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700489 for_each_pid(do_mountinfo, nullptr);
490 MYLOGD("%s: %d entries added to zip file\n", title.c_str(), (int)mount_points.size());
Felipe Leme635ca312016-01-05 14:23:02 -0800491}
492
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700493static void dump_dev_files(const char *title, const char *driverpath, const char *filename)
494{
495 DIR *d;
496 struct dirent *de;
497 char path[PATH_MAX];
498
499 d = opendir(driverpath);
Yi Kong19d5c002018-07-20 13:39:55 -0700500 if (d == nullptr) {
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700501 return;
502 }
503
504 while ((de = readdir(d))) {
505 if (de->d_type != DT_LNK) {
506 continue;
507 }
508 snprintf(path, sizeof(path), "%s/%s/%s", driverpath, de->d_name, filename);
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700509 DumpFile(title, path);
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700510 }
511
512 closedir(d);
513}
514
Mark Salyzyn326842f2015-04-30 09:49:41 -0700515static bool skip_not_stat(const char *path) {
516 static const char stat[] = "/stat";
517 size_t len = strlen(path);
518 if (path[len - 1] == '/') { /* Directory? */
519 return false;
520 }
521 return strcmp(path + len - sizeof(stat) + 1, stat); /* .../stat? */
522}
523
Felipe Leme4c2d6632016-09-28 14:32:00 -0700524static bool skip_none(const char* path __attribute__((unused))) {
Felipe Lemee82a27d2016-01-05 13:35:44 -0800525 return false;
526}
527
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700528unsigned long worst_write_perf = 20000; /* in KB/s */
Mark Salyzyn326842f2015-04-30 09:49:41 -0700529
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800530//
531// stat offsets
532// Name units description
533// ---- ----- -----------
534// read I/Os requests number of read I/Os processed
535#define __STAT_READ_IOS 0
536// read merges requests number of read I/Os merged with in-queue I/O
537#define __STAT_READ_MERGES 1
538// read sectors sectors number of sectors read
539#define __STAT_READ_SECTORS 2
540// read ticks milliseconds total wait time for read requests
541#define __STAT_READ_TICKS 3
542// write I/Os requests number of write I/Os processed
543#define __STAT_WRITE_IOS 4
544// write merges requests number of write I/Os merged with in-queue I/O
545#define __STAT_WRITE_MERGES 5
546// write sectors sectors number of sectors written
547#define __STAT_WRITE_SECTORS 6
548// write ticks milliseconds total wait time for write requests
549#define __STAT_WRITE_TICKS 7
550// in_flight requests number of I/Os currently in flight
551#define __STAT_IN_FLIGHT 8
552// io_ticks milliseconds total time this block device has been active
553#define __STAT_IO_TICKS 9
554// time_in_queue milliseconds total wait time for all requests
555#define __STAT_IN_QUEUE 10
556#define __STAT_NUMBER_FIELD 11
557//
558// read I/Os, write I/Os
559// =====================
560//
561// These values increment when an I/O request completes.
562//
563// read merges, write merges
564// =========================
565//
566// These values increment when an I/O request is merged with an
567// already-queued I/O request.
568//
569// read sectors, write sectors
570// ===========================
571//
572// These values count the number of sectors read from or written to this
573// block device. The "sectors" in question are the standard UNIX 512-byte
574// sectors, not any device- or filesystem-specific block size. The
575// counters are incremented when the I/O completes.
576#define SECTOR_SIZE 512
577//
578// read ticks, write ticks
579// =======================
580//
581// These values count the number of milliseconds that I/O requests have
582// waited on this block device. If there are multiple I/O requests waiting,
583// these values will increase at a rate greater than 1000/second; for
584// example, if 60 read requests wait for an average of 30 ms, the read_ticks
585// field will increase by 60*30 = 1800.
586//
587// in_flight
588// =========
589//
590// This value counts the number of I/O requests that have been issued to
591// the device driver but have not yet completed. It does not include I/O
592// requests that are in the queue but not yet issued to the device driver.
593//
594// io_ticks
595// ========
596//
597// This value counts the number of milliseconds during which the device has
598// had I/O requests queued.
599//
600// time_in_queue
601// =============
602//
603// This value counts the number of milliseconds that I/O requests have waited
604// on this block device. If there are multiple I/O requests waiting, this
605// value will increase as the product of the number of milliseconds times the
606// number of requests waiting (see "read ticks" above for an example).
607#define S_TO_MS 1000
608//
609
Mark Salyzyn326842f2015-04-30 09:49:41 -0700610static int dump_stat_from_fd(const char *title __unused, const char *path, int fd) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800611 unsigned long long fields[__STAT_NUMBER_FIELD];
Mark Salyzyn326842f2015-04-30 09:49:41 -0700612 bool z;
Yi Kong19d5c002018-07-20 13:39:55 -0700613 char *cp, *buffer = nullptr;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700614 size_t i = 0;
Josh Gao7c4258c2018-06-25 13:40:08 -0700615 FILE *fp = fdopen(dup(fd), "rb");
Mark Salyzyn326842f2015-04-30 09:49:41 -0700616 getline(&buffer, &i, fp);
617 fclose(fp);
618 if (!buffer) {
619 return -errno;
620 }
621 i = strlen(buffer);
622 while ((i > 0) && (buffer[i - 1] == '\n')) {
623 buffer[--i] = '\0';
624 }
625 if (!*buffer) {
626 free(buffer);
627 return 0;
628 }
629 z = true;
630 for (cp = buffer, i = 0; i < (sizeof(fields) / sizeof(fields[0])); ++i) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800631 fields[i] = strtoull(cp, &cp, 10);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700632 if (fields[i] != 0) {
633 z = false;
634 }
635 }
636 if (z) { /* never accessed */
637 free(buffer);
638 return 0;
639 }
640
Wei Wang509bb5d2017-06-09 14:42:12 -0700641 if (!strncmp(path, BLK_DEV_SYS_DIR, sizeof(BLK_DEV_SYS_DIR) - 1)) {
642 path += sizeof(BLK_DEV_SYS_DIR) - 1;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700643 }
Wei Wang1dc1ef52017-06-12 11:28:37 -0700644
645 printf("%-30s:%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s\n%-30s:\t%s\n", "Block-Dev",
646 "R-IOs", "R-merg", "R-sect", "R-wait", "W-IOs", "W-merg", "W-sect",
647 "W-wait", "in-fli", "activ", "T-wait", path, buffer);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700648 free(buffer);
649
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800650 if (fields[__STAT_IO_TICKS]) {
651 unsigned long read_perf = 0;
652 unsigned long read_ios = 0;
653 if (fields[__STAT_READ_TICKS]) {
654 unsigned long long divisor = fields[__STAT_READ_TICKS]
655 * fields[__STAT_IO_TICKS];
656 read_perf = ((unsigned long long)SECTOR_SIZE
657 * fields[__STAT_READ_SECTORS]
658 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
659 / divisor;
660 read_ios = ((unsigned long long)S_TO_MS * fields[__STAT_READ_IOS]
661 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
662 / divisor;
663 }
664
665 unsigned long write_perf = 0;
666 unsigned long write_ios = 0;
667 if (fields[__STAT_WRITE_TICKS]) {
668 unsigned long long divisor = fields[__STAT_WRITE_TICKS]
669 * fields[__STAT_IO_TICKS];
670 write_perf = ((unsigned long long)SECTOR_SIZE
671 * fields[__STAT_WRITE_SECTORS]
672 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
673 / divisor;
674 write_ios = ((unsigned long long)S_TO_MS * fields[__STAT_WRITE_IOS]
675 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
676 / divisor;
677 }
678
679 unsigned queue = (fields[__STAT_IN_QUEUE]
680 + (fields[__STAT_IO_TICKS] >> 1))
681 / fields[__STAT_IO_TICKS];
682
683 if (!write_perf && !write_ios) {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700684 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 -0800685 } else {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700686 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 -0800687 read_ios, write_perf, write_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800688 }
689
690 /* bugreport timeout factor adjustment */
691 if ((write_perf > 1) && (write_perf < worst_write_perf)) {
692 worst_write_perf = write_perf;
693 }
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700694 }
Mark Salyzyn326842f2015-04-30 09:49:41 -0700695 return 0;
696}
697
Yao Chenbe3bbc12018-01-17 16:31:10 -0800698static const long MINIMUM_LOGCAT_TIMEOUT_MS = 50000;
699
Tom Cherryf4472f32020-08-05 09:31:17 -0700700// Returns the actual readable size of the given buffer or -1 on error.
701static long logcat_buffer_readable_size(const std::string& buffer) {
702 std::unique_ptr<logger_list, decltype(&android_logger_list_free)> logger_list{
703 android_logger_list_alloc(0, 0, 0), &android_logger_list_free};
704 auto logger = android_logger_open(logger_list.get(), android_name_to_log_id(buffer.c_str()));
705
706 return android_logger_get_log_readable_size(logger);
707}
708
709// Returns timeout in ms to read a list of buffers.
Yao Chenbe3bbc12018-01-17 16:31:10 -0800710static unsigned long logcat_timeout(const std::vector<std::string>& buffers) {
711 unsigned long timeout_ms = 0;
712 for (const auto& buffer : buffers) {
Tom Cherryf4472f32020-08-05 09:31:17 -0700713 long readable_size = logcat_buffer_readable_size(buffer);
714 if (readable_size > 0) {
715 // Engineering margin is ten-fold our guess.
716 timeout_ms += 10 * (readable_size + worst_write_perf) / worst_write_perf;
717 }
Yao Chenbe3bbc12018-01-17 16:31:10 -0800718 }
719 return timeout_ms > MINIMUM_LOGCAT_TIMEOUT_MS ? timeout_ms : MINIMUM_LOGCAT_TIMEOUT_MS;
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700720}
721
Nandana Duttd2f5f082019-01-18 17:13:52 +0000722Dumpstate::ConsentCallback::ConsentCallback() : result_(UNAVAILABLE), start_time_(Nanotime()) {
723}
724
725android::binder::Status Dumpstate::ConsentCallback::onReportApproved() {
726 std::lock_guard<std::mutex> lock(lock_);
727 result_ = APPROVED;
728 MYLOGD("User approved consent to share bugreport\n");
Paul Chang0d2aad72020-02-13 20:04:03 +0800729
730 // Maybe copy screenshot so calling app can display the screenshot to the user as soon as
731 // consent is granted.
732 if (ds.options_->is_screenshot_copied) {
733 return android::binder::Status::ok();
734 }
735
736 if (!ds.options_->do_screenshot || ds.options_->screenshot_fd.get() == -1 ||
737 !ds.do_early_screenshot_) {
738 return android::binder::Status::ok();
739 }
740
741 bool copy_succeeded = android::os::CopyFileToFd(ds.screenshot_path_,
742 ds.options_->screenshot_fd.get());
743 ds.options_->is_screenshot_copied = copy_succeeded;
744 if (copy_succeeded) {
745 android::os::UnlinkAndLogOnError(ds.screenshot_path_);
746 }
Nandana Duttd2f5f082019-01-18 17:13:52 +0000747 return android::binder::Status::ok();
748}
749
750android::binder::Status Dumpstate::ConsentCallback::onReportDenied() {
751 std::lock_guard<std::mutex> lock(lock_);
752 result_ = DENIED;
753 MYLOGW("User denied consent to share bugreport\n");
754 return android::binder::Status::ok();
755}
756
757UserConsentResult Dumpstate::ConsentCallback::getResult() {
758 std::lock_guard<std::mutex> lock(lock_);
759 return result_;
760}
761
762uint64_t Dumpstate::ConsentCallback::getElapsedTimeMs() const {
Hunter Knepshieldf0a39052020-01-03 14:53:04 -0800763 return (Nanotime() - start_time_) / NANOS_PER_MILLI;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000764}
765
Felipe Leme2b9b06c2016-10-14 09:13:06 -0700766void Dumpstate::PrintHeader() const {
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700767 std::string build, fingerprint, radio, bootloader, network;
768 char date[80];
Colin Crossf45fa6b2012-03-26 12:38:26 -0700769
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700770 build = android::base::GetProperty("ro.build.display.id", "(unknown)");
771 fingerprint = android::base::GetProperty("ro.build.fingerprint", "(unknown)");
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700772 radio = android::base::GetProperty("gsm.version.baseband", "(unknown)");
773 bootloader = android::base::GetProperty("ro.bootloader", "(unknown)");
774 network = android::base::GetProperty("gsm.operator.alpha", "(unknown)");
Felipe Lemebbaf3c12016-10-11 14:32:25 -0700775 strftime(date, sizeof(date), "%Y-%m-%d %H:%M:%S", localtime(&now_));
Colin Crossf45fa6b2012-03-26 12:38:26 -0700776
Felipe Lemed8b94e52016-12-08 10:21:44 -0800777 printf("========================================================\n");
778 printf("== dumpstate: %s\n", date);
779 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -0700780
Felipe Lemed8b94e52016-12-08 10:21:44 -0800781 printf("\n");
782 printf("Build: %s\n", build.c_str());
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700783 // NOTE: fingerprint entry format is important for other tools.
Felipe Lemed8b94e52016-12-08 10:21:44 -0800784 printf("Build fingerprint: '%s'\n", fingerprint.c_str());
785 printf("Bootloader: %s\n", bootloader.c_str());
786 printf("Radio: %s\n", radio.c_str());
787 printf("Network: %s\n", network.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100788 int64_t module_metadata_version = android::os::GetModuleMetadataVersion();
789 if (module_metadata_version != 0) {
790 printf("Module Metadata version: %" PRId64 "\n", module_metadata_version);
791 }
Colin Crossf45fa6b2012-03-26 12:38:26 -0700792
Felipe Lemed8b94e52016-12-08 10:21:44 -0800793 printf("Kernel: ");
Felipe Lemef0292972016-11-22 13:57:05 -0800794 DumpFileToFd(STDOUT_FILENO, "", "/proc/version");
Felipe Lemed8b94e52016-12-08 10:21:44 -0800795 printf("Command line: %s\n", strtok(cmdline_buf, "\n"));
Felipe Leme7709f8a2017-12-05 09:30:09 -0800796 printf("Uptime: ");
797 RunCommandToFd(STDOUT_FILENO, "", {"uptime", "-p"},
798 CommandOptions::WithTimeout(1).Always().Build());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800799 printf("Bugreport format version: %s\n", version_.c_str());
Rhed Jao1c855122020-07-16 17:37:39 +0800800 printf("Dumpstate info: id=%d pid=%d dry_run=%d parallel_run=%d args=%s bugreport_mode=%s\n",
801 id_, pid_, PropertiesHelper::IsDryRun(), PropertiesHelper::IsParallelRun(),
802 options_->args.c_str(), options_->bugreport_mode.c_str());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800803 printf("\n");
Felipe Leme78f2c862015-12-21 09:55:22 -0800804}
805
Felipe Leme24b66ee2016-06-16 10:55:26 -0700806// List of file extensions that can cause a zip file attachment to be rejected by some email
807// service providers.
808static const std::set<std::string> PROBLEMATIC_FILE_EXTENSIONS = {
809 ".ade", ".adp", ".bat", ".chm", ".cmd", ".com", ".cpl", ".exe", ".hta", ".ins", ".isp",
810 ".jar", ".jse", ".lib", ".lnk", ".mde", ".msc", ".msp", ".mst", ".pif", ".scr", ".sct",
811 ".shb", ".sys", ".vb", ".vbe", ".vbs", ".vxd", ".wsc", ".wsf", ".wsh"
812};
813
Vishnu Naire97d6122018-01-18 13:58:56 -0800814status_t Dumpstate::AddZipEntryFromFd(const std::string& entry_name, int fd,
815 std::chrono::milliseconds timeout = 0ms) {
Felipe Leme1d486fe2016-10-14 18:06:47 -0700816 if (!IsZipping()) {
817 MYLOGD("Not adding zip entry %s from fd because it's not a zipped bugreport\n",
818 entry_name.c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -0800819 return INVALID_OPERATION;
Felipe Leme111b9d02016-02-03 09:28:24 -0800820 }
Felipe Leme24b66ee2016-06-16 10:55:26 -0700821 std::string valid_name = entry_name;
822
823 // Rename extension if necessary.
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -0700824 size_t idx = entry_name.rfind('.');
Felipe Leme24b66ee2016-06-16 10:55:26 -0700825 if (idx != std::string::npos) {
826 std::string extension = entry_name.substr(idx);
827 std::transform(extension.begin(), extension.end(), extension.begin(), ::tolower);
828 if (PROBLEMATIC_FILE_EXTENSIONS.count(extension) != 0) {
829 valid_name = entry_name + ".renamed";
830 MYLOGI("Renaming entry %s to %s\n", entry_name.c_str(), valid_name.c_str());
831 }
832 }
833
Felipe Leme6fe9db62016-02-12 09:04:16 -0800834 // Logging statement below is useful to time how long each entry takes, but it's too verbose.
835 // MYLOGD("Adding zip entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700836 int32_t err = zip_writer_->StartEntryWithTime(valid_name.c_str(), ZipWriter::kCompress,
837 get_mtime(fd, ds.now_));
Felipe Leme1d486fe2016-10-14 18:06:47 -0700838 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700839 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", valid_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700840 ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800841 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800842 }
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000843 bool finished_entry = false;
844 auto finish_entry = [this, &finished_entry] {
845 if (!finished_entry) {
846 // This should only be called when we're going to return an earlier error,
847 // which would've been logged. This may imply the file is already corrupt
848 // and any further logging from FinishEntry is more likely to mislead than
849 // not.
850 this->zip_writer_->FinishEntry();
851 }
852 };
853 auto scope_guard = android::base::make_scope_guard(finish_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -0800854 auto start = std::chrono::steady_clock::now();
855 auto end = start + timeout;
856 struct pollfd pfd = {fd, POLLIN};
Felipe Lemee82a27d2016-01-05 13:35:44 -0800857
Felipe Leme770410d2016-01-26 17:07:14 -0800858 std::vector<uint8_t> buffer(65536);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800859 while (1) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800860 if (timeout.count() > 0) {
861 // lambda to recalculate the timeout.
862 auto time_left_ms = [end]() {
863 auto now = std::chrono::steady_clock::now();
864 auto diff = std::chrono::duration_cast<std::chrono::milliseconds>(end - now);
865 return std::max(diff.count(), 0LL);
866 };
867
868 int rc = TEMP_FAILURE_RETRY(poll(&pfd, 1, time_left_ms()));
869 if (rc < 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000870 MYLOGE("Error in poll while adding from fd to zip entry %s:%s\n",
871 entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800872 return -errno;
873 } else if (rc == 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000874 MYLOGE("Timed out adding from fd to zip entry %s:%s Timeout:%lldms\n",
Vishnu Naire97d6122018-01-18 13:58:56 -0800875 entry_name.c_str(), strerror(errno), timeout.count());
876 return TIMED_OUT;
877 }
878 }
879
Zach Riggle22200402016-08-18 01:01:24 -0400880 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800881 if (bytes_read == 0) {
882 break;
883 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800884 MYLOGE("read(%s): %s\n", entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800885 return -errno;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800886 }
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700887 err = zip_writer_->WriteBytes(buffer.data(), bytes_read);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800888 if (err) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700889 MYLOGE("zip_writer_->WriteBytes(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800890 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800891 }
892 }
893
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700894 err = zip_writer_->FinishEntry();
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000895 finished_entry = true;
Felipe Leme1d486fe2016-10-14 18:06:47 -0700896 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700897 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800898 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800899 }
900
Vishnu Naire97d6122018-01-18 13:58:56 -0800901 return OK;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800902}
903
Felipe Leme1d486fe2016-10-14 18:06:47 -0700904bool Dumpstate::AddZipEntry(const std::string& entry_name, const std::string& entry_path) {
905 android::base::unique_fd fd(
906 TEMP_FAILURE_RETRY(open(entry_path.c_str(), O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
Andreas Gampeaff68432016-07-18 18:01:27 -0700907 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800908 MYLOGE("open(%s): %s\n", entry_path.c_str(), strerror(errno));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800909 return false;
910 }
911
Vishnu Naire97d6122018-01-18 13:58:56 -0800912 return (AddZipEntryFromFd(entry_name, fd.get()) == OK);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800913}
914
915/* adds a file to the existing zipped bugreport */
Felipe Leme4c2d6632016-09-28 14:32:00 -0700916static int _add_file_from_fd(const char* title __attribute__((unused)), const char* path, int fd) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800917 return (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + path, fd) == OK) ? 0 : 1;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800918}
919
Felipe Leme1d486fe2016-10-14 18:06:47 -0700920void Dumpstate::AddDir(const std::string& dir, bool recursive) {
921 if (!IsZipping()) {
922 MYLOGD("Not adding dir %s because it's not a zipped bugreport\n", dir.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800923 return;
924 }
Felipe Leme678727a2016-09-21 17:22:11 -0700925 MYLOGD("Adding dir %s (recursive: %d)\n", dir.c_str(), recursive);
Felipe Leme46b85da2016-11-21 17:40:45 -0800926 DurationReporter duration_reporter(dir, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700927 dump_files("", dir.c_str(), recursive ? skip_none : is_dir, _add_file_from_fd);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800928}
929
Felipe Leme1d486fe2016-10-14 18:06:47 -0700930bool Dumpstate::AddTextZipEntry(const std::string& entry_name, const std::string& content) {
931 if (!IsZipping()) {
932 MYLOGD("Not adding text zip entry %s because it's not a zipped bugreport\n",
933 entry_name.c_str());
Felipe Leme111b9d02016-02-03 09:28:24 -0800934 return false;
935 }
Felipe Lemecbce55d2016-02-08 09:53:18 -0800936 MYLOGD("Adding zip text entry %s\n", entry_name.c_str());
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700937 int32_t err = zip_writer_->StartEntryWithTime(entry_name.c_str(), ZipWriter::kCompress, ds.now_);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700938 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700939 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700940 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800941 return false;
942 }
943
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700944 err = zip_writer_->WriteBytes(content.c_str(), content.length());
Felipe Leme1d486fe2016-10-14 18:06:47 -0700945 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700946 MYLOGE("zip_writer_->WriteBytes(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700947 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800948 return false;
949 }
950
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700951 err = zip_writer_->FinishEntry();
Felipe Leme1d486fe2016-10-14 18:06:47 -0700952 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700953 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800954 return false;
955 }
956
957 return true;
958}
959
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800960static void DoKmsg() {
961 struct stat st;
962 if (!stat(PSTORE_LAST_KMSG, &st)) {
963 /* Also TODO: Make console-ramoops CAP_SYSLOG protected. */
964 DumpFile("LAST KMSG", PSTORE_LAST_KMSG);
965 } else if (!stat(ALT_PSTORE_LAST_KMSG, &st)) {
966 DumpFile("LAST KMSG", ALT_PSTORE_LAST_KMSG);
967 } else {
968 /* TODO: Make last_kmsg CAP_SYSLOG protected. b/5555691 */
969 DumpFile("LAST KMSG", "/proc/last_kmsg");
970 }
971}
972
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800973static void DoKernelLogcat() {
Yao Chenbe3bbc12018-01-17 16:31:10 -0800974 unsigned long timeout_ms = logcat_timeout({"kernel"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800975 RunCommand(
976 "KERNEL LOG",
977 {"logcat", "-b", "kernel", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
978 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
979}
980
Nandana Duttdb379fa2019-10-09 16:54:41 +0100981static void DoSystemLogcat(time_t since) {
982 char since_str[80];
983 strftime(since_str, sizeof(since_str), "%Y-%m-%d %H:%M:%S.000", localtime(&since));
984
985 unsigned long timeout_ms = logcat_timeout({"main", "system", "crash"});
986 RunCommand("SYSTEM LOG",
987 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v", "-T",
988 since_str},
989 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
990}
991
Hunter Knepshield820f9bc2020-02-05 20:10:53 -0800992static void DoRadioLogcat() {
993 unsigned long timeout_ms = logcat_timeout({"radio"});
994 RunCommand(
995 "RADIO LOG",
996 {"logcat", "-b", "radio", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
997 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
998}
999
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001000static void DoLogcat() {
Vishnu Nair6921f802017-11-22 09:17:23 -08001001 unsigned long timeout_ms;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001002 // DumpFile("EVENT LOG TAGS", "/etc/event-log-tags");
1003 // calculate timeout
Yao Chenbe3bbc12018-01-17 16:31:10 -08001004 timeout_ms = logcat_timeout({"main", "system", "crash"});
Tony Makae737652017-03-30 17:47:09 +01001005 RunCommand("SYSTEM LOG",
Vishnu Nair6921f802017-11-22 09:17:23 -08001006 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1007 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -08001008 timeout_ms = logcat_timeout({"events"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001009 RunCommand(
1010 "EVENT LOG",
1011 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001012 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Yao Chenbe3bbc12018-01-17 16:31:10 -08001013 timeout_ms = logcat_timeout({"stats"});
1014 RunCommand(
1015 "STATS LOG",
1016 {"logcat", "-b", "stats", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001017 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001018 DoRadioLogcat();
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001019
1020 RunCommand("LOG STATISTICS", {"logcat", "-b", "all", "-S"});
1021
1022 /* kernels must set CONFIG_PSTORE_PMSG, slice up pstore with device tree */
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001023 RunCommand("LAST LOGCAT", {"logcat", "-L", "-b", "all", "-v", "threadtime", "-v", "printable",
1024 "-v", "uid", "-d", "*:v"});
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001025}
1026
Mike Ma5c267872019-08-21 11:31:34 -07001027static void DumpIncidentReport() {
1028 if (!ds.IsZipping()) {
1029 MYLOGD("Not dumping incident report because it's not a zipped bugreport\n");
1030 return;
1031 }
Mike Ma5c267872019-08-21 11:31:34 -07001032 const std::string path = ds.bugreport_internal_dir_ + "/tmp_incident_report";
1033 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1034 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1035 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1036 if (fd < 0) {
1037 MYLOGE("Could not open %s to dump incident report.\n", path.c_str());
1038 return;
1039 }
1040 RunCommandToFd(fd, "", {"incident", "-u"}, CommandOptions::WithTimeout(120).Build());
1041 bool empty = 0 == lseek(fd, 0, SEEK_END);
1042 if (!empty) {
1043 // Use a different name from "incident.proto"
1044 // /proto/incident.proto is reserved for incident service dump
1045 // i.e. metadata for debugging.
Rhed Jao4875aa62020-07-20 17:46:29 +08001046 ds.EnqueueAddZipEntryAndCleanupIfNeeded(kProtoPath + "incident_report" + kProtoExt,
1047 path);
1048 } else {
1049 unlink(path.c_str());
Mike Ma5c267872019-08-21 11:31:34 -07001050 }
Mike Ma5c267872019-08-21 11:31:34 -07001051}
1052
Sunny Goyal35949782019-11-19 15:54:36 -08001053static void DumpVisibleWindowViews() {
1054 if (!ds.IsZipping()) {
1055 MYLOGD("Not dumping visible views because it's not a zipped bugreport\n");
1056 return;
1057 }
1058 DurationReporter duration_reporter("VISIBLE WINDOW VIEWS");
1059 const std::string path = ds.bugreport_internal_dir_ + "/tmp_visible_window_views";
1060 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1061 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1062 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1063 if (fd < 0) {
1064 MYLOGE("Could not open %s to dump visible views.\n", path.c_str());
1065 return;
1066 }
1067 RunCommandToFd(fd, "", {"cmd", "window", "dump-visible-window-views"},
1068 CommandOptions::WithTimeout(120).Build());
1069 bool empty = 0 == lseek(fd, 0, SEEK_END);
1070 if (!empty) {
1071 ds.AddZipEntry("visible_windows.zip", path);
1072 } else {
1073 MYLOGW("Failed to dump visible windows\n");
1074 }
1075 unlink(path.c_str());
1076}
1077
Jayachandran Ca94c7172017-06-10 15:08:12 -07001078static void DumpIpTablesAsRoot() {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001079 RunCommand("IPTABLES", {"iptables", "-L", "-nvx"});
1080 RunCommand("IP6TABLES", {"ip6tables", "-L", "-nvx"});
Erik Kline32af8c22016-09-28 17:26:26 +09001081 RunCommand("IPTABLES NAT", {"iptables", "-t", "nat", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001082 /* no ip6 nat */
Erik Kline32af8c22016-09-28 17:26:26 +09001083 RunCommand("IPTABLES MANGLE", {"iptables", "-t", "mangle", "-L", "-nvx"});
1084 RunCommand("IP6TABLES MANGLE", {"ip6tables", "-t", "mangle", "-L", "-nvx"});
1085 RunCommand("IPTABLES RAW", {"iptables", "-t", "raw", "-L", "-nvx"});
1086 RunCommand("IP6TABLES RAW", {"ip6tables", "-t", "raw", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001087}
1088
David Andersond9ba4752018-12-11 18:26:59 -08001089static void DumpDynamicPartitionInfo() {
1090 if (!::android::base::GetBoolProperty("ro.boot.dynamic_partitions", false)) {
1091 return;
1092 }
1093
1094 RunCommand("LPDUMP", {"lpdump", "--all"});
David Anderson6650ade2019-10-02 15:18:59 -07001095 RunCommand("DEVICE-MAPPER", {"gsid", "dump-device-mapper"});
David Andersond9ba4752018-12-11 18:26:59 -08001096}
1097
Narayan Kamath8f788292017-05-25 13:20:39 +01001098static void AddAnrTraceDir(const bool add_to_zip, const std::string& anr_traces_dir) {
1099 MYLOGD("AddAnrTraceDir(): dump_traces_file=%s, anr_traces_dir=%s\n", dump_traces_path,
1100 anr_traces_dir.c_str());
1101
1102 // If we're here, dump_traces_path will always be a temporary file
1103 // (created with mkostemp or similar) that contains dumps taken earlier
1104 // on in the process.
1105 if (dump_traces_path != nullptr) {
1106 if (add_to_zip) {
1107 ds.AddZipEntry(ZIP_ROOT_DIR + anr_traces_dir + "/traces-just-now.txt", dump_traces_path);
1108 } else {
1109 MYLOGD("Dumping current ANR traces (%s) to the main bugreport entry\n",
1110 dump_traces_path);
1111 ds.DumpFile("VM TRACES JUST NOW", dump_traces_path);
1112 }
1113
1114 const int ret = unlink(dump_traces_path);
1115 if (ret == -1) {
1116 MYLOGW("Error unlinking temporary trace path %s: %s\n", dump_traces_path,
1117 strerror(errno));
Felipe Lemee184f662016-10-27 10:04:47 -07001118 }
1119 }
1120
Narayan Kamathbd863722017-06-01 18:50:12 +01001121 // Add a specific message for the first ANR Dump.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001122 if (ds.anr_data_.size() > 0) {
1123 AddDumps(ds.anr_data_.begin(), ds.anr_data_.begin() + 1,
Narayan Kamathbd863722017-06-01 18:50:12 +01001124 "VM TRACES AT LAST ANR", add_to_zip);
1125
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001126 // The "last" ANR will always be included as separate entry in the zip file. In addition,
1127 // it will be present in the body of the main entry if |add_to_zip| == false.
1128 //
1129 // Historical ANRs are always included as separate entries in the bugreport zip file.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001130 AddDumps(ds.anr_data_.begin() + ((add_to_zip) ? 1 : 0), ds.anr_data_.end(),
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001131 "HISTORICAL ANR", true /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001132 } else {
Narayan Kamath8f788292017-05-25 13:20:39 +01001133 printf("*** NO ANRs to dump in %s\n\n", ANR_DIR.c_str());
1134 }
1135}
1136
1137static void AddAnrTraceFiles() {
1138 const bool add_to_zip = ds.IsZipping() && ds.version_ == VERSION_SPLIT_ANR;
1139
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001140 std::string anr_traces_dir = "/data/anr";
Narayan Kamath8f788292017-05-25 13:20:39 +01001141
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001142 AddAnrTraceDir(add_to_zip, anr_traces_dir);
Narayan Kamath8f788292017-05-25 13:20:39 +01001143
Makoto Onuki83ec63f2019-01-31 17:08:59 -08001144 RunCommand("ANR FILES", {"ls", "-lt", ANR_DIR});
1145
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001146 // Slow traces for slow operations.
Felipe Lemee184f662016-10-27 10:04:47 -07001147 struct stat st;
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001148 int i = 0;
1149 while (true) {
1150 const std::string slow_trace_path =
1151 anr_traces_dir + android::base::StringPrintf("slow%02d.txt", i);
1152 if (stat(slow_trace_path.c_str(), &st)) {
1153 // No traces file at this index, done with the files.
1154 break;
Felipe Lemee184f662016-10-27 10:04:47 -07001155 }
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001156 ds.DumpFile("VM TRACES WHEN SLOW", slow_trace_path.c_str());
1157 i++;
Felipe Lemee184f662016-10-27 10:04:47 -07001158 }
1159}
1160
Wei Wang509bb5d2017-06-09 14:42:12 -07001161static void DumpBlockStatFiles() {
1162 DurationReporter duration_reporter("DUMP BLOCK STAT");
Wei Wang509bb5d2017-06-09 14:42:12 -07001163
Wei Wang1dc1ef52017-06-12 11:28:37 -07001164 std::unique_ptr<DIR, std::function<int(DIR*)>> dirptr(opendir(BLK_DEV_SYS_DIR), closedir);
1165
1166 if (dirptr == nullptr) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001167 MYLOGE("Failed to open %s: %s\n", BLK_DEV_SYS_DIR, strerror(errno));
1168 return;
1169 }
1170
1171 printf("------ DUMP BLOCK STAT ------\n\n");
Wei Wang1dc1ef52017-06-12 11:28:37 -07001172 while (struct dirent *d = readdir(dirptr.get())) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001173 if ((d->d_name[0] == '.')
1174 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
1175 || (d->d_name[1] == '\0'))) {
1176 continue;
1177 }
1178 const std::string new_path =
1179 android::base::StringPrintf("%s/%s", BLK_DEV_SYS_DIR, d->d_name);
1180 printf("------ BLOCK STAT (%s) ------\n", new_path.c_str());
1181 dump_files("", new_path.c_str(), skip_not_stat, dump_stat_from_fd);
1182 printf("\n");
1183 }
Wei Wang1dc1ef52017-06-12 11:28:37 -07001184 return;
Wei Wang509bb5d2017-06-09 14:42:12 -07001185}
Jayachandran Ca94c7172017-06-10 15:08:12 -07001186
1187static void DumpPacketStats() {
1188 DumpFile("NETWORK DEV INFO", "/proc/net/dev");
1189 DumpFile("QTAGUID NETWORK INTERFACES INFO", "/proc/net/xt_qtaguid/iface_stat_all");
1190 DumpFile("QTAGUID NETWORK INTERFACES INFO (xt)", "/proc/net/xt_qtaguid/iface_stat_fmt");
1191 DumpFile("QTAGUID CTRL INFO", "/proc/net/xt_qtaguid/ctrl");
1192 DumpFile("QTAGUID STATS INFO", "/proc/net/xt_qtaguid/stats");
1193}
1194
1195static void DumpIpAddrAndRules() {
1196 /* The following have a tendency to get wedged when wifi drivers/fw goes belly-up. */
1197 RunCommand("NETWORK INTERFACES", {"ip", "link"});
1198 RunCommand("IPv4 ADDRESSES", {"ip", "-4", "addr", "show"});
1199 RunCommand("IPv6 ADDRESSES", {"ip", "-6", "addr", "show"});
1200 RunCommand("IP RULES", {"ip", "rule", "show"});
1201 RunCommand("IP RULES v6", {"ip", "-6", "rule", "show"});
1202}
1203
Nandana Dutt5c390032019-03-12 10:52:56 +00001204static Dumpstate::RunStatus RunDumpsysTextByPriority(const std::string& title, int priority,
1205 std::chrono::milliseconds timeout,
1206 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001207 auto start = std::chrono::steady_clock::now();
Vishnu Naire97d6122018-01-18 13:58:56 -08001208 sp<android::IServiceManager> sm = defaultServiceManager();
1209 Dumpsys dumpsys(sm.get());
Vishnu Naire97d6122018-01-18 13:58:56 -08001210 Vector<String16> args;
1211 Dumpsys::setServiceArgs(args, /* asProto = */ false, priority);
Vishnu Naire97d6122018-01-18 13:58:56 -08001212 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ false);
1213 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001214 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001215 std::string path(title);
1216 path.append(" - ").append(String8(service).c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -08001217 size_t bytes_written = 0;
Steven Moreland5a30d342019-10-08 13:53:28 -07001218 status_t status = dumpsys.startDumpThread(Dumpsys::Type::DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001219 if (status == OK) {
1220 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1221 std::chrono::duration<double> elapsed_seconds;
1222 status = dumpsys.writeDump(STDOUT_FILENO, service, service_timeout,
1223 /* as_proto = */ false, elapsed_seconds, bytes_written);
Vishnu Naire97d6122018-01-18 13:58:56 -08001224 dumpsys.writeDumpFooter(STDOUT_FILENO, service, elapsed_seconds);
1225 bool dump_complete = (status == OK);
1226 dumpsys.stopDumpThread(dump_complete);
1227 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001228
1229 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1230 std::chrono::steady_clock::now() - start);
1231 if (elapsed_duration > timeout) {
1232 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1233 elapsed_duration.count());
1234 break;
1235 }
1236 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001237 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001238}
1239
Vishnu Nair64afc022018-02-01 15:29:34 -08001240static void RunDumpsysText(const std::string& title, int priority,
1241 std::chrono::milliseconds timeout,
1242 std::chrono::milliseconds service_timeout) {
1243 DurationReporter duration_reporter(title);
1244 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1245 fsync(STDOUT_FILENO);
1246 RunDumpsysTextByPriority(title, priority, timeout, service_timeout);
1247}
1248
1249/* Dump all services registered with Normal or Default priority. */
Nandana Dutt5c390032019-03-12 10:52:56 +00001250static Dumpstate::RunStatus RunDumpsysTextNormalPriority(const std::string& title,
1251 std::chrono::milliseconds timeout,
1252 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001253 DurationReporter duration_reporter(title);
1254 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1255 fsync(STDOUT_FILENO);
1256 RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_NORMAL, timeout,
1257 service_timeout);
Nandana Dutt5c390032019-03-12 10:52:56 +00001258
1259 RETURN_IF_USER_DENIED_CONSENT();
1260
1261 return RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_DEFAULT, timeout,
1262 service_timeout);
Vishnu Nair64afc022018-02-01 15:29:34 -08001263}
1264
Nandana Dutt5c390032019-03-12 10:52:56 +00001265static Dumpstate::RunStatus RunDumpsysProto(const std::string& title, int priority,
1266 std::chrono::milliseconds timeout,
1267 std::chrono::milliseconds service_timeout) {
Luis Hector Chavez1e27b082018-03-22 15:36:42 -07001268 if (!ds.IsZipping()) {
1269 MYLOGD("Not dumping %s because it's not a zipped bugreport\n", title.c_str());
Nandana Dutt5c390032019-03-12 10:52:56 +00001270 return Dumpstate::RunStatus::OK;
Luis Hector Chavez1e27b082018-03-22 15:36:42 -07001271 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001272 sp<android::IServiceManager> sm = defaultServiceManager();
1273 Dumpsys dumpsys(sm.get());
1274 Vector<String16> args;
1275 Dumpsys::setServiceArgs(args, /* asProto = */ true, priority);
1276 DurationReporter duration_reporter(title);
1277
1278 auto start = std::chrono::steady_clock::now();
1279 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ true);
1280 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001281 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001282 std::string path(kProtoPath);
1283 path.append(String8(service).c_str());
1284 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL) {
1285 path.append("_CRITICAL");
1286 } else if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH) {
1287 path.append("_HIGH");
1288 }
1289 path.append(kProtoExt);
Steven Moreland5a30d342019-10-08 13:53:28 -07001290 status_t status = dumpsys.startDumpThread(Dumpsys::Type::DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001291 if (status == OK) {
1292 status = ds.AddZipEntryFromFd(path, dumpsys.getDumpFd(), service_timeout);
1293 bool dumpTerminated = (status == OK);
1294 dumpsys.stopDumpThread(dumpTerminated);
1295 }
1296 ZipWriter::FileEntry file_entry;
1297 ds.zip_writer_->GetLastEntry(&file_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -08001298
1299 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1300 std::chrono::steady_clock::now() - start);
1301 if (elapsed_duration > timeout) {
1302 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1303 elapsed_duration.count());
1304 break;
1305 }
1306 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001307 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001308}
1309
Nandana Dutta7db6342018-11-21 14:53:34 +00001310// Runs dumpsys on services that must dump first and will take less than 100ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001311static Dumpstate::RunStatus RunDumpsysCritical() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001312 RunDumpsysText("DUMPSYS CRITICAL", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1313 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Nandana Dutt5c390032019-03-12 10:52:56 +00001314
1315 RETURN_IF_USER_DENIED_CONSENT();
1316
1317 return RunDumpsysProto("DUMPSYS CRITICAL PROTO", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1318 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Vishnu Nair780b1282017-10-10 13:57:24 -07001319}
1320
1321// Runs dumpsys on services that must dump first but can take up to 250ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001322static Dumpstate::RunStatus RunDumpsysHigh() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001323 // TODO meminfo takes ~10s, connectivity takes ~5sec to dump. They are both
1324 // high priority. Reduce timeout once they are able to dump in a shorter time or
1325 // moved to a parallel task.
1326 RunDumpsysText("DUMPSYS HIGH", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1327 /* timeout= */ 90s, /* service_timeout= */ 30s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001328
1329 RETURN_IF_USER_DENIED_CONSENT();
1330
1331 return RunDumpsysProto("DUMPSYS HIGH PROTO", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1332 /* timeout= */ 5s, /* service_timeout= */ 1s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001333}
1334
1335// Runs dumpsys on services that must dump but can take up to 10s to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001336static Dumpstate::RunStatus RunDumpsysNormal() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001337 RunDumpsysTextNormalPriority("DUMPSYS", /* timeout= */ 90s, /* service_timeout= */ 10s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001338
1339 RETURN_IF_USER_DENIED_CONSENT();
1340
1341 return RunDumpsysProto("DUMPSYS PROTO", IServiceManager::DUMP_FLAG_PRIORITY_NORMAL,
1342 /* timeout= */ 90s, /* service_timeout= */ 10s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001343}
1344
Rhed Jao4875aa62020-07-20 17:46:29 +08001345/*
1346 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1347 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1348 * if it's not running in the parallel task.
1349 */
1350static void DumpHals(int out_fd = STDOUT_FILENO) {
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001351 if (!ds.IsZipping()) {
Yifan Hong30528a22020-08-07 18:24:06 -07001352 RunCommand("HARDWARE HALS", {"lshal", "--all", "--types=all", "--debug"},
Steven Moreland9de8a1f2020-09-23 17:26:33 +00001353 CommandOptions::WithTimeout(60).AsRootIfAvailable().Build());
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001354 return;
1355 }
Yifan Hong30528a22020-08-07 18:24:06 -07001356 RunCommand("HARDWARE HALS", {"lshal", "--all", "--types=all"},
Rhed Jao4875aa62020-07-20 17:46:29 +08001357 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build(),
1358 false, out_fd);
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001359
Steven Moreland44cd9482018-01-04 16:24:13 -08001360 using android::hidl::manager::V1_0::IServiceManager;
1361 using android::hardware::defaultServiceManager;
1362
1363 sp<IServiceManager> sm = defaultServiceManager();
1364 if (sm == nullptr) {
1365 MYLOGE("Could not retrieve hwservicemanager to dump hals.\n");
1366 return;
1367 }
1368
1369 auto ret = sm->list([&](const auto& interfaces) {
1370 for (const std::string& interface : interfaces) {
1371 std::string cleanName = interface;
1372 std::replace_if(cleanName.begin(),
1373 cleanName.end(),
1374 [](char c) {
1375 return !isalnum(c) &&
1376 std::string("@-_:.").find(c) == std::string::npos;
1377 }, '_');
Nandana Dutt979388e2018-11-30 16:48:55 +00001378 const std::string path = ds.bugreport_internal_dir_ + "/lshal_debug_" + cleanName;
Steven Moreland44cd9482018-01-04 16:24:13 -08001379
Rhed Jao4875aa62020-07-20 17:46:29 +08001380 bool empty = false;
Steven Moreland44cd9482018-01-04 16:24:13 -08001381 {
1382 auto fd = android::base::unique_fd(
1383 TEMP_FAILURE_RETRY(open(path.c_str(),
1384 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1385 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1386 if (fd < 0) {
1387 MYLOGE("Could not open %s to dump additional hal information.\n", path.c_str());
1388 continue;
1389 }
1390 RunCommandToFd(fd,
1391 "",
Steven Morelandc81cd3c2018-01-18 14:36:26 -08001392 {"lshal", "debug", "-E", interface},
Steven Moreland44cd9482018-01-04 16:24:13 -08001393 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
1394
Rhed Jao4875aa62020-07-20 17:46:29 +08001395 empty = 0 == lseek(fd, 0, SEEK_END);
Steven Moreland44cd9482018-01-04 16:24:13 -08001396 }
Rhed Jao4875aa62020-07-20 17:46:29 +08001397 if (!empty) {
1398 ds.EnqueueAddZipEntryAndCleanupIfNeeded("lshal-debug/" + cleanName + ".txt",
1399 path);
1400 } else {
1401 unlink(path.c_str());
1402 }
Steven Moreland44cd9482018-01-04 16:24:13 -08001403 }
1404 });
1405
1406 if (!ret.isOk()) {
1407 MYLOGE("Could not list hals from hwservicemanager.\n");
1408 }
1409}
1410
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001411static void DumpExternalFragmentationInfo() {
1412 struct stat st;
1413 if (stat("/proc/buddyinfo", &st) != 0) {
1414 MYLOGE("Unable to dump external fragmentation info\n");
1415 return;
1416 }
1417
1418 printf("------ EXTERNAL FRAGMENTATION INFO ------\n");
1419 std::ifstream ifs("/proc/buddyinfo");
1420 auto unusable_index_regex = std::regex{"Node\\s+([0-9]+),\\s+zone\\s+(\\S+)\\s+(.*)"};
1421 for (std::string line; std::getline(ifs, line);) {
1422 std::smatch match_results;
1423 if (std::regex_match(line, match_results, unusable_index_regex)) {
1424 std::stringstream free_pages(std::string{match_results[3]});
1425 std::vector<int> free_pages_per_order(std::istream_iterator<int>{free_pages},
1426 std::istream_iterator<int>());
1427
1428 int total_free_pages = 0;
1429 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1430 total_free_pages += (free_pages_per_order[i] * std::pow(2, i));
1431 }
1432
1433 printf("Node %s, zone %8s", match_results[1].str().c_str(),
1434 match_results[2].str().c_str());
1435
1436 int usable_free_pages = total_free_pages;
1437 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1438 auto unusable_index = (total_free_pages - usable_free_pages) /
1439 static_cast<double>(total_free_pages);
1440 printf(" %5.3f", unusable_index);
1441 usable_free_pages -= (free_pages_per_order[i] * std::pow(2, i));
1442 }
1443
1444 printf("\n");
1445 }
1446 }
1447 printf("\n");
1448}
1449
mhasankd451a472020-05-26 18:02:39 -07001450static void DumpstateLimitedOnly() {
1451 // Trimmed-down version of dumpstate to only include a whitelisted
1452 // set of logs (system log, event log, and system server / system app
1453 // crashes, and networking logs). See b/136273873 and b/138459828
1454 // for context.
1455 DurationReporter duration_reporter("DUMPSTATE");
1456 unsigned long timeout_ms;
1457 // calculate timeout
1458 timeout_ms = logcat_timeout({"main", "system", "crash"});
1459 RunCommand("SYSTEM LOG",
1460 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1461 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1462 timeout_ms = logcat_timeout({"events"});
1463 RunCommand(
1464 "EVENT LOG",
1465 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1466 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1467
1468 printf("========================================================\n");
1469 printf("== Networking Service\n");
1470 printf("========================================================\n");
1471
1472 RunDumpsys("DUMPSYS NETWORK_SERVICE_LIMITED", {"wifi", "-a"},
1473 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hugo Benichiaa162682020-10-30 23:28:56 +09001474 RunDumpsys("DUMPSYS CONNECTIVITY REQUESTS", {"connectivity", "requests"},
1475 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
mhasankd451a472020-05-26 18:02:39 -07001476
1477 printf("========================================================\n");
1478 printf("== Dropbox crashes\n");
1479 printf("========================================================\n");
1480
1481 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1482 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1483
1484 printf("========================================================\n");
1485 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1486 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1487 printf("========================================================\n");
1488 printf("== dumpstate: done (id %d)\n", ds.id_);
1489 printf("========================================================\n");
1490}
1491
Rhed Jao6b1ea2d2020-07-21 17:58:41 +08001492/*
1493 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1494 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1495 * if it's not running in the parallel task.
1496 */
1497static void DumpCheckins(int out_fd = STDOUT_FILENO) {
1498 dprintf(out_fd, "========================================================\n");
1499 dprintf(out_fd, "== Checkins\n");
1500 dprintf(out_fd, "========================================================\n");
1501
1502 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"}, out_fd);
1503 RunDumpsys("CHECKIN MEMINFO", {"meminfo", "--checkin"}, out_fd);
1504 RunDumpsys("CHECKIN NETSTATS", {"netstats", "--checkin"}, out_fd);
1505 RunDumpsys("CHECKIN PROCSTATS", {"procstats", "-c"}, out_fd);
1506 RunDumpsys("CHECKIN USAGESTATS", {"usagestats", "-c"}, out_fd);
1507 RunDumpsys("CHECKIN PACKAGE", {"package", "--checkin"}, out_fd);
1508}
1509
1510/*
1511 * Runs dumpsys on activity service to dump all application activities, services
1512 * and providers in the device.
1513 *
1514 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1515 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1516 * if it's not running in the parallel task.
1517 */
1518static void DumpAppInfos(int out_fd = STDOUT_FILENO) {
1519 dprintf(out_fd, "========================================================\n");
1520 dprintf(out_fd, "== Running Application Activities\n");
1521 dprintf(out_fd, "========================================================\n");
1522
1523 // The following dumpsys internally collects output from running apps, so it can take a long
1524 // time. So let's extend the timeout.
1525
1526 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
1527
1528 RunDumpsys("APP ACTIVITIES", {"activity", "-v", "all"}, DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1529
1530 dprintf(out_fd, "========================================================\n");
1531 dprintf(out_fd, "== Running Application Services (platform)\n");
1532 dprintf(out_fd, "========================================================\n");
1533
1534 RunDumpsys("APP SERVICES PLATFORM", {"activity", "service", "all-platform-non-critical"},
1535 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1536
1537 dprintf(out_fd, "========================================================\n");
1538 dprintf(out_fd, "== Running Application Services (non-platform)\n");
1539 dprintf(out_fd, "========================================================\n");
1540
1541 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1542 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1543
1544 dprintf(out_fd, "========================================================\n");
1545 dprintf(out_fd, "== Running Application Providers (platform)\n");
1546 dprintf(out_fd, "========================================================\n");
1547
1548 RunDumpsys("APP PROVIDERS PLATFORM", {"activity", "provider", "all-platform"},
1549 DUMPSYS_COMPONENTS_OPTIONS, out_fd);
1550
1551 dprintf(out_fd, "========================================================\n");
1552 dprintf(out_fd, "== Running Application Providers (non-platform)\n");
1553 dprintf(out_fd, "========================================================\n");
1554
1555 RunDumpsys("APP PROVIDERS NON-PLATFORM", {"activity", "provider", "all-non-platform"},
1556 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1557}
1558
Nandana Dutt5c390032019-03-12 10:52:56 +00001559// Dumps various things. Returns early with status USER_CONSENT_DENIED if user denies consent
1560// via the consent they are shown. Ignores other errors that occur while running various
1561// commands. The consent checking is currently done around long running tasks, which happen to
1562// be distributed fairly evenly throughout the function.
1563static Dumpstate::RunStatus dumpstate() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001564 DurationReporter duration_reporter("DUMPSTATE");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001565
Rhed Jao4875aa62020-07-20 17:46:29 +08001566 // Enqueue slow functions into the thread pool, if the parallel run is enabled.
1567 if (ds.dump_pool_) {
1568 // Pool was shutdown in DumpstateDefaultAfterCritical method in order to
1569 // drop root user. Restarts it with two threads for the parallel run.
1570 ds.dump_pool_->start(/* thread_counts = */2);
1571
1572 ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
1573 ds.dump_pool_->enqueueTask(DUMP_INCIDENT_REPORT_TASK, &DumpIncidentReport);
1574 ds.dump_pool_->enqueueTaskWithFd(DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
Rhed Jao6b1ea2d2020-07-21 17:58:41 +08001575 ds.dump_pool_->enqueueTaskWithFd(DUMP_CHECKINS_TASK, &DumpCheckins, _1);
1576 ds.dump_pool_->enqueueTaskWithFd(DUMP_APP_INFOS_TASK, &DumpAppInfos, _1);
Rhed Jao4875aa62020-07-20 17:46:29 +08001577 }
1578
Nandana Dutt5c390032019-03-12 10:52:56 +00001579 // Dump various things. Note that anything that takes "long" (i.e. several seconds) should
1580 // check intermittently (if it's intrerruptable like a foreach on pids) and/or should be wrapped
1581 // in a consent check (via RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK).
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -07001582 dump_dev_files("TRUSTY VERSION", "/sys/bus/platform/drivers/trusty", "trusty_version");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001583 RunCommand("UPTIME", {"uptime"});
Wei Wang509bb5d2017-06-09 14:42:12 -07001584 DumpBlockStatFiles();
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001585 DumpFile("MEMORY INFO", "/proc/meminfo");
1586 RunCommand("CPU INFO", {"top", "-b", "-n", "1", "-H", "-s", "6", "-o",
Felipe Leme30dbfa12016-09-02 12:43:26 -07001587 "pid,tid,user,pr,ni,%cpu,s,virt,res,pcy,cmd,name"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001588
1589 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "PROCRANK", {"procrank"}, AS_ROOT_20);
1590
Sunny Goyal35949782019-11-19 15:54:36 -08001591 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpVisibleWindowViews);
1592
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001593 DumpFile("VIRTUAL MEMORY STATS", "/proc/vmstat");
1594 DumpFile("VMALLOC INFO", "/proc/vmallocinfo");
1595 DumpFile("SLAB INFO", "/proc/slabinfo");
1596 DumpFile("ZONEINFO", "/proc/zoneinfo");
1597 DumpFile("PAGETYPEINFO", "/proc/pagetypeinfo");
1598 DumpFile("BUDDYINFO", "/proc/buddyinfo");
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001599 DumpExternalFragmentationInfo();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001600
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001601 DumpFile("KERNEL WAKE SOURCES", "/d/wakeup_sources");
1602 DumpFile("KERNEL CPUFREQ", "/sys/devices/system/cpu/cpu0/cpufreq/stats/time_in_state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001603
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001604 RunCommand("PROCESSES AND THREADS",
Yohei Yukawa591a72d2017-10-05 21:36:35 -07001605 {"ps", "-A", "-T", "-Z", "-O", "pri,nice,rtprio,sched,pcy,time"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001606
1607 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "LIBRANK", {"librank"},
1608 CommandOptions::AS_ROOT);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001609
Rhed Jao4875aa62020-07-20 17:46:29 +08001610 if (ds.dump_pool_) {
1611 WAIT_TASK_WITH_CONSENT_CHECK(DUMP_HALS_TASK, ds.dump_pool_);
1612 } else {
1613 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_HALS_TASK, DumpHals);
1614 }
Steven Moreland81b429e2017-01-31 19:50:46 -08001615
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001616 RunCommand("PRINTENV", {"printenv"});
Elliott Hughes21b7c8d2016-10-28 08:53:02 -07001617 RunCommand("NETSTAT", {"netstat", "-nW"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001618 struct stat s;
1619 if (stat("/proc/modules", &s) != 0) {
1620 MYLOGD("Skipping 'lsmod' because /proc/modules does not exist\n");
1621 } else {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001622 RunCommand("LSMOD", {"lsmod"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001623 }
Michal Karpinski4db754f2015-12-11 18:04:32 +00001624
Tom Cherryb87dbfa2020-07-28 11:28:53 -07001625 if (android::base::GetBoolProperty("ro.logd.kernel", false)) {
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001626 DoKernelLogcat();
1627 } else {
1628 do_dmesg();
1629 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001630
Felipe Lemef0292972016-11-22 13:57:05 -08001631 RunCommand("LIST OF OPEN FILES", {"lsof"}, CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001632
1633 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(for_each_pid, do_showmap, "SMAPS OF ALL PROCESSES");
1634
Jeff Brown1dc94e32014-09-11 14:15:27 -07001635 for_each_tid(show_wchan, "BLOCKED PROCESS WAIT-CHANNELS");
Mark Salyzyna297c322016-02-05 15:33:17 -08001636 for_each_pid(show_showtime, "PROCESS TIMES (pid cmd user system iowait+percentage)");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001637
Ajay Panicker2ff8e872017-04-27 14:04:32 -07001638 /* Dump Bluetooth HCI logs */
1639 ds.AddDir("/data/misc/bluetooth/logs", true);
Jack Yu5a6b2e22020-08-14 18:13:35 +08001640 /* Dump Nfc NCI logs */
1641 ds.AddDir("/data/misc/nfc/logs", true);
Ajay Panickerd886ec42016-09-14 12:26:46 -07001642
Paul Chang0d2aad72020-02-13 20:04:03 +08001643 if (ds.options_->do_screenshot && !ds.do_early_screenshot_) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001644 MYLOGI("taking late screenshot\n");
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001645 ds.TakeScreenshot();
Jeff Sharkey5a930032013-03-19 15:05:19 -07001646 }
1647
Felipe Lemee184f662016-10-27 10:04:47 -07001648 AddAnrTraceFiles();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001649
Narayan Kamath8f788292017-05-25 13:20:39 +01001650 // NOTE: tombstones are always added as separate entries in the zip archive
1651 // and are not interspersed with the main report.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001652 const bool tombstones_dumped = AddDumps(ds.tombstone_data_.begin(), ds.tombstone_data_.end(),
Narayan Kamathbd863722017-06-01 18:50:12 +01001653 "TOMBSTONE", true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001654 if (!tombstones_dumped) {
1655 printf("*** NO TOMBSTONES to dump in %s\n\n", TOMBSTONE_DIR.c_str());
Christopher Ferris7dc7f322014-07-22 16:08:19 -07001656 }
1657
Jayachandran Ca94c7172017-06-10 15:08:12 -07001658 DumpPacketStats();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001659
Chenbo Feng276a3b62018-08-07 11:44:49 -07001660 RunDumpsys("EBPF MAP STATS", {"netd", "trafficcontroller"});
1661
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001662 DoKmsg();
Mark Salyzyn2262c162014-12-16 09:09:26 -08001663
Jayachandran Ca94c7172017-06-10 15:08:12 -07001664 DumpIpAddrAndRules();
Sreeram Ramachandran2b3bba32014-07-08 15:40:55 -07001665
1666 dump_route_tables();
1667
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001668 RunCommand("ARP CACHE", {"ip", "-4", "neigh", "show"});
1669 RunCommand("IPv6 ND CACHE", {"ip", "-6", "neigh", "show"});
1670 RunCommand("MULTICAST ADDRESSES", {"ip", "maddr"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001671
Nandana Dutt5c390032019-03-12 10:52:56 +00001672 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysHigh);
Lorenzo Colitti6afc38c2015-09-09 22:59:25 +09001673
Elliott Hughes23ccc622017-02-28 10:14:22 -08001674 RunCommand("SYSTEM PROPERTIES", {"getprop"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001675
Jin Qianf334d662017-10-10 14:41:37 -07001676 RunCommand("STORAGED IO INFO", {"storaged", "-u", "-p"});
ynwangf649a6e2016-07-17 21:56:00 -07001677
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001678 RunCommand("FILESYSTEMS & FREE SPACE", {"df"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001679
Colin Crossf45fa6b2012-03-26 12:38:26 -07001680 /* Binder state is expensive to look at as it uses a lot of memory. */
Hridya Valsaraju920ba712020-02-09 16:27:01 -08001681 std::string binder_logs_dir = access("/dev/binderfs/binder_logs", R_OK) ?
1682 "/sys/kernel/debug/binder" : "/dev/binderfs/binder_logs";
1683
1684 DumpFile("BINDER FAILED TRANSACTION LOG", binder_logs_dir + "/failed_transaction_log");
1685 DumpFile("BINDER TRANSACTION LOG", binder_logs_dir + "/transaction_log");
1686 DumpFile("BINDER TRANSACTIONS", binder_logs_dir + "/transactions");
1687 DumpFile("BINDER STATS", binder_logs_dir + "/stats");
1688 DumpFile("BINDER STATE", binder_logs_dir + "/state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001689
Vishnu Nair36b4cdb2017-11-17 10:27:05 -08001690 /* Add window and surface trace files. */
1691 if (!PropertiesHelper::IsUserBuild()) {
1692 ds.AddDir(WMTRACE_DATA_DIR, false);
1693 }
1694
Yifan Hongcba0a4f2020-02-08 16:52:02 -08001695 ds.AddDir(SNAPSHOTCTL_LOG_DIR, false);
1696
Rhed Jao4875aa62020-07-20 17:46:29 +08001697 if (ds.dump_pool_) {
1698 WAIT_TASK_WITH_CONSENT_CHECK(DUMP_BOARD_TASK, ds.dump_pool_);
1699 } else {
1700 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
1701 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001702
Steven Moreland7440ddb2016-12-15 16:13:39 -08001703 /* Migrate the ril_dumpstate to a device specific dumpstate? */
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001704 int rilDumpstateTimeout = android::base::GetIntProperty("ril.dumpstate.timeout", 0);
1705 if (rilDumpstateTimeout > 0) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001706 // su does not exist on user builds, so try running without it.
1707 // This way any implementations of vril-dump that do not require
1708 // root can run on user builds.
1709 CommandOptions::CommandOptionsBuilder options =
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001710 CommandOptions::WithTimeout(rilDumpstateTimeout);
Felipe Lemef0292972016-11-22 13:57:05 -08001711 if (!PropertiesHelper::IsUserBuild()) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001712 options.AsRoot();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001713 }
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001714 RunCommand("DUMP VENDOR RIL LOGS", {"vril-dump"}, options.Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -07001715 }
1716
Felipe Lemed8b94e52016-12-08 10:21:44 -08001717 printf("========================================================\n");
1718 printf("== Android Framework Services\n");
1719 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001720
Nandana Dutt5c390032019-03-12 10:52:56 +00001721 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysNormal);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001722
Rhed Jao6b1ea2d2020-07-21 17:58:41 +08001723 if (ds.dump_pool_) {
1724 WAIT_TASK_WITH_CONSENT_CHECK(DUMP_CHECKINS_TASK, ds.dump_pool_);
1725 } else {
1726 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_CHECKINS_TASK, DumpCheckins);
1727 }
Dianne Hackborn02bea972013-06-26 18:59:09 -07001728
Rhed Jao6b1ea2d2020-07-21 17:58:41 +08001729 if (ds.dump_pool_) {
1730 WAIT_TASK_WITH_CONSENT_CHECK(DUMP_APP_INFOS_TASK, ds.dump_pool_);
1731 } else {
1732 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_APP_INFOS_TASK, DumpAppInfos);
1733 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001734
Adrian Roos8b397ab2017-04-04 16:35:44 -07001735 printf("========================================================\n");
1736 printf("== Dropbox crashes\n");
1737 printf("========================================================\n");
1738
1739 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1740 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1741
Felipe Lemed8b94e52016-12-08 10:21:44 -08001742 printf("========================================================\n");
1743 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1744 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1745 printf("========================================================\n");
1746 printf("== dumpstate: done (id %d)\n", ds.id_);
1747 printf("========================================================\n");
Bookatz38472142018-09-28 10:20:24 -07001748
1749 printf("========================================================\n");
1750 printf("== Obtaining statsd metadata\n");
1751 printf("========================================================\n");
1752 // This differs from the usual dumpsys stats, which is the stats report data.
1753 RunDumpsys("STATSDSTATS", {"stats", "--metadata"});
Mike Ma5c267872019-08-21 11:31:34 -07001754
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +09001755 // Add linker configuration directory
1756 ds.AddDir(LINKERCONFIG_DIR, true);
1757
Rhed Jao4875aa62020-07-20 17:46:29 +08001758 if (ds.dump_pool_) {
1759 WAIT_TASK_WITH_CONSENT_CHECK(DUMP_INCIDENT_REPORT_TASK, ds.dump_pool_);
1760 } else {
1761 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_INCIDENT_REPORT_TASK,
1762 DumpIncidentReport);
1763 }
Mike Ma5c267872019-08-21 11:31:34 -07001764
Nandana Dutt5c390032019-03-12 10:52:56 +00001765 return Dumpstate::RunStatus::OK;
Colin Crossf45fa6b2012-03-26 12:38:26 -07001766}
1767
Nandana Dutt5c390032019-03-12 10:52:56 +00001768/*
1769 * Dumps state for the default case; drops root after it's no longer necessary.
1770 *
1771 * Returns RunStatus::OK if everything went fine.
1772 * Returns RunStatus::ERROR if there was an error.
1773 * Returns RunStatus::USER_DENIED_CONSENT if user explicitly denied consent to sharing the bugreport
1774 * with the caller.
1775 */
Jichao Lie89d9c12019-11-21 19:02:51 -08001776Dumpstate::RunStatus Dumpstate::DumpstateDefaultAfterCritical() {
Nandana Duttdb379fa2019-10-09 16:54:41 +01001777 // Capture first logcat early on; useful to take a snapshot before dumpstate logs take over the
1778 // buffer.
1779 DoLogcat();
1780 // Capture timestamp after first logcat to use in next logcat
1781 time_t logcat_ts = time(nullptr);
1782
Nandana Dutt4be45d12018-09-26 15:04:23 +01001783 /* collect stack traces from Dalvik and native processes (needs root) */
Rhed Jao1c855122020-07-16 17:37:39 +08001784 if (dump_pool_) {
1785 RETURN_IF_USER_DENIED_CONSENT();
1786 // One thread is enough since we only need to enqueue DumpTraces here.
1787 dump_pool_->start(/* thread_counts = */1);
1788
1789 // DumpTraces takes long time, post it to the another thread in the
1790 // pool, if pool is available
1791 dump_pool_->enqueueTask(DUMP_TRACES_TASK, &Dumpstate::DumpTraces, &ds, &dump_traces_path);
1792 } else {
1793 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_TRACES_TASK, ds.DumpTraces,
1794 &dump_traces_path);
1795 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001796
1797 /* Run some operations that require root. */
1798 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX, !ds.IsZipping());
1799 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX, !ds.IsZipping());
1800
1801 ds.AddDir(RECOVERY_DIR, true);
1802 ds.AddDir(RECOVERY_DATA_DIR, true);
1803 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
1804 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1805 if (!PropertiesHelper::IsUserBuild()) {
1806 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1807 ds.AddDir(PROFILE_DATA_DIR_REF, true);
Calin Juravle78a0d842020-04-28 15:31:12 -07001808 ds.AddZipEntry(ZIP_ROOT_DIR + PACKAGE_DEX_USE_LIST, PACKAGE_DEX_USE_LIST);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001809 }
Jerry Changa1df8a92020-01-02 16:03:39 +08001810 ds.AddDir(PREREBOOT_DATA_DIR, false);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001811 add_mountinfo();
1812 DumpIpTablesAsRoot();
David Andersond9ba4752018-12-11 18:26:59 -08001813 DumpDynamicPartitionInfo();
Yifan Hong3945e1b2019-10-29 12:59:23 -07001814 ds.AddDir(OTA_METADATA_DIR, true);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001815
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001816 // Capture any IPSec policies in play. No keys are exposed here.
Nandana Dutt4be45d12018-09-26 15:04:23 +01001817 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1818
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001819 // Dump IPsec stats. No keys are exposed here.
1820 DumpFile("XFRM STATS", XFRM_STAT_PROC_FILE);
1821
Nandana Dutt4be45d12018-09-26 15:04:23 +01001822 // Run ss as root so we can see socket marks.
1823 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
1824
1825 // Run iotop as root to show top 100 IO threads
1826 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
1827
Erick Reyese68df822019-02-11 14:46:36 -08001828 // Gather shared memory buffer info if the product implements it
1829 struct stat st;
1830 if (!stat("/product/bin/dmabuf_dump", &st)) {
1831 RunCommand("Dmabuf dump", {"/product/bin/dmabuf_dump"});
1832 }
1833
Minchan Kim22c6a1e2019-09-30 15:58:10 -07001834 DumpFile("PSI cpu", "/proc/pressure/cpu");
1835 DumpFile("PSI memory", "/proc/pressure/memory");
1836 DumpFile("PSI io", "/proc/pressure/io");
1837
Rhed Jao1c855122020-07-16 17:37:39 +08001838 if (dump_pool_) {
1839 RETURN_IF_USER_DENIED_CONSENT();
1840 dump_pool_->waitForTask(DUMP_TRACES_TASK);
1841
1842 // Current running thread in the pool is the root user also. Shutdown
1843 // the pool and restart later to ensure all threads in the pool could
1844 // drop the root user.
1845 dump_pool_->shutdown();
1846 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001847 if (!DropRootUser()) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001848 return Dumpstate::RunStatus::ERROR;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001849 }
1850
Nandana Dutt5c390032019-03-12 10:52:56 +00001851 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttdb379fa2019-10-09 16:54:41 +01001852 Dumpstate::RunStatus status = dumpstate();
1853 // Capture logcat since the last time we did it.
1854 DoSystemLogcat(logcat_ts);
1855 return status;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001856}
1857
Rhed Jaoa5de5752020-08-14 17:19:17 +08001858// Common states for telephony and wifi which are needed to be collected before
1859// dumpstate drop the root user.
1860static void DumpstateRadioAsRoot() {
1861 DumpIpTablesAsRoot();
1862 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1863}
1864
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001865// This method collects common dumpsys for telephony and wifi. Typically, wifi
1866// reports are fine to include all information, but telephony reports on user
1867// builds need to strip some content (see DumpstateTelephonyOnly).
1868static void DumpstateRadioCommon(bool include_sensitive_info = true) {
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001869 // We need to be picky about some stuff for telephony reports on user builds.
1870 if (!include_sensitive_info) {
1871 // Only dump the radio log buffer (other buffers and dumps contain too much unrelated info).
1872 DoRadioLogcat();
1873 } else {
Rhed Jaoa5de5752020-08-14 17:19:17 +08001874 // DumpHals takes long time, post it to the another thread in the pool,
1875 // if pool is available.
1876 if (ds.dump_pool_) {
1877 ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
1878 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001879 // Contains various system properties and process startup info.
1880 do_dmesg();
1881 // Logs other than the radio buffer may contain package/component names and potential PII.
1882 DoLogcat();
1883 // Too broad for connectivity problems.
1884 DoKmsg();
Rhed Jaoa5de5752020-08-14 17:19:17 +08001885 // DumpHals contains unrelated hardware info (camera, NFC, biometrics, ...).
1886 if (ds.dump_pool_) {
1887 ds.dump_pool_->waitForTask(DUMP_HALS_TASK);
1888 } else {
1889 RUN_SLOW_FUNCTION_AND_LOG(DUMP_HALS_TASK, DumpHals);
1890 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001891 }
1892
Jayachandran Ca94c7172017-06-10 15:08:12 -07001893 DumpPacketStats();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001894 DumpIpAddrAndRules();
1895 dump_route_tables();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001896 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
1897 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08001898}
1899
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001900// We use "telephony" here for legacy reasons, though this now really means "connectivity" (cellular
1901// + wifi + networking). This method collects dumpsys for connectivity debugging only. General rules
1902// for what can be included on user builds: all reported information MUST directly relate to
1903// connectivity debugging or customer support and MUST NOT contain unrelated personally identifiable
1904// information. This information MUST NOT identify user-installed packages (UIDs are OK, package
1905// names are not), and MUST NOT contain logs of user application traffic.
1906// TODO(b/148168577) rename this and other related fields/methods to "connectivity" instead.
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08001907static void DumpstateTelephonyOnly(const std::string& calling_package) {
mukesh agrawal253dad42018-01-23 21:59:59 -08001908 DurationReporter duration_reporter("DUMPSTATE");
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001909
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001910 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08001911
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001912 const bool include_sensitive_info = !PropertiesHelper::IsUserBuild();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001913
Rhed Jaoa5de5752020-08-14 17:19:17 +08001914 DumpstateRadioAsRoot();
1915 if (!DropRootUser()) {
1916 return;
1917 }
1918
1919 // Starts thread pool after the root user is dropped, and two additional threads
1920 // are created for DumpHals in the DumpstateRadioCommon and DumpstateBoard.
1921 if (ds.dump_pool_) {
1922 ds.dump_pool_->start(/*thread_counts =*/2);
1923
1924 // DumpstateBoard takes long time, post it to the another thread in the pool,
1925 // if pool is available.
1926 ds.dump_pool_->enqueueTaskWithFd(DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
1927 }
1928
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001929 DumpstateRadioCommon(include_sensitive_info);
1930
1931 if (include_sensitive_info) {
1932 // Contains too much unrelated PII, and given the unstructured nature of sysprops, we can't
1933 // really cherrypick all of the connectivity-related ones. Apps generally have no business
1934 // reading these anyway, and there should be APIs to supply the info in a more app-friendly
1935 // way.
1936 RunCommand("SYSTEM PROPERTIES", {"getprop"});
1937 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07001938
1939 printf("========================================================\n");
1940 printf("== Android Framework Services\n");
1941 printf("========================================================\n");
1942
Vishnu Nair652cc802017-11-30 15:18:30 -08001943 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1944 SEC_TO_MSEC(10));
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08001945 if (include_sensitive_info) {
1946 // Carrier apps' services will be dumped below in dumpsys activity service all-non-platform.
1947 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
1948 SEC_TO_MSEC(10));
1949 } else {
1950 // If the caller is a carrier app and has a carrier service, dump it here since we aren't
1951 // running dumpsys activity service all-non-platform below. Due to the increased output, we
1952 // give a higher timeout as well.
1953 RunDumpsys("DUMPSYS", {"carrier_config", "--requesting-package", calling_package},
1954 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(30));
1955 }
1956 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001957 RunDumpsys("DUMPSYS", {"netpolicy"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
1958 RunDumpsys("DUMPSYS", {"network_management"}, CommandOptions::WithTimeout(90).Build(),
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07001959 SEC_TO_MSEC(10));
Hunter Knepshield0fe51b12020-03-05 16:58:20 -08001960 RunDumpsys("DUMPSYS", {"telephony.registry"}, CommandOptions::WithTimeout(90).Build(),
1961 SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001962 if (include_sensitive_info) {
1963 // Contains raw IP addresses, omit from reports on user builds.
1964 RunDumpsys("DUMPSYS", {"netd"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
1965 // Contains raw destination IP/MAC addresses, omit from reports on user builds.
1966 RunDumpsys("DUMPSYS", {"connmetrics"}, CommandOptions::WithTimeout(90).Build(),
1967 SEC_TO_MSEC(10));
1968 // Contains package/component names, omit from reports on user builds.
1969 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
1970 SEC_TO_MSEC(10));
1971 // Contains package names, but should be relatively simple to remove them (also contains
1972 // UIDs already), omit from reports on user builds.
1973 RunDumpsys("BATTERYSTATS", {"deviceidle"}, CommandOptions::WithTimeout(90).Build(),
1974 SEC_TO_MSEC(10));
1975 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07001976
1977 printf("========================================================\n");
1978 printf("== Running Application Services\n");
1979 printf("========================================================\n");
1980
1981 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
1982
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001983 if (include_sensitive_info) {
1984 printf("========================================================\n");
1985 printf("== Running Application Services (non-platform)\n");
1986 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001987
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001988 // Contains package/component names and potential PII, omit from reports on user builds.
1989 // To get dumps of the active CarrierService(s) on user builds, we supply an argument to the
1990 // carrier_config dumpsys instead.
1991 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1992 DUMPSYS_COMPONENTS_OPTIONS);
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001993
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001994 printf("========================================================\n");
1995 printf("== Checkins\n");
1996 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07001997
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001998 // Contains package/component names, omit from reports on user builds.
1999 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
2000 }
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002001
2002 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07002003 printf("== dumpstate: done (id %d)\n", ds.id_);
2004 printf("========================================================\n");
Rhed Jaoa5de5752020-08-14 17:19:17 +08002005
2006 if (ds.dump_pool_) {
2007 ds.dump_pool_->waitForTask(DUMP_BOARD_TASK);
2008 } else {
2009 RUN_SLOW_FUNCTION_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
2010 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002011}
2012
mukesh agrawal253dad42018-01-23 21:59:59 -08002013// This method collects dumpsys for wifi debugging only
2014static void DumpstateWifiOnly() {
2015 DurationReporter duration_reporter("DUMPSTATE");
2016
Rhed Jaoa5de5752020-08-14 17:19:17 +08002017 DumpstateRadioAsRoot();
2018 if (!DropRootUser()) {
2019 return;
2020 }
2021
2022 // Starts thread pool after the root user is dropped. Only one additional
2023 // thread is needed for DumpHals in the DumpstateRadioCommon.
2024 if (ds.dump_pool_) {
2025 ds.dump_pool_->start(/*thread_counts =*/1);
2026 }
2027
mukesh agrawal253dad42018-01-23 21:59:59 -08002028 DumpstateRadioCommon();
2029
2030 printf("========================================================\n");
2031 printf("== Android Framework Services\n");
2032 printf("========================================================\n");
2033
2034 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
2035 SEC_TO_MSEC(10));
2036 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
2037 SEC_TO_MSEC(10));
2038
2039 printf("========================================================\n");
2040 printf("== dumpstate: done (id %d)\n", ds.id_);
2041 printf("========================================================\n");
2042}
2043
Nandana Duttcf419a72019-03-14 10:40:17 +00002044Dumpstate::RunStatus Dumpstate::DumpTraces(const char** path) {
Nandana Duttfaafd522019-03-11 09:23:09 +00002045 const std::string temp_file_pattern = "/data/anr/dumptrace_XXXXXX";
2046 const size_t buf_size = temp_file_pattern.length() + 1;
2047 std::unique_ptr<char[]> file_name_buf(new char[buf_size]);
2048 memcpy(file_name_buf.get(), temp_file_pattern.c_str(), buf_size);
2049
2050 // Create a new, empty file to receive all trace dumps.
2051 //
2052 // TODO: This can be simplified once we remove support for the old style
2053 // dumps. We can have a file descriptor passed in to dump_traces instead
2054 // of creating a file, closing it and then reopening it again.
2055 android::base::unique_fd fd(mkostemp(file_name_buf.get(), O_APPEND | O_CLOEXEC));
2056 if (fd < 0) {
2057 MYLOGE("mkostemp on pattern %s: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002058 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002059 }
2060
2061 // Nobody should have access to this temporary file except dumpstate, but we
2062 // temporarily grant 'read' to 'others' here because this file is created
2063 // when tombstoned is still running as root, but dumped after dropping. This
2064 // can go away once support for old style dumping has.
2065 const int chmod_ret = fchmod(fd, 0666);
2066 if (chmod_ret < 0) {
2067 MYLOGE("fchmod on %s failed: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002068 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002069 }
2070
2071 std::unique_ptr<DIR, decltype(&closedir)> proc(opendir("/proc"), closedir);
2072 if (proc.get() == nullptr) {
2073 MYLOGE("opendir /proc failed: %s\n", strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002074 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002075 }
2076
2077 // Number of times process dumping has timed out. If we encounter too many
2078 // failures, we'll give up.
2079 int timeout_failures = 0;
2080 bool dalvik_found = false;
2081
2082 const std::set<int> hal_pids = get_interesting_hal_pids();
2083
2084 struct dirent* d;
2085 while ((d = readdir(proc.get()))) {
Nandana Duttcf419a72019-03-14 10:40:17 +00002086 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttfaafd522019-03-11 09:23:09 +00002087 int pid = atoi(d->d_name);
2088 if (pid <= 0) {
2089 continue;
2090 }
2091
2092 const std::string link_name = android::base::StringPrintf("/proc/%d/exe", pid);
2093 std::string exe;
2094 if (!android::base::Readlink(link_name, &exe)) {
2095 continue;
2096 }
2097
2098 bool is_java_process;
2099 if (exe == "/system/bin/app_process32" || exe == "/system/bin/app_process64") {
2100 // Don't bother dumping backtraces for the zygote.
2101 if (IsZygote(pid)) {
2102 continue;
2103 }
2104
2105 dalvik_found = true;
2106 is_java_process = true;
2107 } else if (should_dump_native_traces(exe.c_str()) || hal_pids.find(pid) != hal_pids.end()) {
2108 is_java_process = false;
2109 } else {
2110 // Probably a native process we don't care about, continue.
2111 continue;
2112 }
2113
2114 // If 3 backtrace dumps fail in a row, consider debuggerd dead.
2115 if (timeout_failures == 3) {
2116 dprintf(fd, "ERROR: Too many stack dump failures, exiting.\n");
2117 break;
2118 }
2119
2120 const uint64_t start = Nanotime();
2121 const int ret = dump_backtrace_to_file_timeout(
2122 pid, is_java_process ? kDebuggerdJavaBacktrace : kDebuggerdNativeBacktrace,
2123 is_java_process ? 5 : 20, fd);
2124
2125 if (ret == -1) {
2126 // For consistency, the header and footer to this message match those
2127 // dumped by debuggerd in the success case.
2128 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
2129 dprintf(fd, "Dump failed, likely due to a timeout.\n");
2130 dprintf(fd, "---- end %d ----", pid);
2131 timeout_failures++;
2132 continue;
2133 }
2134
2135 // We've successfully dumped stack traces, reset the failure count
2136 // and write a summary of the elapsed time to the file and continue with the
2137 // next process.
2138 timeout_failures = 0;
2139
2140 dprintf(fd, "[dump %s stack %d: %.3fs elapsed]\n", is_java_process ? "dalvik" : "native",
2141 pid, (float)(Nanotime() - start) / NANOS_PER_SEC);
2142 }
2143
2144 if (!dalvik_found) {
2145 MYLOGE("Warning: no Dalvik processes found to dump stacks\n");
2146 }
2147
Nandana Duttcf419a72019-03-14 10:40:17 +00002148 *path = file_name_buf.release();
2149 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002150}
2151
Rhed Jao4875aa62020-07-20 17:46:29 +08002152void Dumpstate::DumpstateBoard(int out_fd) {
2153 dprintf(out_fd, "========================================================\n");
2154 dprintf(out_fd, "== Board\n");
2155 dprintf(out_fd, "========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08002156
Felipe Leme6f674ae2016-11-18 17:10:33 -08002157 if (!IsZipping()) {
Steven Moreland7440ddb2016-12-15 16:13:39 -08002158 MYLOGD("Not dumping board info because it's not a zipped bugreport\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08002159 return;
2160 }
2161
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002162 std::vector<std::string> paths;
2163 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07002164 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002165 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
2166 kDumpstateBoardFiles[i].c_str()));
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002167 remover.emplace_back(android::base::make_scope_guard(
2168 std::bind([](std::string path) { android::os::UnlinkAndLogOnError(path); }, paths[i])));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002169 }
Jie Song9fbfad02017-06-20 16:29:42 -07002170
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002171 sp<IDumpstateDevice_1_0> dumpstate_device_1_0(IDumpstateDevice_1_0::getService());
2172 if (dumpstate_device_1_0 == nullptr) {
Wei Wang587eac92018-04-05 12:17:20 -07002173 MYLOGE("No IDumpstateDevice implementation\n");
2174 return;
2175 }
2176
2177 using ScopedNativeHandle =
2178 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
2179 ScopedNativeHandle handle(native_handle_create(static_cast<int>(paths.size()), 0),
2180 [](native_handle_t* handle) {
2181 native_handle_close(handle);
2182 native_handle_delete(handle);
2183 });
2184 if (handle == nullptr) {
2185 MYLOGE("Could not create native_handle\n");
2186 return;
2187 }
2188
Nandana Dutt5c390032019-03-12 10:52:56 +00002189 // TODO(128270426): Check for consent in between?
Wei Wang587eac92018-04-05 12:17:20 -07002190 for (size_t i = 0; i < paths.size(); i++) {
2191 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
2192
2193 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
2194 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
2195 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
2196 if (fd < 0) {
2197 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
2198 return;
2199 }
2200 handle.get()->data[i] = fd.release();
2201 }
2202
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002203 // Given that bugreport is required to diagnose failures, it's better to set an arbitrary amount
2204 // of timeout for IDumpstateDevice than to block the rest of bugreport. In the timeout case, we
2205 // will kill the HAL and grab whatever it dumped in time.
2206 constexpr size_t timeout_sec = 30;
2207 // Prefer version 1.1 if available. New devices launching with R are no longer allowed to
2208 // implement just 1.0.
2209 const char* descriptor_to_kill;
2210 using DumpstateBoardTask = std::packaged_task<bool()>;
2211 DumpstateBoardTask dumpstate_board_task;
2212 sp<IDumpstateDevice_1_1> dumpstate_device_1_1(
2213 IDumpstateDevice_1_1::castFrom(dumpstate_device_1_0));
2214 if (dumpstate_device_1_1 != nullptr) {
2215 MYLOGI("Using IDumpstateDevice v1.1");
2216 descriptor_to_kill = IDumpstateDevice_1_1::descriptor;
2217 dumpstate_board_task = DumpstateBoardTask([this, dumpstate_device_1_1, &handle]() -> bool {
2218 ::android::hardware::Return<DumpstateStatus> status =
2219 dumpstate_device_1_1->dumpstateBoard_1_1(handle.get(), options_->dumpstate_hal_mode,
2220 SEC_TO_MSEC(timeout_sec));
2221 if (!status.isOk()) {
2222 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2223 return false;
2224 } else if (status != DumpstateStatus::OK) {
2225 MYLOGE("dumpstateBoard failed with DumpstateStatus::%s\n", toString(status).c_str());
2226 return false;
2227 }
2228 return true;
2229 });
2230 } else {
2231 MYLOGI("Using IDumpstateDevice v1.0");
2232 descriptor_to_kill = IDumpstateDevice_1_0::descriptor;
2233 dumpstate_board_task = DumpstateBoardTask([dumpstate_device_1_0, &handle]() -> bool {
2234 ::android::hardware::Return<void> status =
2235 dumpstate_device_1_0->dumpstateBoard(handle.get());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002236 if (!status.isOk()) {
2237 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
Wei Wang587eac92018-04-05 12:17:20 -07002238 return false;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002239 }
Wei Wang587eac92018-04-05 12:17:20 -07002240 return true;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002241 });
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002242 }
2243 auto result = dumpstate_board_task.get_future();
2244 std::thread(std::move(dumpstate_board_task)).detach();
Wei Wang587eac92018-04-05 12:17:20 -07002245
Wei Wang587eac92018-04-05 12:17:20 -07002246 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2247 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate vendor HAL\n", timeout_sec);
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002248 if (!android::base::SetProperty(
2249 "ctl.interface_restart",
2250 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
Wei Wang587eac92018-04-05 12:17:20 -07002251 MYLOGE("Couldn't restart dumpstate HAL\n");
2252 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002253 }
Wei Wang587eac92018-04-05 12:17:20 -07002254 // Wait some time for init to kill dumpstate vendor HAL
2255 constexpr size_t killing_timeout_sec = 10;
2256 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2257 MYLOGE("killing dumpstateBoard timed out after %zus, continue and "
2258 "there might be racing in content\n", killing_timeout_sec);
2259 }
2260
2261 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
2262 for (size_t i = 0; i < paths.size(); i++) {
2263 struct stat s;
2264 if (fstat(handle.get()->data[i], &s) == -1) {
2265 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(),
2266 strerror(errno));
2267 file_sizes[i] = -1;
2268 continue;
2269 }
2270 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002271 }
2272
2273 for (size_t i = 0; i < paths.size(); i++) {
2274 if (file_sizes[i] == -1) {
2275 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002276 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002277 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07002278 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002279 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002280 }
Rhed Jao4875aa62020-07-20 17:46:29 +08002281 remover[i].Disable();
2282 EnqueueAddZipEntryAndCleanupIfNeeded(kDumpstateBoardFiles[i], paths[i]);
2283 dprintf(out_fd, "*** See %s entry ***\n", kDumpstateBoardFiles[i].c_str());
Jie Song9fbfad02017-06-20 16:29:42 -07002284 }
Felipe Leme6f674ae2016-11-18 17:10:33 -08002285}
2286
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002287static void ShowUsage() {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002288 fprintf(stderr,
mhasank2d75c442020-06-11 15:05:25 -07002289 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-o directory] [-d] [-p] "
mhasankd451a472020-05-26 18:02:39 -07002290 "[-z] [-s] [-S] [-q] [-P] [-R] [-L] [-V version]\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002291 " -h: display this help message\n"
2292 " -b: play sound file instead of vibrate, at beginning of job\n"
2293 " -e: play sound file instead of vibrate, at end of job\n"
mhasank2d75c442020-06-11 15:05:25 -07002294 " -o: write to custom directory (only in limited mode)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01002295 " -d: append date to filename\n"
2296 " -p: capture screenshot to filename.png\n"
2297 " -z: generate zipped file\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002298 " -s: write output to control socket (for init)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01002299 " -S: write file location to control socket (for init; requires -z)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002300 " -q: disable vibrate\n"
Abhijeet Kaure370d682019-10-01 16:49:30 +01002301 " -P: send broadcast when started and do progress updates\n"
2302 " -R: take bugreport in remote mode (requires -z and -d, shouldn't be used with -P)\n"
Nandana Dutt235864b2019-01-22 12:10:16 +00002303 " -w: start binder service and make it wait for a call to startBugreport\n"
mhasankd451a472020-05-26 18:02:39 -07002304 " -L: output limited information that is safe for submission in feedback reports\n"
Felipe Lemed071c682016-10-20 16:48:00 -07002305 " -v: prints the dumpstate header and exit\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002306}
2307
Wei Liuf87959e2016-08-26 14:51:42 -07002308static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07002309 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07002310}
2311
Felipe Leme1d486fe2016-10-14 18:06:47 -07002312bool Dumpstate::FinishZipFile() {
Rhed Jao4875aa62020-07-20 17:46:29 +08002313 // Runs all enqueued adding zip entry and cleanup tasks before finishing the zip file.
2314 if (zip_entry_tasks_) {
2315 zip_entry_tasks_->run(/* do_cancel = */false);
2316 }
2317
Felipe Leme9a523ae2016-10-20 15:10:33 -07002318 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07002319 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07002320 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002321 // Final timestamp
2322 char date[80];
2323 time_t the_real_now_please_stand_up = time(nullptr);
2324 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002325 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07002326 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002327
Felipe Leme9a523ae2016-10-20 15:10:33 -07002328 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002329 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08002330 return false;
2331 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07002332 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002333 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08002334 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08002335 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08002336
Felipe Leme0f3fb202016-06-10 17:10:53 -07002337 // Add log file (which contains stderr output) to zip...
2338 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07002339 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07002340 MYLOGE("Failed to add dumpstate log to .zip file\n");
2341 return false;
2342 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002343 // TODO: Should truncate the existing file.
2344 // ... and re-open it for further logging.
Nandana Dutta344cb62019-02-22 15:12:35 +00002345 if (!redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()))) {
2346 return false;
2347 }
Felipe Leme0f3fb202016-06-10 17:10:53 -07002348 fprintf(stderr, "\n");
2349
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002350 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07002351 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002352 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002353 return false;
2354 }
2355
Felipe Leme1d486fe2016-10-14 18:06:47 -07002356 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
2357 ds.zip_file.reset(nullptr);
2358
Felipe Lemee9d2c542016-11-15 11:48:26 -08002359 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002360 android::os::UnlinkAndLogOnError(tmp_path_);
Felipe Lemec4eee562016-04-21 15:42:55 -07002361
Felipe Leme1e9edc62015-12-21 16:02:13 -08002362 return true;
2363}
Felipe Leme6e01fa62015-11-11 19:35:14 -08002364
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002365static void SendBroadcast(const std::string& action, const std::vector<std::string>& args) {
2366 // clang-format off
2367 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user", "0",
2368 "--receiver-foreground", "--receiver-include-background", "-a", action};
2369 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08002370
2371 am.insert(am.end(), args.begin(), args.end());
2372
Felipe Leme8d2410e2017-02-08 09:46:08 -08002373 RunCommand("", am,
2374 CommandOptions::WithTimeout(20)
2375 .Log("Sending broadcast: '%s'\n")
2376 .Always()
2377 .DropRoot()
2378 .RedirectStderr()
2379 .Build());
2380}
2381
Felipe Leme35b8cf12017-02-10 15:47:29 -08002382static void Vibrate(int duration_ms) {
2383 // clang-format off
Chris Fries0c3de872019-09-14 15:49:41 +00002384 RunCommand("", {"cmd", "vibrator", "vibrate", "-f", std::to_string(duration_ms), "dumpstate"},
Felipe Leme35b8cf12017-02-10 15:47:29 -08002385 CommandOptions::WithTimeout(10)
2386 .Log("Vibrate: '%s'\n")
2387 .Always()
2388 .Build());
2389 // clang-format on
2390}
2391
Nandana Dutt979388e2018-11-30 16:48:55 +00002392static void MaybeResolveSymlink(std::string* path) {
2393 std::string resolved_path;
2394 if (android::base::Readlink(*path, &resolved_path)) {
2395 *path = resolved_path;
2396 }
2397}
2398
Nandana Dutt4be45d12018-09-26 15:04:23 +01002399/*
2400 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
2401 * if we are writing zip files and adds the version file.
2402 */
2403static void PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002404 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
2405
Nandana Dutt4be45d12018-09-26 15:04:23 +01002406 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
2407 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002408 ds.base_name_ = StringPrintf("bugreport-%s-%s", device_name.c_str(), build_id.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002409 if (ds.options_->do_add_date) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002410 char date[80];
2411 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
2412 ds.name_ = date;
2413 } else {
2414 ds.name_ = "undated";
2415 }
2416
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002417 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002418 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002419 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002420 ds.base_name_ += "-wifi";
2421 }
2422
Paul Chang0d2aad72020-02-13 20:04:03 +08002423 if (ds.options_->do_screenshot) {
Nandana Dutt9d17b942020-03-26 10:02:59 +00002424 ds.screenshot_path_ = ds.GetPath(ds.CalledByApi() ? "-png.tmp" : ".png");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002425 }
2426 ds.tmp_path_ = ds.GetPath(".tmp");
2427 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
2428
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002429 std::string destination = ds.CalledByApi()
Nandana Dutt54dbd672019-01-11 12:58:05 +00002430 ? StringPrintf("[fd:%d]", ds.options_->bugreport_fd.get())
Nandana Dutt9a76d202019-01-21 15:56:48 +00002431 : ds.bugreport_internal_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01002432 MYLOGD(
Nandana Dutt235c6672019-11-14 15:22:32 +00002433 "Bugreport dir: [%s] "
2434 "Base name: [%s] "
2435 "Suffix: [%s] "
2436 "Log path: [%s] "
2437 "Temporary path: [%s] "
2438 "Screenshot path: [%s]\n",
Nandana Dutt9a76d202019-01-21 15:56:48 +00002439 destination.c_str(), ds.base_name_.c_str(), ds.name_.c_str(), ds.log_path_.c_str(),
2440 ds.tmp_path_.c_str(), ds.screenshot_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002441
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002442 if (ds.options_->do_zip_file) {
Nandana Dutt9d17b942020-03-26 10:02:59 +00002443 ds.path_ = ds.GetPath(ds.CalledByApi() ? "-zip.tmp" : ".zip");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002444 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
2445 create_parent_dirs(ds.path_.c_str());
2446 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
2447 if (ds.zip_file == nullptr) {
2448 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
2449 } else {
2450 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
2451 }
2452 ds.AddTextZipEntry("version.txt", ds.version_);
2453 }
2454}
2455
2456/*
Abhijeet Kaure370d682019-10-01 16:49:30 +01002457 * Finalizes writing to the file by zipping the tmp file to the final location,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002458 * printing zipped file status, etc.
2459 */
2460static void FinalizeFile() {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002461 bool do_text_file = true;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002462 if (ds.options_->do_zip_file) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002463 if (!ds.FinishZipFile()) {
2464 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
2465 do_text_file = true;
2466 } else {
2467 do_text_file = false;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002468 }
2469 }
mhasank2d75c442020-06-11 15:05:25 -07002470
2471 std::string final_path = ds.path_;
2472 if (ds.options_->OutputToCustomFile()) {
mhasank3a4cfb42020-06-15 18:06:43 -07002473 final_path = ds.GetPath(ds.options_->out_dir, ".zip");
mhasank2d75c442020-06-11 15:05:25 -07002474 android::os::CopyFileToFile(ds.path_, final_path);
Nandana Dutt4be45d12018-09-26 15:04:23 +01002475 }
mhasank2d75c442020-06-11 15:05:25 -07002476
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002477 if (ds.options_->use_control_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002478 if (do_text_file) {
2479 dprintf(ds.control_socket_fd_,
2480 "FAIL:could not create zip file, check %s "
2481 "for more details\n",
2482 ds.log_path_.c_str());
2483 } else {
mhasank2d75c442020-06-11 15:05:25 -07002484 dprintf(ds.control_socket_fd_, "OK:%s\n", final_path.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002485 }
2486 }
2487}
2488
Nandana Dutt4be45d12018-09-26 15:04:23 +01002489
Nandana Dutt58d72e22018-11-16 10:30:48 +00002490static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2491 switch (mode) {
2492 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2493 return "BUGREPORT_FULL";
2494 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2495 return "BUGREPORT_INTERACTIVE";
2496 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2497 return "BUGREPORT_REMOTE";
2498 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2499 return "BUGREPORT_WEAR";
2500 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2501 return "BUGREPORT_TELEPHONY";
2502 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2503 return "BUGREPORT_WIFI";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002504 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2505 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002506 }
2507}
2508
Paul Changf59c2b72020-03-10 02:08:55 +08002509static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options,
2510 bool is_screenshot_requested) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002511 // Modify com.android.shell.BugreportProgressService#isDefaultScreenshotRequired as well for
2512 // default system screenshots.
Abhijeet Kaure370d682019-10-01 16:49:30 +01002513 options->bugreport_mode = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002514 switch (mode) {
2515 case Dumpstate::BugreportMode::BUGREPORT_FULL:
Paul Changf59c2b72020-03-10 02:08:55 +08002516 options->do_screenshot = is_screenshot_requested;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002517 options->dumpstate_hal_mode = DumpstateMode::FULL;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002518 break;
2519 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002520 // Currently, the dumpstate binder is only used by Shell to update progress.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002521 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002522 options->do_screenshot = is_screenshot_requested;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002523 options->dumpstate_hal_mode = DumpstateMode::INTERACTIVE;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002524 break;
2525 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002526 options->do_vibrate = false;
2527 options->is_remote_mode = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002528 options->do_screenshot = false;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002529 options->dumpstate_hal_mode = DumpstateMode::REMOTE;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002530 break;
2531 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002532 options->do_progress_updates = true;
2533 options->do_zip_file = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002534 options->do_screenshot = is_screenshot_requested;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002535 options->dumpstate_hal_mode = DumpstateMode::WEAR;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002536 break;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002537 // TODO(b/148168577) rename TELEPHONY everywhere to CONNECTIVITY.
Nandana Dutt58d72e22018-11-16 10:30:48 +00002538 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002539 options->telephony_only = true;
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002540 options->do_progress_updates = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002541 options->do_screenshot = false;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002542 options->dumpstate_hal_mode = DumpstateMode::CONNECTIVITY;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002543 break;
2544 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002545 options->wifi_only = true;
2546 options->do_zip_file = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002547 options->do_screenshot = false;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002548 options->dumpstate_hal_mode = DumpstateMode::WIFI;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002549 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002550 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2551 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002552 }
2553}
2554
Nandana Dutt58d72e22018-11-16 10:30:48 +00002555static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
Nandana Dutt235c6672019-11-14 15:22:32 +00002556 MYLOGI(
Paul Chang0d2aad72020-02-13 20:04:03 +08002557 "do_zip_file: %d do_vibrate: %d use_socket: %d use_control_socket: %d do_screenshot: %d "
Rhed Jao6f5ddce2020-08-20 00:10:32 +08002558 "is_remote_mode: %d show_header_only: %d telephony_only: %d "
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002559 "wifi_only: %d do_progress_updates: %d fd: %d bugreport_mode: %s dumpstate_hal_mode: %s "
mhasankd451a472020-05-26 18:02:39 -07002560 "limited_only: %d args: %s\n",
Nandana Dutt235c6672019-11-14 15:22:32 +00002561 options.do_zip_file, options.do_vibrate, options.use_socket, options.use_control_socket,
Paul Chang0d2aad72020-02-13 20:04:03 +08002562 options.do_screenshot, options.is_remote_mode, options.show_header_only,
Rhed Jao6f5ddce2020-08-20 00:10:32 +08002563 options.telephony_only, options.wifi_only,
mhasankd451a472020-05-26 18:02:39 -07002564 options.do_progress_updates, options.bugreport_fd.get(), options.bugreport_mode.c_str(),
2565 toString(options.dumpstate_hal_mode).c_str(), options.limited_only, options.args.c_str());
Nandana Dutt58d72e22018-11-16 10:30:48 +00002566}
2567
Nandana Dutt54dbd672019-01-11 12:58:05 +00002568void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode,
2569 const android::base::unique_fd& bugreport_fd_in,
Paul Changf59c2b72020-03-10 02:08:55 +08002570 const android::base::unique_fd& screenshot_fd_in,
2571 bool is_screenshot_requested) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002572 // In the new API world, date is always added; output is always a zip file.
2573 // TODO(111441001): remove these options once they are obsolete.
2574 do_add_date = true;
2575 do_zip_file = true;
2576
Nandana Dutt54dbd672019-01-11 12:58:05 +00002577 // Duplicate the fds because the passed in fds don't outlive the binder transaction.
2578 bugreport_fd.reset(dup(bugreport_fd_in.get()));
2579 screenshot_fd.reset(dup(screenshot_fd_in.get()));
Nandana Dutt58d72e22018-11-16 10:30:48 +00002580
Paul Changf59c2b72020-03-10 02:08:55 +08002581 SetOptionsFromMode(bugreport_mode, this, is_screenshot_requested);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002582}
2583
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002584Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
2585 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002586 int c;
mhasankd451a472020-05-26 18:02:39 -07002587 while ((c = getopt(argc, argv, "dho:svqzpLPBRSV:w")) != -1) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002588 switch (c) {
2589 // clang-format off
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002590 case 'd': do_add_date = true; break;
2591 case 'z': do_zip_file = true; break;
mhasank3a4cfb42020-06-15 18:06:43 -07002592 case 'o': out_dir = optarg; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002593 case 's': use_socket = true; break;
2594 case 'S': use_control_socket = true; break;
2595 case 'v': show_header_only = true; break;
2596 case 'q': do_vibrate = false; break;
Paul Chang0d2aad72020-02-13 20:04:03 +08002597 case 'p': do_screenshot = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002598 case 'P': do_progress_updates = true; break;
2599 case 'R': is_remote_mode = true; break;
mhasankd451a472020-05-26 18:02:39 -07002600 case 'L': limited_only = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002601 case 'V': break; // compatibility no-op
Nandana Dutt235864b2019-01-22 12:10:16 +00002602 case 'w':
2603 // This was already processed
2604 break;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002605 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002606 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002607 break;
2608 default:
2609 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002610 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002611 break;
2612 // clang-format on
2613 }
2614 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08002615
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002616 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002617 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002618 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002619 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002620 }
2621 }
2622
2623 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
2624 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002625
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002626 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002627}
2628
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002629bool Dumpstate::DumpOptions::ValidateOptions() const {
Nandana Dutt54dbd672019-01-11 12:58:05 +00002630 if (bugreport_fd.get() != -1 && !do_zip_file) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002631 return false;
2632 }
2633
Abhijeet Kaure370d682019-10-01 16:49:30 +01002634 if ((do_zip_file || do_add_date || do_progress_updates) && !OutputToFile()) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002635 return false;
2636 }
2637
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002638 if (use_control_socket && !do_zip_file) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002639 return false;
2640 }
2641
Abhijeet Kaure370d682019-10-01 16:49:30 +01002642 if (is_remote_mode && (do_progress_updates || !do_zip_file || !do_add_date)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002643 return false;
2644 }
2645 return true;
2646}
2647
Nandana Dutt197661d2018-11-16 16:40:21 +00002648void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
2649 options_ = std::move(options);
2650}
2651
Abhijeet Kaura407fb82020-03-27 12:51:12 +00002652void Dumpstate::Initialize() {
2653 /* gets the sequential id */
2654 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
2655 id_ = ++last_id;
2656 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
2657}
2658
Nandana Duttd2f5f082019-01-18 17:13:52 +00002659Dumpstate::RunStatus Dumpstate::Run(int32_t calling_uid, const std::string& calling_package) {
2660 Dumpstate::RunStatus status = RunInternal(calling_uid, calling_package);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002661 if (listener_ != nullptr) {
2662 switch (status) {
2663 case Dumpstate::RunStatus::OK:
Nandana Duttcc4ead82019-01-23 08:29:23 +00002664 listener_->onFinished();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002665 break;
2666 case Dumpstate::RunStatus::HELP:
2667 break;
2668 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002669 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_INVALID_INPUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002670 break;
2671 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002672 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_RUNTIME_ERROR);
2673 break;
2674 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2675 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_DENIED_CONSENT);
2676 break;
2677 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
2678 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_CONSENT_TIMED_OUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002679 break;
2680 }
2681 }
2682 return status;
2683}
2684
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002685void Dumpstate::Cancel() {
2686 CleanupTmpFiles();
2687 android::os::UnlinkAndLogOnError(log_path_);
2688 for (int i = 0; i < NUM_OF_DUMPS; i++) {
2689 android::os::UnlinkAndLogOnError(ds.bugreport_internal_dir_ + "/" +
2690 kDumpstateBoardFiles[i]);
2691 }
2692 tombstone_data_.clear();
2693 anr_data_.clear();
Rhed Jaoe96bcd52020-08-21 14:48:20 +08002694
2695 // Instead of shutdown the pool, we delete temporary files directly since
2696 // shutdown blocking the call.
2697 if (dump_pool_) {
2698 dump_pool_->deleteTempFiles();
2699 }
2700 if (zip_entry_tasks_) {
2701 zip_entry_tasks_->run(/*do_cancel =*/ true);
2702 }
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002703}
2704
Nandana Dutt979388e2018-11-30 16:48:55 +00002705/*
2706 * Dumps relevant information to a bugreport based on the given options.
2707 *
2708 * The bugreport can be dumped to a file or streamed to a socket.
2709 *
2710 * How dumping to file works:
2711 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
2712 * stderr is redirected a log file.
2713 *
2714 * The temporary bugreport is then populated via printfs, dumping contents of files and
2715 * output of commands to stdout.
2716 *
2717 * If zipping, the temporary bugreport file is added to the zip archive. Else it's renamed to final
2718 * text file.
2719 *
2720 * If zipping, a bunch of other files and dumps also get added to the zip archive. The log file also
2721 * gets added to the archive.
2722 *
mhasank2d75c442020-06-11 15:05:25 -07002723 * Bugreports are first generated in a local directory and later copied to the caller's fd
2724 * or directory if supplied.
Nandana Dutt979388e2018-11-30 16:48:55 +00002725 */
Nandana Duttd2f5f082019-01-18 17:13:52 +00002726Dumpstate::RunStatus Dumpstate::RunInternal(int32_t calling_uid,
2727 const std::string& calling_package) {
Rhed Jao1c855122020-07-16 17:37:39 +08002728 DurationReporter duration_reporter("RUN INTERNAL", /* logcat_only = */true);
Nandana Dutt979388e2018-11-30 16:48:55 +00002729 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00002730 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002731 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002732 return RunStatus::INVALID_INPUT;
2733 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002734 /* set as high priority, and protect from OOM killer */
2735 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002736
Felipe Lemed071c682016-10-20 16:48:00 -07002737 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002738 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002739 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002740 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002741 } else {
2742 /* fallback to kernels <= 2.6.35 */
2743 oom_adj = fopen("/proc/self/oom_adj", "we");
2744 if (oom_adj) {
2745 fputs("-17", oom_adj);
2746 fclose(oom_adj);
2747 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002748 }
2749
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002750 if (version_ == VERSION_DEFAULT) {
2751 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00002752 }
2753
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002754 if (version_ != VERSION_CURRENT && version_ != VERSION_SPLIT_ANR) {
Vishnu Nair64afc022018-02-01 15:29:34 -08002755 MYLOGE("invalid version requested ('%s'); suppported values are: ('%s', '%s', '%s')\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002756 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str(),
Vishnu Nair64afc022018-02-01 15:29:34 -08002757 VERSION_SPLIT_ANR.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002758 return RunStatus::INVALID_INPUT;
Felipe Lemed071c682016-10-20 16:48:00 -07002759 }
2760
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002761 if (options_->show_header_only) {
2762 PrintHeader();
2763 return RunStatus::OK;
Felipe Lemed071c682016-10-20 16:48:00 -07002764 }
2765
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002766 MYLOGD("dumpstate calling_uid = %d ; calling package = %s \n",
2767 calling_uid, calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00002768
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002769 // Redirect output if needed
Nandana Dutt9a76d202019-01-21 15:56:48 +00002770 bool is_redirecting = options_->OutputToFile();
Felipe Leme7447d7c2016-11-03 18:12:22 -07002771
2772 // TODO: temporarily set progress until it's part of the Dumpstate constructor
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002773 std::string stats_path =
Nandana Dutt979388e2018-11-30 16:48:55 +00002774 is_redirecting
2775 ? android::base::StringPrintf("%s/dumpstate-stats.txt", bugreport_internal_dir_.c_str())
2776 : "";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002777 progress_.reset(new Progress(stats_path));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002778
Sahana Raof35ed432019-07-12 10:47:52 +01002779 if (acquire_wake_lock(PARTIAL_WAKE_LOCK, WAKE_LOCK_NAME) < 0) {
2780 MYLOGE("Failed to acquire wake lock: %s\n", strerror(errno));
2781 } else {
2782 // Wake lock will be released automatically on process death
2783 MYLOGD("Wake lock acquired.\n");
2784 }
2785
Felipe Leme6ae5c4f2017-01-10 14:13:22 -08002786 register_sig_handler();
Felipe Lemed071c682016-10-20 16:48:00 -07002787
Felipe Lemef0292972016-11-22 13:57:05 -08002788 if (PropertiesHelper::IsDryRun()) {
Felipe Lemed071c682016-10-20 16:48:00 -07002789 MYLOGI("Running on dry-run mode (to disable it, call 'setprop dumpstate.dry_run false')\n");
2790 }
2791
Nandana Dutt235c6672019-11-14 15:22:32 +00002792 MYLOGI("dumpstate info: id=%d, args='%s', bugreport_mode= %s bugreport format version: %s\n",
2793 id_, options_->args.c_str(), options_->bugreport_mode.c_str(), version_.c_str());
Felipe Leme809d74e2016-02-02 12:57:00 -08002794
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002795 do_early_screenshot_ = options_->do_progress_updates;
Felipe Lemee338bf62015-12-07 14:03:50 -08002796
Christopher Ferrised9354f2014-10-01 17:35:01 -07002797 // If we are going to use a socket, do it as early as possible
2798 // to avoid timeouts from bugreport.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002799 if (options_->use_socket) {
Nandana Dutta344cb62019-02-22 15:12:35 +00002800 if (!redirect_to_socket(stdout, "dumpstate")) {
2801 return ERROR;
2802 }
Christopher Ferrised9354f2014-10-01 17:35:01 -07002803 }
2804
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002805 if (options_->use_control_socket) {
Felipe Leme2628e9e2016-04-12 16:36:51 -07002806 MYLOGD("Opening control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002807 control_socket_fd_ = open_socket("dumpstate");
Nandana Dutta344cb62019-02-22 15:12:35 +00002808 if (control_socket_fd_ == -1) {
2809 return ERROR;
2810 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002811 options_->do_progress_updates = 1;
Felipe Leme2628e9e2016-04-12 16:36:51 -07002812 }
2813
Felipe Leme71bbfc52015-11-23 14:14:51 -08002814 if (is_redirecting) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002815 PrepareToWriteToFile();
Felipe Leme1e9edc62015-12-21 16:02:13 -08002816
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002817 if (options_->do_progress_updates) {
Abhijeet Kaure370d682019-10-01 16:49:30 +01002818 // clang-format off
2819 std::vector<std::string> am_args = {
2820 "--receiver-permission", "android.permission.DUMP",
2821 };
2822 // clang-format on
2823 // Send STARTED broadcast for apps that listen to bugreport generation events
2824 SendBroadcast("com.android.internal.intent.action.BUGREPORT_STARTED", am_args);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002825 if (options_->use_control_socket) {
2826 dprintf(control_socket_fd_, "BEGIN:%s\n", path_.c_str());
Felipe Lemeaabfcae2016-07-29 09:49:04 -07002827 }
Felipe Leme71bbfc52015-11-23 14:14:51 -08002828 }
2829 }
2830
Nick Kralevichf3599b32016-01-25 15:05:16 -08002831 /* read /proc/cmdline before dropping root */
2832 FILE *cmdline = fopen("/proc/cmdline", "re");
2833 if (cmdline) {
2834 fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
2835 fclose(cmdline);
2836 }
2837
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002838 if (options_->do_vibrate) {
Felipe Leme35b8cf12017-02-10 15:47:29 -08002839 Vibrate(150);
John Michelau1f794c42012-09-17 11:20:19 -05002840 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002841
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002842 if (options_->do_zip_file && zip_file != nullptr) {
2843 if (chown(path_.c_str(), AID_SHELL, AID_SHELL)) {
2844 MYLOGE("Unable to change ownership of zip file %s: %s\n", path_.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -07002845 strerror(errno));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002846 }
2847 }
2848
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002849 int dup_stdout_fd;
2850 int dup_stderr_fd;
Felipe Leme71bbfc52015-11-23 14:14:51 -08002851 if (is_redirecting) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002852 // Redirect stderr to log_path_ for debugging.
Vishnu Nair20cf5032018-01-05 13:15:49 -08002853 TEMP_FAILURE_RETRY(dup_stderr_fd = dup(fileno(stderr)));
Nandana Dutta344cb62019-02-22 15:12:35 +00002854 if (!redirect_to_file(stderr, const_cast<char*>(log_path_.c_str()))) {
2855 return ERROR;
2856 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002857 if (chown(log_path_.c_str(), AID_SHELL, AID_SHELL)) {
2858 MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n", log_path_.c_str(),
2859 strerror(errno));
Felipe Leme6fe9db62016-02-12 09:04:16 -08002860 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002861
2862 // Redirect stdout to tmp_path_. This is the main bugreport entry and will be
2863 // moved into zip file later, if zipping.
Vishnu Nair20cf5032018-01-05 13:15:49 -08002864 TEMP_FAILURE_RETRY(dup_stdout_fd = dup(fileno(stdout)));
Nandana Dutt979388e2018-11-30 16:48:55 +00002865 // TODO: why not write to a file instead of stdout to overcome this problem?
Felipe Leme6e01fa62015-11-11 19:35:14 -08002866 /* TODO: rather than generating a text file now and zipping it later,
2867 it would be more efficient to redirect stdout to the zip entry
2868 directly, but the libziparchive doesn't support that option yet. */
Nandana Dutta344cb62019-02-22 15:12:35 +00002869 if (!redirect_to_file(stdout, const_cast<char*>(tmp_path_.c_str()))) {
2870 return ERROR;
2871 }
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002872 if (chown(tmp_path_.c_str(), AID_SHELL, AID_SHELL)) {
Felipe Leme6fe9db62016-02-12 09:04:16 -08002873 MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002874 tmp_path_.c_str(), strerror(errno));
Felipe Leme6fe9db62016-02-12 09:04:16 -08002875 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002876 }
Felipe Lemed8b94e52016-12-08 10:21:44 -08002877
2878 // Don't buffer stdout
2879 setvbuf(stdout, nullptr, _IONBF, 0);
2880
Rhed Jao1c855122020-07-16 17:37:39 +08002881 // Enable the parallel run if the client requests to output to a file.
2882 EnableParallelRunIfNeeded();
2883 // Using scope guard to make sure the dump pool can be shut down correctly.
2884 auto scope_guard_to_shutdown_pool = android::base::make_scope_guard([=]() {
2885 ShutdownDumpPool();
2886 });
2887
Felipe Leme608385d2016-02-01 10:35:38 -08002888 // NOTE: there should be no stdout output until now, otherwise it would break the header.
2889 // In particular, DurationReport objects should be created passing 'title, NULL', so their
Felipe Lemecbce55d2016-02-08 09:53:18 -08002890 // duration is logged into MYLOG instead.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002891 PrintHeader();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002892
mhasankd451a472020-05-26 18:02:39 -07002893 // TODO(b/158737089) reduce code repetition in if branches
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002894 if (options_->telephony_only) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002895 MaybeTakeEarlyScreenshot();
Paul Changc490e662020-04-11 18:14:09 +08002896 onUiIntensiveBugreportDumpsFinished(calling_uid, calling_package);
Jichao Lie89d9c12019-11-21 19:02:51 -08002897 MaybeCheckUserConsent(calling_uid, calling_package);
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08002898 DumpstateTelephonyOnly(calling_package);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002899 } else if (options_->wifi_only) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002900 MaybeTakeEarlyScreenshot();
Paul Changc490e662020-04-11 18:14:09 +08002901 onUiIntensiveBugreportDumpsFinished(calling_uid, calling_package);
Jichao Lie89d9c12019-11-21 19:02:51 -08002902 MaybeCheckUserConsent(calling_uid, calling_package);
mukesh agrawal253dad42018-01-23 21:59:59 -08002903 DumpstateWifiOnly();
mhasankd451a472020-05-26 18:02:39 -07002904 } else if (options_->limited_only) {
2905 MaybeTakeEarlyScreenshot();
2906 onUiIntensiveBugreportDumpsFinished(calling_uid, calling_package);
2907 MaybeCheckUserConsent(calling_uid, calling_package);
2908 DumpstateLimitedOnly();
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002909 } else {
Paul Chang0d2aad72020-02-13 20:04:03 +08002910 // Invoke critical dumpsys first to preserve system state, before doing anything else.
Jichao Lie89d9c12019-11-21 19:02:51 -08002911 RunDumpsysCritical();
2912
Paul Chang0d2aad72020-02-13 20:04:03 +08002913 // Take screenshot and get consent only after critical dumpsys has finished.
2914 MaybeTakeEarlyScreenshot();
Paul Changc490e662020-04-11 18:14:09 +08002915 onUiIntensiveBugreportDumpsFinished(calling_uid, calling_package);
Jichao Lie89d9c12019-11-21 19:02:51 -08002916 MaybeCheckUserConsent(calling_uid, calling_package);
2917
Nandana Dutt4be45d12018-09-26 15:04:23 +01002918 // Dump state for the default case. This also drops root.
Jichao Lie89d9c12019-11-21 19:02:51 -08002919 RunStatus s = DumpstateDefaultAfterCritical();
Nandana Dutt5c390032019-03-12 10:52:56 +00002920 if (s != RunStatus::OK) {
Nandana Duttaac6f582019-07-26 14:32:47 +01002921 if (s == RunStatus::USER_CONSENT_DENIED) {
Nandana Dutt5c390032019-03-12 10:52:56 +00002922 HandleUserConsentDenied();
2923 }
2924 return s;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08002925 }
Zhengyin Qian068ecc72016-08-10 16:48:14 -07002926 }
Felipe Leme71a74ac2016-03-17 15:43:25 -07002927
Felipe Leme55b42a62015-11-10 17:39:08 -08002928 /* close output if needed */
Felipe Leme71bbfc52015-11-23 14:14:51 -08002929 if (is_redirecting) {
Vishnu Nair20cf5032018-01-05 13:15:49 -08002930 TEMP_FAILURE_RETRY(dup2(dup_stdout_fd, fileno(stdout)));
Colin Crossf45fa6b2012-03-26 12:38:26 -07002931 }
2932
Abhijeet Kaure370d682019-10-01 16:49:30 +01002933 // Zip the (now complete) .tmp file within the internal directory.
Nandana Dutt9a76d202019-01-21 15:56:48 +00002934 if (options_->OutputToFile()) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002935 FinalizeFile();
Colin Crossf45fa6b2012-03-26 12:38:26 -07002936 }
2937
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002938 // Share the final file with the caller if the user has consented or Shell is the caller.
Nandana Duttd2f5f082019-01-18 17:13:52 +00002939 Dumpstate::RunStatus status = Dumpstate::RunStatus::OK;
Abhijeet Kaure370d682019-10-01 16:49:30 +01002940 if (CalledByApi()) {
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002941 status = CopyBugreportIfUserConsented(calling_uid);
Nandana Duttd2f5f082019-01-18 17:13:52 +00002942 if (status != Dumpstate::RunStatus::OK &&
2943 status != Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2944 // Do an early return if there were errors. We make an exception for consent
2945 // timing out because it's possible the user got distracted. In this case the
2946 // bugreport is not shared but made available for manual retrieval.
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002947 MYLOGI("User denied consent. Returning\n");
Nandana Duttd2f5f082019-01-18 17:13:52 +00002948 return status;
2949 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002950 if (status == Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
2951 MYLOGI(
2952 "Did not receive user consent yet."
2953 " Will not copy the bugreport artifacts to caller.\n");
Abhijeet Kaur57627412019-04-17 16:00:09 +01002954 const String16 incidentcompanion("incidentcompanion");
2955 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
2956 if (ics != nullptr) {
2957 MYLOGD("Canceling user consent request via incidentcompanion service\n");
2958 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
2959 consent_callback_.get());
2960 } else {
2961 MYLOGD("Unable to cancel user consent; incidentcompanion service unavailable\n");
2962 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002963 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00002964 }
2965
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002966 /* vibrate a few but shortly times to let user know it's finished */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002967 if (options_->do_vibrate) {
Takuya Ogawa47f644e2017-12-20 18:09:09 +09002968 for (int i = 0; i < 3; i++) {
2969 Vibrate(75);
2970 usleep((75 + 50) * 1000);
2971 }
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08002972 }
2973
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002974 MYLOGD("Final progress: %d/%d (estimated %d)\n", progress_->Get(), progress_->GetMax(),
2975 progress_->GetInitialMax());
2976 progress_->Save();
2977 MYLOGI("done (id %d)\n", id_);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002978
Felipe Leme107a05f2016-03-08 15:11:15 -08002979 if (is_redirecting) {
Vishnu Nair20cf5032018-01-05 13:15:49 -08002980 TEMP_FAILURE_RETRY(dup2(dup_stderr_fd, fileno(stderr)));
Felipe Leme107a05f2016-03-08 15:11:15 -08002981 }
2982
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002983 if (options_->use_control_socket && control_socket_fd_ != -1) {
Felipe Lemee844a9d2016-09-21 15:01:39 -07002984 MYLOGD("Closing control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002985 close(control_socket_fd_);
Felipe Leme2628e9e2016-04-12 16:36:51 -07002986 }
2987
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002988 tombstone_data_.clear();
2989 anr_data_.clear();
Narayan Kamath6b9516c2017-10-27 11:15:51 +01002990
Nandana Duttd2f5f082019-01-18 17:13:52 +00002991 return (consent_callback_ != nullptr &&
2992 consent_callback_->getResult() == UserConsentResult::UNAVAILABLE)
2993 ? USER_CONSENT_TIMED_OUT
2994 : RunStatus::OK;
2995}
2996
Paul Chang0d2aad72020-02-13 20:04:03 +08002997void Dumpstate::MaybeTakeEarlyScreenshot() {
2998 if (!options_->do_screenshot || !do_early_screenshot_) {
2999 return;
3000 }
3001
3002 TakeScreenshot();
3003}
3004
Paul Changc490e662020-04-11 18:14:09 +08003005void Dumpstate::onUiIntensiveBugreportDumpsFinished(int32_t calling_uid,
3006 const std::string& calling_package) {
3007 if (calling_uid == AID_SHELL || !CalledByApi()) {
3008 return;
3009 }
3010 if (listener_ != nullptr) {
3011 // Let listener know ui intensive bugreport dumps are finished, then it can do event
3012 // handling if required.
3013 android::String16 package(calling_package.c_str());
3014 listener_->onUiIntensiveBugreportDumpsFinished(package);
3015 }
3016}
3017
Jichao Lie89d9c12019-11-21 19:02:51 -08003018void Dumpstate::MaybeCheckUserConsent(int32_t calling_uid, const std::string& calling_package) {
3019 if (calling_uid == AID_SHELL || !CalledByApi()) {
3020 // No need to get consent for shell triggered dumpstates, or not through
3021 // bugreporting API (i.e. no fd to copy back).
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003022 return;
3023 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003024 consent_callback_ = new ConsentCallback();
3025 const String16 incidentcompanion("incidentcompanion");
3026 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
Jichao Lie89d9c12019-11-21 19:02:51 -08003027 android::String16 package(calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003028 if (ics != nullptr) {
3029 MYLOGD("Checking user consent via incidentcompanion service\n");
3030 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
Jichao Lie89d9c12019-11-21 19:02:51 -08003031 calling_uid, package, String16(), String16(),
Joe Onorato1c36d752019-03-17 18:26:43 -07003032 0x1 /* FLAG_CONFIRMATION_DIALOG */, consent_callback_.get());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003033 } else {
3034 MYLOGD("Unable to check user consent; incidentcompanion service unavailable\n");
3035 }
3036}
3037
Nandana Dutt5c390032019-03-12 10:52:56 +00003038bool Dumpstate::IsUserConsentDenied() const {
3039 return ds.consent_callback_ != nullptr &&
3040 ds.consent_callback_->getResult() == UserConsentResult::DENIED;
3041}
3042
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01003043bool Dumpstate::CalledByApi() const {
3044 return ds.options_->bugreport_fd.get() != -1 ? true : false;
3045}
3046
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003047void Dumpstate::CleanupTmpFiles() {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003048 android::os::UnlinkAndLogOnError(tmp_path_);
3049 android::os::UnlinkAndLogOnError(screenshot_path_);
3050 android::os::UnlinkAndLogOnError(path_);
3051}
3052
Rhed Jao1c855122020-07-16 17:37:39 +08003053void Dumpstate::EnableParallelRunIfNeeded() {
3054 // The thread pool needs to create temporary files to receive dump results.
3055 // That's why we only enable it when the bugreport client chooses to output
3056 // to a file.
3057 if (!PropertiesHelper::IsParallelRun() || !options_->OutputToFile()) {
3058 return;
3059 }
3060 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao4875aa62020-07-20 17:46:29 +08003061 zip_entry_tasks_ = std::make_unique<TaskQueue>();
Rhed Jao1c855122020-07-16 17:37:39 +08003062}
3063
3064void Dumpstate::ShutdownDumpPool() {
3065 if (dump_pool_) {
3066 dump_pool_->shutdown();
3067 dump_pool_ = nullptr;
3068 }
Rhed Jao4875aa62020-07-20 17:46:29 +08003069 if (zip_entry_tasks_) {
3070 zip_entry_tasks_->run(/* do_cancel = */true);
3071 zip_entry_tasks_ = nullptr;
3072 }
3073}
3074
3075void Dumpstate::EnqueueAddZipEntryAndCleanupIfNeeded(const std::string& entry_name,
3076 const std::string& entry_path) {
3077 auto func_add_zip_entry_and_cleanup = [=](bool task_cancelled) {
3078 if (!task_cancelled) {
3079 AddZipEntry(entry_name, entry_path);
3080 }
3081 android::os::UnlinkAndLogOnError(entry_path);
3082 };
3083 if (zip_entry_tasks_) {
3084 // Enqueues AddZipEntryAndCleanup function if the parallel run is enabled.
3085 zip_entry_tasks_->add(func_add_zip_entry_and_cleanup, _1);
3086 } else {
3087 // Invokes AddZipEntryAndCleanup immediately
3088 std::invoke(func_add_zip_entry_and_cleanup, /* task_cancelled = */false);
3089 }
Rhed Jao1c855122020-07-16 17:37:39 +08003090}
3091
Nandana Duttd2f5f082019-01-18 17:13:52 +00003092Dumpstate::RunStatus Dumpstate::HandleUserConsentDenied() {
3093 MYLOGD("User denied consent; deleting files and returning\n");
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003094 CleanupTmpFiles();
Nandana Duttd2f5f082019-01-18 17:13:52 +00003095 return USER_CONSENT_DENIED;
3096}
3097
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003098Dumpstate::RunStatus Dumpstate::CopyBugreportIfUserConsented(int32_t calling_uid) {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003099 // If the caller has asked to copy the bugreport over to their directory, we need explicit
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003100 // user consent (unless the caller is Shell).
3101 UserConsentResult consent_result;
3102 if (calling_uid == AID_SHELL) {
3103 consent_result = UserConsentResult::APPROVED;
3104 } else {
3105 consent_result = consent_callback_->getResult();
3106 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003107 if (consent_result == UserConsentResult::UNAVAILABLE) {
3108 // User has not responded yet.
3109 uint64_t elapsed_ms = consent_callback_->getElapsedTimeMs();
Hunter Knepshield70610fa2020-01-03 15:27:33 -08003110 // Telephony is a fast report type, particularly on user builds where information may be
3111 // more aggressively limited. To give the user time to read the consent dialog, increase the
3112 // timeout.
3113 uint64_t timeout_ms = options_->telephony_only ? TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS
3114 : USER_CONSENT_TIMEOUT_MS;
3115 if (elapsed_ms < timeout_ms) {
3116 uint delay_seconds = (timeout_ms - elapsed_ms) / 1000;
Nandana Duttd2f5f082019-01-18 17:13:52 +00003117 MYLOGD("Did not receive user consent yet; going to wait for %d seconds", delay_seconds);
3118 sleep(delay_seconds);
3119 }
3120 consent_result = consent_callback_->getResult();
3121 }
3122 if (consent_result == UserConsentResult::DENIED) {
3123 // User has explicitly denied sharing with the app. To be safe delete the
3124 // internal bugreport & tmp files.
3125 return HandleUserConsentDenied();
3126 }
3127 if (consent_result == UserConsentResult::APPROVED) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00003128 bool copy_succeeded = android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
3129 if (copy_succeeded) {
3130 android::os::UnlinkAndLogOnError(path_);
Abhijeet Kaur9ce94672020-04-01 17:22:36 +01003131 if (options_->do_screenshot &&
3132 options_->screenshot_fd.get() != -1 &&
3133 !options_->is_screenshot_copied) {
3134 copy_succeeded = android::os::CopyFileToFd(screenshot_path_,
3135 options_->screenshot_fd.get());
3136 options_->is_screenshot_copied = copy_succeeded;
3137 if (copy_succeeded) {
3138 android::os::UnlinkAndLogOnError(screenshot_path_);
3139 }
3140 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003141 }
3142 return copy_succeeded ? Dumpstate::RunStatus::OK : Dumpstate::RunStatus::ERROR;
3143 } else if (consent_result == UserConsentResult::UNAVAILABLE) {
3144 // consent_result is still UNAVAILABLE. The user has likely not responded yet.
3145 // Since we do not have user consent to share the bugreport it does not get
3146 // copied over to the calling app but remains in the internal directory from
3147 // where the user can manually pull it.
3148 return Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT;
3149 }
3150 // Unknown result; must be a programming error.
3151 MYLOGE("Unknown user consent result:%d\n", consent_result);
3152 return Dumpstate::RunStatus::ERROR;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003153}
3154
Nandana Duttf02564e2019-02-15 15:24:24 +00003155Dumpstate::RunStatus Dumpstate::ParseCommandlineAndRun(int argc, char* argv[]) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003156 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
3157 Dumpstate::RunStatus status = options->Initialize(argc, argv);
3158 if (status == Dumpstate::RunStatus::OK) {
Nandana Duttf02564e2019-02-15 15:24:24 +00003159 SetOptions(std::move(options));
Nandana Duttd2f5f082019-01-18 17:13:52 +00003160 // When directly running dumpstate binary, the output is not expected to be written
3161 // to any external file descriptor.
Nandana Duttf02564e2019-02-15 15:24:24 +00003162 assert(options_->bugreport_fd.get() == -1);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003163
3164 // calling_uid and calling_package are for user consent to share the bugreport with
Abhijeet Kaura407fb82020-03-27 12:51:12 +00003165 // an app; they are irrelevant here because bugreport is triggered via command line.
3166 // Update Last ID before calling Run().
3167 Initialize();
Nandana Duttf02564e2019-02-15 15:24:24 +00003168 status = Run(-1 /* calling_uid */, "" /* calling_package */);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003169 }
Nandana Duttf02564e2019-02-15 15:24:24 +00003170 return status;
3171}
3172
3173/* Main entry point for dumpstate binary. */
3174int run_main(int argc, char* argv[]) {
3175 Dumpstate::RunStatus status = ds.ParseCommandlineAndRun(argc, argv);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003176
3177 switch (status) {
3178 case Dumpstate::RunStatus::OK:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003179 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003180 case Dumpstate::RunStatus::HELP:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003181 ShowUsage();
3182 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003183 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003184 fprintf(stderr, "Invalid combination of args\n");
3185 ShowUsage();
3186 exit(1);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003187 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00003188 FALLTHROUGH_INTENDED;
3189 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
3190 FALLTHROUGH_INTENDED;
3191 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003192 exit(2);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003193 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003194}
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003195
3196// TODO(111441001): Default DumpOptions to sensible values.
3197Dumpstate::Dumpstate(const std::string& version)
3198 : pid_(getpid()),
3199 options_(new Dumpstate::DumpOptions()),
Nandana Duttf02cd782019-06-14 14:25:13 +01003200 last_reported_percent_progress_(0),
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003201 version_(version),
3202 now_(time(nullptr)) {
3203}
3204
3205Dumpstate& Dumpstate::GetInstance() {
3206 static Dumpstate singleton_(android::base::GetProperty("dumpstate.version", VERSION_CURRENT));
3207 return singleton_;
3208}
3209
Rhed Jao1c855122020-07-16 17:37:39 +08003210DurationReporter::DurationReporter(const std::string& title, bool logcat_only, bool verbose,
3211 int duration_fd) : title_(title), logcat_only_(logcat_only), verbose_(verbose),
3212 duration_fd_(duration_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003213 if (!title_.empty()) {
3214 started_ = Nanotime();
3215 }
3216}
3217
3218DurationReporter::~DurationReporter() {
3219 if (!title_.empty()) {
3220 float elapsed = (float)(Nanotime() - started_) / NANOS_PER_SEC;
chenqiwuaf8b2d92019-12-12 18:53:51 +08003221 if (elapsed >= .5f || verbose_) {
3222 MYLOGD("Duration of '%s': %.2fs\n", title_.c_str(), elapsed);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003223 }
chenqiwuaf8b2d92019-12-12 18:53:51 +08003224 if (!logcat_only_) {
3225 // Use "Yoda grammar" to make it easier to grep|sort sections.
Rhed Jao1c855122020-07-16 17:37:39 +08003226 dprintf(duration_fd_, "------ %.3fs was the duration of '%s' ------\n",
3227 elapsed, title_.c_str());
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003228 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003229 }
3230}
3231
3232const int32_t Progress::kDefaultMax = 5000;
3233
3234Progress::Progress(const std::string& path) : Progress(Progress::kDefaultMax, 1.1, path) {
3235}
3236
3237Progress::Progress(int32_t initial_max, int32_t progress, float growth_factor)
3238 : Progress(initial_max, growth_factor, "") {
3239 progress_ = progress;
3240}
3241
3242Progress::Progress(int32_t initial_max, float growth_factor, const std::string& path)
3243 : initial_max_(initial_max),
3244 progress_(0),
3245 max_(initial_max),
3246 growth_factor_(growth_factor),
3247 n_runs_(0),
3248 average_max_(0),
3249 path_(path) {
3250 if (!path_.empty()) {
3251 Load();
3252 }
3253}
3254
3255void Progress::Load() {
3256 MYLOGD("Loading stats from %s\n", path_.c_str());
3257 std::string content;
3258 if (!android::base::ReadFileToString(path_, &content)) {
3259 MYLOGI("Could not read stats from %s; using max of %d\n", path_.c_str(), max_);
3260 return;
3261 }
3262 if (content.empty()) {
3263 MYLOGE("No stats (empty file) on %s; using max of %d\n", path_.c_str(), max_);
3264 return;
3265 }
3266 std::vector<std::string> lines = android::base::Split(content, "\n");
3267
3268 if (lines.size() < 1) {
3269 MYLOGE("Invalid stats on file %s: not enough lines (%d). Using max of %d\n", path_.c_str(),
3270 (int)lines.size(), max_);
3271 return;
3272 }
3273 char* ptr;
3274 n_runs_ = strtol(lines[0].c_str(), &ptr, 10);
3275 average_max_ = strtol(ptr, nullptr, 10);
3276 if (n_runs_ <= 0 || average_max_ <= 0 || n_runs_ > STATS_MAX_N_RUNS ||
3277 average_max_ > STATS_MAX_AVERAGE) {
3278 MYLOGE("Invalid stats line on file %s: %s\n", path_.c_str(), lines[0].c_str());
3279 initial_max_ = Progress::kDefaultMax;
3280 } else {
3281 initial_max_ = average_max_;
3282 }
3283 max_ = initial_max_;
3284
3285 MYLOGI("Average max progress: %d in %d runs; estimated max: %d\n", average_max_, n_runs_, max_);
3286}
3287
3288void Progress::Save() {
3289 int32_t total = n_runs_ * average_max_ + progress_;
3290 int32_t runs = n_runs_ + 1;
3291 int32_t average = floor(((float)total) / runs);
3292 MYLOGI("Saving stats (total=%d, runs=%d, average=%d) on %s\n", total, runs, average,
3293 path_.c_str());
3294 if (path_.empty()) {
3295 return;
3296 }
3297
3298 std::string content = android::base::StringPrintf("%d %d\n", runs, average);
3299 if (!android::base::WriteStringToFile(content, path_)) {
3300 MYLOGE("Could not save stats on %s\n", path_.c_str());
3301 }
3302}
3303
3304int32_t Progress::Get() const {
3305 return progress_;
3306}
3307
3308bool Progress::Inc(int32_t delta_sec) {
3309 bool changed = false;
3310 if (delta_sec >= 0) {
3311 progress_ += delta_sec;
3312 if (progress_ > max_) {
3313 int32_t old_max = max_;
3314 max_ = floor((float)progress_ * growth_factor_);
3315 MYLOGD("Adjusting max progress from %d to %d\n", old_max, max_);
3316 changed = true;
3317 }
3318 }
3319 return changed;
3320}
3321
3322int32_t Progress::GetMax() const {
3323 return max_;
3324}
3325
3326int32_t Progress::GetInitialMax() const {
3327 return initial_max_;
3328}
3329
3330void Progress::Dump(int fd, const std::string& prefix) const {
3331 const char* pr = prefix.c_str();
3332 dprintf(fd, "%sprogress: %d\n", pr, progress_);
3333 dprintf(fd, "%smax: %d\n", pr, max_);
3334 dprintf(fd, "%sinitial_max: %d\n", pr, initial_max_);
3335 dprintf(fd, "%sgrowth_factor: %0.2f\n", pr, growth_factor_);
3336 dprintf(fd, "%spath: %s\n", pr, path_.c_str());
3337 dprintf(fd, "%sn_runs: %d\n", pr, n_runs_);
3338 dprintf(fd, "%saverage_max: %d\n", pr, average_max_);
3339}
3340
3341bool Dumpstate::IsZipping() const {
3342 return zip_writer_ != nullptr;
3343}
3344
3345std::string Dumpstate::GetPath(const std::string& suffix) const {
3346 return GetPath(bugreport_internal_dir_, suffix);
3347}
3348
3349std::string Dumpstate::GetPath(const std::string& directory, const std::string& suffix) const {
3350 return android::base::StringPrintf("%s/%s-%s%s", directory.c_str(), base_name_.c_str(),
3351 name_.c_str(), suffix.c_str());
3352}
3353
3354void Dumpstate::SetProgress(std::unique_ptr<Progress> progress) {
3355 progress_ = std::move(progress);
3356}
3357
3358void for_each_userid(void (*func)(int), const char *header) {
3359 std::string title = header == nullptr ? "for_each_userid" : android::base::StringPrintf(
3360 "for_each_userid(%s)", header);
3361 DurationReporter duration_reporter(title);
3362 if (PropertiesHelper::IsDryRun()) return;
3363
3364 DIR *d;
3365 struct dirent *de;
3366
3367 if (header) printf("\n------ %s ------\n", header);
3368 func(0);
3369
3370 if (!(d = opendir("/data/system/users"))) {
3371 printf("Failed to open /data/system/users (%s)\n", strerror(errno));
3372 return;
3373 }
3374
3375 while ((de = readdir(d))) {
3376 int userid;
3377 if (de->d_type != DT_DIR || !(userid = atoi(de->d_name))) {
3378 continue;
3379 }
3380 func(userid);
3381 }
3382
3383 closedir(d);
3384}
3385
3386static void __for_each_pid(void (*helper)(int, const char *, void *), const char *header, void *arg) {
3387 DIR *d;
3388 struct dirent *de;
3389
3390 if (!(d = opendir("/proc"))) {
3391 printf("Failed to open /proc (%s)\n", strerror(errno));
3392 return;
3393 }
3394
3395 if (header) printf("\n------ %s ------\n", header);
3396 while ((de = readdir(d))) {
3397 if (ds.IsUserConsentDenied()) {
3398 MYLOGE(
3399 "Returning early because user denied consent to share bugreport with calling app.");
3400 closedir(d);
3401 return;
3402 }
3403 int pid;
3404 int fd;
3405 char cmdpath[255];
3406 char cmdline[255];
3407
3408 if (!(pid = atoi(de->d_name))) {
3409 continue;
3410 }
3411
3412 memset(cmdline, 0, sizeof(cmdline));
3413
3414 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/cmdline", pid);
3415 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3416 TEMP_FAILURE_RETRY(read(fd, cmdline, sizeof(cmdline) - 2));
3417 close(fd);
3418 if (cmdline[0]) {
3419 helper(pid, cmdline, arg);
3420 continue;
3421 }
3422 }
3423
3424 // if no cmdline, a kernel thread has comm
3425 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/comm", pid);
3426 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3427 TEMP_FAILURE_RETRY(read(fd, cmdline + 1, sizeof(cmdline) - 4));
3428 close(fd);
3429 if (cmdline[1]) {
3430 cmdline[0] = '[';
3431 size_t len = strcspn(cmdline, "\f\b\r\n");
3432 cmdline[len] = ']';
3433 cmdline[len+1] = '\0';
3434 }
3435 }
3436 if (!cmdline[0]) {
3437 strcpy(cmdline, "N/A");
3438 }
3439 helper(pid, cmdline, arg);
3440 }
3441
3442 closedir(d);
3443}
3444
3445static void for_each_pid_helper(int pid, const char *cmdline, void *arg) {
3446 for_each_pid_func *func = (for_each_pid_func*) arg;
3447 func(pid, cmdline);
3448}
3449
3450void for_each_pid(for_each_pid_func func, const char *header) {
3451 std::string title = header == nullptr ? "for_each_pid"
3452 : android::base::StringPrintf("for_each_pid(%s)", header);
3453 DurationReporter duration_reporter(title);
3454 if (PropertiesHelper::IsDryRun()) return;
3455
3456 __for_each_pid(for_each_pid_helper, header, (void *) func);
3457}
3458
3459static void for_each_tid_helper(int pid, const char *cmdline, void *arg) {
3460 DIR *d;
3461 struct dirent *de;
3462 char taskpath[255];
3463 for_each_tid_func *func = (for_each_tid_func *) arg;
3464
3465 snprintf(taskpath, sizeof(taskpath), "/proc/%d/task", pid);
3466
3467 if (!(d = opendir(taskpath))) {
3468 printf("Failed to open %s (%s)\n", taskpath, strerror(errno));
3469 return;
3470 }
3471
3472 func(pid, pid, cmdline);
3473
3474 while ((de = readdir(d))) {
3475 if (ds.IsUserConsentDenied()) {
3476 MYLOGE(
3477 "Returning early because user denied consent to share bugreport with calling app.");
3478 closedir(d);
3479 return;
3480 }
3481 int tid;
3482 int fd;
3483 char commpath[255];
3484 char comm[255];
3485
3486 if (!(tid = atoi(de->d_name))) {
3487 continue;
3488 }
3489
3490 if (tid == pid)
3491 continue;
3492
3493 snprintf(commpath, sizeof(commpath), "/proc/%d/comm", tid);
3494 memset(comm, 0, sizeof(comm));
3495 if ((fd = TEMP_FAILURE_RETRY(open(commpath, O_RDONLY | O_CLOEXEC))) < 0) {
3496 strcpy(comm, "N/A");
3497 } else {
3498 char *c;
3499 TEMP_FAILURE_RETRY(read(fd, comm, sizeof(comm) - 2));
3500 close(fd);
3501
3502 c = strrchr(comm, '\n');
3503 if (c) {
3504 *c = '\0';
3505 }
3506 }
3507 func(pid, tid, comm);
3508 }
3509
3510 closedir(d);
3511}
3512
3513void for_each_tid(for_each_tid_func func, const char *header) {
3514 std::string title = header == nullptr ? "for_each_tid"
3515 : android::base::StringPrintf("for_each_tid(%s)", header);
3516 DurationReporter duration_reporter(title);
3517
3518 if (PropertiesHelper::IsDryRun()) return;
3519
3520 __for_each_pid(for_each_tid_helper, header, (void *) func);
3521}
3522
3523void show_wchan(int pid, int tid, const char *name) {
3524 if (PropertiesHelper::IsDryRun()) return;
3525
3526 char path[255];
3527 char buffer[255];
3528 int fd, ret, save_errno;
3529 char name_buffer[255];
3530
3531 memset(buffer, 0, sizeof(buffer));
3532
3533 snprintf(path, sizeof(path), "/proc/%d/wchan", tid);
3534 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3535 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3536 return;
3537 }
3538
3539 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3540 save_errno = errno;
3541 close(fd);
3542
3543 if (ret < 0) {
3544 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3545 return;
3546 }
3547
3548 snprintf(name_buffer, sizeof(name_buffer), "%*s%s",
3549 pid == tid ? 0 : 3, "", name);
3550
3551 printf("%-7d %-32s %s\n", tid, name_buffer, buffer);
3552
3553 return;
3554}
3555
3556// print time in centiseconds
3557static void snprcent(char *buffer, size_t len, size_t spc,
3558 unsigned long long time) {
3559 static long hz; // cache discovered hz
3560
3561 if (hz <= 0) {
3562 hz = sysconf(_SC_CLK_TCK);
3563 if (hz <= 0) {
3564 hz = 1000;
3565 }
3566 }
3567
3568 // convert to centiseconds
3569 time = (time * 100 + (hz / 2)) / hz;
3570
3571 char str[16];
3572
3573 snprintf(str, sizeof(str), " %llu.%02u",
3574 time / 100, (unsigned)(time % 100));
3575 size_t offset = strlen(buffer);
3576 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3577 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3578}
3579
3580// print permille as a percent
3581static void snprdec(char *buffer, size_t len, size_t spc, unsigned permille) {
3582 char str[16];
3583
3584 snprintf(str, sizeof(str), " %u.%u%%", permille / 10, permille % 10);
3585 size_t offset = strlen(buffer);
3586 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3587 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3588}
3589
3590void show_showtime(int pid, const char *name) {
3591 if (PropertiesHelper::IsDryRun()) return;
3592
3593 char path[255];
3594 char buffer[1023];
3595 int fd, ret, save_errno;
3596
3597 memset(buffer, 0, sizeof(buffer));
3598
3599 snprintf(path, sizeof(path), "/proc/%d/stat", pid);
3600 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3601 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3602 return;
3603 }
3604
3605 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3606 save_errno = errno;
3607 close(fd);
3608
3609 if (ret < 0) {
3610 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3611 return;
3612 }
3613
3614 // field 14 is utime
3615 // field 15 is stime
3616 // field 42 is iotime
3617 unsigned long long utime = 0, stime = 0, iotime = 0;
3618 if (sscanf(buffer,
3619 "%*u %*s %*s %*d %*d %*d %*d %*d %*d %*d %*d "
3620 "%*d %*d %llu %llu %*d %*d %*d %*d %*d %*d "
3621 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %*d "
3622 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %llu ",
3623 &utime, &stime, &iotime) != 3) {
3624 return;
3625 }
3626
3627 unsigned long long total = utime + stime;
3628 if (!total) {
3629 return;
3630 }
3631
3632 unsigned permille = (iotime * 1000 + (total / 2)) / total;
3633 if (permille > 1000) {
3634 permille = 1000;
3635 }
3636
3637 // try to beautify and stabilize columns at <80 characters
3638 snprintf(buffer, sizeof(buffer), "%-6d%s", pid, name);
3639 if ((name[0] != '[') || utime) {
3640 snprcent(buffer, sizeof(buffer), 57, utime);
3641 }
3642 snprcent(buffer, sizeof(buffer), 65, stime);
3643 if ((name[0] != '[') || iotime) {
3644 snprcent(buffer, sizeof(buffer), 73, iotime);
3645 }
3646 if (iotime) {
3647 snprdec(buffer, sizeof(buffer), 79, permille);
3648 }
3649 puts(buffer); // adds a trailing newline
3650
3651 return;
3652}
3653
3654void do_dmesg() {
3655 const char *title = "KERNEL LOG (dmesg)";
3656 DurationReporter duration_reporter(title);
3657 printf("------ %s ------\n", title);
3658
3659 if (PropertiesHelper::IsDryRun()) return;
3660
3661 /* Get size of kernel buffer */
3662 int size = klogctl(KLOG_SIZE_BUFFER, nullptr, 0);
3663 if (size <= 0) {
3664 printf("Unexpected klogctl return value: %d\n\n", size);
3665 return;
3666 }
3667 char *buf = (char *) malloc(size + 1);
3668 if (buf == nullptr) {
3669 printf("memory allocation failed\n\n");
3670 return;
3671 }
3672 int retval = klogctl(KLOG_READ_ALL, buf, size);
3673 if (retval < 0) {
3674 printf("klogctl failure\n\n");
3675 free(buf);
3676 return;
3677 }
3678 buf[retval] = '\0';
3679 printf("%s\n\n", buf);
3680 free(buf);
3681 return;
3682}
3683
3684void do_showmap(int pid, const char *name) {
3685 char title[255];
3686 char arg[255];
3687
3688 snprintf(title, sizeof(title), "SHOW MAP %d (%s)", pid, name);
3689 snprintf(arg, sizeof(arg), "%d", pid);
3690 RunCommand(title, {"showmap", "-q", arg}, CommandOptions::AS_ROOT);
3691}
3692
3693int Dumpstate::DumpFile(const std::string& title, const std::string& path) {
3694 DurationReporter duration_reporter(title);
3695
3696 int status = DumpFileToFd(STDOUT_FILENO, title, path);
3697
3698 UpdateProgress(WEIGHT_FILE);
3699
3700 return status;
3701}
3702
3703int read_file_as_long(const char *path, long int *output) {
3704 int fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC));
3705 if (fd < 0) {
3706 int err = errno;
3707 MYLOGE("Error opening file descriptor for %s: %s\n", path, strerror(err));
3708 return -1;
3709 }
3710 char buffer[50];
3711 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3712 if (bytes_read == -1) {
3713 MYLOGE("Error reading file %s: %s\n", path, strerror(errno));
3714 return -2;
3715 }
3716 if (bytes_read == 0) {
3717 MYLOGE("File %s is empty\n", path);
3718 return -3;
3719 }
3720 *output = atoi(buffer);
3721 return 0;
3722}
3723
3724/* calls skip to gate calling dump_from_fd recursively
3725 * in the specified directory. dump_from_fd defaults to
3726 * dump_file_from_fd above when set to NULL. skip defaults
3727 * to false when set to NULL. dump_from_fd will always be
3728 * called with title NULL.
3729 */
3730int dump_files(const std::string& title, const char* dir, bool (*skip)(const char* path),
3731 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
3732 DurationReporter duration_reporter(title);
3733 DIR *dirp;
3734 struct dirent *d;
3735 char *newpath = nullptr;
3736 const char *slash = "/";
3737 int retval = 0;
3738
3739 if (!title.empty()) {
3740 printf("------ %s (%s) ------\n", title.c_str(), dir);
3741 }
3742 if (PropertiesHelper::IsDryRun()) return 0;
3743
3744 if (dir[strlen(dir) - 1] == '/') {
3745 ++slash;
3746 }
3747 dirp = opendir(dir);
3748 if (dirp == nullptr) {
3749 retval = -errno;
3750 MYLOGE("%s: %s\n", dir, strerror(errno));
3751 return retval;
3752 }
3753
3754 if (!dump_from_fd) {
3755 dump_from_fd = dump_file_from_fd;
3756 }
3757 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
3758 if ((d->d_name[0] == '.')
3759 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
3760 || (d->d_name[1] == '\0'))) {
3761 continue;
3762 }
3763 asprintf(&newpath, "%s%s%s%s", dir, slash, d->d_name,
3764 (d->d_type == DT_DIR) ? "/" : "");
3765 if (!newpath) {
3766 retval = -errno;
3767 continue;
3768 }
3769 if (skip && (*skip)(newpath)) {
3770 continue;
3771 }
3772 if (d->d_type == DT_DIR) {
3773 int ret = dump_files("", newpath, skip, dump_from_fd);
3774 if (ret < 0) {
3775 retval = ret;
3776 }
3777 continue;
3778 }
3779 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(newpath, O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
3780 if (fd.get() < 0) {
3781 retval = -1;
3782 printf("*** %s: %s\n", newpath, strerror(errno));
3783 continue;
3784 }
3785 (*dump_from_fd)(nullptr, newpath, fd.get());
3786 }
3787 closedir(dirp);
3788 if (!title.empty()) {
3789 printf("\n");
3790 }
3791 return retval;
3792}
3793
3794/* fd must have been opened with the flag O_NONBLOCK. With this flag set,
3795 * it's possible to avoid issues where opening the file itself can get
3796 * stuck.
3797 */
3798int dump_file_from_fd(const char *title, const char *path, int fd) {
3799 if (PropertiesHelper::IsDryRun()) return 0;
3800
3801 int flags = fcntl(fd, F_GETFL);
3802 if (flags == -1) {
3803 printf("*** %s: failed to get flags on fd %d: %s\n", path, fd, strerror(errno));
3804 return -1;
3805 } else if (!(flags & O_NONBLOCK)) {
3806 printf("*** %s: fd must have O_NONBLOCK set.\n", path);
3807 return -1;
3808 }
3809 return DumpFileFromFdToFd(title, path, fd, STDOUT_FILENO, PropertiesHelper::IsDryRun());
3810}
3811
3812int Dumpstate::RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Rhed Jao4875aa62020-07-20 17:46:29 +08003813 const CommandOptions& options, bool verbose_duration, int out_fd) {
3814 DurationReporter duration_reporter(title, false /* logcat_only */,
3815 verbose_duration, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003816
Rhed Jao4875aa62020-07-20 17:46:29 +08003817 int status = RunCommandToFd(out_fd, title, full_command, options);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003818
3819 /* TODO: for now we're simplifying the progress calculation by using the
3820 * timeout as the weight. It's a good approximation for most cases, except when calling dumpsys,
3821 * where its weight should be much higher proportionally to its timeout.
3822 * Ideally, it should use a options.EstimatedDuration() instead...*/
3823 UpdateProgress(options.Timeout());
3824
3825 return status;
3826}
3827
3828void Dumpstate::RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsys_args,
Rhed Jao6b1ea2d2020-07-21 17:58:41 +08003829 const CommandOptions& options, long dumpsysTimeoutMs, int out_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003830 long timeout_ms = dumpsysTimeoutMs > 0 ? dumpsysTimeoutMs : options.TimeoutInMs();
3831 std::vector<std::string> dumpsys = {"/system/bin/dumpsys", "-T", std::to_string(timeout_ms)};
3832 dumpsys.insert(dumpsys.end(), dumpsys_args.begin(), dumpsys_args.end());
Rhed Jao6b1ea2d2020-07-21 17:58:41 +08003833 RunCommand(title, dumpsys, options, false, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003834}
3835
3836int open_socket(const char *service) {
3837 int s = android_get_control_socket(service);
3838 if (s < 0) {
3839 MYLOGE("android_get_control_socket(%s): %s\n", service, strerror(errno));
3840 return -1;
3841 }
3842 fcntl(s, F_SETFD, FD_CLOEXEC);
3843
3844 // Set backlog to 0 to make sure that queue size will be minimum.
3845 // In Linux, because the minimum queue will be 1, connect() will be blocked
3846 // if the other clients already called connect() and the connection request was not accepted.
3847 if (listen(s, 0) < 0) {
3848 MYLOGE("listen(control socket): %s\n", strerror(errno));
3849 return -1;
3850 }
3851
3852 struct sockaddr addr;
3853 socklen_t alen = sizeof(addr);
Abhijeet Kaur2113cae2019-09-13 09:24:15 +01003854 int fd = accept4(s, &addr, &alen, SOCK_CLOEXEC);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003855
3856 // Close socket just after accept(), to make sure that connect() by client will get error
3857 // when the socket is used by the other services.
3858 // There is still a race condition possibility between accept and close, but there is no way
3859 // to close-on-accept atomically.
3860 // See detail; b/123306389#comment25
3861 close(s);
3862
3863 if (fd < 0) {
3864 MYLOGE("accept(control socket): %s\n", strerror(errno));
3865 return -1;
3866 }
3867
3868 return fd;
3869}
3870
3871/* redirect output to a service control socket */
3872bool redirect_to_socket(FILE* redirect, const char* service) {
3873 int fd = open_socket(service);
3874 if (fd == -1) {
3875 return false;
3876 }
3877 fflush(redirect);
3878 // TODO: handle dup2 failure
3879 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
3880 close(fd);
3881 return true;
3882}
3883
3884// TODO: should call is_valid_output_file and/or be merged into it.
3885void create_parent_dirs(const char *path) {
3886 char *chp = const_cast<char *> (path);
3887
3888 /* skip initial slash */
3889 if (chp[0] == '/')
3890 chp++;
3891
3892 /* create leading directories, if necessary */
3893 struct stat dir_stat;
3894 while (chp && chp[0]) {
3895 chp = strchr(chp, '/');
3896 if (chp) {
3897 *chp = 0;
3898 if (stat(path, &dir_stat) == -1 || !S_ISDIR(dir_stat.st_mode)) {
3899 MYLOGI("Creating directory %s\n", path);
3900 if (mkdir(path, 0770)) { /* drwxrwx--- */
3901 MYLOGE("Unable to create directory %s: %s\n", path, strerror(errno));
3902 } else if (chown(path, AID_SHELL, AID_SHELL)) {
3903 MYLOGE("Unable to change ownership of dir %s: %s\n", path, strerror(errno));
3904 }
3905 }
3906 *chp++ = '/';
3907 }
3908 }
3909}
3910
3911bool _redirect_to_file(FILE* redirect, char* path, int truncate_flag) {
3912 create_parent_dirs(path);
3913
3914 int fd = TEMP_FAILURE_RETRY(open(path,
3915 O_WRONLY | O_CREAT | truncate_flag | O_CLOEXEC | O_NOFOLLOW,
3916 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH));
3917 if (fd < 0) {
3918 MYLOGE("%s: %s\n", path, strerror(errno));
3919 return false;
3920 }
3921
3922 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
3923 close(fd);
3924 return true;
3925}
3926
3927bool redirect_to_file(FILE* redirect, char* path) {
3928 return _redirect_to_file(redirect, path, O_TRUNC);
3929}
3930
3931bool redirect_to_existing_file(FILE* redirect, char* path) {
3932 return _redirect_to_file(redirect, path, O_APPEND);
3933}
3934
3935void dump_route_tables() {
3936 DurationReporter duration_reporter("DUMP ROUTE TABLES");
3937 if (PropertiesHelper::IsDryRun()) return;
3938 const char* const RT_TABLES_PATH = "/data/misc/net/rt_tables";
3939 ds.DumpFile("RT_TABLES", RT_TABLES_PATH);
3940 FILE* fp = fopen(RT_TABLES_PATH, "re");
3941 if (!fp) {
3942 printf("*** %s: %s\n", RT_TABLES_PATH, strerror(errno));
3943 return;
3944 }
3945 char table[16];
3946 // Each line has an integer (the table number), a space, and a string (the table name). We only
3947 // need the table number. It's a 32-bit unsigned number, so max 10 chars. Skip the table name.
3948 // Add a fixed max limit so this doesn't go awry.
3949 for (int i = 0; i < 64 && fscanf(fp, " %10s %*s", table) == 1; ++i) {
3950 RunCommand("ROUTE TABLE IPv4", {"ip", "-4", "route", "show", "table", table});
3951 RunCommand("ROUTE TABLE IPv6", {"ip", "-6", "route", "show", "table", table});
3952 }
3953 fclose(fp);
3954}
3955
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003956void Dumpstate::UpdateProgress(int32_t delta_sec) {
3957 if (progress_ == nullptr) {
3958 MYLOGE("UpdateProgress: progress_ not set\n");
3959 return;
3960 }
Rhed Jao2cc4eec2020-07-21 15:42:55 +08003961 // This function updates progress related members of the dumpstate and reports
3962 // progress percentage to the bugreport client. Since it could be called by
3963 // different dump tasks at the same time if the parallel run is enabled, a
3964 // mutex lock is necessary here to synchronize the call.
3965 std::lock_guard<std::recursive_mutex> lock(mutex_);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003966
3967 // Always update progess so stats can be tuned...
Nandana Duttf02cd782019-06-14 14:25:13 +01003968 progress_->Inc(delta_sec);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003969
3970 // ...but only notifiy listeners when necessary.
3971 if (!options_->do_progress_updates) return;
3972
3973 int progress = progress_->Get();
3974 int max = progress_->GetMax();
Nandana Duttf02cd782019-06-14 14:25:13 +01003975 int percent = 100 * progress / max;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003976
Nandana Duttf02cd782019-06-14 14:25:13 +01003977 if (last_reported_percent_progress_ > 0 && percent <= last_reported_percent_progress_) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003978 return;
3979 }
Nandana Duttf02cd782019-06-14 14:25:13 +01003980 last_reported_percent_progress_ = percent;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003981
3982 if (control_socket_fd_ >= 0) {
3983 dprintf(control_socket_fd_, "PROGRESS:%d/%d\n", progress, max);
3984 fsync(control_socket_fd_);
3985 }
3986
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003987 if (listener_ != nullptr) {
Nandana Dutt235c6672019-11-14 15:22:32 +00003988 if (percent % 10 == 0) {
3989 // We don't want to spam logcat, so only log multiples of 10.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01003990 MYLOGD("Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003991 } else {
3992 // stderr is ignored on normal invocations, but useful when calling
3993 // /system/bin/dumpstate directly for debuggging.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01003994 fprintf(stderr, "Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003995 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003996
3997 listener_->onProgress(percent);
3998 }
3999}
4000
4001void Dumpstate::TakeScreenshot(const std::string& path) {
4002 const std::string& real_path = path.empty() ? screenshot_path_ : path;
4003 int status =
4004 RunCommand("", {"/system/bin/screencap", "-p", real_path},
4005 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
4006 if (status == 0) {
4007 MYLOGD("Screenshot saved on %s\n", real_path.c_str());
4008 } else {
4009 MYLOGE("Failed to take screenshot on %s\n", real_path.c_str());
4010 }
Paul Chang0d2aad72020-02-13 20:04:03 +08004011 if (listener_ != nullptr) {
4012 // Show a visual indication to indicate screenshot is taken via
4013 // IDumpstateListener.onScreenshotTaken()
4014 listener_->onScreenshotTaken(status == 0);
4015 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004016}
4017
4018bool is_dir(const char* pathname) {
4019 struct stat info;
4020 if (stat(pathname, &info) == -1) {
4021 return false;
4022 }
4023 return S_ISDIR(info.st_mode);
4024}
4025
4026time_t get_mtime(int fd, time_t default_mtime) {
4027 struct stat info;
4028 if (fstat(fd, &info) == -1) {
4029 return default_mtime;
4030 }
4031 return info.st_mtime;
4032}